@lightningjs/blits 1.27.1 → 1.28.0

package/.github/workflows/comment-lint-results.yml

@@ -8,144 +8,94 @@ on:
 
 jobs:
   comment-lint-results:
-    # Only run this job if the previous workflow failed (indicating lint errors)
     if: github.event.workflow_run.conclusion == 'failure'
     runs-on: ubuntu-latest
     permissions:
       pull-requests: write
 
     steps:
-    - name: Download Lint Results
-      id: download
-      uses: actions/github-script@v6
-      with:
-        script: |
-          try {
-            core.info('Downloading lint results artifact');
+      - name: Download Lint Results
+        id: download
+        uses: actions/github-script@v6
+        with:
+          result-encoding: string
+          script: |
 
-            const artifacts = await github.rest.actions.listWorkflowRunArtifacts({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              run_id: ${{ github.event.workflow_run.id }}
-            });
-
-            const matchArtifact = artifacts.data.artifacts.find(artifact => artifact.name === "lint-results");
-            if (!matchArtifact) {
-              core.setFailed('No lint results artifact found');
-              return false;
-            }
-
-            core.info(`Found artifact id: ${matchArtifact.id}`);
-
-            const download = await github.rest.actions.downloadArtifact({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              artifact_id: matchArtifact.id,
-              archive_format: 'zip'
-            });
-
-            const fs = require('fs');
             try {
-              fs.writeFileSync('lint-results.zip', Buffer.from(download.data));
-              core.info('Successfully downloaded and saved artifact');
-              return true;
-            } catch (error) {
-              core.setFailed(`Failed to write artifact: ${error.message}`);
-              return false;
+              core.info('Downloading lint-results artifact');
+              const runId = context.payload.workflow_run.id;
+
+              const artifacts = await github.rest.actions.listWorkflowRunArtifacts({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                run_id: runId
+              });
+
+              const art = artifacts.data.artifacts.find(a => a.name === "lint-results");
+              if (!art) {
+                core.setFailed('No lint-results artifact found');
+                return 'false';
+              }
+
+              core.info(`Found artifact id ${art.id}, downloading…`);
+              const dl = await github.rest.actions.downloadArtifact({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                artifact_id: art.id,
+                archive_format: 'zip'
+              });
+
+              require('fs').writeFileSync('lint-results.zip', Buffer.from(dl.data));
+              core.info('Downloaded and saved lint-results.zip');
+              return 'true';
+
+            } catch (err) {
+              core.setFailed(`Download failed: ${err.message}`);
+              return 'false';
             }
-          } catch (error) {
-            core.setFailed(`Failed to download artifact: ${error.message}`);
-            return false;
-          }
-        result-encoding: string
-
-    - name: Extract Lint Results
-      if: steps.download.outputs.result == 'true'
-      id: extract
-      run: |
-        mkdir -p lint-results
-        unzip -o lint-results.zip -d lint-results
 
-        if [ -f lint-results/errors.md ]; then
-          # Use GitHub's EOF syntax for multiline content
-          echo "LINT_ERRORS<<EOF" >> $GITHUB_ENV
-          cat lint-results/errors.md >> $GITHUB_ENV
-          echo "EOF" >> $GITHUB_ENV
-          echo "HAS_ERRORS=true" >> $GITHUB_OUTPUT
-        else
-          echo "HAS_ERRORS=false" >> $GITHUB_OUTPUT
-        fi
-
-    - name: Find PR Number
-      if: steps.extract.outputs.HAS_ERRORS == 'true'
-      id: find-pr
-      uses: actions/github-script@v6
-      with:
-        script: |
-          try {
-            core.info('Finding associated PR');
-
-            const { owner, repo } = context.repo;
-            const run_id = ${{ github.event.workflow_run.id }};
-
-            // Get the triggering workflow run
-            const run = await github.rest.actions.getWorkflowRun({
-              owner,
-              repo,
-              run_id
-            });
-
-            // Find associated PR - first try the event payload
-            if (run.data.pull_requests && run.data.pull_requests.length > 0) {
-              core.info(`Found PR directly from run data: #${run.data.pull_requests[0].number}`);
-              return run.data.pull_requests[0].number;
-            }
-
-            // Fallback to searching by head SHA
-            core.info(`Searching for PR using head SHA: ${run.data.head_sha}`);
-            const pulls = await github.rest.pulls.list({
-              owner,
-              repo,
-              state: 'open',
-              head: `${owner}:${run.data.head_branch}`
-            });
-
-            if (pulls.data.length > 0) {
-              core.info(`Found PR by branch: #${pulls.data[0].number}`);
-              return pulls.data[0].number;
-            }
-
-            core.info('No PR found for this workflow run');
-            return null;
-          } catch (error) {
-            core.setFailed(`Failed to find PR: ${error.message}`);
-            return null;
-          }
-        result-encoding: string
-
-    - name: Post Lint Results as PR Comment
-      if: steps.find-pr.outputs.result != 'null' && steps.find-pr.outputs.result != ''
-      uses: actions/github-script@v6
-      with:
-        script: |
-          try {
-            const pr_number = parseInt(${{ steps.find-pr.outputs.result }});
-
-            if (isNaN(pr_number)) {
-              core.warning('Invalid PR number');
-              return;
+      - name: Extract Lint Results
+        if: steps.download.outputs.result == 'true'
+        id: extract
+        run: |
+          mkdir -p lint-results
+          unzip -o lint-results.zip -d lint-results
+
+          if [ -f lint-results/errors.md ]; then
+            echo "LINT_ERRORS<<EOF" >> $GITHUB_ENV
+            cat lint-results/errors.md >> $GITHUB_ENV
+            echo "EOF" >> $GITHUB_ENV
+            echo "HAS_ERRORS=true" >> $GITHUB_OUTPUT
+          else
+            echo "HAS_ERRORS=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Post Lint Results as PR Comment
+        if: steps.extract.outputs.HAS_ERRORS == 'true'
+        uses: actions/github-script@v6
+        with:
+          script: |
+            try {
+              const pulls = context.payload.workflow_run.pull_requests;
+              core.info(`Found ${pulls.length} triggering PR(s)`);
+
+              if (pulls.length === 0) {
+                core.warning('No associated PRs; skipping comment.');
+                return;
+              }
+
+              const body = process.env.LINT_ERRORS;
+              for (const pr of pulls) {
+                core.info(`Commenting lint errors on PR #${pr.number}`);
+                await github.rest.issues.createComment({
+                  owner: context.repo.owner,
+                  repo:  context.repo.repo,
+                  issue_number: pr.number,
+                  body
+                });
+              }
+              core.info('All comments posted');
+            } catch (err) {
+              core.error('Failed to post lint comment:', err);
+              core.setFailed(err.message);
             }
-
-            core.info(`Posting comment to PR #${pr_number}`);
-
-            await github.rest.issues.createComment({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              issue_number: pr_number,
-              body: process.env.LINT_ERRORS
-            });
-
-            core.info(`Successfully posted lint errors comment to PR #${pr_number}`);
-          } catch (error) {
-            core.setFailed(`Failed to post comment: ${error.message}`);
-          }

package/.github/workflows/comment-test-results.yml

@@ -3,8 +3,7 @@ name: Comment Test Results
 on:
   workflow_run:
     workflows: ["Run Blits Tests"]
-    types:
-      - completed
+    types: [completed]
 
 jobs:
   comment-test-results:
@@ -13,102 +12,70 @@ jobs:
       pull-requests: write
 
     steps:
-    - name: Download Test Results
-      uses: actions/github-script@v6
-      with:
-        script: |
-          const artifacts = await github.rest.actions.listWorkflowRunArtifacts({
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            run_id: ${{ github.event.workflow_run.id }}
-          });
-
-          const matchArtifact = artifacts.data.artifacts.find(artifact => artifact.name === "test-results");
-          if (!matchArtifact) {
-            core.setFailed('No test results artifact found');
-            return;
-          }
-
-          const download = await github.rest.actions.downloadArtifact({
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            artifact_id: matchArtifact.id,
-            archive_format: 'zip'
-          });
-
-          const fs = require('fs');
-          fs.writeFileSync('test-results.zip', Buffer.from(download.data));
-
-    - name: Extract Test Results
-      run: |
-        mkdir -p test-results
-        unzip -o test-results.zip -d test-results
-
-        TIMESTAMP=$(cat test-results/timestamp.txt)
-        SUMMARY=$(cat test-results/summary.txt)
-        FAILED=$(cat test-results/failed.txt)
-
-        echo "TIMESTAMP=$TIMESTAMP" >> $GITHUB_ENV
-        echo "SUMMARY=$SUMMARY" >> $GITHUB_ENV
-        echo "FAILED=$FAILED" >> $GITHUB_ENV
-
-        # Check if error.txt exists and read it if it does
-        if [ -f test-results/error.txt ]; then
-          # Store raw error output in a file for the next step
-          cat test-results/error.txt > raw_error.txt
-        fi
-
-    - name: Find PR Number
-      id: find-pr
-      uses: actions/github-script@v6
-      with:
-        script: |
-          const { owner, repo } = context.repo;
-          const run_id = ${{ github.event.workflow_run.id }};
-
-          // Get the triggering workflow run
-          const run = await github.rest.actions.getWorkflowRun({
-            owner,
-            repo,
-            run_id
-          });
-
-          // Find associated PR
-          const pulls = await github.rest.pulls.list({
-            owner,
-            repo,
-            state: 'open',
-            head: run.data.head_sha
-          });
-
-          if (pulls.data.length > 0) {
-            return pulls.data[0].number;
-          }
-
-          console.log('No PR found');
-          return null;
-        result-encoding: string
-
-    - name: Post Test Results as PR Comment
-      if: steps.find-pr.outputs.result != 'null'
-      uses: actions/github-script@v6
-      with:
-        script: |
-          const fs = require('fs');
-          const pr_number = parseInt(${{ steps.find-pr.outputs.result }});
-          const status = process.env.FAILED === 'true' ? '❌ FAILED' : '✅ PASSED';
-
-          let commentBody = `#### Test Results: ${status}\n**Run at:** ${process.env.TIMESTAMP}\n\n**Summary:**\n${process.env.SUMMARY}`;
-
-          // Add error output if it exists
-          if (fs.existsSync('raw_error.txt')) {
-            const errorOutput = fs.readFileSync('raw_error.txt', 'utf8');
-            commentBody += '\n\n**Error Output:**\n```\n' + errorOutput + '\n```';
-          }
-
-          github.rest.issues.createComment({
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            issue_number: pr_number,
-            body: commentBody
-          });
+      - name: Download Test Results
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const artifacts = await github.rest.actions.listWorkflowRunArtifacts({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              run_id: ${{ github.event.workflow_run.id }}
+            });
+            const art = artifacts.data.artifacts.find(a => a.name === "test-results");
+            if (!art) core.setFailed('No test-results artifact found');
+            const dl = await github.rest.actions.downloadArtifact({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              artifact_id: art.id,
+              archive_format: 'zip'
+            });
+            require('fs').writeFileSync('test-results.zip', Buffer.from(dl.data));
+      - name: Extract Test Results
+        run: |
+          mkdir -p test-results
+          unzip -o test-results.zip -d test-results
+          echo "TIMESTAMP=$(cat test-results/timestamp.txt)" >> $GITHUB_ENV
+          echo "SUMMARY=$(cat test-results/summary.txt)" >> $GITHUB_ENV
+          echo "FAILED=$(cat test-results/failed.txt)" >> $GITHUB_ENV
+          if [ -f test-results/error.txt ]; then cp test-results/error.txt raw_error.txt; fi
+
+      - name: Post Test Results as PR Comment
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const fs = require('fs');
+
+            try {
+              const pulls = context.payload.workflow_run.pull_requests;
+              console.log(`Found ${pulls.length} triggering PR(s).`);
+
+              if (pulls.length === 0) {
+                console.warn('No pull requests found for this workflow run; skipping comment.');
+                return;
+              }
+
+              const status = process.env.FAILED === 'true' ? '❌ FAILED' : '✅ PASSED';
+              let commentBody = `#### Test Results: ${status}\n`
+                              + `**Run at:** ${process.env.TIMESTAMP}\n\n`
+                              + `**Summary:**\n${process.env.SUMMARY}`;
+
+              if (fs.existsSync('raw_error.txt')) {
+                commentBody += '\n\n**Error Output:**\n```\n'
+                             + fs.readFileSync('raw_error.txt', 'utf8')
+                             + '\n```';
+              }
+
+              for (const pr of pulls) {
+                console.log(`Commenting on PR #${pr.number}`);
+                await github.rest.issues.createComment({
+                  owner: context.repo.owner,
+                  repo:  context.repo.repo,
+                  issue_number: pr.number,
+                  body: commentBody
+                });
+              }
+
+            } catch (err) {
+              console.error('🛑 Failed to post test results comment:', err);
+              core.setFailed(`Comment step failed: ${err.message}`);
+            }

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 _15 apr 2025_
 
+## v1.28.0
+
+- Added graceful handling of announcer when speechSynthesis API is not available
+- Renamed `beforeAll` method on router to `beforeEach` (as specified in the type definitions)
+- Fixed detection of correct PR to comment for github workflows
+
+_15 apr 2025_
+
 ## v1.27.1
 
 - Fixed issue with global watcher on router state not being cleared out

package/index.d.ts

@@ -23,7 +23,7 @@ import {type ShaderEffect as RendererShaderEffect, type WebGlCoreShader, type Re
 declare module '@lightningjs/blits' {
 
 
-  export interface AnnouncerUtterance extends Promise {
+  export interface AnnouncerUtterance extends Promise<T> {
     /**
      * Removes a specific message from the announcement queue,
      * to make sure it isn't spoke out.
@@ -481,7 +481,7 @@ declare module '@lightningjs/blits' {
   }
 
   export interface RouterHooks {
-    beforeEach?: (to: Route, from: Route) => string | Route | Promise<string | Route>;
+    beforeEach?: (to: Route, from: Route) => string | Route | Promise<string | Route> | void;
   }
 
   export interface RouterConfig {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightningjs/blits",
-  "version": "1.27.1",
+  "version": "1.28.0",
   "description": "Blits: The Lightning 3 App Development Framework",
   "bin": "bin/index.js",
   "exports": {

package/src/announcer/speechSynthesis.js

@@ -15,6 +15,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { Log } from '../lib/log.js'
+
 const syn = window.speechSynthesis
 
 const isAndroid = /android/i.test((window.navigator || {}).userAgent || '')
@@ -82,14 +84,21 @@ const speak = (options) => {
 
 export default {
   speak(options) {
-    if (!initialized) {
-      initialize()
+    if (syn !== undefined) {
+      if (initialized === false) {
+        initialize()
+      }
+      return speak(options)
+    } else {
+      Log.error('speechSynthesis web API not available')
+      return Promise.reject({ error: 'unavailable' })
     }
-    return speak(options)
   },
   cancel() {
-    syn.cancel()
-    clear()
+    if (syn !== undefined) {
+      syn.cancel()
+      clear()
+    }
   },
   // @todo
   // getVoices() {

package/src/router/router.js

@@ -148,8 +148,8 @@ export const navigate = async function () {
       let beforeEachResult
       if (this.parent[symbols.routerHooks]) {
         const hooks = this.parent[symbols.routerHooks]
-        if (hooks.beforeAll) {
-          beforeEachResult = await hooks.beforeAll(route, previousRoute)
+        if (hooks.beforeEach) {
+          beforeEachResult = await hooks.beforeEach(route, previousRoute)
           if (isString(beforeEachResult)) {
             to(beforeEachResult)
             return