feat(env): CEDAR_DELAY_API_RESTART (#1130)

Author: Tobbe

docs/docs/environment-variables.md

@@ -157,3 +157,22 @@ config({
 Remember, if `yarn cedar dev` is already running, your local app won't reflect
 any changes you make to your `.env` file until you stop and re-run
 `yarn cedar dev`.
+
+## Pre-defined Environment Variables
+
+Cedar provides a few pre-defined environment variables that you can use in your
+app (this list is a work in progress):
+
+- `RWJS_API_URL`: URL or absolute path to your api-server. This is mapped from
+  `apiUrl` in your `cedar.toml` file.
+- `RWJS_API_GRAPHQL_URL`: The URL of the GraphQL API server. Mapped from
+  `apiGraphQLUrl` in `cedar.toml`.
+- `CEDAR_DELAY_API_RESTART`: Cedar's api server rebuilds all code and
+  auto-restarts as soon as it detects a change in the codebase. Cedar debounces
+  this to avoid excessive rebuilds/restarts when multiple files are changed at
+  once. By default, the debounce delay is 500ms, but you can adjust it with the
+  `CEDAR_DELAY_API_RESTART` environment variable.
+- `RWJS_CWD`: Lets you control the working directory of your app. Mostly used
+  when working on the framework itself, not when building a Cedar app.
+- `CFW_PATH`: Used together with the `cfw` bin. Also mostly used when working on
+  the framework itself, not when building a Cedar app.

packages/api-server/src/buildManager.ts

@@ -15,6 +15,9 @@ class BuildManager {
     this.shouldRebuild = true
     this.shouldClean = false
     this.buildFn = buildFn
+    // TODO: Remove process.env.RWJS_DELAY_RESTART in next major release
+    const delay =
+      process.env.CEDAR_DELAY_API_RESTART || process.env.RWJS_DELAY_RESTART
     this.debouncedBuild = debounce(
       async (options: BuildAndRestartOptions) => {
         // Use flags with higher precedence to determine if we should rebuild or clean
@@ -29,14 +32,11 @@ class BuildManager {
           this.shouldClean = false
         }
       },
-      // We want to delay execution when multiple files are modified on the filesystem,
-      // this usually happens when running RedwoodJS generator commands.
-      // Local writes are very fast, but writes in e2e environments are not,
-      // so allow the default to be adjusted with an env-var.
-      //
-      process.env.RWJS_DELAY_RESTART
-        ? parseInt(process.env.RWJS_DELAY_RESTART, 10)
-        : 500,
+      // We want to delay execution when multiple files are modified on the
+      // filesystem. This usually happens when running Cedar generator commands.
+      // Local writes are very fast, but writes in e2e environments are not, so
+      // allow the default to be adjusted with an env-var.
+      delay ? parseInt(delay, 10) : 500,
     )
   }
 

tasks/run-e2e.cjs

@@ -140,7 +140,7 @@ const runDevServerInBackground = () => {
       shell: true,
       stdio: 'inherit',
       env: {
-        RWJS_DELAY_RESTART: '500',
+        CEDAR_DELAY_API_RESTART: '500',
         REDWOOD_CI: '1',
       },
     })