Added support for multiple segments.

.github/workflows/CI-tests.yml

@@ -15,10 +15,10 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: 16.18
+          node-version: 18
 
       - name: Install Dependencies
-        run: yarn install --frozen-lockfile
+        run: yarn install
 
       - name: Generate Prisma Client and Test
         run: npx prisma generate && yarn test 2>&1 | tee test-report.txt

Dockerfile

@@ -1,9 +1,9 @@
-FROM node:16 AS install
+FROM node:18 AS install
 WORKDIR /app
 COPY package.json ./
 RUN yarn install
 
-FROM node:16 as build
+FROM node:18 as build
 WORKDIR /app
 COPY prisma ./prisma/
 RUN npx prisma generate
@@ -13,11 +13,11 @@ COPY --from=install /app/node_modules ./node_modules
 COPY . .
 RUN npm run build
 
-FROM node:16
+FROM node:18
 WORKDIR /app
 COPY --from=build /app/dist ./dist
 COPY --from=build /app/package*.json ./
 COPY --from=build /app/prisma ./prisma
 COPY --from=build /app/node_modules ./node_modules
 EXPOSE 3002
-CMD [ "npm", "run", "start:migrate:prod" ]
+CMD [ "npm", "run", "start:migrate:prod" ]

src/modules/bot/bot.controller.ts

@@ -281,8 +281,8 @@ export class BotController {
     AddOwnerInfoInterceptor,
     AddROToResponseInterceptor,
   )
-  @Get('/getAllUsers/:id/:page?')
-  async getAllUsers(@Param('id') id: string, @Headers() headers, @Param('page') page?: number) {
+  @Get('/getAllUsers/:id/:segment/:page?')
+  async getAllUsers(@Param('id') id: string, @Headers() headers, @Param('segment') segment: number, @Param('page') page?: number) {
     const bot: Prisma.BotGetPayload<{
       include: {
         users: {
@@ -300,7 +300,7 @@ export class BotController {
     }> | null = await this.botService.findOne(id);
     bot ? console.log('Users for the bot', bot['users']) : '';
     if (bot && bot.users[0].all) {
-      const users = await this.service.resolve(bot.users[0].all, page, bot.ownerID, headers['conversation-authorization']);
+      const users = await this.service.resolve(bot.users[0].all, segment, page, bot.ownerID, headers['conversation-authorization']);
       return users;
     }
     return bot;

src/modules/bot/bot.service.spec.ts

@@ -351,7 +351,7 @@ const mockBotsResolved = [{
 }];
 
 const mockConfig = {
-  "url": "http://mytesturl?",
+  "url": "http://mytesturl/segments/1/mentors?deepLink=nipunlakshya://chatbot?botId=testbotid",
   "type": "GET",
   "cadence": {
     "perPage": 20,
@@ -373,7 +373,8 @@ let deletedIds: any[] = []
 describe('BotService', () => {
   let botService: BotService;
   let configService: ConfigService;
-  jest.setTimeout(15000);
+  // Multiple segments need more time to trigger.
+  jest.setTimeout(30000);
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
@@ -441,19 +442,19 @@ describe('BotService', () => {
   });
 
   it('bot picks totalCount from config url', async () => {
-    fetchMock.getOnce('http://mytesturl/count', {
+    fetchMock.getOnce('http://mytesturl/segments/1/mentors/count', {
       totalCount: 100
     });
     for (let x = 1; x <= 5; x++) {
       fetchMock.getOnce(
-        `${configService.get('UCI_CORE_BASE_URL')}/campaign/start?campaignId=${'testId'}&page=${x}`,
+        `${configService.get('UCI_CORE_BASE_URL')}/campaign/start?campaignId=${'testId'}&page=${x}&segment=1`,
         ''
       );
     }
     await botService.start('testId', mockConfig, 'testAuthToken');
     for (let x = 1; x <= 5; x++) {
       expect(fetchMock.called(
-        `${configService.get('UCI_CORE_BASE_URL')}/campaign/start?campaignId=${'testId'}&page=${x}`
+        `${configService.get('UCI_CORE_BASE_URL')}/campaign/start?campaignId=${'testId'}&page=${x}&segment=1`
       )).toBe(true);
     }
     fetchMock.restore();
@@ -559,12 +560,12 @@ describe('BotService', () => {
     fetchMock.getOnce('http://testSegmentUrl/segments/1/mentors/count', {
       totalCount: 1
     });
-    fetchMock.getOnce(`${configService.get('UCI_CORE_BASE_URL')}/campaign/start?campaignId=testBotId&page=1`, (url, options) => {
+    fetchMock.getOnce(`${configService.get('UCI_CORE_BASE_URL')}/campaign/start?campaignId=testBotId&page=1&segment=1`, (url, options) => {
       submittedToken = options.headers ? options.headers['conversation-authorization'] : '';
       return true;
     });
     await botService.start(botId, mockBotsDb[0].users[0].all.config,'testAuthToken');
-    expect(fetchMock.called(`${configService.get('UCI_CORE_BASE_URL')}/campaign/start?campaignId=testBotId&page=1`)).toBe(true);
+    expect(fetchMock.called(`${configService.get('UCI_CORE_BASE_URL')}/campaign/start?campaignId=testBotId&page=1&segment=1`)).toBe(true);
     expect(submittedToken).toEqual('testAuthToken');
     fetchMock.restore();
   });
@@ -808,4 +809,30 @@ describe('BotService', () => {
     .toThrowError(`Required type for 'meta' is JSON, provided: 'string'`);
     fetchMock.restore();
   });
+
+  it('bot start triggers multiple segments', async () => {
+    const segments = [1, 99, 4];
+    for (let segment of segments) {
+      fetchMock.getOnce(`http://mytesturl/segments/${segment}/mentors/count`, {
+        totalCount: 100
+      });
+      for (let x = 1; x <= 5; x++) {
+        fetchMock.getOnce(
+          `${configService.get('UCI_CORE_BASE_URL')}/campaign/start?campaignId=${'testId'}&page=${x}&segment=${segment}`,
+          ''
+        );
+      }
+    }
+    const mockConfigCopy = JSON.parse(JSON.stringify(mockConfig));
+    mockConfigCopy.url = `http://mytesturl/segments/${segments.join(",")}/mentors?deepLink=nipunlakshya://chatbot?botId=testbotid`;
+    await botService.start('testId', mockConfigCopy, 'testAuthToken');
+    for (let segment of segments) {
+      for (let x = 1; x <= 5; x++) {
+        expect(fetchMock.called(
+          `${configService.get('UCI_CORE_BASE_URL')}/campaign/start?campaignId=${'testId'}&page=${x}&segment=${segment}`
+        )).toBe(true);
+      }
+    }
+    fetchMock.restore();
+  });
 });

src/modules/bot/bot.service.ts

@@ -89,50 +89,50 @@ export class BotService {
     this.logger.log(`BotService::start: Called with id: ${id} and config: ${JSON.stringify(config)}`);
     const pageSize: number = config.cadence.perPage;
     const segmentUrl: string = config.url;
-    const userCountUrl = `${segmentUrl.substring(0, segmentUrl.indexOf('?'))}/count`;
-    this.logger.log(`BotService::start: Fetching total count from ${userCountUrl}`);
-    const userCount: number = await fetch(
-      userCountUrl,
-      {
-        //@ts-ignore
-        timeout: 5000,
-        headers: { 'conversation-authorization': conversationToken }
-      }
-    )
-    .then(resp => resp.json())
-    .then(resp => {
-      if (resp.totalCount) {
-        this.logger.log(`BotService::start: Fetched total count of users: ${resp.totalCount}`);
-        return resp.totalCount;
-      }
-      else {
-        this.logger.error(`BotService::start: Failed to fetch total count of users, reason: Response did not have 'totalCount'.`);
-        throw new HttpException(
-          'Failed to get user count',
-          HttpStatus.INTERNAL_SERVER_ERROR
-        );
-      }
-    })
-    .catch(err => {
-      this.logger.error(`BotService::start: Failed to fetch total count of users, reason: ${err}`);
-      throw new HttpException(
-        err,
-        HttpStatus.INTERNAL_SERVER_ERROR
-      );
-    });
-    let pages = Math.ceil(userCount / pageSize);
-    this.logger.log(`BotService::start: Total pages: ${pages}`);
+    const regex = /\/segments\/([\d,]+)/;
+    const matched = segmentUrl.match(regex);
+    if (!matched || !matched[1]) {
+      throw new BadRequestException('Segment Url invalid.');
+    }
+    const segments = matched[1].split(',').map(Number);
     const promisesFunc: string[] = [];
-    for (let page = 1; page <= pages; page++) {
-      this.logger.log(
-        `BotService::start: Calling endpoint: ${this.configService.get(
+    for (let segment of segments) {
+      const userCountUrl = `${segmentUrl.substring(0, segmentUrl.indexOf('/segments/'))}/segments/${segment}/mentors/count`;
+      this.logger.log(`BotService::start: Fetching total count from ${userCountUrl}`);
+      const userCount: number = await fetch(
+        userCountUrl,
+        {
+          //@ts-ignore
+          timeout: 5000,
+          headers: { 'conversation-authorization': conversationToken }
+        }
+      )
+      .then(resp => resp.json())
+      .then(resp => {
+        if (resp.totalCount) {
+          this.logger.log(`BotService::start: Fetched total count of users: ${resp.totalCount}`);
+          return resp.totalCount;
+        }
+        else {
+          this.logger.error(`BotService::start: Failed to fetch total count of users, reason: Response did not have 'totalCount'.`);
+        }
+      })
+      .catch(err => {
+        this.logger.error(`BotService::start: Failed to fetch total count of users, reason: ${err}`);
+      });
+      let pages = Math.ceil(userCount / pageSize);
+      this.logger.log(`BotService::start: Segment: ${segment} Total pages: ${pages}`);
+      for (let page = 1; page <= pages; page++) {
+        this.logger.log(
+          `BotService::start: Calling endpoint: ${this.configService.get(
+            'UCI_CORE_BASE_URL',
+          )}/campaign/start?campaignId=${id}&page=${page}`,
+        );
+        const url = `${this.configService.get(
           'UCI_CORE_BASE_URL',
-        )}/campaign/start?campaignId=${id}&page=${page}`,
-      );
-      const url = `${this.configService.get(
-        'UCI_CORE_BASE_URL',
-      )}/campaign/start?campaignId=${id}&page=${page}`;
-      promisesFunc.push(url);
+        )}/campaign/start?campaignId=${id}&page=${page}&segment=${segment}`;
+        promisesFunc.push(url);
+      }
     }
     let promises = promisesFunc.map((url) => {
       return limit(() =>

src/modules/service/http-get.resolver.ts

@@ -67,9 +67,12 @@ export class GetRequestResolverService {
     queryType: ServiceQueryType,
     getRequestConfig: GetRequestConfig,
     user: string | null,
+    segment: number,
     page: number | undefined,
     conversationToken: string
   ): Promise<User[]> {
+    const regex = /\/segments\/[\d,]+/;
+    let userFetchUrl = getRequestConfig.url.replace(regex, `/segments/${segment}`);
     this.logger.debug(
       `Resolving ${queryType}, ${JSON.stringify(getRequestConfig.url)}`,
     );
@@ -87,7 +90,6 @@ export class GetRequestResolverService {
     // const variables = getRequestConfig.verificationParams;
     const errorNotificationWebhook = getRequestConfig.errorNotificationWebhook;
     this.logger.debug(`Headers: ${JSON.stringify(headers)}`);
-    let userFetchUrl = getRequestConfig.url;
     if (getRequestConfig.cadence.perPage != undefined && page != undefined) {
       const pageSize = getRequestConfig.cadence.perPage;
       const offset = pageSize * (page - 1);

src/modules/service/service.service.spec.ts

@@ -177,9 +177,27 @@ describe('ServiceService', () => {
         }
       };
     });
-    await serviceService.resolve(mockBotsDb[0].users[0].all, 1, mockBotsDb[0].ownerID, 'testAuthToken');
+    await serviceService.resolve(mockBotsDb[0].users[0].all, 1, 1, mockBotsDb[0].ownerID, 'testAuthToken');
     expect(fetchMock.called('http://testSegmentUrl/segments/1/mentors?deepLink=nipunlakshya://chatbot&limit=1&offset=0')).toBe(true);
     expect(submittedToken).toEqual('testAuthToken');
     fetchMock.restore();
   });
+
+  it('service passes segment correctly', async () => {
+    let submittedToken: string | null = '';
+    fetchMock.getOnce('http://testSegmentUrl/segments/99/mentors?deepLink=nipunlakshya://chatbot&limit=1&offset=0', (url, options) => {
+      if (options.headers) {
+        submittedToken = new Headers(options.headers).get('conversation-authorization');
+      }
+      return {
+        data : {
+          users: []
+        }
+      };
+    });
+    await serviceService.resolve(mockBotsDb[0].users[0].all, 99, 1, mockBotsDb[0].ownerID, 'testAuthToken');
+    expect(fetchMock.called('http://testSegmentUrl/segments/99/mentors?deepLink=nipunlakshya://chatbot&limit=1&offset=0')).toBe(true);
+    expect(submittedToken).toEqual('testAuthToken');
+    fetchMock.restore();
+  });
 });

src/modules/service/service.service.ts

@@ -15,7 +15,7 @@ export class ServiceService {
     this.logger = new Logger('ServiceService');
   }
 
-  async resolve(service: Service, page: number | undefined, owner: string | null, conversationToken: string) {
+  async resolve(service: Service, segment: number, page: number | undefined, owner: string | null, conversationToken: string) {
     const startTime = performance.now();
     this.logger.log(`ServiceService::resolve: Resolving users. Page: ${page}`);
     if (service.type === 'gql') {
@@ -33,6 +33,7 @@ export class ServiceService {
         ServiceQueryType.all,
         service.config as GqlConfig,
         owner,
+        segment,
         page,
         conversationToken
       );