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

Author: hlxid

.eslintrc.js

@@ -1,21 +1,19 @@
+/** @type {import("eslint").ESLint.Options} */
 module.exports = {
     parser: "@typescript-eslint/parser",
     parserOptions: {
         ecmaVersion: 2017,
         sourceType: "module",
     },
-    extends: [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended",
-    ],
+    extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
     // Don't traverse fs up to root.
     // This caused problems when nodecg-io was cloned into a NodeCG installation as it then
     // tried to lint nodecg-io with that config.
     root: true,
     rules: {
         // Allow for unused function arguments when they are prefixed with an underscore.
         // This is the TypeScript convention to mark unused arguments.
-        "@typescript-eslint/no-unused-vars": ["warn", {argsIgnorePattern: "^_"}],
+        "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
 
         // We simply have empty functions at some places, so we ignore this rule.
         "@typescript-eslint/no-empty-function": ["warn", { allow: ["arrowFunctions"] }],
@@ -24,6 +22,6 @@ module.exports = {
         "no-console": ["warn"],
 
         // Enforce triple equals for comparisons
-        "eqeqeq": ["warn"]
+        "eqeqeq": ["warn"],
     },
 };

.github/workflows/ci.yml

@@ -11,8 +11,8 @@ jobs:
     build:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v2
-            - uses: actions/setup-node@v2
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3.4.1
               with:
                   node-version: "16"
 
@@ -31,16 +31,16 @@ jobs:
                   tar cvzf compilation-results.tar.gz --exclude "node_modules" **/*.js **/*.js.map **/*.d.ts **/*.d.ts.map **/*.tsbuildinfo **/*.ttf
 
             - name: Upload compilation results
-              uses: actions/upload-artifact@v2
+              uses: actions/upload-artifact@v3
               with:
                 name: compilation-results
                 path: compilation-results.tar.gz
 
     tests:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v2
-            - uses: actions/setup-node@v2
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3.4.1
               with:
                   node-version: "16"
 
@@ -59,31 +59,63 @@ jobs:
         # are mounted by NodeCG. It will fail if one of them is not mounted.
         # You may check for other NodeCG runtime errors in the output (these
         # may not fail the run).
-        runs-on: ubuntu-latest
+        strategy:
+          matrix:
+            os: [ubuntu-latest, windows-2019]
+        runs-on: ${{ matrix.os }}
         steps:
-            - uses: actions/setup-node@v2
+            - uses: actions/setup-node@v3.4.1
               with:
                   node-version: "16"
 
-            - name: Install nodecg-cli
-              run: npm install --global nodecg-cli
+            - name: Download NodeCG
+              uses: actions/checkout@v3
+              with:
+                repository: nodecg/nodecg
+
+            - name: Get NodeCG commit hash
+              id: nodecgHash
+              shell: bash
+              run: echo "::set-output name=nodecgHash::$(git rev-parse HEAD)"
+
+            - name: Cache NodeCG dependencies
+              id: cache-nodecg
+              uses: actions/cache@v3
+              with:
+                path: 'node_modules'
+                key: ${{ runner.os }}-${{ steps.nodecgHash.outputs.nodecgHash }}-nodecg
 
-            - name: Setup NodeCG
-              run: nodecg setup
+            - 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
 
-            - name: Setup NodeCG config
+            - name: Setup NodeCG config linux
+              if: matrix.os == 'ubuntu-latest'
               run: |
                   mkdir cfg
                   echo '{"bundles": {"paths": ["'${GITHUB_WORKSPACE}'/nodecg-io","'${GITHUB_WORKSPACE}'/nodecg-io/services","'${GITHUB_WORKSPACE}'/nodecg-io/samples"]}}' > ./cfg/nodecg.json
 
-            # nodecg-io needs to be cloned after NodeCG setup because the nodecg-cli requires an empty directory.
-            - uses: actions/checkout@v2
+            - name: Setup NodeCG config windows
+              if: matrix.os == 'windows-2019'
+              shell: bash
+              run: |
+                  mkdir cfg
+                  # We need to escape backslashes to get valid json. Replaces each "\" with "\\"
+                  echo '{"bundles": {"paths": ["'${GITHUB_WORKSPACE//\\/\\\\}'\\nodecg-io","'${GITHUB_WORKSPACE//\\/\\\\}'\\nodecg-io\\services","'${GITHUB_WORKSPACE//\\/\\\\}'\\nodecg-io\\samples"]}}' > ./cfg/nodecg.json
+
+            - uses: actions/checkout@v3
               with:
                   path: "nodecg-io"
 
             - name: Install system dependencies
+              if: matrix.os == 'ubuntu-latest'
               run: sudo apt update && sudo apt-get -y install libusb-1.0-0-dev libasound2-dev libudev-dev
 
+            - name: Install node native development files
+              shell: bash
+              run: npx node-gyp install
+
             - name: Install nodejs dependencies
               run: npm ci
               working-directory: ./nodecg-io
@@ -93,6 +125,7 @@ jobs:
               working-directory: ./nodecg-io
 
             - name: Run test
+              shell: bash
               run: node .scripts/ci-nodecg-integration.mjs
               working-directory: ./nodecg-io
 
@@ -108,13 +141,13 @@ jobs:
         - tests
         - nodecg
         steps:
-            - uses: actions/checkout@v2
-            - uses: actions/setup-node@v2
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3.4.1
               with:
                 node-version: "16"
 
             - name: Download compilation results # From the build step
-              uses: actions/download-artifact@v2
+              uses: actions/download-artifact@v3
               with:
                 name: compilation-results
 
@@ -125,7 +158,7 @@ jobs:
               run: npm pack --workspaces
 
             - name: Clone publish repository
-              uses: actions/checkout@v2
+              uses: actions/checkout@v3
               with:
                   repository: codeoverflow-org/nodecg-io-publish
                   ssh-key: ${{ secrets.PUBLISH_SSH_KEY }}

.github/workflows/docs.yml

@@ -17,14 +17,14 @@ jobs:
         if: startsWith(github.repository, 'codeoverflow-org') && github.actor != 'dependabot[bot]'
         steps:
             - name: Setup Python
-              uses: actions/setup-python@v2
+              uses: actions/setup-python@v4
               with:
                   python-version: 3.8.3
 
-            - uses: actions/checkout@v2
+            - uses: actions/checkout@v3
 
             - name: Checkout docs
-              uses: actions/checkout@v2
+              uses: actions/checkout@v3
               with:
                   repository: codeoverflow-org/nodecg-io-docs
                   path: docs

.github/workflows/lint.yaml

@@ -5,9 +5,9 @@ jobs:
     build:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v2
+            - uses: actions/checkout@v3
 
-            - uses: actions/setup-node@v2
+            - uses: actions/setup-node@v3.4.1
               with:
                   node-version: "16"
 

.gitignore

@@ -33,6 +33,7 @@ services/nodecg-io-debug/dashboard/dist
 
 # Launch configurations and settings
 !/.vscode/launch.json
+!/.vscode/tasks.json
 !/.vscode/settings.json
 
 # Lerna temporary files
@@ -55,7 +56,7 @@ lerna-debug.log
 install.json
 
 # Autogenerated tsconfig.json files
-tsconfig.json
-samples/tsconfig.json
-services/tsconfig.json
-utils/tsconfig.json
+/tsconfig.json
+/samples/tsconfig.json
+/services/tsconfig.json
+/utils/tsconfig.json

.prettierignore

@@ -3,7 +3,7 @@ docs/build
 coverage
 
 # Autogenerated tsconfig.json files
-tsconfig.json
-samples/tsconfig.json
-services/tsconfig.json
-utils/tsconfig.json
+/tsconfig.json
+/samples/tsconfig.json
+/services/tsconfig.json
+/utils/tsconfig.json

.prettierrc.js

@@ -1,9 +1,16 @@
+/** @type {import("prettier").RequiredOptions} */
 module.exports = {
-    semi: true,
-    trailingComma: "all",
-    singleQuote: false,
     printWidth: 120,
     tabWidth: 4,
     useTabs: false,
-    endOfLine: "auto"
+    semi: true,
+    singleQuote: false,
+    quoteProps: "consistent",
+    jsxSingleQuote: false,
+    trailingComma: "all",
+    bracketSpacing: true,
+    arrowParens: "always",
+    proseWrap: "preserve",
+    vueIndentScriptAndStyle: false,
+    endOfLine: "lf",
 };

.scripts/ci-nodecg-integration.mjs

@@ -1,6 +1,7 @@
 import * as fs from "fs";
 import * as path from "path";
 import * as child_process from "child_process";
+import { getPackages } from "@manypkg/get-packages";
 
 const cwd = path.parse(process.cwd());
 const nodecgiodir = fs.readdirSync(process.cwd()).some((v) => v === "nodecg-io-core");
@@ -9,66 +10,53 @@ const nodecgiodir = fs.readdirSync(process.cwd()).some((v) => v === "nodecg-io-c
 if (!nodecgiodir) {
     throw new Error("You will have to run this script from inside the nodecg-io folder!");
 }
-/**
- * expected data:
- *
- * ~~~json
- * {
- *   name: 'nodecg-io',
- *   dependencies: {
- *     'name': {
- *       version: 'version',
- *       resolved: 'optional'
- *     },
- *   }
- * }
- * ~~~
- */
-const npm = JSON.parse(child_process.execSync("npm ls --json"));
 
-// Filter out any dependencies which are not resolved locally in samples or services because the other npm packages will not be loaded by NodeCG
-let bundles = Object.entries(npm.dependencies)
-    .filter((i) =>
-        Object.entries(i[1]).some(
-            (j) =>
-                j[0] === "resolved" &&
-                (`${j[1]}`.startsWith("file:../samples/") ||
-                    `${j[1]}`.startsWith("file:../services/" || `${j[1]}` === "file:../nodecg-io-core")),
-        ),
-    )
-    .map((v) => v[0]);
+const { packages } = await getPackages(process.cwd());
 
-console.log(`Found ${bundles.length} bundles in this install.`);
+// Filter out packages other than core, samples and services, because they should not be NodeCG-bundles (dashboard, utils)
+const bundles = packages.filter(
+    (v) =>
+        v.packageJson.name === "nodecg-io-core" ||
+        path.parse(v.dir).dir.endsWith("samples") ||
+        path.parse(v.dir).dir.endsWith("services"),
+);
 
-console.log("");
-console.log("NodeCG sterr");
+console.log(`Found ${bundles.length} bundles in this install.`);
+console.log("\nStarted NodeCG");
 console.log("--------------------------------------------------------------------------------");
 
-// expects a NodeCG folder be the parent of the cwd needs timeout
-const log = child_process
-    .execSync("timeout --preserve-status 15s node " + cwd.dir + path.sep + "index.js", { cwd: cwd.dir })
-    .toString("utf8");
+// 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 lines = log.split("\n");
+// Store stdout and pipe the output of the child process to the output of this process
+const buffer = [];
+child.stdout.on("data", (data) => buffer.push(data));
+child.stdout.pipe(process.stdout);
+child.stderr.pipe(process.stderr);
 
-// Try to find each bundle in the logs.
-const missing = bundles.filter(
-    /*Using endsWith here to remove possible ansi styling of "[info]" caused by ModeCG's logger when run locally*/
-    (i) => !lines.some((j) => j.endsWith("[nodecg/lib/server/extensions] Mounted " + i + " extension")),
-);
-
-// Fail the run if there are missing bundles.
-if (missing.length > 0) {
-    // Only log stout if the run has failed because otherwise its unimportant and everything important should be in stderr
-    console.log("");
-    console.log("NodeCG stout");
+child.once("exit", (exitCode, signal) => {
     console.log("--------------------------------------------------------------------------------");
-    console.log(log);
+    console.log("Stopped NodeCG\n");
 
-    console.log("");
-    console.log("Missing Bundles");
-    console.log("--------------------------------------------------------------------------------");
-    console.log(missing);
+    // Check exit code for failure
+    if (exitCode !== null && exitCode !== 0) {
+        throw new Error(`NodeCG exited with code ${exitCode} ${signal}`);
+    }
 
-    throw new Error(`NodeCG did not mount ${missing.length} bundle(s).`);
-}
+    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`),
+    );
+
+    // Fail the run if there are missing bundles.
+    if (missing.length > 0) {
+        console.log("Missing Bundles:");
+        console.log(missing.map((v) => v.packageJson.name));
+
+        throw new Error(`NodeCG did not mount ${missing.length} bundle(s).`);
+    }
+
+    console.log("No Errors!");
+});

.scripts/exec.mjs

@@ -3,7 +3,7 @@ import concurrently from "concurrently";
 
 const COMMAND = process.argv[2];
 
-/**@type {import('concurrently').CommandObj[]}*/
+/**@type {import('concurrently').ConcurrentlyCommandInput[]}*/
 const commands = packages
     .filter((v) => v.packageJson["scripts"] && v.packageJson["scripts"][COMMAND])
     .map((v) => ({
@@ -43,8 +43,8 @@ const colors = [
 if (commands.length > 0) {
     concurrently(commands, {
         prefixColors: colors,
-    }).catch(() => {
-        console.log("At least one build task has failed")
+    }).result.catch(() => {
+        console.log("At least one build task has failed");
         process.exit(1);
     });
 }

.scripts/update-paths.mjs

@@ -14,4 +14,5 @@ const tsconfig = {
 };
 
 let content = "// This file will be overwritten automatically! Do not store options here.\n" + JSON.stringify(tsconfig);
+console.log("Update root tsconfig.json…");
 fs.writeFileSync(rootTSconfig, content, { encoding: "utf8" });