Merge pull request #362 from codeoverflow-org/feat/nodecg-v2-support

Support for NodeCG v2

Author: hlxid

.devcontainer/devcontainer.json

@@ -6,14 +6,24 @@
         "dockerfile": "Dockerfile"
     },
 
-    // Set *default* container specific settings.json values on container create.
-    "settings": {
-        "terminal.integrated.shell.linux": "/bin/zsh"
+    "customizations": {
+        "vscode": {
+            "extensions": ["dbaeumer.vscode-eslint", "Orta.vscode-jest"],
+            "settings": {
+                "terminal.integrated.profiles.linux": {
+                    "bash": {
+                        "path": "bash",
+                        "icon": "terminal-bash"
+                    },
+                    "zsh": {
+                        "path": "zsh"
+                    }
+                },
+                "terminal.integrated.defaultProfile.linux": "zsh"
+            }
+        }
     },
 
-    // Add the IDs of extensions you want installed when the container is created.
-    "extensions": ["dbaeumer.vscode-eslint"],
-
     // Use 'forwardPorts' to make a list of ports inside the container available locally.
     // 9090 is the default nodecg port if you have setup a nodecg install using the install command and want to test it
     "forwardPorts": [9090],

.devcontainer/postCreate.sh

@@ -8,4 +8,4 @@ npm link
 # Get nodecg so you can test the cli using this installation
 [ ! -d "nodecg" ] && git clone https://github.com/nodecg/nodecg.git 
 
-cd nodecg && npm i --omit=dev
+cd nodecg && npm i && npm run build

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/generate/extension.ts

@@ -42,20 +42,20 @@ export async function genExtension(opts: GenerationOptions, install: Installatio
     const writer = new CodeBlockWriter();
 
     // imports
-    genImport(writer, "requireService", opts.corePackage.name, opts.language);
+    genImport(writer, "requireService", opts.corePackage.name, opts.language, false);
 
     if (opts.language === "typescript") {
-        genImport(writer, "NodeCG", `${opts.nodeCGTypingsPackage}/types/server`, opts.language);
+        generateNodeCGImport(writer, opts, install);
+
         // Service import statements
         services.forEach((svc) => {
-            genImport(writer, svc.clientName, svc.packageName, opts.language);
+            genImport(writer, svc.clientName, svc.packageName, opts.language, false);
         });
     }
 
     // global nodecg function
     writer.blankLine();
-    const nodecgVariableType = opts.language === "typescript" ? ": NodeCG" : "";
-    writer.write(`module.exports = function (nodecg${nodecgVariableType}) `).block(() => {
+    writer.write(`module.exports = function (nodecg${getNodeCGType(opts, install)}) `).block(() => {
         genLog(writer, `${opts.bundleName} bundle started.`);
         writer.blankLine();
 
@@ -76,18 +76,68 @@ export async function genExtension(opts: GenerationOptions, install: Installatio
     await writeBundleFile(writer.toString(), opts.bundlePath, "extension", `index.${fileExtension}`);
 }
 
-function genImport(writer: CodeBlockWriter, symbolToImport: string, packageName: string, lang: CodeLanguage) {
+function genImport(
+    writer: CodeBlockWriter,
+    symbolToImport: string,
+    packageName: string,
+    lang: CodeLanguage,
+    isDefaultImport: boolean,
+) {
     if (lang === "typescript") {
-        writer.write(`import { ${symbolToImport} } from `).quote(packageName).write(";");
+        writer.write("import ");
+
+        if (!isDefaultImport) {
+            writer.write("{ ");
+        }
+        writer.write(symbolToImport);
+        if (!isDefaultImport) {
+            writer.write(" }");
+        }
+
+        writer.write(` from `).quote(packageName).write(";");
     } else if (lang === "javascript") {
-        writer.write(`const ${symbolToImport} = require(`).quote(packageName).write(`).${symbolToImport};`);
+        writer.write(`const ${symbolToImport} = require(`).quote(packageName).write(")");
+
+        if (!isDefaultImport) {
+            writer.write(`.${symbolToImport}`);
+        }
+
+        writer.write(";");
     } else {
         throw new Error("unsupported language: " + lang);
     }
 
     writer.write("\n");
 }
 
+export function determineNodeCGImportPath(opts: GenerationOptions, install: Installation): string {
+    if (install.version === "0.1") {
+        // nodecg-io 0.1 is only compatible with the NodeCG typings bundled inside the full nodecg package
+        return "nodecg/types/server";
+    } else if (install.version === "0.2" || opts.nodeCGVersion.major === 1) {
+        // nodecg-io 0.2 is only compatible with nodecg-types.
+        // Newer versions are compatible with both: nodecg-types (NodeCG v1) and @nodecg/types (NodeCG v2)
+        // There we check the current nodecg version to determine which import to use.
+        return "nodecg-types/types/server";
+    } else if (opts.nodeCGVersion.major === 2) {
+        // All versions from 0.3 and upwards support the official @nodecg/types package for NodeCG v2
+        return "@nodecg/types";
+    } else {
+        throw new Error(
+            "unable to determine nodecg typings import for nodecg " +
+                opts.nodeCGVersion +
+                " and nodecg-io " +
+                install.version,
+        );
+    }
+}
+
+function generateNodeCGImport(writer: CodeBlockWriter, opts: GenerationOptions, install: Installation) {
+    const importPath = determineNodeCGImportPath(opts, install);
+    const isDefaultImport = opts.nodeCGVersion.major === 2 && install.version !== "0.1" && install.version !== "0.2";
+    genImport(writer, "NodeCG", importPath, opts.language, isDefaultImport);
+}
+
 function genLog(writer: CodeBlockWriter, logMessage: string) {
     writer.write("nodecg.log.info(").quote(logMessage).write(");");
 }
@@ -121,3 +171,15 @@ function genOnUnavailableCall(writer: CodeBlockWriter, svc: ServiceNames) {
         })
         .write(");");
 }
+
+function getNodeCGType(opts: GenerationOptions, install: Installation): string {
+    if (opts.language !== "typescript") {
+        return "";
+    }
+
+    if (install.version === "0.1" || install.version === "0.2" || opts.nodeCGVersion.major === 1) {
+        return ": NodeCG";
+    } else {
+        return ": NodeCG.ServerAPI";
+    }
+}

src/generate/packageJson.ts

@@ -5,6 +5,7 @@ import { genNodeCGDashboardConfig, genNodeCGGraphicConfig } from "./panel";
 import { SemVer } from "semver";
 import { writeBundleFile } from "./utils";
 import { Installation } from "../utils/installation";
+import { determineNodeCGImportPath } from "./extension";
 
 // Loaction where the development tarballs are hosted.
 export const developmentPublishRootUrl = "https://codeoverflow-org.github.io/nodecg-io-publish/";
@@ -54,7 +55,7 @@ async function genDependencies(opts: GenerationOptions, serviceDeps: Dependency[
 
     if (opts.language === "typescript") {
         // For typescript we need core, all services (for typings) and special packages like ts itself or node typings.
-        const deps = [core, ...serviceDeps, ...(await genTypeScriptDependencies(opts))];
+        const deps = [core, ...serviceDeps, ...(await genTypeScriptDependencies(opts, install))];
         deps.sort();
         return deps;
     } else {
@@ -66,22 +67,30 @@ async function genDependencies(opts: GenerationOptions, serviceDeps: Dependency[
 /**
  * Generates all extra dependencies that are needed when having a bundle in TS. Meaning typescript itself, nodecg for typings
  * and types for node.
- * @param nodecgDir the directory in which nodecg is installed. Used to get nodecg version which will be used by nodecg dependency.
+ * @return the dependencies that are needed for a TS bundle.
  */
-async function genTypeScriptDependencies(opts: GenerationOptions): Promise<Dependency[]> {
-    logger.debug(
-        `Fetching latest ${opts.nodeCGTypingsPackage}, nodecg-io-tsconfig, typescript and @types/node versions...`,
-    );
-    const [nodecgVersion, latestTsConfig, latestTypeScript, latestNodeTypes] = await Promise.all([
-        getLatestPackageVersion(opts.nodeCGTypingsPackage),
+async function genTypeScriptDependencies(opts: GenerationOptions, install: Installation): Promise<Dependency[]> {
+    const nodecgTypingPackage = determineNodeCGImportPath(opts, install).replace("/types/server", "");
+    if (!nodecgTypingPackage) {
+        throw new Error("Could not determine nodecg typing package");
+    }
+
+    let nodecgTypingVersion = opts.nodeCGVersion;
+    if (nodecgTypingPackage === "nodecg-types") {
+        logger.debug(`Fetching latest nodecg-types version...`);
+        nodecgTypingVersion = await getLatestPackageVersion("nodecg-types");
+    }
+
+    logger.debug(`Fetching latest nodecg-io-tsconfig, typescript and @types/node versions...`);
+    const [latestTsConfig, latestTypeScript, latestNodeTypes] = await Promise.all([
         getLatestPackageVersion("nodecg-io-tsconfig"),
         getLatestPackageVersion("typescript"),
         getLatestPackageVersion("@types/node"),
     ]);
 
     return [
         ["@types/node", `^${latestNodeTypes}`],
-        [opts.nodeCGTypingsPackage, `^${nodecgVersion}`],
+        [nodecgTypingPackage, `^${nodecgTypingVersion}`],
         ["nodecg-io-tsconfig", `^${latestTsConfig}`],
         ["typescript", `^${latestTypeScript}`],
     ];

src/generate/prompt.ts

@@ -7,7 +7,7 @@ import { getServicesFromInstall } from "../install/prompt";
 import { yellowInstallCommand } from "./utils";
 import { findNpmPackages, NpmPackage } from "../utils/npm";
 import { corePackage } from "../nodecgIOVersions";
-import { getNodeCGIODirectory } from "../utils/nodecgInstallation";
+import { getNodeCGIODirectory, getNodeCGVersion } from "../utils/nodecgInstallation";
 
 /**
  * Describes all options for bundle generation a user has answered with inside the inquirer prompt
@@ -29,7 +29,7 @@ export interface PromptedGenerationOptions {
 export interface GenerationOptions extends PromptedGenerationOptions {
     servicePackages: NpmPackage[];
     corePackage: NpmPackage;
-    nodeCGTypingsPackage: "nodecg" | "nodecg-types";
+    nodeCGVersion: semver.SemVer;
     bundlePath: string;
 }
 
@@ -106,7 +106,7 @@ export async function promptGenerationOpts(nodecgDir: string, install: Installat
         },
     ]);
 
-    return computeGenOptsFields(opts, install, installedPackages);
+    return await computeGenOptsFields(opts, installedPackages, nodecgDir);
 }
 
 // region prompt validation
@@ -156,11 +156,11 @@ function validateServiceSelection(services: string[]): true | string {
  * @param install the current nodecg-io installation. Used to get installed packages/exact versions.
  * @return opts including computed fields.
  */
-export function computeGenOptsFields(
+export async function computeGenOptsFields(
     opts: PromptedGenerationOptions,
-    install: Installation,
     installedPackages: NpmPackage[],
-): GenerationOptions {
+    nodecgDir: string,
+): Promise<GenerationOptions> {
     const corePkg = installedPackages.find((pkg) => pkg.name === corePackage);
     if (corePkg === undefined) {
         throw new Error("Core package in installation info could not be found.");
@@ -178,6 +178,6 @@ export function computeGenOptsFields(
             return svcPackage;
         }),
         bundlePath: path.join(opts.bundleDir, opts.bundleName),
-        nodeCGTypingsPackage: install.version === "0.1" ? "nodecg" : "nodecg-types",
+        nodeCGVersion: await getNodeCGVersion(nodecgDir),
     };
 }

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.