gwchq-textjam 0.4.2 → 0.5.0

package/README.md

@@ -91,54 +91,28 @@ Automated unit tests can be run via the `yarn test` command. These unit tests ar
 
 ## Publishing to npm
 
-### Prerequisites
+Publishing is handled by the **"NPM Publish (Scan + Bump + Publish)"** GitHub Actions workflow (`.github/workflows/publish.yml`) — there is no manual `npm publish` step.
 
-1. Ensure you're logged into npm:
+### Running the workflow
 
-   ```bash
-   npm login
-   ```
+1. Go to the repo's **Actions** tab → **NPM Publish (Scan + Bump + Publish)** → **Run workflow**.
+2. Fill in the inputs:
+   - `git_branch` — the branch to scan, bump, tag, and publish from (defaults to the current release branch).
+   - `version_bump_type` — `patch`, `minor`, or `major`, following [semantic versioning](https://semver.org/).
+   - `run_publish` — leave checked to publish to npm, or uncheck for a scan + version-bump dry run.
+3. Run it. The workflow will:
+   - Run the shared dependency, secrets, and SAST scans (`security-scan` → `secrets-scan` → `sast-scan`).
+   - Run the test suite (`test`).
+   - Bump `package.json`, commit, tag (`vX.Y.Z`), and push to `git_branch` (`bump-version`).
+   - Build the library (via the `prepublishOnly` hook) and run `npm publish` (`publish`).
 
-2. Verify you have publish access to the `gwchq-textjam` package.
+Each stage gates the next — if a scan or the test suite fails, the version is never bumped and nothing is published.
 
-3. Make sure all changes are committed and the working directory is clean.
+### Verify publication
 
-### Publishing Steps
-
-1. **Update the version** in `package.json` following [semantic versioning](https://semver.org/):
-   - Patch: `0.1.2` → `0.1.3` (bug fixes)
-   - Minor: `0.1.2` → `0.2.0` (new features, backwards compatible)
-   - Major: `0.1.2` → `1.0.0` (breaking changes)
-2. **Build the library** (automatically runs via `prepublishOnly` hook):
-
-   ```bash
-   yarn build:lib
-   ```
-
-   This creates the `dist` folder with:
-
-   - `index.js` - The main ESM module
-   - `style.css` - Extracted stylesheet
-   - `assets/` - Static assets (icons, fonts, etc.)
-
-3. **Verify the build output**:
-
-   - Check that `dist/index.js` exists and is properly built
-   - Verify `dist/style.css` contains all styles
-   - Ensure all required assets are in `dist/assets/`
-
-4. **Publish to npm**:
-
-   ```bash
-   npm publish
-   ```
-
-   The `prepublishOnly` script will automatically run `yarn build:lib` before publishing.
-
-5. **Verify publication**:
-   ```bash
-   npm view gwchq-textjam version
-   ```
+```bash
+npm view gwchq-textjam version
+```
 
 ### What Gets Published
 

package/dist/360.index.js

@@ -5,7 +5,7 @@ export const modules = {
 /***/ 22796:
 /***/ ((module) => {
 
-module.exports = /*#__PURE__*/JSON.parse('{"modal":{"close":"Close","error":{"error":"Error","heading":"An error has occurred","externalLink":{"message":"Unfortunately links to external sites are not available in the Editor."}}},"editorPanel":{"ariaLabel":"editor text input","characterLimitError":"Error: Character limit reached","characterLimitExplanation_one":"Files in the editor are limited to {{count}} character","characterLimitExplanation_other":"Files in the editor are limited to {{count}} characters","viewOnly":"View only","close":"close"},"filePanel":{"errors":{"reservedFileName":"{{fileName}} is a reserved file name. Please choose a different name.","containsSpaces":"File names must not contain spaces.","generalError":"Error","notUnique":"File names must be unique.","or":"or","unsupportedExtension":"File names must end in {{allowedExtensions}}."},"files":"Project files","images":"Image gallery","newFileButton":"Add file","newFileModal":{"cancel":"Cancel","heading":"Add a new file to your project","helpText":"Remember to add the file extension at the end of your file name, for example, {{examples}}","helpTextExample":{"html":"\'file.html\', \'file.css\' or \'file.js\'","python":"\'file.py\'"},"inputLabel":"Name your file","addFile":"Add file"},"renameFileModal":{"cancel":"Cancel","heading":"Rename file","inputLabel":"Name your file","save":"Save"},"fileMenu":{"label":"Open file menu","renameItem":"Rename file"}},"footer":{"accessibility":"Accessibility","charityNameAndNumber":"Raspberry Pi Foundation UK registered charity 1129409","cookies":"Cookies","privacy":"Privacy","safeguarding":"Safeguarding"},"projectName":{"label":"Project name","newProject":"New Project"},"header":{"download":"Download","editorLogoAltText":"Editor logo","projects":"Your projects","renameProject":"Edit project name","renameSave":"Save project name","save":"Save","loginToSave":"Log in to save","settings":"Settings"},"projectsPanel":{"projects":"Projects","yourProjectsButton":"Go to your projects","projectTypeLabel":"Project type"},"settingsPanel":{"info":"Settings"},"input":{"comment":{"py5":"Py5: imported mode"}},"mobile":{"code":"Code","menu":"Menu","output":"Output","preview":"Preview","steps":"Steps"},"modals":{"close":"Close"},"notifications":{"close":"close","loginPrompt":"To save this project and access it later, don\'t forget to log in or sign up!","projectRenamed":"You have renamed your project.","savePrompt":"Save this project to access it later under \\"Your projects\\"."},"project":{"accessDeniedWithAuthModal":{"embedded":{"text":"Visit the Projects site for cool project ideas"},"heading":"You can\'t access this project","newProject":"Create a new code project","projectsSiteLinkText":"Explore Projects site","text":"Visit the Projects site for cool project ideas or start coding in a new project."},"loading":"Loading","notFoundModal":{"embedded":{"text":"Visit the Projects site for cool project ideas"},"heading":"This project does not exist","newProject":"Start new code project","projectsSiteLinkText":"Explore Projects site","text":"You can start coding in a new project, or visit the Projects site for cool project ideas."},"untitled":"Untitled project"},"projectHeader":{"subTitle":"Code Editor","title":"Your projects","text":"Select a project to continue coding, view, or edit it."},"projectList":{"delete":"Delete","deleteLabel":"Delete project","empty":"No projects created yet","label":"Open project menu","loading":"Loading","loadingFailed":"Failed to load projects","newProject":"Create a new project","pagination":{"first":"First page","last":"Last page","next":"Next page","previous":"Previous page","more":"Load more projects"},"rename":"Rename","renameLabel":"Rename project","renameProjectModal":{"cancel":"Do not save","heading":"Rename project","inputLabel":"Change the name of your project","save":"Save"},"updated":"Edited","python_type":"Python","html_type":"HTML"},"projectTypes":{"html":"HTML/CSS","python":"Python"},"runButton":{"run":"Run","stop":"Stop","stopping":"Stopping..."},"saveStatus":{"saving":"Saving","saved":"Saved"},"sidebar":{"collapse":"Collapse sidebar","download":"Download project","expand":"Expand sidebar","file":"Project files","images":"Image gallery","settings":"Settings","projects":"Projects","information":"Information","information_text":"Our Code Editor is a tool to help young people learn to code. We have only included functions that are simple and safe to use. That\'s why, for example, links to other websites are not allowed.","feedback":"Feedback","help":"Help","privacy":"Privacy","cookies":"Cookies","accessibility":"Accessibility","safeguarding":"Safeguarding","charity":"Raspberry Pi Foundation - UK registered charity 1129409","settingsMenu":{"heading":"Settings","textSize":"Text size","theme":"Theme","textSizeOptions":{"large":"Large","medium":"Medium","small":"Small"},"themeOptions":{"dark":"Dark","light":"Light"}}},"webComponent":{"failed":"Load failed"},"newInputPanelButton":{"buttonText":"Add another panel"},"button":{"yes":"Yes","no":"No"},"common":{"or":"or"}}');
+module.exports = /*#__PURE__*/JSON.parse('{"modal":{"close":"Close","error":{"error":"Error","heading":"An error has occurred","externalLink":{"message":"Unfortunately links to external sites are not available in the Editor."}}},"editorPanel":{"ariaLabel":"editor text input. Press Escape then Tab to move focus out of the editor","characterLimitError":"Error: Character limit reached","characterLimitExplanation_one":"Files in the editor are limited to {{count}} character","characterLimitExplanation_other":"Files in the editor are limited to {{count}} characters","viewOnly":"View only","close":"close"},"filePanel":{"errors":{"reservedFileName":"{{fileName}} is a reserved file name. Please choose a different name.","containsSpaces":"File names must not contain spaces.","generalError":"Error","notUnique":"File names must be unique.","or":"or","unsupportedExtension":"File names must end in {{allowedExtensions}}."},"files":"Project files","images":"Image gallery","newFileButton":"Add file","newFileModal":{"cancel":"Cancel","heading":"Add a new file to your project","helpText":"Remember to add the file extension at the end of your file name, for example, {{examples}}","helpTextExample":{"html":"\'file.html\', \'file.css\' or \'file.js\'","python":"\'file.py\'"},"inputLabel":"Name your file","addFile":"Add file"},"renameFileModal":{"cancel":"Cancel","heading":"Rename file","inputLabel":"Name your file","save":"Save"},"fileMenu":{"label":"Open file menu","renameItem":"Rename file"}},"footer":{"accessibility":"Accessibility","charityNameAndNumber":"Raspberry Pi Foundation UK registered charity 1129409","cookies":"Cookies","privacy":"Privacy","safeguarding":"Safeguarding"},"projectName":{"label":"Project name","newProject":"New Project"},"header":{"download":"Download","editorLogoAltText":"Editor logo","projects":"Your projects","renameProject":"Edit project name","renameSave":"Save project name","save":"Save","loginToSave":"Log in to save","settings":"Settings"},"projectsPanel":{"projects":"Projects","yourProjectsButton":"Go to your projects","projectTypeLabel":"Project type"},"settingsPanel":{"info":"Settings"},"input":{"comment":{"py5":"Py5: imported mode"}},"mobile":{"code":"Code","menu":"Menu","output":"Output","preview":"Preview","steps":"Steps"},"modals":{"close":"Close"},"notifications":{"close":"close","loginPrompt":"To save this project and access it later, don\'t forget to log in or sign up!","projectRenamed":"You have renamed your project.","savePrompt":"Save this project to access it later under \\"Your projects\\"."},"project":{"accessDeniedWithAuthModal":{"embedded":{"text":"Visit the Projects site for cool project ideas"},"heading":"You can\'t access this project","newProject":"Create a new code project","projectsSiteLinkText":"Explore Projects site","text":"Visit the Projects site for cool project ideas or start coding in a new project."},"loading":"Loading","notFoundModal":{"embedded":{"text":"Visit the Projects site for cool project ideas"},"heading":"This project does not exist","newProject":"Start new code project","projectsSiteLinkText":"Explore Projects site","text":"You can start coding in a new project, or visit the Projects site for cool project ideas."},"untitled":"Untitled project"},"projectHeader":{"subTitle":"Code Editor","title":"Your projects","text":"Select a project to continue coding, view, or edit it."},"projectList":{"delete":"Delete","deleteLabel":"Delete project","empty":"No projects created yet","label":"Open project menu","loading":"Loading","loadingFailed":"Failed to load projects","newProject":"Create a new project","pagination":{"first":"First page","last":"Last page","next":"Next page","previous":"Previous page","more":"Load more projects"},"rename":"Rename","renameLabel":"Rename project","renameProjectModal":{"cancel":"Do not save","heading":"Rename project","inputLabel":"Change the name of your project","save":"Save"},"updated":"Edited","python_type":"Python","html_type":"HTML"},"projectTypes":{"html":"HTML/CSS","python":"Python"},"runButton":{"run":"Run","stop":"Stop","stopping":"Stopping..."},"saveStatus":{"saving":"Saving","saved":"Saved"},"sidebar":{"collapse":"Collapse sidebar","download":"Download project","expand":"Expand sidebar","file":"Project files","images":"Image gallery","settings":"Settings","projects":"Projects","information":"Information","information_text":"Our Code Editor is a tool to help young people learn to code. We have only included functions that are simple and safe to use. That\'s why, for example, links to other websites are not allowed.","feedback":"Feedback","help":"Help","privacy":"Privacy","cookies":"Cookies","accessibility":"Accessibility","safeguarding":"Safeguarding","charity":"Raspberry Pi Foundation - UK registered charity 1129409","settingsMenu":{"heading":"Settings","textSize":"Text size","theme":"Theme","textSizeOptions":{"large":"Large","medium":"Medium","small":"Small"},"themeOptions":{"dark":"Dark","light":"Light"}}},"newInputPanelButton":{"buttonText":"Add another panel"},"button":{"yes":"Yes","no":"No"},"common":{"or":"or"},"webComponent":{"failed":"Load failed"}}');
 
 /***/ })
 

package/dist/assets/{PyodideWorkerb1409749c37aedc47dc8.js → PyodideWorkereba24d5259c22fbe422a.js}

@@ -133,6 +133,8 @@ const PyodideWorker = () => {
   let useSyncXhrStdin = false;
   /** True when current input request was cancelled from outside the worker. */
   let stdinCancelled = false;
+  /** True when the sync-XHR stdin transport failed (SW unreachable / request escaped). */
+  let stdinTransportFailed = false;
   /** Used when SharedArrayBuffer is unavailable: resolve for the pending input() call. */
   let pendingStdinResolve = null;
   // Until Pyodide is fully initialised, keep stdout/stderr in the dev console only.
@@ -185,6 +187,7 @@ const PyodideWorker = () => {
       case "runPython":
         currentRunId = data.runId || null;
         stdinCancelled = false;
+        stdinTransportFailed = false;
         runPython(data.python, data.userModuleNames);
         break;
       case "stopPython": {
@@ -238,10 +241,7 @@ const PyodideWorker = () => {
         await runUserCode();
       });
     } catch (error) {
-      const isStdinControlError =
-        error?.message === "PYODIDE_STDIN_CANCELLED" ||
-        error?.message === "PYODIDE_STDIN_TIMEOUT" ||
-        error?.message === "PYODIDE_STDIN_ABORTED";
+      const isStdinControlError = error?.message === "PYODIDE_STDIN_CANCELLED";
 
       if (stdinCancelled || isStdinControlError) {
         postMessage({
@@ -256,6 +256,19 @@ const PyodideWorker = () => {
         return;
       }
 
+      if (stdinTransportFailed) {
+        postMessage({
+          method: "handleError",
+          file: "main.py",
+          line: "",
+          mistake: "",
+          type: "InputUnavailableError",
+          info: "Input timed out. Rerun your code and try again.",
+        });
+        await clearPyodideData(userModuleNames);
+        return;
+      }
+
       if (!(error instanceof pyodide.ffi.PythonError)) {
         postMessage({
           method: "handleError",
@@ -691,59 +704,64 @@ const PyodideWorker = () => {
   };
 
   const readInputViaSyncXhr = (runId) => {
-    const requestId = crypto.randomUUID();
-    const requestUrl = new URL(
-      stdinFallbackConfig.endpointPath,
-      // eslint-disable-next-line no-restricted-globals
-      self.location.origin,
-    );
-    requestUrl.searchParams.set("runId", runId || "");
-    requestUrl.searchParams.set("requestId", requestId);
-    requestUrl.searchParams.set("clientId", stdinFallbackConfig.clientId);
-
-    const xhr = new XMLHttpRequest();
-    xhr.open("GET", requestUrl.toString(), false);
-    xhr.setRequestHeader("X-Pyodide-Stdin-Request", "true");
-    xhr.setRequestHeader("Cache-Control", "no-store");
-
+    // Mark any failure with XHR setup as stdinTransportFailed for a clean error
     try {
+      const requestId = crypto.randomUUID();
+      const requestUrl = new URL(
+        stdinFallbackConfig.endpointPath,
+        // eslint-disable-next-line no-restricted-globals
+        self.location.origin,
+      );
+      requestUrl.searchParams.set("runId", runId || "");
+      requestUrl.searchParams.set("requestId", requestId);
+      requestUrl.searchParams.set("clientId", stdinFallbackConfig.clientId);
+
+      const xhr = new XMLHttpRequest();
+      xhr.open("GET", requestUrl.toString(), false);
+      xhr.setRequestHeader("X-Pyodide-Stdin-Request", "true");
+      xhr.setRequestHeader("Cache-Control", "no-store");
       xhr.send(null);
-    } catch (_) {
-      throw new Error("Failed to read Python input via stdin fallback");
-    }
 
-    if (xhr.status === STDIN_CANCELLED_RESPONSE_CODE) {
-      stdinCancelled = true;
-      throw new Error("PYODIDE_STDIN_CANCELLED");
-    }
+      if (xhr.status === STDIN_CANCELLED_RESPONSE_CODE) {
+        stdinCancelled = true;
+        throw new Error("PYODIDE_STDIN_CANCELLED");
+      }
 
-    if (xhr.status === STDIN_TIMEOUT_RESPONSE_CODE) {
-      throw new Error("PYODIDE_STDIN_TIMEOUT");
-    }
+      if (xhr.status === STDIN_TIMEOUT_RESPONSE_CODE) {
+        stdinTransportFailed = true;
+        throw new Error("PYODIDE_STDIN_TIMEOUT");
+      }
 
-    if (xhr.status === STDIN_ABORTED_RESPONSE_CODE) {
-      throw new Error("PYODIDE_STDIN_ABORTED");
-    }
+      if (xhr.status === STDIN_ABORTED_RESPONSE_CODE) {
+        stdinTransportFailed = true;
+        throw new Error("PYODIDE_STDIN_ABORTED");
+      }
 
-    // EOF: orchestrator signalled Ctrl+D / no more input. Returning null tells
-    // Pyodide's line-based stdin handler to raise EOFError at the input() call
-    // site, rather than escalating to a KeyboardInterrupt that tears down the run.
-    if (xhr.status === STDIN_EOF_RESPONSE_CODE) {
-      return null;
-    }
+      // EOF: orchestrator signalled Ctrl+D / no more input. Returning null tells
+      // Pyodide's line-based stdin handler to raise EOFError at the input() call
+      // site, rather than escalating to a KeyboardInterrupt that tears down the run.
+      if (xhr.status === STDIN_EOF_RESPONSE_CODE) {
+        return null;
+      }
 
-    if (xhr.status !== 200) {
-      throw new Error(
-        `Python input request failed with status ${xhr.status}: ${xhr.responseText}`,
-      );
-    }
+      if (xhr.status !== 200) {
+        throw new Error(
+          `Python input request failed with status ${xhr.status}: ${xhr.responseText}`,
+        );
+      }
 
-    let content = xhr.responseText ?? "";
-    if (!content.endsWith("\n")) {
-      content += "\n";
-    }
+      let content = xhr.responseText ?? "";
+      if (!content.endsWith("\n")) {
+        content += "\n";
+      }
 
-    return content;
+      return content;
+    } catch (err) {
+      if (!stdinCancelled) {
+        stdinTransportFailed = true;
+      }
+      throw err;
+    }
   };
 
   const clearPyodideData = async (userModuleNames) => {

package/dist/assets/pyodide-stdin-sw.js

@@ -175,6 +175,13 @@ self.addEventListener("message", (event) => {
     event.source && "id" in event.source ? event.source.id : "";
   const clientId = data.clientId || eventClientId || "";
 
+  if (data.type === "PYODIDE_STDIN_PROBE") {
+    if (event.source) {
+      event.source.postMessage({ type: "PYODIDE_STDIN_PROBE_ACK" });
+    }
+    return;
+  }
+
   if (data.type === "PYODIDE_STDIN_REGISTER") {
     if (data.clientId && eventClientId) {
       tabClientToWindowClient.set(String(data.clientId), String(eventClientId));