@milaboratories/pl-deployments 2.15.7 → 2.15.9

package/src/common/pl_binary_download.ts

@@ -1,21 +1,21 @@
-import fs from 'node:fs';
-import fsp from 'node:fs/promises';
-import upath from 'upath';
-import type { Dispatcher } from 'undici';
-import { request } from 'undici';
-import { Writable, Readable } from 'node:stream';
-import { text } from 'node:stream/consumers';
-import * as tar from 'tar';
-import type { MiLogger } from '@milaboratories/ts-helpers';
-import { assertNever, fileExists } from '@milaboratories/ts-helpers';
-import decompress from 'decompress';
-import type { ArchType, OSType } from './os_and_arch';
-import { newOs, newArch } from './os_and_arch';
-
-const cdn = 'https://cdn.platforma.bio/software';
+import fs from "node:fs";
+import fsp from "node:fs/promises";
+import upath from "upath";
+import type { Dispatcher } from "undici";
+import { request } from "undici";
+import { Writable, Readable } from "node:stream";
+import { text } from "node:stream/consumers";
+import * as tar from "tar";
+import type { MiLogger } from "@milaboratories/ts-helpers";
+import { assertNever, fileExists } from "@milaboratories/ts-helpers";
+import decompress from "decompress";
+import type { ArchType, OSType } from "./os_and_arch";
+import { newOs, newArch } from "./os_and_arch";
+
+const cdn = "https://cdn.platforma.bio/software";
 // We'll download things from Global Access if downloading from CDN has failed
 // (it might be that it's blocked from the company's network.)
-const gaCdn = 'https://cdn-ga.pl-open.science/software';
+const gaCdn = "https://cdn-ga.pl-open.science/software";
 
 export type DownloadBinaryResult = {
   archiveUrl: string;
@@ -27,24 +27,30 @@ export type DownloadBinaryResult = {
   baseName: string;
 };
 
-export async function downloadBinaryNoExtract(
-  { logger, baseDir, softwareName, tgzName, arch, platform, dispatcher }: {
-    logger: MiLogger;
-    baseDir: string;
-    softwareName: string;
-    tgzName: string;
-    arch: string;
-    platform: string;
-    dispatcher?: Dispatcher;
-  },
-): Promise<DownloadBinaryResult> {
+export async function downloadBinaryNoExtract({
+  logger,
+  baseDir,
+  softwareName,
+  tgzName,
+  arch,
+  platform,
+  dispatcher,
+}: {
+  logger: MiLogger;
+  baseDir: string;
+  softwareName: string;
+  tgzName: string;
+  arch: string;
+  platform: string;
+  dispatcher?: Dispatcher;
+}): Promise<DownloadBinaryResult> {
   const opts = getPathsForDownload(softwareName, tgzName, baseDir, newArch(arch), newOs(platform));
   const { archiveUrl, alternativeArchiveGAUrl, archivePath } = opts;
 
   try {
     await downloadArchive({ logger, archiveUrl, archivePath, dispatcher });
     opts.wasDownloadedFrom = archiveUrl;
-  } catch (_e) {
+  } catch {
     await downloadArchive({ logger, archiveUrl: alternativeArchiveGAUrl, archivePath, dispatcher });
     opts.wasDownloadedFrom = alternativeArchiveGAUrl;
   }
@@ -52,24 +58,36 @@ export async function downloadBinaryNoExtract(
   return opts;
 }
 
-export async function downloadBinary(
-  { logger, baseDir, softwareName, archiveName, arch, platform, dispatcher }: {
-    logger: MiLogger;
-    baseDir: string;
-    softwareName: string;
-    archiveName: string;
-    arch: string;
-    platform: string;
-    dispatcher?: Dispatcher;
-  },
-): Promise<DownloadBinaryResult> {
-  const opts = getPathsForDownload(softwareName, archiveName, baseDir, newArch(arch), newOs(platform));
+export async function downloadBinary({
+  logger,
+  baseDir,
+  softwareName,
+  archiveName,
+  arch,
+  platform,
+  dispatcher,
+}: {
+  logger: MiLogger;
+  baseDir: string;
+  softwareName: string;
+  archiveName: string;
+  arch: string;
+  platform: string;
+  dispatcher?: Dispatcher;
+}): Promise<DownloadBinaryResult> {
+  const opts = getPathsForDownload(
+    softwareName,
+    archiveName,
+    baseDir,
+    newArch(arch),
+    newOs(platform),
+  );
   const { archiveUrl, alternativeArchiveGAUrl, archivePath, archiveType, targetFolder } = opts;
 
   try {
     await downloadArchive({ logger, archiveUrl, archivePath, dispatcher });
     opts.wasDownloadedFrom = archiveUrl;
-  } catch (_e) {
+  } catch {
     await downloadArchive({ logger, archiveUrl: alternativeArchiveGAUrl, archivePath, dispatcher });
     opts.wasDownloadedFrom = alternativeArchiveGAUrl;
   }
@@ -119,14 +137,17 @@ export type DownloadInfo = {
   newExisted?: boolean;
 };
 
-export async function downloadArchive(
-  { logger, archiveUrl, archivePath, dispatcher }: {
-    logger: MiLogger;
-    archiveUrl: string;
-    archivePath: string;
-    dispatcher?: Dispatcher;
-  },
-): Promise<DownloadInfo> {
+export async function downloadArchive({
+  logger,
+  archiveUrl,
+  archivePath,
+  dispatcher,
+}: {
+  logger: MiLogger;
+  archiveUrl: string;
+  archivePath: string;
+  dispatcher?: Dispatcher;
+}): Promise<DownloadInfo> {
   const state: DownloadInfo = {};
   state.archivePath = archivePath;
 
@@ -153,7 +174,7 @@ export async function downloadArchive(
     }
 
     // to prevent incomplete downloads we first write in a temp file
-    state.tmpPath = archivePath + '.tmp';
+    state.tmpPath = archivePath + ".tmp";
     // eslint-disable-next-line n/no-unsupported-features/node-builtins
     await Readable.toWeb(body).pipeTo(Writable.toWeb(fs.createWriteStream(state.tmpPath)));
     state.wroteTmp = true;
@@ -173,7 +194,7 @@ export async function downloadArchive(
 }
 
 /** Used to prevent mid-way interrupted unarchived folders to be used */
-const MarkerFileName = '.ok';
+const MarkerFileName = ".ok";
 
 export async function extractArchive(
   logger: MiLogger,
@@ -181,7 +202,7 @@ export async function extractArchive(
   archiveType: ArchiveType,
   dstFolder: string,
 ) {
-  logger.info('extracting archive...');
+  logger.info("extracting archive...");
   logger.info(`  archive path: '${archivePath}'`);
   logger.info(`  target dir: '${dstFolder}'`);
 
@@ -211,7 +232,7 @@ export async function extractArchive(
   );
 
   switch (archiveType) {
-    case 'tgz':
+    case "tgz":
       await tar.x({
         file: archivePath,
         cwd: dstFolder,
@@ -219,7 +240,7 @@ export async function extractArchive(
       });
       break;
 
-    case 'zip':
+    case "zip":
       await decompress(archivePath, dstFolder);
       break;
 
@@ -228,15 +249,15 @@ export async function extractArchive(
   }
 
   // writing marker file, to be able in the future detect that we completely unarchived the tar file
-  await fsp.writeFile(markerFilePath, 'ok');
+  await fsp.writeFile(markerFilePath, "ok");
 
   logger.info(`  ... unpack done.`);
 }
 
-export type ArchiveType = 'tgz' | 'zip';
+export type ArchiveType = "tgz" | "zip";
 
 const osToArchiveType: Record<OSType, ArchiveType> = {
-  linux: 'tgz',
-  macos: 'tgz',
-  windows: 'zip',
+  linux: "tgz",
+  macos: "tgz",
+  windows: "zip",
 };

package/src/common/pl_version.ts

@@ -1,6 +1,6 @@
-import packageJson from '../../package.json';
+import packageJson from "../../package.json";
 
 export function getDefaultPlVersion(): string {
   // drop build error if pl-version is not defined
-  return packageJson['pl-version'];
+  return packageJson["pl-version"];
 }

package/src/index.ts

@@ -1,5 +1,5 @@
-export * from './local/pl';
-export * from './common/pl_version';
-export * from './ssh/ssh';
-export * from './ssh/pl';
-export * from './ssh/connection_info';
+export * from "./local/pl";
+export * from "./common/pl_version";
+export * from "./ssh/ssh";
+export * from "./ssh/pl";
+export * from "./ssh/connection_info";

package/src/local/config.test.yaml

@@ -1,17 +1,17 @@
 license:
-  value: ''
-  file: ''
+  value: ""
+  file: ""
 
 logging:
-  level: 'info'
+  level: "info"
   destinations:
-  - path: 'platforma.log'
+    - path: "platforma.log"
 
 monitoring:
-  listen: '127.0.0.1:11235'
+  listen: "127.0.0.1:11235"
 
 debug:
-  listen: '127.0.0.1:11236'
+  listen: "127.0.0.1:11236"
 
 core:
   logging:
@@ -19,16 +19,16 @@ core:
     dumpResourceData: true
 
   grpc:
-    listen: '127.0.0.1:11234'
+    listen: "127.0.0.1:11234"
     tlsEnabled: false
 
   http:
-    listen: '127.0.0.1:11233'
+    listen: "127.0.0.1:11233"
 
   authEnabled: false
   auth: []
   db:
-    path: './db'
+    path: "./db"
 
 controllers:
   data:
@@ -43,23 +43,23 @@ controllers:
           downloadable: false
 
     storages:
-    - id: 'main'
-      type: 'FS'
-      indexCachePeriod: '1m'
-      rootPath: './storages/main'
+      - id: "main"
+        type: "FS"
+        indexCachePeriod: "1m"
+        rootPath: "./storages/main"
 
-    - id: 'work'
-      type: 'FS'
-      indexCachePeriod: '1m'
-      rootPath: './storages/work'
+      - id: "work"
+        type: "FS"
+        indexCachePeriod: "1m"
+        rootPath: "./storages/work"
 
   runner:
     type: local
     resources:
       cpu: 5
-    storageRoot: './storages/work'
+    storageRoot: "./storages/work"
 
   packageLoader:
-    packagesRoot: './packages'
+    packagesRoot: "./packages"
 
   workflows: {}

package/src/local/options.ts

@@ -1,5 +1,5 @@
-import type { SpawnOptions } from 'node:child_process';
-import type { PlBinarySource } from '../common/pl_binary';
+import type { SpawnOptions } from "node:child_process";
+import type { PlBinarySource } from "../common/pl_binary";
 
 /** Options to start a local pl-core. */
 export type LocalPlOptions = {
@@ -24,11 +24,11 @@ export type LocalPlRestart = LocalPlRestartSilent | LocalPlRestartHook;
 
 /** Do nothing if the error happened or a process exited. */
 export type LocalPlRestartSilent = {
-  type: 'silent';
+  type: "silent";
 };
 
 /** Run a hook if the error happened or a process exited. */
 export type LocalPlRestartHook = {
-  type: 'hook';
+  type: "hook";
   hook(pl: any): void;
 };

package/src/local/pid.ts

@@ -1,9 +1,9 @@
-import { fileExists } from '@milaboratories/ts-helpers';
-import fs from 'node:fs/promises';
-import upath from 'upath';
+import { fileExists } from "@milaboratories/ts-helpers";
+import fs from "node:fs/promises";
+import upath from "upath";
 
 export function filePid(dir: string) {
-  return upath.join(dir, 'pl_pid');
+  return upath.join(dir, "pl_pid");
 }
 
 export async function readPid(filePath: string): Promise<number | undefined> {