fix: fixes #1041: websocket URL ending with / wont work (#1046)

Author: janthurau

packages/provider/src/HocuspocusProvider.ts

@@ -36,7 +36,13 @@ export type HocuspocusProviderConfiguration = Required<
 > &
 	Partial<CompleteHocuspocusProviderConfiguration> &
 	(
-		| Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">>
+		| (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">> &
+				Partial<
+					Pick<
+						CompleteHocuspocusProviderWebsocketConfiguration,
+						"preserveTrailingSlash"
+					>
+				>)
 		| Required<
 				Pick<CompleteHocuspocusProviderConfiguration, "websocketProvider">
 		  >
@@ -222,12 +228,10 @@ export class HocuspocusProvider extends EventEmitter {
 		configuration: Partial<HocuspocusProviderConfiguration> = {},
 	): void {
 		if (!configuration.websocketProvider) {
-			const websocketProviderConfig =
-				configuration as CompleteHocuspocusProviderWebsocketConfiguration;
 			this.manageSocket = true;
-			this.configuration.websocketProvider = new HocuspocusProviderWebsocket({
-				url: websocketProviderConfig.url,
-			});
+			this.configuration.websocketProvider = new HocuspocusProviderWebsocket(
+				configuration as CompleteHocuspocusProviderWebsocketConfiguration,
+			);
 		}
 
 		this.configuration = { ...this.configuration, ...configuration };
@@ -310,7 +314,9 @@ export class HocuspocusProvider extends EventEmitter {
 		try {
 			token = await this.getToken();
 		} catch (error) {
-			this.permissionDeniedHandler(`Failed to get token during sendToken(): ${error}`);
+			this.permissionDeniedHandler(
+				`Failed to get token during sendToken(): ${error}`,
+			);
 			return;
 		}
 

packages/provider/src/HocuspocusProviderWebsocket.ts

@@ -37,6 +37,12 @@ export interface CompleteHocuspocusProviderWebsocketConfiguration {
 	 */
 	url: string;
 
+	/**
+	 * By default, trailing slashes are removed from the URL. Set this to true
+	 * to preserve trailing slashes if your server configuration requires them.
+	 */
+	preserveTrailingSlash: boolean;
+
 	/**
 	 * An optional WebSocket polyfill, for example for Node.js
 	 */
@@ -102,6 +108,7 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
 	public configuration: CompleteHocuspocusProviderWebsocketConfiguration = {
 		url: "",
 		autoConnect: true,
+		preserveTrailingSlash: false,
 		// @ts-ignore
 		document: undefined,
 		WebSocketPolyfill: undefined,
@@ -434,13 +441,18 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
 		}
 	}
 
-	// Ensure that the URL never ends with /
 	get serverUrl() {
-		while (this.configuration.url[this.configuration.url.length - 1] === "/") {
-			return this.configuration.url.slice(0, this.configuration.url.length - 1);
+		if (this.configuration.preserveTrailingSlash) {
+			return this.configuration.url;
+		}
+
+		// By default, ensure that the URL never ends with /
+		let url = this.configuration.url;
+		while (url[url.length - 1] === "/") {
+			url = url.slice(0, url.length - 1);
 		}
 
-		return this.configuration.url;
+		return url;
 	}
 
 	get url() {