feat: Allow LCV permitting for STOS (#1761)

Co-authored-by: GlenAOT <[email protected]>

database/mssql/scripts/sampledata/dbo.ORBC_POWER_UNIT.Table.sql

@@ -103,7 +103,8 @@ INSERT [dbo].[ORBC_POWER_UNIT] ([POWER_UNIT_ID], [UNIT_NUMBER], [PLATE], [PROVIN
 INSERT [dbo].[ORBC_POWER_UNIT] ([POWER_UNIT_ID], [UNIT_NUMBER], [PLATE], [PROVINCE_TYPE], [YEAR], [MAKE], [VIN], [LICENSED_GVW], [POWER_UNIT_TYPE], [STEER_AXLE_TIRE_SIZE], [CONCURRENCY_CONTROL_NUMBER], [DB_CREATE_USERID], [DB_CREATE_TIMESTAMP], [DB_LAST_UPDATE_USERID], [DB_LAST_UPDATE_TIMESTAMP], [COMPANY_ID]) VALUES (99, N'9', N'F7XC0M', N'CA-BC', 2020, N'Freightliner', N'713995', CAST(18917.00 AS Numeric(18, 2)), N'CONCRET', 711, NULL, N'dbo', GETUTCDATE(), N'dbo', GETUTCDATE(), 99)
 INSERT [dbo].[ORBC_POWER_UNIT] ([POWER_UNIT_ID], [UNIT_NUMBER], [PLATE], [PROVINCE_TYPE], [YEAR], [MAKE], [VIN], [LICENSED_GVW], [POWER_UNIT_TYPE], [STEER_AXLE_TIRE_SIZE], [CONCURRENCY_CONTROL_NUMBER], [DB_CREATE_USERID], [DB_CREATE_TIMESTAMP], [DB_LAST_UPDATE_USERID], [DB_LAST_UPDATE_TIMESTAMP], [COMPANY_ID]) VALUES (100, N'9', N'VCUDWK', N'CA-BC', 2014, N'Hyundai', N'925292', CAST(4989.00 AS Numeric(18, 2)), N'TRKTRAC', 325, NULL, N'dbo', GETUTCDATE(), N'dbo', GETUTCDATE(), 100)
 
-
+INSERT [dbo].[ORBC_POWER_UNIT] ([POWER_UNIT_ID], [UNIT_NUMBER], [PLATE], [PROVINCE_TYPE], [YEAR], [MAKE], [VIN], [LICENSED_GVW], [POWER_UNIT_TYPE], [STEER_AXLE_TIRE_SIZE], [CONCURRENCY_CONTROL_NUMBER], [DB_CREATE_USERID], [DB_CREATE_TIMESTAMP], [DB_LAST_UPDATE_USERID], [DB_LAST_UPDATE_TIMESTAMP], [COMPANY_ID]) VALUES (101, N'LCV1', N'TTH199', N'CA-BC', 2020, N'Western Star', N'657854', CAST(20000 AS Numeric(18, 2)), N'LCVRMDB', 325, NULL, N'dbo', GETUTCDATE(), N'dbo', GETUTCDATE(), 74)
+INSERT [dbo].[ORBC_POWER_UNIT] ([POWER_UNIT_ID], [UNIT_NUMBER], [PLATE], [PROVINCE_TYPE], [YEAR], [MAKE], [VIN], [LICENSED_GVW], [POWER_UNIT_TYPE], [STEER_AXLE_TIRE_SIZE], [CONCURRENCY_CONTROL_NUMBER], [DB_CREATE_USERID], [DB_CREATE_TIMESTAMP], [DB_LAST_UPDATE_USERID], [DB_LAST_UPDATE_TIMESTAMP], [COMPANY_ID]) VALUES (102, N'LCV2', N'HIU499', N'CA-BC', 2022, N'Kenworth', N'199876', CAST(22000 AS Numeric(18, 2)), N'LCVTPDB', 431, NULL, N'dbo', GETUTCDATE(), N'dbo', GETUTCDATE(), 74)
 
 SET IDENTITY_INSERT [dbo].[ORBC_POWER_UNIT] OFF
 GO

database/mssql/scripts/sampledata/permit.ORBC_SPECIAL_AUTH.Table.sql

@@ -0,0 +1,5 @@
+SET NOCOUNT ON
+GO
+
+INSERT INTO permit.ORBC_SPECIAL_AUTH (COMPANY_ID, LCV) VALUES (74, 'Y')
+GO

database/mssql/scripts/utility/refresh-sample-data.sh

@@ -6,6 +6,7 @@ USAGE="-u ORBC_USER -p ORBC_PASS -s ORBC_SERVER -d ORBC_DATABASE"
 parse_options "${USAGE}" ${@}
 
 echo "Deleting existing sample data"
+sqlcmd -C -U ${ORBC_USER} -P "${ORBC_PASS}" -S ${ORBC_SERVER} -d ${ORBC_DATABASE} -Q "SET QUOTED_IDENTIFIER ON; SET NOCOUNT ON; DELETE FROM permit.ORBC_SPECIAL_AUTH"
 sqlcmd -C -U ${ORBC_USER} -P "${ORBC_PASS}" -S ${ORBC_SERVER} -d ${ORBC_DATABASE} -Q "SET QUOTED_IDENTIFIER ON; SET NOCOUNT ON; DELETE FROM dbo.ORBC_FEATURE_FLAG"
 sqlcmd -C -U ${ORBC_USER} -P "${ORBC_PASS}" -S ${ORBC_SERVER} -d ${ORBC_DATABASE} -Q "SET QUOTED_IDENTIFIER ON; SET NOCOUNT ON; DELETE FROM dbo.ORBC_TRAILER"
 sqlcmd -C -U ${ORBC_USER} -P "${ORBC_PASS}" -S ${ORBC_SERVER} -d ${ORBC_DATABASE} -Q "SET QUOTED_IDENTIFIER ON; SET NOCOUNT ON; DELETE FROM dbo.ORBC_POWER_UNIT"
@@ -25,6 +26,7 @@ sqlcmd -C -U ${ORBC_USER} -P "${ORBC_PASS}" -S ${ORBC_SERVER} -d ${ORBC_DATABASE
 sqlcmd -C -U ${ORBC_USER} -P "${ORBC_PASS}" -S ${ORBC_SERVER} -d ${ORBC_DATABASE} -i ${SCRIPT_DIR}/sampledata/dbo.ORBC_POWER_UNIT.Table.sql
 sqlcmd -C -U ${ORBC_USER} -P "${ORBC_PASS}" -S ${ORBC_SERVER} -d ${ORBC_DATABASE} -i ${SCRIPT_DIR}/sampledata/dbo.ORBC_TRAILER.Table.sql
 sqlcmd -C -U ${ORBC_USER} -P "${ORBC_PASS}" -S ${ORBC_SERVER} -d ${ORBC_DATABASE} -i ${SCRIPT_DIR}/sampledata/dbo.ORBC_FEATURE_FLAG.Table.sql
+sqlcmd -C -U ${ORBC_USER} -P "${ORBC_PASS}" -S ${ORBC_SERVER} -d ${ORBC_DATABASE} -i ${SCRIPT_DIR}/sampledata/permit.ORBC_SPECIAL_AUTH.Table.sql
 
 echo "Setting credit account sequence restart to current timestamp (used only for lower environments)"
 sqlcmd -C -U ${ORBC_USER} -P "${ORBC_PASS}" -S ${ORBC_SERVER} -d ${ORBC_DATABASE} -i ${SCRIPT_DIR}/sampledata/permit.ORBC_CREDIT_ACCOUNT_NUMBER_SEQ.sql

database/mssql/scripts/versions/revert/v_55_ddl_revert.sql

@@ -0,0 +1,43 @@
+SET ANSI_NULLS ON
+GO
+SET QUOTED_IDENTIFIER ON
+GO
+SET NOCOUNT ON
+GO
+SET XACT_ABORT ON
+GO
+SET TRANSACTION ISOLATION LEVEL SERIALIZABLE
+GO
+BEGIN TRANSACTION
+GO
+
+-- Remove the newly added policy configuration
+DELETE FROM [dbo].[ORBC_POLICY_CONFIGURATION]
+WHERE POLICY_CONFIGURATION_ID = (SELECT MAX(POLICY_CONFIGURATION_ID) FROM [dbo].[ORBC_POLICY_CONFIGURATION])
+GO
+
+IF @@ERROR <> 0 SET NOEXEC ON
+GO
+
+DECLARE @VersionDescription VARCHAR(255)
+SET @VersionDescription = 'Reverting updates to policy configuration JSON allowing lcv vehicles for TROS and TROW'
+
+INSERT [dbo].[ORBC_SYS_VERSION] ([VERSION_ID], [DESCRIPTION], [RELEASE_DATE]) VALUES (54, @VersionDescription, getutcdate())
+GO
+
+IF @@ERROR <> 0 SET NOEXEC ON
+GO
+
+COMMIT TRANSACTION
+GO
+IF @@ERROR <> 0 SET NOEXEC ON
+GO
+DECLARE @Success AS BIT
+SET @Success = 1
+SET NOEXEC OFF
+IF (@Success = 1) PRINT 'The database revert succeeded'
+ELSE BEGIN
+   IF @@TRANCOUNT > 0 ROLLBACK TRANSACTION
+   PRINT 'The database revert failed'
+END
+GO

frontend/package.json

@@ -21,7 +21,7 @@
     "material-react-table": "^2.13.3",
     "mui-nested-menu": "^3.4.0",
     "oidc-client-ts": "^3.1.0",
-    "onroute-policy-engine": "^1.1.0",
+    "onroute-policy-engine": "^1.4.1",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-error-boundary": "^4.1.2",

frontend/src/features/permits/ApplicationSteps.tsx

@@ -3,7 +3,10 @@ import { ErrorBoundary } from "react-error-boundary";
 
 import { ApplicationStepPage } from "./components/dashboard/ApplicationStepPage";
 import { ErrorFallback } from "../../common/pages/ErrorFallback";
-import { ApplicationStep, ApplicationStepContext } from "../../routes/constants";
+import {
+  ApplicationStep,
+  ApplicationStepContext,
+} from "../../routes/constants";
 
 export const ApplicationSteps = React.memo(
   ({

frontend/src/features/permits/components/dashboard/ApplicationStepPage.tsx

@@ -129,11 +129,11 @@ export const ApplicationStepPage = ({
         <ApplicationReview companyId={companyId} />
       );
     }
-
     return (
       <ApplicationForm
         permitType={applicationPermitType}
         companyId={companyId}
+        applicationStepContext={applicationStepContext}
       />
     );
   };

frontend/src/features/permits/helpers/vehicles/subtypes/getEligibleVehicleSubtypes.ts

@@ -1,14 +1,8 @@
 import { Policy } from "onroute-policy-engine";
 
 import { Nullable } from "../../../../../common/types/common";
-import { PERMIT_TYPES, PermitType } from "../../../types/PermitType";
+import { PermitType } from "../../../types/PermitType";
 import { getDefaultRequiredVal } from "../../../../../common/helpers/util";
-import { TROW_ELIGIBLE_VEHICLE_SUBTYPES } from "../../../constants/trow";
-import { TROS_ELIGIBLE_VEHICLE_SUBTYPES } from "../../../constants/tros";
-import {
-  DEFAULT_COMMODITY_SELECT_VALUE,
-  LCV_VEHICLE_SUBTYPES,
-} from "../../../constants/constants";
 
 /**
  * Get eligible vehicle subtypes based on given criteria.
@@ -20,41 +14,30 @@ import {
  */
 export const getEligibleVehicleSubtypes = (
   permitType: PermitType,
-  isLcvDesignated: boolean,
   selectedCommodity?: Nullable<string>,
   policyEngine?: Nullable<Policy>,
 ) => {
-  const lcvSubtypes = LCV_VEHICLE_SUBTYPES.map(({ typeCode }) => typeCode);
-  switch (permitType) {
-    case PERMIT_TYPES.STOS: {
-      if (!selectedCommodity || !policyEngine || (selectedCommodity === DEFAULT_COMMODITY_SELECT_VALUE))
-        return new Set<string>();
+  if (!policyEngine)
+    return new Set<string>();
 
-      const subtypesMap = policyEngine.getPermittableVehicleTypes(permitType, selectedCommodity);
-      return new Set(
-        [
-          ...getDefaultRequiredVal(
-            new Map<string, string>(),
-            subtypesMap.get("powerUnits"),
-          ).keys(),
-          ...getDefaultRequiredVal(
-            new Map<string, string>(),
-            subtypesMap.get("trailers"),
-          ).keys(),
-        ].concat(isLcvDesignated ? lcvSubtypes : []),
-      );
-    }
-    // Policy engine currently doesn't return vehicle subtypes unless a commodity is provided
-    // which TROW and TROS doesn't have, thus here the hardcoded subtypes are being used
-    case PERMIT_TYPES.TROW:
-      return new Set(
-        TROW_ELIGIBLE_VEHICLE_SUBTYPES.concat(isLcvDesignated ? lcvSubtypes : []),
-      );
-    case PERMIT_TYPES.TROS:
-      return new Set(
-        TROS_ELIGIBLE_VEHICLE_SUBTYPES.concat(isLcvDesignated ? lcvSubtypes : []),
-      );
-    default:
-      return new Set<string>();
-  }
+  // The policy engine requires a commodity to be provided for any
+  // permit type where commodity is required, hence the nullish
+  // coalescing operator on the second parameter. An empty string will
+  // result in an empty map returned.
+  const subtypesMap = policyEngine.getPermittableVehicleTypes(
+    permitType,
+    getDefaultRequiredVal('-', selectedCommodity),
+  );
+  return new Set(
+    [
+      ...getDefaultRequiredVal(
+        new Map<string, string>(),
+        subtypesMap.get("powerUnits"),
+      ).keys(),
+      ...getDefaultRequiredVal(
+        new Map<string, string>(),
+        subtypesMap.get("trailers"),
+      ).keys(),
+    ],
+  );
 };

frontend/src/features/permits/hooks/form/useInitApplicationFormData.ts

@@ -55,7 +55,6 @@ export const useInitApplicationFormData = (
   const initialFormData = useMemo(() => {
     const eligibleVehicleSubtypes = getEligibleVehicleSubtypes(
       permitType,
-      isLcvDesignated,
       applicationData?.permitData?.permittedCommodity?.commodityType,
       policyEngine,
     );

frontend/src/features/permits/hooks/usePermitVehicles.ts

@@ -45,7 +45,6 @@ export const usePermitVehicles = (
   const eligibleVehicleSubtypes = useMemo(() => {
     return getEligibleVehicleSubtypes(
       permitType,
-      isLcvDesignated,
       selectedCommodity,
       policyEngine,
     );

frontend/src/features/permits/pages/Amend/components/AmendPermitForm.tsx

@@ -94,7 +94,7 @@ export const AmendPermitForm = () => {
     trailerSubtypeNamesMap,
   } = usePermitVehicleManagement(companyId);
 
-  const policyEngine = usePolicyEngine();
+  const policyEngine = usePolicyEngine(specialAuthorizations);
 
   const { initialFormData, formData, formMethods } = useAmendPermitForm({
     repopulateFormData: currentStepIndex === 0,

frontend/src/features/permits/pages/Amend/components/AmendPermitReview.tsx

@@ -23,6 +23,7 @@ import {
   applyWhenNotNullable,
   getDefaultRequiredVal,
 } from "../../../../../common/helpers/util";
+import { useFetchSpecialAuthorizations } from "../../../../settings/hooks/specialAuthorizations";
 
 export const AmendPermitReview = () => {
   const navigate = useNavigate();
@@ -59,8 +60,9 @@ export const AmendPermitReview = () => {
     amendmentApplication?.permitType,
     permit?.permitType,
   );
+  const { data: specialAuthorizations } = useFetchSpecialAuthorizations(companyId);
 
-  const policyEngine = usePolicyEngine();
+  const policyEngine = usePolicyEngine(specialAuthorizations);
   const { commodityOptions } = useCommodityOptions(policyEngine, permitType);
   const powerUnitSubTypesQuery = usePowerUnitSubTypesQuery();
   const trailerSubTypesQuery = useTrailerSubTypesQuery();

frontend/src/features/permits/pages/Amend/hooks/useAmendPermitForm.ts

@@ -46,7 +46,6 @@ export const useAmendPermitForm = (
     if (amendmentApplication) {
       const eligibleSubtypes = getEligibleVehicleSubtypes(
         amendmentApplication.permitType,
-        isLcvDesignated,
         amendmentApplication.permitData.permittedCommodity?.commodityType,
         policyEngine,
       );
@@ -80,7 +79,6 @@ export const useAmendPermitForm = (
 
     const eligibleSubtypes = getEligibleVehicleSubtypes(
       defaultPermitFormData.permitType,
-      isLcvDesignated,
       defaultPermitFormData.permitData.permittedCommodity?.commodityType,
       policyEngine,
     );

frontend/src/features/permits/pages/Application/ApplicationForm.tsx

@@ -46,7 +46,10 @@ import {
 
 import {
   APPLICATIONS_ROUTES,
+  APPLICATION_QUEUE_ROUTES,
   APPLICATION_STEPS,
+  APPLICATION_STEP_CONTEXTS,
+  ApplicationStepContext,
   ERROR_ROUTES,
 } from "../../../../routes/constants";
 
@@ -59,9 +62,11 @@ const FEATURE = "application";
 export const ApplicationForm = ({
   permitType,
   companyId,
+  applicationStepContext,
 }: {
   permitType: PermitType;
   companyId: number;
+  applicationStepContext: ApplicationStepContext;
 }) => {
   // Context to hold all of the application data related to the application
   const applicationContext = useContext(ApplicationContext);
@@ -88,7 +93,7 @@ export const ApplicationForm = ({
     trailerSubtypeNamesMap,
   } = usePermitVehicleManagement(companyId);
 
-  const policyEngine = usePolicyEngine();
+  const policyEngine = usePolicyEngine(specialAuthorizations);
 
   // Use a custom hook that performs the following whenever page is rendered (or when application context is updated/changed):
   // 1. Get all data needed to initialize the application form (from application context, company, user details)
@@ -192,6 +197,7 @@ export const ApplicationForm = ({
     const updatedViolations = await triggerPolicyValidation();
     // prevent CV client continuing if there are policy engine validation errors
     if (Object.keys(updatedViolations).length > 0 && !isStaffUser) {
+      console.error(updatedViolations);
       return;
     }
 
@@ -201,10 +207,13 @@ export const ApplicationForm = ({
     const savedVehicleDetails = await handleSaveVehicle(vehicleData);
 
     // Save application before continuing
-    await onSaveApplication(
-      (permitId) => navigate(APPLICATIONS_ROUTES.REVIEW(permitId)),
-      savedVehicleDetails,
-    );
+    await onSaveApplication((permitId) => {
+      return navigate(
+        applicationStepContext === APPLICATION_STEP_CONTEXTS.QUEUE
+          ? APPLICATION_QUEUE_ROUTES.REVIEW(companyId, permitId)
+          : APPLICATIONS_ROUTES.REVIEW(permitId),
+      );
+    }, savedVehicleDetails);
   };
 
   const onSaveSuccess = (savedApplication: Application, status: number) => {

frontend/src/features/permits/pages/Application/ApplicationReview.tsx

@@ -65,7 +65,7 @@ export const ApplicationReview = ({
 
   const navigate = useNavigate();
 
-  const policyEngine = usePolicyEngine();
+  const policyEngine = usePolicyEngine(specialAuth);
   const { commodityOptions } = useCommodityOptions(policyEngine, permitType);
   const powerUnitSubTypesQuery = usePowerUnitSubTypesQuery();
   const trailerSubTypesQuery = useTrailerSubTypesQuery();

frontend/src/features/policy/hooks/usePolicyEngine.ts

@@ -3,14 +3,15 @@ import { Policy } from "onroute-policy-engine";
 
 import { usePolicyConfigurationQuery } from "./usePolicyConfigurationQuery";
 import { isNull } from "../../../common/types/common";
+import { SpecialAuthorizationData } from "../../settings/types/SpecialAuthorization";
 
 /**
  * Hook that instantiates the policy engine instance.
  * The hook will return undefined when policy configuration is still loading,
  * and null when there's a problem getting the policy configuration.
  * @returns The instantiated policy engine, or undefined when loading, and null on error 
  */
-export const usePolicyEngine = () => {
+export const usePolicyEngine = (specialAuthorizations?: SpecialAuthorizationData) => {
   const { data: policyConfiguration } = usePolicyConfigurationQuery();
 
   const policyEngine = useMemo(() => {
@@ -20,5 +21,9 @@ export const usePolicyEngine = () => {
     return new Policy(policyConfiguration.policy);
   }, [policyConfiguration]);
 
+  if (specialAuthorizations) {
+    policyEngine?.setSpecialAuthorizations(specialAuthorizations);
+  }
+
   return policyEngine;
 };