feat(install): check whether the nodecg-io version is compatible with the used NodeCG version

Author: hlxid

integration_test.sh

@@ -22,7 +22,14 @@ function clean_test_directory {
 trap clean_test_directory EXIT
 
 cd $dir
-git clone https://github.com/nodecg/nodecg.git --depth 1 .
+
+# Download NodeCG
+if [ "$version" == "0.1" ] || [ "$version" == "0.2" ]; then
+    # if version is 0.1 or 0.2 then switch back to NodeCG v1
+    git clone https://github.com/nodecg/nodecg.git --depth 1 --branch legacy-1.x .
+else
+    git clone https://github.com/nodecg/nodecg.git --depth 1 .
+fi
 
 if [ "$version" == "development" ]; then
     nodecg-io install --nodecg-io-version $version --docs

src/install/index.ts

@@ -91,6 +91,7 @@ async function install(opts: InstallCommandOptions): Promise<void> {
             requestedInstall,
             currentInstall && !currentInstall.dev ? currentInstall : undefined,
             nodecgIODir,
+            nodecgDir,
         );
     }
 

src/install/production.ts

@@ -14,12 +14,17 @@ import { logger } from "../utils/log";
 import { promises as fs } from "fs";
 import path = require("path");
 import chalk = require("chalk");
+import { SemVer } from "semver";
+import { getNodeCGVersion } from "../utils/nodecgInstallation";
 
 export async function createProductionInstall(
     requested: ProductionInstallation,
     current: ProductionInstallation | undefined,
     nodecgIODir: string,
+    nodecgDir: string,
 ): Promise<void> {
+    const nodecgVersion = await getNodeCGVersion(nodecgDir);
+    await checkNodeCGCompatibility(requested, nodecgVersion);
     await ensureDirectory(nodecgIODir);
 
     if (current) {
@@ -41,6 +46,27 @@ export async function createProductionInstall(
     }
 }
 
+/**
+ * Checks whether the nodecg-io version that should be installed is compatible with the used NodeCG version-
+ * @param requestedInstall the target nodecg-io install
+ * @param nodecgDir the directory in which NodeCG is installed, used to get the NodeCG version
+ */
+export async function checkNodeCGCompatibility(requestedInstall: ProductionInstallation, nodecgVersion: SemVer) {
+    const supportedNodeCGVersions = [1];
+    if (requestedInstall.version !== "0.1" && requestedInstall.version !== "0.2") {
+        // All versions above 0.2 support NodeCG v2 as well
+        supportedNodeCGVersions.push(2);
+    }
+
+    const nodeCGMajorVersion = nodecgVersion.major;
+    if (!supportedNodeCGVersions.includes(nodeCGMajorVersion)) {
+        throw new Error(
+            `Your currently used NodeCG v${nodeCGMajorVersion} is not supported by nodecg-io ${requestedInstall.version}. ` +
+                `Supported NodeCG major versions for this nodecg-io version are: ${supportedNodeCGVersions.join(", ")}`,
+        );
+    }
+}
+
 /**
  * Finds the removed or added packages between two array of packages (current and requested install).
  * That way we only need to remove what is no longer requested and install what was not already present.

test/install/production.ts

@@ -2,10 +2,17 @@ import { vol } from "memfs";
 import * as path from "path";
 import * as fs from "fs";
 import { corePkg, dashboardPkg, nodecgIODir, twitchChatPkg, validProdInstall } from "../test.util";
-import { diffPackages, installPackages, removePackages, validateInstall } from "../../src/install/production";
+import {
+    checkNodeCGCompatibility,
+    diffPackages,
+    installPackages,
+    removePackages,
+    validateInstall,
+} from "../../src/install/production";
 import * as installation from "../../src/utils/installation";
 import * as fsUtils from "../../src/utils/fs";
 import * as npm from "../../src/utils/npm";
+import { SemVer } from "semver";
 
 jest.mock("fs", () => vol);
 beforeEach(() => vol.promises.mkdir(nodecgIODir));
@@ -20,6 +27,35 @@ const corePkg2 = {
 };
 const packages = [corePkg, twitchChatPkg];
 
+describe("checkNodeCGCompatibility", () => {
+    const testCases: [string, number, boolean][] = [
+        ["0.1", 0, false],
+        ["0.1", 1, true],
+        ["0.1", 2, false],
+        ["0.2", 1, true],
+        ["0.2", 2, false],
+        ["0.3", 1, true],
+        ["0.3", 2, true],
+        ["development", 1, true],
+        ["development", 2, true],
+        ["development", 3, false],
+    ];
+
+    testCases.forEach(([version, nodecgVersion, shouldWork]) => {
+        test(`should ${shouldWork ? "allow" : "not allow"} installing ${version} with NodeCG v${nodecgVersion}`, () => {
+            const promise = checkNodeCGCompatibility(
+                { ...validProdInstall, version },
+                new SemVer(`v${nodecgVersion}.0.0`),
+            );
+            if (shouldWork) {
+                return expect(promise).resolves.toBeUndefined();
+            } else {
+                return expect(promise).rejects.toThrowError();
+            }
+        });
+    });
+});
+
 describe("diffPackages", () => {
     test("should return not already installed package in pkgInstall", () => {
         const { pkgInstall, pkgRemove } = diffPackages([twitchChatPkg, corePkg], [twitchChatPkg]);