Merge pull request #421 from bcgov/bugfix/peach-sync

Update Peach sync

Author: qhanson55

.github/environments/values.dev.yaml

@@ -32,6 +32,7 @@ config:
     SERVER_PCNS_APPURL: https://pcns-dev-master.apps.silver.devops.gov.bc.ca
     SERVER_PCNS_NAVEMAIL: NRM.PermittingAndData@gov.bc.ca
     SERVER_PEACH_APIPATH: "https://nr-peach-dev-main-api.azurewebsites.net/api/v1"
+    SERVER_PEACH_TOKENURL: https://dev.loginproxy.gov.bc.ca/auth/realms/permittingexchange/protocol/openid-connect/token
     SERVER_PORT: "8080"
     SERVER_SSO_APIPATH: https://api.loginproxy.gov.bc.ca/api/v1
     SERVER_SSO_TOKENURL: https://loginproxy.gov.bc.ca/auth/realms/standard/protocol/openid-connect/token

.github/environments/values.prod.yaml

@@ -32,6 +32,7 @@ config:
     SERVER_PCNS_APPURL: https://pcns-prod-master.apps.silver.devops.gov.bc.ca
     SERVER_PCNS_NAVEMAIL: Navigator.Service@gov.bc.ca
     SERVER_PEACH_APIPATH: "https://nr-peach-prod-main-api.azurewebsites.net/api/v1"
+    SERVER_PEACH_TOKENURL: https://loginproxy.gov.bc.ca/auth/realms/permittingexchange/protocol/openid-connect/token
     SERVER_PORT: "8080"
     SERVER_SSO_APIPATH: https://api.loginproxy.gov.bc.ca/api/v1
     SERVER_SSO_TOKENURL: https://loginproxy.gov.bc.ca/auth/realms/standard/protocol/openid-connect/token

.github/environments/values.test.yaml

@@ -32,6 +32,7 @@ config:
     SERVER_PCNS_APPURL: https://pcns-test-master.apps.silver.devops.gov.bc.ca
     SERVER_PCNS_NAVEMAIL: Navigator.Service@gov.bc.ca
     SERVER_PEACH_APIPATH: "https://nr-peach-test-main-api.azurewebsites.net/api/v1"
+    SERVER_PEACH_TOKENURL: https://test.loginproxy.gov.bc.ca/auth/realms/permittingexchange/protocol/openid-connect/token
     SERVER_PORT: "8080"
     SERVER_SSO_APIPATH: https://api.loginproxy.gov.bc.ca/api/v1
     SERVER_SSO_TOKENURL: https://loginproxy.gov.bc.ca/auth/realms/standard/protocol/openid-connect/token

app/config/custom-environment-variables.json

@@ -89,7 +89,10 @@
       "navEmail": "SERVER_PCNS_NAVEMAIL"
     },
     "peach": {
-      "apiPath": "SERVER_PEACH_APIPATH"
+      "apiPath": "SERVER_PEACH_APIPATH",
+      "clientId": "SERVER_PEACH_CLIENTID",
+      "clientSecret": "SERVER_PEACH_CLIENTSECRET",
+      "tokenUrl": "SERVER_PEACH_TOKENURL"
     },
     "port": "SERVER_PORT",
     "sso": {

app/src/db/migrations/20260105000000_050-remove-developed-in-bc.ts

@@ -1,4 +1,3 @@
-/* eslint-disable max-len */
 import type { Knex } from 'knex';
 
 export async function up(knex: Knex): Promise<void> {

app/src/parsers/peachParser.ts

@@ -177,15 +177,21 @@ export const getRecordEvents = (
   record: PeachRecord,
   n = 0,
   m = 0
-): { processEvent: ProcessEvent; onHoldEvent: CodingEvent } => {
-  const processEvents = [...record.process_event_set].sort((a, b) => compareProcessEvents(a, b, true));
+): { processEvent?: ProcessEvent; onHoldEvent?: CodingEvent } => {
+  const processEvents = record.process_event_set
+    ? [...record.process_event_set].sort((a, b) => compareProcessEvents(a, b, true))
+    : [];
   // TODO: Once onHold is implemented a tie breaker compartive function will be needed
-  const onHoldEvents = [...record.on_hold_event_set].sort((a, b) =>
-    compareDates(piesEventToDate(a.event), piesEventToDate(b.event), true)
-  );
+  /*  eslint-disable indent */
+  const onHoldEvents = record.on_hold_event_set
+    ? [...record.on_hold_event_set].sort((a, b) =>
+        compareDates(piesEventToDate(a.event), piesEventToDate(b.event), true)
+      )
+    : [];
+  /* eslint-enable indent */
 
-  const processEvent = processEvents.length > n ? processEvents[n] : processEvents[0];
-  const onHoldEvent = onHoldEvents.length > m ? onHoldEvents[m] : onHoldEvents[0];
+  const processEvent = processEvents && processEvents.length > n ? processEvents[n] : undefined;
+  const onHoldEvent = onHoldEvents && onHoldEvents.length > m ? onHoldEvents[m] : undefined;
 
   return { processEvent, onHoldEvent };
 };
@@ -207,10 +213,12 @@ const generateStatus = (
   const phase = PermitPhase.APPLICATION;
 
   let statusKey = processEvent.process.code;
-
   if (statusKey in PeachTerminatedStage) {
-    const { processEvent } = getRecordEvents(record, 1);
-    const prevStageCode = processEvent.process.code_set[1] as string;
+    const { processEvent: prevProcessEvent } = getRecordEvents(record, 1);
+    if (!prevProcessEvent) {
+      return { phase, stage: undefined, state: undefined };
+    }
+    const prevStageCode = prevProcessEvent.process.code_set[1];
     statusKey = `${prevStageCode}:${statusKey}`;
   }
 
@@ -265,9 +273,11 @@ export function piesEventToDateParts(piesEvent: PiesEvent): DateTimeStrings {
  * @returns A split date representing the submitted date and time, or both null if not found
  */
 const findSubmittedDate = (record: PeachRecord): NullableDateTimeStrings => {
-  for (const pe of record.process_event_set) {
-    if (pe.process.code === PEACH_SUBMITTED_STATE) {
-      return piesEventToDateParts(pe.event);
+  if (record.process_event_set) {
+    for (const pe of record.process_event_set) {
+      if (pe.process.code === PEACH_SUBMITTED_STATE) {
+        return piesEventToDateParts(pe.event);
+      }
     }
   }
   return {
@@ -282,9 +292,11 @@ const findSubmittedDate = (record: PeachRecord): NullableDateTimeStrings => {
  * @returns A split date representing the decision date and time, or both null if not found
  */
 const findDecisionDate = (record: PeachRecord): NullableDateTimeStrings => {
-  for (const pe of record.process_event_set) {
-    if (PEACH_DECISION_STATES.has(pe.process.code)) {
-      return piesEventToDateParts(pe.event);
+  if (record.process_event_set) {
+    for (const pe of record.process_event_set) {
+      if (PEACH_DECISION_STATES.has(pe.process.code)) {
+        return piesEventToDateParts(pe.event);
+      }
     }
   }
   return {
@@ -313,6 +325,8 @@ export function summarizePeachRecord(record: PeachRecord): PeachSummary | null {
   //   // set set permit values based on process
   // }
 
+  if (!processEvent) return null;
+
   const { stage, state } = generateStatus(processEvent, record);
 
   if (!stage || !state) return null;

app/src/services/peach.ts

@@ -6,6 +6,27 @@ import { Problem } from '../utils/index.ts';
 import type { AxiosInstance, AxiosRequestConfig } from 'axios';
 import type { Record as PeachRecord } from '../types/pies.d.ts';
 
+/**
+ * Gets Auth token using PEACH client credentials
+ * @returns A valid access token
+ */
+async function getToken() {
+  const response = await axios({
+    method: 'POST',
+    url: config.get('server.peach.tokenUrl'),
+    data: {
+      grant_type: 'client_credentials',
+      client_id: config.get('server.peach.clientId'),
+      client_secret: config.get('server.peach.clientSecret')
+    },
+    headers: {
+      'Content-type': 'application/x-www-form-urlencoded'
+    },
+    withCredentials: true
+  });
+  return response.data.access_token;
+}
+
 /**
  * Returns an Axios instance for the PEACH API
  * @param options Axios request config options
@@ -19,6 +40,13 @@ function peachAxios(options: AxiosRequestConfig = {}): AxiosInstance {
     ...options
   });
 
+  // Add bearer token
+  instance.interceptors.request.use(async (config) => {
+    const token = await getToken();
+    const auth = token ? `Bearer ${token}` : '';
+    config.headers['Authorization'] = auth;
+    return config;
+  });
   return instance;
 }
 

app/src/types/pies.d.ts

@@ -50,13 +50,13 @@ export interface Header {
    */
   record_id: string;
   /**
-   * The kind of record the source system stores this record as (i.e. Permit, Project, Submission or Tracking).
+   * The kind of record the source system stores this record as (i.e. Anchor or Permit).
    */
-  record_kind: 'Permit' | 'Project' | 'Submission' | 'Tracking';
+  record_kind: 'Anchor' | 'Permit';
 }
 export interface Record2 {
-  on_hold_event_set: CodingEvent[];
-  process_event_set: [ProcessEvent, ...ProcessEvent[]];
+  on_hold_event_set?: CodingEvent[];
+  process_event_set?: ProcessEvent[];
 }
 /**
  * Represents a coding concept at a specific event in time.
@@ -75,8 +75,8 @@ export interface Coding {
    */
   code_display?: string;
   /**
-   * An ordered set of code symbols, where the last element must match the code attribute. The set must contain at least
-   * one symbol, preserve order, and not include duplicates.
+   * An ordered set of code symbols, where the last element must match the code attribute. The set must contain at
+   * least one symbol, preserve order, and not include duplicates.
    */
   code_set: [Code] | [Code, Code] | [Code, Code, Code];
   /**
@@ -105,8 +105,8 @@ export interface Event1 {
   end_datetime?: string;
 }
 /**
- * This schema is used when the event starts with a date (`start_date`), and optionally, an end date (`end_date`) can be
- * specified. Mixing a start date with a datetime is not allowed.
+ * This schema is used when the event starts with a date (`start_date`), and optionally, an end date (`end_date`) can
+ * be specified. Mixing a start date with a datetime is not allowed.
  */
 export interface Date {
   start_date: string;
@@ -152,16 +152,16 @@ export type RecordLinkage1 = Header;
 
 export interface RecordLinkage2 {
   /**
-   * A valid NRIDS IT Service Management code which identifies the source system,
-   * service or asset that the linked data originates from.
+   * A valid NRIDS IT Service Management code which identifies the source system, service or asset that the linked data
+   * originates from.
    */
   linked_system_id: string;
   /**
    * The record or primary key representing what record should be linked with the primary header record.
    */
   linked_record_id: string;
   /**
-   * The kind of record the source system stores this linked record as (i.e. Permit, Project, Submission or Tracking).
+   * The kind of record the source system stores this linked record as (i.e. Anchor or Permit).
    */
-  linked_record_kind: 'Permit' | 'Project' | 'Submission' | 'Tracking';
+  linked_record_kind: 'Anchor' | 'Permit';
 }

app/tests/unit/parsers/peachParser.test.ts

@@ -57,10 +57,10 @@ describe('peachRecordParser', () => {
 
       const { processEvent } = getRecordEvents(record);
 
-      expect(processEvent.process.code).toBe('REJECTED');
+      expect(processEvent?.process.code).toBe('REJECTED');
     });
 
-    it('falls back to the first process event when n is out of range', () => {
+    it('returns undefined when n is out of range', () => {
       const record: PeachRecord = {
         ...TEST_PEACH_RECORD_1,
         process_event_set: [
@@ -78,8 +78,7 @@ describe('peachRecordParser', () => {
 
       const { processEvent } = getRecordEvents(record, 5);
 
-      expect(processEvent.event.start_datetime).toBe('2024-09-01T00:00:00.000Z');
-      expect(processEvent.process.code).toBe('SUBMITTED');
+      expect(processEvent).toBe(undefined);
     });
   });
 

charts/pcns/Chart.yaml

@@ -3,7 +3,7 @@ name: nr-permitconnect-navigator-service
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.0.28
+version: 0.0.29
 kubeVersion: ">= 1.13.0"
 description: PermitConnect Navigator Service
 # A chart can be either an 'application' or a 'library' chart.