Merge pull request #3423 from RedisInsight/be/feature/add-package-type

add package type

Author: mariasergeenko

redisinsight/api/src/modules/cloud/common/models/cloud-request-utm.ts

@@ -37,4 +37,12 @@ export class CloudRequestUtm {
   @IsString()
   @IsNotEmpty()
   amp?: string;
+
+  @ApiPropertyOptional({
+    type: String,
+  })
+  @IsOptional()
+  @IsString()
+  @IsNotEmpty()
+  package?: string;
 }

redisinsight/api/src/modules/cloud/user/cloud-user.api.service.ts

@@ -104,10 +104,11 @@ export class CloudUserApiService {
 
         const preparedUtm = utm;
 
-        if (preparedUtm && !preparedUtm.amp) {
+        if (preparedUtm && (!preparedUtm.amp || !preparedUtm.package)) {
           await this.serverService.getInfo()
-            .then(({ id }) => {
-              preparedUtm.amp = id;
+            .then(({ id, packageType }) => {
+              preparedUtm.amp = preparedUtm.amp || id;
+              preparedUtm.package = preparedUtm.package || packageType;
             })
             .catch(() => {
               this.logger.warn('Unable to get server id for utm parameters');

redisinsight/api/src/modules/server/dto/server.dto.ts

@@ -1,4 +1,5 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { PackageType } from 'src/modules/server/models/server';
 
 export class GetServerInfoResponse {
   @ApiProperty({
@@ -36,6 +37,13 @@ export class GetServerInfoResponse {
   })
   buildType: string;
 
+  @ApiProperty({
+    description: 'Application package type.',
+    enum: PackageType,
+    example: 'app-image',
+  })
+  packageType: PackageType;
+
   @ApiPropertyOptional({
     description: 'Fixed Redis database id.',
     type: String,

redisinsight/api/src/modules/server/models/server.ts

@@ -8,7 +8,15 @@ export enum BuildType {
 }
 
 export enum PackageType {
-  AppImage = 'appimage',
+  Flatpak = 'flatpak',
+  Snap = 'snap',
+  UnknownLinux = 'unknown-linux',
+  AppImage = 'app-image',
+  Mas = 'mas',
+  UnknownDarwin = 'unknown-darwin',
+  WindowsStore = 'windows-store',
+  UnknownWindows = 'unknown-windows',
+  Unknown = 'unknown',
 }
 
 export enum AppType {

redisinsight/api/src/modules/server/server.service.ts

@@ -1,12 +1,14 @@
-import { Injectable, InternalServerErrorException, Logger, OnApplicationBootstrap } from '@nestjs/common';
+import {
+  Injectable, InternalServerErrorException, Logger, OnApplicationBootstrap,
+} from '@nestjs/common';
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import config, { Config } from 'src/utils/config';
 import { AppAnalyticsEvents } from 'src/constants/app-events';
 import { TelemetryEvents } from 'src/constants/telemetry-events';
 import { ServerInfoNotFoundException } from 'src/constants/exceptions';
 import { EncryptionService } from 'src/modules/encryption/encryption.service';
 import { ServerRepository } from 'src/modules/server/repositories/server.repository';
-import { AppType, BuildType } from 'src/modules/server/models/server';
+import { AppType, BuildType, PackageType } from 'src/modules/server/models/server';
 import { GetServerInfoResponse } from 'src/modules/server/dto/server.dto';
 import { FeaturesConfigService } from 'src/modules/feature/features-config.service';
 
@@ -51,6 +53,7 @@ export class ServerService implements OnApplicationBootstrap {
       sessionId: this.sessionId,
       appType: ServerService.getAppType(SERVER_CONFIG.buildType),
       appVersion: SERVER_CONFIG.appVersion,
+      packageType: ServerService.getPackageType(SERVER_CONFIG.buildType),
       ...(await this.featuresConfigService.getControlInfo()),
     });
 
@@ -63,6 +66,7 @@ export class ServerService implements OnApplicationBootstrap {
           osPlatform: process.platform,
           buildType: SERVER_CONFIG.buildType,
           port: SERVER_CONFIG.port,
+          packageType: ServerService.getPackageType(SERVER_CONFIG.buildType),
         },
         nonTracking: true,
       });
@@ -88,6 +92,7 @@ export class ServerService implements OnApplicationBootstrap {
         appType: ServerService.getAppType(SERVER_CONFIG.buildType),
         encryptionStrategies: await this.encryptionService.getAvailableEncryptionStrategies(),
         fixedDatabaseId: REDIS_STACK_CONFIG?.id,
+        packageType: ServerService.getPackageType(SERVER_CONFIG.buildType),
         ...(await this.featuresConfigService.getControlInfo()),
       };
       this.logger.log('Succeed to get server info.');
@@ -110,4 +115,47 @@ export class ServerService implements OnApplicationBootstrap {
         return AppType.Unknown;
     }
   }
+
+  static getPackageType(buildType: string): PackageType {
+    if (buildType === BuildType.Electron) {
+      // Darwin
+      if (process.platform === 'darwin') {
+        if (process.env.mas || process['mas']) {
+          return PackageType.Mas;
+        }
+
+        return PackageType.UnknownDarwin;
+      }
+
+      // Linux
+      if (process.platform === 'linux') {
+        if (process.env.APPIMAGE) {
+          return PackageType.AppImage;
+        }
+
+        if (process.env.SNAP_INSTANCE_NAME || process.env.SNAP_DATA) {
+          return PackageType.Snap;
+        }
+
+        if (process.env.container) {
+          return PackageType.Flatpak;
+        }
+
+        return PackageType.UnknownLinux;
+      }
+
+      // Windows
+      if (process.platform === 'win32') {
+        if (process.env.windowsStore || process['windowsStore']) {
+          return PackageType.WindowsStore;
+        }
+
+        return PackageType.UnknownWindows;
+      }
+
+      return PackageType.Unknown;
+    }
+
+    return undefined;
+  }
 }