Support ignoring test/spec files inside trigger dirs (fixes #1593) (#…

…1596) * Support ignoring test/spec files inside trigger dirs (fixes #1593) * Add changeset
triggerdotdev · Jan 10, 2025 · 9e0f036 · 9e0f036
1 parent 914ceaf
commit 9e0f036
Show file tree

Hide file tree

Showing 17 changed files with 850 additions and 64 deletions.
diff --git a/.changeset/famous-grapes-film.md b/.changeset/famous-grapes-film.md
@@ -0,0 +1,5 @@
+---
+"trigger.dev": patch
+---
+
+Support ignoring test/spec files inside trigger dirs (fixes #1593)
diff --git a/docs/config/config-file.mdx b/docs/config/config-file.mdx
@@ -47,6 +47,33 @@ The config file handles a lot of things, like:
   imports used inside build config with be tree-shaken out.
 </Note>
 
+## Dirs
+
+You can specify the directories where your tasks are located using the `dirs` option:
+
+```ts trigger.config.ts
+import { defineConfig } from "@trigger.dev/sdk/v3";
+
+export default defineConfig({
+  project: "<project ref>",
+  dirs: ["./trigger"],
+});
+```
+
+If you omit the `dirs` option, we will automatically detect directories that are named `trigger` in your project, but we recommend specifying the directories explicitly. The `dirs` option is an array of strings, so you can specify multiple directories if you have tasks in multiple locations.
+
+We will search for TypeScript and JavaScript files in the specified directories and include them in the build process. We automatically exclude files that have `.test` or `.spec` in the name, but you can customize this by specifying glob patterns in the `ignorePatterns` option:
+
+```ts trigger.config.ts
+import { defineConfig } from "@trigger.dev/sdk/v3";
+
+export default defineConfig({
+  project: "<project ref>",
+  dirs: ["./trigger"],
+  ignorePatterns: ["**/*.my-test.ts"],
+});
+```
+
 ## Lifecycle functions
 
 You can add lifecycle functions to get notified when any task starts, succeeds, or fails using `onStart`, `onSuccess` and `onFailure`:

diff --git a/docs/mint.json b/docs/mint.json
@@ -1,7 +1,10 @@
 {
   "$schema": "https://mintlify.com/schema.json",
   "name": "Trigger.dev",
-  "openapi": ["/openapi.yml", "/v3-openapi.yaml"],
+  "openapi": [
+    "/openapi.yml",
+    "/v3-openapi.yaml"
+  ],
   "api": {
     "playground": {
       "mode": "simple"
@@ -128,7 +131,6 @@
         "quick-start",
         "video-walkthrough",
         "how-it-works",
-        "upgrading-beta",
         "limits"
       ]
     },
@@ -137,20 +139,30 @@
       "pages": [
         {
           "group": "Tasks",
-          "pages": ["tasks/overview", "tasks/schemaTask", "tasks/scheduled"]
+          "pages": [
+            "tasks/overview",
+            "tasks/schemaTask",
+            "tasks/scheduled"
+          ]
         },
         "triggering",
         "runs",
         "apikeys",
         {
           "group": "Configuration",
-          "pages": ["config/config-file", "config/extensions/overview"]
+          "pages": [
+            "config/config-file",
+            "config/extensions/overview"
+          ]
         }
       ]
     },
     {
       "group": "Development",
-      "pages": ["cli-dev", "run-tests"]
+      "pages": [
+        "cli-dev",
+        "run-tests"
+      ]
     },
     {
       "group": "Deployment",
@@ -160,7 +172,9 @@
         "github-actions",
         {
           "group": "Deployment integrations",
-          "pages": ["vercel-integration"]
+          "pages": [
+            "vercel-integration"
+          ]
         }
       ]
     },
@@ -172,7 +186,13 @@
         "errors-retrying",
         {
           "group": "Wait",
-          "pages": ["wait", "wait-for", "wait-until", "wait-for-event", "wait-for-request"]
+          "pages": [
+            "wait",
+            "wait-for",
+            "wait-until",
+            "wait-for-event",
+            "wait-for-request"
+          ]
         },
         "queue-concurrency",
         "versioning",
@@ -217,7 +237,10 @@
         "management/overview",
         {
           "group": "Tasks API",
-          "pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
+          "pages": [
+            "management/tasks/trigger",
+            "management/tasks/batch-trigger"
+          ]
         },
         {
           "group": "Runs API",
@@ -256,7 +279,9 @@
         },
         {
           "group": "Projects API",
-          "pages": ["management/projects/runs"]
+          "pages": [
+            "management/projects/runs"
+          ]
         }
       ]
     },
@@ -294,6 +319,7 @@
       "pages": [
         "troubleshooting",
         "upgrading-packages",
+        "upgrading-beta",
         "troubleshooting-alerts",
         "troubleshooting-uptime-status",
         "troubleshooting-github-issues",
@@ -302,11 +328,17 @@
     },
     {
       "group": "Help",
-      "pages": ["community", "help-slack", "help-email"]
+      "pages": [
+        "community",
+        "help-slack",
+        "help-email"
+      ]
     },
     {
       "group": "",
-      "pages": ["guides/introduction"]
+      "pages": [
+        "guides/introduction"
+      ]
     },
     {
       "group": "Frameworks",
@@ -380,16 +412,20 @@
     },
     {
       "group": "Dashboard",
-      "pages": ["guides/dashboard/creating-a-project"]
+      "pages": [
+        "guides/dashboard/creating-a-project"
+      ]
     },
     {
       "group": "Migrations",
-      "pages": ["guides/use-cases/upgrading-from-v2"]
+      "pages": [
+        "guides/use-cases/upgrading-from-v2"
+      ]
     }
   ],
   "footerSocials": {
     "twitter": "https://twitter.com/triggerdotdev",
     "github": "https://github.com/triggerdotdev",
     "linkedin": "https://www.linkedin.com/company/triggerdotdev"
   }
-}
+}
diff --git a/packages/cli-v3/package.json b/packages/cli-v3/package.json
@@ -91,6 +91,7 @@
     "@trigger.dev/core": "workspace:3.3.9",
     "c12": "^1.11.1",
     "chalk": "^5.2.0",
+    "chokidar": "^3.6.0",
     "cli-table3": "^0.6.3",
     "commander": "^9.4.1",
     "defu": "^6.1.4",
@@ -119,6 +120,7 @@
     "terminal-link": "^3.0.0",
     "tiny-invariant": "^1.2.0",
     "tinyexec": "^0.3.1",
+    "tinyglobby": "^0.2.2",
     "ws": "^8.18.0",
     "xdg-app-paths": "^8.3.0",
     "zod": "3.23.8",

diff --git a/packages/cli-v3/src/build/bundle.ts b/packages/cli-v3/src/build/bundle.ts
@@ -17,6 +17,7 @@ import {
   telemetryEntryPoint,
 } from "./packageModules.js";
 import { buildPlugins } from "./plugins.js";
+import { createEntryPointManager } from "./entryPoints.js";
 
 export interface BundleOptions {
   target: BuildTarget;
@@ -45,12 +46,30 @@ export type BundleResult = {
 export async function bundleWorker(options: BundleOptions): Promise<BundleResult> {
   const { resolvedConfig } = options;
 
-  // We need to add the package entry points here somehow
-  // Then we need to get them out of the build result into the build manifest
-  // taskhero/dist/esm/workers/dev.js
-  // taskhero/dist/esm/telemetry/loader.js
-  const entryPoints = await getEntryPoints(options.target, resolvedConfig);
-  const $buildPlugins = await buildPlugins(options.target, resolvedConfig);
+  let currentContext: esbuild.BuildContext | undefined;
+
+  const entryPointManager = await createEntryPointManager(
+    resolvedConfig.dirs,
+    resolvedConfig,
+    options.target,
+    typeof options.watch === "boolean" ? options.watch : false,
+    async (newEntryPoints) => {
+      if (currentContext) {
+        // Rebuild with new entry points
+        await currentContext.cancel();
+        await currentContext.dispose();
+        const buildOptions = await createBuildOptions({
+          ...options,
+          entryPoints: newEntryPoints,
+        });
+
+        logger.debug("Rebuilding worker with options", buildOptions);
+
+        currentContext = await esbuild.context(buildOptions);
+        await currentContext.watch();
+      }
+    }
+  );
 
   let initialBuildResult: (result: esbuild.BuildResult) => void;
   const initialBuildResultPromise = new Promise<esbuild.BuildResult>(
@@ -63,12 +82,63 @@ export async function bundleWorker(options: BundleOptions): Promise<BundleResult
     },
   };
 
+  const buildOptions = await createBuildOptions({
+    ...options,
+    entryPoints: entryPointManager.entryPoints,
+    buildResultPlugin,
+  });
+
+  let result: esbuild.BuildResult<typeof buildOptions>;
+  let stop: BundleResult["stop"];
+
+  logger.debug("Building worker with options", buildOptions);
+
+  if (options.watch) {
+    currentContext = await esbuild.context(buildOptions);
+    await currentContext.watch();
+    result = await initialBuildResultPromise;
+    if (result.errors.length > 0) {
+      throw new Error("Failed to build");
+    }
+
+    stop = async function () {
+      await entryPointManager.stop();
+      await currentContext?.dispose();
+    };
+  } else {
+    result = await esbuild.build(buildOptions);
+
+    stop = async function () {
+      await entryPointManager.stop();
+    };
+  }
+
+  const bundleResult = await getBundleResultFromBuild(
+    options.target,
+    options.cwd,
+    options.resolvedConfig,
+    result
+  );
+
+  if (!bundleResult) {
+    throw new Error("Failed to get bundle result");
+  }
+
+  return { ...bundleResult, stop };
+}
+
+// Helper function to create build options
+async function createBuildOptions(
+  options: BundleOptions & { entryPoints: string[]; buildResultPlugin?: esbuild.Plugin }
+): Promise<esbuild.BuildOptions & { metafile: true }> {
   const customConditions = options.resolvedConfig.build?.conditions ?? [];
 
   const conditions = [...customConditions, "trigger.dev", "module", "node"];
 
-  const buildOptions: esbuild.BuildOptions & { metafile: true } = {
-    entryPoints,
+  const $buildPlugins = await buildPlugins(options.target, options.resolvedConfig);
+
+  return {
+    entryPoints: options.entryPoints,
     outdir: options.destination,
     absWorkingDir: options.cwd,
     bundle: true,
@@ -93,50 +163,18 @@ export async function bundleWorker(options: BundleOptions): Promise<BundleResult
     inject: [...shims], // TODO: copy this into the working dir to work with Yarn PnP
     jsx: options.jsxAutomatic ? "automatic" : undefined,
     jsxDev: options.jsxAutomatic && options.target === "dev" ? true : undefined,
-    plugins: [...$buildPlugins, ...(options.plugins ?? []), buildResultPlugin],
+    plugins: [
+      ...$buildPlugins,
+      ...(options.plugins ?? []),
+      ...(options.buildResultPlugin ? [options.buildResultPlugin] : []),
+    ],
     ...(options.jsxFactory && { jsxFactory: options.jsxFactory }),
     ...(options.jsxFragment && { jsxFragment: options.jsxFragment }),
     logLevel: "silent",
     logOverride: {
       "empty-glob": "silent",
     },
   };
-
-  let result: esbuild.BuildResult<typeof buildOptions>;
-  let stop: BundleResult["stop"];
-
-  logger.debug("Building worker with options", buildOptions);
-
-  if (options.watch) {
-    const ctx = await esbuild.context(buildOptions);
-    await ctx.watch();
-    result = await initialBuildResultPromise;
-    if (result.errors.length > 0) {
-      throw new Error("Failed to build");
-    }
-
-    stop = async function () {
-      await ctx.dispose();
-    };
-  } else {
-    result = await esbuild.build(buildOptions);
-    // Even when we're not watching, we still want some way of cleaning up the
-    // temporary directory when we don't need it anymore
-    stop = async function () {};
-  }
-
-  const bundleResult = await getBundleResultFromBuild(
-    options.target,
-    options.cwd,
-    options.resolvedConfig,
-    result
-  );
-
-  if (!bundleResult) {
-    throw new Error("Failed to get bundle result");
-  }
-
-  return { ...bundleResult, stop };
 }
 
 export async function getBundleResultFromBuild(