Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed: player.changeNode() #87

Merged
merged 9 commits into from
Jan 13, 2025
Merged

Fixed: player.changeNode() #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1aa9f9b
fix: player.changeNode()
PandaIN95 Dec 19, 2024
3d01be0
fix: trackStart getting called twice when player.changeNode();
PandaIN95 Dec 19, 2024
5a86715
fix: check if the currentQueue can be played on new Node or not
PandaIN95 Dec 19, 2024
40be1dd
fix: using player.changeNode() gives error when currentNode is discon…
PandaIN95 Dec 19, 2024
2ace1b4
Fixed: player.skip()
PandaIN95 Dec 29, 2024
bb5f11d
Update Player.ts
PandaIN95 Jan 1, 2025
28dc127
player.changeNode() enhancement
PandaIN95 Jan 1, 2025
ef7a36d
Revert "player.changeNode() enhancement"
PandaIN95 Jan 1, 2025
b2c6c8a
player.changeNode() enhancement
PandaIN95 Jan 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/structures/Node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1231,6 +1231,7 @@ export class LavalinkNode {

/** @private util function for handling trackEnd event */
private async trackEnd(player: Player, track: Track, payload: TrackEndEvent): Promise<void> {
if (player.get('internal_nodeChanging') === true) return; // Check if nodeChange is in Progress than stop the trackEnd Event from being triggered.
const trackToUse = track || this.getTrackOfPayload(payload);
// If a track was forcibly played
if (payload.reason === "replaced") {
Expand Down Expand Up @@ -1454,6 +1455,7 @@ export class LavalinkNode {

/** private util function for handling the queue end event */
private async queueEnd(player: Player, track: Track, payload: TrackEndEvent | TrackStuckEvent | TrackExceptionEvent): Promise<void> {
if (player.get('internal_nodeChanging') === true) return; // Check if nodeChange is in Progress than stop the queueEnd Event from being triggered.
// add previous track to the queue!
player.queue.current = null;
player.playing = false;
Expand Down
134 changes: 89 additions & 45 deletions src/structures/Player.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,12 @@ export class Player {
serverMute: boolean,
suppress: boolean,
} = {
selfDeaf: false,
selfMute: false,
serverDeaf: false,
serverMute: false,
suppress: false,
}
selfDeaf: false,
selfMute: false,
serverDeaf: false,
serverMute: false,
suppress: false,
}

/** Custom data for the player */
private readonly data: Record<string, unknown> = {};
Expand All @@ -109,7 +109,7 @@ export class Player {
: this.options.node;

if (!this.node || typeof this.node.request !== "function") {
if(typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.PlayerCreateNodeNotFound, {
state: "warn",
message: `Player was created with provided node Id: ${this.options.node}, but no node with that Id was found.`,
Expand Down Expand Up @@ -179,7 +179,7 @@ export class Player {
*/
async play(options: Partial<PlayOptions> = {}) {
if (this.get("internal_queueempty")) {
if(this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.PlayerPlayQueueEmptyTimeoutClear, {
state: "log",
message: `Player was called to play something, while there was a queueEmpty Timeout set, clearing the timeout.`,
Expand All @@ -198,7 +198,7 @@ export class Player {
// resolve the unresolved track
await (options.clientTrack as UnresolvedTrack).resolve(this);
} catch (error) {
if(this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.PlayerPlayUnresolvedTrackFailed, {
state: "error",
error: error,
Expand Down Expand Up @@ -245,16 +245,16 @@ export class Player {
identifier: options.track.identifier,
}).filter(v => typeof v[1] !== "undefined")) as LavalinkPlayOptions["track"];

if(typeof options.track.userData === "object") track.userData = {
if (typeof options.track.userData === "object") track.userData = {
...(options.track.userData || {})
};

if(typeof options?.track?.requester === "object") track.userData = {
if (typeof options?.track?.requester === "object") track.userData = {
...(track.userData || {}),
requester: this.LavalinkManager.utils.getTransformedRequester(options?.track?.requester || {}) as anyObject
};

if(this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.PlayerPlayWithTrackReplace, {
state: "log",
message: `Player was called to play something, with a specific track provided. Replacing the current Track and resolving the track on trackStart Event.`,
Expand All @@ -280,7 +280,7 @@ export class Player {
if (!this.queue.current && this.queue.tracks.length) await queueTrackEnd(this);

if (this.queue.current && this.LavalinkManager.utils.isUnresolvedTrack(this.queue.current)) {
if(this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.PlayerPlayUnresolvedTrack, {
state: "log",
message: `Player Play was called, current Queue Song is unresolved, resolving the track.`,
Expand All @@ -294,7 +294,7 @@ export class Player {

if (typeof options.track?.userData === "object" && this.queue.current) this.queue.current.userData = { ...(this.queue.current?.userData || {}), ...(options.track?.userData || {}) };
} catch (error) {
if(this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.PlayerPlayUnresolvedTrackFailed, {
state: "error",
error: error,
Expand Down Expand Up @@ -375,7 +375,7 @@ export class Player {

const now = performance.now();
if (this.LavalinkManager.options.playerOptions.applyVolumeAsFilter) {
if(this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.PlayerVolumeAsFilter, {
state: "log",
message: `Player Volume was set as a Filter, because LavalinkManager option "playerOptions.applyVolumeAsFilter" is true`,
Expand Down Expand Up @@ -427,7 +427,7 @@ export class Player {
const Query = this.LavalinkManager.utils.transformQuery(query);

if (["bcsearch", "bandcamp"].includes(Query.source) && !this.node.info.sourceManagers.includes("bandcamp")) {
if(this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.BandcampSearchLokalEngine, {
state: "log",
message: `Player.search was called with a Bandcamp Query, but no bandcamp search was enabled on lavalink, searching with the custom Search Engine.`,
Expand Down Expand Up @@ -512,11 +512,10 @@ export class Player {
await this.queue.splice(0, skipTo - 1);
}

if (!this.playing) return (this.play(), this);
PandaIN95 marked this conversation as resolved.
Show resolved Hide resolved

if (!this.playing && !this.queue.current) return (this.play(), this);
const now = performance.now();
this.set("internal_skipped", true);
await this.node.updatePlayer({ guildId: this.guildId, playerOptions: { track: { encoded: null } } });
await this.node.updatePlayer({ guildId: this.guildId, playerOptions: { track: { encoded: null }, paused: false } });

this.ping.lavalink = Math.round((performance.now() - now) / 10) / 100;

Expand Down Expand Up @@ -628,7 +627,7 @@ export class Player {

if (this.get("internal_destroystatus") === true) {

if(this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.PlayerDestroyingSomewhereElse, {
state: "warn",
message: `Player is already destroying somewhere else..`,
Expand Down Expand Up @@ -715,12 +714,31 @@ export class Player {
/**
* Move the player on a different Audio-Node
* @param newNode New Node / New Node Id
* @param checkSources If it should check if the sources are supported by the new node
*/
public async changeNode(newNode: LavalinkNode | string) {
public async changeNode(newNode: LavalinkNode | string, checkSources: boolean = true) {
const updateNode = typeof newNode === "string" ? this.LavalinkManager.nodeManager.nodes.get(newNode) : newNode;
if (!updateNode) throw new Error("Could not find the new Node");
if (!updateNode.connected) throw new Error("The provided Node is not active or disconnected");
if (this.node.id === updateNode.id) throw new Error("Player is already on the provided Node");
if (this.get("internal_nodeChanging") === true) throw new Error("Player is already changing the node please wait");
if (checkSources) {
const isDefaultSource = (): boolean => { // check if defaultSearchPlatform is enabled on newNode
try {
this.LavalinkManager.utils.validateSourceString(updateNode, this.LavalinkManager.options.playerOptions.defaultSearchPlatform);
return true;
} catch { return false }
};
if (!isDefaultSource()) throw new RangeError(`defaultSearchPlatform "${this.LavalinkManager.options.playerOptions.defaultSearchPlatform}" is not supported by the newNode`);
if (this.queue.current || this.queue.tracks.length) { // Check if all queued track sources are supported by the new node
const trackSources = new Set([this.queue.current, ...this.queue.tracks].map(track => track.info.sourceName));
const missingSources = [...trackSources].filter(
source => !updateNode.info.sourceManagers.includes(source));
if (missingSources.length)
throw new RangeError(`Sources missing for Node ${updateNode.id}: ${missingSources.join(', ')}`)}
}

if(this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.PlayerChangeNode, {
state: "log",
message: `Player.changeNode() was executed, trying to change from "${this.node.id}" to "${updateNode.id}"`,
Expand All @@ -729,32 +747,58 @@ export class Player {
}

const data = this.toJSON();

const currentTrack = this.queue.current;

await this.node.destroyPlayer(this.guildId);

const voiceData = this.voice;
if (!voiceData.endpoint ||
!voiceData.sessionId ||
!voiceData.token)
throw new Error("Voice Data is missing, can't change the node");
this.set("internal_nodeChanging", true); // This will stop execution of trackEnd or queueEnd event while changing the node
if (this.node.connected) await this.node.destroyPlayer(this.guildId); // destroy the player on the currentNode if it's connected
this.node = updateNode;

const now = performance.now();

await this.connect();

await this.node.updatePlayer({
guildId: this.guildId,
noReplace: false,
playerOptions: {
position: data.position,
volume: Math.round(Math.max(Math.min(data.volume, 1000), 0)),
paused: data.paused,
filters: { ...data.filters, equalizer: data.equalizer },
track: currentTrack ?? undefined
},
});

this.ping.lavalink = Math.round((performance.now() - now) / 10) / 100;

return this.node.id;
try {
await this.connect();
const endpoint = `/sessions/${this.node.sessionId}/players/${this.guildId}`; //Send the VoiceData to the newly connected node.
await this.node.request(endpoint, r => {
r.method = "PATCH";
r.headers["Content-Type"] = "application/json";
r.body = JSON.stringify({
voice: {
token: voiceData.token,
endpoint: voiceData.endpoint,
sessionId: voiceData.sessionId
}
});
});
if (currentTrack) { // If there is a current track, send it to the new node.
await this.node.updatePlayer({
guildId: this.guildId,
noReplace: false,
playerOptions: {
track: currentTrack ?? null,
position: currentTrack ? data.position : 0,
volume: data.lavalinkVolume,
paused: data.paused,
//filters: { ...data.filters, equalizer: data.equalizer }, Sending filters on nodeChange causes issues (player gets dicsonnected)
}
});
}
this.ping.lavalink = Math.round((performance.now() - now) / 10) / 100;
return this.node.id;
} catch (error) {
if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
this.LavalinkManager.emit("debug", DebugEvents.PlayerChangeNode, {
state: "error",
error: error,
message: `Player.changeNode() execution failed`,
functionLayer: "Player > changeNode()",
});
}
throw new Error(`Failed to change the node: ${error}`);
} finally {
this.set("internal_nodeChanging", undefined);
}
}

/** Converts the Player including Queue to a Json state */
Expand Down
Loading