Merge pull request #181 from RJ-SMTR/hotfix/#177-ts-me-individual

Hotfix/#177 Endpoint transações individuais

src/bank-statements/bank-statements-repository.service.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
 import { nextFriday } from 'date-fns';
-import { TicketRevenuesService } from 'src/ticket-revenues/ticket-revenues.service';
+import { TicketRevenuesRepositoryService } from 'src/ticket-revenues/ticket-revenues-repository.service';
 import { User } from 'src/users/entities/user.entity';
 import { getDateYMDString, isPaymentWeekComplete } from 'src/utils/date-utils';
 import { TimeIntervalEnum } from 'src/utils/enums/time-interval.enum';
@@ -18,7 +18,9 @@ import { IBSGetMeDayValidArgs } from './interfaces/bs-get-me-day-args.interface'
  */
 @Injectable()
 export class BankStatementsRepositoryService {
-  constructor(private readonly ticketRevenuesService: TicketRevenuesService) {}
+  constructor(
+    private readonly ticketRevenuesRepository: TicketRevenuesRepositoryService,
+  ) {}
 
   public async getPreviousDays(
     validArgs: IBSGetMePreviousDaysValidArgs,
@@ -54,7 +56,7 @@ export class BankStatementsRepositoryService {
     const pagination = validArgs.paginationArgs
       ? validArgs.paginationArgs
       : { limit: 9999, page: 1 };
-    const revenues = await this.ticketRevenuesService.fetchTicketRevenues({
+    const revenues = await this.ticketRevenuesRepository.fetchTicketRevenues({
       startDate: new Date(validArgs.endDate),
       endDate: new Date(validArgs.endDate),
       cpfCnpj: validArgs.user.getCpfCnpj(),

src/bank-statements/bank-statements.service.spec.ts

@@ -1,6 +1,8 @@
 import { Provider } from '@nestjs/common';
 import { Test, TestingModule } from '@nestjs/testing';
+import { BigqueryService } from 'src/bigquery/bigquery.service';
 import { ITicketRevenuesGroup } from 'src/ticket-revenues/interfaces/ticket-revenues-group.interface';
+import { TicketRevenuesRepositoryService } from 'src/ticket-revenues/ticket-revenues-repository.service';
 import { TicketRevenuesService } from 'src/ticket-revenues/ticket-revenues.service';
 import { User } from 'src/users/entities/user.entity';
 import { UsersService } from 'src/users/users.service';
@@ -27,6 +29,12 @@ describe('BankStatementsService', () => {
   let ticketRevenuesService: TicketRevenuesService;
 
   beforeEach(async () => {
+    // class TicketRevenuesRepositoryMock {
+    //   async fetchTicketRevenues(): any[] {
+    //     return [];
+    //   }
+    // }
+
     const usersServiceMock = {
       provide: UsersService,
       useValue: {
@@ -37,6 +45,12 @@ describe('BankStatementsService', () => {
         softDelete: jest.fn(),
       },
     } as Provider;
+    const bigqueryServiceMock = {
+      provide: BigqueryService,
+      useValue: {
+        runQuery: jest.fn(),
+      },
+    } as Provider;
     const ticketRevenuesServiceMock = {
       provide: TicketRevenuesService,
       useValue: {
@@ -49,6 +63,8 @@ describe('BankStatementsService', () => {
       providers: [
         BankStatementsService,
         BankStatementsRepositoryService,
+        TicketRevenuesRepositoryService,
+        bigqueryServiceMock,
         usersServiceMock,
         ticketRevenuesServiceMock,
       ],

src/ticket-revenues/interfaces/tr-get-me-individual-args.interface.ts

@@ -1,8 +1,17 @@
-import { TRTimeIntervalEnum as TRTimeIntervalEnum } from '../enums/tr-time-interval.enum';
+import { User } from 'src/users/entities/user.entity';
+import { TimeIntervalEnum } from 'src/utils/enums/time-interval.enum';
+import { TRTimeIntervalEnum } from '../enums/tr-time-interval.enum';
 
 export interface ITRGetMeIndividualArgs {
   startDate?: string;
   endDate?: string;
   timeInterval?: TRTimeIntervalEnum;
   userId?: number;
 }
+
+export interface ITRGetMeIndividualValidArgs {
+  user: User;
+  startDate?: string;
+  endDate?: string;
+  timeInterval?: TimeIntervalEnum;
+}

src/ticket-revenues/ticket-revenues-repository.service.ts

@@ -0,0 +1,293 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { endOfDay, isToday, startOfDay } from 'date-fns';
+import { BQSInstances, BigqueryService } from 'src/bigquery/bigquery.service';
+import { isCpfOrCnpj } from 'src/utils/cpf-cnpj';
+import { getPagination } from 'src/utils/get-pagination';
+import { getPaymentDates } from 'src/utils/payment-date-utils';
+import { QueryBuilder } from 'src/utils/query-builder/query-builder';
+import { PaginationOptions } from 'src/utils/types/pagination-options';
+import { Pagination } from 'src/utils/types/pagination.type';
+import { IFetchTicketRevenues } from './interfaces/fetch-ticket-revenues.interface';
+import { ITicketRevenue } from './interfaces/ticket-revenue.interface';
+import { ITicketRevenuesGroup } from './interfaces/ticket-revenues-group.interface';
+import { ITRGetMeIndividualValidArgs } from './interfaces/tr-get-me-individual-args.interface';
+import { ITRGetMeIndividualResponse } from './interfaces/tr-get-me-individual-response.interface';
+import {
+  TRIntegrationTypeMap as IntegrationType,
+  TRPaymentTypeMap as PaymentType,
+} from './maps/ticket-revenues.map';
+
+@Injectable()
+export class TicketRevenuesRepositoryService {
+  private logger: Logger = new Logger('TicketRevenuesService', {
+    timestamp: true,
+  });
+
+  constructor(private readonly bigqueryService: BigqueryService) {}
+
+  /**
+   * TODO: use it only for repository services
+   *
+   * Filter: used by:
+   * - ticket-revenues/get/me
+   */
+  removeTodayData<T extends ITicketRevenue | ITicketRevenuesGroup>(
+    data: T[],
+    endDate: Date,
+  ): T[] {
+    const mostRecentDate = startOfDay(new Date(data[0].partitionDate));
+    if (mostRecentDate > endOfDay(endDate)) {
+      return data.filter((i) => !isToday(new Date(i.partitionDate)));
+    } else {
+      return data;
+    }
+  }
+
+  /**
+   * TODO: use it only in repository
+   *
+   * Repository: query `ITicketRevenue[]` with pagination
+   *
+   * Used by:
+   * - ticket-revenues/me/individual
+   * - ticket-revenues/me               (day gorup)
+   * - ticket-revenues/me/grouped       (sum all group)
+   * - bank-statements/me/previous-days
+   */
+  async fetchTicketRevenues(
+    args?: IFetchTicketRevenues,
+  ): Promise<{ data: ITicketRevenue[]; countAll: number }> {
+    const IS_PROD = process.env.NODE_ENV === 'production';
+    const Q_CONSTS = {
+      bucket: IS_PROD ? 'rj-smtr' : 'rj-smtr-dev',
+      transacao: IS_PROD
+        ? 'rj-smtr.br_rj_riodejaneiro_bilhetagem.transacao'
+        : 'rj-smtr-dev.br_rj_riodejaneiro_bilhetagem_cct.transacao',
+      integracao: IS_PROD
+        ? 'rj-smtr.br_rj_riodejaneiro_bilhetagem.integracao'
+        : 'rj-smtr-dev.br_rj_riodejaneiro_bilhetagem_cct.integracao',
+      tTipoPgto: IS_PROD ? 'tipo_pagamento' : 'id_tipo_pagamento',
+    };
+    // Args
+    let offset = args?.offset;
+    const queryBuilder = new QueryBuilder();
+    queryBuilder.pushOR([]);
+    if (args?.offset !== undefined && args.limit === undefined) {
+      this.logger.warn(
+        "fetchTicketRevenues(): 'offset' is defined but 'limit' is not." +
+          " 'offset' will be ignored to prevent query fail",
+      );
+      offset = undefined;
+    }
+
+    if (args?.startDate !== undefined) {
+      const startDate = args.startDate.toISOString().slice(0, 10);
+      queryBuilder.pushAND(
+        `DATE(t.datetime_processamento) >= DATE('${startDate}')`,
+      );
+    }
+    if (args?.endDate !== undefined) {
+      const endDate = args.endDate.toISOString().slice(0, 10);
+      queryBuilder.pushAND(
+        `DATE(t.datetime_processamento) <= DATE('${endDate}')`,
+      );
+    }
+    if (args?.previousDays === true) {
+      queryBuilder.pushAND(
+        'DATE(t.datetime_processamento) > DATE(t.datetime_transacao)',
+      );
+    }
+
+    queryBuilder.pushOR([]);
+    if (args?.getToday) {
+      const nowStr = new Date(Date.now()).toISOString().slice(0, 10);
+      queryBuilder.pushAND(
+        `DATE(t.datetime_processamento) = DATE('${nowStr}')`,
+      );
+    }
+
+    let qWhere = queryBuilder.toSQL();
+    if (args?.cpfCnpj !== undefined) {
+      const cpfCnpj = args.cpfCnpj;
+      qWhere =
+        isCpfOrCnpj(args?.cpfCnpj) === 'cpf'
+          ? `b.documento = '${cpfCnpj}' AND (${qWhere})`
+          : `b.cnpj = '${cpfCnpj}' AND (${qWhere})`;
+    }
+
+    // Query
+    const joinCpfCnpj =
+      isCpfOrCnpj(args?.cpfCnpj) === 'cpf'
+        ? `LEFT JOIN \`${Q_CONSTS.bucket}.cadastro.operadoras\` b ON b.id_operadora = t.id_operadora `
+        : `LEFT JOIN \`${Q_CONSTS.bucket}.cadastro.consorcios\` b ON b.id_consorcio = t.id_consorcio `;
+    const joinIntegracao = `INNER JOIN ${Q_CONSTS.integracao} i ON i.id_transacao = t.id_transacao`;
+
+    const countQuery =
+      'SELECT COUNT(*) AS count ' +
+      `FROM \`${Q_CONSTS.transacao}\` t\n` +
+      joinCpfCnpj +
+      '\n' +
+      joinIntegracao +
+      '\n' +
+      (qWhere.length ? ` WHERE ${qWhere}\n` : '');
+    const query =
+      `
+      SELECT
+        CAST(t.data AS STRING) AS partitionDate,
+        t.hora AS processingHour,
+        CAST(t.datetime_transacao AS STRING) AS transactionDateTime,
+        CAST(t.datetime_processamento AS STRING) AS processingDateTime,
+        t.datetime_captura AS captureDateTime,
+        t.modo AS transportType,
+        t.servico AS vehicleService,
+        t.sentido AS directionId,
+        t.id_veiculo AS vehicleId,
+        t.id_cliente AS clientId,
+        t.id_transacao AS transactionId,
+        t.${Q_CONSTS.tTipoPgto} AS paymentMediaType,
+        t.tipo_transacao AS transactionType,
+        t.id_tipo_integracao AS transportIntegrationType,
+        t.id_integracao AS integrationId,
+        t.latitude AS transactionLat,
+        t.longitude AS transactionLon,
+        t.stop_id AS stopId,
+        t.stop_lat AS stopLat,
+        t.stop_lon AS stopLon,
+        CASE WHEN t.tipo_transacao = 'Integração' THEN i.valor_transacao_total ELSE t.valor_transacao END AS transactionValue,
+        t.versao AS bqDataVersion,
+        (${countQuery}) AS count,
+        'ok' AS status
+      FROM \`${Q_CONSTS.transacao}\` t\n` +
+      joinCpfCnpj +
+      '\n' +
+      joinIntegracao +
+      '\n' +
+      (qWhere.length ? `WHERE ${qWhere}\n` : '') +
+      `UNION ALL
+      SELECT ${'null, '.repeat(22)}
+      (${countQuery}) AS count, 'empty' AS status` +
+      `\nORDER BY partitionDate DESC, processingHour DESC` +
+      (args?.limit !== undefined ? `\nLIMIT ${args.limit + 1}` : '') +
+      (offset !== undefined ? `\nOFFSET ${offset}` : '');
+    const queryResult = await this.bigqueryService.runQuery(
+      BQSInstances.smtr,
+      query,
+    );
+
+    const count: number = queryResult[0].count;
+    // Remove unwanted keys and remove last item (all null if empty)
+    let ticketRevenues: ITicketRevenue[] = queryResult.map((i) => {
+      delete i.status;
+      delete i.count;
+      return i;
+    });
+    ticketRevenues.pop();
+    ticketRevenues = this.mapTicketRevenues(ticketRevenues);
+
+    return {
+      data: ticketRevenues,
+      countAll: count,
+    };
+  }
+
+  /**
+   * Convert id or some values into desired string values
+   */
+  private mapTicketRevenues(
+    ticketRevenues: ITicketRevenue[],
+  ): ITicketRevenue[] {
+    return ticketRevenues.map((item: ITicketRevenue) => {
+      const paymentType = item.paymentMediaType;
+      const integrationType = item.transportIntegrationType;
+      return {
+        ...item,
+        paymentMediaType:
+          paymentType !== null
+            ? PaymentType?.[paymentType] || paymentType
+            : paymentType,
+        transportIntegrationType:
+          integrationType !== null
+            ? IntegrationType?.[integrationType] || integrationType
+            : integrationType,
+      };
+    });
+  }
+
+  public async getMeIndividual(
+    validArgs: ITRGetMeIndividualValidArgs,
+    paginationArgs: PaginationOptions,
+  ): Promise<Pagination<ITRGetMeIndividualResponse>> {
+    const { startDate, endDate } = getPaymentDates({
+      endpoint: 'ticket-revenues',
+      startDateStr: validArgs.startDate,
+      endDateStr: validArgs.endDate,
+      timeInterval: validArgs.timeInterval,
+    });
+
+    const result = await this.fetchTicketRevenues({
+      cpfCnpj: validArgs.user.getCpfCnpj(),
+      startDate,
+      endDate,
+      getToday: true,
+      limit: paginationArgs.limit,
+      offset: (paginationArgs.page - 1) * paginationArgs.limit,
+    });
+    let ticketRevenuesResponse = result.data;
+
+    if (ticketRevenuesResponse.length === 0) {
+      return getPagination<ITRGetMeIndividualResponse>(
+        {
+          amountSum: 0,
+          data: [],
+        },
+        {
+          dataLenght: 0,
+          maxCount: 0,
+        },
+        paginationArgs,
+      );
+    }
+
+    ticketRevenuesResponse = this.removeTodayData(
+      ticketRevenuesResponse,
+      endDate,
+    );
+
+    return getPagination<ITRGetMeIndividualResponse>(
+      {
+        amountSum: this.getAmountSum(ticketRevenuesResponse),
+        data: ticketRevenuesResponse,
+      },
+      {
+        dataLenght: ticketRevenuesResponse.length,
+        maxCount: result.countAll,
+      },
+      paginationArgs,
+    );
+  }
+
+  /**
+   * TODO: use it only in repository
+   */
+  getAmountSum<T extends ITicketRevenue | ITicketRevenuesGroup>(
+    data: T[],
+  ): number {
+    return Number(
+      data
+        .reduce((sum, i) => sum + (this.getTransactionValue(i) || 0), 0)
+        .toFixed(2),
+    );
+  }
+
+  private getTransactionValue(
+    item: ITicketRevenue | ITicketRevenuesGroup,
+  ): number {
+    if ('transactionValue' in item) {
+      return item.transactionValue || 0;
+    } else if ('transactionValueSum' in item) {
+      return item.transactionValueSum || 0;
+    } else {
+      return 0;
+    }
+  }
+}