< Summary - Envilder CLI

Information
Class: src/envilder/core/application/secretResolution/RequiredSecretsResolver.ts
Assembly: Default
File(s): src/envilder/core/application/secretResolution/RequiredSecretsResolver.ts
Tag: 605_44106794472
Line coverage
100%
Covered lines: 26
Uncovered lines: 0
Coverable lines: 26
Total lines: 96
Line coverage: 100%
Branch coverage
100%
Covered branches: 8
Total branches: 8
Branch coverage: 100%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

File(s)

src/envilder/core/application/secretResolution/RequiredSecretsResolver.ts

#LineLine coverage
 1import { findCaseCollisions } from '../../domain/ChildEnvironment.js';
 2import {
 3  InvalidArgumentError,
 4  SecretsFetchError,
 5} from '../../domain/errors/DomainErrors.js';
 6import type { ILogger } from '../../domain/ports/ILogger.js';
 7import type { IProcessContext } from '../../domain/ports/IProcessContext.js';
 8import type { ISecretMasker } from '../../domain/ports/ISecretMasker.js';
 9import type { ISecretProvider } from '../../domain/ports/ISecretProvider.js';
 10import type { IVariableStore } from '../../domain/ports/IVariableStore.js';
 11import {
 12  type FailedSecret,
 13  SecretResolver,
 14  type UnresolvedSecret,
 15} from './SecretResolver.js';
 16
 1317const NUL = '\0';
 18
 19/**
 20 * Resolves every secret of a map file into environment variables, fail-closed:
 21 * it throws instead of returning a partial set.
 22 *
 23 * Shared by the modes that hand secrets to processes as environment variables
 24 * (exec, and the GitHub Action exporting to the job environment), where a
 25 * missing secret must stop the run instead of leaving a variable unset.
 26 */
 27export class RequiredSecretsResolver {
 28  private readonly secretResolver: SecretResolver;
 29
 30  constructor(
 31    secretProvider: ISecretProvider,
 12332    private readonly variableStore: IVariableStore,
 12333    private readonly logger: ILogger,
 34    secretMasker: ISecretMasker,
 12335    private readonly processContext: IProcessContext,
 36  ) {
 12337    this.secretResolver = new SecretResolver(
 38      secretProvider,
 39      logger,
 40      secretMasker,
 41    );
 42  }
 43
 44  /**
 45   * Throws `SecretsFetchError` when any secret is missing, empty or
 46   * unreadable, and `InvalidArgumentError` when the variables cannot be set
 47   * on this platform.
 48   */
 49  async resolve(mapPath: string): Promise<Record<string, string>> {
 8450    const mappings = await this.variableStore.getMapping(mapPath);
 8451    if (Object.keys(mappings).length === 0) {
 152      this.logger.warn('Map file declares no variables.');
 53    }
 8454    this.assertNoCaseCollisions(Object.keys(mappings));
 55
 8456    const { outcomes, resolved } = await this.secretResolver.resolve(mappings);
 7357    const failures = outcomes.filter(
 58      (outcome): outcome is UnresolvedSecret | FailedSecret =>
 13959        outcome.status !== 'resolved',
 60    );
 7361    if (failures.length > 0) {
 1062      this.secretResolver.logSecretsSection(resolved, []);
 1063      throw new SecretsFetchError(failures.map(SecretResolver.toFailure));
 64    }
 65
 6366    const secrets: Record<string, string> = {};
 6367    for (const { envVar, value } of resolved) {
 11768      if (value.includes(NUL)) {
 269        throw new InvalidArgumentError(
 70          `Secret for ${envVar} contains a NUL byte and cannot be passed as an environment variable.`,
 71        );
 72      }
 11573      secrets[envVar] = value;
 74    }
 75
 6176    return secrets;
 77  }
 78
 79  /**
 80   * On Windows two mapped names that differ only by case are one variable,
 81   * so one value would be silently dropped. Refuse before resolving.
 82   */
 83  private assertNoCaseCollisions(names: string[]): void {
 8484    const collisions = findCaseCollisions(
 85      names,
 86      this.processContext.platform(),
 87    );
 8488    if (collisions.length === 0) {
 8189      return;
 90    }
 391    const listed = collisions.map((group) => group.join(', ')).join('; ');
 392    throw new InvalidArgumentError(
 93      `Map file declares variables that differ only by case (${listed}); Windows treats them as the same variable.`,
 94    );
 95  }
 96}