@milaboratories/pl-deployments 1.1.6 → 1.1.8

package/src/common/pl_binary.ts

@@ -1,8 +1,10 @@
 import type { MiLogger } from '@milaboratories/ts-helpers';
 import { assertNever } from '@milaboratories/ts-helpers';
-import { downloadPlBinary, DownloadBinaryResult } from './pl_binary_download';
+import { downloadBinary } from './pl_binary_download';
 import { getDefaultPlVersion } from './pl_version';
 import os from 'os';
+import upath from 'upath';
+import { newOs, OSType } from './os_and_arch';
 
 /** Shows how the binary should be got. */
 export type PlBinarySource = PlBinarySourceDownload | PlBinarySourceLocal;
@@ -28,7 +30,8 @@ export async function resolveLocalPlBinaryPath(
 ): Promise<string> {
   switch (src.type) {
     case 'Download':
-      return (await downloadPlBinary(logger, downloadDir, src.version, os.arch(), os.platform())).binaryPath!;
+      const ops = await downloadBinary(logger, downloadDir, 'pl', `pl-${src.version}`, os.arch(), os.platform());
+      return upath.join(ops.baseName, 'binaries', osToBinaryName[newOs(os.platform())]);
 
     case 'Local':
       return src.path;
@@ -37,3 +40,9 @@ export async function resolveLocalPlBinaryPath(
       assertNever(src);
   }
 }
+
+export const osToBinaryName: Record<OSType, string> = {
+  linux: 'platforma',
+  macos: 'platforma',
+  windows: 'platforma.exe',
+};

package/src/common/pl_binary_download.ts

@@ -11,13 +11,19 @@ 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';
+
 export type DownloadBinaryResult = {
   archiveUrl: string;
+  alternativeArchiveGAUrl: string;
+  wasDownloadedFrom?: string;
   archivePath: string;
   archiveType: ArchiveType;
   targetFolder: string;
   baseName: string;
-  binaryPath?: string;
 };
 
 export async function downloadBinaryNoExtract(
@@ -29,9 +35,15 @@ export async function downloadBinaryNoExtract(
   platform: string,
 ): Promise<DownloadBinaryResult> {
   const opts = getPathsForDownload(softwareName, tgzName, baseDir, newArch(arch), newOs(platform));
-  const { archiveUrl, archivePath } = opts;
+  const { archiveUrl, alternativeArchiveGAUrl, archivePath } = opts;
 
-  await downloadArchive(logger, archiveUrl, archivePath);
+  try {
+    await downloadArchive(logger, archiveUrl, archivePath);
+    opts.wasDownloadedFrom = archiveUrl;
+  } catch (e: unknown) {
+    await downloadArchive(logger, alternativeArchiveGAUrl, archivePath);
+    opts.wasDownloadedFrom = alternativeArchiveGAUrl;
+  }
 
   return opts;
 }
@@ -45,25 +57,16 @@ export async function downloadBinary(
   platform: string,
 ): Promise<DownloadBinaryResult> {
   const opts = getPathsForDownload(softwareName, archiveName, baseDir, newArch(arch), newOs(platform));
-  const { archiveUrl, archivePath, archiveType, targetFolder, baseName } = opts;
-
-  await downloadArchive(logger, archiveUrl, archivePath);
-  await extractArchive(logger, archivePath, archiveType, targetFolder);
+  const { archiveUrl, alternativeArchiveGAUrl, archivePath, archiveType, targetFolder, baseName } = opts;
 
-  return opts;
-}
-
-export async function downloadPlBinary(
-  logger: MiLogger,
-  baseDir: string,
-  plVersion: string,
-  arch: string,
-  platform: string,
-): Promise<DownloadBinaryResult> {
-  const opts = localDownloadPlOptions(plVersion, baseDir, newArch(arch), newOs(platform));
-  const { archiveUrl, archivePath, archiveType, targetFolder, binaryPath } = opts;
+  try {
+    await downloadArchive(logger, archiveUrl, archivePath);
+    opts.wasDownloadedFrom = archiveUrl;
+  } catch (e: unknown) {
+    await downloadArchive(logger, alternativeArchiveGAUrl, archivePath);
+    opts.wasDownloadedFrom = alternativeArchiveGAUrl;
+  }
 
-  await downloadArchive(logger, archiveUrl, archivePath);
   await extractArchive(logger, archivePath, archiveType, targetFolder);
 
   return opts;
@@ -80,13 +83,15 @@ function getPathsForDownload(
   const archiveType = osToArchiveType[os];
 
   const archiveFileName = `${baseName}.${archiveType}`;
-  const archiveUrl = `https://cdn.platforma.bio/software/${softwareName}/${os}/${archiveFileName}`;
+  const archiveUrl = `${cdn}/${softwareName}/${os}/${archiveFileName}`;
+  const alternativeArchiveGAUrl = `${gaCdn}/${softwareName}/${os}/${archiveFileName}`;
   const archivePath = upath.join(baseDir, archiveFileName);
   // folder where binary distribution of pl will be unpacked
   const targetFolder = upath.join(baseDir, baseName);
 
   return {
     archiveUrl,
+    alternativeArchiveGAUrl,
     archivePath,
     archiveType,
     targetFolder,
@@ -94,34 +99,6 @@ function getPathsForDownload(
   };
 }
 
-export function localDownloadPlOptions(
-  plVersion: string,
-  baseDir: string,
-  arch: ArchType,
-  os: OSType,
-): DownloadBinaryResult {
-  const baseName = `pl-${plVersion}-${arch}`;
-  const archiveType = osToArchiveType[os];
-
-  const archiveFileName = `${baseName}.${archiveType}`;
-  const archiveUrl = `https://cdn.platforma.bio/software/pl/${os}/${archiveFileName}`;
-  const archivePath = upath.join(baseDir, archiveFileName);
-
-  // folder where binary distribution of pl will be unpacked
-  const targetFolder = upath.join(baseDir, baseName);
-
-  const binaryPath = upath.join(baseName, 'binaries', osToBinaryName[os]);
-
-  return {
-    archiveUrl,
-    archivePath,
-    archiveType,
-    targetFolder,
-    binaryPath,
-    baseName,
-  };
-}
-
 export type DownloadInfo = {
   dstArchive?: string;
   fileExisted?: boolean;
@@ -250,9 +227,3 @@ const osToArchiveType: Record<OSType, ArchiveType> = {
   macos: 'tgz',
   windows: 'zip',
 };
-
-const osToBinaryName: Record<OSType, string> = {
-  linux: 'platforma',
-  macos: 'platforma',
-  windows: 'platforma.exe',
-};

package/src/local/pl.ts

@@ -162,7 +162,9 @@ export async function localPlatformaInit(logger: MiLogger, _ops: LocalPlOptions)
     logger.info(`writing configuration '${configPath}'...`);
     await fsp.writeFile(configPath, ops.config);
 
-    const baseBinaryPath = await resolveLocalPlBinaryPath(logger, upath.join(workDir, 'binaries'), ops.plBinary);
+    const plBinPath = upath.join(workDir, 'binaries');
+    const baseBinaryPath = await resolveLocalPlBinaryPath(logger, plBinPath, ops.plBinary);
+
     const binaryPath = trace('binaryPath', upath.join('binaries', baseBinaryPath));
 
     const processOpts: ProcessOptions = {

package/src/ssh/__tests__/pl-docker.test.ts

@@ -5,7 +5,7 @@ import upath from 'upath';
 import { getDefaultPlVersion } from '../../common/pl_version';
 import { existsSync, unlinkSync, rmSync } from 'fs';
 import { newArch } from '../../common/os_and_arch';
-import { downloadBinary, downloadPlBinary } from '../../common/pl_binary_download';
+import { downloadBinary } from '../../common/pl_binary_download';
 import { ConsoleLoggerAdapter } from '@milaboratories/ts-helpers';
 import * as plpath from '../pl_paths';
 
@@ -39,12 +39,15 @@ describe('SshPl', async () => {
     expect(platformInfo).toHaveProperty('platform');
     expect(platformInfo).toHaveProperty('arch');
 
-    expect(platformInfo?.arch).toBe('x86_64');
+    // expect(platformInfo?.arch).toBe('x86_64');
     expect(platformInfo?.platform).toBe('Linux');
   });
 
   it('Check start/stop cmd', async () => {
-    await sshPl.platformaInit(downloadDestination);
+    await sshPl.platformaInit({
+      localWorkdir: downloadDestination,
+      license: {type: 'env'},
+    });
     expect(await sshPl.isAlive()).toBe(true);
 
     await sshPl.stop();
@@ -71,7 +74,10 @@ describe('SshPl', async () => {
   });
 
   it('platformaInit', async () => {
-    const result = await sshPl.platformaInit(downloadDestination);
+    const result = await sshPl.platformaInit({
+      localWorkdir: downloadDestination,
+      license: { type: 'env' },
+    });
 
     const remoteHome = await sshPl.getUserHomeDirectory();
 
@@ -84,10 +90,10 @@ describe('SshPl', async () => {
   it('Transfer Platforma to server', async () => {
     const arch = await sshPl.getArch();
 
-    const plPath = await downloadPlBinary(
+    const plPath = await downloadBinary(
       new ConsoleLoggerAdapter(),
       downloadDestination,
-      getDefaultPlVersion(),
+      'pl', `pl-${getDefaultPlVersion()}`,
       arch.arch,
       arch.platform,
     );
@@ -104,7 +110,10 @@ describe('SshPl', async () => {
   });
 
   it('Get free port', async () => {
-    await sshPl?.platformaInit(downloadDestination);
+    await sshPl.platformaInit({
+      localWorkdir: downloadDestination,
+      license: { type: 'env' },
+    })
     const isAlive = await sshPl?.isAlive();
     expect(isAlive).toBe(true);
 
@@ -154,10 +163,10 @@ describe('SshPl download binaries', async () => {
   it('Download pl. We have archive and extracted data', async () => {
     const arch = await sshPl.getArch();
 
-    const result = await downloadPlBinary(
+    const result = await downloadBinary(
       new ConsoleLoggerAdapter(),
       downloadDestination,
-      getDefaultPlVersion(),
+      'pl', `pl-${getDefaultPlVersion()}`,
       arch.arch,
       arch.platform,
     );

package/src/ssh/pl.ts

@@ -9,7 +9,7 @@ import * as plpath from './pl_paths';
 import { getDefaultPlVersion } from '../common/pl_version';
 
 import net from 'net';
-import type { SshPlConfigGenerationResult } from '@milaboratories/pl-config';
+import type { PlLicenseMode, SshPlConfigGenerationResult } from '@milaboratories/pl-config';
 import { generateSshPlConfigs, getFreePort } from '@milaboratories/pl-config';
 import { supervisorStatus, supervisorStop as supervisorCtlShutdown, generateSupervisordConfig, supervisorCtlStart } from './supervisord';
 
@@ -98,8 +98,8 @@ export class SshPl {
     return true;
   }
 
-  public async platformaInit(localWorkdir: string): Promise<SshInitReturnTypes> {
-    const state: PlatformaInitState = { localWorkdir };
+  public async platformaInit(ops: SshPlConfig): Promise<SshInitReturnTypes> {
+    const state: PlatformaInitState = { localWorkdir: ops.localWorkdir };
 
     try {
       state.arch = await this.getArch();
@@ -115,7 +115,7 @@ export class SshPl {
       }
 
       const downloadRes = await this.downloadBinariesAndUploadToTheServer(
-        localWorkdir, state.remoteHome, state.arch,
+        ops.localWorkdir, state.remoteHome, state.arch,
       );
       state.binPaths = { ...downloadRes, history: undefined };
       state.downloadedBinaries = downloadRes.history;
@@ -428,6 +428,11 @@ export type SshPlatformaPorts = {
 
 type Arch = { platform: string; arch: string };
 
+export type SshPlConfig = {
+  localWorkdir: string;
+  license: PlLicenseMode;
+}
+
 export type SshInitReturnTypes = {
   plUser: string;
   plPassword: string;