@simitgroup/simpleapp-generator 2.0.2-b-alpha → 2.0.2-c-alpha

package/ReleaseNote.md

@@ -1,3 +1,9 @@
+[2.0.2c-alpha]
+
+1. support environment variable off mongodb transaction
+2. add /health check endpoint which no need credentials
+3. add still buggy pagination setting
+
 [2.0.2b-alpha]
 
 1. fix generate no bugs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simitgroup/simpleapp-generator",
-  "version": "2.0.2b-alpha",
+  "version": "2.0.2c-alpha",
   "description": "frontend nuxtjs and backend nests code generator using jsonschema",
   "main": "dist/index.js",
   "scripts": {

package/templates/basic/nest/controller.ts.eta

@@ -99,8 +99,8 @@ export class <%= it.typename %>Controller extends SimpleAppController<
   @ApiBody({ description: 'Data', type: schemas.SearchBody })
   @ApiOperation({ operationId: 'runSearch' })
   <%~ drawMiniAppScope('list') %>
-  async search(@AppUser() appuser: UserContext,@Body() data: schemas.SearchBody) {
-    return await this._search(appuser,data)
+  async search(@AppUser() appuser: UserContext,@Body() data: schemas.SearchBody, @Res({ passthrough: true }) res: Response) {
+    return await this._search(appuser,data, res)
   }
 
 <% if(simpleappconfig.search !==undefined){%>

package/templates/nest/src/app.controller.ts.eta

@@ -4,22 +4,22 @@
  * last change 2023-10-28
  * Author: Ks Tan
  */
-import { Controller, Get,Logger } from '@nestjs/common';
+import { Controller, Get, Logger } from '@nestjs/common';
 import { AppService } from './app.service';
-
+import { Roles } from 'src/simple-app/_core/features/auth/role-guard/roles.decorator';
+import { Role } from 'src/simple-app/_core/features/auth/role-guard/roles.enum';
 @Controller()
 export class AppController {
-  private logger = new Logger()
+  private logger = new Logger();
   constructor(private readonly appService: AppService) {
-    if(process.env.DRYRUN=='true'){
-      this.logger.warn("DRY run Mode, transaction will roll back")
+    if (process.env.DRYRUN == 'true') {
+      this.logger.warn('DRY run Mode, transaction will roll back');
     }
-      
-    
   }
 
-  @Get()
-  async getHello() {
-    return 'hello'
+  @Get('/health')
+  @Roles(Role.Everyone)
+  async getHealth() {
+    return Promise.resolve('ok');
   }
 }

package/templates/nest/src/app.module.ts._eta

@@ -100,6 +100,7 @@ export class AppModule implements NestModule {
     consumer
       .apply(SimpleAppMiddleware)
       // .exclude('/graphql')
+      .exclude('/health')
       .exclude('/api-yaml')
       .exclude('/api-json')
       .exclude('/api')

package/templates/nest/src/simple-app/_core/features/auth/role-guard/roles.guard.ts.eta

@@ -4,13 +4,7 @@
  * last change 2024-03-17
  * Author: Ks Tan
  */
-import {
-  Injectable,
-  Inject,
-  CanActivate,
-  ExecutionContext,
-  Scope,
-} from '@nestjs/common';
+import { Injectable, Inject, CanActivate, ExecutionContext, Scope } from '@nestjs/common';
 import { Reflector } from '@nestjs/core';
 import { Role } from './roles.enum';
 import { ROLES_KEY } from './roles.decorator';
@@ -21,18 +15,13 @@ export class RolesGuard implements CanActivate {
   constructor(private reflector: Reflector) {}
 
   canActivate(context: ExecutionContext): boolean {
-    const requiredRoles = this.reflector.getAllAndOverride<Role[]>(ROLES_KEY, [
-      context.getHandler(),
-      context.getClass(),
-    ]) || [];
+    const requiredRoles = this.reflector.getAllAndOverride<Role[]>(ROLES_KEY, [context.getHandler(), context.getClass()]) || [];
     const criticalRoles = [Role.SuperAdmin, Role.SuperUser, Role.TenantOwner];
-
     criticalRoles.forEach((role) => {
       if (!requiredRoles.includes(role)) {
         requiredRoles.push(role);
       }
     });
-
     let sessionuser: UserContext;
     if (context.getType() == 'http') {
       const request = context.switchToHttp().getRequest();
@@ -41,17 +30,15 @@ export class RolesGuard implements CanActivate {
       const req = context.getArgs()[2].req;
       sessionuser = req['sessionuser'];
     }
-
+    
     if (!requiredRoles) {
       return true;
     }
-
-    const roles = sessionuser.getRoles();
+    const roles = sessionuser ? sessionuser.getRoles() : [Role.Everyone];
     if (!roles) {
       return false;
     }
-    const result = requiredRoles.some((role) => roles.includes(role));
-
+    const result = requiredRoles.some((role) => roles.includes(role));        
     return result;
     // return true
   }

package/templates/nest/src/simple-app/_core/features/document-no-format/document-no-format.service.ts.eta

@@ -65,8 +65,8 @@ export class SimpleAppDocumentNoFormatService {
     }
     //
     Object.assign(filter, appUser.getBranchFilter());
-    const session = appUser.getDBSession()
-    const result = await this.docformat.find(filter)//.session(session);
+    const session = appUser.getDBSession();
+    const result = await this.docformat.find(filter).session(session);
     if (result && result.length > 0) {
       const d: DocumentNoFormat = result[0];
       const recordId = d._id;
@@ -74,8 +74,9 @@ export class SimpleAppDocumentNoFormatService {
       const newnextnumber = d.nextNumber + 1;
       const updatedata = { nextNumber: newnextnumber } as DocumentNoFormat;
 
-      const options = process.env.BlockGenerateDocNumberWithSession ? {} : {session:session}
-      const updateresult = await this.docformat.findByIdAndUpdate(recordId, updatedata,options)
+      const options = process.env.BlockGenerateDocNumberWithSession ? {} : { session: session };
+      const updateresult = await this.docformat.findByIdAndUpdate(recordId, updatedata, options);
+      appUser.addTransactionStep('update','documentnoformat',[recordId],[result[0]])
       if (updateresult) {
         const result: DocNumberFormatResult = {
           formatId: d._id,
@@ -111,7 +112,9 @@ export class SimpleAppDocumentNoFormatService {
     const docformats = alldocuments.filter((item) => item.docNumber);
     const allFormats: DocumentNoFormat[] = [];
     for (let i = 0; i < docformats.length; i++) {
+
       const doc = docformats[i];
+      if(['tenantinvoice'].includes(doc.docType)) continue;
       const pattern = doc.docNoPattern.replace('@BranchCode', branchCode);
       const formatdata: DocumentNoFormat = {
         _id: crypto.randomUUID(),
@@ -137,6 +140,10 @@ export class SimpleAppDocumentNoFormatService {
     try {
       //rollback when not able to create branch
       const result = await this.docformat.insertMany(allFormats, { session: appUser.getDBSession() });
+      const allRecordIds = result.map(item=>item._id)
+      const allLogData = result.map(item=>null)
+      
+      appUser.addTransactionStep('create','documentnoformat',allRecordIds,allLogData)
       if (!result) {
         throw new InternalServerErrorException(`Generate ${allFormats.length} document formats for "${branchCode}" failed.`, 'generateDefaultDocNumbers');
       }
@@ -215,9 +222,9 @@ export class SimpleAppDocumentNoFormatService {
       }
       const updatedata = { nextNumber: d.nextNumber + 1 } as DocumentNoFormat;
 
-      const options = process.env.BlockGenerateDocNumberWithSession ? {} : {session:appUser.getDBSession()}
-      const updateresult = await this.docformat.findByIdAndUpdate(recordId, updatedata,options)
-
+      const options = process.env.BlockGenerateDocNumberWithSession ? {} : { session: appUser.getDBSession(), };
+      const updateresult = await this.docformat.findByIdAndUpdate(recordId, updatedata, options);
+      appUser.addTransactionStep('update','documentnoformat',[recordId],[result[0]])
       return documentNumbers;
     } else {
       throw new BadRequestException(`No active document number found for ${doctype}. Please update in Settings > Document Numbering Format`);

package/templates/nest/src/simple-app/_core/features/log/log.service.ts.eta

@@ -48,6 +48,8 @@ export class SimpleAppLogService {
     return data;
   }
   async addEvent(appUser: UserContext, documentName: string, id: string, eventType: string, data: any) {
+    if(process.env.DISABLE_DOCUMENT_EVENT==='true') return false
+
     const eventdata: DocumentEvent = {
       _id: crypto.randomUUID(),
       documentName: documentName,
@@ -68,6 +70,7 @@ export class SimpleAppLogService {
     const newdoc = new this.doc(eventdata);
     const dbsession = appUser.getDBSession();
     const result = await newdoc.save({ session: dbsession });
+    appUser.addTransactionStep('create','documentevent',[eventdata._id],[null])
   }
 
   async addManyEvents(appUser: UserContext, documentName: string, eventType: string, datas: any[]) {
@@ -93,11 +96,13 @@ export class SimpleAppLogService {
       alldata.push(eventdata);
     }
     const dbsession = appUser.getDBSession();
-    try{
-      await this.doc.insertMany(alldata, { session: dbsession });  
-    }catch(e){
-      throw e
+    try {
+      await this.doc.insertMany(alldata, { session: dbsession });
+      const allIds = alldata.map(item=>item._id)
+      const allLogData = alldata.map(item=>null)
+      appUser.addTransactionStep('create','documentevent',allIds,allLogData)
+    } catch (e) {
+      throw e;
     }
-    
   }
 }

package/templates/nest/src/simple-app/_core/features/mini-app/mini-app-scope/mini-app-scope.guard.ts.eta

@@ -20,6 +20,10 @@ export class MiniAppScopeGuard implements CanActivate {
     }
 
     const req = context.switchToHttp().getRequest();
+
+    if(req.url==='/health'){
+      return true
+    }    
     const appUser: UserContext = req?.sessionuser;
     if (!appUser) {
       throw new BadRequestException('User Context Not Found');

package/templates/nest/src/simple-app/_core/features/profile/profile.service.ts.eta

@@ -87,14 +87,16 @@ export class ProfileService {
     return userinfo;
   }
 
-  async createTenant(appuser: UserContext, tenantName: string, timeZone: string, utcOffset: number, businessType: string,mobileNo:string) {
+  async createTenant(appuser: UserContext, tenantName: string, timeZone: string, utcOffset: number, businessType: string, mobileNo: string) {
     // try{
+
+    
     const timezonedata = countrytimezone.getCountriesForTimezone(timeZone)[0];
     const countryCode = timezonedata['id'];
     const countryName = timezonedata['name'];
     const currencyCode = countryToCurrency[countryCode];
 
-    appuser.getDBSession().startTransaction({readConcern:{level:"snapshot"},writeConcern:{w:"majority"}, readPreference: 'primary' });
+    appuser.startTransaction()
     const tenantdata: Tenant = {
       tenantId: 1,
       tenantName: tenantName,
@@ -111,12 +113,12 @@ export class ProfileService {
         uid: appuser.getUid(),
       },
     };
-    this.logger.log(tenantdata, 'createTenant data');
+    this.logger.debug(tenantdata, 'createTenant data');
     const tenantResult = await this.tenantService.create(appuser, tenantdata);
     if (!tenantResult) {
       throw new BadRequestException('Create tenant failed');
     }
-    this.logger.log(tenantResult, 'createTenant result');
+    this.logger.debug(tenantResult, 'createTenant result');
     const tenantId = tenantResult.tenantId;
 
     // return tenantResult
@@ -133,7 +135,7 @@ export class ProfileService {
       orgId: 1,
     };
 
-    this.logger.log(orgdata, 'createOrg data');
+    this.logger.debug(orgdata, 'createOrg data');
     const orgResult = await this.orgService.create(appuser, orgdata);
     if (!orgResult) {
       throw new BadRequestException('Create Org failed');
@@ -168,14 +170,14 @@ export class ProfileService {
       tenantId: tenantResult.tenantId,
       organization: { _id: orgRecordId, label: tenantName },
     };
-    this.logger.log(branchdata, 'createbranch data');
+    this.logger.debug(branchdata, 'createbranch data');
 
     const branchResult = await this.branchService.create(appuser, branchdata);
     if (!branchResult) {
       throw new BadRequestException('Create Branch failed');
     }
     const branchRecordId = branchResult._id.toString();
-    this.logger.log(branchResult, 'createbranch result');
+    this.logger.debug(branchResult, 'createbranch result');
 
     const userdata: User = {
       tenantId: tenantResult.tenantId,
@@ -186,14 +188,14 @@ export class ProfileService {
       email: appuser.getEmail(),
       active: true,
     };
-    this.logger.log(userdata, 'createtenant user data');
+    this.logger.debug(userdata, 'createtenant user data');
     const userResult = await this.userService.create(appuser, userdata);
     // if(true ){
     if (!userResult) {
       throw new BadRequestException('Create User failed');
     }
 
-    this.logger.log(userResult, 'createtenant user result');
+    this.logger.debug(userResult, 'createtenant user result');
     const userRecordId = userResult._id.toString();
 
     const permdata: Permission = {
@@ -204,13 +206,13 @@ export class ProfileService {
       userId: userRecordId,
       groups: ['admin'],
     };
-    this.logger.log(permdata, 'create Permission data');
+    this.logger.debug(permdata, 'create Permission data');
     const permResult = await this.permService.create(appuser, permdata);
     if (!permResult) {
       throw new BadRequestException('Create permResult failed');
     }
 
-    this.logger.log(permResult, 'create Permission result');
+    this.logger.debug(permResult, 'create Permission result');
 
     //tenant owner shall map to userId for that tenant
 
@@ -228,6 +230,8 @@ export class ProfileService {
       orgId: orgResult.orgId,
       branchId: branchResult.branchId,
     };
+
+    // console.log("finalresult, is transaction",finalresult,appuser.getDBSession().inTransaction())
     return finalresult;
     // }catch(e){
     //   this.logger.error("Couldn't generate tenant or subsequence records")

package/templates/nest/src/simple-app/_core/features/queue/queue-base/queue-base.consumer.ts.eta

@@ -7,19 +7,21 @@ import { UserContext } from '../../user-context/user.context';
 import { QueueUserContext } from '../queue-user-context/queue-user-context.service';
 import { Queuejob } from '../queue.type';
 // import { QueueName } from '../queue.enum';
-import { forwardRef, Inject, InternalServerErrorException } from '@nestjs/common';
+import { forwardRef, Inject, Logger, InternalServerErrorException } from '@nestjs/common';
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import _ from 'lodash';
+import { SimpleAppDbRevertService } from 'src/simple-app/_core/framework/simple-app-db-revert.service';
 
 export abstract class BaseQueueConsumer extends WorkerHost {
   // protected abstract readonly processor: QueueName;
   protected abstract readonly processor: string;
-
+  protected logger = new Logger()
   constructor(
     protected readonly queueUserContext: QueueUserContext,
     @InjectModel('Queuejob') protected queueJobModel: Model<Queuejob>,
     @InjectConnection() private readonly connection: Connection,
     protected eventEmitter: EventEmitter2,
+    protected simpleAppDbRevertService: SimpleAppDbRevertService
   ) {
     super();
   }
@@ -36,6 +38,7 @@ export abstract class BaseQueueConsumer extends WorkerHost {
   async process(job: Job) {
     // console.log("process job", job.data)
     const { userContext, payload } = job.data;
+    this.logger.debug(payload,`run queue job ${job.name}`)    
 
     const appUser = await this.createUserContext(userContext.user);
     await this.startSession(appUser);
@@ -45,19 +48,19 @@ export abstract class BaseQueueConsumer extends WorkerHost {
       // this.queueUserContext.assign(userContext);
 
       await this.dispatch(appUser, job, payload);
-      if (appUser.getDBSession().inTransaction()) {
-        await appUser.getDBSession().commitTransaction();
-      }
+      // if (appUser.getDBSession().inTransaction()) {
+        await appUser.commitTransaction() //.getDBSession().commitTransaction();
+      // }
       return {
         success: true,
       };
     } catch (e) {
-      if (appUser.getDBSession().inTransaction()) {
-        await appUser.getDBSession().abortTransaction();
-      }
+      // if (appUser.getDBSession().inTransaction()) {
+        await appUser.rollBackTransaction(this.simpleAppDbRevertService) //.getDBSession().abortTransaction();
+      // }
       throw e;
     } finally {
-      appUser.getDBSession().endSession();
+      await appUser.endSession()//getDBSession().endSession();
     }
   }
 
@@ -74,8 +77,7 @@ export abstract class BaseQueueConsumer extends WorkerHost {
     await handler.call(this, appUser, job, payload);
   }
 
-  protected async updateQueueJobRecord(job: Job, status: 'completed' | 'failed', result: any) {    
-
+  protected async updateQueueJobRecord(job: Job, status: 'completed' | 'failed', result: any) {
     await this.queueJobModel.updateOne(
       {
         'job.id': job.id,
@@ -83,8 +85,7 @@ export abstract class BaseQueueConsumer extends WorkerHost {
         'job.processor': this.processor,
       },
       {
-
-        'job.status': status,        
+        'job.status': status,
         initTime: new Date(job.timestamp).toISOString(),
         startTime: new Date(job.processedOn).toISOString(),
         endTime: new Date(job.finishedOn).toISOString(),

package/templates/nest/src/simple-app/_core/features/user-context/user.context.ts.eta

@@ -30,12 +30,15 @@ import { Role } from '../auth/role-guard/roles.enum';
 import { Environment } from '@core-features/maintenance/schemas';
 import * as rolegroups from '../auth/role-guard/roles.group';
 import { TenantLicenseEnum } from '@resources/tenant/tenant.enum';
+import { SimpleAppDbRevertService } from '../../framework/simple-app-db-revert.service';
+import { StepData } from 'src/simple-app/_core/resources/permission/permission.schema';
 
 // import systemWebHooks from '../../webhooks';
 @Injectable({ scope: Scope.REQUEST })
 export class UserContext extends UserContextInfo {
   sessionId: string = crypto.randomUUID();
-
+  protected isTransaction = false  
+  protected transSteps:StepData[] = []
   protected logger = new Logger(this.constructor.name);
 
   // protected uid: string = '';
@@ -148,7 +151,7 @@ export class UserContext extends UserContextInfo {
   };
 
   getDBSession = (): ClientSession => this.dbsession;
-
+  getTransStep = () => this.transSteps
   getId = () => this._id;
 
   getUid = () => this.uid;
@@ -448,7 +451,7 @@ export class UserContext extends UserContextInfo {
                   branchName: '$b.branchName',
                   branchId: '$b.branchId',
                   imageUrl: '$b.imageUrl',
-                  active: '$b.active'
+                  active: '$b.active',
                 },
 
                 groups: 1,
@@ -1216,8 +1219,56 @@ export class UserContext extends UserContextInfo {
     const isodate = new Date(timestamp + -offsets).toISOString().split('.')[0] + 'Z';
     return isodate;
   }
+
+
+  addTransactionStep (action:string,collection:string,id:string[], data:any[]) {
+    this.transSteps.push({action:action,collection:collection,id:id,data:data})
+  } 
+
+  
+  inTransaction(){
+    if(process.env.MONGO_TRANS==='false')
+      return this.isTransaction
+    else 
+      return this.dbsession && this.dbsession.inTransaction() ? true : false
+  }
+  startTransaction(){
+    if(process.env.MONGO_TRANS==='false'){
+      this.isTransaction=true
+      this.transSteps=[]      
+      
+
+    }else{
+      this.dbsession.startTransaction({ readConcern: { level: 'snapshot' }, writeConcern: { w: 'majority' }, readPreference: 'primary' });    
+    }
+  }
+  async commitTransaction(){
+    if(process.env.MONGO_TRANS==='false'){
+      this.isTransaction=false
+      this.transSteps=[]
+    }else{
+      if(this.dbsession.inTransaction())
+      await this.dbsession.commitTransaction()
+    }
+  }
+  async rollBackTransaction(dbService:SimpleAppDbRevertService){
+    if(process.env.MONGO_TRANS==='false'){
+      await dbService.revertSteps(this.transSteps)
+      this.isTransaction=false
+      this.transSteps=[]
+
+    }else{
+      if(this.dbsession.inTransaction())
+      await this.dbsession.abortTransaction()
+    }
+  }
+  async endSession(){    
+      await this.dbsession.endSession()    
+  }
 }
 
+
+// type StepData = {action:string,collection:string,id:string[],data:any[]}
 /**
  * Define a type for userinfo
  */

package/templates/nest/src/simple-app/_core/framework/base/simple-app.controller.ts.eta

@@ -4,7 +4,8 @@
  * last change 2025-09-01
  * Author: Ks Tan
  */
-import { Controller, Get, Put, Post, Delete, Body, Param, Type } from '@nestjs/common';
+import { Controller, Get, Put, Post, Delete, Body, Param, Type, Res } from '@nestjs/common';
+import { Response } from 'express';
 // import { ApiTags, ApiBody, ApiResponse, ApiOperation } from '@nestjs/swagger';
 import { UserContext } from '../../features/user-context/user.context';
 import { SearchBody, TextSearchBody, PatchManyRequest } from '../schemas';
@@ -15,6 +16,9 @@ const doctype = 'person'.toUpperCase();
 type ServiceType = {
   list: Function;
   search: Function;
+  searchWithPageInfo: Function;
+  setPaginationHeaders: Function;
+  getTotalCount: Function;
   create: Function;
   //update: Function;
   //delete: Function;
@@ -47,8 +51,22 @@ export class SimpleAppController<TService extends ServiceType, TApiSchema> {
     return this.service.fullTextSearch(appuser, body);
   }
 
-  async _search(appuser: UserContext, searchObject: SearchBody) {
-    return this.service.search(appuser, searchObject['filter'], searchObject['fields'], searchObject['sorts'], searchObject['lookup']);
+  async _search(appuser: UserContext, searchObject: SearchBody, res?: Response) {
+    //return this.service.search(appuser, searchObject['filter'], searchObject['fields'], searchObject['sorts'], searchObject['lookup']);
+    const items = await this.service.searchWithPageInfo(
+      appuser,
+      searchObject['filter'],
+      searchObject['fields'],
+      searchObject['sorts'],
+      searchObject['lookup'],
+      searchObject['pagination'],
+    );
+
+    if (res && searchObject['pagination']) {
+      const total = await this.service.getTotalCount(appuser, searchObject['filter'] || {});
+      this.service.setPaginationHeaders(res, total, searchObject['pagination']);
+    }
+    return items;
   }
 
   async _autocomplete(appuser: UserContext, keyword: string, data?: TApiSchema) {