inversify/InversifyJS

import { BindingCount } from '../bindings/binding_count';
import * as ERROR_MSGS from '../constants/error_msgs';
import { BindingTypeEnum, TargetTypeEnum } from '../constants/literal_types';
import * as METADATA_KEY from '../constants/metadata_keys';
import { interfaces } from '../interfaces/interfaces';
import { isStackOverflowExeption } from '../utils/exceptions';
import { circularDependencyToException, getServiceIdentifierAsString, listMetadataForTarget, listRegisteredBindingsForServiceIdentifier } from '../utils/serialization';
import { Context } from './context';
import { Metadata } from './metadata';
import { Plan } from './plan';
import { getBaseClassDependencyCount, getDependencies, getFunctionName } from './reflection_utils';
import { Request } from './request';
import { Target } from './target';

function getBindingDictionary(cntnr: interfaces.Container): interfaces.Lookup<interfaces.Binding<unknown>> {
  return (cntnr as unknown as { _bindingDictionary: interfaces.Lookup<interfaces.Binding<unknown>> })._bindingDictionary;
}

function _createTarget(
  isMultiInject: boolean,
  targetType: interfaces.TargetType,
  serviceIdentifier: interfaces.ServiceIdentifier,
  name: string,
  key?: string | number | symbol,
  value?: unknown
): interfaces.Target {

  const metadataKey = isMultiInject ? METADATA_KEY.MULTI_INJECT_TAG : METADATA_KEY.INJECT_TAG;
  const injectMetadata = new Metadata(metadataKey, serviceIdentifier);
  const target = new Target(targetType, name, serviceIdentifier, injectMetadata);

  if (key !== undefined) {
    const tagMetadata = new Metadata(key, value);
    target.metadata.push(tagMetadata);
  }

  return target;

}

function _getActiveBindings(
  metadataReader: interfaces.MetadataReader,
  avoidConstraints: boolean,
  context: interfaces.Context,
  parentRequest: interfaces.Request | null,
  target: interfaces.Target
): interfaces.Binding<unknown>[] {

  let bindings = getBindings(context.container, target.serviceIdentifier);
  let activeBindings: interfaces.Binding<unknown>[] = [];

  // automatic binding
  if (bindings.length === BindingCount.NoBindingsAvailable &&
    context.container.options.autoBindInjectable &&
    typeof target.serviceIdentifier === 'function' &&
    metadataReader.getConstructorMetadata(target.serviceIdentifier).compilerGeneratedMetadata
  ) {
    context.container.bind(target.serviceIdentifier).toSelf();
    bindings = getBindings(context.container, target.serviceIdentifier);
  }

  // multiple bindings available
  if (!avoidConstraints) {

    // apply constraints if available to reduce the number of active bindings
    activeBindings = bindings.filter((binding) => {

      const request = new Request(
        binding.serviceIdentifier,
        context,
        parentRequest,
        binding,
        target
      );

      return binding.constraint(request);

    });

  } else {
    // simple injection or multi-injection without constraints
    activeBindings = bindings;
  }

  // validate active bindings
  _validateActiveBindingCount(target.serviceIdentifier, activeBindings, target, context.container);

  return activeBindings;
}

function _validateActiveBindingCount(
  serviceIdentifier: interfaces.ServiceIdentifier,
  bindings: interfaces.Binding<unknown>[],
  target: interfaces.Target,
  container: interfaces.Container
): interfaces.Binding<unknown>[] {

  switch (bindings.length) {

    case BindingCount.NoBindingsAvailable:
      if (target.isOptional()) {
        return bindings;
      } else {
        const serviceIdentifierString = getServiceIdentifierAsString(serviceIdentifier);
        let msg = ERROR_MSGS.NOT_REGISTERED;
        msg += listMetadataForTarget(serviceIdentifierString, target);
        msg += listRegisteredBindingsForServiceIdentifier(container, serviceIdentifierString, getBindings);
        throw new Error(msg);
      }

    case BindingCount.OnlyOneBindingAvailable:
      return bindings;
    case BindingCount.MultipleBindingsAvailable:
    default:
      if (!target.isArray()) {
        const serviceIdentifierString = getServiceIdentifierAsString(serviceIdentifier);
        let msg = `${ERROR_MSGS.AMBIGUOUS_MATCH} ${serviceIdentifierString}`;
        msg += listRegisteredBindingsForServiceIdentifier(container, serviceIdentifierString, getBindings);
        throw new Error(msg);
      } else {
        return bindings;
      }
  }

}

function _createSubRequests(
  metadataReader: interfaces.MetadataReader,
  avoidConstraints: boolean,
  serviceIdentifier: interfaces.ServiceIdentifier,
  context: interfaces.Context,
  parentRequest: interfaces.Request | null,
  target: interfaces.Target
) {

  let activeBindings: interfaces.Binding<unknown>[];
  let childRequest: interfaces.Request;

  if (parentRequest === null) {

    activeBindings = _getActiveBindings(metadataReader, avoidConstraints, context, null, target);

    childRequest = new Request(
      serviceIdentifier,
      context,
      null,
      activeBindings,
      target
    );

    const thePlan = new Plan(context, childRequest);
    context.addPlan(thePlan);

  } else {
    activeBindings = _getActiveBindings(metadataReader, avoidConstraints, context, parentRequest, target);
    childRequest = parentRequest.addChildRequest(target.serviceIdentifier, activeBindings, target);
  }

  activeBindings.forEach((binding) => {

    let subChildRequest: interfaces.Request | null = null;

    if (target.isArray()) {
      subChildRequest = childRequest.addChildRequest(binding.serviceIdentifier, binding, target);
    } else {
      if (binding.cache) {
        return;
      }
      subChildRequest = childRequest;
    }

    if (binding.type === BindingTypeEnum.Instance && binding.implementationType !== null) {

      const dependencies = getDependencies(metadataReader, binding.implementationType as NewableFunction);

      if (!context.container.options.skipBaseClassChecks) {
        // Throw if a derived class does not implement its constructor explicitly
        // We do this to prevent errors when a base class (parent) has dependencies
        // and one of the derived classes (children) has no dependencies
        const baseClassDependencyCount = getBaseClassDependencyCount(metadataReader, binding.implementationType as NewableFunction);

        if (dependencies.length < baseClassDependencyCount) {
          const error = ERROR_MSGS.ARGUMENTS_LENGTH_MISMATCH(getFunctionName(binding.implementationType as NewableFunction));
          throw new Error(error);
        }
      }

      dependencies.forEach((dependency: interfaces.Target) => {
        _createSubRequests(metadataReader, false, dependency.serviceIdentifier, context, subChildRequest, dependency);
      });

    }

  });

}

function getBindings<T>(
  container: interfaces.Container,
  serviceIdentifier: interfaces.ServiceIdentifier<T>
): interfaces.Binding<T>[] {

  let bindings: interfaces.Binding<T>[] = [];
  const bindingDictionary = getBindingDictionary(container);

  if (bindingDictionary.hasKey(serviceIdentifier)) {

    bindings = bindingDictionary.get(serviceIdentifier) as interfaces.Binding<T>[];

  } else if (container.parent !== null) {

    // recursively try to get bindings from parent container
    bindings = getBindings<T>(container.parent, serviceIdentifier);

  }

  return bindings;
}

function plan(
  metadataReader: interfaces.MetadataReader,
  container: interfaces.Container,
  isMultiInject: boolean,
  targetType: interfaces.TargetType,
  serviceIdentifier: interfaces.ServiceIdentifier,
  key?: string | number | symbol,
  value?: unknown,
  avoidConstraints = false
): interfaces.Context {

  const context = new Context(container);
  const target = _createTarget(isMultiInject, targetType, serviceIdentifier, '', key, value);

  try {
    _createSubRequests(metadataReader, avoidConstraints, serviceIdentifier, context, null, target);
    return context;
  } catch (error) {
    if (
      isStackOverflowExeption(error)
    ) {
      circularDependencyToException(context.plan.rootRequest);
    }
    throw error;
  }

}

function createMockRequest(
  container: interfaces.Container,
  serviceIdentifier: interfaces.ServiceIdentifier,
  key: string | number | symbol,
  value: unknown
): interfaces.Request {

  const target = new Target(TargetTypeEnum.Variable, '', serviceIdentifier, new Metadata(key, value));
  const context = new Context(container);
  const request = new Request(serviceIdentifier, context, null, [], target);
  return request;
}

export { plan, createMockRequest, getBindingDictionary };