Add Firefox metadata recovery workflow

Author: josStorer

.github/workflows/firefox-metadata.yml

@@ -0,0 +1,34 @@
+name: Firefox metadata
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Firefox version to update, for example 2.6.1"
+        required: true
+        type: string
+
+permissions:
+  contents: read
+
+jobs:
+  update-firefox-metadata:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Update Firefox metadata
+        run: npm run release:update-firefox-metadata -- --version "${{ inputs.version }}"
+        env:
+          FIREFOX_EXTENSION_ID: ${{ secrets.FIREFOX_EXTENSION_ID }}
+          FIREFOX_JWT_ISSUER: ${{ secrets.FIREFOX_JWT_ISSUER }}
+          FIREFOX_JWT_SECRET: ${{ secrets.FIREFOX_JWT_SECRET }}

package.json

@@ -20,6 +20,7 @@
     "release:firefox-sources": "node scripts/create-firefox-sources-zip.mjs",
     "release:submit": "node scripts/submit-stores.mjs",
     "release:submit:dry-run": "node scripts/submit-stores.mjs --dry-run",
+    "release:update-firefox-metadata": "node scripts/update-firefox-metadata.mjs",
     "release:check-edge-api-key": "node scripts/check-edge-api-key-expiry.mjs"
   },
   "pre-commit": [

scripts/update-firefox-metadata.mjs

@@ -0,0 +1,66 @@
+/* global process */
+
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { updateFirefoxVersionNotes } from './submit-stores.mjs'
+
+const REQUIRED_FIREFOX_METADATA_ENV = [
+  'FIREFOX_EXTENSION_ID',
+  'FIREFOX_JWT_ISSUER',
+  'FIREFOX_JWT_SECRET',
+]
+
+export function parseFirefoxMetadataArgs(args) {
+  let version = ''
+
+  for (let index = 0; index < args.length; index += 1) {
+    const arg = args[index]
+    if (arg === '--version') {
+      version = args[index + 1] || ''
+      index += 1
+    } else if (arg.startsWith('--version=')) {
+      version = arg.slice('--version='.length)
+    }
+  }
+
+  return { version }
+}
+
+export function findMissingFirefoxMetadataEnv(env = process.env) {
+  return REQUIRED_FIREFOX_METADATA_ENV.filter((name) => !env[name])
+}
+
+export async function updateFirefoxMetadata({
+  argv = process.argv.slice(2),
+  env = process.env,
+  updateImpl = updateFirefoxVersionNotes,
+  logger = console.log,
+} = {}) {
+  const { version } = parseFirefoxMetadataArgs(argv)
+  if (!version) {
+    throw new Error(
+      'Missing Firefox metadata version. Use --version <version>, for example --version 2.6.1',
+    )
+  }
+
+  const missingEnv = findMissingFirefoxMetadataEnv(env)
+  if (missingEnv.length > 0) {
+    throw new Error(`Missing Firefox metadata environment variables: ${missingEnv.join(', ')}`)
+  }
+
+  logger(`Updating Firefox metadata for ChatGPTBox ${version}`)
+  await updateImpl({
+    extensionId: env.FIREFOX_EXTENSION_ID,
+    version,
+    jwtIssuer: env.FIREFOX_JWT_ISSUER,
+    jwtSecret: env.FIREFOX_JWT_SECRET,
+  })
+}
+
+const currentFile = fileURLToPath(import.meta.url)
+if (process.argv[1] && path.resolve(process.argv[1]) === currentFile) {
+  updateFirefoxMetadata().catch((error) => {
+    console.error(error)
+    process.exit(1)
+  })
+}

tests/unit/release/update-firefox-metadata.test.mjs

@@ -0,0 +1,80 @@
+import assert from 'node:assert/strict'
+import test from 'node:test'
+import {
+  findMissingFirefoxMetadataEnv,
+  parseFirefoxMetadataArgs,
+  updateFirefoxMetadata,
+} from '../../../scripts/update-firefox-metadata.mjs'
+
+test('parseFirefoxMetadataArgs reads the target version', () => {
+  assert.deepEqual(parseFirefoxMetadataArgs(['--version', '2.6.1']), { version: '2.6.1' })
+  assert.deepEqual(parseFirefoxMetadataArgs(['--version=2.6.1']), { version: '2.6.1' })
+})
+
+test('findMissingFirefoxMetadataEnv reports required Firefox secrets only', () => {
+  assert.deepEqual(findMissingFirefoxMetadataEnv({}), [
+    'FIREFOX_EXTENSION_ID',
+    'FIREFOX_JWT_ISSUER',
+    'FIREFOX_JWT_SECRET',
+  ])
+
+  assert.deepEqual(
+    findMissingFirefoxMetadataEnv({
+      FIREFOX_EXTENSION_ID: 'chatgptbox',
+      FIREFOX_JWT_ISSUER: 'issuer',
+      FIREFOX_JWT_SECRET: 'secret',
+    }),
+    [],
+  )
+})
+
+test('updateFirefoxMetadata patches the requested Firefox version only', async () => {
+  const calls = []
+
+  await updateFirefoxMetadata({
+    argv: ['--version', '2.6.1'],
+    env: {
+      FIREFOX_EXTENSION_ID: 'chatgptbox',
+      FIREFOX_JWT_ISSUER: 'issuer',
+      FIREFOX_JWT_SECRET: 'secret',
+    },
+    updateImpl: async (params) => {
+      calls.push(params)
+    },
+    logger: () => {},
+  })
+
+  assert.equal(calls.length, 1)
+  assert.deepEqual(calls[0], {
+    extensionId: 'chatgptbox',
+    version: '2.6.1',
+    jwtIssuer: 'issuer',
+    jwtSecret: 'secret',
+  })
+})
+
+test('updateFirefoxMetadata fails before patching when version or secrets are missing', async () => {
+  await assert.rejects(
+    updateFirefoxMetadata({
+      argv: [],
+      env: {},
+      updateImpl: async () => {
+        throw new Error('should not patch')
+      },
+      logger: () => {},
+    }),
+    /Missing Firefox metadata version/,
+  )
+
+  await assert.rejects(
+    updateFirefoxMetadata({
+      argv: ['--version', '2.6.1'],
+      env: {},
+      updateImpl: async () => {
+        throw new Error('should not patch')
+      },
+      logger: () => {},
+    }),
+    /Missing Firefox metadata environment variables/,
+  )
+})