@milaboratories/pl-drivers 1.5.9 → 1.5.11

package/src/drivers/helpers/ls_storage_entry.ts

@@ -1,5 +1,6 @@
-import * as sdk from '@milaboratories/pl-model-common';
-import { bigintToResourceId, ResourceId, ResourceType } from '@milaboratories/pl-client';
+import type * as sdk from '@milaboratories/pl-model-common';
+import type { ResourceId, ResourceType } from '@milaboratories/pl-client';
+import { bigintToResourceId } from '@milaboratories/pl-client';
 import { assertNever } from '@milaboratories/ts-helpers';
 
 export type StorageHandleData = RemoteStorageHandleData | LocalStorageHandleData;
@@ -46,7 +47,7 @@ function parseLocalStorageHandle(handle: string): LocalStorageHandleData {
   return {
     rootPath: decodeURIComponent(path),
     name,
-    isRemote: false
+    isRemote: false,
   };
 }
 
@@ -64,7 +65,7 @@ export type RemoteStorageHandleData = {
 const remoteHandleRegex = /^remote:\/\/(?<name>.*)\/(?<resourceId>.*)$/;
 
 export function isRemoteStorageHandle(
-  handle: sdk.StorageHandle
+  handle: sdk.StorageHandle,
 ): handle is sdk.StorageHandleRemote {
   return remoteHandleRegex.test(handle);
 }
@@ -82,7 +83,7 @@ function parseRemoteStorageHandle(handle: string): RemoteStorageHandleData {
     id: bigintToResourceId(BigInt(resourceId)),
     type: storageType(name),
     name,
-    isRemote: true
+    isRemote: true,
   };
 }
 

package/src/drivers/logs.test.ts

@@ -1,6 +1,6 @@
 import { expect, test } from '@jest/globals';
 import { Computable } from '@milaboratories/computable';
-import {
+import type {
   AnyFieldRef,
   FieldId,
   FieldRef,
@@ -8,10 +8,11 @@ import {
   PlTransaction,
   ResourceId,
   ResourceRef,
-  ResourceType,
+  ResourceType } from '@milaboratories/pl-client';
+import {
   TestHelpers,
   jsonToData,
-  stringifyWithResourceId
+  stringifyWithResourceId,
 } from '@milaboratories/pl-client';
 import { SynchronizedTreeState } from '@milaboratories/pl-tree';
 import { ConsoleLoggerAdapter, HmacSha256Signer, notEmpty } from '@milaboratories/ts-helpers';
@@ -30,7 +31,7 @@ test('should get all logs', async () => {
 
     const tree = await SynchronizedTreeState.init(client, client.clientRoot, {
       stopPollingDelay: 10,
-      pollingInterval: 10
+      pollingInterval: 10,
     });
     const logsStream = new LogsStreamDriver(logger, createLogsClient(client, logger));
     const dir = await fsp.mkdtemp(path.join(os.tmpdir(), 'test-logs-1-'));
@@ -40,7 +41,7 @@ test('should get all logs', async () => {
       createLogsClient(client, logger),
       dir,
       new HmacSha256Signer(HmacSha256Signer.generateSecret()),
-      { cacheSoftSizeBytes: 700 * 1024, nConcurrentDownloads: 10 }
+      { cacheSoftSizeBytes: 700 * 1024, nConcurrentDownloads: 10 },
     );
     const logs = new LogsDriver(logger, logsStream, download);
 
@@ -75,7 +76,7 @@ test('should get last line with a prefix', async () => {
 
     const tree = await SynchronizedTreeState.init(client, client.clientRoot, {
       stopPollingDelay: 10,
-      pollingInterval: 10
+      pollingInterval: 10,
     });
     const logsStream = new LogsStreamDriver(logger, createLogsClient(client, logger));
     const dir = await fsp.mkdtemp(path.join(os.tmpdir(), 'test-logs-2-'));
@@ -85,7 +86,7 @@ test('should get last line with a prefix', async () => {
       createLogsClient(client, logger),
       dir,
       new HmacSha256Signer(HmacSha256Signer.generateSecret()),
-      { cacheSoftSizeBytes: 700 * 1024, nConcurrentDownloads: 10 }
+      { cacheSoftSizeBytes: 700 * 1024, nConcurrentDownloads: 10 },
     );
     const logs = new LogsDriver(logger, logsStream, download);
 
@@ -103,7 +104,7 @@ test('should get last line with a prefix', async () => {
 
     await createRunCommandWithStdoutStream(client, 'bash', [
       '-c',
-      'echo PREFIX1; echo PREFIX2; echo 3; sleep 0.1; echo PREFIX4'
+      'echo PREFIX1; echo PREFIX2; echo 3; sleep 0.1; echo PREFIX4',
     ]);
 
     while (true) {
@@ -125,7 +126,7 @@ test('should get log smart object and get log lines from that', async () => {
 
     const tree = await SynchronizedTreeState.init(client, client.clientRoot, {
       stopPollingDelay: 10,
-      pollingInterval: 10
+      pollingInterval: 10,
     });
     const logsStream = new LogsStreamDriver(logger, createLogsClient(client, logger));
     const dir = await fsp.mkdtemp(path.join(os.tmpdir(), 'test-logs-3-'));
@@ -135,7 +136,7 @@ test('should get log smart object and get log lines from that', async () => {
       createLogsClient(client, logger),
       dir,
       new HmacSha256Signer(HmacSha256Signer.generateSecret()),
-      { cacheSoftSizeBytes: 700 * 1024, nConcurrentDownloads: 10 }
+      { cacheSoftSizeBytes: 700 * 1024, nConcurrentDownloads: 10 },
     );
     const logs = new LogsDriver(logger, logsStream, download);
 
@@ -181,7 +182,7 @@ test('should get log smart object and get log lines from that', async () => {
 async function createRunCommandWithStdoutStream(
   client: PlClient,
   cmd: string,
-  args: string[]
+  args: string[],
 ): Promise<ResourceId> {
   return await client.withWriteTx('CreateRunCommandWithStreaming', async (tx: PlTransaction) => {
     const wdFId: FieldRef = createWd(tx);
@@ -192,7 +193,7 @@ async function createRunCommandWithStdoutStream(
 
     const dynamicId: FieldId = {
       resourceId: client.clientRoot,
-      fieldName: 'result'
+      fieldName: 'result',
     };
     tx.createField(dynamicId, 'Dynamic', streamManagerId);
 
@@ -211,18 +212,18 @@ function createRunCommand(
   tx: PlTransaction,
   wdFId: FieldRef,
   cmd: string,
-  args: string[]
+  args: string[],
 ): FieldRef {
   const refsId = tx.createStruct({ name: 'RunCommandRefs', version: '1' });
   tx.lock(refsId);
   const cmdData = {
     type: 'string',
-    value: cmd
+    value: cmd,
   };
   const argsData = args.map((arg) => {
     return {
       type: 'string',
-      value: arg
+      value: arg,
     };
   });
   const optsData = {
@@ -230,7 +231,7 @@ function createRunCommand(
     errorLines: 200,
     redirectStdout: 'logs.txt',
     redirectStderr: 'logs.txt',
-    envs: []
+    envs: [],
   };
 
   const runCmdId = tx.createEphemeral({ name: 'RunCommand/executor', version: '1' });
@@ -257,9 +258,9 @@ function createWdSave(tx: PlTransaction, workdirOut: FieldRef): FieldRef {
       {
         blobKey: 'logs.txt',
         type: 'file',
-        filePath: 'logs.txt'
-      }
-    ])
+        filePath: 'logs.txt',
+      },
+    ]),
   );
   tx.setField({ resourceId: wdSave, fieldName: 'workdirIn' }, workdirOut);
   tx.setField({ resourceId: wdSave, fieldName: 'rules' }, wdSaveRules);
@@ -271,7 +272,7 @@ function createDownloadableBlobFromStdout(tx: PlTransaction, blobsOut: FieldRef)
   const blobOut = tx.getFutureFieldValue(blobsOut, 'logs.txt', 'Input');
   const blobDownloadId = tx.createStruct({
     name: 'BlobDownload',
-    version: '2'
+    version: '2',
   });
   tx.setField({ resourceId: blobDownloadId, fieldName: 'blob' }, blobOut);
 
@@ -281,7 +282,7 @@ function createDownloadableBlobFromStdout(tx: PlTransaction, blobsOut: FieldRef)
 function createStreamManager(
   tx: PlTransaction,
   wdFId: FieldRef,
-  downloadableFId: AnyFieldRef
+  downloadableFId: AnyFieldRef,
 ): ResourceRef {
   const streamId = tx.createEphemeral({ name: 'CreateStream', version: '2' });
   tx.setField({ resourceId: streamId, fieldName: 'workdir' }, wdFId);
@@ -291,7 +292,7 @@ function createStreamManager(
 
   const streamManagerId = tx.createEphemeral({
     name: 'StreamManager',
-    version: '2'
+    version: '2',
   });
   tx.setField({ resourceId: streamManagerId, fieldName: 'downloadable' }, downloadableFId);
   tx.setField({ resourceId: streamManagerId, fieldName: 'stream' }, streamFId);

package/src/drivers/logs.ts

@@ -1,16 +1,17 @@
-import { Computable, ComputableCtx } from '@milaboratories/computable';
-import { PlTreeEntry, ResourceInfo } from '@milaboratories/pl-tree';
-import { LogsStreamDriver } from './logs_stream';
-import * as sdk from '@milaboratories/pl-model-common';
-import { MiLogger } from '@milaboratories/ts-helpers';
-import { DownloadDriver } from './download_blob';
+import type { ComputableCtx } from '@milaboratories/computable';
+import { Computable } from '@milaboratories/computable';
+import type { PlTreeEntry, ResourceInfo } from '@milaboratories/pl-tree';
+import type { LogsStreamDriver } from './logs_stream';
+import type * as sdk from '@milaboratories/pl-model-common';
+import type { MiLogger } from '@milaboratories/ts-helpers';
+import type { DownloadDriver } from './download_blob';
 import { isLiveLogHandle } from './helpers/logs_handle';
 
 export class LogsDriver implements sdk.LogsDriver {
   constructor(
     private readonly logger: MiLogger,
     private readonly logsStreamDriver: LogsStreamDriver,
-    private readonly downloadDriver: DownloadDriver
+    private readonly downloadDriver: DownloadDriver,
   ) {}
 
   /** Returns all logs and schedules a job that reads remain logs.
@@ -20,7 +21,7 @@ export class LogsDriver implements sdk.LogsDriver {
   getLastLogs(
     res: PlTreeEntry,
     lines: number,
-    ctx?: ComputableCtx
+    ctx?: ComputableCtx,
   ): Computable<string | undefined> | string | undefined {
     if (ctx === undefined) return Computable.make((ctx) => this.getLastLogs(res, lines, ctx));
 
@@ -50,7 +51,7 @@ export class LogsDriver implements sdk.LogsDriver {
   getProgressLog(
     res: PlTreeEntry,
     patternToSearch: string,
-    ctx?: ComputableCtx
+    ctx?: ComputableCtx,
   ): Computable<string | undefined> | string | undefined {
     if (ctx === undefined)
       return Computable.make((ctx) => this.getProgressLog(res, patternToSearch, ctx));
@@ -80,7 +81,7 @@ export class LogsDriver implements sdk.LogsDriver {
   getLogHandle(res: PlTreeEntry, ctx: ComputableCtx): sdk.AnyLogHandle | undefined;
   getLogHandle(
     res: PlTreeEntry,
-    ctx?: ComputableCtx
+    ctx?: ComputableCtx,
   ): Computable<sdk.AnyLogHandle | undefined> | sdk.AnyLogHandle | undefined {
     if (ctx === undefined) return Computable.make((ctx) => this.getLogHandle(res, ctx));
 
@@ -99,7 +100,7 @@ export class LogsDriver implements sdk.LogsDriver {
     handle: sdk.AnyLogHandle,
     lineCount: number,
     offsetBytes?: number,
-    searchStr?: string
+    searchStr?: string,
   ): Promise<sdk.StreamingApiResponse> {
     if (isLiveLogHandle(handle))
       return await this.logsStreamDriver.lastLines(handle, lineCount, offsetBytes, searchStr);
@@ -110,7 +111,7 @@ export class LogsDriver implements sdk.LogsDriver {
     handle: sdk.AnyLogHandle,
     lineCount: number,
     offsetBytes?: number,
-    searchStr?: string
+    searchStr?: string,
   ): Promise<sdk.StreamingApiResponse> {
     if (isLiveLogHandle(handle))
       return await this.logsStreamDriver.readText(handle, lineCount, offsetBytes, searchStr);

package/src/drivers/logs_stream.ts

@@ -1,25 +1,30 @@
+import type {
+  ComputableCtx,
+  Watcher,
+} from '@milaboratories/computable';
 import {
   ChangeSource,
   Computable,
-  ComputableCtx,
   PollingComputableHooks,
-  Watcher
 } from '@milaboratories/computable';
-import {
+import type {
   ResourceId,
+  ResourceType } from '@milaboratories/pl-client';
+import {
   resourceIdToString,
-  ResourceType,
-  stringifyWithResourceId
+  stringifyWithResourceId,
 } from '@milaboratories/pl-client';
-import { asyncPool, CallersCounter, MiLogger } from '@milaboratories/ts-helpers';
-import { ClientLogs } from '../clients/logs';
+import type { MiLogger } from '@milaboratories/ts-helpers';
+import { asyncPool, CallersCounter } from '@milaboratories/ts-helpers';
+import type { ClientLogs } from '../clients/logs';
 import { randomUUID } from 'node:crypto';
-import { PlTreeEntry, ResourceInfo, treeEntryToResourceInfo } from '@milaboratories/pl-tree';
+import type { PlTreeEntry, ResourceInfo } from '@milaboratories/pl-tree';
+import { treeEntryToResourceInfo } from '@milaboratories/pl-tree';
 import { scheduler } from 'node:timers/promises';
-import { StreamingAPI_Response } from '../proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol';
-import * as sdk from '@milaboratories/pl-model-common';
-import { PollingOps } from './helpers/polling_ops';
-import { RpcError } from '@protobuf-ts/runtime-rpc';
+import type { StreamingAPI_Response } from '../proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol';
+import type * as sdk from '@milaboratories/pl-model-common';
+import type { PollingOps } from './helpers/polling_ops';
+import type { RpcError } from '@protobuf-ts/runtime-rpc';
 import { getResourceInfoFromLogHandle, isLiveLogHandle, newLogHandle } from './helpers/logs_handle';
 import { WrongResourceTypeError } from './helpers/helpers';
 
@@ -44,14 +49,14 @@ export class LogsStreamDriver implements sdk.LogsDriver {
     private readonly opts: LogsStreamDriverOps = {
       nConcurrentGetLogs: 10,
       pollingInterval: 1000,
-      stopPollingDelay: 1000
-    }
+      stopPollingDelay: 1000,
+    },
   ) {
     this.hooks = new PollingComputableHooks(
       () => this.startUpdating(),
       () => this.stopUpdating(),
       { stopDebounce: opts.stopPollingDelay },
-      (resolve, reject) => this.scheduleOnNextState(resolve, reject)
+      (resolve, reject) => this.scheduleOnNextState(resolve, reject),
     );
   }
 
@@ -64,7 +69,7 @@ export class LogsStreamDriver implements sdk.LogsDriver {
   getLastLogs(
     res: ResourceInfo | PlTreeEntry,
     lines: number,
-    ctx?: ComputableCtx
+    ctx?: ComputableCtx,
   ): Computable<string | undefined> | string | undefined {
     if (ctx == undefined) return Computable.make((ctx) => this.getLastLogs(res, lines, ctx));
 
@@ -75,7 +80,7 @@ export class LogsStreamDriver implements sdk.LogsDriver {
 
     const result = this.getLastLogsNoCtx(ctx.watcher, r, lines, callerId);
     ctx.markUnstable(
-      'The logs are from stream, so we consider them unstable. Final values will be got from blobs.'
+      'The logs are from stream, so we consider them unstable. Final values will be got from blobs.',
     );
 
     return result;
@@ -85,7 +90,7 @@ export class LogsStreamDriver implements sdk.LogsDriver {
     w: Watcher,
     rInfo: ResourceInfo,
     lines: number,
-    callerId: string
+    callerId: string,
   ): string | undefined {
     validateResourceType('getLastLogs', rInfo.type);
 
@@ -119,7 +124,7 @@ export class LogsStreamDriver implements sdk.LogsDriver {
   getProgressLog(
     res: ResourceInfo | PlTreeEntry,
     patternToSearch: string,
-    ctx?: ComputableCtx
+    ctx?: ComputableCtx,
   ): Computable<string | undefined> | string | undefined {
     if (ctx == undefined)
       return Computable.make((ctx) => this.getProgressLog(res, patternToSearch, ctx));
@@ -131,7 +136,7 @@ export class LogsStreamDriver implements sdk.LogsDriver {
 
     const result = this.getProgressLogNoCtx(ctx.watcher, r, patternToSearch, callerId);
     ctx.markUnstable(
-      'The progress log is from the stream, so we consider it unstable. Final value will be got from blobs.'
+      'The progress log is from the stream, so we consider it unstable. Final value will be got from blobs.',
     );
 
     return result;
@@ -141,7 +146,7 @@ export class LogsStreamDriver implements sdk.LogsDriver {
     w: Watcher,
     rInfo: ResourceInfo,
     patternToSearch: string,
-    callerId: string
+    callerId: string,
   ): string | undefined {
     validateResourceType('getProgressLog', rInfo.type);
 
@@ -165,7 +170,7 @@ export class LogsStreamDriver implements sdk.LogsDriver {
   getLogHandle(res: ResourceInfo | PlTreeEntry, ctx: ComputableCtx): sdk.AnyLogHandle;
   getLogHandle(
     res: ResourceInfo | PlTreeEntry,
-    ctx?: ComputableCtx
+    ctx?: ComputableCtx,
   ): Computable<sdk.AnyLogHandle> | sdk.AnyLogHandle {
     if (ctx == undefined) return Computable.make((ctx) => this.getLogHandle(res, ctx));
 
@@ -190,15 +195,15 @@ export class LogsStreamDriver implements sdk.LogsDriver {
     handle: sdk.AnyLogHandle,
     lineCount: number,
     offsetBytes?: number,
-    searchStr?: string | undefined
+    searchStr?: string | undefined,
   ) {
     return await this.tryWithNotFound(handle, () =>
       this.clientLogs.lastLines(
         getResourceInfoFromLogHandle(handle),
         lineCount,
         BigInt(offsetBytes ?? 0),
-        searchStr
-      )
+        searchStr,
+      ),
     );
   }
 
@@ -206,21 +211,21 @@ export class LogsStreamDriver implements sdk.LogsDriver {
     handle: sdk.AnyLogHandle,
     lineCount: number,
     offsetBytes?: number,
-    searchStr?: string | undefined
+    searchStr?: string | undefined,
   ) {
     return await this.tryWithNotFound(handle, () =>
       this.clientLogs.readText(
         getResourceInfoFromLogHandle(handle),
         lineCount,
         BigInt(offsetBytes ?? 0),
-        searchStr
-      )
+        searchStr,
+      ),
     );
   }
 
   private async tryWithNotFound(
     handle: sdk.AnyLogHandle,
-    method: () => Promise<StreamingAPI_Response>
+    method: () => Promise<StreamingAPI_Response>,
   ): Promise<sdk.StreamingApiResponse> {
     if (!isLiveLogHandle(handle))
       throw new Error(`Not live log handle was passed to live log driver, handle: ${handle}`);
@@ -232,7 +237,7 @@ export class LogsStreamDriver implements sdk.LogsDriver {
         shouldUpdateHandle: false,
         data: resp.data,
         size: Number(resp.size),
-        newOffset: Number(resp.newOffset)
+        newOffset: Number(resp.newOffset),
       };
     } catch (e: any) {
       if (e.name == 'RpcError' && e.code == 'NOT_FOUND') {
@@ -286,7 +291,7 @@ export class LogsStreamDriver implements sdk.LogsDriver {
         const logs = this.getAllLogs();
         await asyncPool(
           this.opts.nConcurrentGetLogs,
-          logs.map((getter) => async () => await getter.update())
+          logs.map((getter) => async () => await getter.update()),
         );
 
         toNotify.forEach((n) => n.resolve());
@@ -322,7 +327,7 @@ class LogGetter {
     private readonly clientLogs: ClientLogs,
     private readonly rInfo: ResourceInfo,
     private readonly lines: number,
-    private readonly patternToSearch?: string
+    private readonly patternToSearch?: string,
   ) {}
 
   getLog(): {
@@ -331,7 +336,7 @@ class LogGetter {
   } {
     return {
       log: this.logs,
-      error: this.error
+      error: this.error,
     };
   }
 
@@ -350,7 +355,7 @@ class LogGetter {
         this.rInfo,
         this.lines,
         0n,
-        this.patternToSearch
+        this.patternToSearch,
       );
 
       const newLogs = resp.data.toString();
@@ -371,7 +376,7 @@ class LogGetter {
       }
 
       this.logger.error(
-        `Stream log lines for ${stringifyWithResourceId(this.rInfo.id)} failed, reason: ${e}`
+        `Stream log lines for ${stringifyWithResourceId(this.rInfo.id)} failed, reason: ${e}`,
       );
       throw e;
     }
@@ -386,8 +391,8 @@ type ScheduledRefresh = {
 function validateResourceType(methodName: string, rType: ResourceType) {
   if (!rType.name.startsWith('StreamWorkdir')) {
     throw new WrongResourceTypeError(
-      `${methodName}: wrong resource type: ${rType.name}, ` +
-        `expected: a resource of type 'StreamWorkdir'.`
+      `${methodName}: wrong resource type: ${rType.name}, `
+      + `expected: a resource of type 'StreamWorkdir'.`,
     );
   }
 }

package/src/drivers/ls.test.ts

@@ -91,7 +91,7 @@ test('should ok when list files from local storage in ls driver and correctly ap
       client,
       signer,
       [{ storageId: 'test_storage', localPath: path.join(assetsPath, 'ls_dir_structure_test') }],
-      async () => [dialogRet]
+      async () => [dialogRet],
     );
 
     const storages = await driver.getStorageList();
@@ -128,7 +128,7 @@ test('should ok when get file using local dialog, and read its content', async (
   const logger = new ConsoleLoggerAdapter();
   await TestHelpers.withTempRoot(async (client) => {
     const driver = await LsDriver.init(logger, client, signer, [], async () => [
-      path.join(assetsPath, 'answer_to_the_ultimate_question.txt')
+      path.join(assetsPath, 'answer_to_the_ultimate_question.txt'),
     ]);
 
     const result = await driver.showOpenSingleFileDialog();