BE: Policy int - Rough draft

vehicles/package.json

@@ -78,7 +78,8 @@
     "swagger-ui-express": "^5.0.1",
     "typeorm": "^0.3.20",
     "uuid": "^9.0.1",
-    "winston": "^3.14.2"
+    "winston": "^3.14.2",
+    "onroute-policy-engine": "0.4.2"
   },
   "devDependencies": {
     "@golevelup/ts-jest": "^0.5.4",

vehicles/src/app.service.ts

@@ -12,6 +12,8 @@ import { PaymentService } from './modules/permit-application-payment/payment/pay
 import { LogAsyncMethodExecution } from './common/decorator/log-async-method-execution.decorator';
 import { FeatureFlagsService } from './modules/feature-flags/feature-flags.service';
 import { ApplicationService } from './modules/permit-application-payment/application/application.service';
+import { HttpService } from '@nestjs/axios';
+import { getActivePolicyDefinitions } from './common/helper/policy-engine.helper';
 
 @Injectable()
 export class AppService {
@@ -27,6 +29,7 @@ export class AppService {
     private paymentService: PaymentService,
     private featureFlagsService: FeatureFlagsService,
     private applicationService: ApplicationService,
+    private readonly httpService: HttpService,
   ) {}
 
   getHello(): string {
@@ -128,6 +131,16 @@ export class AppService {
       createCacheMap(permitApprovalSource, 'id', 'code'),
     );
 
+    const policyConfigs = await getActivePolicyDefinitions(
+      this.httpService,
+      this.cacheManager,
+    );
+    await addToCache(
+      this.cacheManager,
+      CacheKey.POLICY_CONFIGURATIONS,
+      createCacheMap(policyConfigs, '??', 'policyJson'),
+    );
+
     const endDateTime = new Date();
     const processingTime = endDateTime.getTime() - startDateTime.getTime();
     this.logger.log(

vehicles/src/common/enum/cache-key.enum.ts

@@ -20,4 +20,6 @@ export enum CacheKey {
   FEATURE_FLAG_TYPE = 'FEATURE_FLAG_TYPE',
   PERMIT_APPLICATION_ORIGIN = 'PERMIT_APPLICATION_ORIGIN',
   PERMIT_APPROVAL_SOURCE = 'PERMIT_APPROVAL_SOURCE',
+  POLICY_CONFIGURATIONS = 'POLICY_CONFIGURATIONS',
+  ORBC_SERVICE_ACCOUNT_ACCESS_TOKEN = 'ORBC_SERVICE_ACCOUNT_ACCESS_TOKEN',
 }

vehicles/src/common/enum/gov-common-services.enum.ts

@@ -2,4 +2,5 @@ export enum GovCommonServices {
   COMMON_HOSTED_EMAIL_SERVICE = 'CHES',
   COMMON_DOCUMENT_GENERATION_SERVICE = 'CDOGS',
   CREDIT_ACCOUNT_SERVICE = 'CREDIT_ACCOUNT',
+  ORBC_SERVICE_ACCOUNT = 'SA',
 }

vehicles/src/common/helper/gov-common-services.helper.ts

@@ -124,7 +124,12 @@ function getTokenCredentials(govCommonServices: GovCommonServices): {
       username = process.env.CFS_CREDIT_ACCOUNT_CLIENT_ID;
       password = process.env.CFS_CREDIT_ACCOUNT_CLIENT_SECRET;
       break;
-
+    case GovCommonServices.ORBC_SERVICE_ACCOUNT:
+      tokenCacheKey = CacheKey.ORBC_SERVICE_ACCOUNT_ACCESS_TOKEN;
+      tokenUrl = process.env.ORBC_SERVICE_ACCOUNT_TOKEN_URL;
+      username = process.env.ORBC_SERVICE_ACCOUNT_CLIENT_ID;
+      password = process.env.ORBC_SERVICE_ACCOUNT_CLIENT_SECRET;
+      break;
     default:
       break;
   }

vehicles/src/common/helper/policy-engine.helper.ts

@@ -1,6 +1,13 @@
 import { Permit } from 'src/modules/permit-application-payment/permit/entities/permit.entity';
 import { PolicyApplication } from '../interface/policy-application.interface';
 import { PermitData } from '../interface/permit.template.interface';
+import { getAccessToken } from './gov-common-services.helper';
+import { GovCommonServices } from '../enum/gov-common-services.enum';
+import { HttpService } from '@nestjs/axios';
+import { Cache } from 'cache-manager';
+import { AxiosResponse } from 'axios';
+import { ReadPolicyConfigDto } from '../../modules/policy/dto/response/read-policy-config.dto';
+import { Policy, ValidationResults } from 'onroute-policy-engine';
 
 export const convertToPolicyApplication = (
   application: Permit,
@@ -10,3 +17,41 @@ export const convertToPolicyApplication = (
     permitData: JSON.parse(application.permitData.permitData) as PermitData,
   };
 };
+
+export const getActivePolicyDefinitions = async (
+  httpService: HttpService,
+  cacheManager: Cache,
+) => {
+  const token = await getAccessToken(
+    GovCommonServices.ORBC_SERVICE_ACCOUNT,
+    httpService,
+    cacheManager,
+  );
+  const response = await httpService.axiosRef.get<
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    any,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    AxiosResponse<Response, any>,
+    Request
+  >(process.env.ORBC_POLICY_URL + '/policy-configurations', {
+    headers: {
+      Authorization: `Bearer ${token}`,
+      'Content-Type': 'application/json',
+    },
+  });
+  return (await response.data.json()) as ReadPolicyConfigDto[];
+};
+
+export const validateWithPolicyEngine = async (
+  permitApplication: unknown,
+  cacheManager: Cache,
+): Promise<boolean> => {
+  const policyDefinitions: ReadPolicyConfigDto[] = await cacheManager.get(
+    'active-policy-definitions',
+  );
+  const policy = new Policy(policyDefinitions);
+  const validationResults: ValidationResults =
+    await policy.validate(permitApplication);
+
+  return validationResults.violations.length > 0;
+};

vehicles/src/modules/policy/dto/response/read-policy-config.dto.ts

@@ -0,0 +1,54 @@
+import { AutoMap } from '@automapper/classes';
+import { ApiProperty } from '@nestjs/swagger';
+import { PolicyDefinition } from 'onroute-policy-engine/dist/types';
+
+export class ReadPolicyConfigDto {
+  /**
+   * Unique identifier for the policy configuration.
+   */
+  @AutoMap()
+  @ApiProperty({
+    example: '1',
+    description: 'Unique identifier for the policy configuration.',
+  })
+  policyConfigId: number;
+
+  /**
+   * JSON data representing the policy configuration.
+   */
+  @AutoMap()
+  @ApiProperty({
+    description: 'Policy configuration in JSON format.',
+  })
+  policy: PolicyDefinition;
+
+  /**
+   * Configuration effective date.
+   */
+  @AutoMap()
+  @ApiProperty({
+    example: '2023-07-13T17:31:17.470Z',
+    description: 'Policy Configuration effective date.',
+  })
+  effectiveDate: string;
+
+  /**
+   * Indicates if the configuration is currently a draft version.
+   */
+  @AutoMap()
+  @ApiProperty({
+    example: true,
+    description: 'Indicates if the configuration is currently a draft.',
+  })
+  isDraft: boolean;
+
+  /**
+   * Description of changes made in the configuration.
+   */
+  @AutoMap()
+  @ApiProperty({
+    example: 'Initial release of policy configuration with updated rules',
+    description: 'Description of changes made in the configuration.',
+  })
+  changeDescription: string;
+}

vehicles/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
+    "module": "CommonJS",
     "declaration": true,
     "removeComments": true,
     "emitDecoratorMetadata": true,