@milaboratories/pl-middle-layer 1.37.4 → 1.37.5

package/dist/mutator/context_export.d.ts

@@ -1,9 +1,9 @@
-import { AnyRef, PlTransaction } from '@milaboratories/pl-client';
+import { AnyRef, PlTransaction, FieldRef } from '@milaboratories/pl-client';
 import { TemplateSpecPrepared } from '../model/template_spec';
 export type TemplateEnvelop = {
     spec: TemplateSpecPrepared;
     hash: string;
 };
 export declare function getPreparedExportTemplateEnvelope(): Promise<TemplateEnvelop>;
-export declare function exportContext(tx: PlTransaction, exportTpl: AnyRef, ctx: AnyRef): AnyRef;
+export declare function exportContext(tx: PlTransaction, exportTpl: AnyRef, ctx: AnyRef): FieldRef;
 //# sourceMappingURL=context_export.d.ts.map

package/dist/mutator/context_export.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"context_export.d.ts","sourceRoot":"","sources":["../../src/mutator/context_export.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAGvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAWnE,MAAM,MAAM,eAAe,GAAG;IAAE,IAAI,EAAE,oBAAoB,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAI3E,wBAAsB,iCAAiC,IAAI,OAAO,CAAC,eAAe,CAAC,CAUlF;AAED,wBAAgB,aAAa,CAAC,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,UAE9E"}
+{"version":3,"file":"context_export.d.ts","sourceRoot":"","sources":["../../src/mutator/context_export.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAGvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAWnE,MAAM,MAAM,eAAe,GAAG;IAAE,IAAI,EAAE,oBAAoB,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAI3E,wBAAsB,iCAAiC,IAAI,OAAO,CAAC,eAAe,CAAC,CAUlF;AAED,wBAAgB,aAAa,CAAC,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gDAE9E"}

package/dist/mutator/template/render_template.d.ts

@@ -1,4 +1,4 @@
-import { AnyRef, PlTransaction, Pl } from '@milaboratories/pl-client';
+import { AnyRef, FieldRef, PlTransaction, Pl } from '@milaboratories/pl-client';
 /**
  * Creates render template operation, for a given remplate and inputs.
  *
@@ -8,5 +8,5 @@ import { AnyRef, PlTransaction, Pl } from '@milaboratories/pl-client';
  * @param inputs map of inputs pointing to other resources or fields
  * @param outputNames names of the outputs to collect and return from this method
  */
-export declare function createRenderTemplate<O extends string>(tx: PlTransaction, tpl: AnyRef, ephemeral: boolean, inputs: Pl.PlRecord, outputNames: O[]): Record<O, AnyRef>;
+export declare function createRenderTemplate<O extends string>(tx: PlTransaction, tpl: AnyRef, ephemeral: boolean, inputs: Pl.PlRecord, outputNames: O[]): Record<O, FieldRef>;
 //# sourceMappingURL=render_template.d.ts.map

package/dist/mutator/template/render_template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"render_template.d.ts","sourceRoot":"","sources":["../../../src/mutator/template/render_template.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,EAAS,EAAE,EAAE,MAAM,2BAA2B,CAAC;AAYtD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,MAAM,EACnD,EAAE,EAAE,aAAa,EACjB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,OAAO,EAClB,MAAM,EAAE,EAAE,CAAC,QAAQ,EACnB,WAAW,EAAE,CAAC,EAAE,GACf,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAYnB"}
+{"version":3,"file":"render_template.d.ts","sourceRoot":"","sources":["../../../src/mutator/template/render_template.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACjF,OAAO,EAAS,EAAE,EAAE,MAAM,2BAA2B,CAAC;AAYtD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,MAAM,EACnD,EAAE,EAAE,aAAa,EACjB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,OAAO,EAClB,MAAM,EAAE,EAAE,CAAC,QAAQ,EACnB,WAAW,EAAE,CAAC,EAAE,GACf,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAYrB"}

package/dist/network_check/network_check.d.ts

@@ -0,0 +1,40 @@
+import { PlClientConfig, PlClient } from '@milaboratories/pl-client';
+import { MiLogger } from '@milaboratories/ts-helpers';
+import { ClientDownload, ClientUpload, LsDriver } from '@milaboratories/pl-drivers';
+import { Dispatcher } from 'undici';
+export interface CheckNetworkOpts {
+    /** Platforma Backend pings options. */
+    pingCheckDurationMs: number;
+    pingTimeoutMs: number;
+    maxPingsPerSecond: number;
+    /** An options for CDN and block registry. */
+    httpTimeoutMs: number;
+    /** Block registry pings options. */
+    blockRegistryDurationMs: number;
+    maxRegistryChecksPerSecond: number;
+    blockRegistryUrl: string;
+    blockGARegistryUrl: string;
+    blockOverviewPath: string;
+    blockUiPath: string;
+    /** CDN for auto-update pings options. */
+    autoUpdateCdnDurationMs: number;
+    maxAutoUpdateCdnChecksPerSecond: number;
+    autoUpdateCdnUrl: string;
+    bodyLimit: number;
+}
+/** Checks connectivity to Platforma Backend, to block registry
+ * and to auto-update CDN,
+ * and generates a string report. */
+export declare function checkNetwork(plCredentials: string, plUser: string | undefined, plPassword: string | undefined, optsOverrides?: Partial<CheckNetworkOpts>): Promise<string>;
+export declare function initNetworkCheck(plCredentials: string, plUser: string | undefined, plPassword: string | undefined, optsOverrides?: Partial<CheckNetworkOpts>): Promise<{
+    logger: MiLogger;
+    plConfig: PlClientConfig;
+    client: PlClient;
+    downloadClient: ClientDownload;
+    uploadBlobClient: ClientUpload;
+    lsDriver: LsDriver;
+    httpClient: Dispatcher;
+    ops: CheckNetworkOpts;
+    terminate: () => Promise<void>;
+}>;
+//# sourceMappingURL=network_check.d.ts.map

package/dist/network_check/network_check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network_check.d.ts","sourceRoot":"","sources":["../../src/network_check/network_check.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAmB,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACjF,OAAO,EAAE,QAAQ,EAA8C,MAAM,2BAA2B,CAAC;AACjG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAG3D,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAgD,MAAM,4BAA4B,CAAC;AAGpG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAsBzC,MAAM,WAAW,gBAAgB;IAC/B,uCAAuC;IACvC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAE1B,6CAA6C;IAC7C,aAAa,EAAE,MAAM,CAAC;IAEtB,oCAAoC;IACpC,uBAAuB,EAAE,MAAM,CAAC;IAChC,0BAA0B,EAAE,MAAM,CAAC;IACnC,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IAEpB,yCAAyC;IACzC,uBAAuB,EAAE,MAAM,CAAC;IAChC,+BAA+B,EAAE,MAAM,CAAC;IACxC,gBAAgB,EAAE,MAAM,CAAC;IAEzB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;oCAEoC;AACpC,wBAAsB,YAAY,CAChC,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,aAAa,GAAE,OAAO,CAAC,gBAAgB,CAAM,GAC5C,OAAO,CAAC,MAAM,CAAC,CA6DjB;AAED,wBAAsB,gBAAgB,CACpC,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,aAAa,GAAE,OAAO,CAAC,gBAAgB,CAAM,GAC5C,OAAO,CAAC;IACP,MAAM,EAAE,QAAQ,CAAC;IACjB,QAAQ,EAAE,cAAc,CAAC;IACzB,MAAM,EAAE,QAAQ,CAAC;IACjB,cAAc,EAAE,cAAc,CAAC;IAC/B,gBAAgB,EAAE,YAAY,CAAC;IAC/B,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,GAAG,EAAE,gBAAgB,CAAC;IACtB,SAAS,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC,CAAC,CA2FH"}

package/dist/network_check/network_check.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network_check.test.d.ts","sourceRoot":"","sources":["../../src/network_check/network_check.test.ts"],"names":[],"mappings":""}

package/dist/network_check/pings.d.ts

@@ -0,0 +1,32 @@
+import { ValueOrError } from '@milaboratories/ts-helpers';
+import { Dispatcher } from 'undici';
+import { CheckNetworkOpts } from './network_check';
+import { PlClientConfig } from '@milaboratories/pl-client';
+/** A report about one concrete ping to the service. */
+export interface NetworkReport<T> {
+    elapsedMs: number;
+    response: ValueOrError<T>;
+}
+export type HttpNetworkReport = NetworkReport<{
+    statusCode: number;
+    beginningOfBody: string;
+}>;
+export declare function backendPings(ops: CheckNetworkOpts, plConfig: PlClientConfig): Promise<NetworkReport<string>[]>;
+export declare function blockRegistryOverviewPings(ops: CheckNetworkOpts, httpClient: Dispatcher): Promise<HttpNetworkReport[]>;
+export declare function blockGARegistryOverviewPings(ops: CheckNetworkOpts, httpClient: Dispatcher): Promise<HttpNetworkReport[]>;
+export declare function blockRegistryUiPings(ops: CheckNetworkOpts, httpClient: Dispatcher): Promise<HttpNetworkReport[]>;
+export declare function blockGARegistryUiPings(ops: CheckNetworkOpts, httpClient: Dispatcher): Promise<HttpNetworkReport[]>;
+export declare function autoUpdateCdnPings(ops: CheckNetworkOpts, httpClient: Dispatcher): Promise<HttpNetworkReport[]>;
+/** Executes a body several times per second up to the given duration,
+ * and returns results and elapsed time for every result. */
+export declare function recordPings<T>(pingCheckDurationMs: number, maxPingsPerSecond: number, body: () => Promise<T>): Promise<NetworkReport<T>[]>;
+export declare function requestUrl(url: string | URL, ops: CheckNetworkOpts, httpClient: Dispatcher): Promise<{
+    statusCode: number;
+    beginningOfBody: string;
+}>;
+export declare function elapsed(startMs: number): number;
+export declare function reportToString<T>(report: NetworkReport<T>[]): {
+    ok: boolean;
+    details: string;
+};
+//# sourceMappingURL=pings.d.ts.map

package/dist/network_check/pings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pings.d.ts","sourceRoot":"","sources":["../../src/network_check/pings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAG/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAA2B,KAAK,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAEzF,uDAAuD;AACvD,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;CAC3B;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC;IAC5C,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC,CAAC;AAEH,wBAAsB,YAAY,CAAC,GAAG,EAAE,gBAAgB,EAAE,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,CAMpH;AAED,wBAAsB,0BAA0B,CAAC,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAO5H;AAED,wBAAsB,4BAA4B,CAAC,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAM9H;AAED,wBAAsB,oBAAoB,CAAC,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAMtH;AAED,wBAAsB,sBAAsB,CAAC,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAMxH;AAED,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAMpH;AAED;4DAC4D;AAC5D,wBAAsB,WAAW,CAAC,CAAC,EACjC,mBAAmB,EAAE,MAAM,EAC3B,iBAAiB,EAAE,MAAM,EACzB,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GACrB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CA2B7B;AAED,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU;;;GAYhG;AAED,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG;IAC7D,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACjB,CAiBA"}

package/dist/network_check/template.d.ts

@@ -0,0 +1,33 @@
+import { PlClient } from '@milaboratories/pl-client';
+import { ClientDownload, LsDriver, ClientUpload } from '@milaboratories/pl-drivers';
+import { MiLogger } from '@milaboratories/ts-helpers';
+import { ResourceInfo } from '@milaboratories/pl-tree';
+export interface TemplateReport {
+    ok: boolean;
+    message: string;
+}
+/** Uploads `hello-world` template and checks the output is correct. */
+export declare function uploadTemplate(logger: MiLogger, pl: PlClient, name: string): Promise<TemplateReport>;
+export declare function runUploadTemplate(logger: MiLogger, pl: PlClient, name: string): Promise<string>;
+/** Uploads a file to the backend and checks the output is a Blob resource. */
+export declare function uploadFile(logger: MiLogger, lsDriver: LsDriver, uploadClient: ClientUpload, pl: PlClient, filePath: string): Promise<TemplateReport>;
+export declare function runUploadFile(logger: MiLogger, lsDriver: LsDriver, uploadClient: ClientUpload, pl: PlClient, filePath: string): Promise<ResourceInfo>;
+/** Uploads a file to the backend and then tries to download it back. */
+export declare function downloadFile(logger: MiLogger, pl: PlClient, lsDriver: LsDriver, uploadClient: ClientUpload, downloadClient: ClientDownload, filePath: string, fileContent: string): Promise<TemplateReport>;
+export declare function runDownloadFile(logger: MiLogger, pl: PlClient, lsDriver: LsDriver, uploadClient: ClientUpload, downloadClient: ClientDownload, filePath: string): Promise<string>;
+/** Runs Go's hello-world binary. */
+export declare function softwareCheck(pl: PlClient): Promise<TemplateReport>;
+export declare function runSoftware(pl: PlClient): Promise<string>;
+/** Runs Python hello-world. */
+export declare function pythonSoftware(pl: PlClient, name: string): Promise<TemplateReport>;
+export declare function runPythonSoftware(pl: PlClient, name: string): Promise<string>;
+/** Creates a big temporary file with random content. */
+export declare function createBigTempFile(): Promise<{
+    filePath: string;
+}>;
+/** Creates a temporarly file we could use for uploading and downloading. */
+export declare function createTempFile(): Promise<{
+    filePath: string;
+    fileContent: string;
+}>;
+//# sourceMappingURL=template.d.ts.map

package/dist/network_check/template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../src/network_check/template.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAqB,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAM3F,OAAO,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,EAA0C,KAAK,YAAY,EAAE,MAAM,4BAA4B,CAAC;AACvG,OAAO,EAAY,KAAK,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAO5D,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,uEAAuE;AACvE,wBAAsB,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAW1G;AAED,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,QAAQ,EAChB,EAAE,EAAE,QAAQ,EACZ,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,CAAC,CAgBjB;AAED,8EAA8E;AAC9E,wBAAsB,UAAU,CAC9B,MAAM,EAAE,QAAQ,EAChB,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,YAAY,EAC1B,EAAE,EAAE,QAAQ,EACZ,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,cAAc,CAAC,CAYzB;AAED,wBAAsB,aAAa,CACjC,MAAM,EAAE,QAAQ,EAChB,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,YAAY,EAC1B,EAAE,EAAE,QAAQ,EACZ,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,YAAY,CAAC,CAiCvB;AAED,wEAAwE;AACxE,wBAAsB,YAAY,CAChC,MAAM,EAAE,QAAQ,EAChB,EAAE,EAAE,QAAQ,EACZ,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,YAAY,EAC1B,cAAc,EAAE,cAAc,EAC9B,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,cAAc,CAAC,CAWzB;AAED,wBAAsB,eAAe,CACnC,MAAM,EAAE,QAAQ,EAChB,EAAE,EAAE,QAAQ,EACZ,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,YAAY,EAC1B,cAAc,EAAE,cAAc,EAC9B,QAAQ,EAAE,MAAM,mBAoCjB;AAED,oCAAoC;AACpC,wBAAsB,aAAa,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,CAWzE;AAED,wBAAsB,WAAW,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAc/D;AAED,+BAA+B;AAC/B,wBAAsB,cAAc,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAWxF;AAED,wBAAsB,iBAAiB,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAcnF;AAED,wDAAwD;AACxD,wBAAsB,iBAAiB,IAAI,OAAO,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CASvE;AAED,4EAA4E;AAC5E,wBAAsB,cAAc,IAAI,OAAO,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC,CAOzF"}

package/dist/network_check/template.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=template.test.d.ts.map

package/dist/network_check/template.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.test.d.ts","sourceRoot":"","sources":["../../src/network_check/template.test.ts"],"names":[],"mappings":""}

package/dist/network_check/test_utils.d.ts

@@ -0,0 +1,6 @@
+export declare function testCredentials(): {
+    plEndpoint: string;
+    plUser: string | undefined;
+    plPassword: string | undefined;
+};
+//# sourceMappingURL=test_utils.d.ts.map

package/dist/network_check/test_utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test_utils.d.ts","sourceRoot":"","sources":["../../src/network_check/test_utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,eAAe;;;;EAQ9B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-middle-layer",
-  "version": "1.37.4",
+  "version": "1.37.5",
   "description": "Pl Middle Layer",
   "engines": {
     "node": ">=20.16.0"
@@ -33,21 +33,21 @@
     "zod": "~3.23.8",
     "remeda": "^2.21.2",
     "@milaboratories/pl-http": "^1.1.2",
-    "@milaboratories/resolve-helper": "^1.1.0",
-    "@milaboratories/pl-drivers": "^1.5.50",
     "@milaboratories/computable": "^2.4.7",
     "@platforma-sdk/block-tools": "^2.5.44",
     "@milaboratories/pl-client": "^2.9.0",
-    "@milaboratories/pl-model-common": "^1.14.0",
+    "@milaboratories/pl-drivers": "^1.5.51",
     "@milaboratories/pl-model-middle-layer": "^1.7.29",
+    "@milaboratories/pl-model-common": "^1.14.0",
     "@milaboratories/pl-model-backend": "^1.1.0",
+    "@milaboratories/resolve-helper": "^1.1.0",
     "@platforma-sdk/model": "^1.30.3",
-    "@milaboratories/ts-helpers": "^1.2.0",
     "@milaboratories/pl-tree": "^1.6.0",
+    "@milaboratories/ts-helpers": "^1.2.0",
+    "@platforma-sdk/workflow-tengo": "4.2.1",
     "@milaboratories/pl-config": "^1.4.9",
-    "@platforma-sdk/workflow-tengo": "4.2.0",
-    "@milaboratories/pl-deployments": "^2.1.2",
-    "@milaboratories/pl-errors": "^1.0.9"
+    "@milaboratories/pl-errors": "^1.0.9",
+    "@milaboratories/pl-deployments": "^2.1.2"
   },
   "devDependencies": {
     "semver": "^7.6.3",
@@ -60,8 +60,8 @@
     "jest": "^29.7.0",
     "@jest/globals": "^29.7.0",
     "ts-jest": "^29.2.6",
-    "@milaboratories/eslint-config": "^1.0.4",
-    "@milaboratories/platforma-build-configs": "1.0.3"
+    "@milaboratories/platforma-build-configs": "1.0.3",
+    "@milaboratories/eslint-config": "^1.0.4"
   },
   "scripts": {
     "type-check": "tsc --noEmit --composite false",

package/src/index.ts

@@ -6,7 +6,7 @@ export * from './block_registry';
 export * from './middle_layer';
 export * from './model';
 
-export * from './network_check';
+export * from './network_check/network_check';
 
 // explicitly override ProjectListEntry from SDK
 export { type ProjectListEntry } from './model';

package/src/mutator/template/render_template.ts

@@ -1,4 +1,4 @@
-import type { AnyRef, PlTransaction } from '@milaboratories/pl-client';
+import type { AnyRef, FieldRef, PlTransaction } from '@milaboratories/pl-client';
 import { field, Pl } from '@milaboratories/pl-client';
 import type { ResourceType } from '@platforma-sdk/model';
 
@@ -26,7 +26,7 @@ export function createRenderTemplate<O extends string>(
   ephemeral: boolean,
   inputs: Pl.PlRecord,
   outputNames: O[],
-): Record<O, AnyRef> {
+): Record<O, FieldRef> {
   if (outputNames.length === 0) throw new Error('Zero output names provided');
   const rId = ephemeral ? tx.createEphemeral(EphRenderTemplate) : tx.createStruct(RenderTemplate);
 

package/src/{network_check.test.ts → network_check/network_check.test.ts}

@@ -1,10 +1,10 @@
 import { checkNetwork } from './network_check';
+import { testCredentials } from './test_utils';
 
 // it's too long, enable only when you need to see the report.
 test.skip('should return network connectivity report for a platform endpoint set in PL_ADDRESS env', async () => {
-  expect(process.env.PL_ADDRESS).not.toBeUndefined();
+  const { plEndpoint, plUser, plPassword } = testCredentials();
 
-  const plEndpoint = process.env.PL_ADDRESS!;
-  const report = await checkNetwork(plEndpoint);
+  const report = await checkNetwork(plEndpoint, plUser, plPassword);
   console.log(report);
 }, 80000);

package/src/network_check/network_check.ts

@@ -0,0 +1,369 @@
+/** A utility to check network problems and gather statistics.
+ * It's useful when we cannot connect to the server of a company
+ * because of security reasons,
+ * but they can send us and their DevOps team this report.
+ *
+ * What we check:
+ * - pings to backend
+ * - block registry for block overview and ui.
+ * - autoupdate CDN.
+ * - upload workflow to backend (workflow part via our API).
+ * - the desktop could do multipart upload.
+ * - the desktop could download files from S3.
+ * - backend could download software and run it.
+ * - backend could run python software.
+ * TODO:
+ * - try to get something from backend's library storage.
+ *
+ * We don't check backend access to S3 storage, it is checked on the start of backend.
+ */
+
+import type { AuthInformation, PlClientConfig } from '@milaboratories/pl-client';
+import { PlClient, UnauthenticatedPlClient, plAddressToConfig } from '@milaboratories/pl-client';
+import type { MiLogger } from '@milaboratories/ts-helpers';
+import { ConsoleLoggerAdapter, HmacSha256Signer } from '@milaboratories/ts-helpers';
+import { channel } from 'node:diagnostics_channel';
+import type { ClientDownload, ClientUpload } from '@milaboratories/pl-drivers';
+import { LsDriver, createDownloadClient, createUploadBlobClient } from '@milaboratories/pl-drivers';
+import type { HttpNetworkReport, NetworkReport } from './pings';
+import { autoUpdateCdnPings, backendPings, blockGARegistryOverviewPings, blockGARegistryUiPings, blockRegistryOverviewPings, blockRegistryUiPings, reportToString } from './pings';
+import type { Dispatcher } from 'undici';
+import type { TemplateReport } from './template';
+import { uploadTemplate, uploadFile, downloadFile, createTempFile, pythonSoftware, softwareCheck, createBigTempFile } from './template';
+
+/** All reports we need to collect. */
+interface NetworkReports {
+  plPings: NetworkReport<string>[];
+
+  blockRegistryOverviewChecks: HttpNetworkReport[];
+  blockGARegistryOverviewChecks: HttpNetworkReport[];
+  blockRegistryUiChecks: HttpNetworkReport[];
+  blockGARegistryUiChecks: HttpNetworkReport[];
+
+  autoUpdateCdnChecks: HttpNetworkReport[];
+
+  uploadTemplateCheck: TemplateReport;
+  uploadFileCheck: TemplateReport;
+  downloadFileCheck: TemplateReport;
+  softwareCheck: TemplateReport;
+  pythonSoftwareCheck: TemplateReport;
+}
+
+export interface CheckNetworkOpts {
+  /** Platforma Backend pings options. */
+  pingCheckDurationMs: number;
+  pingTimeoutMs: number;
+  maxPingsPerSecond: number;
+
+  /** An options for CDN and block registry. */
+  httpTimeoutMs: number;
+
+  /** Block registry pings options. */
+  blockRegistryDurationMs: number;
+  maxRegistryChecksPerSecond: number;
+  blockRegistryUrl: string;
+  blockGARegistryUrl: string;
+  blockOverviewPath: string;
+  blockUiPath: string;
+
+  /** CDN for auto-update pings options. */
+  autoUpdateCdnDurationMs: number;
+  maxAutoUpdateCdnChecksPerSecond: number;
+  autoUpdateCdnUrl: string;
+
+  bodyLimit: number;
+}
+
+/** Checks connectivity to Platforma Backend, to block registry
+ * and to auto-update CDN,
+ * and generates a string report. */
+export async function checkNetwork(
+  plCredentials: string,
+  plUser: string | undefined,
+  plPassword: string | undefined,
+  optsOverrides: Partial<CheckNetworkOpts> = {},
+): Promise<string> {
+  const undiciLogs: any[] = [];
+  // Subscribe to all Undici diagnostic events
+  undiciEvents.forEach((event) => {
+    const diagnosticChannel = channel(event);
+    diagnosticChannel.subscribe((message: any) => {
+      const timestamp = new Date().toISOString();
+      const data = { ...message };
+      if (data?.response?.headers) {
+        data.response = { ...data.response };
+        data.response.headers = data.response.headers.slice();
+        data.response.headers = data.response.headers.map((h: any) => h.toString());
+      }
+
+      // we try to upload big files, don't include the buffer in the report.
+      if (data?.request?.body) {
+        data.request = { ...data.request };
+        data.request.body = `too big`;
+      }
+
+      undiciLogs.push(
+        JSON.stringify({
+          timestamp,
+          event,
+          data,
+        }),
+      );
+    });
+  });
+
+  const {
+    logger,
+    plConfig,
+    client,
+    downloadClient,
+    uploadBlobClient,
+    lsDriver,
+    httpClient,
+    ops,
+  } = await initNetworkCheck(plCredentials, plUser, plPassword, optsOverrides);
+
+  const { filePath: filePathToDownload, fileContent: fileContentToDownload } = await createTempFile();
+  const { filePath: filePathToUpload } = await createBigTempFile();
+
+  const report: NetworkReports = {
+    plPings: await backendPings(ops, plConfig),
+    blockRegistryOverviewChecks: await blockRegistryOverviewPings(ops, httpClient),
+    blockGARegistryOverviewChecks: await blockGARegistryOverviewPings(ops, httpClient),
+    blockRegistryUiChecks: await blockRegistryUiPings(ops, httpClient),
+    blockGARegistryUiChecks: await blockGARegistryUiPings(ops, httpClient),
+
+    autoUpdateCdnChecks: await autoUpdateCdnPings(ops, httpClient),
+
+    uploadTemplateCheck: await uploadTemplate(logger, client, 'Jack'),
+    uploadFileCheck: await uploadFile(logger, lsDriver, uploadBlobClient, client, filePathToUpload),
+    downloadFileCheck: await downloadFile(logger, client, lsDriver, uploadBlobClient, downloadClient, filePathToDownload, fileContentToDownload),
+    softwareCheck: await softwareCheck(client),
+    pythonSoftwareCheck: await pythonSoftware(client, 'Jack'),
+  };
+
+  return reportsToString(report, plCredentials, ops, undiciLogs);
+}
+
+export async function initNetworkCheck(
+  plCredentials: string,
+  plUser: string | undefined,
+  plPassword: string | undefined,
+  optsOverrides: Partial<CheckNetworkOpts> = {},
+): Promise<{
+    logger: MiLogger;
+    plConfig: PlClientConfig;
+    client: PlClient;
+    downloadClient: ClientDownload;
+    uploadBlobClient: ClientUpload;
+    lsDriver: LsDriver;
+    httpClient: Dispatcher;
+    ops: CheckNetworkOpts;
+    terminate: () => Promise<void>;
+  }> {
+  const ops: CheckNetworkOpts = {
+    pingCheckDurationMs: 10000,
+    pingTimeoutMs: 3000,
+    maxPingsPerSecond: 50,
+
+    httpTimeoutMs: 3000,
+
+    blockRegistryDurationMs: 3000,
+    maxRegistryChecksPerSecond: 1,
+
+    blockRegistryUrl: 'https://blocks.pl-open.science',
+    blockGARegistryUrl: 'https://blocks-ga.pl-open.science',
+    blockOverviewPath: 'v2/overview.json',
+    blockUiPath: 'v2/milaboratories/samples-and-data/1.7.0/ui.tgz',
+
+    autoUpdateCdnDurationMs: 5000,
+    maxAutoUpdateCdnChecksPerSecond: 1,
+    autoUpdateCdnUrl:
+      'https://cdn.platforma.bio/software/platforma-desktop-v2/windows/amd64/latest.yml',
+
+    bodyLimit: 300,
+
+    ...optsOverrides,
+  };
+
+  const plConfig = plAddressToConfig(plCredentials, {
+    defaultRequestTimeout: ops.pingTimeoutMs,
+  });
+
+  // exposing alternative root for fields not to interfere with
+  // projects of the user.
+  plConfig.alternativeRoot = `check_network_${Date.now()}`;
+
+  const uaClient = new UnauthenticatedPlClient(plConfig);
+
+  let auth: AuthInformation = {};
+  if (plUser && plPassword) {
+    auth = await uaClient.login(plUser, plPassword);
+  }
+
+  const client = await PlClient.init(plCredentials, { authInformation: auth });
+
+  const httpClient = uaClient.ll.httpDispatcher;
+  const logger = new ConsoleLoggerAdapter();
+
+  // FIXME: do we need to get an actual secret?
+  const signer = new HmacSha256Signer('localSecret');
+
+  // We could initialize middle-layer here, but for now it seems like an overkill.
+  // Here's the code to do it:
+  //
+  // const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'platforma-network-check-'));
+  // const ml = await MiddleLayer.init(client, tmpDir, {
+  //   logger,
+  //   localSecret: '',
+  //   localProjections: [],
+  //   openFileDialogCallback: () => Promise.resolve([]),
+  //   preferredUpdateChannel: 'stable',
+  // });
+
+  const downloadClient = createDownloadClient(logger, client, []);
+  const uploadBlobClient = createUploadBlobClient(client, logger);
+
+  const lsDriver = await LsDriver.init(
+    logger,
+    client,
+    signer,
+    [],
+    () => Promise.resolve([]),
+    [],
+  );
+
+  const terminate = async () => {
+    downloadClient.close();
+    uploadBlobClient.close();
+    await httpClient.close();
+    await client.close();
+  };
+
+  return {
+    logger,
+    plConfig,
+    client,
+    downloadClient,
+    uploadBlobClient,
+    lsDriver,
+    httpClient,
+    ops,
+    terminate,
+  };
+}
+
+function reportsToString(
+  report: NetworkReports,
+  plEndpoint: string,
+  opts: CheckNetworkOpts,
+  undiciLogs: any[],
+): string {
+  const successPings = report.plPings.filter((p) => p.response.ok);
+  const failedPings = report.plPings.filter((p) => !p.response.ok);
+  const successPingsBodies = [
+    ...new Set(successPings.map((p) => JSON.stringify((p.response as any).value))),
+  ];
+
+  const pings = reportToString(report.plPings);
+  const blockRegistryOverview = reportToString(report.blockRegistryOverviewChecks);
+  const blockGARegistryOverview = reportToString(report.blockGARegistryOverviewChecks);
+  const blockRegistryUi = reportToString(report.blockRegistryUiChecks);
+  const blockGARegistryUi = reportToString(report.blockGARegistryUiChecks);
+  const autoUpdateCdn = reportToString(report.autoUpdateCdnChecks);
+
+  const summary = (ok: boolean) => ok ? 'OK' : 'FAILED';
+
+  return `
+Network report:
+pl endpoint: ${plEndpoint};
+
+summary:
+${summary(pings.ok)} pings to Platforma Backend
+${summary(blockRegistryOverview.ok)} block registry overview
+${summary(blockGARegistryOverview.ok)} block ga registry overview
+${summary(blockRegistryUi.ok)} block registry ui
+${summary(blockGARegistryUi.ok)} block ga registry ui
+${summary(autoUpdateCdn.ok)} auto-update CDN
+${summary(report.uploadTemplateCheck.ok)} upload template
+${summary(report.uploadFileCheck.ok)} upload file
+${summary(report.downloadFileCheck.ok)} download file
+${summary(report.softwareCheck.ok)} software check
+${summary(report.pythonSoftwareCheck.ok)} python software check
+
+details:
+options: ${JSON.stringify(opts, null, 2)}.
+
+Upload template response: ${report.uploadTemplateCheck.message}
+
+Upload file response: ${report.uploadFileCheck.message}
+
+Download file response: ${report.downloadFileCheck.message}
+
+Software check response: ${report.softwareCheck.message}
+Python software check response: ${report.pythonSoftwareCheck.message}
+Platforma pings: ${pings.details}
+
+Block registry overview responses: ${blockRegistryOverview.details}
+
+Block ga registry overview responses: ${blockGARegistryOverview.details}
+
+Block registry ui responses: ${blockRegistryUi.details}
+
+Block ga registry ui responses: ${blockGARegistryUi.details}
+
+Auto-update CDN responses: ${autoUpdateCdn.details}
+
+dumps:
+Block registry overview dumps:
+${JSON.stringify(report.blockRegistryOverviewChecks, null, 2)}
+
+Block ga registry overview dumps:
+${JSON.stringify(report.blockGARegistryOverviewChecks, null, 2)}
+
+Block registry ui dumps:
+${JSON.stringify(report.blockRegistryUiChecks, null, 2)}
+
+Block ga registry ui dumps:
+${JSON.stringify(report.blockGARegistryUiChecks, null, 2)}
+
+Auto-update CDN dumps:
+${JSON.stringify(report.autoUpdateCdnChecks, null, 2)}
+
+Platforma pings error dumps:
+${JSON.stringify(failedPings, null, 2)}
+
+Platforma pings success dump examples:
+${JSON.stringify(successPingsBodies, null, 2)}
+
+Undici logs:
+${undiciLogs.join('\n')}
+`;
+}
+
+// List of Undici diagnostic channels
+const undiciEvents: string[] = [
+  'undici:request:create', // When a new request is created
+  'undici:request:bodySent', // When the request body is sent
+  'undici:request:headers', // When request headers are sent
+  'undici:request:error', // When a request encounters an error
+  'undici:request:trailers', // When a response completes.
+
+  'undici:client:sendHeaders',
+  'undici:client:beforeConnect',
+  'undici:client:connected',
+  'undici:client:connectError',
+
+  'undici:socket:close', // When a socket is closed
+  'undici:socket:connect', // When a socket connects
+  'undici:socket:error', // When a socket encounters an error
+
+  'undici:pool:request', // When a request is added to the pool
+  'undici:pool:connect', // When a pool creates a new connection
+  'undici:pool:disconnect', // When a pool connection is closed
+  'undici:pool:destroy', // When a pool is destroyed
+  'undici:dispatcher:request', // When a dispatcher processes a request
+  'undici:dispatcher:connect', // When a dispatcher connects
+  'undici:dispatcher:disconnect', // When a dispatcher disconnects
+  'undici:dispatcher:retry', // When a dispatcher retries a request
+];