Method executeAsync

packages/steps/src/BuildStep.ts:213–298

()

  }

  public async executeAsync(): Promise<void> {
    try {
      this.ctx.logger.info(
        { marker: BuildStepLogMarker.START_STEP },
        `Executing build step "${this.displayName}"`
      );
      this.status = BuildStepStatus.IN_PROGRESS;

      await fs.mkdir(this.outputsDir, { recursive: true });
      this.ctx.logger.debug(`Created temporary directory for step outputs: ${this.outputsDir}`);

      await fs.mkdir(this.envsDir, { recursive: true });
      this.ctx.logger.debug(
        `Created temporary directory for step environment variables: ${this.envsDir}`
      );

      if (this.timeoutMs !== undefined) {
        const abortController = new AbortController();

        let timeoutId: NodeJS.Timeout | undefined;
        const timeoutPromise = new Promise<void>((_, reject) => {
          timeoutId = setTimeout(() => {
            // Reject with timeout error FIRST, before killing the process
            // This ensures the timeout error wins the race
            reject(
              new BuildStepRuntimeError(
                `Build step "${this.displayName}" timed out after ${this.timeoutMs}ms`
              )
            );

            abortController.abort();
          }, this.timeoutMs);
        });

        try {
          await Promise.race([
            this.command !== undefined
              ? this.executeCommandAsync({ signal: abortController.signal })
              : this.executeFnAsync({ signal: abortController.signal }),
            timeoutPromise,
          ]);
        } finally {
          if (timeoutId) {
            clearTimeout(timeoutId);
          }
        }
      } else {
        const executionPromise =
          this.command !== undefined
            ? this.executeCommandAsync({ signal: null })
            : this.executeFnAsync({ signal: null });
        await executionPromise;
      }

      this.ctx.logger.info(
        { marker: BuildStepLogMarker.END_STEP, result: BuildStepStatus.SUCCESS },
        `Finished build step "${this.displayName}" successfully`
      );