magmastream 2.10.6-alpha.4 → 2.10.6-alpha.6

package/dist/structures/Manager.d.ts

@@ -38,6 +38,11 @@ export declare class Manager extends EventEmitter {
      */
     constructor(options: StandaloneManagerOptions);
     constructor(options: ManagerOptions, isWrapper: true);
+    /**
+     * Waits until the Redis client is connected, at most `timeoutMs`. Never throws: when Redis is not
+     * ready in time, init continues and commands fail later with Redis's own error.
+     */
+    private waitForRedis;
     /**
      * Initiates the Manager.
      * @param clientId - The Discord client ID (only required when not using any of the magmastream wrappers).

package/dist/structures/Manager.js

@@ -179,6 +179,30 @@ class Manager extends events_1.EventEmitter {
             });
         }
     }
+    /**
+     * Waits until the Redis client is connected, at most `timeoutMs`. Never throws: when Redis is not
+     * ready in time, init continues and commands fail later with Redis's own error.
+     */
+    async waitForRedis(timeoutMs = 10_000) {
+        const redis = this.redis;
+        if (!redis || redis.status === "ready")
+            return;
+        await new Promise((resolve) => {
+            const done = (message) => {
+                clearTimeout(timer);
+                redis.off("ready", onReady);
+                redis.off("end", onEnd);
+                if (message)
+                    this.emit(Enums_1.ManagerEventTypes.Debug, `[MANAGER] ${message}`);
+                resolve();
+            };
+            const onReady = () => done();
+            const onEnd = () => done("Redis connection ended before it was ready.");
+            const timer = setTimeout(() => done(`Redis was not ready after ${timeoutMs}ms, continuing without waiting.`), timeoutMs);
+            redis.once("ready", onReady);
+            redis.once("end", onEnd);
+        });
+    }
     /**
      * Initiates the Manager.
      * @param clientId - The Discord client ID (only required when not using any of the magmastream wrappers).
@@ -209,6 +233,9 @@ class Manager extends events_1.EventEmitter {
         }
         if (this.options.stateStorage.type === Enums_1.StateStorageType.Redis) {
             this.redis = new ioredis_1.default(lodash_1.default.omit(this.options.stateStorage.redisConfig, "prefix"));
+            // Nodes read and write their session ids as soon as they connect. With enableOfflineQueue: false,
+            // any command sent before Redis is ready fails, so wait for the connection first.
+            await this.waitForRedis();
         }
         const results = await Promise.allSettled([...this.nodes.values()].map(async (node) => {
             await node.connect();

package/dist/structures/Node.d.ts

@@ -242,8 +242,8 @@ export declare class Node {
      *
      * If the node is a NodeLink, it will use the `NodeLinkGetLyrics` method to fetch the lyrics.
      *
-     * Requires the `lavalyrics-plugin` to be present in the Lavalink node.
-     * Requires the `lavasrc-plugin` or `java-lyrics-plugin` to be present in the Lavalink node.
+     * Requires the `lavalyrics-plugin` to be present in the Lavalink node. The lyrics sources come from
+     * whichever plugins register them with LavaLyrics (LavaSrc, PulseLink, java-lyrics, ...).
      *
      * @param {Track} track - The track to fetch the lyrics for.
      * @param {boolean} [skipTrackSource=false] - Whether to skip using the track's source URL.
@@ -283,14 +283,14 @@ export declare class Node {
      * @param {string} guildId - The ID of the guild to subscribe to lyrics for.
      * @param {boolean} [skipTrackSource=false] - Whether to skip using the track's source URL.
      * @returns {Promise<unknown>} A promise that resolves when the subscription is complete.
-     * @throws {RangeError} If the node is not connected to the lavalink server or if the java-lyrics-plugin is not available.
+     * @throws {MagmaStreamError} If the node is not connected to the lavalink server or if the lavalyrics-plugin is not available.
      */
     lyricsSubscribe(guildId: string, skipTrackSource?: boolean): Promise<unknown>;
     /**
      * Unsubscribes from lyrics for a player.
      * @param {string} guildId - The ID of the guild to unsubscribe from lyrics for.
      * @returns {Promise<unknown>} A promise that resolves when the unsubscription is complete.
-     * @throws {RangeError} If the node is not connected to the lavalink server or if the java-lyrics-plugin is not available.
+     * @throws {MagmaStreamError} If the node is not connected to the lavalink server, or if neither the lavalyrics-plugin nor the java-lyrics-plugin is available.
      */
     lyricsUnsubscribe(guildId: string): Promise<unknown>;
     /**
@@ -454,6 +454,8 @@ export declare class Node {
      * @returns {Promise<void>}
      */
     removeNodeLinkMix(player: Player, mixId: string): Promise<void>;
+    /** Throws NODE_PLUGIN_ERROR unless the node reports at least one of the given plugins. */
+    private requireAnyPlugin;
     private assertNodeLinkFeature;
     private assertMixVolume;
     private assertNodeLinkSponsorBlockUpdate;

package/dist/structures/Node.js

@@ -496,7 +496,14 @@ class Node {
                 const hadPreviousSession = this.pendingResumeSessionId && this.pendingResumeSessionId !== payload.sessionId;
                 this.pendingResumeSessionId = null;
                 this.sessionId = payload.sessionId;
-                await this.updateSessionId();
+                // Storing the session id only matters for resuming after a restart. A storage failure must not stop
+                // the node from loading its info and player states.
+                try {
+                    await this.updateSessionId();
+                }
+                catch (err) {
+                    this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[NODE] Could not store sessionId for node ${this.options.identifier}, session resume may not work after a restart: ${err instanceof Error ? (err.cause instanceof Error ? err.cause.message : err.message) : String(err)}`);
+                }
                 this.info = await this.fetchInfo();
                 this.isNodeLink = this.isNodeLink || Boolean(this.info.isNodelink);
                 this.rest.isNodeLink = this.isNodeLink;
@@ -1034,8 +1041,8 @@ class Node {
      *
      * If the node is a NodeLink, it will use the `NodeLinkGetLyrics` method to fetch the lyrics.
      *
-     * Requires the `lavalyrics-plugin` to be present in the Lavalink node.
-     * Requires the `lavasrc-plugin` or `java-lyrics-plugin` to be present in the Lavalink node.
+     * Requires the `lavalyrics-plugin` to be present in the Lavalink node. The lyrics sources come from
+     * whichever plugins register them with LavaLyrics (LavaSrc, PulseLink, java-lyrics, ...).
      *
      * @param {Track} track - The track to fetch the lyrics for.
      * @param {boolean} [skipTrackSource=false] - Whether to skip using the track's source URL.
@@ -1053,23 +1060,7 @@ class Node {
         if (this.isNodeLink) {
             return (await this.rest.get(`/v4/loadlyrics?encodedTrack=${encodeURIComponent(track.track)}${language ? `&lang=${encodeURIComponent(language)}` : ""}`));
         }
-        const requiredPlugins = ["lavalyrics-plugin"];
-        for (const plugin of requiredPlugins) {
-            if (!(this.info?.plugins ?? []).some((p) => p.name === plugin)) {
-                throw new MagmastreamError_1.MagmaStreamError({
-                    code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
-                    message: `The plugin "${plugin}" must be present in the lavalink node.`,
-                    context: { identifier: this.options.identifier },
-                });
-            }
-        }
-        if (!(this.info?.plugins ?? []).some((p) => p.name === "lavasrc-plugin" || p.name === "java-lyrics-plugin")) {
-            throw new MagmastreamError_1.MagmaStreamError({
-                code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
-                message: `One of the following plugins must also be present in the lavalink node: "lavasrc-plugin" or "java-lyrics-plugin".`,
-                context: { identifier: this.options.identifier },
-            });
-        }
+        this.requireAnyPlugin(["lavalyrics-plugin"], "fetch lyrics");
         const lyrics = (await this.rest.get(`/v4/lyrics?track=${encodeURIComponent(track.track)}&skipTrackSource=${skipTrackSource}`));
         return lyrics || { sourceName: null, source: null, provider: null, text: null, lines: [], plugin: [] };
     }
@@ -1170,7 +1161,7 @@ class Node {
      * @param {string} guildId - The ID of the guild to subscribe to lyrics for.
      * @param {boolean} [skipTrackSource=false] - Whether to skip using the track's source URL.
      * @returns {Promise<unknown>} A promise that resolves when the subscription is complete.
-     * @throws {RangeError} If the node is not connected to the lavalink server or if the java-lyrics-plugin is not available.
+     * @throws {MagmaStreamError} If the node is not connected to the lavalink server or if the lavalyrics-plugin is not available.
      */
     async lyricsSubscribe(guildId, skipTrackSource = false) {
         if (!this.connected) {
@@ -1182,23 +1173,7 @@ class Node {
         }
         if (this.isNodeLink)
             return await this.rest.post(`/v4/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe?skipTrackSource=${skipTrackSource}`, {});
-        const requiredPlugins = ["lavalyrics-plugin"];
-        for (const plugin of requiredPlugins) {
-            if (!(this.info?.plugins ?? []).some((p) => p.name === plugin)) {
-                throw new MagmastreamError_1.MagmaStreamError({
-                    code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
-                    message: `The plugin "${plugin}" must be present in the lavalink node.`,
-                    context: { identifier: this.options.identifier },
-                });
-            }
-        }
-        if (!(this.info?.plugins ?? []).some((p) => p.name === "lavasrc-plugin" || p.name === "java-lyrics-plugin")) {
-            throw new MagmastreamError_1.MagmaStreamError({
-                code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
-                message: `One of the following plugins must also be present in the lavalink node: "lavasrc-plugin" or "java-lyrics-plugin".`,
-                context: { identifier: this.options.identifier },
-            });
-        }
+        this.requireAnyPlugin(["lavalyrics-plugin"], "subscribe to lyrics");
         try {
             return await this.rest.post(`/v4/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe?skipTrackSource=${skipTrackSource}`, {});
         }
@@ -1217,7 +1192,7 @@ class Node {
      * Unsubscribes from lyrics for a player.
      * @param {string} guildId - The ID of the guild to unsubscribe from lyrics for.
      * @returns {Promise<unknown>} A promise that resolves when the unsubscription is complete.
-     * @throws {RangeError} If the node is not connected to the lavalink server or if the java-lyrics-plugin is not available.
+     * @throws {MagmaStreamError} If the node is not connected to the lavalink server, or if neither the lavalyrics-plugin nor the java-lyrics-plugin is available.
      */
     async lyricsUnsubscribe(guildId) {
         if (!this.connected) {
@@ -1229,13 +1204,7 @@ class Node {
         }
         if (this.isNodeLink)
             return await this.rest.delete(`/v4/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe`);
-        if (!(this.info?.plugins ?? []).some((plugin) => plugin.name === "java-lyrics-plugin")) {
-            throw new MagmastreamError_1.MagmaStreamError({
-                code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
-                message: `The plugin "java-lyrics-plugin" must be present in the lavalink node to unsubscribe.`,
-                context: { identifier: this.options.identifier },
-            });
-        }
+        this.requireAnyPlugin(["lavalyrics-plugin", "java-lyrics-plugin"], "unsubscribe from lyrics");
         try {
             return await this.rest.delete(`/v4/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe`);
         }
@@ -1519,6 +1488,20 @@ class Node {
     async removeNodeLinkMix(player, mixId) {
         return this.removeMix(player, mixId);
     }
+    /** Throws NODE_PLUGIN_ERROR unless the node reports at least one of the given plugins. */
+    requireAnyPlugin(plugins, action) {
+        const installed = this.info?.plugins ?? [];
+        if (installed.some((plugin) => plugins.includes(plugin.name)))
+            return;
+        const names = plugins.map((plugin) => `"${plugin}"`).join(" or ");
+        throw new MagmastreamError_1.MagmaStreamError({
+            code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
+            message: plugins.length === 1
+                ? `The plugin ${names} must be present in the lavalink node to ${action}.`
+                : `One of the following plugins must be present in the lavalink node to ${action}: ${names}.`,
+            context: { identifier: this.options.identifier },
+        });
+    }
     assertNodeLinkFeature(action) {
         if (this.isNodeLink && this.connected)
             return;

package/dist/structures/Utils.js

@@ -238,7 +238,17 @@ class AutoPlayUtils {
         if (apiKey) {
             return await this.getRecommendedTracksFromLastFm(track, apiKey);
         }
-        const enabledSources = node.info.sourceManagers;
+        // node.info is only set once the node's "ready" message is handled, so a just-connected node has none yet
+        let info = node.info;
+        if (!info) {
+            try {
+                info = node.info = await node.fetchInfo();
+            }
+            catch (error) {
+                this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[AUTOPLAY] Node ${node.options.identifier} has no info yet: ${error instanceof Error ? error.message : String(error)}`);
+            }
+        }
+        const enabledSources = info?.sourceManagers ?? [];
         const autoPlaySearchPlatforms = this.manager.options.autoPlaySearchPlatforms;
         // Iterate over autoplay platforms in order of priority
         for (const platform of autoPlaySearchPlatforms) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "magmastream",
-    "version": "2.10.6-alpha.4",
+    "version": "2.10.6-alpha.6",
     "description": "A user-friendly Lavalink client designed for NodeJS.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -11,7 +11,7 @@
         "prepare": "npm run build",
         "build": "tsc",
         "types": "rtb --dist dist",
-        "test": "npm run build && node --test tests/player-state.test.cjs tests/hot-paths.test.cjs tests/restore-performance.test.cjs tests/lyrics.test.cjs",
+        "test": "npm run build && node --test tests/player-state.test.cjs tests/hot-paths.test.cjs tests/restore-performance.test.cjs tests/lyrics.test.cjs tests/autoplay.test.cjs tests/session-storage.test.cjs",
         "format": "prettier --write .",
         "format:check": "prettier --check .",
         "lint": "eslint \"src/**/*.{ts,js}\"",