Feat/subos itegration and new pricing (#1117)

Author: thisismayuresh

.env.example

@@ -0,0 +1,11 @@
+# SubOS Configuration
+NEXT_PUBLIC_SUBOS_API_ENDPOINT=
+NEXT_PUBLIC_SUBOS_PROJECT_ID=
+NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=
+
+# App Configuration
+NEXT_PUBLIC_APP_NAME=Impler.io
+NEXT_PUBLIC_APP_VERSION=1.0.0
+
+# Environment is automatically set by NODE_ENV
+# NODE_ENV=development

apps/api/src/app/column/dtos/column-request.dto.ts

@@ -17,7 +17,7 @@ import { ValidationTypesEnum } from '@impler/client';
 import { IsValidRegex } from '@shared/framework/is-valid-regex.validator';
 import { IsValidDigitsConstraint } from '@shared/framework/is-valid-digits.validator';
 import { IsNumberOrString } from '@shared/framework/number-or-string.validator';
-import { ColumnDelimiterEnum, ColumnTypesEnum, Defaults } from '@impler/shared';
+import { ColumnDelimiterEnum, ColumnTypesEnum } from '@impler/shared';
 
 export class ValidationDto {
   @ApiProperty({
@@ -154,7 +154,7 @@ export class ColumnRequestDto {
   })
   @ValidateIf((object) => object.type === ColumnTypesEnum.DATE)
   @Type(() => Array<string>)
-  dateFormats: string[] = Defaults.DATE_FORMATS;
+  dateFormats: string[];
 
   @ApiProperty({
     description: 'Sequence of column',

apps/api/src/app/common/common.controller.ts

@@ -12,9 +12,9 @@ import {
   UploadedFile,
 } from '@nestjs/common';
 
-import { ACCESS_KEY_NAME } from '@impler/shared';
+import { ACCESS_KEY_NAME, IImportConfig } from '@impler/shared';
 import { JwtAuthGuard } from '@shared/framework/auth.gaurd';
-import { ValidRequestDto, SignedUrlDto, ImportConfigResponseDto } from './dtos';
+import { ValidRequestDto, SignedUrlDto } from './dtos';
 import { ValidImportFile } from '@shared/validations/valid-import-file.validation';
 import { ValidRequestCommand, GetSignedUrl, ValidRequest, GetImportConfig, GetSheetNames } from './usecases';
 
@@ -60,7 +60,7 @@ export class CommonController {
   async getImportConfigRoute(
     @Query('projectId') projectId: string,
     @Query('templateId') templateId: string
-  ): Promise<ImportConfigResponseDto> {
+  ): Promise<IImportConfig> {
     if (!projectId) {
       throw new BadRequestException();
     }

apps/api/src/app/common/dtos/Schema.dto.ts

@@ -13,7 +13,7 @@ import {
   ValidateNested,
 } from 'class-validator';
 import { Type } from 'class-transformer';
-import { ColumnTypesEnum, Defaults } from '@impler/shared';
+import { ColumnTypesEnum } from '@impler/shared';
 import { IsValidRegex } from '@shared/framework/is-valid-regex.validator';
 import { ValidationDto } from 'app/column/dtos/column-request.dto';
 
@@ -101,7 +101,7 @@ export class SchemaDto {
   @Type(() => Array<string>)
   @IsArray({ message: "'dateFormats' must be an array, when type is Date" })
   @ArrayMinSize(1, { message: "'dateFormats' must not be empty, when type is Date" })
-  dateFormats: string[] = Defaults.DATE_FORMATS;
+  dateFormats: string[];
 
   @ApiProperty({
     description: 'Sequence of column',

apps/api/src/app/common/dtos/import-config-response.dto.ts

@@ -1,4 +1,3 @@
 export { SignedUrlDto } from './signed-url.dto';
 export { ValidRequestDto } from './valid.dto';
 export { SheetNamesDto } from './sheet-names.dto';
-export { ImportConfigResponseDto } from './import-config-response.dto';

apps/api/src/app/common/dtos/index.ts

@@ -1,6 +1,6 @@
 import { BadRequestException, Injectable } from '@nestjs/common';
 import { UserRepository, TemplateRepository, TemplateEntity } from '@impler/dal';
-import { AVAILABLE_BILLABLEMETRIC_CODE_ENUM, IImportConfig } from '@impler/shared';
+import { BILLABLEMETRIC_CODE_ENUM, IImportConfig } from '@impler/shared';
 import { PaymentAPIService } from '@impler/services';
 import { APIMessages } from '@shared/constants';
 
@@ -14,12 +14,22 @@ export class GetImportConfig {
 
   async execute(projectId: string, templateId?: string): Promise<IImportConfig> {
     const userEmail = await this.userRepository.findUserEmailFromProjectId(projectId);
+    const isFeatureAvailableMap = new Map<string, boolean>();
 
-    const removeBrandingAvailable = await this.paymentAPIService.checkEvent({
-      email: userEmail,
-      billableMetricCode: AVAILABLE_BILLABLEMETRIC_CODE_ENUM.REMOVE_BRANDING,
+    Object.values(BILLABLEMETRIC_CODE_ENUM).forEach((code) => {
+      isFeatureAvailableMap.set(code, false);
     });
 
+    try {
+      for (const billableMetricCode of Object.keys(BILLABLEMETRIC_CODE_ENUM)) {
+        const isAvailable = await this.paymentAPIService.checkEvent({
+          email: userEmail,
+          billableMetricCode: BILLABLEMETRIC_CODE_ENUM[billableMetricCode],
+        });
+        isFeatureAvailableMap.set(billableMetricCode, isAvailable);
+      }
+    } catch (error) {}
+
     let template: TemplateEntity;
     if (templateId) {
       template = await this.templateRepository.findOne({
@@ -32,6 +42,11 @@ export class GetImportConfig {
       }
     }
 
-    return { showBranding: !removeBrandingAvailable, mode: template?.mode, title: template?.name };
+    return {
+      ...Object.fromEntries(isFeatureAvailableMap),
+      showBranding: !isFeatureAvailableMap.get(BILLABLEMETRIC_CODE_ENUM.REMOVE_BRANDING),
+      mode: template?.mode,
+      title: template?.name,
+    };
   }
 }

apps/api/src/app/common/usecases/get-import-config/get-import-config.usecase.ts

@@ -8,7 +8,7 @@ import { PaymentAPIService } from '@impler/services';
 import { ValidRequestCommand } from './valid-request.command';
 import { ProjectRepository, TemplateRepository, UserEntity } from '@impler/dal';
 import { UniqueColumnException } from '@shared/exceptions/unique-column.exception';
-import { AVAILABLE_BILLABLEMETRIC_CODE_ENUM, ColumnTypesEnum } from '@impler/shared';
+import { BILLABLEMETRIC_CODE_ENUM, ColumnTypesEnum } from '@impler/shared';
 import { DocumentNotFoundException } from '@shared/exceptions/document-not-found.exception';
 
 @Injectable()
@@ -98,7 +98,7 @@ export class ValidRequest {
         if (hasImageColumns && email) {
           const imageImportAvailable = await this.paymentAPIService.checkEvent({
             email,
-            billableMetricCode: AVAILABLE_BILLABLEMETRIC_CODE_ENUM.IMAGE_IMPORT,
+            billableMetricCode: BILLABLEMETRIC_CODE_ENUM.IMAGE_IMPORT,
           });
 
           if (!imageImportAvailable) {
@@ -108,7 +108,7 @@ export class ValidRequest {
         if (hasValidations && email) {
           const validationsAvailable = await this.paymentAPIService.checkEvent({
             email,
-            billableMetricCode: AVAILABLE_BILLABLEMETRIC_CODE_ENUM.ADVANCED_VALIDATORS,
+            billableMetricCode: BILLABLEMETRIC_CODE_ENUM.ADVANCED_VALIDATORS,
           });
 
           if (!validationsAvailable) {

apps/api/src/app/common/usecases/valid-request/valid-request.usecase.ts

@@ -8,6 +8,7 @@ import { ReanameFileHeadings } from './rename-file-headings/rename-file-headings
 
 import { DoMappingCommand } from './do-mapping/do-mapping.command';
 import { ValidateMappingCommand } from './validate-mapping/validate-mapping.command';
+import { PaymentAPIService } from '@impler/services';
 
 export const USE_CASES = [
   DoMapping,
@@ -17,9 +18,19 @@ export const USE_CASES = [
   ValidateMapping,
   ReanameFileHeadings,
   GetUpload,
+  PaymentAPIService,
   //
 ];
 
-export { DoMapping, ValidateMapping, GetMappings, UpdateMappings, FinalizeUpload, ReanameFileHeadings, GetUpload };
+export {
+  DoMapping,
+  ValidateMapping,
+  GetMappings,
+  UpdateMappings,
+  FinalizeUpload,
+  ReanameFileHeadings,
+  GetUpload,
+  PaymentAPIService,
+};
 
 export { DoMappingCommand, ValidateMappingCommand };

apps/api/src/app/mapping/usecases/index.ts

@@ -1,9 +1,10 @@
+/* eslint-disable multiline-comment-style */
 import { Model } from 'mongoose';
 import { Writable } from 'stream';
 import { Injectable, BadRequestException, InternalServerErrorException } from '@nestjs/common';
 
 import { APIMessages } from '@shared/constants';
-import { EMAIL_SUBJECT } from '@impler/shared';
+import { BILLABLEMETRIC_CODE_ENUM, EMAIL_SUBJECT } from '@impler/shared';
 import { BaseReview } from './base-review.usecase';
 import { UniqueWithValidationType, ValidationTypesEnum } from '@impler/client';
 import { BATCH_LIMIT } from '@shared/services/sandbox';
@@ -16,7 +17,9 @@ import {
   DalService,
   TemplateEntity,
   TemplateRepository,
+  EnvironmentRepository,
 } from '@impler/dal';
+import { UsageLimitExceededException } from '@shared/exceptions/import-limit-exceeded.exception';
 
 interface ISaveResults {
   uploadId: string;
@@ -32,6 +35,7 @@ export class DoReview extends BaseReview {
 
   constructor(
     private templateRepository: TemplateRepository,
+    private environmentRepository: EnvironmentRepository,
     private storageService: StorageService,
     private uploadRepository: UploadRepository,
     private validatorRepository: ValidatorRepository,
@@ -44,6 +48,7 @@ export class DoReview extends BaseReview {
   }
 
   async execute(_uploadId: string) {
+    console.log('Called The Do Review.execute');
     this._modal = this.dalService.getRecordCollection(_uploadId);
     const userEmail = await this.uploadRepository.getUserEmailFromUploadId(_uploadId);
 
@@ -205,7 +210,28 @@ export class DoReview extends BaseReview {
       throw new InternalServerErrorException(APIMessages.ERROR_DURING_VALIDATION);
     }
 
-    await this.saveResults(response);
+    try {
+      await this.saveResults(response);
+    } catch (error) {
+      const emailContents = this.emailService.getEmailContent({
+        type: 'IMPORT_LIMIT_EXCEEDED_EMAIL',
+        data: {
+          limitType: 'Import Rows',
+          currentUsage: 'All available units including grace percentage',
+          planName: 'Current Plan',
+          upgradeUrl: `${process.env.WEB_BASE_URL}/pricing`,
+        },
+      });
+      await this.emailService.sendEmail({
+        from: process.env.EMAIL_FROM,
+        html: emailContents,
+        subject: 'Usage limit exceeded',
+        to: userEmail,
+        senderName: process.env.EMAIL_FROM_NAME,
+      });
+
+      throw new UsageLimitExceededException(error.message);
+    }
 
     return response;
   }
@@ -235,32 +261,66 @@ export class DoReview extends BaseReview {
   }
 
   private async saveResults({ uploadId, totalRecords, validRecords, invalidRecords, _templateId }: ISaveResults) {
-    await this.uploadRepository.update(
-      { _id: uploadId },
-      {
-        status: UploadStatusEnum.REVIEWING,
-        totalRecords,
-        validRecords,
-        invalidRecords,
-      }
-    );
-    await this.templateRepository.findOneAndUpdate(
-      {
-        _id: _templateId,
-      },
-      {
-        $inc: {
-          totalUploads: 1,
-          totalRecords: totalRecords,
-          totalInvalidRecords: invalidRecords,
-        },
-      }
-    );
     const userExternalIdOrEmail = await this.uploadRepository.getUserEmailFromUploadId(uploadId);
 
-    await this.paymentAPIService.createEvent(
-      { uploadId, totalRecords, validRecords, invalidRecords },
-      userExternalIdOrEmail
-    );
+    try {
+      await this.paymentAPIService.createEvent(
+        { units: totalRecords, billableMetricCode: BILLABLEMETRIC_CODE_ENUM.ROWS },
+        userExternalIdOrEmail
+      );
+
+      // Only update database if payment event creation succeeds
+      await this.uploadRepository.update(
+        { _id: uploadId },
+        {
+          status: UploadStatusEnum.REVIEWING,
+          totalRecords,
+          validRecords,
+          invalidRecords,
+        }
+      );
+
+      await this.templateRepository.findOneAndUpdate(
+        {
+          _id: _templateId,
+        },
+        {
+          $inc: {
+            totalUploads: 1,
+            totalRecords: totalRecords,
+            totalInvalidRecords: invalidRecords,
+          },
+        }
+      );
+    } catch (error) {
+      const template = await this.templateRepository.findById(_templateId);
+      const environment = await this.environmentRepository.getProjectTeamMembers(template._projectId);
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore
+      const teamMemberEmails = environment.map((teamMember) => teamMember._userId.email);
+      console.log(teamMemberEmails);
+
+      const emailContents = this.emailService.getEmailContent({
+        type: 'IMPORT_LIMIT_EXCEEDED_EMAIL',
+        data: {
+          limitType: 'Import Rows',
+          currentUsage: 'All available units including grace percentage',
+          planName: 'Current Plan',
+          upgradeUrl: `${process.env.WEB_BASE_URL}/pricing`,
+        },
+      });
+
+      teamMemberEmails.forEach(async (email) => {
+        await this.emailService.sendEmail({
+          to: email,
+          subject: EMAIL_SUBJECT.IMPORT_LIMIT_EXCEEDED,
+          html: emailContents,
+          from: process.env.ALERT_EMAIL_FROM,
+          senderName: process.env.EMAIL_FROM_NAME,
+        });
+      });
+
+      throw new UsageLimitExceededException(error.message);
+    }
   }
 }