implab/implabjs-core Commit - r114:475b8ce3e850

working on IoC configuration

cin -

r114:475b8ce3e850 ioc ts support

parent child

Context file:

r114:475b8ce3e850

Collapse all files

src/main/ts/di/ActivationContext.ts +29 -23

             import { argumentNotNull, argumentNotEmptyString, isPrimitive, each, isNull } from "../safe";
             import { Descriptor, ServiceMap } from "./interfaces";
             import { Container } from "./Container";
+            import { MapOf } from "../interfaces";
             const trace = TraceSource.get("@implab/core/di/ActivationContext");
-            export interface ActivationContextInfo {
+            export interface ActivationContextInfo<S> {
                 name: string;
                 service: string;
-                scope: ServiceMap;
+                scope: ServiceMap<S>;
             }
-            export class ActivationContext {
+            export class ActivationContext<S> {
-                _cache: object;
+                _cache: MapOf<any>;
-                _services: ServiceMap;
+                _services: ServiceMap<S>;
-                _stack: ActivationContextInfo[];
+                _stack: ActivationContextInfo<S>[];
-                _visited: object;
+                _visited: MapOf<any>;
                 _name: string;
-                _localized: boolean;
+                _localized: boolean = false;
-                container: Container;
+                container: Container<S>;
-                constructor(container: Container, services: ServiceMap, name?: string, cache?: object, visited?) {
+                constructor(container: Container<S>, services: ServiceMap<S>, name?: string, cache?: object, visited?: MapOf<any>) {
                     argumentNotNull(container, "container");
                     argumentNotNull(services, "services");
-                    this._name = name;
+                    this._name = name || "<unnamed>";
                     this._visited = visited || {};
                     this._stack = [];
                     this._cache = cache || {};
                     return this._name;
                 }
-                resolve(name, def?): any {
+                resolve<K extends keyof S, T extends S[K]>(name: K, def?: T) {
                     const d = this._services[name];
-                    if (!d)
+                    if (d !== undefined) {
-                        if (arguments.length > 1)
+                        return this.activate(d as Descriptor<T>, name.toString());
+                    } else {
+                        if (def !== undefined && def !== null)
                             return def;
                         else
                             throw new Error(`Service ${name} not found`);
+                    }
-                    return this.activate(d, name);
                 }
                 /**
                  * @name{string} the name of the service
                  * @service{string} the service descriptor to register
                  */
-                register(name: string, service: Descriptor) {
+                register<K extends keyof S>(name: K, service: Descriptor<S[K]>) {
                     argumentNotEmptyString(name, "name");
                     this._services[name] = service;
                     return id in this._cache;
                 }
-                get(id: string) {
+                get<T>(id: string) {
                     return this._cache[id];
                 }
-                store(id: string, value) {
+                store(id: string, value: any) {
                     return (this._cache[id] = value);
                 }
-                activate(d: Descriptor, name: string) {
+                activate<T>(d: Descriptor<T>, name: string) {
                     if (trace.isLogEnabled())
                         trace.log(`enter ${name} ${d}`);
                     this.enter(name, d.toString());
-                    const v = d.activate(this);
+                    const v = d.activate<S>(this);
                     this.leave();
                     if (trace.isLogEnabled())
                 private leave() {
                     const ctx = this._stack.pop();
-                    this._services = ctx.scope;
+                    if (ctx) {
-                    this._name = ctx.name;
+                        this._services = ctx.scope;
+                        this._name = ctx.name;
+                    } else {
+                        trace.error("Trying to leave the last activation scope");
+                    }
                 }
             }

src/main/ts/di/ActivationError.ts +6 -3

-            import { ActivationContextInfo } from "./ActivationContext";
+            export interface ActivationItem {
+                name: string;
+                service: string;
+            }
             export class ActivationError {
-                activationStack: ActivationContextInfo[];
+                activationStack: ActivationItem[];
                 service: string;
                 message: string;
-                constructor(service: string, activationStack: ActivationContextInfo[], innerException: any) {
+                constructor(service: string, activationStack: ActivationItem[], innerException: any) {
                     this.message = "Failed to activate the service";
                     this.activationStack = activationStack;
                     this.service = service;

src/main/ts/di/AggregateDescriptor.ts +11 -9

             import { ActivationContext } from "./ActivationContext";
             import { isPrimitive } from "../safe";
-            export class AggregateDescriptor<T> implements Descriptor<T> {
+            type Parse<T> = T extends Descriptor<infer V> ? V :
+                    T extends {} ? { [K in keyof T]: Parse<T[K]> } :
+                    T;
+            export class AggregateDescriptor<T> implements Descriptor<Parse<T>> {
                 _value: T;
                 constructor(value: T) {
                     this._value = value;
                 }
-                activate(context: ActivationContext) {
+                activate<S>(context: ActivationContext<S>) {
                     return this._parse(this._value, context, "$value");
                 }
-                // TODO: make async
+                _parse<S, V>(value: V, context: ActivationContext<S>, path: string): Parse<V> {
-                _parse(value: T, context: ActivationContext, path: string) {
                     if (isPrimitive(value))
-                        return value;
+                        return value as any;
                     if (isDescriptor(value))
                         return context.activate(value, path);
                     if (value instanceof Array)
-                        return value.map((x, i) => this._parse(x, context, `${path}[${i}]`));
+                        return value.map((x, i) => this._parse(x, context, `${path}[${i}]`)) as any;
-                    const t = {};
+                    const t: any = {};
-                    for (const p of Object.keys(value))
+                    for (const p in value)
                         t[p] = this._parse(value[p], context, `${path}.${p}`);
                     return t;
                 }
                 toString() {

src/main/ts/di/Annotations.ts +23 -3

                 lazy?: boolean;
             }
+            interface Dependency<K extends keyof any> {
+                $dependency: K;
+                lazy?: boolean;
+            }
+            interface Lazy<K extends keyof any> extends Dependency<K> {
+                lazy: true;
+            }
             type Setter<T = any> = (v: T) => void;
             type Compatible<T1, T2> = T1 extends T2 ? any : never;
-            type SetterType<T> = T extends (v: infer V) => void ? V : never;
             type ExtractService<K, S> = K extends keyof S ? S[K] : K;
             type ExtractDependency<D, S> = D extends { $dependency: infer K } ? D extends { lazy: true } ? () => ExtractService<K, S> : ExtractService<K, S> : VisitDependency<D, S>;
             type VisitDependency<D, S> = D extends {} ? { [K in keyof D]: ExtractDependency<D[K], S> } : D;
+            interface Config<S> {
+                dependency<K extends keyof S>(name: K): Dependency<K>;
+                lazy<K extends keyof S>(name: K): Lazy<K>;
+                build<T>(): Builder<T, S>;
+            }
+            export declare function services<S extends object>(): Config<S>;
             export class Builder<T, S> {
                 consume<P extends any[]>(...args: P) {
                     return <C extends new (...args: ExtractDependency<P, S>) => T>(constructor: C) => {
-                        return constructor as typeof constructor & { service: () => T };
+                        return constructor;
                     };
                 }
                 }
             }

src/main/ts/di/ConfigError.ts +4 -4

             export class ConfigError extends Error {
-                inner: any;
+                inner?: {};
-                path: string;
+                path?: string;
-                configName: string;
+                configName?: string;
-                constructor(message: string, inner?: any) {
+                constructor(message: string, inner?: {}) {
                     super(message);
                     this.inner = inner;
                 }

src/main/ts/di/Configuration.ts +17 -19

             const trace = TraceSource.get("@implab/core/di/Configuration");
-            async function mapAll(data: any | any[], map?: (v: any, k: keyof any) => any): Promise<any> {
+            async function mapAll(data: any | any[], map?: (v: any, k: number | string) => any): Promise<any> {
                 if (data instanceof Array) {
                     return Promise.all(map ? data.map(map) : data);
                 } else {
             export type ModuleResolver = (moduleName: string, ct?: ICancellation) => any;
-            type _key = string | number;
+            export class Configuration<S> {
-            export class Configuration {
                 _hasInnerDescriptors = false;
-                _container: Container;
+                _container: Container<S>;
-                _path: Array<_key>;
+                _path: Array<string>;
                 _configName: string | undefined;
                 _require: ModuleResolver | undefined;
-                constructor(container: Container) {
+                constructor(container: Container<S>) {
                     argumentNotNull(container, "container");
                     this._container = container;
                     this._path = [];
                     return this._require(moduleName);
                 }
-                async _visitRegistrations(data: any, name: _key) {
+                async _visitRegistrations(data: any, name: string) {
                     this._enter(name);
                     if (data.constructor &&
                     const keys = Object.keys(data);
                     const services = await mapAll(data, async (v, k) => {
-                        const d = await this._visit(v, k);
+                        const d = await this._visit(v, k.toString());
                         return isDescriptor(d) ? d : new AggregateDescriptor(d);
                     }) as ServiceMap;
                     trace.debug("<{0}", name);
                 }
-                async _visit<T extends object>(data: T, name: keyof T) {
+                async _visit<T>(data: T, name: string) {
                     if (isPrimitive(data) || isDescriptor(data))
                         return data;
-                    if (isDependencyRegistration(data)) {
+                    if (isDependencyRegistration<S>(data)) {
                         return this._visitDependencyRegistration(data, name);
                     } else if (isValueRegistration(data)) {
                         return this._visitValueRegistration(data, name);
                         return this._visitArray(data, name);
                     }
-                    return this._visitObject(data, name);
+                    return this._visitObject(data as T & object, name);
                 }
-                async _visitObject(data: object, name: _key) {
+                async _visitObject<T extends object>(data: T, name: string) {
                     if (data.constructor &&
                         data.constructor.prototype !== Object.prototype)
                         return new ValueDescriptor(data);
                     return v;
                 }
-                async _visitArray(data: any[], name: _key) {
+                async _visitArray(data: any[], name: string) {
                     if (data.constructor &&
                         data.constructor.prototype !== Array.prototype)
                         return new ValueDescriptor(data);
                     return v;
                 }
-                _makeServiceParams<T, P, S>(data: ServiceRegistration<T, P, S>) {
+                _makeServiceParams<T, P>(data: ServiceRegistration<T, P, S>) {
                     const opts: any = {
                         owner: this._container
                     };
                     return opts;
                 }
-                async _visitValueRegistration<T>(data: ValueRegistration<T>, name: _key) {
+                async _visitValueRegistration<T>(data: ValueRegistration<T>, name: string) {
                     this._enter(name);
                     const d = data.parse ? new AggregateDescriptor(data.$value) : new ValueDescriptor(data.$value);
                     this._leave();
                     return d;
                 }
-                async _visitDependencyRegistration<S, K extends keyof S>(data: DependencyRegistration<S, K>, name: keyof S) {
+                async _visitDependencyRegistration<K extends keyof S>(data: DependencyRegistration<S, K>, name: string) {
                     argumentNotEmptyString(data && data.$dependency, "data.$dependency");
                     this._enter(name);
                     const d = new ReferenceDescriptor<S, K>({
                     return d;
                 }
-                async _visitTypeRegistration<T, P, S>(data: TypeRegistration<T, P, S>, name: _key) {
+                async _visitTypeRegistration<T, P>(data: TypeRegistration<T, P, S>, name: string) {
                     argumentNotNull(data.$type, "data.$type");
                     this._enter(name);
                     return d;
                 }
-                async _visitFactoryRegistration<T, P, S>(data: FactoryRegistration<T, P, S>, name: _key) {
+                async _visitFactoryRegistration<T, P>(data: FactoryRegistration<T, P, S>, name: string) {
                     argumentOfType(data.$factory, Function, "data.$factory");
                     this._enter(name);

src/main/ts/di/Container.ts +41 -31

             import { ActivationContext } from "./ActivationContext";
             import { ValueDescriptor } from "./ValueDescriptor";
             import { ActivationError } from "./ActivationError";
-            import { isDescriptor, ServiceMap } from "./interfaces";
+            import { isDescriptor, ServiceMap, Descriptor } from "./interfaces";
             import { TraceSource } from "../log/TraceSource";
             import { Configuration } from "./Configuration";
             import { Cancellation } from "../Cancellation";
+            import { MapOf } from "../interfaces";
             const trace = TraceSource.get("@implab/core/di/ActivationContext");
-            export class Container {
+            export class Container<S extends { container?: Container<S> }> {
-                _services: ServiceMap;
+                readonly _services: ServiceMap<S>;
-                _cache: object;
+                readonly _cache: MapOf<any>;
+                readonly _cleanup: (() => void)[];
-                _cleanup: (() => void)[];
+                readonly _root: Container<S>;
-                _root: Container;
+                readonly _parent?: Container<S>;
-                _parent: Container;
+                _disposed: boolean;
-                constructor(parent?: Container) {
+                constructor(parent?: Container<S>) {
                     this._parent = parent;
                     this._services = parent ? Object.create(parent._services) : {};
                     this._cache = {};
                     this._cleanup = [];
                     this._root = parent ? parent.getRootContainer() : this;
                     this._services.container = new ValueDescriptor(this);
+                    this._disposed = false;
                 }
                 getRootContainer() {
                     return this._parent;
                 }
-                resolve(name: string, def?) {
+                resolve<K extends keyof S, T extends S[K] = S[K]>(name: K, def?: T) {
                     trace.debug("resolve {0}", name);
                     const d = this._services[name];
                     if (d === undefined) {
-                        if (arguments.length > 1)
+                        if (def !== undefined)
                             return def;
                         else
                             throw new Error("Service '" + name + "' isn't found");
+                    } else {
-                    const context = new ActivationContext(this, this._services);
+                        const context = new ActivationContext<S>(this, this._services);
-                    try {
+                        try {
-                        return context.activate(d, name);
+                            return context.activate(d as Descriptor<T>, name.toString());
-                    } catch (error) {
+                        } catch (error) {
-                        throw new ActivationError(name, context.getStack(), error);
+                            throw new ActivationError(name.toString(), context.getStack(), error);
+                        }
                     }
                 }
                 /**
                  * @deprecated use resolve() method
                  */
-                getService() {
+                getService<K extends keyof S>(name: K, def?: S[K]) {
-                    return this.resolve.apply(this, arguments);
+                    return this.resolve(name, def);
                 }
-                register(nameOrCollection, service?) {
+                register<K extends keyof S>(name: K, service: Descriptor<S[K]>): this;
+                register(services: ServiceMap<S>): this;
+                register<K extends keyof S>(nameOrCollection: K | ServiceMap<S>, service?: Descriptor<S[K]>) {
                     if (arguments.length === 1) {
-                        const data = nameOrCollection;
+                        const data = nameOrCollection as ServiceMap<S>;
-                        for (const name in data)
+                        for (const name in data) {
-                            this.register(name, data[name]);
+                            if (Object.prototype.hasOwnProperty.call(data, name)) {
+                                this.register(name, data[name] as Descriptor<S[keyof S]>);
+                            }
+                        }
                     } else {
                         if (!isDescriptor(service))
                             throw new Error("The service parameter must be a descriptor");
-                        this._services[nameOrCollection] = service;
+                        this._services[nameOrCollection as K] = service;
                     }
                     return this;
                 }
-                onDispose(callback) {
+                onDispose(callback: () => void) {
                     if (!(callback instanceof Function))
                         throw new Error("The callback must be a function");
                     this._cleanup.push(callback);
                 }
                 dispose() {
-                    if (this._cleanup) {
+                    if (this._disposed)
-                        for (const f of this._cleanup)
+                        return;
-                            f();
+                    this._disposed = true;
-                        this._cleanup = null;
+                    for (const f of this._cleanup)
+                        f();
                 }
                 /**
                     }
                 }
-                createChildContainer() {
+                createChildContainer<S2 extends { container?: Container<S & S2> } = S>(): Container<S & S2> {
-                    return new Container(this);
+                    return new Container<S & S2>(this as any);
                 }
                 has(id: string | number) {

src/main/ts/di/ReferenceDescriptor.ts +12 -14

-            import { isNull, argumentNotEmptyString, each } from "../safe";
+            import { isNull, argumentNotEmptyString, each, keys } from "../safe";
             import { ActivationContext } from "./ActivationContext";
             import { ServiceMap, Descriptor } from "./interfaces";
             import { ActivationError } from "./ActivationError";
                 services?: ServiceMap;
             }
+            function def<T>(v: T) {
+                if (v === undefined)
+                    throw Error();
+                return v;
+            }
             export class ReferenceDescriptor<S, K extends keyof S> implements Descriptor<S[K]> {
                 _name: K;
                 _default: any;
-                _services: ServiceMap;
+                _services: ServiceMap<S>;
                 constructor(opts: ReferenceDescriptorParams<S, K>) {
                     argumentNotEmptyString(opts && opts.name, "opts.name");
                     this._services = opts.services || {};
                 }
-                activate(context: ActivationContext, name: string) {
+                activate(context: ActivationContext<S>) {
                     // добавляем сервисы
                     if (this._services) {
-                        for (const p of Object.keys(this._services))
+                        each(this._services, (v, k) => context.register(k, def(v)));
-                            context.register(p, this._services[p]);
                     }
                     if (this._lazy) {
                         const saved = context.clone();
-                        return (cfg: ServiceMap) => {
+                        return (cfg: Partial<ServiceMap<S>>) => {
                             // защищаем контекст на случай исключения в процессе
                             // активации
                             const ct = saved.clone();
                             try {
                                 if (cfg) {
-                                    for (const k in cfg)
+                                    each(cfg, (v, k) => ct.register(k, v || {}));
-                                        ct.register(k, cfg[k]);
                                 }
                                 return this._optional ? ct.resolve(this._name, this._default) : ct
                             }
                         };
                     } else {
-                        // добавляем сервисы
-                        if (this._services) {
-                            for (const p of Object.keys(this._services))
-                                context.register(p, this._services[p]);
                         const v = this._optional ?
                             context.resolve(this._name, this._default) :
                             context.resolve(this._name);

src/main/ts/di/interfaces.ts +2 -2

             import { Constructor, Factory } from "../interfaces";
             export interface Descriptor<T = any> {
-                activate(context: ActivationContext, name?: string): T;
+                activate<S>(context: ActivationContext<S>): T;
             }
             export function isDescriptor(x: any): x is Descriptor {
                 return (!isPrimitive(x)) && ("$value" in x);
             }
-            export function isDependencyRegistration(x: any): x is DependencyRegistration<any, string | number | symbol> {
+            export function isDependencyRegistration<S>(x: any): x is DependencyRegistration<S, keyof S> {
                 return (!isPrimitive(x)) && ("$dependency" in x);
             }

src/main/ts/safe.ts +24 -15

                 Symbol("__implab__oid__") :
                 "__implab__oid__";
-            export function oid(instance: object): string {
+            export function oid(instance: any): string | undefined {
                 if (isNull(instance))
-                    return null;
+                    return undefined;
                 if (_oid in instance)
                     return instance[_oid];
                     return (instance[_oid] = "oid_" + (++_nextOid));
             }
+            export function keys<T>(arg: T): (Extract<keyof T, string>)[] {
+                return isObject(arg) && arg ? Object.keys(arg) as (Extract<keyof T, string>)[] : [];
+            }
             export function argumentNotNull(arg: any, name: string) {
                 if (arg === null || arg === undefined)
                     throw new Error("The argument " + name + " can't be null or undefined");
                     throw new Error("The argument '" + name + "' type doesn't match");
             }
+            export function isObject(val: any): val is object {
+                return typeof val === "object";
+            }
             export function isNull(val: any) {
                 return (val === null || val === undefined);
             }
                 return val && typeof val.cancel === "function";
             }
-            export function isNullOrEmptyString(val: any): val is string | null | undefined {
+            export function isNullOrEmptyString(val: any): val is (string | null | undefined) {
-                if (val === null || val === undefined ||
+                return (val === null || val === undefined ||
                     ((typeof (val) === "string" || val instanceof String) && val.length === 0))
-                    return true;
             }
             export function isNotEmptyArray(arg: any): arg is Array<any> {
                 return (arg instanceof Array && arg.length > 0);
             }
-            function _isStrictMode() {
+            function _isStrictMode(this: any) {
                 return !this;
             }
-            function _getNonStrictGlobal() {
+            function _getNonStrictGlobal(this: any) {
                 return this;
             }
              * @returns Результат вызова функции <c>cb</c>, либо <c>undefined</c>
              *          если достигнут конец массива.
              */
-            export function each(obj, cb, thisArg?) {
+            export function each<T>(obj: T, cb: (v: T[keyof T], k: keyof T) => void): void;
+            export function each(obj: any, cb: any, thisArg?: any): any;
+            export function each(obj: any, cb: any, thisArg?: any) {
                 argumentNotNull(cb, "cb");
                 if (obj instanceof Array) {
                     for (let i = 0; i < obj.length; i++) {
                             return x;
                     }
                 } else {
-                    const keys = Object.keys(obj);
+                    const _keys = Object.keys(obj);
-                    for (const k of keys) {
+                    for (const k of _keys) {
                         const x = cb.call(thisArg, obj[k], k);
                         if (x !== undefined)
                             return x;
                             _res[p] = source[p];
                     }
                 } else if (template) {
-                    const keys = Object.keys(source);
+                    const _keys = Object.keys(source);
-                    for (const p of keys) {
+                    for (const p of _keys) {
                         if (p in template)
                             _res[template[p]] = source[p];
                     }
              * @param{Object} thisArg [Optional] Object which will be passed as 'this' to the function.
              * @param{Function|String} fn [Required] Function wich will be wrapped.
              */
-            export function async(_fn: (...args: any[]) => any, thisArg): (...args: any[]) => PromiseLike<any> {
+            export function async(_fn: (...args: any[]) => any, thisArg: any): (...args: any[]) => PromiseLike<any> {
                 let fn = _fn;
                 if (arguments.length === 2 && !(fn instanceof Function))
                     let i = 0;
                     const result = new Array<T2>();
-                    const next = () => {
+                    const next = (): any => {
                         while (i < items.length) {
                             const r = cb(items[i], i);
                             const ri = i;
                     let i = 0;
-                    const next = () => {
+                    const next = (): any => {
                         while (i < items.length) {
                             const r = cb(items[i], i);
                             i++;

src/test/ts/mock/Box.ts +10 -3

@@ -1,6 +1,13
1	import { ~~config~~ } from ".~~/config~~";	1	import { services } from "../di/Annotations";
		2	import { Bar } from "./Bar";
2		3
3	const service = config.build("barBox");	4	// declare required dependencies
		5	const config = services<{
		6	bar: Bar;
		7	}>();
		8
		9	// export service descriptor
		10	export const service = config.build<Box<Bar>>();
4		11
5	@service.consume(config.dependency("bar"))	12	@service.consume(config.dependency("bar"))
6	export class Box<T> {	13	export class Box<T> {
@@ -25,4 +32,4 export class Box<T> {
25		32
26	return this._value;	33	return this._value;
27	}	34	}
28	} No newline at end of file	35	}

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages