Strip out server-only package from worker builds

Author: ericallam

.changeset/dull-mangos-press.md

@@ -0,0 +1,5 @@
+---
+"trigger.dev": patch
+---
+
+Strip out server-only package from worker builds

packages/cli-v3/src/commands/deploy.ts

@@ -45,7 +45,11 @@ import { login } from "./login";
 import { esbuildDecorators } from "@anatine/esbuild-decorators";
 import { Glob, GlobOptions } from "glob";
 import type { SetOptional } from "type-fest";
-import { bundleDependenciesPlugin, workerSetupImportConfigPlugin } from "../utilities/build";
+import {
+  bundleDependenciesPlugin,
+  mockServerOnlyPlugin,
+  workerSetupImportConfigPlugin,
+} from "../utilities/build";
 import { chalkError, chalkPurple, chalkWarning } from "../utilities/cliOutput";
 import {
   logESMRequireError,
@@ -1141,6 +1145,7 @@ async function compileProject(
           __PROJECT_CONFIG__: JSON.stringify(config),
         },
         plugins: [
+          mockServerOnlyPlugin(),
           bundleDependenciesPlugin(
             "workerFacade",
             config.dependenciesToBundle,

packages/cli-v3/src/commands/dev.tsx

@@ -26,6 +26,7 @@ import { CommonCommandOptions, commonOptions, wrapCommandAction } from "../cli/c
 import {
   bundleDependenciesPlugin,
   bundleTriggerDevCore,
+  mockServerOnlyPlugin,
   workerSetupImportConfigPlugin,
 } from "../utilities/build";
 import { chalkError, chalkGrey, chalkPurple, chalkTask, chalkWorker } from "../utilities/cliOutput";
@@ -411,6 +412,7 @@ function useDev({
           __PROJECT_CONFIG__: JSON.stringify(config),
         },
         plugins: [
+          mockServerOnlyPlugin(),
           bundleTriggerDevCore("workerFacade", config.tsconfigPath),
           bundleDependenciesPlugin(
             "workerFacade",

packages/cli-v3/src/utilities/build.ts

@@ -6,6 +6,36 @@ import tsConfigPaths from "tsconfig-paths";
 import { logger } from "./logger";
 import { escapeImportPath } from "./windows";
 
+export function mockServerOnlyPlugin(): Plugin {
+  return {
+    name: "trigger-mock-server-only",
+    setup(build) {
+      build.onResolve({ filter: /server-only/ }, (args) => {
+        if (args.path !== "server-only") {
+          return undefined;
+        }
+
+        logger.debug(`[trigger-mock-server-only] Bundling ${args.path}`, {
+          ...args,
+        });
+
+        return {
+          path: args.path,
+          external: false,
+          namespace: "server-only-mock",
+        };
+      });
+
+      build.onLoad({ filter: /server-only/, namespace: "server-only-mock" }, (args) => {
+        return {
+          contents: `export default true;`,
+          loader: "js",
+        };
+      });
+    },
+  };
+}
+
 export function bundleTriggerDevCore(buildIdentifier: string, tsconfigPath?: string): Plugin {
   return {
     name: "trigger-bundle-core",

pnpm-lock.yaml

@@ -24,6 +24,7 @@
     "react": "^18.2.0",
     "react-email": "^1.6.1",
     "reflect-metadata": "^0.1.13",
+    "server-only": "^0.0.1",
     "stripe": "^12.14.0",
     "typeorm": "^0.3.20",
     "yt-dlp-wrap": "^2.3.12"

references/v3-catalog/package.json

@@ -1,3 +1,4 @@
+import "server-only";
 import { logger, task, wait } from "@trigger.dev/sdk/v3";
 
 export const simplestTask = task({