Merge branch 'main' into feat/encrypt-using-password-hash

Author: hlxid

.devcontainer/Dockerfile

@@ -0,0 +1,15 @@
+# Base devcontainer for node.js development
+FROM mcr.microsoft.com/vscode/devcontainers/typescript-node:1-20-bullseye
+USER node
+
+# Install required system dependencies
+RUN sudo apt update && sudo apt-get -y install libusb-1.0-0-dev libasound2-dev libudev-dev libc-bin
+
+# Create a NodeCG installation
+WORKDIR /workspaces
+RUN git clone https://github.com/nodecg/nodecg.git
+
+# Install dependencies and add configuration that includes the nodecg-io install
+RUN cd nodecg && npm install --prod && mkdir cfg
+COPY ./nodecg.json /workspaces/nodecg/cfg/nodecg.json
+

.devcontainer/devcontainer.json

@@ -0,0 +1,30 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/typescript-node
+{
+    "name": "nodecg-io inside a NodeCG installation",
+    "build": {
+        "dockerfile": "Dockerfile"
+    },
+
+    // Configure tool-specific properties.
+    "customizations": {
+        // Configure properties specific to VS Code.
+        "vscode": {
+            // Add the IDs of extensions you want installed when the container is created.
+            "extensions": ["dbaeumer.vscode-eslint", "streetsidesoftware.code-spell-checker", "esbenp.prettier-vscode"]
+        }
+    },
+
+    "forwardPorts": [
+        9090 // NodeCG dashboard port
+    ],
+
+    // Install node.js dependencies and build project after the container has been created.
+    "postCreateCommand": "npm install && npm run build",
+
+    // Change directory from /workspaces/nodecg-io to /workspaces/nodecg/nodecg-io inside the NodeCG installation
+    "workspaceFolder": "/workspaces/nodecg/nodecg-io",
+    "workspaceMount": "source=${localWorkspaceFolder},target=/workspaces/nodecg/nodecg-io,type=bind",
+
+    "remoteUser": "node"
+}

.devcontainer/nodecg.json

@@ -0,0 +1,9 @@
+{
+    "bundles": {
+        "paths": [
+            "/workspaces/nodecg/nodecg-io",
+            "/workspaces/nodecg/nodecg-io/services",
+            "/workspaces/nodecg/nodecg-io/samples"
+        ]
+    }
+}

.github/dependabot.yml

@@ -6,5 +6,10 @@ updates:
       interval: "monthly"
   - package-ecosystem: "npm"
     directory: "/"
+    open-pull-requests-limit: 15
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: "docker"
+    directory: ".devcontainer"
     schedule:
       interval: "monthly"

.github/workflows/ci.yml

@@ -12,9 +12,9 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3.5.0
+            - uses: actions/setup-node@v3.6.0
               with:
-                  node-version: "16"
+                  node-version: "18"
 
             - name: Install system dependencies
               run: sudo apt update && sudo apt-get -y install libusb-1.0-0-dev libasound2-dev libudev-dev
@@ -40,9 +40,9 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3.5.0
+            - uses: actions/setup-node@v3.6.0
               with:
-                  node-version: "16"
+                  node-version: "18"
 
             - name: Install system dependencies
               run: sudo apt update && sudo apt-get -y install libusb-1.0-0-dev libasound2-dev libudev-dev
@@ -64,9 +64,9 @@ jobs:
             os: [ubuntu-latest, windows-2019]
         runs-on: ${{ matrix.os }}
         steps:
-            - uses: actions/setup-node@v3.5.0
+            - uses: actions/setup-node@v3.6.0
               with:
-                  node-version: "16"
+                  node-version: "18"
 
             - name: Download NodeCG
               uses: actions/checkout@v3
@@ -76,19 +76,31 @@ jobs:
             - name: Get NodeCG commit hash
               id: nodecgHash
               shell: bash
-              run: echo "::set-output name=nodecgHash::$(git rev-parse HEAD)"
+              run: echo "NODECG_HASH=$(git rev-parse HEAD)" >> $GITHUB_ENV
 
             - name: Cache NodeCG dependencies
-              id: cache-nodecg
+              id: cache-nodecg-deps
               uses: actions/cache@v3
               with:
                 path: 'node_modules'
-                key: ${{ runner.os }}-${{ steps.nodecgHash.outputs.nodecgHash }}-nodecg
+                key: ${{ runner.os }}-${{ env.NODECG_HASH }}-nodecg-deps
+
+            - name: Cache NodeCG compilation outputs
+              id: cache-nodecg-build
+              uses: actions/cache@v3
+              with:
+                path: 'build'
+                key: ${{ runner.os }}-${{ env.NODECG_HASH }}-nodecg-build
 
             - name: Install NodeCG dependencies
               # Only get dependencies if we didn't get them from the cache
-              if: steps.cache-nodecg.outputs.cache-hit != 'true'
-              run: npm install --prod
+              if: steps.cache-nodecg-deps.outputs.cache-hit != 'true'
+              run: npm install
+
+            - name: Build NodeCG
+              # Only build NodeCG if we didn't have cached compilation results
+              if: steps.cache-nodecg-build.outputs.cache-hit != 'true'
+              run: npm run build
 
             - name: Setup NodeCG config linux
               if: matrix.os == 'ubuntu-latest'
@@ -124,7 +136,19 @@ jobs:
               run: npm run build
               working-directory: ./nodecg-io
 
-            - name: Run test
+              # Under linux we need to run the test as the root user because
+              # the midi service requires access to audio devices.
+              # By default the GitHub Actions user is not in the `audio` group and therefore
+              # has no access. Either we need to run as root to get access or need to add the user
+              # to the `audio` group which doesn't work for us, as it would only take affect on next login,
+              # but we cannot logout and login in CI.
+            - name: Run test (ubuntu)
+              if: matrix.os == 'ubuntu-latest'
+              run: sudo node .scripts/ci-nodecg-integration.mjs
+              working-directory: ./nodecg-io
+
+            - name: Run test (windows)
+              if: matrix.os == 'windows-2019'
               shell: bash
               run: node .scripts/ci-nodecg-integration.mjs
               working-directory: ./nodecg-io
@@ -142,9 +166,9 @@ jobs:
         - nodecg
         steps:
             - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3.5.0
+            - uses: actions/setup-node@v3.6.0
               with:
-                node-version: "16"
+                node-version: "18"
 
             - name: Download compilation results # From the build step
               uses: actions/download-artifact@v3
@@ -154,6 +178,22 @@ jobs:
             - name: Extract compilation results
               run: tar xvf compilation-results.tar.gz
 
+              # All twitch services depend on the utility package `nodecg-io-twitch-auth`.
+              # In the repository the services depend on the latest development version which is not yet published.
+              # If someone installs the service using the published tarball npm would try to get the
+              # unpublished version of twitch-auth from the npm registry which is not possible.
+              # To fix this we update the version of the twitch-auth package in all usages
+              # to also reference the published tarball.
+            - name: Patch twitch-auth dependency to use published current tarball
+              run: |
+                # Get current version as it is needed for the tarball file name
+                TWITCH_AUTH_VERSION=$(cat utils/nodecg-io-twitch-auth/package.json | jq .version -r)
+
+                # Find usages in all package.json files and replace with the corresponding tarball url
+                find . -name 'package.json' -exec grep -q -E '"nodecg-io-twitch-auth": ".+"' {} \; -print # Print found files for debug purposes
+                find . -name 'package.json' -exec grep -q -E '"nodecg-io-twitch-auth": ".+"' {} \; -print0 | \
+                    xargs -0 sed -i "s/\"nodecg-io-twitch-auth\": \".*\"/\"nodecg-io-twitch-auth\": \"https:\/\/codeoverflow-org.github.io\/nodecg-io-publish\/nodecg-io-twitch-auth-${TWITCH_AUTH_VERSION}.tgz\"/g"
+
             - name: Create npm tarballs
               run: npm pack --workspaces
 

.github/workflows/docs.yml

@@ -19,7 +19,7 @@ jobs:
             - name: Setup Python
               uses: actions/setup-python@v4
               with:
-                  python-version: 3.8.3
+                  python-version: 3.10.8
 
             - uses: actions/checkout@v3
 

.github/workflows/lint.yaml

@@ -7,9 +7,9 @@ jobs:
         steps:
             - uses: actions/checkout@v3
 
-            - uses: actions/setup-node@v3.5.0
+            - uses: actions/setup-node@v3.6.0
               with:
-                  node-version: "16"
+                  node-version: "18"
 
             - name: Install system dependencies
               run: sudo apt update && sudo apt-get -y install libusb-1.0-0-dev libasound2-dev libudev-dev

.scripts/ci-nodecg-integration.mjs

@@ -26,7 +26,7 @@ console.log("\nStarted NodeCG");
 console.log("--------------------------------------------------------------------------------");
 
 // Spawn a process that runs NodeCG and let it run for 15 seconds to load all bundles
-const child = child_process.spawn("node", ["index.js"], { cwd: cwd.dir, timeout: 15000 });
+const child = child_process.spawn("node", ["index.js"], { cwd: cwd.dir, timeout: 20000 });
 
 // Store stdout and pipe the output of the child process to the output of this process
 const buffer = [];
@@ -39,15 +39,16 @@ child.once("exit", (exitCode, signal) => {
     console.log("Stopped NodeCG\n");
 
     // Check exit code for failure
-    if (exitCode !== null && exitCode !== 0) {
+    // 143 is the exit code when the process is killed by the timeout (SIGTERM)
+    if (exitCode !== null && exitCode !== 143) {
         throw new Error(`NodeCG exited with code ${exitCode} ${signal}`);
     }
 
     const log = Buffer.concat(buffer).toString();
 
     // Try to find each bundle in the logs.
     const missing = bundles.filter(
-        (i) => !log.includes(`[nodecg/lib/server/extensions] Mounted ${i.packageJson.name} extension`),
+        (bundle) => !log.includes(` [extensions] Mounted ${bundle.packageJson.name} extension`),
     );
 
     // Fail the run if there are missing bundles.

.scripts/create-service.py

@@ -47,7 +47,7 @@
     os.mkdir(f'services/nodecg-io-{service_name}/extension')
     with open(f'services/nodecg-io-{service_name}/extension/index.ts', mode='w') as file:
         file.writelines([
-            'import { NodeCG } from "nodecg-types/types/server";\n',
+            'import NodeCG from "@nodecg/types";\n',
             'import { Result, emptySuccess, success, ServiceBundle } from "nodecg-io-core";\n',
             f'import {{ {service_name_c}Client }} from "./{service_name_cc}Client";\n',
             '\n',
@@ -57,7 +57,7 @@
             '\n',
             f'export {{ {service_name_c}Client }} from "./{service_name_cc}Client";\n',
             '\n',
-            'module.exports = (nodecg: NodeCG) => {\n',
+            'module.exports = (nodecg: NodeCG.ServerAPI) => {\n',
             f'    new {service_name_c}Service(nodecg, "{service_name}", __dirname, "../schema.json").register();\n',
             '};\n',
             '\n',
@@ -135,11 +135,11 @@
     os.mkdir(f'samples/{sample_name}/extension')
     with open(f'samples/{sample_name}/extension/index.ts', mode='w') as file:
         file.writelines([
-            'import { NodeCG } from "nodecg-types/types/server";\n',
+            'import NodeCG from "@nodecg/types";\n',
             f'import {{ {service_name_c}Client }} from "nodecg-io-{service_name}";\n',
             'import { requireService } from "nodecg-io-core";\n',
             '\n',
-            'module.exports = function (nodecg: NodeCG) {\n',
+            'module.exports = function (nodecg: NodeCG.ServerAPI) {\n',
             f'    nodecg.log.info("Sample bundle for {service_name_c} started.");\n',
             '\n',
             f'    const {service_name_cc} = requireService<{service_name_c}Client>(nodecg, "{service_name}");\n',

.scripts/exec.mjs

@@ -1,4 +1,4 @@
-import { root, packages } from "./update-paths.mjs";
+import { rootDir, packages, rootPackage } from "./update-paths.mjs";
 import concurrently from "concurrently";
 
 const COMMAND = process.argv[2];
@@ -12,12 +12,12 @@ const commands = packages
         cwd: v.dir,
     }));
 
-const scripts = root.packageJson["scripts"];
+const scripts = rootPackage?.packageJson["scripts"];
 if (scripts && scripts[COMMAND + ":root"]) {
     commands.unshift({
-        name: root.packageJson.name,
+        name: rootPackage?.packageJson.name,
         command: "npm:" + COMMAND + ":root",
-        cwd: root.dir,
+        cwd: rootDir,
     });
 }
 

.scripts/update-paths.mjs

@@ -3,14 +3,14 @@ import path from "path";
 
 import { getPackages } from "@manypkg/get-packages";
 
-export const { root, packages } = await getPackages(process.cwd());
+export const { rootDir, packages, rootPackage } = await getPackages(process.cwd());
 
-const rootTSconfig = path.join(root.dir, "tsconfig.json");
+const rootTSconfig = path.join(rootDir, "tsconfig.json");
 const tsconfig = {
     files: [],
     references: packages
         .filter((pkg) => fs.readdirSync(pkg.dir).includes("tsconfig.json"))
-        .map((v) => ({ path: path.relative(root.dir, v.dir) })),
+        .map((v) => ({ path: path.relative(rootDir, v.dir) })),
 };
 
 let content = "// This file will be overwritten automatically! Do not store options here.\n" + JSON.stringify(tsconfig);

jest.config.mjs

@@ -5,7 +5,7 @@ import { getPackages } from "@manypkg/get-packages";
 
 let projects = [];
 // @ts-ignore
-const { root, packages } = await getPackages(cwd());
+const { packages } = await getPackages(cwd());
 
 /** @param pkg {import("@manypkg/get-packages").Package} */
 function hasJestConfig(pkg) {
@@ -21,7 +21,7 @@ function hasJestConfig(pkg) {
     );
 }
 
-projects = packages.filter((pkg) => hasJestConfig(pkg)).map((v) => `<rootDir>/${path.relative(root.dir, v.dir)}`);
+projects = packages.filter((pkg) => hasJestConfig(pkg)).map((v) => `<rootDir>/${path.relative(cwd(), v.dir)}`);
 
 console.log(projects);
 

nodecg-io-core/dashboard/authentication.ts

@@ -1,5 +1,3 @@
-/// <reference types="nodecg-types/types/browser" />
-
 import { updateMonacoLayout } from "./serviceInstance";
 import { setPassword, isPasswordSet } from "./crypto";
 
@@ -41,7 +39,7 @@ document.addEventListener("DOMContentLoaded", () => {
 
 export async function isLoaded(): Promise<boolean> {
     return new Promise((resolve, _reject) => {
-        nodecg.sendMessage("isLoaded", (_err, res) => resolve(res));
+        nodecg.sendMessage("isLoaded", (_err, res: boolean) => resolve(res));
         setTimeout(() => resolve(false), 5000); // Fallback in case connection gets lost.
     });
 }

nodecg-io-core/dashboard/main.ts

@@ -1,3 +1,11 @@
+// Define NodeCG instance on global scope
+import type { NodeCGAPIClient } from "@nodecg/types/client/api/api.client";
+
+declare global {
+    const NodeCG: typeof NodeCGAPIClient;
+    const nodecg: NodeCGAPIClient;
+}
+
 // Re-export functions that are used in panel.html to the global scope
 import { loadFramework } from "./authentication";
 import {

nodecg-io-core/dashboard/package.json

@@ -19,10 +19,10 @@
         "watch": "node esbuild.config.js --watch"
     },
     "devDependencies": {
-        "esbuild": "^0.15.8",
-        "monaco-editor": "^0.34.0",
-        "nodecg-types": "^1.9.0",
-        "typescript": "^4.8.4"
+        "esbuild": "^0.16.12",
+        "monaco-editor": "^0.38.0",
+        "@nodecg/types": "^2.1.11",
+        "typescript": "^5.1.6"
     },
     "dependencies": {
         "crypto-js": "^4.1.1",