Method boot

packages/boot/src/bootstrapper.ts:68–132

* Function is responsible for calling all registered Booter classes that * are bound to the Application instance. Each phase of an instance must * complete before the next phase is started. * * @param execOptions - Execution options for boot. These * determine the phases and booters t

(
    execOptions?: BootExecutionOptions,
    ctx?: Context,
  )

   * may maintain state.
   */
  async boot(
    execOptions?: BootExecutionOptions,
    ctx?: Context,
  ): Promise<Context> {
    const bootCtx = ctx ?? new Context(this.app);

    // Bind booters passed in as a part of BootOptions
    // We use _bindBooter so this Class can be used without the Mixin
    if (execOptions?.booters) {
      execOptions.booters.forEach(booter => bindBooter(this.app, booter));
    }

    // Determine the phases to be run. If a user set a phases filter, those
    // are selected otherwise we run the default phases (BOOTER_PHASES).
    const phases = execOptions?.filter?.phases ?? BOOTER_PHASES;

    // Find booters registered to the BOOTERS_TAG by getting the bindings
    const bindings = bootCtx.findByTag(BootTags.BOOTER);

    // Prefix length. +1 because of `.` => 'booters.'
    const prefixLength = BootBindings.BOOTERS.length + 1;

    // Names of all registered booters.
    const defaultBooterNames = bindings.map(binding =>
      binding.key.slice(prefixLength),
    );

    // Determining the booters to be run. If a user set a booters filter (class
    // names of booters that should be run), that is the value, otherwise it
    // is all the registered booters by default.
    const names = execOptions
      ? execOptions.filter?.booters
        ? execOptions.filter.booters
        : defaultBooterNames
      : defaultBooterNames;

    // Filter bindings by names
    const filteredBindings = bindings.filter(binding =>
      names.includes(binding.key.slice(prefixLength)),
    );

    // Resolve Booter Instances
    const booterInsts = await resolveList(filteredBindings, binding =>
      // We cannot use Booter interface here because "filter.booters"
      // allows arbitrary string values, not only the phases defined
      // by Booter interface
      bootCtx.get<{[phase: string]: () => Promise<void>}>(binding.key),
    );

    // Run phases of booters
    for (const phase of phases) {
      for (const inst of booterInsts) {
        const instName = inst.constructor.name;
        if (inst[phase]) {
          debug(`${instName} phase: ${phase} starting.`);
          await inst[phase]();
          debug(`${instName} phase: ${phase} complete.`);
        } else {