@milaboratories/pl-deployments 1.2.3 → 1.3.0

package/src/ssh/pl.ts

@@ -117,6 +117,8 @@ export class SshPl {
   public async platformaInit(options: SshPlConfig): Promise<ConnectionInfo> {
     const state: PlatformaInitState = { localWorkdir: options.localWorkdir };
 
+    const { onProgress } = options;
+
     try {
       // merge options with default ops.
       const ops: SshPlConfig = {
@@ -124,11 +126,22 @@ export class SshPl {
         ...options,
       };
       state.plBinaryOps = ops.plBinary;
+
+      await onProgress?.('Detecting server architecture...');
       state.arch = await this.getArch();
+      await onProgress?.('Server architecture detected.');
+
+      await onProgress?.('Fetching user home directory...');
       state.remoteHome = await this.getUserHomeDirectory();
+      await onProgress?.('User home directory retrieved.');
 
+      await onProgress?.('Checking platform status...');
       state.alive = await this.isAlive();
 
+      if (state.alive.allAlive) {
+        await onProgress?.('All required services are running.');
+      }
+
       if (state.alive.allAlive) {
         state.userCredentials = await this.getUserCredentials(state.remoteHome);
         if (!state.userCredentials) {
@@ -139,12 +152,17 @@ export class SshPl {
         state.needRestart = !(sameGA && samePlVersion);
         this.logger.info(`SshPl.platformaInit: need restart? ${state.needRestart}`);
 
-        if (!state.needRestart)
+        if (!state.needRestart) {
+          await onProgress?.('Server setup completed.');
           return state.userCredentials;
+        }
 
+        await onProgress?.('Stopping services...');
         await this.stop();
       }
 
+      await onProgress?.('Downloading and uploading required binaries...');
+
       const glibcVersion = await getGlibcVersion(this.logger, this.sshClient);
       if (glibcVersion < minRequiredGlibcVersion)
         throw new Error(`glibc version ${glibcVersion} is too old. Version ${minRequiredGlibcVersion} or higher is required for Platforma.`);
@@ -152,6 +170,8 @@ export class SshPl {
       const downloadRes = await this.downloadBinariesAndUploadToTheServer(
         ops.localWorkdir, ops.plBinary!, state.remoteHome, state.arch,
       );
+      await onProgress?.('All required binaries have been downloaded and uploaded.');
+
       state.binPaths = { ...downloadRes, history: undefined };
       state.downloadedBinaries = downloadRes.history;
 
@@ -161,6 +181,7 @@ export class SshPl {
         throw new Error(`SshPl.platformaInit: remote ports are not defined`);
       }
 
+      await onProgress?.('Generating server configuration...');
       const config = await generateSshPlConfigs({
         logger: this.logger,
         workingDir: plpath.workDir(state.remoteHome),
@@ -183,6 +204,9 @@ export class SshPl {
       });
       state.generatedConfig = { ...config, filesToCreate: { skipped: 'it is too wordy' } };
 
+      await onProgress?.('Server configuration generated.');
+
+      await onProgress?.('Generating folder structure...');
       for (const [filePath, content] of Object.entries(config.filesToCreate)) {
         await this.sshClient.writeFileOnTheServer(filePath, content);
         this.logger.info(`Created file ${filePath}`);
@@ -192,7 +216,9 @@ export class SshPl {
         await this.sshClient.ensureRemoteDirCreated(dir);
         this.logger.info(`Created directory ${dir}`);
       }
+      await onProgress?.('Folder structure created.');
 
+      await onProgress?.('Writing supervisord configuration...');
       const supervisorConfig = generateSupervisordConfig(
         config.minioConfig.storageDir,
         config.minioConfig.envs,
@@ -207,7 +233,9 @@ export class SshPl {
       if (!writeResult) {
         throw new Error(`Can not write supervisord config on the server ${plpath.workDir(state.remoteHome)}`);
       }
+      await onProgress?.('Supervisord configuration written.');
 
+      await onProgress?.('Saving connection information...');
       state.connectionInfo = newConnectionInfo(
         config.plUser,
         config.plPassword,
@@ -219,11 +247,15 @@ export class SshPl {
         plpath.connectionInfo(state.remoteHome),
         stringifyConnectionInfo(state.connectionInfo),
       );
+      await onProgress?.('Connection information saved.');
 
+      await onProgress?.('Starting Platforma on the server...');
       await this.start();
       state.started = true;
       this.initState = state;
 
+      await onProgress?.('Platforma has been started successfully.');
+
       return state.connectionInfo;
     } catch (e: unknown) {
       const msg = `SshPl.platformaInit: ${e}, state: ${JSON.stringify(state)}`;
@@ -455,6 +487,9 @@ export type SshPlConfig = {
   license: PlLicenseMode;
   useGlobalAccess?: boolean;
   plBinary?: PlBinarySourceDownload;
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  onProgress?: (...args: any) => Promise<any>;
   plConfigPostprocessing?: (config: PlConfig) => PlConfig;
 };
 
@@ -513,11 +548,11 @@ type PlatformaInitState = {
 async function getGlibcVersion(logger: MiLogger, sshClient: SshClient): Promise <number> {
   try {
     const { stdout, stderr } = await sshClient.exec('ldd --version | head -n 1');
-    if(stderr) {
+    if (stderr) {
       throw new Error(`Failed to check glibc version: ${stderr}`);
     }
-      return parseGlibcVersion(stdout);
-  } catch(e: unknown) {
+    return parseGlibcVersion(stdout);
+  } catch (e: unknown) {
     logger.error(`glibc version check failed: ${e}`);
     throw e;
   }