/* eslint-disable @typescript-eslint/no-this-alias */ /* eslint-disable @typescript-eslint/strict-boolean-expressions, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any */ import { IContainer, InterfaceSymbol, Resolver, ResolverStrategy, getDependencies, type IContainerConfiguration, type IFactory, type IRegistry, type IResolver, type Key, type RegisterSelf, type Resolved, type Transformer, IDisposableResolver, } from './di'; import { aliasToRegistration, singletonRegistration } from './di.registration'; import type { IAllResolver, IFactoryResolver, ILazyResolver, INewInstanceResolver, IOptionalResolver, IResolvedFactory, IResolvedLazy, } from './di.resolvers'; import { ErrorNames, createMappedError, logError } from './errors'; import { isNativeFunction } from './functions'; import { type Class, type Constructable } from './interfaces'; import { emptyArray } from './platform'; import { ResourceDefinition, StaticResourceType, resourceBaseName, type ResourceType } from './resource'; import { getMetadata, isFunction, isObjectOrFunction, isString } from './utilities'; export const registrableMetadataKey = Symbol.for('au:registrable'); export const DefaultResolver = { none(key: Key): IResolver { throw createMappedError(ErrorNames.none_resolver_found, key); }, singleton: (key: Key): IResolver => new Resolver(key, ResolverStrategy.singleton, key), transient: (key: Key): IResolver => new Resolver(key, ResolverStrategy.transient, key), }; export class ContainerConfiguration implements IContainerConfiguration { public static readonly DEFAULT: ContainerConfiguration = ContainerConfiguration.from({}); private constructor( public readonly inheritParentResources: boolean, public readonly defaultResolver: ( key: Key, handler: IContainer ) => IResolver ) {} public static from(config?: IContainerConfiguration): ContainerConfiguration { if ( config === void 0 || config === ContainerConfiguration.DEFAULT ) { return ContainerConfiguration.DEFAULT; } return new ContainerConfiguration( config.inheritParentResources ?? false, config.defaultResolver ?? DefaultResolver.singleton, ); } } /** @internal */ export const createContainer = (config?: Partial): IContainer => new Container(null, ContainerConfiguration.from(config)); const InstrinsicTypeNames = new Set('Array ArrayBuffer Boolean DataView Date Error EvalError Float32Array Float64Array Function Int8Array Int16Array Int32Array Map Number Object Promise RangeError ReferenceError RegExp Set SharedArrayBuffer String SyntaxError TypeError Uint8Array Uint8ClampedArray Uint16Array Uint32Array URIError WeakMap WeakSet'.split(' ')); // const factoryKey = 'di:factory'; // const factoryAnnotationKey = Protocol.annotation.keyFor(factoryKey); let containerId = 0; let currentContainer: IContainer | null = null; /** @internal */ export class Container implements IContainer { public readonly id: number = ++containerId; /** @internal */ private _registerDepth: number = 0; public get depth(): number { return this._parent === null ? 0 : this._parent.depth + 1; } public readonly root: Container; /** * All own resolvers of this container * * @internal */ private readonly _resolvers: Map; /** * A map of Factory per Constructor (Type) of this container tree. * * Factories are "global" per container tree * * @internal */ private readonly _factories: Map; /** * A map of all resources resolver by their key */ private res: Record; /** @internal */ private readonly _disposableResolvers = new Map(); public get parent(): IContainer | null { return this._parent as (IContainer | null); } /** @internal */ private readonly _parent: Container | null; /** @internal */ private readonly config: ContainerConfiguration; public constructor( parent: Container | null, config: ContainerConfiguration ) { this._parent = parent; this.config = config; this._resolvers = new Map(); this.res = {}; if (parent === null) { this.root = this; this._factories = new Map(); } else { this.root = parent.root; this._factories = parent._factories; if (config.inheritParentResources) { // todo: when the simplify resource system work is commenced // this resource inheritance can just be a Object.create() call // with parent resources as the prototype of the child resources for (const key in parent.res) { this.registerResolver(key, parent.res[key]!); } } } this._resolvers.set(IContainer, containerResolver); } public register(...params: any[]): IContainer { if (++this._registerDepth === 100) { throw createMappedError(ErrorNames.unable_auto_register, ...params); } let current: IRegistry | Record; let keys: string[]; let value: IRegistry; let j: number; let jj: number; let i = 0; // eslint-disable-next-line let ii = params.length; let def: ResourceDefinition; for (; i < ii; ++i) { current = params[i]; if (!isObjectOrFunction(current)) { continue; } if (isRegistry(current)) { current.register(this); } else if ((def = getMetadata(resourceBaseName, current)!) != null) { def.register(this); } else if (isClass(current)) { const registrable = current[Symbol.metadata]?.[registrableMetadataKey] as IRegistry; if (isRegistry(registrable)) { registrable.register(this); } else if (isString((current).$au?.type)) { const $au = current.$au; const aliases = (current.aliases ?? emptyArray).concat($au.aliases ?? emptyArray); let key = `${resourceBaseName}:${$au.type}:${$au.name}`; if (this.has(key, false)) { if (__DEV__) { // eslint-disable-next-line @typescript-eslint/no-unsafe-call (globalThis as any).console?.warn(createMappedError(ErrorNames.resource_already_exists, key)); } continue; } aliasToRegistration(current, key).register(this); if (!this.has(current, false)) { singletonRegistration(current, current).register(this); } j = 0; jj = aliases.length; for (; j < jj; ++j) { key = `${resourceBaseName}:${$au.type}:${aliases[j]}`; if (this.has(key, false)) { if (__DEV__) { // eslint-disable-next-line @typescript-eslint/no-unsafe-call (globalThis as any).console?.warn(createMappedError(ErrorNames.resource_already_exists, key)); } continue; } aliasToRegistration(current, key).register(this); } } else { singletonRegistration(current, current as Constructable).register(this); } } else { keys = Object.keys(current); j = 0; jj = keys.length; for (; j < jj; ++j) { value = current[keys[j]]; if (!isObjectOrFunction(value)) { continue; } // note: we could remove this if-branch and call this.register directly // - the extra check is just a perf tweak to create fewer unnecessary arrays by the spread operator if (isRegistry(value)) { value.register(this); } else { this.register(value); } } } } --this._registerDepth; return this; } public registerResolver>(key: K, resolver: T, isDisposable: boolean = false): T { validateKey(key); const resolvers = this._resolvers; const result = resolvers.get(key); if (result == null) { resolvers.set(key, resolver); if (isResourceKey(key)) { if (this.res[key] !== void 0) { throw createMappedError(ErrorNames.resource_already_exists, key); } this.res[key] = resolver; } } else if (result instanceof Resolver && result._strategy === ResolverStrategy.array) { (result._state as IResolver[]).push(resolver); } else { resolvers.set(key, new Resolver(key, ResolverStrategy.array, [result, resolver]) as IResolver); } if (isDisposable) { this._disposableResolvers.set(key, resolver); } return resolver; } public deregister(key: Key): void { validateKey(key); const resolver = this._resolvers.get(key); if (resolver != null) { this._resolvers.delete(key); if (isResourceKey(key)) { // eslint-disable-next-line @typescript-eslint/no-dynamic-delete delete this.res[key]; } if (this._disposableResolvers.has(key)) { (resolver as IDisposableResolver).dispose(); this._disposableResolvers.delete(key); } } } // public deregisterResolverFor(key: K, searchAncestors: boolean): void { // validateKey(key); // // eslint-disable-next-line @typescript-eslint/no-this-alias // let current: Container | null = this; // let resolver: IResolver | undefined; // while (current != null) { // resolver = current._resolvers.get(key); // if (resolver != null) { // current._resolvers.delete(key); // break; // } // if (current.parent == null) { return; } // current = searchAncestors ? current.parent : null; // } // if (resolver == null) { return; } // if (resolver instanceof Resolver && resolver.strategy === ResolverStrategy.array) { // throw createError('Cannot deregister a resolver with array strategy'); // } // if (this._disposableResolvers.has(resolver as IDisposableResolver)) { // (resolver as IDisposableResolver).dispose(); // } // if (isResourceKey(key)) { // // eslint-disable-next-line @typescript-eslint/no-dynamic-delete // delete this.res[key]; // } // } public registerTransformer(key: K, transformer: Transformer): boolean { const resolver = this.getResolver(key); if (resolver == null) { return false; } if (resolver.getFactory) { const factory = resolver.getFactory(this); if (factory == null) { return false; } // This type cast is a bit of a hacky one, necessary due to the duplicity of IResolverLike. // Problem is that that interface's type arg can be of type Key, but the getFactory method only works on // type Constructable. So the return type of that optional method has this additional constraint, which // seems to confuse the type checker. factory.registerTransformer( transformer as unknown as Transformer ); return true; } return false; } public getResolver(key: K | Key, autoRegister: boolean = true): IResolver | null { validateKey(key); if ((key as unknown as IResolver).resolve !== void 0) { return key as unknown as IResolver; } const previousContainer = currentContainer; let current: Container = currentContainer = this; let resolver: IResolver | undefined; let handler: Container; try { while (current != null) { resolver = current._resolvers.get(key); if (resolver == null) { if (current._parent == null) { handler = (isRegisterInRequester(key as unknown as RegisterSelf)) ? this : current; if (autoRegister) { return this._jitRegister(key, handler); } return null; } current = current._parent; } else { return resolver; } } } finally { currentContainer = previousContainer; } return null; } public has(key: K, searchAncestors: boolean = false): boolean { return this._resolvers.has(key) || isResourceKey(key) && key in this.res || ((searchAncestors && this._parent?.has(key, true)) ?? false); } public get(key: K): Resolved { validateKey(key); if ((key as IResolver).$isResolver) { return (key as IResolver).resolve(this, this); } const previousContainer = currentContainer; let current: Container = currentContainer = this; let resolver: IResolver | undefined; let handler: Container; try { while (current != null) { resolver = current._resolvers.get(key); if (resolver == null) { if (current._parent == null) { handler = (isRegisterInRequester(key as unknown as RegisterSelf)) ? this : current; resolver = this._jitRegister(key, handler); return resolver.resolve(current, this); } current = current._parent; } else { return resolver.resolve(current, this); } } } finally { currentContainer = previousContainer; } throw createMappedError(ErrorNames.unable_resolve_key, key); } public getAll(key: K, searchAncestors: boolean = false): Resolved[] { validateKey(key); const previousContainer = currentContainer; const requestor = currentContainer = this; let current: Container | null = requestor; let resolver: IResolver | undefined; let resolutions: Resolved[] = emptyArray; try { if (searchAncestors) { while (current != null) { resolver = current._resolvers.get(key); if (resolver != null) { resolutions = resolutions.concat(buildAllResponse(resolver, current, requestor)); } current = current._parent; } return resolutions; } while (current != null) { resolver = current._resolvers.get(key); if (resolver == null) { current = current._parent; if (current == null) { return emptyArray; } } else { return buildAllResponse(resolver, current, requestor); } } } finally { currentContainer = previousContainer; } return emptyArray; } public invoke(Type: Constructable, dynamicDependencies?: TDeps): T { if (isNativeFunction(Type)) { throw createMappedError(ErrorNames.no_construct_native_fn, Type); } const previousContainer = currentContainer; currentContainer = this; if (__DEV__) { let resolvedDeps: unknown[]; let dep: Key | undefined; try { resolvedDeps = getDependencies(Type).map(_ => this.get(dep = _)); } catch (ex) { logError(`[DEV:aurelia] Error during construction of ${!Type.name ? `(Anonymous) ${String(Type)}` : Type.name}, caused by dependency: ${String(dep)}`); currentContainer = previousContainer; throw ex; } try { return dynamicDependencies === void 0 ? new Type(...resolvedDeps) : new Type(...resolvedDeps, ...dynamicDependencies); } catch (ex) { logError(`[DEV:aurelia] Error during construction of ${!Type.name ? `(Anonymous) ${String(Type)}` : Type.name}`); throw ex; } finally { currentContainer = previousContainer; } } try { return dynamicDependencies === void 0 ? new Type(...getDependencies(Type).map(containerGetKey, this)) : new Type(...getDependencies(Type).map(containerGetKey, this), ...dynamicDependencies); } finally { currentContainer = previousContainer; } } public hasFactory(key: T): boolean { return this._factories.has(key); } public getFactory(Type: K | IResolver): IFactory { let factory = this._factories.get(Type as K); if (factory != null) { return factory; } let RealType: Constructable | undefined; if ((Type as IResolver).$isResolver) { RealType = (Type as IResolver).getFactory?.(this)?.Type; } else { RealType = isFunction(Type) ? Type : this.getResolver(Type, false)?.getFactory?.(this)?.Type; } if (!isFunction(RealType)) { throw createMappedError(ErrorNames.unable_jit_non_constructor, RealType); } factory = this._factories.get(RealType); if (factory === void 0) { if (isNativeFunction(RealType)) { throw createMappedError(ErrorNames.no_construct_native_fn, Type); } this._factories.set(RealType, factory = new Factory(RealType as K, getDependencies(RealType))); } return factory; } public registerFactory(key: Key, factory: IFactory): void { this._factories.set(key, factory as Factory); } public createChild(config?: Partial): IContainer { if (config === void 0 && this.config.inheritParentResources) { if (this.config === ContainerConfiguration.DEFAULT) { return new Container(this, this.config); } return new Container( this, ContainerConfiguration.from({ ...this.config, inheritParentResources: false, }) ); } return new Container(this, ContainerConfiguration.from(config ?? this.config)); } public disposeResolvers(): void { const resolvers = this._resolvers; const disposableResolvers = this._disposableResolvers; let disposable: IResolver; let key: Key; for ([key, disposable] of disposableResolvers.entries()) { disposable.dispose?.(); resolvers.delete(key); } disposableResolvers.clear(); } public useResources(container: Container): void { const res = container.res; for (const key in res) { this.registerResolver(key, res[key]!); } } public find(kind: string, name: string): TResType | null; public find(key: string): TResType | null; public find(keyOrKind: string, name?: string): TResType | null { const key = isString(name) ? `${resourceBaseName}:${keyOrKind}:${name}` : keyOrKind; let container: Container = this; let resolver = container.res[key]; if (resolver == null) { container = container.root; resolver = container.res[key]; } if (resolver == null) { return null; } return resolver.getFactory?.(container)?.Type as TResType ?? null; } public dispose(): void { if (this._disposableResolvers.size > 0) { this.disposeResolvers(); } this._resolvers.clear(); if (this.root === this) { this._factories.clear(); this.res = {}; } } /** @internal */ private _jitRegister(keyAsValue: any, handler: Container): IResolver { const $isRegistry = isRegistry(keyAsValue); if (!isFunction(keyAsValue) && !$isRegistry) { throw createMappedError(ErrorNames.unable_jit_non_constructor, keyAsValue); } if (InstrinsicTypeNames.has(keyAsValue.name)) { throw createMappedError(ErrorNames.no_jit_intrinsic_type, keyAsValue); } if ($isRegistry) { const registrationResolver = keyAsValue.register(handler, keyAsValue); if (!(registrationResolver instanceof Object) || (registrationResolver as IResolver).resolve == null) { const newResolver = handler._resolvers.get(keyAsValue); if (newResolver != null) { return newResolver; } throw createMappedError(ErrorNames.null_resolver_from_register, keyAsValue); } return registrationResolver as IResolver; } // TODO(sayan): remove potential dead code if (keyAsValue.$isInterface) { throw createMappedError(ErrorNames.no_jit_interface, keyAsValue.friendlyName); } const resolver = this.config.defaultResolver(keyAsValue, handler); handler._resolvers.set(keyAsValue, resolver); return resolver; } } /** @internal */ class Factory implements IFactory { private transformers: ((instance: any) => any)[] | null = null; public constructor( public Type: T, private readonly dependencies: Key[], ) { } public construct(container: IContainer, dynamicDependencies?: unknown[]): Resolved { const previousContainer = currentContainer; currentContainer = container; let instance: Resolved; /* istanbul ignore next */ if (__DEV__) { let resolvedDeps: unknown[]; let dep: Key | undefined; try { resolvedDeps = this.dependencies.map(_ => container.get(dep = _)); } catch (ex) { logError(`[DEV:aurelia] Error during construction of ${!this.Type.name ? `(Anonymous) ${String(this.Type)}` : this.Type.name}, caused by dependency: ${String(dep)}`); currentContainer = previousContainer; throw ex; } try { if (dynamicDependencies === void 0) { instance = new this.Type(...resolvedDeps) as Resolved; } else { instance = new this.Type(...resolvedDeps, ...dynamicDependencies) as Resolved; } if (this.transformers == null) { return instance; } return this.transformers.reduce(transformInstance, instance); } catch (ex) { logError(`[DEV:aurelia] Error during construction of ${!this.Type.name ? `(Anonymous) ${String(this.Type)}` : this.Type.name}`); throw ex; } finally { currentContainer = previousContainer; } } try { if (dynamicDependencies === void 0) { instance = new this.Type(...this.dependencies.map(containerGetKey, container)) as Resolved; } else { instance = new this.Type(...this.dependencies.map(containerGetKey, container), ...dynamicDependencies) as Resolved; } if (this.transformers == null) { return instance; } return this.transformers.reduce(transformInstance, instance); } finally { currentContainer = previousContainer; } } public registerTransformer(transformer: (instance: any) => any): void { (this.transformers ??= []).push(transformer); } } function transformInstance(inst: Resolved, transform: (instance: any) => any) { return transform(inst); } function validateKey(key: any): void { if (key === null || key === void 0) { throw createMappedError(ErrorNames.null_undefined_key); } } function containerGetKey(this: IContainer, d: Key) { return this.get(d); } export type IResolvedInjection = K extends IAllResolver ? Resolved[] : K extends INewInstanceResolver ? Resolved : K extends ILazyResolver ? IResolvedLazy : K extends IOptionalResolver ? Resolved | undefined : K extends IFactoryResolver ? IResolvedFactory : K extends IResolver ? Resolved : K extends [infer R1 extends Key, ...infer R2] ? [IResolvedInjection, ...IResolvedInjection] : K extends InterfaceSymbol ? T : Resolved; /** * Retrieve the resolved value of a key, or values of a list of keys from the currently active container. * * Calling this without an active container will result in an error. */ export function resolve(key: K): IResolvedInjection; export function resolve(...keys: K): IResolvedInjection; export function resolve(...keys: A): Resolved | Resolved[] { if (currentContainer == null) { throw createMappedError(ErrorNames.no_active_container_for_resolve, ...keys); } /* istanbul ignore next */ if (__DEV__) { if (keys.length === 1) { try { return currentContainer.get(keys[0]); } catch (ex) { logError(`[DEV:aurelia] resolve() call error for: ${String(keys[0])}`); throw ex; } } else { let key: Key | undefined; try { return keys.map(_ => currentContainer!.get(key = _)); } catch (ex) { logError(`[DEV:aurelia] resolve() call error for: ${String(key)}`); throw ex; } } } return keys.length === 1 ? currentContainer.get(keys[0]) : keys.map(containerGetKey, currentContainer); } const buildAllResponse = (resolver: IResolver, handler: IContainer, requestor: IContainer): any[] => { if (resolver instanceof Resolver && resolver._strategy === ResolverStrategy.array) { const state = resolver._state as IResolver[]; const ii = state.length; const results = Array(ii); let i = 0; for (; i < ii; ++i) { results[i] = state[i].resolve(handler, requestor); } return results; } return [resolver.resolve(handler, requestor)]; }; const containerResolver: IResolver = { $isResolver: true, resolve(handler: IContainer, requestor: IContainer): IContainer { return requestor; } }; const isRegistry = (obj: IRegistry | Record): obj is IRegistry => isFunction(obj?.register); const isSelfRegistry = (obj: RegisterSelf): obj is RegisterSelf => isRegistry(obj) && typeof obj.registerInRequestor === 'boolean'; const isRegisterInRequester = (obj: RegisterSelf): obj is RegisterSelf => isSelfRegistry(obj) && obj.registerInRequestor; const isClass = (obj: unknown): obj is Class => (obj as { prototype: object }).prototype !== void 0; const isResourceKey = (key: Key): key is string => isString(key) && key.indexOf(':') > 0;