Improve CI

.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  verify_json:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+
+      - name: Install yajl-tools
+        run: sudo apt-get install -qq yajl-tools
+
+      - name: Check that JSON files are valid
+        run: for f in *.json dist/*.json filter_lists/*.json ; do json_verify < $f || echo "$f failed" ; done
+
+  confirm_built:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+
+      - name: Install node
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
+        with:
+          node-version: "20"
+
+      - name: Get changed resource-related files
+        id: changed-files
+        uses: tj-actions/changed-files@cbda684547adc8c052d50711417fa61b428a9f88 # v41
+        with:
+          files: |
+            resources
+            metadata.json
+
+      - name: Build and verify
+        if: steps.changed-files.outputs.any_changed == 'true'
+        run: |
+          npm run build
+          npm run generateMetadata
+
+      - name: Check for any drift via git diff
+        if: steps.changed-files.outputs.any_changed == 'true'
+        run: |
+          git diff --no-ext-diff --exit-code metadata.json
+
+  check_format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+
+      - name: Install node
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
+        with:
+          node-version: "20"
+
+      - name: See if list catalog has changed
+        id: changed-files
+        uses: tj-actions/changed-files@cbda684547adc8c052d50711417fa61b428a9f88 # v41
+        with:
+          files: |
+            filter_lists/list_catalog.json
+
+      - name: Run format tests
+        if: steps.changed-files.outputs.any_changed == 'true'
+        run: |
+          npm run test

build.js

@@ -1,6 +1,6 @@
-const fs = require('fs')
-const path = require('path')
+import fs from 'fs'
+import path from 'path'
 
-const { readResources } = require('.')
+import { readResources } from './index.js'
 
-fs.writeFileSync(path.join(__dirname, 'dist', 'resources.json'), JSON.stringify(readResources()))
+fs.writeFileSync(path.join(import.meta.dirname, 'dist', 'resources.json'), JSON.stringify(readResources()))

generateMetadataJsonFromScriptResources.js

@@ -4,8 +4,8 @@
  * For instance - brave-fix script needs the "bf" alias
  */
 
-const fs = require("fs");
-const path = require("path");
+import fs from "fs";
+import path from "path";
 
 const metadataJsonFile = "metadata.json";
 const resourcesDir = "resources";

index.js

@@ -1,17 +1,17 @@
-const fs = require('fs')
-const path = require('path')
+import fs from 'fs'
+import path from 'path'
 
-const metadata = require('./metadata.json')
+import metadata from './metadata.json' with { type: "json" }
 
 const readResources = (() => {
     return metadata.map(item => ({
         name: item.name,
         aliases: item.aliases,
         kind: item.kind,
-        content: fs.readFileSync(path.join(__dirname, 'resources', item.resourcePath)).toString('base64')
+        content: fs.readFileSync(path.join(import.meta.dirname, 'resources', item.resourcePath)).toString('base64')
     }))
 })
 
-const listCatalog = require('./filter_lists/list_catalog.json')
+import listCatalog from './filter_lists/list_catalog.json' with { type: "json" }
 
-module.exports = { listCatalog, readResources }
+export { listCatalog, readResources }

package.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "description": "Custom resources and scriptlets used for Brave's adblocker",
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "build": "node build",
     "test": "node verify",

verify.js

@@ -1,8 +1,19 @@
-const { readResources, listCatalog } = require('.')
+import { readResources, listCatalog } from './index.js'
 
-const assert = require('node:assert')
-const test = require('node:test')
-const { Engine, FilterFormat, FilterSet } = require('adblock-rs')
+import assert from 'node:assert'
+import crypto from 'crypto'
+import test from 'node:test'
+import { Engine, FilterFormat, FilterSet } from 'adblock-rs'
+
+const getIDFromBase64PublicKey = (key) => {
+  const hash = crypto.createHash('sha256')
+  const data = Buffer.from(key, 'base64')
+  const digest = hash.update(data).digest('hex')
+  const id = digest.toString().substring(0, 32)
+  return id.replace(/[0-9a-f]/g, (c) => {
+    return 'abcdefghijklmnop'.charAt('0123456789abcdef'.indexOf(c))
+  })
+}
 
 test('resources are parsed OK by adblock-rust', t => {
     const resources = readResources()
@@ -34,6 +45,9 @@ const testLists = (lists) => {
         assert.ok(list.list_text_component.component_id !== undefined && typeof list.list_text_component.component_id === 'string')
         assert.ok(list.list_text_component.base64_public_key !== undefined && typeof list.list_text_component.base64_public_key === 'string')
 
+        assert.ok(list.component_id === getIDFromBase64PublicKey(list.base64_public_key))
+        assert.ok(list.list_text_component.component_id === getIDFromBase64PublicKey(list.list_text_component.base64_public_key))
+
         assert.ok(list.sources !== undefined && Array.isArray(list.sources))
         for (const source of list.sources) {
             assert.ok(source.url !== undefined && typeof source.url === 'string')