test(cli): add test for watcher

Author: oscar60310

packages/cli/src/commands/start.ts

@@ -12,7 +12,7 @@ import * as chokidar from 'chokidar';
 import * as jsYAML from 'js-yaml';
 import { promises as fs } from 'fs';
 import * as path from 'path';
-import { logger } from '../utils';
+import { addShutdownJob, logger } from '../utils';
 
 const callAfterFulfilled = (func: () => Promise<void>) => {
   let busy = false;
@@ -70,8 +70,13 @@ export const handleStart = async (
 
   const restartServer = async () => {
     if (stopServer) await stopServer();
-    await buildVulcan(buildOptions);
-    stopServer = (await serveVulcan(serveOptions)).stopServer;
+    try {
+      await buildVulcan(buildOptions);
+      stopServer = (await serveVulcan(serveOptions)).stopServer;
+    } catch (e) {
+      // Ignore the error to keep watch process works
+      if (!startOptions.watch) throw e;
+    }
   };
 
   await restartServer();
@@ -110,10 +115,13 @@ export const handleStart = async (
     }
 
     const restartWhenFulfilled = callAfterFulfilled(restartServer);
-    chokidar
+    const watcher = chokidar
       .watch(pathsToWatch, { ignoreInitial: true })
       .on('all', () => restartWhenFulfilled());
-
+    addShutdownJob(async () => {
+      logger.info(`Stop watching changes...`);
+      await watcher.close();
+    });
     logger.info(`Start watching changes...`);
   }
 };

packages/cli/test/cli.spec.ts

@@ -37,7 +37,7 @@ beforeAll(async () => {
 }, 30000);
 
 afterAll(async () => {
-  await fs.rm(projectRoot, { recursive: true, force: true });
+  await fs.rm(projectRoot, { recursive: true, force: true, maxRetries: 5 });
 });
 
 afterEach(async () => {
@@ -83,6 +83,28 @@ it('Start command should build the project and start Vulcan server', async () =>
   await runShutdownJobs();
 });
 
+it('Start command with watch option should watch the file changes', (done) => {
+  // Arrange
+  const agent = supertest(`http://localhost:${testingServerPort}`);
+  const testYamlPath = path.resolve(projectRoot, 'sqls', 'test.yaml');
+
+  // Act
+  program
+    .parseAsync(['node', 'vulcan', 'start', '-w'])
+    // Wait for server start
+    .then(() => new Promise((resolve) => setTimeout(resolve, 1000)))
+    // Write some invalid configs, let server fail to start
+    .then(() => fs.writeFile(testYamlPath, 'url: /user/:id\ns', 'utf-8'))
+    // Wait for serer restart
+    .then(() => new Promise((resolve) => setTimeout(resolve, 1000)))
+    .then(() => expect(agent.get('/doc')).rejects.toThrow())
+    .finally(() => {
+      runShutdownJobs()
+        .then(() => fs.rm(testYamlPath))
+        .then(() => done());
+    });
+}, 5000);
+
 it('Version command should execute without error', async () => {
   // Action, Assert
   await expect(