👷 Update proto build system

.github/workflows/deploy.yml

@@ -36,6 +36,11 @@ jobs:
           cache: "pnpm"
           cache-dependency-path: "./app/pnpm-lock.yaml"
 
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+        with:
+          version: "27.x"
+
       - run: pnpm install
       - run: pnpm run build
 

.github/workflows/frontend-tests.yml

@@ -2,14 +2,14 @@ name: Frontend Tests
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
     paths:
-        - 'app/**'  
+      - "app/**"
   pull_request:
-    branches: [ master ]
+    branches: [master]
     paths:
-        - 'app/**'  
-    
+      - "app/**"
+
 permissions:
   contents: read
 
@@ -20,22 +20,31 @@ jobs:
       run:
         working-directory: ./app
     steps:
-    - uses: actions/checkout@v4
-    - uses: pnpm/action-setup@v2
-      with:
-        version: 9
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 9
 
-    - name: Setup Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: 'latest'
-        cache: 'pnpm'
-        cache-dependency-path: './app/pnpm-lock.yaml'
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "latest"
+          cache: "pnpm"
+          cache-dependency-path: "./app/pnpm-lock.yaml"
 
-    - name: Install dependencies
-      run: pnpm install
-    - name: Install Playwright Browsers
-      run: npx playwright install --with-deps
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+        with:
+          version: "27.x"
 
-    - name: Run tests
-      run: pnpm test
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Generate Proto
+        run: pnpm proto
+
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+
+      - name: Run tests
+        run: pnpm test

.github/workflows/proto-build.yml

@@ -56,4 +56,5 @@ jobs:
         working-directory: ./app
 
       - name: Build Protocol Buffers (Typescript)
-        run: protoc --plugin="protoc-gen-ts_proto=./app/node_modules/.bin/protoc-gen-ts_proto" --ts_proto_out="./app/src/lib/platform_shared" --ts_proto_opt=outputSchema=true --proto_path "./platform_shared" ./platform_shared/websocket_message.proto ./platform_shared/rest_message.proto
+        run: pnpm proto
+        working-directory: ./app

.gitignore

@@ -6,5 +6,7 @@ __pycache__/
 *.py[cod]
 *$py.class
 .pio
-esp32/src/platform_shared
-app/src/lib/platform_shared
+esp32/src/platform_shared/*
+!esp32/src/platform_shared/.gitkeep
+app/src/lib/platform_shared/*
+!app/src/lib/platform_shared/.gitkeep

app/package.json

@@ -14,7 +14,7 @@
         "format": "prettier --write .",
         "test:integration": "playwright test",
         "test:unit": "vitest",
-        "proto": "protoc --plugin=protoc-gen-ts_proto=.\\node_modules\\.bin\\protoc-gen-ts_proto.cmd --ts_proto_out=./src/lib/platform_shared --ts_proto_opt=outputTypeAnnotations=true,useExactTypes=false,outputExtensions=true,outputTypeRegistry=true,outputSchema=true -I ../platform_shared ../platform_shared/websocket_message.proto ../platform_shared/rest_message.proto"
+        "proto": "node scripts/compile_protos.js"
     },
     "devDependencies": {
         "@eslint/js": "^9.39.2",

app/scripts/compile_protos.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+import { execSync } from 'child_process';
+import path from 'path';
+import os from 'os';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const isWindows = os.platform() === 'win32';
+const projectRoot = path.resolve(__dirname, '..');
+const platformSharedDir = path.resolve(projectRoot, '..', 'platform_shared');
+const outputDir = path.resolve(projectRoot, 'src', 'lib', 'platform_shared');
+
+const pluginPath = isWindows
+    ? path.join(projectRoot, 'node_modules', '.bin', 'protoc-gen-ts_proto.cmd')
+    : path.join(projectRoot, 'node_modules', '.bin', 'protoc-gen-ts_proto');
+
+const protoFiles = ['websocket_message.proto', 'rest_message.proto'];
+
+const tsProtoOpts = [
+    'outputTypeAnnotations=true',
+    'useExactTypes=false',
+    'outputExtensions=true',
+    'outputTypeRegistry=true',
+    'outputSchema=true'
+].join(',');
+
+const cmd = [
+    'protoc',
+    `--plugin=protoc-gen-ts_proto=${pluginPath}`,
+    `--ts_proto_out=${outputDir}`,
+    `--ts_proto_opt=${tsProtoOpts}`,
+    `-I${platformSharedDir}`,
+    ...protoFiles.map(f => path.join(platformSharedDir, f))
+].join(' ');
+
+console.log('Compiling protos...');
+console.log(`  Platform: ${os.platform()}`);
+console.log(`  Output: ${outputDir}`);
+
+try {
+    execSync(cmd, { stdio: 'inherit', cwd: projectRoot });
+    console.log('Proto compilation complete!');
+} catch (error) {
+    console.error('Proto compilation failed!');
+    process.exit(1);
+}
+