@paybuy/config-client 0.0.0-stage → 1.2.12

package/src/types/paybuy-config.ts

@@ -0,0 +1,119 @@
+/* eslint-disable */
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+import {
+  DeleteEntityById,
+  FindEntityById,
+  FindEntityPagination,
+} from './crud_request';
+import {
+  CreateDynamicConfigRequest,
+  DynamicConfig,
+  DynamicConfigPaginationResponse,
+  GetRawDynamicConfigRequest,
+  GetRawDynamicConfigResponse,
+  UpdateDynamicConfigRequest,
+} from './dynamic-config/dynamic-config';
+import { HealthCheckEmpty, HealthCheckResponse } from './paybuy-health-check';
+
+export const protobufPackage = 'paybuy.config';
+
+export const PAYBUY_CONFIG_PACKAGE_NAME = 'paybuy.config';
+
+export interface DynamicConfigServiceClient {
+  findPaginate(
+    request: FindEntityPagination,
+  ): Observable<DynamicConfigPaginationResponse>;
+
+  findById(request: FindEntityById): Observable<DynamicConfig>;
+
+  getRaw(
+    request: GetRawDynamicConfigRequest,
+  ): Observable<GetRawDynamicConfigResponse>;
+
+  create(request: CreateDynamicConfigRequest): Observable<DynamicConfig>;
+
+  delete(request: DeleteEntityById): Observable<DynamicConfig>;
+
+  update(request: UpdateDynamicConfigRequest): Observable<DynamicConfig>;
+
+  healthCheck(request: HealthCheckEmpty): Observable<HealthCheckResponse>;
+}
+
+export interface DynamicConfigServiceController {
+  findPaginate(
+    request: FindEntityPagination,
+  ):
+    | Promise<DynamicConfigPaginationResponse>
+    | Observable<DynamicConfigPaginationResponse>
+    | DynamicConfigPaginationResponse;
+
+  findById(
+    request: FindEntityById,
+  ): Promise<DynamicConfig> | Observable<DynamicConfig> | DynamicConfig;
+
+  getRaw(
+    request: GetRawDynamicConfigRequest,
+  ):
+    | Promise<GetRawDynamicConfigResponse>
+    | Observable<GetRawDynamicConfigResponse>
+    | GetRawDynamicConfigResponse;
+
+  create(
+    request: CreateDynamicConfigRequest,
+  ): Promise<DynamicConfig> | Observable<DynamicConfig> | DynamicConfig;
+
+  delete(
+    request: DeleteEntityById,
+  ): Promise<DynamicConfig> | Observable<DynamicConfig> | DynamicConfig;
+
+  update(
+    request: UpdateDynamicConfigRequest,
+  ): Promise<DynamicConfig> | Observable<DynamicConfig> | DynamicConfig;
+
+  healthCheck(
+    request: HealthCheckEmpty,
+  ):
+    | Promise<HealthCheckResponse>
+    | Observable<HealthCheckResponse>
+    | HealthCheckResponse;
+}
+
+export function DynamicConfigServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'findPaginate',
+      'findById',
+      'getRaw',
+      'create',
+      'delete',
+      'update',
+      'healthCheck',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('DynamicConfigService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('DynamicConfigService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const DYNAMIC_CONFIG_SERVICE_NAME = 'DynamicConfigService';

package/src/types/paybuy-health-check.ts

@@ -0,0 +1,22 @@
+/* eslint-disable */
+
+export const protobufPackage = 'paybuy.healthCheck';
+
+/** Enums */
+export enum HealthCheckStatus {
+  HEALTH_CHECK_STATUS_ERROR = 'HEALTH_CHECK_STATUS_ERROR',
+  HEALTH_CHECK_STATUS_OK = 'HEALTH_CHECK_STATUS_OK',
+  HEALTH_CHECK_STATUS_SHUTTING_DOWN = 'HEALTH_CHECK_STATUS_SHUTTING_DOWN',
+}
+
+/** HealthCheck */
+export interface HealthCheckResponse {
+  status: HealthCheckStatus;
+  info: string;
+  error: string;
+  details: string;
+}
+
+export interface HealthCheckEmpty {}
+
+export const PAYBUY_HEALTH_CHECK_PACKAGE_NAME = 'paybuy.healthCheck';

package/test/dyanimc-config-client.unit.spec.ts

@@ -0,0 +1,57 @@
+/* Import */
+// Type
+import { DynamicConfigCacheService } from '../src/dynamic-config/service/dynamic-config-cache.service';
+import MockedGrpcClientService from './mock/grpc-client-service.mock';
+import { Observable } from 'rxjs';
+import { DynamicConfig, DynamicConfigModel } from '../src';
+import { createClientServer } from './test-client';
+import { INestApplication } from '@nestjs/common';
+import {
+  DYNAMIC_CONFIG_CLIENT_SERVICE_NAME,
+  DYNAMIC_CONFIG_SERVICE_KEY,
+} from '../src/dynamic-config/constants/dynamic-config-client-key.constants';
+
+@DynamicConfig({
+  dynamicConfigType: 'test',
+  fallBackValue: {},
+  key: 'test',
+  cacheTTL: 5000,
+})
+export class TestConfig extends DynamicConfigModel {}
+
+describe('Dynamic Config Client (unit)', () => {
+  let clientServer: INestApplication;
+  let clientService: MockedGrpcClientService;
+  let dynamicConfigService: DynamicConfigCacheService;
+
+  beforeAll(async () => {
+    clientServer = await createClientServer();
+    clientService = clientServer.get<MockedGrpcClientService>(
+      DYNAMIC_CONFIG_CLIENT_SERVICE_NAME,
+    );
+
+    jest
+      .spyOn(clientService, clientService.getRaw.name as any)
+      .mockImplementation(() => {
+        console.log('MockedGrpcClientService.getRaw');
+        
+        return new Observable((subscriber) => {
+          subscriber.next({ result: '{"ga":"ASDF"}' });
+          subscriber.complete();
+        });
+      });
+
+    dynamicConfigService = clientServer.get<DynamicConfigCacheService>(
+      DYNAMIC_CONFIG_SERVICE_KEY,
+    );
+  });
+
+  it('getRaw', async () => {
+    const configClass = new TestConfig();
+    for (let i = 0; i < 6; i++) {
+      await configClass.get(dynamicConfigService);
+    }
+
+    expect(clientService.getRaw).toHaveBeenCalledTimes(1);
+  });
+});

package/test/jest.json

@@ -0,0 +1,32 @@
+{
+  "moduleFileExtensions": [
+    "js",
+    "json",
+    "ts"
+  ],
+  "verbose": true,
+  "silent": false,
+  "rootDir": "..",
+  "testEnvironment": "node",
+  "testRegex": "(.*).spec.ts$",
+  "testTimeout": 190000,
+  "maxWorkers": 1,
+  "modulePaths": [
+    "./"
+  ],
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  },
+  "moduleDirectories": [
+    "node_modules"
+  ],
+  "collectCoverage": false,
+  "coverageProvider": "v8",
+  "collectCoverageFrom": [
+    "src/**/*.ts",
+    "!**/node_modules/**",
+    "!**/dist/**",
+    "!**/*.interface.ts",
+    "!**/*.type.ts"
+  ]
+}

package/test/mock/grpc-client-service.mock.ts

@@ -0,0 +1,48 @@
+/* Import */
+import { Observable } from 'rxjs';
+import {
+  FindEntityPagination,
+  FindEntityById,
+  DeleteEntityById,
+} from '../../src/types/crud_request';
+// Type
+import {
+  CreateDynamicConfigRequest,
+  DynamicConfig,
+  DynamicConfigPaginationResponse,
+  GetRawDynamicConfigRequest,
+  GetRawDynamicConfigResponse,
+  UpdateDynamicConfigRequest,
+} from '../../src/types/dynamic-config/dynamic-config';
+import { DynamicConfigServiceClient } from '../../src/types/paybuy-config';
+import { HealthCheckEmpty, HealthCheckResponse } from '../../src/types/paybuy-health-check';
+
+export default class MockedGrpcClientService
+  implements DynamicConfigServiceClient
+{
+  getRaw(
+    request: GetRawDynamicConfigRequest,
+  ): Observable<GetRawDynamicConfigResponse> {
+    throw new Error('Method not implemented.');
+  }
+  findPaginate(
+    request: FindEntityPagination,
+  ): Observable<DynamicConfigPaginationResponse> {
+    throw new Error('Method not implemented.');
+  }
+  findById(request: FindEntityById): Observable<DynamicConfig> {
+    throw new Error('Method not implemented.');
+  }
+  create(request: CreateDynamicConfigRequest): Observable<DynamicConfig> {
+    throw new Error('Method not implemented.');
+  }
+  delete(request: DeleteEntityById): Observable<DynamicConfig> {
+    throw new Error('Method not implemented.');
+  }
+  update(request: UpdateDynamicConfigRequest): Observable<DynamicConfig> {
+    throw new Error('Method not implemented.');
+  }
+  healthCheck(request: HealthCheckEmpty): Observable<HealthCheckResponse> {
+    throw new Error('Method not implemented.');
+  }
+}

package/test/test-client.ts

@@ -0,0 +1,27 @@
+/* Import */
+import { INestApplication } from '@nestjs/common';
+import { Test, TestingModule } from '@nestjs/testing';
+import MockedGrpcClientService from './mock/grpc-client-service.mock';
+import { DYNAMIC_CONFIG_CLIENT_SERVICE_NAME } from '../src/dynamic-config/constants/dynamic-config-client-key.constants';
+import { DynamicConfigModule } from 'src';
+
+export async function createClientServer(): Promise<INestApplication> {
+  const moduleFixture: TestingModule = await Test.createTestingModule({
+    imports: [
+      DynamicConfigModule.forRoot({
+        url: '',
+      }),
+    ],
+  })
+    .overrideProvider(DYNAMIC_CONFIG_CLIENT_SERVICE_NAME)
+    .useFactory({
+      factory: async (): Promise<MockedGrpcClientService> => {
+        return new MockedGrpcClientService();
+      },
+    })
+    .compile();
+
+  const clientServer = moduleFixture.createNestApplication();
+  await clientServer.init();
+  return clientServer;
+}

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "module": "CommonJS",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2021",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strict": true
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.