@joystick.js/cli-canary 0.0.0-canary.99 → 1.0.0-beta.74

package/src/lib/build/buildFiles.js

@@ -53,8 +53,10 @@ const handleBuildForNode = (nodePaths = [], options = {}) => {
       format: "esm",
       bundle: false,
       entryPoints: nodePaths?.map((file) => file.path),
+      entryNames: '[dir]/[name]',
       // TODO: Make sure we don't need outbase here so the paths map correctly.
       outdir: options?.outputPath || "./.joystick/build",
+      outbase: './',
       define: {
         "process.env.NODE_ENV": `'${options?.environment}'`,
       },
@@ -77,6 +79,8 @@ const handleBuildForBrowser = (browserPaths = [], options = {}) => {
       format: "esm",
       bundle: true,
       entryPoints: browserPaths?.map((file) => file.path),
+      entryNames: '[dir]/[name]',
+      outbase: './',
       // TODO: Make sure we don't need outbase here so the paths map correctly.
       outdir: options?.outputPath || "./.joystick/build",
       define: {
@@ -225,7 +229,6 @@ const buildFiles = async (options, { resolve, reject }) => {
         return { success: true };
       }).catch((exception) => {
         const file = handleParseFilePathFromException(exception);
-        console.log(file, exception);
         const snippet = handleBuildException(exception, file);
         
         return {

package/src/lib/build/nodePaths.js

@@ -5,5 +5,6 @@ export default [
   getPlatformSafePath("routes/"),
   getPlatformSafePath("fixtures/"),
   getPlatformSafePath("lib/node"),
+  getPlatformSafePath("tests/"),
   "index.server.js",
 ];

package/src/lib/dev/hmrServer.js

@@ -0,0 +1,78 @@
+import fs from "fs";
+import { WebSocketServer } from "ws";
+import generateId from "../generateId.js";
+
+// NOTE: This doesn't run on the app server (in node). This runs on your local computer
+// as a totally separate process that's forked on joystick start.
+
+export default (() => {
+  const websocketServer = new WebSocketServer({
+    port: parseInt(process.env.PORT, 10) + 1,
+    path: "/_joystick/hmr",
+  });
+
+  process.on("message", (message) => {
+    if (typeof process.HMR_CONNECTIONS === "object") {
+      const parsedMessage = JSON.parse(message);
+      const connections = Object.values(process.HMR_CONNECTIONS);
+      for (let i = 0; i < connections?.length; i += 1) {
+        const connection = connections[i];
+        if (connection?.connection?.send) {
+          connection.connection.send(
+            JSON.stringify({
+              type: "FILE_CHANGE",
+              settings: {
+                global: parsedMessage?.settings?.global,
+                public: parsedMessage?.settings?.public,
+              },
+              indexHTMLChanged: parsedMessage?.indexHTMLChanged,
+            })
+          );
+        }
+      }
+    }
+  });
+
+  websocketServer.on("connection", function connection(websocketConnection) {
+    const connectionId = generateId();
+
+    process.HMR_CONNECTIONS = {
+      ...(process.HMR_CONNECTIONS || {}),
+      [connectionId]: {
+        connection: websocketConnection,
+        watchlist: [],
+      },
+    };
+
+    if (Object.keys(process.HMR_CONNECTIONS || {})?.length > 0) {
+      process.send({ type: "HAS_HMR_CONNECTIONS" });
+    }
+
+    websocketConnection.on("message", (message) => {
+      const parsedMessage = JSON.parse(message);
+
+      if (parsedMessage?.type === "HMR_UPDATE_COMPLETE") {
+        process.send({ type: "HMR_UPDATE_COMPLETED", sessions: parsedMessage?.sessions });
+      }
+
+      if (parsedMessage?.type === "HMR_WATCHLIST") {
+        process.HMR_CONNECTIONS[connectionId]?.watchlist?.push(
+          ...(parsedMessage?.tags || [])
+        );
+      }
+    });
+
+    websocketConnection.on("close", () => {
+      if (process.HMR_CONNECTIONS[connectionId]) {
+        delete process.HMR_CONNECTIONS[connectionId];
+
+        if (Object.keys(process.HMR_CONNECTIONS || {})?.length === 0) {
+          process.send({ type: "HAS_NO_HMR_CONNECTIONS" });
+        }
+      }
+    });
+
+  });
+
+  return true;
+})();

package/src/lib/dev/index.js

@@ -22,6 +22,8 @@ import getCodependenciesForFile from "./getCodependenciesForFile.js";
 import removeDeletedDependenciesFromMap from "../build/removeDeletedDependenciesFromMap.js";
 import chalk from "chalk";
 
+const processIds = [];
+
 const getDatabaseProcessIds = () => {
   try {
     const databaseProcessIds = [];
@@ -75,6 +77,8 @@ const handleSignalEvents = (processIds = [], nodeMajorVersion = 0, __dirname = '
       }
     );
 
+    process.cleanupProcess = cleanupProcess;
+
     process.on("SIGINT", async () => {
       const databaseProcessIds = getDatabaseProcessIds();
       cleanupProcess.send(JSON.stringify(({ processIds: [...processIds, ...databaseProcessIds] })));
@@ -115,7 +119,7 @@ const handleHMRProcessMessages = (options = {}) => {
 
       if (message?.type === "HMR_UPDATE_COMPLETED") {
         // NOTE: Do a setTimeout to ensure that server is still available while the HMR update completes.
-        // Necessary because some updates are instance, but others might mount a UI that needs a server
+        // Necessary because some updates are instant, but others might mount a UI that needs a server
         // available (e.g., runs API requests).
         setTimeout(() => {
           handleRestartApplicationProcess({
@@ -171,7 +175,7 @@ const handleServerProcessMessages = () => {
   }
 };
 
-const handleServerProcessSTDIO = () => {
+const handleServerProcessSTDIO = (options = {}) => {
   try {
     if (process.serverProcess) {
       process.serverProcess.on("error", (error) => {
@@ -181,7 +185,7 @@ const handleServerProcessSTDIO = () => {
       process.serverProcess.stdout.on("data", (data) => {
         const message = data.toString();
 
-        if (message && message.includes("App running at:")) {
+        if (message && message.includes("App running at:") && !options?.watch) {
           process.loader.stable(message);
         } else {
           if (message && !message.includes("BUILD_ERROR")) {
@@ -208,11 +212,10 @@ const handleAddOrChangeFile = async (context = {}, path = '', options = {}) => {
   try {
     if (context.isAddingOrChangingFile) {
       const codependencies = await getCodependenciesForFile(path);
-      const fileResults = await buildFiles(
-        [path, ...(codependencies?.existing || [])],
-        null,
-        process.env.NODE_ENV
-      );
+      const fileResults = await buildFiles({
+        files: [path, ...(codependencies?.existing || [])],
+        environment: process.env.NODE_ENV,
+      });
 
       const fileResultsHaveErrors = fileResults
         .filter((result) => !!result)
@@ -305,21 +308,15 @@ const handleCopyDirectory = (context = {}, path = '', options = {}) => {
 const handleRestartApplicationProcess = async (options = {}) => {
   try {
       if (process.serverProcess && process.serverProcess.pid) {
-        process.loader.text("Restarting app...");
         process.serverProcess.kill();
 
-        await startApp({
-          nodeMajorVersion: options?.nodeMajorVersion,
-          port: options?.port,
-          sessionsBeforeHMRUpdate: options?.sessionsBeforeHMRUpdate,
-        });
+        await handleStartAppServer(options);
 
         return Promise.resolve();
       }
 
       // NOTE: Original process was never initialized due to an error.
-      process.loader.text("Starting app...");
-      startApplicationProcess();
+      await handleStartAppServer(options);
 
       if (!process.hmrProcess) {
         startHMR();
@@ -329,19 +326,41 @@ const handleRestartApplicationProcess = async (options = {}) => {
   }
 };
 
-const handleNotifyHMRClients = (indexHTMLChanged = false) => {
+const handleStartAppServer = async (options = {}) => {
+  try {
+    const serverProcess = await startApp({
+      watch: options?.watch,
+      nodeMajorVersion: options?.nodeMajorVersion,
+      port: options?.port,
+      sessionsBeforeHMRUpdate: options?.sessionsBeforeHMRUpdate,
+    });
+
+    if (serverProcess) {
+      processIds.push(serverProcess.pid);
+      process.serverProcess = serverProcess;
+      handleServerProcessSTDIO(options);
+      handleServerProcessMessages(options);
+    }
+  } catch (exception) {
+    console.warn(exception);
+    throw new Error(`[dev.handleStartAppServer] ${exception.message}`);
+  }
+};
+
+const handleNotifyHMRClients = async (indexHTMLChanged = false) => {
   try {
     if (process.hmrProcess) {
-      const settings = loadSettings(process.env.NODE_ENV);
+      const settings = await loadSettings({ environment: process.env.NODE_ENV });
       process.hmrProcess.send(
         JSON.stringify({
           type: "RESTART_SERVER",
-          settings,
+          settings: settings.parsed,
           indexHTMLChanged,
         })
       );
     }
   } catch (exception) {
+    console.warn(exception);
     throw new Error(`[dev.handleNotifyHMRClients] ${exception.message}`);
   }
 };
@@ -359,7 +378,7 @@ const getWatchChangeContext = (event = '', path = '') => {
     const isAddDirectory = event === 'addDir' && isExistingDirectoryInSource && !isExistingDirectoryInBuild;
     const isFileToCopy = !!filesToCopy.find((fileToCopy) => fileToCopy.path === path);
     const isExistingFileInSource = isFile && fs.existsSync(path);
-    const isAddingOrChangingFile = event === 'add' && isExistingFileInSource;
+    const isAddingOrChangingFile = ["add", "change"].includes(event) && isExistingFileInSource;
 
     return {
       isHTMLUpdate,
@@ -391,10 +410,16 @@ const startFileWatcher = (options = {}) => {
       // NOTE: Do this here in case a required file/folder goes missing inbetween builds.
       checkForRequiredFiles();
 
-      process.loader.text("Rebuilding app...");
+      if (!options?.watch) {
+        process.loader.text("Rebuilding app...");
+      }
 
       const watchChangeContext = getWatchChangeContext(event, path);
-
+//
+//      console.log({
+//        watchChangeContext,
+//      });
+//
       handleCopyDirectory(watchChangeContext, path, options);
       handleCopyFile(watchChangeContext, path, options);
       handleAddDirectory(watchChangeContext, path, options);
@@ -578,21 +603,15 @@ const dev = async (options, { resolve, reject }) => {
     });
 
     await runInitialBuild(settings?.parsed?.config?.build);
-    await startFileWatcher(options);
-
-    const processIds = [];
-
-    const serverProcess = await startApp({
+    await startFileWatcher({
+      ...options,
       nodeMajorVersion,
-      port: options?.port,
     });
 
-    if (serverProcess) {
-      processIds.push(serverProcess.pid);
-      process.serverProcess = serverProcess;
-      handleServerProcessSTDIO();
-      handleServerProcessMessages();
-    }
+    await handleStartAppServer({
+      ...options,
+      nodeMajorVersion,
+    });
 
     if (options?.environment !== 'test') {
       const hmrProcess = await startHMR({
@@ -604,7 +623,10 @@ const dev = async (options, { resolve, reject }) => {
       process.hmrProcess = hmrProcess;
 
       handleHMRProcessSTDIO();
-      handleHMRProcessMessages(options);
+      handleHMRProcessMessages({
+        ...options,
+        nodeMajorVersion,
+      });
     }
 
 
@@ -615,10 +637,23 @@ const dev = async (options, { resolve, reject }) => {
     );
 
     if (options?.environment === 'test') {
-      process.loader.text('Running tests...');
+      process.loader.stop();
+      const databaseProcessIds = getDatabaseProcessIds();
+
       await runTests({
+        watch: options?.watch,
         __dirname,
+        processIds: [
+          ...processIds,
+          ...databaseProcessIds,
+        ],
+        cleanupProcess: process.cleanupProcess,
       });
+
+      if (!options?.watch) {
+        // NOTE: Kick out of the process after tests run if we're not in watch mode.
+        process.exit(0);
+      }
     }
 
     /*

package/src/lib/dev/runTests.js

@@ -1,46 +1,95 @@
 import child_process from "child_process";
+import CLILog from "../CLILog.js";
 
-const handleAvaSTDIO = (ava = {}) => {
+const handleAvaSTDERR = (stderr = '', options = {}) => {
+  try {
+    // NOTE: Squash output about using a configuration file (we always do in the framework).
+    if (stderr?.includes('Using configuration')) {
+      return null;
+    }
+
+    if (stderr?.includes('No tests found')) {
+      return CLILog('No tests found. Add tests in the /tests folder at the root of your Joystick app.', {
+        level: 'danger',
+        docs: 'https://cheatcode.co/docs/joystick/test/setup',
+      });
+    }
+    
+    console.log(stderr);
+  } catch (exception) {
+    throw new Error(`[runTests.handleAvaSTDERR] ${exception.message}`);
+  }
+};
+
+const handleAvaSTDOUT = (stdout = '', options = {}) => {
+  try {
+    // NOTE: Squash output about using a configuration file (we always do in the framework).
+    if (stdout?.includes('Using configuration')) {
+      return null;
+    }
+
+    if (stdout?.includes('No tests found in')) {
+      const [message] = stdout?.split(',');
+      return console.log(`${message}\n`);
+    }
+    
+    console.log(stdout);
+  } catch (exception) {
+    throw new Error(`[runTests.handleAvaSTDOUT] ${exception.message}`);
+  }
+};
+
+const handleAvaSTDIO = (ava = {}, options = {}) => {
   try {
     ava.stdout.on('data', function (data) {
       const string = data.toString();
-
-      if (!string?.includes('ava')) {
-        console.log(string);
-      }
+      handleAvaSTDOUT(string, options);
     });
 
     ava.stderr.on('data', function (data) {
       const string = data.toString();
-
-      if (!string?.includes('ava')) {
-        console.log(string);
-      }
+      handleAvaSTDERR(string, options);
     });
   } catch (exception) {
     throw new Error(`[runTests.handleAvaSTDIO] ${exception.message}`);
   }
 };
 
-const runAva = (__dirname = '') => {
+const runAva = (options = {}) => {
   try {
-    console.log(`node_modules/.bin/ava --config ${__dirname}/tests.config.js`);
+    // NOTE: A little bananas to reason through this. In order for Ava to run w/o errors,
+    // the Ava binary being run here has to be identical to the one used in @joystick.js/test.
+    // That would equal the copy of Ava that's installed in a Joystick app's node_modules
+    // directory, not the node_modules directory of the CLI here. We can guarantee that will
+    // exist for the CLI here because a developer has to install @joystick.js/test which will
+    // add Ava as a dependency to their app in order to write tests.
+    const avaPath = `${process.cwd()}/node_modules/.bin/ava`;
+    
     return new Promise((resolve, reject) => {
-      const ava = child_process.exec(`node_modules/.bin/ava --config ${__dirname}/tests.config.js`, {
+      // NOTE: Despite using the app's node_modules path to reference Ava, we still want to reference
+      // the internal path here for the default test config in /lib/dev/tests.config.js.
+      const ava = child_process.exec(`${avaPath} --config ${options?.__dirname}/tests.config.js ${options?.watch ? '--watch' : ''}`, {
         stdio: 'inherit',
         env: {
           ...(process.env),
+          databases: process.databases,
           FORCE_COLOR: "1"
         }
       }, (error) => {
-        if (error) {
-          return reject();
+        if (!error) {
+          // NOTE: Do this here because the standard SIGINT and SIGTERM hooks the dev process
+          // listens for don't catch a clean exit (and the process.exit() hook fires after exit).
+          options.cleanupProcess.send(JSON.stringify(({ processIds: options?.processIds })));
+          resolve();
+        } else {
+          // NOTE: Do not report any Ava errors here because they're picked up by the handleAvaSTDIO();
+          // hook below. Just do a clean exit here so Node doesn't hang.
+          options.cleanupProcess.send(JSON.stringify(({ processIds: options?.processIds })));
+          resolve();
         }
-        
-        return resolve();
       });
 
-      handleAvaSTDIO(ava);
+      handleAvaSTDIO(ava, options);
     });
   } catch (exception) {
     throw new Error(`[runTests.runAva] ${exception.message}`);
@@ -60,7 +109,7 @@ const runTests = async (options, { resolve, reject }) => {
   try {
     validateOptions(options);
     
-    await runAva(options?.__dirname);
+    await runAva(options);
     
     resolve();
   } catch (exception) {

package/src/lib/dev/startApp.js

@@ -1,9 +1,11 @@
 import child_process from "child_process";
 import path from "path";
 
-const handleStartServerProcess = (execArgv = {}, sessionsBeforeHMRUpdate = {}) => {
+const handleStartServerProcess = (execArgv = {}, options = {}) => {
   try {
-    process.loader.text('Starting app...');
+    if (!options?.watch) {
+      process.loader.text('Starting app...');
+    }
 
     return child_process.fork(
       path.resolve(".joystick/build/index.server.js"),
@@ -20,7 +22,7 @@ const handleStartServerProcess = (execArgv = {}, sessionsBeforeHMRUpdate = {}) =
           ROOT_URL: process.env.ROOT_URL,
           PORT: process.env.PORT,
           JOYSTICK_SETTINGS: process.env.JOYSTICK_SETTINGS,
-          HMR_SESSIONS: JSON.stringify(sessionsBeforeHMRUpdate),
+          HMR_SESSIONS: options?.sessionsBeforeHMRUpdate || '{}',
         },
       }
     );
@@ -65,7 +67,7 @@ const startApp = (options, { resolve, reject }) => {
     validateOptions(options);
 
     const execArgv = getExecArgs(options?.nodeMajorVersion);
-    const serverProcess = handleStartServerProcess(execArgv, options?.sessionsBeforeHMRUpdate);
+    const serverProcess = handleStartServerProcess(execArgv, options);
 
     return resolve(serverProcess);
   } catch (exception) {

package/src/lib/dev/tests.config.js

@@ -0,0 +1,9 @@
+export default {
+  files: [`tests/**/*.test.js`],
+  // NOTE: Intentionally limit to 1 test at a time to avoid concurrency creating
+  // race conditions in tests that have users or other "global" data that needs
+  // to be cleaned up. The extra time needed is worth it to guarantee that tests
+  // don't step on each other's toes and our code is properly verified.
+  concurrency: 1,
+  cache: false,
+};