pxt-core 11.1.4 → 11.1.5

package/built/cli.js

@@ -2520,6 +2520,7 @@ function serveAsync(parsed) {
         browser: parsed.flags["browser"],
         serial: !parsed.flags["noSerial"] && !exports.globalConfig.noSerial,
         noauth: parsed.flags["noauth"] || false,
+        backport: parsed.flags["backport"] || 0,
     }));
 }
 exports.serveAsync = serveAsync;
@@ -6237,6 +6238,11 @@ ${pxt.crowdin.KEY_VARIABLE} - crowdin key
             noauth: {
                 description: "disable localtoken-based authentication",
                 aliases: ["na"],
+            },
+            backport: {
+                description: "port where the locally running backend is listening.",
+                argument: "backport",
+                type: "number",
             }
         }
     }, serveAsync);

package/built/pxt.js

@@ -102515,7 +102515,7 @@ var pxt;
             var _a;
             try {
                 return typeof window !== "undefined"
-                    && /^http:\/\/(localhost|127\.0\.0\.1|192\.168\.\d+\.\d+):\d+\//.test(window.location.href)
+                    && /^http:\/\/(?:localhost|127\.0\.0\.1|192\.168\.\d{1,3}\.\d{1,3}|[a-zA-Z0-9.-]+\.local):\d+\/?/.test(window.location.href)
                     && (ignoreFlags || !/nolocalhost=1/.test(window.location.href))
                     && !((_a = pxt === null || pxt === void 0 ? void 0 : pxt.webConfig) === null || _a === void 0 ? void 0 : _a.isStatic);
             }
@@ -153913,11 +153913,13 @@ var pxsim;
             return isPxtElectron() || isIpcRenderer();
         }
         U.isElectron = isElectron;
+        function testLocalhost(url) {
+            return /^http:\/\/(?:localhost|127\.0\.0\.1|192\.168\.\d{1,3}\.\d{1,3}|[a-zA-Z0-9.-]+\.local):\d+\/?/.test(url) && !/nolocalhost=1/.test(url);
+        }
+        U.testLocalhost = testLocalhost;
         function isLocalHost() {
             try {
-                return typeof window !== "undefined"
-                    && /^http:\/\/(localhost|127\.0\.0\.1):\d+\//.test(window.location.href)
-                    && !/nolocalhost=1/.test(window.location.href);
+                return typeof window !== "undefined" && testLocalhost(window.location.href);
             }
             catch (e) {
                 return false;
@@ -153941,6 +153943,14 @@ var pxsim;
             return v;
         }
         U.unique = unique;
+        function sanitizeCssName(name) {
+            let sanitized = name.replace(/[^a-zA-Z0-9-_]/g, '_');
+            if (!/^[a-zA-Z_]/.test(sanitized)) {
+                sanitized = 'cls_' + sanitized;
+            }
+            return sanitized;
+        }
+        U.sanitizeCssName = sanitizeCssName;
     })(U = pxsim.U || (pxsim.U = {}));
     class BreakLoopException {
     }
@@ -155317,16 +155327,42 @@ var pxsim;
                 this._allowedOrigins.push(options.parentOrigin);
             }
             this._allowedOrigins.push(this.getSimUrl().origin);
-            const messageSimulators = options === null || options === void 0 ? void 0 : options.messageSimulators;
-            if (messageSimulators) {
-                Object.keys(messageSimulators)
-                    .map(channel => messageSimulators[channel])
-                    .forEach(messageSimulator => {
-                    this._allowedOrigins.push(new URL(messageSimulator.url).origin);
-                    if (messageSimulator.localHostUrl)
-                        this._allowedOrigins.push(new URL(messageSimulator.localHostUrl).origin);
-                });
-            }
+            // Legacy support for message simulators
+            const messageSimulators = (options === null || options === void 0 ? void 0 : options.messageSimulators) || {};
+            Object.keys(messageSimulators)
+                .map(channel => messageSimulators[channel])
+                .forEach(messageSimulator => {
+                this._allowedOrigins.push(new URL(messageSimulator.url).origin);
+                if (messageSimulator.localHostUrl)
+                    this._allowedOrigins.push(new URL(messageSimulator.localHostUrl).origin);
+            });
+            // Preprocess simulator extensions
+            const simXDevMode = pxsim.U.isLocalHost() && /[?&]simxdev(?:[=&#]|$)/i.test(window.location.href);
+            Object.entries((options === null || options === void 0 ? void 0 : options.simulatorExtensions) || {}).forEach(([key, simx]) => {
+                // Verify essential `simx` config was provided
+                if (!simx ||
+                    !simx.index ||
+                    !simx.aspectRatio ||
+                    simx.permanent === undefined) {
+                    return;
+                }
+                // Compute the effective URL
+                if (simXDevMode && simx.devUrl) {
+                    // Use the dev URL if the dev flag is set (and we're on localhost)
+                    simx.url = new URL(simx.index, simx.devUrl).toString();
+                }
+                else {
+                    const simUrl = this.getSimUrl();
+                    // Ensure we preserve upload target path (/app/<sha>---simulator)
+                    const simPath = simUrl.pathname.replace(/---?.*/, "");
+                    // Construct the path. The "-" element delineates the extension key from the resource name.
+                    const simxPath = [simPath, "simx", key, "-", simx.index].join("/");
+                    // Create the fully-qualified URL, preserving the origin by removing all leading slashes
+                    simx.url = new URL(simxPath.replace(/^\/+/, ""), simUrl.origin).toString();
+                }
+                // Add the origin to the allowed origins
+                this._allowedOrigins.push(new URL(simx.url).origin);
+            });
             this._allowedOrigins = pxsim.U.unique(this._allowedOrigins, f => f);
         }
         isDebug() {
@@ -155533,8 +155569,44 @@ var pxsim;
                         const messageSimulator = messageChannel &&
                             this.options.messageSimulators &&
                             this.options.messageSimulators[messageChannel];
-                        // should we start an extension editor?
-                        if (messageSimulator) {
+                        const simulatorExtension = messageChannel &&
+                            this.options.simulatorExtensions &&
+                            this.options.simulatorExtensions[messageChannel];
+                        const startSimulatorExtension = (url, permanent, aspectRatio) => {
+                            var _a;
+                            aspectRatio = aspectRatio || ((_a = this._runOptions) === null || _a === void 0 ? void 0 : _a.aspectRatio) || 1.22;
+                            let wrapper = this.createFrame(url);
+                            this.container.appendChild(wrapper);
+                            const messageFrame = wrapper.firstElementChild;
+                            messageFrame.dataset[FRAME_DATA_MESSAGE_CHANNEL] = messageChannel;
+                            messageFrame.dataset[FRAME_ASPECT_RATIO] = aspectRatio + "";
+                            pxsim.U.addClass(wrapper, "simmsg");
+                            pxsim.U.addClass(wrapper, "simmsg" + pxsim.U.sanitizeCssName(messageChannel));
+                            if (permanent)
+                                messageFrame.dataset[PERMANENT] = "true";
+                            this.startFrame(messageFrame);
+                            frames = this.simFrames(); // refresh
+                        };
+                        // should we start a simulator extension for this message?
+                        if (simulatorExtension) {
+                            // find a frame already running that simulator
+                            let messageFrame = frames.find(frame => frame.dataset[FRAME_DATA_MESSAGE_CHANNEL] === messageChannel);
+                            // not found, spin a new one
+                            if (!messageFrame) {
+                                const url = new URL(simulatorExtension.url);
+                                if (this.options.parentOrigin)
+                                    url.searchParams.set("parentOrigin", encodeURIComponent(this.options.parentOrigin));
+                                if (this.options.userLanguage)
+                                    url.searchParams.set("language", encodeURIComponent(this.options.userLanguage));
+                                startSimulatorExtension(url.toString(), simulatorExtension.permanent, simulatorExtension.aspectRatio);
+                            }
+                            // not running the current run, restart
+                            else if (messageFrame.dataset['runid'] != this.runId) {
+                                this.startFrame(messageFrame);
+                            }
+                        }
+                        // (legacy: messageSimulator) should we start a message simulator for this message?
+                        else if (messageSimulator) {
                             // find a frame already running that simulator
                             let messageFrame = frames.find(frame => frame.dataset[FRAME_DATA_MESSAGE_CHANNEL] === messageChannel);
                             // not found, spin a new one
@@ -155543,16 +155615,7 @@ var pxsim;
                                 const url = ((useLocalHost && messageSimulator.localHostUrl) || messageSimulator.url)
                                     .replace("$PARENT_ORIGIN$", encodeURIComponent(this.options.parentOrigin || ""))
                                     .replace("$LANGUAGE$", encodeURIComponent(this.options.userLanguage));
-                                let wrapper = this.createFrame(url);
-                                this.container.appendChild(wrapper);
-                                messageFrame = wrapper.firstElementChild;
-                                messageFrame.dataset[FRAME_DATA_MESSAGE_CHANNEL] = messageChannel;
-                                pxsim.U.addClass(wrapper, "simmsg");
-                                pxsim.U.addClass(wrapper, "simmsg" + messageChannel);
-                                if (messageSimulator.permanent)
-                                    messageFrame.dataset[PERMANENT] = "true";
-                                this.startFrame(messageFrame);
-                                frames = this.simFrames(); // refresh
+                                startSimulatorExtension(url, messageSimulator.permanent, messageSimulator.aspectRatio);
                             }
                             // not running the curren run, restart
                             else if (messageFrame.dataset['runid'] != this.runId) {
@@ -163160,6 +163223,7 @@ function serveAsync(parsed) {
         browser: parsed.flags["browser"],
         serial: !parsed.flags["noSerial"] && !exports.globalConfig.noSerial,
         noauth: parsed.flags["noauth"] || false,
+        backport: parsed.flags["backport"] || 0,
     }));
 }
 exports.serveAsync = serveAsync;
@@ -166877,6 +166941,11 @@ ${pxt.crowdin.KEY_VARIABLE} - crowdin key
             noauth: {
                 description: "disable localtoken-based authentication",
                 aliases: ["na"],
+            },
+            backport: {
+                description: "port where the locally running backend is listening.",
+                argument: "backport",
+                type: "number",
             }
         }
     }, serveAsync);

package/built/pxtlib.js

@@ -4829,7 +4829,7 @@ var pxt;
             var _a;
             try {
                 return typeof window !== "undefined"
-                    && /^http:\/\/(localhost|127\.0\.0\.1|192\.168\.\d+\.\d+):\d+\//.test(window.location.href)
+                    && /^http:\/\/(?:localhost|127\.0\.0\.1|192\.168\.\d{1,3}\.\d{1,3}|[a-zA-Z0-9.-]+\.local):\d+\/?/.test(window.location.href)
                     && (ignoreFlags || !/nolocalhost=1/.test(window.location.href))
                     && !((_a = pxt === null || pxt === void 0 ? void 0 : pxt.webConfig) === null || _a === void 0 ? void 0 : _a.isStatic);
             }

package/built/pxtsim.d.ts

@@ -1059,9 +1059,11 @@ declare namespace pxsim {
         function isPxtElectron(): boolean;
         function isIpcRenderer(): boolean;
         function isElectron(): boolean;
+        function testLocalhost(url: string): boolean;
         function isLocalHost(): boolean;
         function isLocalHostDev(): boolean;
         function unique<T>(arr: T[], f: (t: T) => string): T[];
+        function sanitizeCssName(name: string): string;
     }
     export interface Map<T> {
         [index: string]: T;
@@ -1308,6 +1310,13 @@ declare namespace pxsim {
             aspectRatio?: number;
             permanent?: boolean;
         }>;
+        simulatorExtensions?: pxt.Map<{
+            aspectRatio?: number;
+            permanent?: boolean;
+            index?: string;
+            devUrl?: string;
+            url?: string;
+        }>;
         userLanguage?: string;
     }
     enum SimulatorState {

package/built/pxtsim.js

@@ -4712,11 +4712,13 @@ var pxsim;
             return isPxtElectron() || isIpcRenderer();
         }
         U.isElectron = isElectron;
+        function testLocalhost(url) {
+            return /^http:\/\/(?:localhost|127\.0\.0\.1|192\.168\.\d{1,3}\.\d{1,3}|[a-zA-Z0-9.-]+\.local):\d+\/?/.test(url) && !/nolocalhost=1/.test(url);
+        }
+        U.testLocalhost = testLocalhost;
         function isLocalHost() {
             try {
-                return typeof window !== "undefined"
-                    && /^http:\/\/(localhost|127\.0\.0\.1):\d+\//.test(window.location.href)
-                    && !/nolocalhost=1/.test(window.location.href);
+                return typeof window !== "undefined" && testLocalhost(window.location.href);
             }
             catch (e) {
                 return false;
@@ -4740,6 +4742,14 @@ var pxsim;
             return v;
         }
         U.unique = unique;
+        function sanitizeCssName(name) {
+            let sanitized = name.replace(/[^a-zA-Z0-9-_]/g, '_');
+            if (!/^[a-zA-Z_]/.test(sanitized)) {
+                sanitized = 'cls_' + sanitized;
+            }
+            return sanitized;
+        }
+        U.sanitizeCssName = sanitizeCssName;
     })(U = pxsim.U || (pxsim.U = {}));
     class BreakLoopException {
     }
@@ -6116,16 +6126,42 @@ var pxsim;
                 this._allowedOrigins.push(options.parentOrigin);
             }
             this._allowedOrigins.push(this.getSimUrl().origin);
-            const messageSimulators = options === null || options === void 0 ? void 0 : options.messageSimulators;
-            if (messageSimulators) {
-                Object.keys(messageSimulators)
-                    .map(channel => messageSimulators[channel])
-                    .forEach(messageSimulator => {
-                    this._allowedOrigins.push(new URL(messageSimulator.url).origin);
-                    if (messageSimulator.localHostUrl)
-                        this._allowedOrigins.push(new URL(messageSimulator.localHostUrl).origin);
-                });
-            }
+            // Legacy support for message simulators
+            const messageSimulators = (options === null || options === void 0 ? void 0 : options.messageSimulators) || {};
+            Object.keys(messageSimulators)
+                .map(channel => messageSimulators[channel])
+                .forEach(messageSimulator => {
+                this._allowedOrigins.push(new URL(messageSimulator.url).origin);
+                if (messageSimulator.localHostUrl)
+                    this._allowedOrigins.push(new URL(messageSimulator.localHostUrl).origin);
+            });
+            // Preprocess simulator extensions
+            const simXDevMode = pxsim.U.isLocalHost() && /[?&]simxdev(?:[=&#]|$)/i.test(window.location.href);
+            Object.entries((options === null || options === void 0 ? void 0 : options.simulatorExtensions) || {}).forEach(([key, simx]) => {
+                // Verify essential `simx` config was provided
+                if (!simx ||
+                    !simx.index ||
+                    !simx.aspectRatio ||
+                    simx.permanent === undefined) {
+                    return;
+                }
+                // Compute the effective URL
+                if (simXDevMode && simx.devUrl) {
+                    // Use the dev URL if the dev flag is set (and we're on localhost)
+                    simx.url = new URL(simx.index, simx.devUrl).toString();
+                }
+                else {
+                    const simUrl = this.getSimUrl();
+                    // Ensure we preserve upload target path (/app/<sha>---simulator)
+                    const simPath = simUrl.pathname.replace(/---?.*/, "");
+                    // Construct the path. The "-" element delineates the extension key from the resource name.
+                    const simxPath = [simPath, "simx", key, "-", simx.index].join("/");
+                    // Create the fully-qualified URL, preserving the origin by removing all leading slashes
+                    simx.url = new URL(simxPath.replace(/^\/+/, ""), simUrl.origin).toString();
+                }
+                // Add the origin to the allowed origins
+                this._allowedOrigins.push(new URL(simx.url).origin);
+            });
             this._allowedOrigins = pxsim.U.unique(this._allowedOrigins, f => f);
         }
         isDebug() {
@@ -6332,8 +6368,44 @@ var pxsim;
                         const messageSimulator = messageChannel &&
                             this.options.messageSimulators &&
                             this.options.messageSimulators[messageChannel];
-                        // should we start an extension editor?
-                        if (messageSimulator) {
+                        const simulatorExtension = messageChannel &&
+                            this.options.simulatorExtensions &&
+                            this.options.simulatorExtensions[messageChannel];
+                        const startSimulatorExtension = (url, permanent, aspectRatio) => {
+                            var _a;
+                            aspectRatio = aspectRatio || ((_a = this._runOptions) === null || _a === void 0 ? void 0 : _a.aspectRatio) || 1.22;
+                            let wrapper = this.createFrame(url);
+                            this.container.appendChild(wrapper);
+                            const messageFrame = wrapper.firstElementChild;
+                            messageFrame.dataset[FRAME_DATA_MESSAGE_CHANNEL] = messageChannel;
+                            messageFrame.dataset[FRAME_ASPECT_RATIO] = aspectRatio + "";
+                            pxsim.U.addClass(wrapper, "simmsg");
+                            pxsim.U.addClass(wrapper, "simmsg" + pxsim.U.sanitizeCssName(messageChannel));
+                            if (permanent)
+                                messageFrame.dataset[PERMANENT] = "true";
+                            this.startFrame(messageFrame);
+                            frames = this.simFrames(); // refresh
+                        };
+                        // should we start a simulator extension for this message?
+                        if (simulatorExtension) {
+                            // find a frame already running that simulator
+                            let messageFrame = frames.find(frame => frame.dataset[FRAME_DATA_MESSAGE_CHANNEL] === messageChannel);
+                            // not found, spin a new one
+                            if (!messageFrame) {
+                                const url = new URL(simulatorExtension.url);
+                                if (this.options.parentOrigin)
+                                    url.searchParams.set("parentOrigin", encodeURIComponent(this.options.parentOrigin));
+                                if (this.options.userLanguage)
+                                    url.searchParams.set("language", encodeURIComponent(this.options.userLanguage));
+                                startSimulatorExtension(url.toString(), simulatorExtension.permanent, simulatorExtension.aspectRatio);
+                            }
+                            // not running the current run, restart
+                            else if (messageFrame.dataset['runid'] != this.runId) {
+                                this.startFrame(messageFrame);
+                            }
+                        }
+                        // (legacy: messageSimulator) should we start a message simulator for this message?
+                        else if (messageSimulator) {
                             // find a frame already running that simulator
                             let messageFrame = frames.find(frame => frame.dataset[FRAME_DATA_MESSAGE_CHANNEL] === messageChannel);
                             // not found, spin a new one
@@ -6342,16 +6414,7 @@ var pxsim;
                                 const url = ((useLocalHost && messageSimulator.localHostUrl) || messageSimulator.url)
                                     .replace("$PARENT_ORIGIN$", encodeURIComponent(this.options.parentOrigin || ""))
                                     .replace("$LANGUAGE$", encodeURIComponent(this.options.userLanguage));
-                                let wrapper = this.createFrame(url);
-                                this.container.appendChild(wrapper);
-                                messageFrame = wrapper.firstElementChild;
-                                messageFrame.dataset[FRAME_DATA_MESSAGE_CHANNEL] = messageChannel;
-                                pxsim.U.addClass(wrapper, "simmsg");
-                                pxsim.U.addClass(wrapper, "simmsg" + messageChannel);
-                                if (messageSimulator.permanent)
-                                    messageFrame.dataset[PERMANENT] = "true";
-                                this.startFrame(messageFrame);
-                                frames = this.simFrames(); // refresh
+                                startSimulatorExtension(url, messageSimulator.permanent, messageSimulator.aspectRatio);
                             }
                             // not running the curren run, restart
                             else if (messageFrame.dataset['runid'] != this.runId) {

package/built/server.d.ts

@@ -12,6 +12,7 @@ export interface ServeOptions {
     wsPort?: number;
     serial?: boolean;
     noauth?: boolean;
+    backport?: number;
 }
 export declare function compileScriptAsync(id: string): Promise<string>;
 export declare function serveAsync(options: ServeOptions): Promise<void>;

package/built/server.js

@@ -932,6 +932,10 @@ function serveAsync(options) {
                 error(404, "File missing: " + filename);
             }
         };
+        // Strip /app/hash-sig from URL.
+        // This can happen when the locally running backend is serving an uploaded target,
+        // but has been configured to route simulator urls to port 3232.
+        req.url = req.url.replace(/^\/app\/[0-9a-f]{40}(?:-[0-9a-f]{10})?(.*)$/i, "$1");
         let uri = url.parse(req.url);
         let pathname = decodeURI(uri.pathname);
         const opts = querystring.parse(url.parse(req.url).query);
@@ -1071,6 +1075,26 @@ function serveAsync(options) {
                 return error(400, "Invalid asset path");
             }
         }
+        if (elts[0] == "simx" && serveOptions.backport) {
+            // Proxy requests for simulator extensions to the locally running backend.
+            // Should only get here when the backend is running locally and configured to serve the simulator from the cli (via LOCAL_SIM_PORT setting).
+            const passthruOpts = {
+                hostname: uri.hostname,
+                port: serveOptions.backport,
+                path: uri.path,
+                method: req.method,
+                headers: req.headers
+            };
+            const passthruReq = http.request(passthruOpts, passthruRes => {
+                res.writeHead(passthruRes.statusCode, passthruRes.headers);
+                passthruRes.pipe(res);
+            });
+            passthruReq.on("error", e => {
+                console.error(`Error proxying request to port ${serveOptions.backport} .. ${e.message}`);
+                return error(500, e.message);
+            });
+            return req.pipe(passthruReq);
+        }
         if (options.packaged) {
             let filename = path.resolve(path.join(packagedDir, pathname));
             if (nodeutil.fileExistsSync(filename)) {
@@ -1164,6 +1188,19 @@ function serveAsync(options) {
                 return;
             }
         }
+        // Look for an .html file corresponding to `/---<pathname>`
+        // Handles serving of `trg-<target>.sim.local:<port>/---simulator`
+        let match = /^\/?---?(.*)/.exec(pathname);
+        if (match && match[1]) {
+            const htmlPathname = `/${match[1]}.html`;
+            for (let dir of dd) {
+                const filename = path.resolve(path.join(dir, htmlPathname));
+                if (nodeutil.fileExistsSync(filename)) {
+                    const html = expandHtml(fs.readFileSync(filename, "utf8"), htmlParams);
+                    return sendHtml(html);
+                }
+            }
+        }
         if (/simulator\.html/.test(pathname)) {
             // Special handling for missing simulator: redirect to the live sim
             res.writeHead(302, { location: `https://trg-${pxt.appTarget.id}.userpxt.io/---simulator` });