@milaboratories/pl-drivers 1.3.0 → 1.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-drivers",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Drivers and a low-level clients for log streaming, downloading and uploading files from and to pl",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -27,10 +27,10 @@
     "undici": "^6.19.8",
     "zod": "^3.23.8",
     "@milaboratories/ts-helpers": "^1.1.0",
-    "@milaboratories/pl-client": "^2.5.3",
-    "@milaboratories/pl-model-common": "^1.4.0",
     "@milaboratories/computable": "^2.2.0",
-    "@milaboratories/pl-tree": "^1.4.4"
+    "@milaboratories/pl-tree": "^1.4.4",
+    "@milaboratories/pl-client": "^2.5.3",
+    "@milaboratories/pl-model-common": "^1.4.0"
   },
   "devDependencies": {
     "typescript": "~5.5.4",

package/src/clients/download.test.ts

@@ -6,7 +6,18 @@ import { ConsoleLoggerAdapter } from '@milaboratories/ts-helpers';
 import { GrpcTransport } from '@protobuf-ts/grpc-transport';
 import { Dispatcher } from 'undici';
 import { text } from 'node:stream/consumers';
-import { ClientDownload } from '../clients/download';
+import { ClientDownload, parseLocalFileUrl } from '../clients/download';
+import { test, expect } from '@jest/globals';
+
+test('should parse local file url even on Windows', () => {
+  const url = "storage://main/67z%5C2vy%5C65i%5C67z2vy65i0xwhjwsfsef_ex3k3hxe7qdc2cvtdfkdnhdp9kwlt7-7dmcy0kthe6u.json";
+  const expectedFullPath = 'C:\\Users\\test\\67z\\2vy\\65i\\67z2vy65i0xwhjwsfsef_ex3k3hxe7qdc2cvtdfkdnhdp9kwlt7-7dmcy0kthe6u.json';
+
+  const got = parseLocalFileUrl(url, new Map([['main', 'C:\\Users\\test']]))
+    .replace(path.sep, '\\'); // for testing on *nix systems
+
+  expect(got).toEqual(expectedFullPath);
+})
 
 test('client download from a local file', async () => {
   await TestHelpers.withTempRoot(async (client) => {

package/src/clients/download.ts

@@ -18,7 +18,6 @@ import { LocalStorageProjection } from '../drivers/types';
 import { validateAbsolute } from '../helpers/validate';
 
 const storageProtocol = 'storage://';
-const localPathRegex = /storage:\/\/(?<storageId>.*?)\/(?<localPath>.*)/;
 
 export class UnknownStorageError extends Error {}
 
@@ -74,29 +73,16 @@ export class ClientDownload {
     return this.isLocal(downloadUrl)
       ? await this.readLocalFile(downloadUrl)
       : await this.downloadHelper.downloadRemoteFile(
-          downloadUrl,
-          headersFromProto(headers),
-          signal
-        );
+        downloadUrl,
+        headersFromProto(headers),
+        signal
+      );
   }
 
   private isLocal = (url: string) => url.startsWith(storageProtocol);
 
   async readLocalFile(url: string): Promise<DownloadResponse> {
-    const parsed = url.match(localPathRegex);
-    if (parsed === null || parsed.length != 3) {
-      throw new WrongLocalFileUrl(
-        `url for local filepath ${url} does not match regex ${localPathRegex}, parsed: ${parsed}`
-      );
-    }
-
-    const [_, storageId, localPath] = parsed;
-
-    const storageRoot = this.localStorageIdsToRoot.get(storageId);
-    if (storageRoot === undefined)
-      throw new UnknownStorageError(`Unknown storage location: ${storageId}`);
-
-    const fullPath = storageRoot === '' ? localPath : path.join(storageRoot, localPath);
+    const fullPath = parseLocalFileUrl(url, this.localStorageIdsToRoot);
     const stat = await fsp.stat(fullPath);
     const size = stat.size;
 
@@ -107,6 +93,25 @@ export class ClientDownload {
   }
 }
 
+export function parseLocalFileUrl(
+  url: string,
+  localStorageIdsToRoot: Map<string, string>,
+): string {
+  const parsed = new URL(url);
+  if (parsed.pathname == '')
+    throw new WrongLocalFileUrl(`url for local filepath ${url} does not match url scheme`);
+
+  const storageId = parsed.host;
+  const storageRoot = localStorageIdsToRoot.get(storageId);
+  if (storageRoot === undefined)
+    throw new UnknownStorageError(`Unknown storage location: ${storageId}`);
+
+  const localPath = decodeURIComponent(parsed.pathname.slice(1));
+  const fullPath = storageRoot === '' ? localPath : path.join(storageRoot, localPath);
+
+  return fullPath;
+}
+
 export function headersFromProto(
   headers: DownloadAPI_GetDownloadURL_HTTPHeader[]
 ): Record<string, string> {