feat(nx-mesh): add build watcher

domjtalbot · Jan 31, 2023 · 53b3ffa · 53b3ffa
1 parent 3c45307
commit 53b3ffa
Show file tree

Hide file tree

Showing 12 changed files with 230 additions and 132 deletions.
diff --git a/README.md b/README.md
@@ -308,6 +308,7 @@ This is the equivalent of using `graphql-mesh dev`, but with extra steps for pac
 | `transformers`                            | `string[]`                           |    -     | -                  | List of TypeScript Transformer Plugins.                                                                                          |
 | `tsConfig`                                | `string`                             |    ✅    | -                  | The path to the Typescript configuration file.                                                                                   |
 | `updateBuildableProjectDepsInPackageJson` | `boolean`                            |    -     | `true`             | Whether to update the buildable project dependencies in `package.json`.                                                          |
+| `watch`                                   | `boolean`                            |    -     | `false`            | Rebuild upon file changes.                                                                                                       |
 
 </details>
 
@@ -391,6 +392,7 @@ This is the equivalent of using `graphql-mesh build`, but with extra steps for p
 | `transformers`                            | `string[]`                           |    -     | -                  | List of TypeScript Transformer Plugins.                                                                                          |
 | `tsConfig`                                | `string`                             |    ✅    | -                  | The path to the Typescript configuration file.                                                                                   |
 | `updateBuildableProjectDepsInPackageJson` | `boolean`                            |    -     | `true`             | Whether to update the buildable project dependencies in `package.json`.                                                          |
+| `watch`                                   | `boolean`                            |    -     | `false`            | Rebuild upon file changes.                                                                                                       |
 
 </details>
 

diff --git a/libs/example/sdk/graphql/star-wars-api/project.json b/libs/example/sdk/graphql/star-wars-api/project.json
@@ -37,6 +37,13 @@
         }
       }
     },
+    "dev": {
+      "executor": "nx-mesh:serve",
+      "options": {
+        "dev": true,
+        "dir": "libs/example/sdk/graphql/star-wars-api"
+      }
+    },
     "serve": {
       "executor": "nx-mesh:serve",
       "options": {

diff --git a/libs/nx-mesh/src/executors/build-gateway/build-gateway.impl.ts b/libs/nx-mesh/src/executors/build-gateway/build-gateway.impl.ts
@@ -52,6 +52,8 @@ export default async function* buildExecutor(
     context
   );
 
+  logger.info('Done.');
+
   yield {
     success: true,
   };

diff --git a/libs/nx-mesh/src/executors/build-swc/build-swc.impl.ts b/libs/nx-mesh/src/executors/build-swc/build-swc.impl.ts
@@ -3,7 +3,7 @@ import type { ExecutorContext } from '@nrwl/devkit';
 import { logger } from '@nrwl/devkit';
 import { resolve } from 'path';
 
-import { createPackageJson } from '../../utils';
+import { createPackageJson, watcher } from '../../utils';
 import { runCodegenCli } from '../../utils/graphql-codegen-cli';
 import { runMeshCli } from '../../utils/mesh-cli';
 import { swcExecutor } from './swc-executor/swc.impl';
@@ -20,69 +20,79 @@ export default async function* buildExecutor(
   const dir = resolve(context.root, options.dir);
   let success = false;
 
-  await runMeshCli(
-    'build',
-    {
-      args: {
-        dir,
-        require: options.require,
-      },
-      env: {
-        debug: options.debug,
-      },
-    },
-    context
-  );
+  await watcher(
+    async () => {
+      await runMeshCli(
+        'build',
+        {
+          args: {
+            dir,
+            require: options.require,
+          },
+          env: {
+            debug: options.debug,
+          },
+        },
+        context
+      );
 
-  if (options.codegen?.config) {
-    logger.info('');
-    logger.info('Running GraphQL Codegen...');
+      if (options.codegen?.config) {
+        logger.info('');
+        logger.info('Running GraphQL Codegen...');
 
-    await runCodegenCli(
-      {
-        ...options.codegen,
-        debug: options.debug,
-        verbose: true,
-        watch: options.watch,
-      },
-      context
-    );
-  }
+        await runCodegenCli(
+          {
+            ...options.codegen,
+            debug: options.debug,
+            verbose: true,
+            watch: false,
+          },
+          context
+        );
+      }
 
-  logger.info('');
-  logger.info('Running SWC compiler...');
+      logger.info('');
+      logger.info('Running SWC compiler...');
 
-  const tsc = swcExecutor(
-    {
-      assets: [...options.assets],
-      main: options.main,
-      outputPath: options.outputPath,
-      skipTypeCheck: options.skipTypeCheck,
-      swcrc: options.swcrc,
-      transformers: [],
-      tsConfig: options.tsConfig,
-      watch: false,
-    },
-    context
-  );
+      const tsc = swcExecutor(
+        {
+          assets: [...options.assets],
+          main: options.main,
+          outputPath: options.outputPath,
+          skipTypeCheck: options.skipTypeCheck,
+          swcrc: options.swcrc,
+          transformers: [],
+          tsConfig: options.tsConfig,
+          watch: false,
+        },
+        context
+      );
 
-  for await (const result of tsc) {
-    success = result.success;
-  }
+      for await (const result of tsc) {
+        success = result.success;
+      }
 
-  if (success) {
-    logger.info('');
-    logger.info('Creating package.json...');
+      if (success) {
+        logger.info('');
+        logger.info('Creating package.json...');
 
-    await createPackageJson(
-      {
-        dir: options.dir,
-        outputPath: options.outputPath,
-        projectRoot: options.outputPath,
-      },
-      context
-    );
-  }
+        await createPackageJson(
+          {
+            dir,
+            outputPath: options.outputPath,
+            projectRoot: options.outputPath,
+          },
+          context
+        );
+
+        logger.info('Done.');
+      }
+    },
+    {
+      dir,
+      watch: options.watch,
+    }
+  );
 
   yield {
     success,

diff --git a/libs/nx-mesh/src/executors/build-swc/schema.json b/libs/nx-mesh/src/executors/build-swc/schema.json
@@ -34,7 +34,7 @@
     },
     "watch": {
       "type": "boolean",
-      "description": "Enable re-building when files change.",
+      "description": "Rebuild upon file changes.",
       "default": false
     },
     "transformers": {

diff --git a/libs/nx-mesh/src/executors/build/build.impl.ts b/libs/nx-mesh/src/executors/build/build.impl.ts
@@ -4,7 +4,7 @@ import { logger } from '@nrwl/devkit';
 import { tscExecutor } from '@nrwl/js/src/executors/tsc/tsc.impl';
 import { resolve } from 'path';
 
-import { createPackageJson } from '../../utils';
+import { createPackageJson, watcher } from '../../utils';
 import { runCodegenCli } from '../../utils/graphql-codegen-cli';
 import { runMeshCli } from '../../utils/mesh-cli';
 
@@ -21,67 +21,77 @@ export default async function* buildExecutor(
   const dir = resolve(context.root, options.dir);
   let success = false;
 
-  await runMeshCli(
-    'build',
-    {
-      args: {
-        dir,
-        require: options.require,
-      },
-      env: {
-        debug: options.debug,
-      },
-    },
-    context
-  );
+  await watcher(
+    async () => {
+      await runMeshCli(
+        'build',
+        {
+          args: {
+            dir,
+            require: options.require,
+          },
+          env: {
+            debug: options.debug,
+          },
+        },
+        context
+      );
 
-  if (options.codegen?.config) {
-    logger.info('');
-    logger.info('Running GraphQL Codegen...');
+      if (options.codegen?.config) {
+        logger.info('');
+        logger.info('Running GraphQL Codegen...');
 
-    await runCodegenCli(
-      {
-        ...options.codegen,
-        debug: options.debug,
-        verbose: true,
-        watch: options.watch,
-      },
-      context
-    );
-  }
+        await runCodegenCli(
+          {
+            ...options.codegen,
+            debug: options.debug,
+            verbose: true,
+            watch: options.watch,
+          },
+          context
+        );
+      }
 
-  logger.info('');
-  logger.info('Running Typescript compiler...');
+      logger.info('');
+      logger.info('Running Typescript compiler...');
 
-  const tsc = tscExecutor(
-    {
-      assets: [...options.assets],
-      main: options.main,
-      outputPath: options.outputPath,
-      transformers: [],
-      tsConfig: options.tsConfig,
-      watch: false,
-    },
-    context
-  );
+      const tsc = tscExecutor(
+        {
+          assets: [...options.assets],
+          main: options.main,
+          outputPath: options.outputPath,
+          transformers: [],
+          tsConfig: options.tsConfig,
+          watch: false,
+        },
+        context
+      );
 
-  for await (const result of tsc) {
-    success = result.success;
-  }
+      for await (const result of tsc) {
+        success = result.success;
+      }
 
-  if (success) {
-    logger.info('');
-    logger.info('Creating package.json...');
+      if (success) {
+        logger.info('');
+        logger.info('Creating package.json...');
 
-    await createPackageJson(
-      {
-        dir: options.dir,
-        outputPath: options.outputPath,
-        projectRoot: options.outputPath,
-      },
-      context
-    );
-  }
+        await createPackageJson(
+          {
+            dir,
+            outputPath: options.outputPath,
+            projectRoot: options.outputPath,
+          },
+          context
+        );
+
+        logger.info('Done.');
+      }
+    },
+    {
+      dir,
+      watch: options.watch,
+    }
+  );
 
   yield {
     success,

diff --git a/libs/nx-mesh/src/executors/build/schema.json b/libs/nx-mesh/src/executors/build/schema.json
@@ -25,7 +25,7 @@
     },
     "watch": {
       "type": "boolean",
-      "description": "Enable re-building when files change.",
+      "description": "Rebuild upon file changes.",
       "default": false
     },
     "transformers": {

diff --git a/libs/nx-mesh/src/utils/index.ts b/libs/nx-mesh/src/utils/index.ts
@@ -4,3 +4,4 @@ export * from './get-package-versions';
 export * from './get-source-file';
 export * from './get-wildcard-packages';
 export * from './mesh-packages';
+export * from './watcher';
diff --git a/libs/nx-mesh/src/utils/watcher/index.ts b/libs/nx-mesh/src/utils/watcher/index.ts
@@ -0,0 +1 @@
+export * from './watcher';
diff --git a/libs/nx-mesh/src/utils/watcher/watcher.ts b/libs/nx-mesh/src/utils/watcher/watcher.ts
@@ -0,0 +1,47 @@
+import type { WatcherOptions } from 'watchpack';
+
+import { logger } from '@nrwl/devkit';
+import Watchpack = require('watchpack');
+
+export type WatchFunc<T = unknown> = () => Promise<T>;
+
+export type Options = Omit<WatcherOptions, 'ignored'> & {
+  dir: string;
+  watch?: boolean;
+};
+
+export async function watcher(func: WatchFunc, options: Options) {
+  const { dir, watch, ...watcherOptions } = options;
+
+  if (watch === true) {
+    const wp = new Watchpack({
+      ...watcherOptions,
+      ignored: [
+        '.eslintrc.json',
+        '.lib.swcrc',
+        '**/.codegen',
+        '**/.git',
+        '**/.mesh',
+        '**/node_modules',
+        'jest.config.ts',
+        'project.json',
+      ],
+    });
+
+    wp.watch({ directories: [dir], startTime: 0 });
+
+    wp.on('aggregated', async () => {
+      await func();
+
+      logger.info('');
+      logger.info('');
+      logger.info('Watching for changes...');
+    });
+
+    await new Promise<{ success: boolean }>(() => {
+      // This Promise intentionally never resolves, leaving the process running.
+    });
+  } else {
+    await func();
+  }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -52,6 +52,8 @@ export default async function* buildExecutor( @@
         context
       );
+      logger.info('Done.');
       yield {
         success: true,
       };
@@ Expand Down @@