ORV2-3166 Staff payment options behind feature flag (#1727)

Author: krishnan-aot

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

@@ -257,6 +257,29 @@ VALUES
     GETUTCDATE()
   );
 
+INSERT INTO
+  [dbo].[ORBC_FEATURE_FLAG] (
+    [FEATURE_ID],
+    [FEATURE_KEY],
+    [FEATURE_VALUE],
+    [CONCURRENCY_CONTROL_NUMBER],
+    [DB_CREATE_USERID],
+    [DB_CREATE_TIMESTAMP],
+    [DB_LAST_UPDATE_USERID],
+    [DB_LAST_UPDATE_TIMESTAMP]
+  )
+VALUES
+  (
+    '12',
+    'STAFF-CAN-PAY',
+    'DISABLED',
+    NULL,
+    N'dbo',
+    GETUTCDATE(),
+    N'dbo',
+    GETUTCDATE()
+  );
+
 SET
   IDENTITY_INSERT [dbo].[ORBC_FEATURE_FLAG] OFF
 GO

frontend/src/features/permits/pages/Application/components/pay/ChoosePaymentMethod.tsx

@@ -9,6 +9,7 @@ import {
   DEFAULT_EMPTY_CARD_TYPE,
   DEFAULT_EMPTY_PAYMENT_TYPE,
 } from "./types/PaymentMethodData";
+import { useFeatureFlagsQuery } from "../../../../../../common/hooks/hooks";
 
 export const ChoosePaymentMethod = ({
   availablePaymentMethods,
@@ -19,6 +20,7 @@ export const ChoosePaymentMethod = ({
 }) => {
   const { control, watch, setValue, clearErrors } = useFormContext();
   const currPaymentMethod = watch("paymentMethod");
+  const { data: featureFlags } = useFeatureFlagsQuery();
 
   const handlePaymentMethodChange = (
     selectedPaymentMethod: PaymentMethodTypeCode,
@@ -71,8 +73,8 @@ export const ChoosePaymentMethod = ({
                 handlePaymentMethodChange={handlePaymentMethodChange}
               />
             ))}
-
-            {showPayInPersonInfo ? (
+            {showPayInPersonInfo &&
+            featureFlags?.["STAFF-CAN-PAY"] === "ENABLED" ? (
               <CVPayInPersonInfo />
             ) : null}
           </RadioGroup>

frontend/src/features/permits/pages/Application/components/pay/PermitPayFeeSummary.tsx

@@ -1,9 +1,11 @@
-import { useEffect, useState } from "react";
+import { useContext, useEffect, useState } from "react";
 import { Box, Button } from "@mui/material";
 
 import "./PermitPayFeeSummary.scss";
 import { PermitType } from "../../../../types/PermitType";
 import { FeeSummary } from "../../../../components/feeSummary/FeeSummary";
+import OnRouteBCContext from "../../../../../../common/authentication/OnRouteBCContext";
+import { useFeatureFlagsQuery } from "../../../../../../common/hooks/hooks";
 
 export const PermitPayFeeSummary = ({
   calculatedFee,
@@ -20,6 +22,9 @@ export const PermitPayFeeSummary = ({
 }) => {
   const [showTooltip, setShowTooltip] = useState<boolean>(false);
   const disablePay = selectedItemsCount === 0;
+  const { idirUserDetails } = useContext(OnRouteBCContext);
+  const isStaffActingAsCompany = Boolean(idirUserDetails?.userRole);
+  const { data: featureFlags } = useFeatureFlagsQuery();
 
   const handlePayNow = () => {
     if (disablePay) {
@@ -57,7 +62,11 @@ export const PermitPayFeeSummary = ({
             className="permit-pay-fee-summary__btn"
             variant="contained"
             onClick={handlePayNow}
-            disabled={transactionPending}
+            disabled={
+              transactionPending ||
+              (isStaffActingAsCompany &&
+                featureFlags?.["STAFF-CAN-PAY"] !== "ENABLED")
+            }
           >
             Pay Now
           </Button>

frontend/src/features/permits/pages/ShoppingCart/ShoppingCartPage.tsx

@@ -53,6 +53,7 @@ import {
   TOLL_FREE_NUMBER,
   PPC_EMAIL,
 } from "../../../../common/constants/constants";
+import { useFeatureFlagsQuery } from "../../../../common/hooks/hooks";
 
 const AVAILABLE_STAFF_PAYMENT_METHODS = [
   PAYMENT_METHOD_TYPE_CODE.ICEPAY,
@@ -66,7 +67,11 @@ const AVAILABLE_CV_PAYMENT_METHODS = [PAYMENT_METHOD_TYPE_CODE.WEB];
 export const ShoppingCartPage = () => {
   const navigate = useNavigate();
   const { idirUserDetails, userDetails } = useContext(OnRouteBCContext);
-  const companyId: number = applyWhenNotNullable(id => Number(id), getCompanyIdFromSession(), 0);
+  const companyId: number = applyWhenNotNullable(
+    (id) => Number(id),
+    getCompanyIdFromSession(),
+    0,
+  );
   const isStaffActingAsCompany = Boolean(idirUserDetails?.userRole);
   const isCompanyAdmin = Boolean(
     userDetails?.userRole === BCeID_USER_ROLE.COMPANY_ADMINISTRATOR,
@@ -116,6 +121,7 @@ export const ShoppingCartPage = () => {
     useStartTransaction();
 
   const { mutation: issuePermitMutation, issueResults } = useIssuePermits();
+  const { data: featureFlags } = useFeatureFlagsQuery();
 
   const availablePaymentMethods = isStaffActingAsCompany
     ? AVAILABLE_STAFF_PAYMENT_METHODS
@@ -405,7 +411,10 @@ export const ShoppingCartPage = () => {
 
       <Box className="shopping-cart-page__right-container">
         <FormProvider {...formMethods}>
-          {!isFeeZero ? (
+          {!isFeeZero &&
+          ((isStaffActingAsCompany &&
+            featureFlags?.["STAFF-CAN-PAY"] === "ENABLED") ||
+            !isStaffActingAsCompany) ? (
             <ChoosePaymentMethod
               availablePaymentMethods={availablePaymentMethods}
               showPayInPersonInfo={!isStaffActingAsCompany}

vehicles/src/modules/permit-application-payment/payment/payment.service.ts

@@ -51,7 +51,10 @@ import { isCfsPaymentMethodType } from 'src/common/helper/payment.helper';
 import { CACHE_MANAGER } from '@nestjs/cache-manager';
 import { Cache } from 'cache-manager';
 import { CacheKey } from 'src/common/enum/cache-key.enum';
-import { getFromCache } from '../../../common/helper/cache.helper';
+import {
+  getFromCache,
+  getMapFromCache,
+} from '../../../common/helper/cache.helper';
 import { doesUserHaveRole } from '../../../common/helper/auth.helper';
 import { IDIR_USER_ROLE_LIST } from '../../../common/enum/user-role.enum';
 import {
@@ -63,6 +66,7 @@ import {
   isFeatureEnabled,
 } from '../../../common/helper/common.helper';
 import { TIMEZONE_PACIFIC } from 'src/common/constants/api.constant';
+import { FeatureFlagValue } from '../../../common/enum/feature-flag-value.enum';
 import { PermitData } from 'src/common/interface/permit.template.interface';
 import { isValidLoa } from 'src/common/helper/validate-loa.helper';
 import { PermitHistoryDto } from '../permit/dto/response/permit-history.dto';
@@ -266,6 +270,18 @@ export class PaymentService {
     createTransactionDto: CreateTransactionDto,
     nestedQueryRunner?: QueryRunner,
   ): Promise<ReadTransactionDto> {
+    const featureFlags = await getMapFromCache(
+      this.cacheManager,
+      CacheKey.FEATURE_FLAG_TYPE,
+    );
+    if (
+      doesUserHaveRole(currentUser.orbcUserRole, IDIR_USER_ROLE_LIST) &&
+      featureFlags?.['STAFF-CAN-PAY'] &&
+      (featureFlags['STAFF-CAN-PAY'] as FeatureFlagValue) !==
+        FeatureFlagValue.ENABLED
+    ) {
+      throwUnprocessableEntityException('Disabled feature');
+    }
     if (
       !doesUserHaveRole(currentUser.orbcUserRole, IDIR_USER_ROLE_LIST) &&
       createTransactionDto?.paymentMethodTypeCode !==