refactor: Implement abortable source polling

Use abort-controller-x with signals to interrupt polling process

#483

Author: FoxxMD

package-lock.json

@@ -78,6 +78,7 @@
     "@tailwindcss/vite": "^4.1.16",
     "@types/express-serve-static-core": "^4.19.6",
     "@xhayper/discord-rpc": "^1.3.0",
+    "abort-controller-x": "^0.5.0",
     "address": "^1.2.2",
     "ajv": "^8.18.0",
     "ajv-formats": "^3.0.1",
@@ -193,7 +194,7 @@
     "@types/xml2js": "^0.4.11",
     "@vitejs/plugin-react": "^4.2.1",
     "chai": "^4.3.6",
-    "chai-as-promised": "^7.1.1",
+    "chai-as-promised": "^8.0.2",
     "eslint": "^8.56.0",
     "eslint-plugin-prefer-arrow-functions": "^3.2.4",
     "eslint-plugin-storybook": "10.1.11",

package.json

@@ -1,7 +1,8 @@
 import { parseRegexSingle } from "@foxxmd/regex-buddy-core";
 import mergeErrorCause from 'merge-error-cause';
-import { findCauseByFunc, findCauseByReference } from "../../utils/ErrorUtils.js";
+import { findCauseByFunc, findCauseByReference, isAbortReasonErrorLike } from "../../utils/ErrorUtils.js";
 import { UpstreamError, UpstreamErrorOptions } from "./UpstreamError.js";
+import { isAbortError } from "abort-controller-x";
 
 export abstract class NamedError extends Error {
     public abstract name: string;
@@ -39,21 +40,29 @@ export class SimpleError extends Error implements HasSimpleError {
     simple: boolean;
     name = 'Error';
 
+    stackShortened: boolean = false;
+
+    shortenStack() {
+        const atIndex = parseRegexSingle(STACK_AT_REGEX,this.stack);
+        if(atIndex !== undefined) {
+            const firstn = this.stack.indexOf('\n', atIndex.index + atIndex.match.length);
+            if(firstn !== -1) {
+                this.stack = this.stack.slice(0, firstn);
+                this.stackShortened = true;
+            }
+        }
+    }
+
     public constructor(msg: string, options?: ErrorOptions & { simple?: boolean, shortStack?: boolean }) {
         super(msg, options);
         const {
             simple = true,
             shortStack = false
         } = options || {};
         this.simple = simple;
+        Error.captureStackTrace(this, this.constructor);
         if(shortStack) {
-            const atIndex = parseRegexSingle(STACK_AT_REGEX,this.stack);
-            if(atIndex !== undefined) {
-                const firstn = this.stack.indexOf('\n', atIndex.index + atIndex.match.length);
-                if(firstn !== -1) {
-                    this.stack = this.stack.slice(0, firstn);
-                }
-            }
+            this.shortenStack();
         }
     }
 }
@@ -104,4 +113,19 @@ export class ScrobbleSubmitError<T extends (object | string) = object> extends U
         super(message, options);
         this.payload = options?.payload;
     }
+}
+
+export class AbortedError extends SimpleError {
+    name = 'Aborted Operation';
+}
+export const generateLoggableAbortReason = (msg: string, signal: AbortSignal): AbortedError => {
+    const reason = signal.reason;
+    let err: AbortedError;
+    if(isAbortReasonErrorLike(signal)) {
+        err = new AbortedError(msg, {cause: reason});
+    } else {
+        err = new AbortedError(`${msg} => ${reason ?? 'No Reason Given'}`, {simple: true, shortStack: true});
+    }
+    Error.captureStackTrace(err, generateLoggableAbortReason);
+    return err;
 }

src/backend/common/errors/MSErrors.ts

@@ -33,6 +33,7 @@ import { setupWebscrobblerRoutes } from "./webscrobblerRoutes.js";
 import ScrobbleSources from "../sources/ScrobbleSources.js";
 import ScrobbleClients from "../scrobblers/ScrobbleClients.js";
 import prom from 'prom-client';
+import { SimpleError } from "../common/errors/MSErrors.js";
 
 const maxBufferSize = 300;
 const output: Record<number, FixedSizeList<LogDataPretty>> =  {};
@@ -435,7 +436,7 @@ export const setupApi = (app: ExpressWithAsync, logger: Logger, appLoggerStream:
 
         if(source.polling) {
             source.logger.info('Source is already polling! Restarting polling...');
-            const stopRes = await source.tryStopPolling();
+            const stopRes = await source.tryStopPolling(new SimpleError('user initiated', {simple: true, shortStack: true}));
             if(stopRes === true) {
                 source.poll({force, notify: false}).catch(e => source.logger.error(e));
             }