feat(cli): implement start --watch feature

Author: oscar60310

labs/playground1/sqls/artist/artist.sql

@@ -2,4 +2,4 @@ select
 *
 from "artists"
 where 
-ConstituentID = {{ context.params.id }}
+ConstituentID = {{ context.params.id }};

package.json

@@ -8,6 +8,7 @@
   "private": true,
   "dependencies": {
     "@koa/cors": "^3.3.0",
+    "chokidar": "^3.5.3",
     "class-validator": "^0.13.2",
     "commander": "^9.4.0",
     "dayjs": "^1.11.2",

packages/cli/src/commands/build.ts

@@ -12,6 +12,15 @@ const defaultOptions: BuildCommandOptions = {
   config: './vulcan.yaml',
 };
 
+export const mergeBuildDefaultOption = (
+  options: Partial<BuildCommandOptions>
+) => {
+  return {
+    ...defaultOptions,
+    ...options,
+  } as BuildCommandOptions;
+};
+
 export const buildVulcan = async (options: BuildCommandOptions) => {
   const configPath = path.resolve(process.cwd(), options.config);
   const config: any = jsYAML.load(await fs.readFile(configPath, 'utf-8'));
@@ -36,9 +45,5 @@ export const buildVulcan = async (options: BuildCommandOptions) => {
 export const handleBuild = async (
   options: Partial<BuildCommandOptions>
 ): Promise<void> => {
-  options = {
-    ...defaultOptions,
-    ...options,
-  };
-  await buildVulcan(options as BuildCommandOptions);
+  await buildVulcan(mergeBuildDefaultOption(options));
 };

packages/cli/src/commands/serve.ts

@@ -1,7 +1,12 @@
 import * as jsYAML from 'js-yaml';
 import { promises as fs } from 'fs';
 import * as path from 'path';
-import { addShutdownJob, localModulePath, logger } from '../utils';
+import {
+  addShutdownJob,
+  localModulePath,
+  logger,
+  removeShutdownJob,
+} from '../utils';
 
 export interface ServeCommandOptions {
   config: string;
@@ -13,6 +18,15 @@ const defaultOptions: ServeCommandOptions = {
   port: 3000,
 };
 
+export const mergeServeDefaultOption = (
+  options: Partial<ServeCommandOptions>
+) => {
+  return {
+    ...defaultOptions,
+    ...options,
+  } as ServeCommandOptions;
+};
+
 export const serveVulcan = async (options: ServeCommandOptions) => {
   const configPath = path.resolve(process.cwd(), options.config);
   const config: any = jsYAML.load(await fs.readFile(configPath, 'utf-8'));
@@ -25,19 +39,24 @@ export const serveVulcan = async (options: ServeCommandOptions) => {
   const server = new VulcanServer(config);
   await server.start(options.port);
   logger.info(`Server is listening at port ${options.port}.`);
-  addShutdownJob(async () => {
+
+  const closeServerJob = async () => {
     logger.info(`Stopping server...`);
     await server.close();
     logger.info(`Server stopped`);
-  });
+  };
+  addShutdownJob(closeServerJob);
+
+  return {
+    stopServer: async () => {
+      removeShutdownJob(closeServerJob);
+      await closeServerJob();
+    },
+  };
 };
 
 export const handleServe = async (
   options: Partial<ServeCommandOptions>
 ): Promise<void> => {
-  options = {
-    ...defaultOptions,
-    ...options,
-  };
-  await serveVulcan(options as ServeCommandOptions);
+  await serveVulcan(mergeServeDefaultOption(options));
 };

packages/cli/src/commands/start.ts

@@ -1,9 +1,33 @@
-import { BuildCommandOptions, handleBuild } from './build';
-import { handleServe, ServeCommandOptions } from './serve';
+import {
+  BuildCommandOptions,
+  buildVulcan,
+  mergeBuildDefaultOption,
+} from './build';
+import {
+  mergeServeDefaultOption,
+  ServeCommandOptions,
+  serveVulcan,
+} from './serve';
+import * as chokidar from 'chokidar';
+import { debounce } from 'lodash';
 
 export const handleStart = async (
   options: Partial<BuildCommandOptions & ServeCommandOptions>
 ): Promise<void> => {
-  await handleBuild(options);
-  await handleServe(options);
+  const buildOptions = mergeBuildDefaultOption(options);
+  const serveOptions = mergeServeDefaultOption(options);
+
+  let stopServer: (() => Promise<any>) | undefined;
+
+  const restartServer = async () => {
+    if (stopServer) await stopServer();
+    await buildVulcan(buildOptions);
+    stopServer = (await serveVulcan(serveOptions)).stopServer;
+  };
+
+  await restartServer();
+
+  chokidar
+    .watch(['./sqls/**/*.sql'], { ignoreInitial: true })
+    .on('all', debounce(restartServer, 1000));
 };

packages/cli/src/utils/shutdown.ts

@@ -8,6 +8,11 @@ export const addShutdownJob = (job: JobBeforeShutdown) => {
   shutdownJobs.push(job);
 };
 
+export const removeShutdownJob = (job: JobBeforeShutdown) => {
+  const index = shutdownJobs.indexOf(job);
+  if (index >= 0) shutdownJobs.splice(index, 1);
+};
+
 export const runShutdownJobs = async () => {
   logger.info('Ctrl-C signal caught, stopping services...');
   await Promise.all(shutdownJobs.map((job) => job()));

yarn.lock

@@ -2028,7 +2028,7 @@ chardet@^0.7.0:
   resolved "https://registry.yarnpkg.com/chardet/-/chardet-0.7.0.tgz#90094849f0937f2eedc2425d0d28a9e5f0cbad9e"
   integrity sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==
 
-chokidar@^3.5.1:
+chokidar@^3.5.1, chokidar@^3.5.3:
   version "3.5.3"
   resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.5.3.tgz#1cf37c8707b932bd1af1ae22c0432e2acd1903bd"
   integrity sha512-Dr3sfKRP6oTcjf2JmUmFJfeVMvXBdegxB0iVQ5eb2V10uFJUCAS8OByZdVAyVb8xXNz3GjjTgj9kLWsZTqE6kw==