Merge branch 'master' into feature/9-remove-client-listeners

hlxid · hlxid · commit 872d6fb34a82 · 2021-01-01T13:19:32.000+01:00
diff --git a/nodecg-io-core/dashboard/authentication.ts b/nodecg-io-core/dashboard/authentication.ts
@@ -12,7 +12,7 @@ const spanPasswordNotice = document.getElementById("spanPasswordNotice") as HTML
 
 // Add key listener to password input
 inputPassword?.addEventListener("keyup", function (event) {
-    if (event.keyCode === 13) {
+    if (event.keyCode === 13 || event.key === "Enter") {
         event.preventDefault();
         loadFramework();
     }
diff --git a/nodecg-io-core/dashboard/bundles.ts b/nodecg-io-core/dashboard/bundles.ts
@@ -29,7 +29,7 @@ export function renderBundleDeps(): void {
         return;
     }
 
-    const bundle = selectBundle.options[selectBundle.selectedIndex].value;
+    const bundle = selectBundle.options[selectBundle.selectedIndex]?.value;
     const bundleDependencies = config.data.bundles[bundle];
     if (bundleDependencies === undefined) {
         return;
@@ -49,7 +49,7 @@ export function renderInstanceSelector(): void {
     }
 
     // Rendering options
-    const serviceType = selectBundleDepTypes.options[selectBundleDepTypes.selectedIndex].value;
+    const serviceType = selectBundleDepTypes.options[selectBundleDepTypes.selectedIndex]?.value;
     const instances = ["none"];
 
     for (const instName in config.data.instances) {
@@ -64,7 +64,7 @@ export function renderInstanceSelector(): void {
     updateOptionsArr(selectBundleInstance, instances);
 
     // Selecting option of current set instance
-    const bundle = selectBundle.options[selectBundle.selectedIndex].value;
+    const bundle = selectBundle.options[selectBundle.selectedIndex]?.value;
     const currentInstance = config.data.bundles[bundle]?.find((dep) => dep.serviceType === serviceType)
         ?.serviceInstance;
     let index = 0;
@@ -78,9 +78,9 @@ export function renderInstanceSelector(): void {
 }
 
 export async function setServiceDependency(): Promise<void> {
-    const bundle = selectBundle.options[selectBundle.selectedIndex].value;
-    const instance = selectBundleInstance.options[selectBundleInstance.selectedIndex].value;
-    const type = selectBundleDepTypes.options[selectBundleDepTypes.selectedIndex].value;
+    const bundle = selectBundle.options[selectBundle.selectedIndex]?.value;
+    const instance = selectBundleInstance.options[selectBundleInstance.selectedIndex]?.value;
+    const type = selectBundleDepTypes.options[selectBundleDepTypes.selectedIndex]?.value;
 
     const msg: Partial<SetServiceDependencyMessage> = {
         bundleName: bundle,
diff --git a/nodecg-io-core/dashboard/serviceInstance.ts b/nodecg-io-core/dashboard/serviceInstance.ts
@@ -117,7 +117,7 @@ export async function saveInstanceConfig(): Promise<void> {
     showError(undefined);
 
     try {
-        const instName = selectInstance.options[selectInstance.selectedIndex].value;
+        const instName = selectInstance.options[selectInstance.selectedIndex]?.value;
         const config = JSON.parse(editor.getValue());
         const msg: Partial<UpdateInstanceConfigMessage> = {
             config: config,
@@ -133,7 +133,7 @@ export async function saveInstanceConfig(): Promise<void> {
 // Delete button
 export async function deleteInstance(): Promise<void> {
     const msg: Partial<DeleteServiceInstanceMessage> = {
-        instanceName: selectInstance.options[selectInstance.selectedIndex].value,
+        instanceName: selectInstance.options[selectInstance.selectedIndex]?.value,
     };
 
     const deleted = await sendAuthenticatedMessage("deleteServiceInstance", msg);
@@ -146,15 +146,22 @@ export async function deleteInstance(): Promise<void> {
 
 // Create button
 export async function createInstance(): Promise<void> {
-    const service = selectService.options[selectService.options.selectedIndex].value;
+    showError(undefined);
+    const service = selectService.options[selectService.options.selectedIndex]?.value;
     const name = inputInstanceName.value;
 
     const msg: Partial<CreateServiceInstanceMessage> = {
         serviceType: service,
         instanceName: name,
     };
 
-    await sendAuthenticatedMessage("createServiceInstance", msg);
+    try {
+        await sendAuthenticatedMessage("createServiceInstance", msg);
+    } catch (e) {
+        showError(e);
+        return;
+    }
+
     // Give the browser some time to create the new instance select option and to add them to the DOM
     setTimeout(() => {
         selectServiceInstance(name);
@@ -203,7 +210,7 @@ function renderInstances() {
 function selectServiceInstance(instanceName: string) {
     for (let i = 0; i < selectInstance.options.length; i++) {
         const opt = selectInstance.options[i];
-        if (opt.value === instanceName) {
+        if (opt?.value === instanceName) {
             selectInstance.selectedIndex = i;
             onInstanceSelectChange(instanceName);
             break;
diff --git a/nodecg-io-core/extension/instanceManager.ts b/nodecg-io-core/extension/instanceManager.ts
@@ -48,6 +48,10 @@ export class InstanceManager extends EventEmitter {
      * @return void if everything went fine and a string describing the issue if not
      */
     createServiceInstance(serviceType: string, instanceName: string): Result<void> {
+        if (!instanceName) {
+            return error("Instance name must not be empty.");
+        }
+
         // Check if a instance with the same name already exists.
         if (this.serviceInstances[instanceName] !== undefined) {
             return error("A service instance with the same name already exists.");
diff --git a/nodecg-io-irc/package.json b/nodecg-io-irc/package.json
@@ -30,12 +30,12 @@
     },
     "license": "MIT",
     "devDependencies": {
-        "@types/irc": "^0.3.33",
         "@types/node": "^14.14.13",
         "nodecg": "^1.7.4",
         "typescript": "^4.1.3"
     },
     "dependencies": {
+        "@types/irc": "^0.3.33",
         "irc": "^0.5.2",
         "nodecg-io-core": "^0.1.0"
     }
diff --git a/nodecg-io-serial/package.json b/nodecg-io-serial/package.json
@@ -32,11 +32,11 @@
     "license": "MIT",
     "devDependencies": {
         "@types/node": "^14.14.13",
-        "@types/serialport": "^8.0.1",
         "nodecg": "^1.7.4",
         "typescript": "^4.1.3"
     },
     "dependencies": {
+        "@types/serialport": "^8.0.1",
         "@serialport/parser-readline": "^9.0.1",
         "nodecg-io-core": "^0.1.0",
         "serialport": "^9.0.3"
diff --git a/nodecg-io-telegram/package.json b/nodecg-io-telegram/package.json
@@ -31,12 +31,12 @@
     "license": "MIT",
     "devDependencies": {
         "@types/node": "^14.14.13",
-        "@types/node-telegram-bot-api": "^0.50.4",
         "nodecg": "^1.7.4",
         "typescript": "^4.1.3"
     },
     "dependencies": {
-        "nodecg-io-core": "^0.1.0",
-        "node-telegram-bot-api": "^0.51.0"
+        "@types/node-telegram-bot-api": "^0.50.4",
+        "node-telegram-bot-api": "^0.51.0",
+        "nodecg-io-core": "^0.1.0"
     }
 }
diff --git a/nodecg-io-twitch-chat/extension/index.ts b/nodecg-io-twitch-chat/extension/index.ts
@@ -10,7 +10,7 @@ export interface TwitchServiceConfig {
 export { TwitchServiceClient } from "./twitchClient";
 
 module.exports = (nodecg: NodeCG) => {
-    new TwitchService(nodecg, "twitch", __dirname, "../twitch-schema.json").register();
+    new TwitchService(nodecg, "twitch-chat", __dirname, "../twitch-schema.json").register();
 };
 
 class TwitchService extends ServiceBundle<TwitchServiceConfig, TwitchServiceClient> {
diff --git a/nodecg-io-twitch-chat/extension/twitchClient.ts b/nodecg-io-twitch-chat/extension/twitchClient.ts
diff --git a/nodecg-io-twitch-chat/package.json b/nodecg-io-twitch-chat/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "nodecg-io-twitch",
+    "name": "nodecg-io-twitch-chat",
     "version": "0.1.0",
     "description": "Allows to connect to twitch with your account, send and receive messages and much more. It can be used to create Twitch-Bots.",
     "homepage": "https://nodecg.io/samples/twitch",
diff --git a/nodecg-io-twitch-chat/tsconfig.json b/nodecg-io-twitch-chat/tsconfig.json
diff --git a/nodecg-io-twitch-chat/twitch-schema.json b/nodecg-io-twitch-chat/twitch-schema.json
diff --git a/samples/serial/extension/index.ts b/samples/serial/extension/index.ts
@@ -6,16 +6,23 @@ module.exports = function (nodecg: NodeCG) {
     nodecg.log.info("Sample bundle for serial started");
 
     const service = requireService<SerialServiceClient>(nodecg, "serial");
+    let interval: NodeJS.Timeout | undefined;
+
     service?.onAvailable((client) => {
         nodecg.log.info("Client has been updated.");
         client.onData((data: string) => {
             nodecg.log.info(data);
         });
 
-        setInterval(() => {
+        interval = setInterval(() => {
             client.send("ping\n");
         }, 10000);
     });
 
-    service?.onUnavailable(() => nodecg.log.info("Client has been unset."));
+    service?.onUnavailable(() => {
+        nodecg.log.info("Client has been unset.");
+        if (interval) {
+            clearInterval(interval);
+        }
+    });
 };
diff --git a/samples/spotify-current-song/extension/index.ts b/samples/spotify-current-song/extension/index.ts
@@ -0,0 +1,19 @@
+import { NodeCG } from "nodecg/types/server";
+import { requireService } from "nodecg-io-core/extension/serviceClientWrapper";
+import { SpotifyServiceClient } from "nodecg-io-spotify";
+
+module.exports = function (nodecg: NodeCG) {
+    nodecg.log.info("Sample bundle for spotify started");
+
+    const service = requireService<SpotifyServiceClient>(nodecg, "spotify");
+    service?.onAvailable(async (client) => {
+        nodecg.log.info("Client has been updated.");
+
+        const track = await client.getNativeClient().getMyCurrentPlayingTrack();
+        const name = track.body.item?.name;
+        const artists = track.body.item?.artists.map((a) => a.name);
+        nodecg.log.info(`Currently playing "${name}" by "${artists}".`);
+    });
+
+    service?.onUnavailable(() => nodecg.log.info("Client has been unset."));
+};
diff --git a/samples/spotify-current-song/package.json b/samples/spotify-current-song/package.json
@@ -0,0 +1,24 @@
+{
+    "name": "spotify-current-song",
+    "private": true,
+    "version": "0.1.0",
+    "nodecg": {
+        "compatibleRange": "^1.1.1",
+        "bundleDependencies": {
+            "nodecg-io-spotify": "^0.1.0"
+        }
+    },
+    "scripts": {
+        "build": "tsc -b",
+        "watch": "tsc -b -w",
+        "clean": "tsc -b --clean"
+    },
+    "license": "MIT",
+    "dependencies": {
+        "nodecg-io-spotify": "^0.1.0",
+        "nodecg-io-core": "^0.1.0",
+        "@types/node": "^14.14.13",
+        "nodecg": "^1.7.4",
+        "typescript": "^4.1.3"
+    }
+}
diff --git a/samples/spotify-current-song/tsconfig.json b/samples/spotify-current-song/tsconfig.json
@@ -0,0 +1,3 @@
+{
+    "extends": "../../tsconfig.common.json"
+}
diff --git a/samples/streamdeck-rainbow/extension/index.ts b/samples/streamdeck-rainbow/extension/index.ts
@@ -6,6 +6,7 @@ module.exports = function (nodecg: NodeCG) {
     nodecg.log.info("Sample bundle for streamdeck started");
 
     const streamdeck = requireService<StreamdeckServiceClient>(nodecg, "streamdeck");
+    let timeout: NodeJS.Timeout | undefined;
 
     streamdeck?.onAvailable((client) => {
         nodecg.log.info("Streamdeck client has been updated, painting the streamdeck.");
@@ -30,7 +31,7 @@ module.exports = function (nodecg: NodeCG) {
             ];
             let i = 0;
 
-            setInterval(() => {
+            timeout = setInterval(() => {
                 try {
                     deck.fillColor(
                         i % deck.NUM_KEYS,
@@ -48,5 +49,10 @@ module.exports = function (nodecg: NodeCG) {
         }
     });
 
-    streamdeck?.onUnavailable(() => nodecg.log.info("Streamdeck client has been unset."));
+    streamdeck?.onUnavailable(() => {
+        nodecg.log.info("Streamdeck client has been unset.");
+        if (timeout) {
+            clearTimeout(timeout);
+        }
+    });
 };
diff --git a/samples/twitch-chat/extension/index.ts b/samples/twitch-chat/extension/index.ts
@@ -1,12 +1,12 @@
 import { NodeCG } from "nodecg/types/server";
-import { TwitchServiceClient } from "nodecg-io-twitch";
+import { TwitchServiceClient } from "nodecg-io-twitch-chat";
 import { requireService } from "nodecg-io-core/extension/serviceClientWrapper";
 
 module.exports = function (nodecg: NodeCG) {
     nodecg.log.info("Sample bundle for twitch started");
 
     // Require the twitch service.
-    const twitch = requireService<TwitchServiceClient>(nodecg, "twitch");
+    const twitch = requireService<TwitchServiceClient>(nodecg, "twitch-chat");
 
     // Hardcoded channels for testing purposes.
     // Note that this does need a # before the channel name and is case-insensitive.
diff --git a/samples/twitch-chat/package.json b/samples/twitch-chat/package.json
@@ -5,7 +5,7 @@
     "nodecg": {
         "compatibleRange": "^1.1.1",
         "bundleDependencies": {
-            "nodecg-io-twitch": "^0.1.0"
+            "nodecg-io-twitch-chat": "^0.1.0"
         }
     },
     "scripts": {
@@ -18,7 +18,7 @@
         "@types/node": "^14.14.13",
         "nodecg": "^1.7.4",
         "nodecg-io-core": "^0.1.0",
-        "nodecg-io-twitch": "^0.1.0",
+        "nodecg-io-twitch-chat": "^0.1.0",
         "typescript": "^4.1.3"
     }
 }
diff --git a/samples/websocket-client/extension/index.ts b/samples/websocket-client/extension/index.ts
@@ -6,17 +6,24 @@ module.exports = function (nodecg: NodeCG) {
     nodecg.log.info("Sample bundle for websocket-client started");
 
     const service = requireService<WSClientServiceClient>(nodecg, "websocket-client");
+    let interval: NodeJS.Timeout | undefined;
+
     service?.onAvailable((client) => {
         nodecg.log.info("Client has been updated.");
 
         client.onMessage((message) => {
             nodecg.log.info(`recieved message "${message}"`);
         });
-        setInterval(() => {
+        interval = setInterval(() => {
             nodecg.log.info("Sending ping ...");
             client.send("ping");
         }, 10000);
     });
 
-    service?.onUnavailable(() => nodecg.log.info("Client has been unset."));
+    service?.onUnavailable(() => {
+        nodecg.log.info("Client has been unset.");
+        if (interval) {
+            clearInterval(interval);
+        }
+    });
 };

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ const spanPasswordNotice = document.getElementById("spanPasswordNotice") as HTML`
`12`	`12`
`13`	`13`	`// Add key listener to password input`
`14`	`14`	`inputPassword?.addEventListener("keyup", function (event) {`
`15`		`- if (event.keyCode === 13) {`
	`15`	`+ if (event.keyCode === 13 \|\| event.key === "Enter") {`
`16`	`16`	`event.preventDefault();`
`17`	`17`	`loadFramework();`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "nodecg-io-twitch",`
	`2`	`+ "name": "nodecg-io-twitch-chat",`
`3`	`3`	`"version": "0.1.0",`
`4`	`4`	`"description": "Allows to connect to twitch with your account, send and receive messages and much more. It can be used to create Twitch-Bots.",`
`5`	`5`	`"homepage": "https://nodecg.io/samples/twitch",`