fix: allow baseUrl to be optional for HTTP Accessor

Author: nytamin

shared/packages/api/src/__tests__/pathJoin.spec.ts

@@ -0,0 +1,11 @@
+import { rebaseUrl } from '../pathJoin'
+test('rebaseUrl', () => {
+	expect(rebaseUrl('https://a', 'b')).toBe('https://a/b')
+	expect(rebaseUrl('https://a/', 'b')).toBe('https://a/b')
+	expect(rebaseUrl('https://a/', '/b')).toBe('https://a/b')
+	expect(rebaseUrl('file://a/', '/b/')).toBe('file://a/b/')
+	expect(rebaseUrl('https:////a/b/', 'c')).toBe('https://a/b/c')
+	expect(rebaseUrl('https://a/', '//b/')).toBe('https://a/b/')
+
+	expect(rebaseUrl('https://a/b//c/', '/d/e//f/')).toBe('https://a/b/c/d/e/f/')
+})

shared/packages/api/src/inputApi.ts

@@ -326,7 +326,7 @@ export namespace Accessor {
 		allowWrite: false
 
 		/** Base url (url to the host), for example http://myhost.com/fileShare/ */
-		baseUrl: string
+		baseUrl?: string
 
 		/** Name/Id of the network the share exists on. Used to differ between different local networks. Leave empty if globally accessible. */
 		networkId?: string

shared/packages/api/src/pathJoin.ts

@@ -0,0 +1,28 @@
+export function removeBasePath(basePath: string, addPath: string): string {
+	addPath = addPath.replace(/\\/g, '/')
+	basePath = basePath.replace(/\\/g, '/')
+
+	return addPath.replace(new RegExp('^' + escapeRegExp(basePath)), '')
+}
+function escapeRegExp(text: string): string {
+	return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&')
+}
+export function rebaseUrl(baseUrl: string, relativeUrl: string): string {
+	try {
+		if (!baseUrl) return new URL(relativeUrl).toString()
+		const base = new URL(baseUrl)
+		const relative = new URL(baseUrl)
+		// relative path may contain URL-unsafe characters, this will encode them but leave any path elements intact
+		relative.pathname = relativeUrl
+		// at this point, relativeUrl.pathname will already include the leading `/`
+		base.pathname = base.pathname + relative.pathname
+		base.pathname = base.pathname.replace(/\/{2,}/g, '/') // Remove double slashes
+		return base.toString()
+	} catch (e) {
+		// Probably a malformed URL
+		if (e instanceof Error) {
+			e.message = `URL: "${baseUrl}" + "${relativeUrl}": ${e.message}`
+		}
+		throw e
+	}
+}

shared/packages/worker/src/worker/accessorHandlers/http.ts

@@ -215,14 +215,9 @@ export class HTTPAccessorHandle<Metadata> extends GenericAccessorHandle<Metadata
 				},
 			}
 		}
-		if (!this.accessor.baseUrl && this.accessor.baseUrl !== '')
-			return {
-				success: false,
-				reason: {
-					user: `Accessor baseUrl not set`,
-					tech: `Accessor baseUrl not set`,
-				},
-			}
+		// Note: For the HTTP-accessor, we allow this.accessor.baseUrl to be empty/falsy
+		// (which means that the content path needs to be a full URL)
+
 		if (!this.content.onlyContainerAccess) {
 			if (!this.path)
 				return {
@@ -236,8 +231,7 @@ export class HTTPAccessorHandle<Metadata> extends GenericAccessorHandle<Metadata
 		return { success: true }
 	}
 	private get baseUrl(): string {
-		if (!this.accessor.baseUrl) throw new Error(`HTTPAccessorHandle: accessor.baseUrl not set!`)
-		return this.accessor.baseUrl
+		return this.accessor.baseUrl ?? ''
 	}
 	get path(): string {
 		if (this.content.onlyContainerAccess) throw new Error('onlyContainerAccess is set!')

shared/packages/worker/src/worker/accessorHandlers/httpProxy.ts

@@ -21,12 +21,12 @@ import {
 	Reason,
 	AccessorId,
 	MonitorId,
+	rebaseUrl,
 } from '@sofie-package-manager/api'
 import { BaseWorker } from '../worker'
 import FormData from 'form-data'
 import { MonitorInProgress } from '../lib/monitorInProgress'
 import { fetchWithController, fetchWithTimeout } from './lib/fetch'
-import { rebaseUrl } from './lib/pathJoin'
 import { defaultCheckHandleRead, defaultCheckHandleWrite } from './lib/lib'
 
 /** Accessor handle for accessing files in HTTP- */

shared/packages/worker/src/worker/accessorHandlers/lib/FileHandler.ts

@@ -17,13 +17,13 @@ import {
 	protectString,
 	MonitorId,
 	AccessorId,
+	removeBasePath,
 } from '@sofie-package-manager/api'
 
 import { BaseWorker } from '../../worker'
 
 import { GenericAccessorHandle } from '../genericHandle'
 import { MonitorInProgress } from '../../lib/monitorInProgress'
-import { removeBasePath } from './pathJoin'
 import { FileEvent, FileWatcher, IFileWatcher } from './FileWatcher'
 import { updateJSONFileBatch } from './json-write-file'
 

shared/packages/worker/src/worker/accessorHandlers/quantel.ts

@@ -23,10 +23,10 @@ import {
 	Reason,
 	INNER_ACTION_TIMEOUT,
 	AccessorId,
+	rebaseUrl,
 } from '@sofie-package-manager/api'
 import { BaseWorker } from '../worker'
 import { ClipData, ClipDataSummary, ServerInfo, ZoneInfo } from 'tv-automation-quantel-gateway-client/dist/quantelTypes'
-import { rebaseUrl } from './lib/pathJoin'
 import { defaultCheckHandleRead, defaultCheckHandleWrite } from './lib/lib'
 
 /** The minimum amount of frames where a clip is minimumly playable */