refactor: improve code efficiency and readability

src/components/EnterpriseApp/data/constants.js

@@ -19,3 +19,8 @@ export const BUDGET_STATUSES = {
  expired: 'Expired',
  upcoming: 'Upcoming',
 };
+
+export const OFFER_TYPES = {
+ ecommerce: 'ecommerce',
+ subsidy: 'subsidy',
+};

src/components/EnterpriseSubsidiesContext/data/hooks.js

@@ -10,6 +10,7 @@ import { camelCaseObject } from '@edx/frontend-platform/utils';
 import EcommerceApiService from '../../../data/services/EcommerceApiService';
 import LicenseManagerApiService from '../../../data/services/LicenseManagerAPIService';
 import SubsidyApiService from '../../../data/services/EnterpriseSubsidyApiService';
+import { OFFER_TYPES } from '../../EnterpriseApp/data/constants';
 
 export const useEnterpriseOffers = ({ enablePortalLearnerCreditManagementScreen, enterpriseId }) => {
  const [offers, setOffers] = useState([]);
@@ -39,9 +40,9 @@ export const useEnterpriseOffers = ({ enablePortalLearnerCreditManagementScreen,
 
  for (let i = 0; i < enterpriseResults.length; i++) {
  const subsidy = enterpriseResults[i];
- const source = 'subsidyApi';
- const { isActive } = subsidy; // Always check isActive for enterprise subsidies
- const isCurrent = isActive; // You can adjust this based on your specific requirements
+ const source = OFFER_TYPES.subsidy;
+ const { isActive } = subsidy;
+ const isCurrent = isActive;
  const activeSubsidyData = {
  id: subsidy.uuid,
  name: subsidy.title,
@@ -58,7 +59,7 @@ export const useEnterpriseOffers = ({ enablePortalLearnerCreditManagementScreen,
 
  for (let i = 0; i < ecommerceResults.length; i++) {
  const subsidy = ecommerceResults[i];
- const source = 'ecommerceApi';
+ const source = OFFER_TYPES.ecommerce;
  const { isCurrent } = subsidy;
  const activeSubsidyData = {
  id: subsidy.id,

src/components/EnterpriseSubsidiesContext/data/tests/hooks.test.js

@@ -4,6 +4,7 @@ import { useCoupons, useCustomerAgreement, useEnterpriseOffers } from '../hooks'
 import EcommerceApiService from '../../../../data/services/EcommerceApiService';
 import LicenseManagerApiService from '../../../../data/services/LicenseManagerAPIService';
 import SubsidyApiService from '../../../../data/services/EnterpriseSubsidyApiService';
+import { OFFER_TYPES } from '../../../EnterpriseApp/data/constants';
 
 jest.mock('@edx/frontend-platform/config', () => ({
  getConfig: jest.fn(() => ({
@@ -51,7 +52,7 @@ describe('useEnterpriseOffers', () => {
  start: '2021-05-15T19:56:09Z',
  end: '2100-05-15T19:56:09Z',
  isCurrent: true,
- source: 'ecommerceApi',
+ source: OFFER_TYPES.ecommerce,
  }];
 
  SubsidyApiService.getSubsidyByCustomerUUID.mockResolvedValueOnce({
@@ -132,15 +133,15 @@ describe('useEnterpriseOffers', () => {
  start: '2021-05-15T19:56:09Z',
  end: '2100-05-15T19:56:09Z',
  isCurrent: true,
- source: 'subsidyApi',
+ source: OFFER_TYPES.subsidy,
  },
  {
  id: 'uuid',
  name: 'offer-name',
  start: '2021-05-15T19:56:09Z',
  end: '2100-05-15T19:56:09Z',
  isCurrent: true,
- source: 'ecommerceApi',
+ source: OFFER_TYPES.ecommerce,
  },
  ];
 
@@ -215,15 +216,15 @@ describe('useEnterpriseOffers', () => {
  start: '2005-05-15T19:56:09Z',
  end: '2006-05-15T19:56:09Z',
  isCurrent: false,
- source: 'subsidyApi',
+ source: OFFER_TYPES.subsidy,
  },
  {
  id: 'offer-2',
  name: 'offer-name-2',
  start: '2006-05-15T19:56:09Z',
  end: '2099-05-15T19:56:09Z',
  isCurrent: true,
- source: 'subsidyApi',
+ source: OFFER_TYPES.subsidy,
  },
  ];
 

src/components/learner-credit-management/BudgetCard-V2.jsx

@@ -10,6 +10,7 @@ import {
 
 import { useOfferSummary } from './data/hooks';
 import SubBudgetCard from './Budgetcard-V3';
+import { OFFER_TYPES } from '../EnterpriseApp/data/constants';
 
 const LoadingCards = () => (
  <Stack gap={4}>
@@ -54,7 +55,7 @@ const BudgetCard = ({
  <Stack gap={4} className='mt-4'>
  {isLoadingOfferSummary ? (
  <LoadingCards />
- ) : offerType === 'ecommerceApi' ? (
+ ) : offerType === OFFER_TYPES.ecommerce ? (
  <SubBudgetCard
  id={offerSummary.offerId}
  start={start}

src/components/learner-credit-management/data/utils.js

@@ -20,12 +20,12 @@ export const transformOfferSummary = (offerSummary) => {
  const redeemedFunds = budgets[i].amountOfPolicySpent && parseFloat(budgets[i].amountOfPolicySpent);
  const remainingFunds = budgets[i].remainingBalance && parseFloat(budgets[i].remainingBalance);
  // Create an object with key-value pairs
- const budgetEntry = {
+ const updatedBudgetDetail = {
  redeemedFunds,
  remainingFunds,
  ...budgets[i],
  };
- budgetsSummary.push(budgetEntry);
+ budgetsSummary.push(updatedBudgetDetail);
  }
  }
 

src/components/learner-credit-management/tests/BudgetCard.test.jsx

@@ -14,6 +14,7 @@ import '@testing-library/jest-dom/extend-expect';
 import { IntlProvider } from '@edx/frontend-platform/i18n';
 import BudgetCard from '../BudgetCard-V2';
 import { useOfferSummary, useOfferRedemptions } from '../data/hooks';
+import { OFFER_TYPES } from '../../EnterpriseApp/data/constants';
 
 jest.mock('../data/hooks');
 useOfferSummary.mockReturnValue({
@@ -115,13 +116,13 @@ describe('<BudgetCard />', () => {
  expect(firstElementWithTestId).toHaveTextContent(formattedString);
  });
 
- it('renders SubBudgetCard when offerType is ecommerceApi', () => {
+ it('renders SubBudgetCard when offerType is ecommerce', () => {
  const mockOffer = {
  id: mockEnterpriseOfferId,
  name: mockOfferDisplayName,
  start: '2022-01-01',
  end: '2023-01-01',
- offerType: 'ecommerceApi',
+ offerType: OFFER_TYPES.ecommerce,
  };
  const mockOfferRedemption = {
  created: '2022-02-01',
@@ -166,7 +167,7 @@ describe('<BudgetCard />', () => {
  expect(screen.getByTestId('view-budget')).toBeInTheDocument();
  });
 
- it('renders SubBudgetCard when offerType is not ecommerceApi', () => {
+ it('renders SubBudgetCard when offerType is not ecommerce', () => {
  const mockOffer = {
  id: mockEnterpriseOfferId,
  name: mockOfferDisplayName,