feat(bridge/nodejs): release process

.github/workflows/pre-release-nodejs-bridge.yml

@@ -0,0 +1,76 @@
+name: Pre-release Node.js bridge
+
+on: workflow_dispatch
+
+jobs:
+  build:
+    name: Build
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-20.04]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v3
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+
+      - name: Set Node.js bridge version
+        working-directory: bridges/nodejs/src
+        run: |
+          echo "NODEJS_BRIDGE_VERSION=$(node --require fs --eval "const fs = require('node:fs'); const [, VERSION] = fs.readFileSync('version.ts', 'utf8').split(\"'\"); console.log(VERSION)")" >> $GITHUB_ENV
+
+      - name: Display Node.js bridge version
+        run: |
+          echo "Node.js bridge version: ${{ env.NODEJS_BRIDGE_VERSION }}"
+
+      - name: Install core
+        run: npm install
+
+      - name: Build Node.js bridge
+        run: npm run build:nodejs-bridge
+
+      - name: Upload Node.js bridge
+        uses: actions/upload-artifact@v3
+        with:
+          path: bridges/nodejs/dist/*.zip
+
+  draft-release:
+    name: Draft-release
+    needs: [build]
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v3
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+
+      - name: Set Node.js bridge version
+        working-directory: bridges/nodejs/src
+        run: |
+          echo "NODEJS_BRIDGE_VERSION=$(node --require fs --eval "const fs = require('node:fs'); const [, VERSION] = fs.readFileSync('version.ts', 'utf8').split(\"'\"); console.log(VERSION)")" >> $GITHUB_ENV
+
+      - name: Download Node.js bridge
+        uses: actions/download-artifact@v3
+        with:
+          path: bridges/nodejs/dist
+
+      - uses: marvinpinto/action-automatic-releases@latest
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          automatic_release_tag: nodejs-bridge_v${{ env.NODEJS_BRIDGE_VERSION }}
+          draft: true
+          prerelease: false
+          title: Node.js Bridge ${{ env.NODEJS_BRIDGE_VERSION }}
+          files: bridges/nodejs/dist/artifact/*.zip

.gitignore

@@ -26,7 +26,7 @@ bridges/python/src/Pipfile.lock
 tcp_server/src/Pipfile.lock
 !tcp_server/**/.gitkeep
 !bridges/python/**/.gitkeep
-!bridges/nodejs/dist/*
+!bridges/nodejs/**/.gitkeep
 !**/*.sample*
 packages/**/config/config.json
 skills/**/src/config.json

bridges/nodejs/dist/leon-nodejs-bridge.js

@@ -1,5 +0,0 @@
-'use strict'
-Object.defineProperty(exports, '__esModule', { value: true })
-const version_1 = require('./version')
-console.log('[WIP] Node.js bridge', version_1.VERSION)
-// TODO

bridges/nodejs/dist/version.js

@@ -1,4 +0,0 @@
-'use strict'
-Object.defineProperty(exports, '__esModule', { value: true })
-exports.VERSION = void 0
-exports.VERSION = '0.0.0'

package.json

@@ -59,6 +59,7 @@
     "python-bridge": "cross-env PIPENV_PIPFILE=bridges/python/src/Pipfile pipenv run python bridges/python/src/main.py server/src/intent-object.sample.json",
     "train": "ts-node scripts/train/run-train.js",
     "prepare-release": "ts-node scripts/release/prepare-release.js",
+    "pre-release:nodejs-bridge": "ts-node scripts/release/pre-release-binaries.js nodejs-bridge",
     "pre-release:python-bridge": "ts-node scripts/release/pre-release-binaries.js python-bridge",
     "pre-release:tcp-server": "ts-node scripts/release/pre-release-binaries.js tcp-server",
     "check": "ts-node scripts/check.js",

scripts/release/pre-release-binaries.js

@@ -3,7 +3,11 @@ import path from 'node:path'
 import { prompt } from 'inquirer'
 import { command } from 'execa'
 
-import { PYTHON_BRIDGE_SRC_PATH, TCP_SERVER_SRC_PATH } from '@/constants'
+import {
+  NODEJS_BRIDGE_SRC_PATH,
+  PYTHON_BRIDGE_SRC_PATH,
+  TCP_SERVER_SRC_PATH
+} from '@/constants'
 import { LogHelper } from '@/helpers/log-helper'
 import { LoaderHelper } from '@/helpers/loader-helper'
 
@@ -15,6 +19,10 @@ import { LoaderHelper } from '@/helpers/loader-helper'
 
 const BUILD_TARGETS = new Map()
 
+BUILD_TARGETS.set('nodejs-bridge', {
+  workflowFileName: 'pre-release-nodejs-bridge.yml',
+  versionFilePath: path.join(NODEJS_BRIDGE_SRC_PATH, 'version.ts')
+})
 BUILD_TARGETS.set('python-bridge', {
   workflowFileName: 'pre-release-python-bridge.yml',
   versionFilePath: path.join(PYTHON_BRIDGE_SRC_PATH, 'version.py')

scripts/setup/setup-binaries.js

@@ -11,52 +11,71 @@ import extractZip from 'extract-zip'
 import {
   BINARIES_FOLDER_NAME,
   GITHUB_URL,
+  NODEJS_BRIDGE_DIST_PATH,
   PYTHON_BRIDGE_DIST_PATH,
   TCP_SERVER_DIST_PATH,
+  NODEJS_BRIDGE_BIN_NAME,
   PYTHON_BRIDGE_BIN_NAME,
   TCP_SERVER_BIN_NAME,
+  NODEJS_BRIDGE_VERSION,
   PYTHON_BRIDGE_VERSION,
   TCP_SERVER_VERSION
 } from '@/constants'
 import { LogHelper } from '@/helpers/log-helper'
 
 /**
- * Set up Python binaries according to the given setup target
+ * Set up binaries according to the given setup target
  * 1. Delete the existing dist binaries if already exist
- * 2. Download the latest Python binaries from GitHub releases
+ * 2. Download the latest binaries from GitHub releases
  * 3. Extract the downloaded ZIP file to the dist folder
  */
 
-const PYTHON_TARGETS = new Map()
+const TARGETS = new Map()
 
-PYTHON_TARGETS.set('python-bridge', {
+TARGETS.set('nodejs-bridge', {
+  name: 'Node.js bridge',
+  distPath: NODEJS_BRIDGE_DIST_PATH,
+  manifestPath: path.join(NODEJS_BRIDGE_DIST_PATH, 'manifest.json'),
+  archiveName: `${NODEJS_BRIDGE_BIN_NAME}.zip`,
+  version: NODEJS_BRIDGE_VERSION,
+  isPlatformDependent: false // Need to be built for the target platform or not
+})
+TARGETS.set('python-bridge', {
   name: 'Python bridge',
   distPath: PYTHON_BRIDGE_DIST_PATH,
   manifestPath: path.join(PYTHON_BRIDGE_DIST_PATH, 'manifest.json'),
   archiveName: `${PYTHON_BRIDGE_BIN_NAME}-${BINARIES_FOLDER_NAME}.zip`,
-  version: PYTHON_BRIDGE_VERSION
+  version: PYTHON_BRIDGE_VERSION,
+  isPlatformDependent: true
 })
-PYTHON_TARGETS.set('tcp-server', {
+TARGETS.set('tcp-server', {
   name: 'TCP server',
   distPath: TCP_SERVER_DIST_PATH,
   manifestPath: path.join(TCP_SERVER_DIST_PATH, 'manifest.json'),
   archiveName: `${TCP_SERVER_BIN_NAME}-${BINARIES_FOLDER_NAME}.zip`,
-  version: TCP_SERVER_VERSION
+  version: TCP_SERVER_VERSION,
+  isPlatformDependent: true
 })
 
 async function createManifestFile(manifestPath, name, version) {
   const manifest = {
     name,
     version,
-    buildDate: Date.now()
+    setupDate: Date.now()
   }
 
   await fs.promises.writeFile(manifestPath, JSON.stringify(manifest, null, 2))
 }
 
-const setupPythonBinaries = async (key) => {
-  const { name, distPath, archiveName, version, manifestPath } =
-    PYTHON_TARGETS.get(key)
+const setupBinaries = async (key) => {
+  const {
+    name,
+    distPath,
+    archiveName,
+    version,
+    manifestPath,
+    isPlatformDependent
+  } = TARGETS.get(key)
   let manifest = null
 
   if (fs.existsSync(manifestPath)) {
@@ -67,7 +86,9 @@ const setupPythonBinaries = async (key) => {
   }
 
   if (!manifest || manifest.version !== version) {
-    const buildPath = path.join(distPath, BINARIES_FOLDER_NAME)
+    const buildPath = isPlatformDependent
+      ? path.join(distPath, BINARIES_FOLDER_NAME)
+      : distPath
     const archivePath = path.join(distPath, archiveName)
 
     await Promise.all([
@@ -114,7 +135,7 @@ const setupPythonBinaries = async (key) => {
 
       LogHelper.success(`${name} extracted`)
 
-      Promise.all([
+      await Promise.all([
         fs.promises.rm(archivePath, { recursive: true, force: true }),
         createManifestFile(manifestPath, name, version)
       ])
@@ -130,6 +151,7 @@ const setupPythonBinaries = async (key) => {
 }
 
 export default async () => {
-  await setupPythonBinaries('python-bridge')
-  await setupPythonBinaries('tcp-server')
+  await setupBinaries('nodejs-bridge')
+  await setupBinaries('python-bridge')
+  await setupBinaries('tcp-server')
 }

scripts/setup/setup.js

@@ -8,7 +8,7 @@ import generateJSONSchemas from '../generate/generate-json-schemas'
 import setupDotenv from './setup-dotenv'
 import setupCore from './setup-core'
 import setupSkillsConfig from './setup-skills-config'
-import setupPythonBinaries from './setup-python-binaries'
+import setupBinaries from './setup-binaries'
 import createInstanceID from './create-instance-id'
 
 // Do not load ".env" file because it is not created yet
@@ -22,7 +22,7 @@ import createInstanceID from './create-instance-id'
     LoaderHelper.start()
     await Promise.all([setupCore(), setupSkillsConfig()])
     LoaderHelper.stop()
-    await setupPythonBinaries()
+    await setupBinaries()
     await generateHTTPAPIKey()
     await generateJSONSchemas()
     LoaderHelper.start()

server/src/constants.ts

@@ -18,14 +18,18 @@ export const GITHUB_URL = 'https://github.com/leon-ai/leon'
  * Binaries / distribution
  */
 export const BINARIES_FOLDER_NAME = SystemHelper.getBinariesFolderName()
-export const PYTHON_BRIDGE_DIST_PATH = path.join('bridges', 'python', 'dist')
 export const NODEJS_BRIDGE_DIST_PATH = path.join('bridges', 'nodejs', 'dist')
+export const PYTHON_BRIDGE_DIST_PATH = path.join('bridges', 'python', 'dist')
 export const TCP_SERVER_DIST_PATH = path.join('tcp_server', 'dist')
 
-export const PYTHON_BRIDGE_SRC_PATH = path.join('bridges', 'python', 'src')
 export const NODEJS_BRIDGE_SRC_PATH = path.join('bridges', 'nodejs', 'src')
+export const PYTHON_BRIDGE_SRC_PATH = path.join('bridges', 'python', 'src')
 export const TCP_SERVER_SRC_PATH = path.join('tcp_server', 'src')
 
+const NODEJS_BRIDGE_VERSION_FILE_PATH = path.join(
+  NODEJS_BRIDGE_SRC_PATH,
+  'version.ts'
+)
 const PYTHON_BRIDGE_VERSION_FILE_PATH = path.join(
   PYTHON_BRIDGE_SRC_PATH,
   'version.py'
@@ -34,6 +38,9 @@ const TCP_SERVER_VERSION_FILE_PATH = path.join(
   TCP_SERVER_SRC_PATH,
   'version.py'
 )
+export const [, NODEJS_BRIDGE_VERSION] = fs
+  .readFileSync(NODEJS_BRIDGE_VERSION_FILE_PATH, 'utf8')
+  .split("'")
 export const [, PYTHON_BRIDGE_VERSION] = fs
   .readFileSync(PYTHON_BRIDGE_VERSION_FILE_PATH, 'utf8')
   .split("'")