lucid-package 0.0.88 → 0.0.89

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-package",
-    "version": "0.0.88",
+    "version": "0.0.89",
     "description": "",
     "main": "index.js",
     "bin": {
@@ -13,6 +13,7 @@
         "@types/argparse": "^2.0.10",
         "@types/express": "^4.17.13",
         "@types/node": "^16.11.11",
+        "@types/webpack": "^5.28.5",
         "prettier": "file:../../cake/node_modules/prettier",
         "prettier-plugin-organize-imports": "file:../../cake/node_modules/prettier-plugin-organize-imports"
     },

package/src/editorextension.d.ts

@@ -1,3 +1,4 @@
+import { Compiler } from 'webpack';
 export declare function createEditorExtension(name: string, isInternalTesting: boolean, skipSDKDependency: boolean): Promise<void>;
 export declare function buildEditorExtension(name: string, isInternalTesting: boolean, quiet?: boolean): Promise<void>;
 export declare function updateExtensionSDK(name: string): Promise<void>;
@@ -6,10 +7,13 @@ export declare function updateExtensionSDK(name: string): Promise<void>;
  * @param name The editor extension name
  * @param quiet If true, will only show errors in output
  */
-export declare function watchEditorExtension(name: string, isInternalTesting: boolean, quiet?: boolean): Promise<void>;
+export declare function watchEditorExtension(name: string, isInternalTesting: boolean, quiet?: boolean): Promise<{
+    name: string;
+    compiler: Compiler;
+}>;
 /**
  * Runs the editor extensions and shape libraries in debug mode, including watching code for changes.
  * @param extensionNames The names of the editor extensions
  * @param quiet If true, will only show errors in output
  */
-export declare function debugEditorExtension(extensionNames: string[], quiet?: boolean, pickAnyPort?: boolean): Promise<void>;
+export declare function debugEditorExtension(extensionNames: string[], isInternalTesting: boolean, quiet?: boolean, pickAnyPort?: boolean): Promise<void>;

package/src/editorextension.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.debugEditorExtension = exports.watchEditorExtension = exports.updateExtensionSDK = exports.buildEditorExtension = exports.createEditorExtension = void 0;
-const child_process = require("child_process");
 const express = require("express");
 const oldFs = require("fs");
 const fs = require("fs/promises");
@@ -14,6 +13,7 @@ const packagemanifest_1 = require("./packagemanifest");
 const shapelibrary_1 = require("./shapelibrary");
 const shellutil_1 = require("./shellutil");
 const supportedproduct_1 = require("./supportedproduct");
+const webpack = require('webpack');
 const WebPackCLI = require('webpack-cli');
 const ws = require('ws');
 const chokidar = require('chokidar');
@@ -64,11 +64,23 @@ exports.updateExtensionSDK = updateExtensionSDK;
  * @param quiet If true, will only show errors in output
  */
 async function watchEditorExtension(name, isInternalTesting, quiet = false) {
+    const originalDirectory = process.cwd();
     const extensionCodePath = path.join('editorextensions', await getExtensionCodeDirectoryName(name));
     process.chdir(extensionCodePath);
     (0, installationutil_1.installDependenciesIfNeeded)(isInternalTesting);
-    const cli = new WebPackCLI();
-    cli.run(['node', 'webpack', '--watch', '--env', 'environment=dev', ...(quiet ? ['--stats', 'errors-only'] : [])]);
+    const webpackConfigExport = require(path.resolve('webpack.config.js'));
+    // For backwards compatibility, we need to support extensions where the webpack config is a fuction or an object
+    const webpackConfig = typeof webpackConfigExport == 'function' ? webpackConfigExport({ environment: 'dev' }) : webpackConfigExport;
+    webpackConfig.mode = 'development';
+    if (quiet) {
+        webpackConfig.stats = 'errors-only';
+    }
+    const compiler = webpack(webpackConfig);
+    compiler.watch({}, (err, stats) => {
+        console.log(stats?.toString({ colors: true }));
+    });
+    process.chdir(originalDirectory);
+    return { name, compiler };
 }
 exports.watchEditorExtension = watchEditorExtension;
 /**
@@ -76,16 +88,14 @@ exports.watchEditorExtension = watchEditorExtension;
  * @param extensionNames The names of the editor extensions
  * @param quiet If true, will only show errors in output
  */
-async function debugEditorExtension(extensionNames, quiet = false, pickAnyPort = false) {
-    let port = 9900;
-    await Promise.all(extensionNames.map(async (name) => {
-        const child = child_process.spawn(`"${process.argv[0]}" "${process.argv[1]}" watch-editor-extension ${name} ${quiet ? '--quiet ' : ''}`, {
-            stdio: 'inherit',
-            shell: true,
-        });
-        return child;
-    }));
+async function debugEditorExtension(extensionNames, isInternalTesting, quiet = false, pickAnyPort = false) {
+    const port = 9900;
+    const watchers = await Promise.all(extensionNames.map(async (name) => watchEditorExtension(name, isInternalTesting, quiet)));
     const app = express();
+    const server = listen(app, port, pickAnyPort);
+    setupWebSockets(server);
+    const errorLog = new Map();
+    recordErrors(watchers, errorLog);
     app.use(cors_1.corsAllowLucid);
     app.get(['/extension.js', '/editorextension/:name/extension.js'], async (req, res) => {
         const name = req.params['name'] ?? extensionNames[0];
@@ -176,6 +186,9 @@ async function debugEditorExtension(extensionNames, quiet = false, pickAnyPort =
         res.set({ 'Content-Type': 'text/html' });
         res.send(req.query['source']);
     });
+    app.get('/editorextensions/errors', async (req, res) => {
+        res.send(JSON.stringify(Array.from(errorLog.entries())));
+    });
     // Static resources in the "public" directory of the package
     const manifest = await (0, packagemanifest_1.readManifest)('local');
     if (manifest['public']) {
@@ -185,48 +198,63 @@ async function debugEditorExtension(extensionNames, quiet = false, pickAnyPort =
         }
     }
     app.use('/resources', express.static('public'));
-    const listen = () => {
-        const server = app
-            .listen(port, 'localhost', () => {
-            console.log('Listening at http://localhost:' + port + '/extension.js');
-            // Watch for any editor extension changes, and inform watchers that they need to refresh them.
-            const wss = new ws.Server({ server, path: '/editorExtensions/changes' });
-            const sockets = [];
-            wss.on('connection', (ws) => {
-                sockets.push(ws);
-            });
-            // Changes to a file can trigger changes in other files. We debounce all changes so that
-            // we don't send multiple "refresh" messages.
-            let timeout = null;
-            chokidar.watch([['./']]).on('all', () => {
-                if (timeout) {
-                    clearTimeout(timeout);
-                }
-                timeout = setTimeout(() => {
-                    for (const socket of sockets) {
-                        socket.send('refresh');
-                    }
-                }, 100);
-            });
-            (0, shapelibrary_1.debugShapeLibraries)(undefined, pickAnyPort);
-        })
-            .on('error', (err) => {
-            if (err.code === 'EADDRINUSE') {
-                if (pickAnyPort && port < 15000) {
-                    port++;
-                    listen();
-                }
-                else {
-                    console.error('Failed to listen for extension');
-                    console.error(err);
-                    process.exit(1);
-                }
+}
+exports.debugEditorExtension = debugEditorExtension;
+function listen(app, port, pickAnyPort) {
+    return app
+        .listen(port, 'localhost', () => {
+        console.log('Listening at http://localhost:' + port + '/extension.js');
+        (0, shapelibrary_1.debugShapeLibraries)(undefined, pickAnyPort);
+    })
+        .on('error', (err) => {
+        if (err.code === 'EADDRINUSE') {
+            if (pickAnyPort && port < 15000) {
+                port++;
+                listen(app, port, pickAnyPort);
+            }
+            else {
+                console.error('Failed to listen for extension');
+                console.error(err);
+                process.exit(1);
+            }
+        }
+    });
+}
+/**
+ * Inform the editor that extensions need to be refreshed when watchers detect changes.
+ */
+function setupWebSockets(server) {
+    // We use chokidar to listen for changes instead of webpacks's on compilation done hook. This is because
+    // changes to the manifest or credentials file do not trigger webpack to recompile the extension.
+    const sockets = [];
+    const wss = new ws.Server({ server, path: '/editorExtensions/changes' });
+    wss.on('connection', (ws) => sockets.push(ws));
+    // Changes to a file can trigger changes in other files. We debounce all changes so that
+    // we don't send multiple "refresh" messages.
+    let timeout = null;
+    chokidar.watch([['./']]).on('all', () => {
+        if (timeout) {
+            clearTimeout(timeout);
+        }
+        timeout = setTimeout(() => {
+            for (const socket of sockets) {
+                socket.send('refresh');
+            }
+        }, 100);
+    });
+}
+function recordErrors(watchers, errorLog) {
+    watchers.forEach((watcher) => {
+        watcher.compiler.hooks.done.tap('CompilationDonePlugin', (stats) => {
+            if (stats.hasErrors()) {
+                errorLog.set(watcher.name, stats.toString({ all: false, colors: false, errors: true }));
+            }
+            else {
+                errorLog.delete(watcher.name);
             }
         });
-    };
-    listen();
+    });
 }
-exports.debugEditorExtension = debugEditorExtension;
 async function getExtensionManifest(name) {
     const manifest = await (0, packagemanifest_1.readManifest)('local');
     return { manifest, extensionManifest: manifest['extensions']?.find((one) => one['name'] === name) };

package/src/index.js

@@ -174,7 +174,7 @@ class LucidSuiteExtensionCLI {
                             await (0, shapelibrary_1.debugShapeLibraries)();
                             break;
                         case 'test-editor-extension':
-                            await (0, editorextension_1.debugEditorExtension)(parsed['name'], parsed['quiet'], parsed['anyport']);
+                            await (0, editorextension_1.debugEditorExtension)(parsed['name'], isInternalTesting, parsed['quiet'], parsed['anyport']);
                             break;
                         case 'watch-editor-extension':
                             await (0, editorextension_1.watchEditorExtension)(parsed['name'], isInternalTesting, parsed['quiet']);