aqualink 3.0.0 → 3.2.0

package/build/structures/Rest.js

@@ -11,10 +11,7 @@ const {
   zstdDecompressSync
 } = require('node:zlib')
 
-let autoplayModule = null
-try {
-  autoplayModule = require('../handlers/autoplay')
-} catch {}
+const { emitOperationalError } = require('./Reporting')
 
 const unrefTimer = (t) => {
   try {
@@ -90,7 +87,6 @@ const _functions = {
   parseBody(data, contentType, forceJson) {
     const isJson = forceJson || this.isJsonContent(contentType)
     if (isJson) {
-      if (typeof data === 'string') return JSON.parse(data)
       return JSON.parse(data)
     }
     return typeof data === 'string' ? data : data.toString(UTF8)
@@ -134,6 +130,7 @@ class Rest {
     this.aqua = aqua
     this.node = node
     this.sessionId = node.sessionId
+    this._sessionGeneration = 0
     this.timeout = node.timeout || 30000
 
     const protocol = node.ssl ? 'https:' : 'http:'
@@ -208,21 +205,18 @@ class Rest {
     this.agent = new (node.ssl ? HttpsAgent : HttpAgent)(opts)
     this.request = node.ssl ? httpsRequest : httpRequest
 
-    if (autoplayModule?.setSharedAgent) {
-      if (node.ssl) {
-        this._autoplayAgent = this.agent
-      } else {
-        this._autoplayAgent = new HttpsAgent({
-          keepAlive: true,
-          maxSockets: node.maxSockets || 128,
-          maxFreeSockets: node.maxFreeSockets || 64,
-          freeSocketTimeout: node.freeSocketTimeout || 15000,
-          keepAliveMsecs: node.keepAliveMsecs || 500,
-          scheduling: 'lifo',
-          timeout: this.timeout
-        })
-      }
-      autoplayModule.setSharedAgent(this._autoplayAgent)
+    if (node.ssl) {
+      this._autoplayAgent = this.agent
+    } else {
+      this._autoplayAgent = new HttpsAgent({
+        keepAlive: true,
+        maxSockets: node.maxSockets || 128,
+        maxFreeSockets: node.maxFreeSockets || 64,
+        freeSocketTimeout: node.freeSocketTimeout || 15000,
+        keepAliveMsecs: node.keepAliveMsecs || 500,
+        scheduling: 'lifo',
+        timeout: this.timeout
+      })
     }
 
     const origCreate = this.agent.createConnection.bind(this.agent)
@@ -236,10 +230,18 @@ class Rest {
 
   setSessionId(sessionId) {
     this.sessionId = sessionId
+    this._sessionGeneration++
   }
 
-  _getSessionPath() {
+  _getSessionPath(generation) {
     if (!this.sessionId) throw ERRORS.NO_SESSION
+    if (generation != null && generation !== this._sessionGeneration) {
+      const staleErr = new Error(
+        `Stale session: sessionId was updated (expected gen ${generation}, current ${this._sessionGeneration}) for session ${this.sessionId}`
+      )
+      staleErr.statusCode = 404
+      throw staleErr
+    }
     return `${this._apiBase}/sessions/${this.sessionId}`
   }
 
@@ -271,7 +273,7 @@ class Rest {
     }
   }
 
-  _collectBody(stream, preallocSize = 0) {
+  _collectBody(stream, preallocSize = 0, source = stream) {
     return new Promise((resolve, reject) => {
       let done = false
       let size = 0
@@ -304,7 +306,11 @@ class Rest {
           size += chunk.length
           chunks.push(chunk)
         }
-        if (size > MAX_RESPONSE_SIZE) finish(false, ERRORS.RESPONSE_TOO_LARGE)
+        if (size > MAX_RESPONSE_SIZE) {
+          stream.destroy?.(ERRORS.RESPONSE_TOO_LARGE)
+          if (source !== stream) source.destroy?.(ERRORS.RESPONSE_TOO_LARGE)
+          finish(false, ERRORS.RESPONSE_TOO_LARGE)
+        }
       })
 
       stream.once('error', (e) => finish(false, e))
@@ -414,7 +420,7 @@ class Rest {
 
           const clInt = cl ? parseInt(cl, 10) : 0
           if (clInt > MAX_RESPONSE_SIZE) {
-            res.resume()
+            res.destroy(ERRORS.RESPONSE_TOO_LARGE)
             return finish(false, ERRORS.RESPONSE_TOO_LARGE)
           }
 
@@ -472,7 +478,7 @@ class Rest {
             preallocSize = clInt
           }
 
-          this._collectBody(stream, preallocSize)
+          this._collectBody(stream, preallocSize, res)
             .then((buffer) => {
               if (!buffer) return finish(true, null)
               finalize(buffer)
@@ -482,6 +488,10 @@ class Rest {
       )
 
       req.once('error', (e) => finish(false, e))
+      req.setTimeout(this.timeout, () => {
+        req.destroy()
+        finish(false, new Error(`Socket timeout: ${this.timeout}ms`))
+      })
       timer = setTimeout(
         () => finish(false, new Error(`Request timeout: ${this.timeout}ms`)),
         this.timeout
@@ -494,13 +504,14 @@ class Rest {
   _getH2Session() {
     if (!this._h2 || this._h2.closed || this._h2.destroyed) {
       this._clearH2()
-      this._h2 = http2.connect(this.baseUrl, this._tlsOptions || undefined)
+      const session = http2.connect(this.baseUrl, this._tlsOptions || undefined)
+      this._h2 = session
       this._resetH2Timer()
 
-      const onEnd = () => this._clearH2()
-      this._h2.once('error', onEnd)
-      this._h2.once('close', onEnd)
-      this._h2.socket?.unref?.()
+      const onEnd = () => this._clearH2(session)
+      session.once('error', onEnd)
+      session.once('close', onEnd)
+      session.socket?.unref?.()
     }
     return this._h2
   }
@@ -511,12 +522,14 @@ class Rest {
       this._h2Timer = null
     }
     if (this._h2 && !this._h2.closed && !this._h2.destroyed) {
-      this._h2Timer = setTimeout(() => this._closeH2(), H2_TIMEOUT)
+      const session = this._h2
+      this._h2Timer = setTimeout(() => this._closeH2(session), H2_TIMEOUT)
       unrefTimer(this._h2Timer)
     }
   }
 
-  _clearH2() {
+  _clearH2(session = this._h2) {
+    if (session !== this._h2) return
     if (this._h2Timer) {
       clearTimeout(this._h2Timer)
       this._h2Timer = null
@@ -524,7 +537,8 @@ class Rest {
     this._h2 = null
   }
 
-  _closeH2() {
+  _closeH2(session = this._h2) {
+    if (session !== this._h2) return
     if (this._h2Timer) {
       clearTimeout(this._h2Timer)
       this._h2Timer = null
@@ -588,7 +602,7 @@ class Rest {
 
         const clInt = cl ? parseInt(cl, 10) : 0
         if (clInt > MAX_RESPONSE_SIZE) {
-          req.resume()
+          req.close(http2.constants.NGHTTP2_CANCEL)
           return finish(false, ERRORS.RESPONSE_TOO_LARGE)
         }
 
@@ -621,7 +635,7 @@ class Rest {
 
         if (decomp) decomp.once('error', (e) => finish(false, e))
         req.once('error', (e) => finish(false, e))
-        this._collectBody(stream, preallocSize)
+        this._collectBody(stream, preallocSize, req)
           .then((buffer) => {
             if (!buffer) return finish(true, null)
             finalize(buffer)
@@ -639,28 +653,33 @@ class Rest {
   }
 
   async updatePlayer({ guildId, data, noReplace = false }) {
+    const gen = this._sessionGeneration
     return this.makeRequest(
       'PATCH',
-      `${this._getSessionPath()}/players/${guildId}?noReplace=${noReplace}`,
+      `${this._getSessionPath(gen)}/players/${guildId}?noReplace=${noReplace}`,
       data
     )
   }
 
   async getPlayer(guildId) {
+    const gen = this._sessionGeneration
     return this.makeRequest(
       'GET',
-      `${this._getSessionPath()}/players/${guildId}`
+      `${this._getSessionPath(gen)}/players/${guildId}`
     )
   }
 
   async getPlayers() {
-    return this.makeRequest('GET', `${this._getSessionPath()}/players`)
+    const gen = this._sessionGeneration
+    return this.makeRequest('GET', `${this._getSessionPath(gen)}/players`)
   }
 
-  async destroyPlayer(guildId) {
+  async destroyPlayer(guildId, abortSignal) {
+    const gen = this._sessionGeneration
+    if (abortSignal?.aborted) return null
     return this.makeRequest(
       'DELETE',
-      `${this._getSessionPath()}/players/${guildId}`
+      `${this._getSessionPath(gen)}/players/${guildId}`
     )
   }
 
@@ -725,7 +744,7 @@ class Rest {
     const title = track?.info?.title
 
     if (!track || (!guildId && !hasEncoded && !title)) {
-      this.aqua?.emit?.('error', '[Aqua/Lyrics] Invalid track object')
+      emitOperationalError(this.aqua, this.node, 'Invalid lyrics track object')
       return null
     }
 
@@ -733,9 +752,10 @@ class Rest {
 
     if (guildId) {
       try {
+        const gen = this._sessionGeneration
         const lyrics = await this.makeRequest(
           'GET',
-          `${this._getSessionPath()}/players/${guildId}/track/lyrics?skipTrackSource=${skip}`
+          `${this._getSessionPath(gen)}/players/${guildId}/track/lyrics?skipTrackSource=${skip}`
         )
         if (this._validLyrics(lyrics)) return lyrics
       } catch {}
@@ -776,10 +796,11 @@ class Rest {
 
   async subscribeLiveLyrics(guildId, skipTrackSource = false) {
     try {
+      const gen = this._sessionGeneration
       return (
         (await this.makeRequest(
           'POST',
-          `${this._getSessionPath()}/players/${guildId}/lyrics/subscribe?skipTrackSource=${skipTrackSource ? 'true' : 'false'}`
+          `${this._getSessionPath(gen)}/players/${guildId}/lyrics/subscribe?skipTrackSource=${skipTrackSource ? 'true' : 'false'}`
         )) === null
       )
     } catch {
@@ -789,10 +810,11 @@ class Rest {
 
   async unsubscribeLiveLyrics(guildId) {
     try {
+      const gen = this._sessionGeneration
       return (
         (await this.makeRequest(
           'DELETE',
-          `${this._getSessionPath()}/players/${guildId}/lyrics/subscribe`
+          `${this._getSessionPath(gen)}/players/${guildId}/lyrics/subscribe`
         )) === null
       )
     } catch {
@@ -816,9 +838,10 @@ class Rest {
       volume: options.volume !== undefined ? options.volume : 0.8
     }
 
+    const gen = this._sessionGeneration
     return this.makeRequest(
       'POST',
-      `/v4/sessions/${this.sessionId}/players/${guildId}/mix`,
+      `${this._getSessionPath(gen)}/players/${guildId}/mix`,
       payload
     )
   }
@@ -826,9 +849,10 @@ class Rest {
   async getActiveMixer(guildId) {
     if (!this.node.isNodelink)
       throw new Error('Mixer endpoints are only available on Nodelink nodes')
+    const gen = this._sessionGeneration
     const response = await this.makeRequest(
       'GET',
-      `/v4/sessions/${this.sessionId}/players/${guildId}/mix`
+      `${this._getSessionPath(gen)}/players/${guildId}/mix`
     )
     return response?.mixes || []
   }
@@ -839,9 +863,10 @@ class Rest {
     if (!guildId || !mix || typeof volume !== 'number')
       throw new Error('You forget to set the guild_id, mix or volume options')
 
+    const gen = this._sessionGeneration
     return this.makeRequest(
       'PATCH',
-      `/v4/sessions/${this.sessionId}/players/${guildId}/mix/${mix}`,
+      `${this._getSessionPath(gen)}/players/${guildId}/mix/${mix}`,
       { volume }
     )
   }
@@ -852,9 +877,10 @@ class Rest {
     if (!guildId || !mix)
       throw new Error('You forget to set the guild_id and/or mix options')
 
+    const gen = this._sessionGeneration
     return this.makeRequest(
       'DELETE',
-      `/v4/sessions/${this.sessionId}/players/${guildId}/mix/${mix}`
+      `${this._getSessionPath(gen)}/players/${guildId}/mix/${mix}`
     )
   }
 
@@ -868,9 +894,6 @@ class Rest {
     if (autoplayAgent && autoplayAgent !== primaryAgent) {
       autoplayAgent.destroy?.()
     }
-    if (autoplayModule?.setSharedAgent && autoplayAgent) {
-      autoplayModule.setSharedAgent(null)
-    }
     this._closeH2()
     if (this._headerPool) {
       this._headerPool.length = 0

package/build/structures/Track.js

@@ -9,6 +9,7 @@ const _h = {
 class Track {
   constructor(data = {}, requester = null, node = null) {
     const info = data.info || {}
+    const pluginInfo = info.pluginInfo || data.pluginInfo || {}
 
     this.track = data.track || data.encoded || null
     this.identifier = _h.str(info.identifier)
@@ -21,14 +22,15 @@ class Track {
     this.uri = _h.str(info.uri)
     this.sourceName = _h.str(info.sourceName)
     this.artworkUrl = _h.str(info.artworkUrl)
-    this.pluginInfo = info.pluginInfo || data.pluginInfo || {}
+    this.pluginInfo = pluginInfo
+    this.isrc = _h.str(info.isrc || pluginInfo.isrc) // ISRC support
 
     this.playlist = data.playlist || null
     this.node = node || data.node || null
     this.nodes = data.nodes || null
     this.requester = requester || null
     this._infoCache = null
-    this._artworkCache = undefined // undefined = not computed, null = computed but no artwork
+    this._artworkCache = undefined
   }
 
   get info() {
@@ -43,7 +45,8 @@ class Track {
       title: this.title,
       uri: this.uri,
       sourceName: this.sourceName,
-      artworkUrl: this.artworkUrl || this._computeArtwork()
+      artworkUrl: this.artworkUrl || this._computeArtwork(),
+      isrc: this.isrc || null // exposed here
     })
     return this._infoCache
   }
@@ -113,6 +116,9 @@ class Track {
     this.position = _h.num(fi.position, this.position)
     this.duration = _h.num(fi.length, this.duration)
     this.playlist = found.playlist ?? this.playlist
+    this.isrc = _h.str(
+      fi.isrc ?? fi.pluginInfo?.isrc ?? found.pluginInfo?.isrc ?? this.isrc
+    ) // keep ISRC
     this._infoCache = null
 
     return this
@@ -139,6 +145,7 @@ class Track {
       this.uri =
       this.sourceName =
       this.artworkUrl =
+      this.isrc =
         ''
   }
 

package/package.json

@@ -1,70 +1,70 @@
-{
-  "name": "aqualink",
-  "version": "3.0.0",
-  "description": "An Lavalink/Nodelink client, focused in pure performance and features",
-  "main": "./build/index.js",
-  "types": "./build/index.d.ts",
-  "scripts": {
-    "start": "node ./build/index.js"
-  },
-  "exports": {
-    ".": {
-      "require": "./build/index.js",
-      "import": "./build/index.js",
-      "types": "./build/index.d.ts"
-    }
-  },
-  "keywords": [
-    "lavalink",
-    "lavalink-client",
-    "client-wrapper",
-    "discord.js",
-    "node.js",
-    "audio-streaming",
-    "music-bot",
-    "discord-integration",
-    "high-performance",
-    "scalable",
-    "nodelink",
-    "api",
-    "discord",
-    "lavalink.js",
-    "discord.js",
-    "lavalink-api",
-    "cross-platform",
-    "seamless-integration",
-    "community-support",
-    "open-source",
-    "opus"
-  ],
-  "author": "mushroom0162 (https://github.com/ToddyTheNoobDud)",
-  "license": "ISC",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ToddyTheNoobDud/AquaLink.git"
-  },
-  "homepage": "https://aqualink-6006388d.mintlify.app/",
-  "dependencies": {
-    "ws": "^8.19.0"
-  },
-  "contributors": [
-    {
-      "name": "mushroom0162",
-      "url": "https://github.com/ToddyTheNoobDud"
-    },
-    {
-      "name": "SoulDevs",
-      "url": "https://github.com/SoulDevs"
-    },
-    {
-      "name": "southctrl",
-      "url": "https://github.com/southctrl"
-    }
-  ],
-  "maintainers": [
-    {
-      "name": "mushroom0162",
-      "url": "https://github.com/ToddyTheNoobDud"
-    }
-  ]
-}
+{
+  "name": "aqualink",
+  "version": "3.2.0",
+  "description": "An Lavalink/Nodelink client, focused in pure performance and features",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "scripts": {
+    "start": "node ./build/index.js"
+  },
+  "exports": {
+    ".": {
+      "require": "./build/index.js",
+      "import": "./build/index.js",
+      "types": "./build/index.d.ts"
+    }
+  },
+  "keywords": [
+    "lavalink",
+    "lavalink-client",
+    "client-wrapper",
+    "discord.js",
+    "node.js",
+    "audio-streaming",
+    "music-bot",
+    "discord-integration",
+    "high-performance",
+    "scalable",
+    "nodelink",
+    "api",
+    "discord",
+    "lavalink.js",
+    "discord.js",
+    "lavalink-api",
+    "cross-platform",
+    "seamless-integration",
+    "community-support",
+    "open-source",
+    "opus"
+  ],
+  "author": "mushroom0162 (https://github.com/ToddyTheNoobDud)",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ToddyTheNoobDud/AquaLink.git"
+  },
+  "homepage": "https://aqualink-6006388d.mintlify.app/",
+  "dependencies": {
+    "ws": "^8.21.1"
+  },
+  "contributors": [
+    {
+      "name": "mushroom0162",
+      "url": "https://github.com/ToddyTheNoobDud"
+    },
+    {
+      "name": "SoulDevs",
+      "url": "https://github.com/SoulDevs"
+    },
+    {
+      "name": "southctrl",
+      "url": "https://github.com/southctrl"
+    }
+  ],
+  "maintainers": [
+    {
+      "name": "mushroom0162",
+      "url": "https://github.com/ToddyTheNoobDud"
+    }
+  ]
+}