[worker] warn on unknown build environment

Author: gwdp

packages/worker/src/__unit__/build.test.ts

@@ -0,0 +1,34 @@
+// @ts-nocheck
+import { warnOnUnknownEnvironment } from '../build';
+
+function createCtx(environment) {
+  return {
+    metadata: environment === undefined ? undefined : { environment },
+    markBuildPhaseHasWarnings: jest.fn(),
+    logger: { warn: jest.fn() },
+  };
+}
+
+describe(warnOnUnknownEnvironment.name, () => {
+  it('warns and marks the phase for an unknown environment', () => {
+    const ctx = createCtx('staging');
+    warnOnUnknownEnvironment(ctx);
+    expect(ctx.markBuildPhaseHasWarnings).toHaveBeenCalled();
+    expect(ctx.logger.warn).toHaveBeenCalledWith(
+      expect.stringContaining('Unknown environment "staging"')
+    );
+  });
+
+  it.each(['development', 'preview', 'production'])('does not warn for %s', environment => {
+    const ctx = createCtx(environment);
+    warnOnUnknownEnvironment(ctx);
+    expect(ctx.markBuildPhaseHasWarnings).not.toHaveBeenCalled();
+    expect(ctx.logger.warn).not.toHaveBeenCalled();
+  });
+
+  it('does not warn when no environment is set', () => {
+    const ctx = createCtx(undefined);
+    warnOnUnknownEnvironment(ctx);
+    expect(ctx.logger.warn).not.toHaveBeenCalled();
+  });
+});

packages/worker/src/build.ts

@@ -19,6 +19,20 @@ import { Analytics, Event, logProjectDependenciesAsync } from './external/analyt
 import { prepareRuntimeEnvironment } from './runtimeEnvironment';
 import { cleanUpWorkingdir } from './workingdir';
 
+const KNOWN_BUILD_ENVIRONMENTS = ['development', 'preview', 'production'];
+
+export function warnOnUnknownEnvironment(ctx: BuildContext): void {
+  const environment = ctx.metadata?.environment;
+  if (environment && !KNOWN_BUILD_ENVIRONMENTS.includes(environment)) {
+    ctx.markBuildPhaseHasWarnings();
+    ctx.logger.warn(
+      `Unknown environment "${environment}". Expected one of: ${KNOWN_BUILD_ENVIRONMENTS.join(
+        ', '
+      )}. No environment variables were added for it.`
+    );
+  }
+}
+
 export async function build({
   ctx,
   buildId,
@@ -40,6 +54,7 @@ export async function build({
           { job: omit(ctx.job, 'secrets', 'projectArchive') },
           'Builder is ready, starting build'
         );
+        warnOnUnknownEnvironment(ctx);
       },
       { doNotMarkStart: true }
     );