Rename GitHub Workflows (#3176)

* Rename GitHub Workflows
* Renamed package.json name
* Remove name from CI Build
* Remove name from names
* Update Build and Package Scripts
* Improve install and start errors and workflow
* Update apps/zui/package.json

.github/actions/build-zui/action.yml → .github/actions/build-app/action.yml

@@ -1,5 +1,5 @@
-name: Build Zui
-description: Build Zui for the current platform
+name: Build App
+description: Build app for the current platform
 inputs:
   cmd:
     required: false

.github/actions/setup-zui/action.yml → .github/actions/setup-app/action.yml

@@ -1,5 +1,5 @@
-name: Setup Zui
-description: Shared steps for setting up Zui in workflows
+name: Setup App
+description: Shared steps for setting up the app in workflows
 runs:
   using: 'composite'
   steps:

.github/workflows/advance-zed.yml

@@ -35,7 +35,7 @@ jobs:
           ref: ${{ github.ref }}
           # We need a token with permission to push.
           token: ${{ secrets.ZQ_UPDATE_PAT }}
-      - uses: ./.github/actions/setup-zui
+      - uses: ./.github/actions/setup-app
       - run: sudo apt-get -y install whois
       - run: yarn workspace zui add zed@brimdata/zed#${{ env.zed_ref }}
       - run: yarn lint

.github/workflows/build-insiders.yml

@@ -40,7 +40,7 @@ jobs:
           ref: ${{ github.event.inputs.zui-branch }}
 
       - name: Setup Zui
-        uses: ./.github/actions/setup-zui
+        uses: ./.github/actions/setup-app
 
       - name: Inject package.json
         run: yarn nx inject insiders ${{ needs.check_latest.outputs.version }}

.github/workflows/build.yml

@@ -18,12 +18,12 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Zui
-        uses: ./.github/actions/setup-zui
+        uses: ./.github/actions/setup-app
 
       - name: Build Zui
         uses: ./.github/actions/build-zui
         with:
-          cmd: yarn nx package-zui zui
+          cmd: yarn nx package-app zui
           gh_token: ${{ secrets.GITHUB_TOKEN }}
           # Windows
           ssl_com_username: ${{ secrets.WINDOWS_SIGNING_SSL_COM_USERNAME }}

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Zui CI
+name: CI
 
 on:
   pull_request:
@@ -17,7 +17,7 @@ jobs:
     steps:
       - run: git config --global core.autocrlf false
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-zui
+      - uses: ./.github/actions/setup-app
       - run: yarn lint
       - run: yarn test
       - name: Build and install package
@@ -28,7 +28,7 @@ jobs:
           set -x
           case ${{ runner.os }} in
             Linux )
-              yarn nx package-zui zui --linux=deb --publish never
+              yarn nx package-app superdb-desktop --linux=deb --publish never
               sudo apt install -y --no-install-recommends ./dist/apps/zui/*.deb
               ;;
           esac

.github/workflows/e2e.yml

@@ -16,15 +16,15 @@ on:
         type: choice
         default: 'true'
         options:
-        - 'true'
-        - 'false'
+          - 'true'
+          - 'false'
         required: true
       debug:
         description: Playwright debug logging
         type: choice
         options:
-        - 'pw:api'
-        - ''
+          - 'pw:api'
+          - ''
       always-upload:
         description: Always upload artifacts even if tests don't fail?
         type: boolean
@@ -42,7 +42,7 @@ jobs:
         run: echo "${{ toJSON(inputs) }}"
         shell: sh
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-zui
+      - uses: ./.github/actions/setup-app
       - name: Install dependencies (Linux)
         if: startsWith(matrix.os, 'ubuntu-')
         run: sudo apt-get -y install whois

.github/workflows/release-insiders.yml

@@ -40,7 +40,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Zui
-        uses: ./.github/actions/setup-zui
+        uses: ./.github/actions/setup-app
 
       - name: Inject package.json
         run: yarn nx inject insiders ${{ needs.check_latest.outputs.version }}

.github/workflows/release.yml

@@ -18,12 +18,12 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Zui
-        uses: ./.github/actions/setup-zui
+        uses: ./.github/actions/setup-app
 
       - name: Build Zui
         uses: ./.github/actions/build-zui
         with:
-          cmd: yarn nx release-zui zui
+          cmd: yarn nx release-app zui
           gh_token: ${{ secrets.GITHUB_TOKEN }}
           # Windows
           ssl_com_username: ${{ secrets.WINDOWS_SIGNING_SSL_COM_USERNAME }}

apps/zui/package.json

@@ -1,8 +1,8 @@
 {
-  "name": "zui",
-  "productName": "Zui",
+  "name": "superdb-desktop",
+  "productName": "SuperDB",
   "private": true,
-  "description": "Zed User Interface",
+  "description": "SuperDB Desktop",
   "repository": "https://github.com/brimdata/zui",
   "license": "BSD-3-Clause",
   "version": "1.18.0",
@@ -29,8 +29,8 @@
     "tsc": "",
     "postinstall": "node scripts/post-install.cjs",
     "prepare": "husky install",
-    "package-zui": "electron-builder --publish never",
-    "release-zui": "electron-builder",
+    "package-app": "electron-builder --publish never",
+    "release-app": "electron-builder",
     "package-insiders": "electron-builder --config electron-builder-insiders.json --publish never",
     "release-insiders": "electron-builder --config electron-builder-insiders.json --publish always"
   },

apps/zui/scripts/clean.js

@@ -1,5 +1,5 @@
-const fs = require("fs-extra")
-const glob = require("glob")
+import fs from "fs-extra"
+import glob from "glob"
 
 fs.removeSync("out")
 fs.removeSync(".next")

apps/zui/scripts/start.js

@@ -20,5 +20,9 @@ async function start() {
 }
 
 process.on("SIGINT", () => process.exit(0))
-
-start()
+try {
+  await start()
+} catch (e) {
+  console.error(e)
+  process.exit(1)
+}

apps/zui/scripts/util/sub.js

@@ -2,6 +2,8 @@ import {spawn} from "child_process"
 
 class Sub {
   constructor(bin, args) {
+    this.bin = bin
+    this.args = args
     this.p = spawn(bin, [args], {
       shell: true,
     })
@@ -32,8 +34,11 @@ class Sub {
         if (debug) console.log(d.toString())
         if (pattern.test(d.toString())) res()
       })
+      this.p.stderr.on("data", (buffer) => {
+        console.log(buffer.toString())
+      })
       this.p.on("close", () => {
-        rej("Process closed before receiving expected output: " + pattern)
+        rej("The process \"" + this.bin + " " + this.args + "\" closed before receiving expected output: " + pattern)
       })
     }).finally(() => {
       this.waiting = false

package.json

@@ -9,13 +9,16 @@
   },
   "scripts": {
     "build-affected": "nx affected --target=build",
+    "build-deps": "nx run-many -t build -p @brimdata/zed-js @brimdata/zed-node",
     "build": "nx run-many -t build --all",
     "lint": "nx run-many -t lint --all",
     "test": "nx run-many -t test --all --exclude zui-player --skip-nx-cache",
-    "start": "nx start zui",
+    "start": "nx start superdb-desktop",
+    "clean": "nx run-many -t clean --all",
     "e2e": "NODE_ENV=production nx test zui-player",
     "e2e:ci": "NODE_ENV=production nx ci zui-player",
-    "artifact-path": "node tools/scripts/artifact-path.js"
+    "artifact-path": "node tools/scripts/artifact-path.js",
+    "postinstall": "yarn build-deps"
   },
   "devDependencies": {
     "@swc/core": "^1.10.18",

packages/zed-js/package.json

@@ -6,7 +6,8 @@
   "exports": "./dist/index.js",
   "scripts": {
     "test": "jest",
-    "build": "tsc"
+    "build": "tsc",
+    "clean": "rimraf dist"
   },
   "dependencies": {
     "date-fns": "^3.6.0",
@@ -19,6 +20,7 @@
     "@types/event-source-polyfill": "^1.0.1",
     "@types/strftime": "^0.9.8",
     "jest": "^29.7.0",
+    "rimraf": "^6.0.1",
     "typescript": "5.1.5"
   }
 }

packages/zed-node/package.json

@@ -6,7 +6,8 @@
   "exports": "./dist/index.js",
   "scripts": {
     "test": "jest",
-    "build": "tsc"
+    "build": "tsc",
+    "clean": "rimraf dist"
   },
   "dependencies": {
     "@brimdata/zed-js": "workspace:*",
@@ -15,6 +16,7 @@
   "devDependencies": {
     "jest": "^29.7.0",
     "node-fetch": "^2.6.1",
+    "rimraf": "^6.0.1",
     "super": "github:brimdata/super#main",
     "typescript": "5.1.5"
   },

packages/zui-player/package.json

@@ -6,13 +6,15 @@
   "scripts": {
     "lint": "tsc",
     "test": "playwright test -c playwright.config.js",
-    "ci": "playwright test -c ci.config.js"
+    "ci": "playwright test -c ci.config.js",
+    "clean": "rimraf run"
   },
   "dependencies": {
     "@playwright/test": "1.44.0",
     "fs-extra": "^11.3.0",
     "playwright": "1.44.0",
     "playwright-chromium": "1.44.0",
+    "rimraf": "^6.0.1",
     "typescript": "5.1.5"
   }
 }