@milaboratories/pl-drivers 1.3.2 → 1.3.4

package/src/drivers/ls.ts

@@ -19,11 +19,15 @@ import {
   parseIndexHandle,
   parseUploadHandle
 } from './helpers/ls_list_entry';
-import { createLocalStorageHandle, createRemoteStorageHandle, parseStorageHandle } from './helpers/ls_storage_entry';
-import { LocalStorageProjection } from './types';
-import * as os from 'node:os';
+import {
+  createLocalStorageHandle,
+  createRemoteStorageHandle,
+  parseStorageHandle
+} from './helpers/ls_storage_entry';
+import { LocalStorageProjection, VirtualLocalStorageSpec } from './types';
 import { createLsFilesClient } from '../clients/helpers';
 import { validateAbsolute } from '../helpers/validate';
+import { DefaultVirtualLocalStorages } from './virtual_storages';
 
 /**
  * Extends public and safe SDK's driver API with methods used internally in the middle
@@ -42,31 +46,6 @@ export type OpenFileDialogCallback = (
   ops?: OpenDialogOps
 ) => Promise<undefined | string[]>;
 
-/** Allows to add parts of local FS as virtual storages, presenting homogeneous API to UI */
-export type VirtualLocalStorageSpec = {
-  /** Virtual storage ID, must not intersect with other storage ids */
-  readonly name: string;
-
-  /** Local path to "chroot" the API in */
-  readonly root: string;
-
-  /** Used as hint to UI controls to, set as initial path during browsing */
-  readonly initialPath: string;
-};
-
-export function DefaultVirtualLocalStorages(): VirtualLocalStorageSpec[] {
-  const home = os.homedir();
-  return path.sep === '/'
-    ? [{ name: 'local', root: '/', initialPath: home }]
-    : [
-        {
-          name: 'local',
-          root: path.parse(home).root, // disk where home directory resides
-          initialPath: home
-        }
-      ];
-}
-
 export class LsDriver implements InternalLsDriver {
   private constructor(
     private readonly logger: MiLogger,
@@ -180,18 +159,28 @@ export class LsDriver implements InternalLsDriver {
   }
 
   public async getStorageList(): Promise<sdk.StorageEntry[]> {
-    return [
-      ...[...this.virtualStoragesMap.values()].map((vs) => ({
-        name: vs.name,
-        handle: createLocalStorageHandle(vs.name, vs.root),
-        initialFullPath: vs.initialPath
-      })),
-      ...Object.entries(this.storageIdToResourceId!).map(([storageId, resourceId]) => ({
+    const virtualStorages = [...this.virtualStoragesMap.values()].map((s) => ({
+      name: s.name,
+      handle: createLocalStorageHandle(s.name, s.root),
+      initialFullPath: s.initialPath
+    }));
+
+    const otherStorages = Object.entries(this.storageIdToResourceId!).map(
+      ([storageId, resourceId]) => ({
         name: storageId,
         handle: createRemoteStorageHandle(storageId, resourceId),
-        initialFullPath: '' // we don't have any additional information from where to start browsing remote storages
-      }))
-    ] as sdk.StorageEntry[];
+        initialFullPath: '', // we don't have any additional information from where to start browsing remote storages
+        isInitialPathHome: false
+      })
+    );
+
+    // root must be a storage so we can index any file,
+    // but for UI it's enough
+    // to have local virtual storage on *nix,
+    // and local_disk_${drive} on Windows.
+    const noRoot = otherStorages.filter((it) => it.name !== 'root');
+
+    return [...virtualStorages, ...noRoot];
   }
 
   public async listFiles(
@@ -213,10 +202,12 @@ export class LsDriver implements InternalLsDriver {
     } else {
       if (path.sep === '/' && fullPath === '') fullPath = '/';
 
-      const lsRoot =
-        storageData.rootPath === ''
-          ? validateAbsolute(fullPath)
-          : path.join(storageData.rootPath, fullPath);
+      if (storageData.rootPath === '') {
+        validateAbsolute(fullPath);
+      }
+      const lsRoot = path.isAbsolute(fullPath)
+        ? fullPath
+        : path.join(storageData.rootPath, fullPath);
 
       const entries: LsEntry[] = [];
       for await (const dirent of await fsp.opendir(lsRoot)) {
@@ -243,13 +234,15 @@ export class LsDriver implements InternalLsDriver {
     logger: MiLogger,
     client: PlClient,
     signer: Signer,
-    virtualStorages: VirtualLocalStorageSpec[],
     /** Pl storages available locally */
     localProjections: LocalStorageProjection[],
-    openFileDialogCallback: OpenFileDialogCallback
+    openFileDialogCallback: OpenFileDialogCallback,
+    virtualStorages?: VirtualLocalStorageSpec[]
   ): Promise<LsDriver> {
     const lsClient = createLsFilesClient(client, logger);
 
+    if (!virtualStorages) virtualStorages = await DefaultVirtualLocalStorages();
+
     // validating inputs
     for (const vp of virtualStorages) validateAbsolute(vp.root);
     for (const lp of localProjections) if (lp.localPath !== '') validateAbsolute(lp.localPath);

package/src/drivers/types.ts

@@ -39,3 +39,15 @@ export type LocalStorageProjection = {
    * */
   readonly localPath: string;
 };
+
+/** Allows to add parts of local FS as virtual storages, presenting homogeneous API to UI */
+export type VirtualLocalStorageSpec = {
+  /** Virtual storage ID, must not intersect with other storage ids */
+  readonly name: string;
+
+  /** Local path to "chroot" the API in */
+  readonly root: string;
+
+  /** Used as hint to UI controls to, set as initial path during browsing */
+  readonly initialPath: string;
+};

package/src/drivers/virtual_storages.ts

@@ -0,0 +1,41 @@
+import path from 'path';
+import os from 'os';
+import util from 'util';
+import { exec } from 'child_process';
+import { VirtualLocalStorageSpec } from './types';
+
+export async function DefaultVirtualLocalStorages(): Promise<VirtualLocalStorageSpec[]> {
+  const home = os.homedir();
+  if (path.sep == '/')
+    return [
+      {
+        name: 'local',
+        root: '/',
+        initialPath: home
+      }
+    ];
+  else {
+    // determine the drive on which user's home folder is stored
+    const homeRoot = path.parse(home).root; // e.g. C:\
+    const homeDrive = homeRoot.replaceAll(':\\', ''); // e.g. C drive.
+
+    // code below inspired by
+    // https://stackoverflow.com/a/52411712/769192
+
+    const wmic = await util.promisify(exec)('wmic logicaldisk get name');
+    // parsing wmic output
+    const drives = wmic.stdout
+      .split('\r\n')
+      .filter((line) => line.includes(':'))
+      .map((line) => line.trim().replaceAll(':', ''));
+
+    return drives.map((drive) => {
+      const isHomeDrive = drive == homeDrive;
+      return {
+        name: `local_disk_${drive}`,
+        root: `${drive}:\\`,
+        initialPath: isHomeDrive ? home : `${drive}:\\`
+      }
+    });
+  }
+}

package/src/helpers/download.ts

@@ -28,7 +28,7 @@ export class DownloadHelper {
     const webBody = Readable.toWeb(body);
 
     if (statusCode != 200) {
-      const textBody = await text(webBody)
+      const textBody = await text(webBody);
       const beginning = textBody.substring(0, Math.min(textBody.length, 1000));
 
       if (400 <= statusCode && statusCode < 500) {
@@ -37,9 +37,7 @@ export class DownloadHelper {
         );
       }
 
-      throw new Error(
-        `Http error: statusCode: ${statusCode} url: ${url.toString()}`
-      );
+      throw new Error(`Http error: statusCode: ${statusCode} url: ${url.toString()}`);
     }
 
     return {

package/src/index.ts

@@ -11,6 +11,7 @@ export * from './drivers/logs_stream';
 export * from './drivers/logs';
 export * from './drivers/download_url';
 export * from './drivers/ls';
+export * from './drivers/virtual_storages';
 export * from './drivers/helpers/helpers';
 export * from './drivers/helpers/polling_ops';