richie-education 3.1.3-dev2 → 3.1.3-dev23

package/js/pages/TeacherDashboardContractsLayout/TeacherDashboardContracts/index.spec.tsx

@@ -3,11 +3,7 @@ import { screen } from '@testing-library/react';
 import { getAllByRole } from '@testing-library/dom';
 import userEvent from '@testing-library/user-event';
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
-import {
-  ContractFactory,
-  CourseProductRelationFactory,
-  OrganizationFactory,
-} from 'utils/test/factories/joanie';
+import { ContractFactory, OfferingFactory, OrganizationFactory } from 'utils/test/factories/joanie';
 import { expectNoSpinner } from 'utils/test/expectSpinner';
 import { expectBannerError } from 'utils/test/expectBanner';
 import { HttpStatusCode } from 'utils/errors/HttpError';
@@ -37,8 +33,8 @@ jest.mock('components/ContractFrame', () => ({
 describe('pages/TeacherDashboardContracts', () => {
   setupJoanieSession();
 
-  it('should render a list of contracts for a course product relation', async () => {
-    const courseProductRelation = CourseProductRelationFactory().one();
+  it('should render a list of contracts for an offering', async () => {
+    const offering = OfferingFactory().one();
     const contracts = ContractFactory({
       student_signed_on: Date.toString(),
       organization_signed_on: Date.toString(),
@@ -48,31 +44,32 @@ describe('pages/TeacherDashboardContracts', () => {
 
     // OrganizationContractFilter request all organizations forwho the user have access
     fetchMock.get(
-      `https://joanie.endpoint/api/v1.0/organizations/?course_product_relation_id=${courseProductRelation.id}`,
+      `https://joanie.endpoint/api/v1.0/organizations/?offering_id=${offering.id}`,
       organizations,
     );
     // TeacherDashboardContracts request a paginated list of contracts to display
     fetchMock.get(
-      `https://joanie.endpoint/api/v1.0/organizations/${defaultOrganization.id}/contracts/?course_product_relation_id=${courseProductRelation.id}&signature_state=signed&page=1&page_size=25`,
+      `https://joanie.endpoint/api/v1.0/organizations/${defaultOrganization.id}/` +
+        `contracts/?offering_id=${offering.id}&signature_state=signed&page=1&page_size=25`,
       { results: contracts, count: 0, previous: null, next: null },
     );
     // useTeacherContractsToSign request all contract to sign, without pagination
     fetchMock.get(
-      `https://joanie.endpoint/api/v1.0/organizations/${defaultOrganization.id}/contracts/?signature_state=half_signed&course_product_relation_id=${courseProductRelation.id}`,
+      `https://joanie.endpoint/api/v1.0/organizations/${defaultOrganization.id}/` +
+        `contracts/?signature_state=half_signed&offering_id=${offering.id}`,
       { results: [], count: 0, previous: null, next: null },
     );
 
     render(<TeacherDashboardContracts />, {
       routerOptions: {
-        path: '/courses/:courseId/products/:courseProductRelationId/contracts',
-        initialEntries: [
-          `/courses/${courseProductRelation.course.id}/products/${courseProductRelation.id}/contracts`,
-        ],
+        path: '/courses/:courseId/products/:offeringId/contracts',
+        initialEntries: [`/courses/${offering.course.id}/products/${offering.id}/contracts`],
       },
     });
 
     await expectNoSpinner();
 
+    // screen.logTestingPlaygroundURL();
     // Organization filter should have been rendered
     const organizationFilter: HTMLInputElement = await screen.findByRole('combobox', {
       name: 'Organization',

package/js/pages/TeacherDashboardContractsLayout/TeacherDashboardContracts/index.tsx

@@ -42,20 +42,15 @@ const TeacherDashboardContracts = () => {
     defaultPage: page ? parseInt(page, 10) : 1,
     pageSize: PER_PAGE.teacherContractList,
   });
-  const {
-    organizationId: routeOrganizationId,
-    courseProductRelationId: routeCourseProductRelationId,
-  } = useParams<TeacherDashboardContractsParams>();
+  const { organizationId: routeOrganizationId, offeringId: routeOfferingId } =
+    useParams<TeacherDashboardContractsParams>();
   // organization list is used to show/hide organization filter.
   // when organizationId is in route's params this filter is always hidden.
   // therefore we don't need to enable this query.
   const {
     items: organizationList,
     states: { isFetched: isOrganizationListFetched },
-  } = useOrganizations(
-    { course_product_relation_id: routeCourseProductRelationId },
-    { enabled: !routeOrganizationId },
-  );
+  } = useOrganizations({ offering_id: routeOfferingId }, { enabled: !routeOrganizationId });
   const hasMultipleOrganizations = isOrganizationListFetched && organizationList.length > 1;
   const { initialFilters, filters, setFilters } = useTeacherContractFilters();
   const {
@@ -98,7 +93,7 @@ const TeacherDashboardContracts = () => {
       <div className="dashboard__page__actions">
         <ContractActionsBar
           organizationId={filters.organization_id!}
-          courseProductRelationId={filters.course_product_relation_id}
+          offeringId={filters.offering_id}
         />
         <ContractFiltersBar
           defaultValues={initialFilters}

package/js/pages/TeacherDashboardContractsLayout/components/BulkDownloadContractButton/index.spec.tsx

@@ -9,7 +9,7 @@ import JoanieApiProvider from 'contexts/JoanieApiContext';
 import { createTestQueryClient } from 'utils/test/createTestQueryClient';
 import { ContractDownloadStatus } from 'pages/TeacherDashboardContractsLayout/hooks/useDownloadContractArchive';
 
-import { CourseProductRelationFactory, OrganizationFactory } from 'utils/test/factories/joanie';
+import { OfferingFactory, OrganizationFactory } from 'utils/test/factories/joanie';
 import { unstoreContractArchiveId } from 'pages/TeacherDashboardContractsLayout/hooks/useDownloadContractArchive/contractArchiveLocalStorage';
 import BulkDownloadContractButton from '.';
 
@@ -44,26 +44,26 @@ describe.each([
   {
     testLabel: 'for all organization and all trainings',
     organization: undefined,
-    courseProductRelation: undefined,
+    offering: undefined,
   },
   {
     testLabel: 'for a training in an organization',
     organization: OrganizationFactory().one(),
-    courseProductRelation: CourseProductRelationFactory().one(),
+    offering: OfferingFactory().one(),
   },
   {
     testLabel: 'for an organization',
     organization: OrganizationFactory().one(),
-    courseProductRelation: undefined,
+    offering: undefined,
   },
   {
     testLabel: 'for a training',
     organization: undefined,
-    courseProductRelation: CourseProductRelationFactory().one(),
+    offering: OfferingFactory().one(),
   },
 ])(
   'TeacherDashboardContractsLayout/BulkDownloadContractButton $testLabel',
-  ({ organization, courseProductRelation }) => {
+  ({ organization, offering }) => {
     const Wrapper = ({ children }: PropsWithChildren) => {
       return (
         <IntlProvider locale="en">
@@ -86,7 +86,7 @@ describe.each([
       jest.resetAllMocks();
       unstoreContractArchiveId({
         organizationId: organization ? organization.id : undefined,
-        courseProductRelationId: courseProductRelation ? courseProductRelation.id : undefined,
+        offeringId: offering ? offering.id : undefined,
       });
     });
 
@@ -97,7 +97,7 @@ describe.each([
         <Wrapper>
           <BulkDownloadContractButton
             organizationId={organization?.id ?? undefined}
-            courseProductRelationId={courseProductRelation?.id ?? undefined}
+            offeringId={offering?.id ?? undefined}
           />
         </Wrapper>,
       );
@@ -118,7 +118,7 @@ describe.each([
         <Wrapper>
           <BulkDownloadContractButton
             organizationId={organization?.id ?? undefined}
-            courseProductRelationId={courseProductRelation?.id ?? undefined}
+            offeringId={offering?.id ?? undefined}
           />
         </Wrapper>,
       );
@@ -139,7 +139,7 @@ describe.each([
         <Wrapper>
           <BulkDownloadContractButton
             organizationId={organization?.id ?? undefined}
-            courseProductRelationId={courseProductRelation?.id ?? undefined}
+            offeringId={offering?.id ?? undefined}
           />
         </Wrapper>,
       );
@@ -160,7 +160,7 @@ describe.each([
         <Wrapper>
           <BulkDownloadContractButton
             organizationId={organization?.id ?? undefined}
-            courseProductRelationId={courseProductRelation?.id ?? undefined}
+            offeringId={offering?.id ?? undefined}
           />
         </Wrapper>,
       );

package/js/pages/TeacherDashboardContractsLayout/components/BulkDownloadContractButton/index.timer.spec.tsx

@@ -14,7 +14,7 @@ import {
   unstoreContractArchiveId,
 } from 'pages/TeacherDashboardContractsLayout/hooks/useDownloadContractArchive/contractArchiveLocalStorage';
 import { CONTRACT_DOWNLOAD_SETTINGS } from 'settings';
-import { CourseProductRelationFactory, OrganizationFactory } from 'utils/test/factories/joanie';
+import { OfferingFactory, OrganizationFactory } from 'utils/test/factories/joanie';
 import BulkDownloadContractButton from '.';
 
 jest.mock('utils/context', () => ({
@@ -45,26 +45,26 @@ describe.each([
   {
     testLabel: 'for all organization and all trainings',
     organization: undefined,
-    courseProductRelation: undefined,
+    offering: undefined,
   },
   {
     testLabel: 'for a training in an organization',
     organization: OrganizationFactory().one(),
-    courseProductRelation: CourseProductRelationFactory().one(),
+    offering: OfferingFactory().one(),
   },
   {
     testLabel: 'for an organization',
     organization: OrganizationFactory().one(),
-    courseProductRelation: undefined,
+    offering: undefined,
   },
   {
     testLabel: 'for a training',
     organization: undefined,
-    courseProductRelation: CourseProductRelationFactory().one(),
+    offering: OfferingFactory().one(),
   },
 ])(
   'TeacherDashboardContractsLayout/BulkDownloadContractButton with fake timer, $testLabel',
-  ({ organization, courseProductRelation }) => {
+  ({ organization, offering }) => {
     let localStorageArchiveFilters: LocalStorageArchiveFilters;
 
     const Wrapper = ({ children }: PropsWithChildren) => {
@@ -81,7 +81,7 @@ describe.each([
     beforeEach(() => {
       localStorageArchiveFilters = {
         organizationId: organization ? organization.id : undefined,
-        courseProductRelationId: courseProductRelation ? courseProductRelation.id : undefined,
+        offeringId: offering ? offering.id : undefined,
       };
       mockHasContractToDownload = true;
 
@@ -102,7 +102,7 @@ describe.each([
       jest.clearAllMocks();
       unstoreContractArchiveId({
         organizationId: organization ? organization.id : undefined,
-        courseProductRelationId: courseProductRelation ? courseProductRelation.id : undefined,
+        offeringId: offering ? offering.id : undefined,
       });
     });
 
@@ -114,7 +114,7 @@ describe.each([
         <Wrapper>
           <BulkDownloadContractButton
             organizationId={organization?.id ?? undefined}
-            courseProductRelationId={courseProductRelation?.id ?? undefined}
+            offeringId={offering?.id ?? undefined}
           />
         </Wrapper>,
       );
@@ -151,10 +151,7 @@ describe.each([
 
       render(
         <Wrapper>
-          <BulkDownloadContractButton
-            organizationId={organization?.id}
-            courseProductRelationId={courseProductRelation?.id}
-          />
+          <BulkDownloadContractButton organizationId={organization?.id} offeringId={offering?.id} />
         </Wrapper>,
       );
 

package/js/pages/TeacherDashboardContractsLayout/components/BulkDownloadContractButton/index.tsx

@@ -4,7 +4,7 @@ import { useEffect } from 'react';
 import useDownloadContractArchive, {
   ContractDownloadStatus,
 } from 'pages/TeacherDashboardContractsLayout/hooks/useDownloadContractArchive';
-import { CourseProductRelation, Organization } from 'types/Joanie';
+import { Offering, Organization } from 'types/Joanie';
 
 const messages = defineMessages({
   bulkDownloadButtonDownloadLabel: {
@@ -26,16 +26,16 @@ const messages = defineMessages({
 
 interface BulkDownloadContractButtonProps {
   organizationId?: Organization['id'];
-  courseProductRelationId?: CourseProductRelation['id'];
+  offeringId?: Offering['id'];
 }
 
 const BulkDownloadContractButton = ({
   organizationId,
-  courseProductRelationId,
+  offeringId,
 }: BulkDownloadContractButtonProps) => {
   const { downloadContractArchive, createContractArchive, status } = useDownloadContractArchive({
     organizationId,
-    courseProductRelationId,
+    offeringId,
   });
 
   useEffect(() => {

package/js/pages/TeacherDashboardContractsLayout/components/ContractActionsBar/index.spec.tsx

@@ -97,38 +97,30 @@ describe('TeacherDashboardContractsLayout/ContractActionsBar', () => {
     {
       label: "doesn't have contract to download",
       hasContractToDownload: false,
-      courseProductRelationId: undefined,
+      offeringId: undefined,
     },
     {
-      label: "doesn't have contract to download  and courseProductRelationId",
+      label: "doesn't have contract to download and offeringId",
       hasContractToDownload: false,
-      courseProductRelationId: faker.string.uuid(),
+      offeringId: faker.string.uuid(),
     },
-  ])(
-    'should only display sign button when $label',
-    ({ hasContractToDownload, courseProductRelationId }) => {
-      mockHasContractToDownload = hasContractToDownload;
-      mockCanSignContracts = true;
-      mockContractsToSignCount = 1;
-
-      render(
-        <Wrapper>
-          <ContractActionsBar
-            courseProductRelationId={courseProductRelationId}
-            organizationId={faker.string.uuid()}
-          />
-        </Wrapper>,
-      );
-
-      expect(screen.getByTestId('teacher-contracts-list-actionsBar')).toBeInTheDocument();
-      expect(
-        screen.getByRole('button', { name: /Sign all pending contracts/ }),
-      ).toBeInTheDocument();
-      expect(
-        screen.queryByRole('button', { name: /Request contracts archive/ }),
-      ).not.toBeInTheDocument();
-    },
-  );
+  ])('should only display sign button when $label', ({ hasContractToDownload, offeringId }) => {
+    mockHasContractToDownload = hasContractToDownload;
+    mockCanSignContracts = true;
+    mockContractsToSignCount = 1;
+
+    render(
+      <Wrapper>
+        <ContractActionsBar offeringId={offeringId} organizationId={faker.string.uuid()} />
+      </Wrapper>,
+    );
+
+    expect(screen.getByTestId('teacher-contracts-list-actionsBar')).toBeInTheDocument();
+    expect(screen.getByRole('button', { name: /Sign all pending contracts/ })).toBeInTheDocument();
+    expect(
+      screen.queryByRole('button', { name: /Request contracts archive/ }),
+    ).not.toBeInTheDocument();
+  });
 
   it("shouldn't only display download button", () => {
     mockHasContractToDownload = true;

package/js/pages/TeacherDashboardContractsLayout/components/ContractActionsBar/index.tsx

@@ -1,5 +1,5 @@
 import classNames from 'classnames';
-import { Organization, CourseProductRelation } from 'types/Joanie';
+import { Organization, Offering } from 'types/Joanie';
 import useTeacherContractsToSign from 'pages/TeacherDashboardContractsLayout/hooks/useTeacherContractsToSign';
 import useHasContractToDownload from 'pages/TeacherDashboardContractsLayout/hooks/useHasContractToDownload';
 import SignOrganizationContractButton from '../SignOrganizationContractButton';
@@ -7,18 +7,18 @@ import BulkDownloadContractButton from '../BulkDownloadContractButton';
 
 interface ContractActionsProps {
   organizationId: Organization['id'];
-  courseProductRelationId?: CourseProductRelation['id'];
+  offeringId?: Offering['id'];
 }
 
-const ContractActionsBar = ({ organizationId, courseProductRelationId }: ContractActionsProps) => {
+const ContractActionsBar = ({ organizationId, offeringId }: ContractActionsProps) => {
   const { canSignContracts, contractsToSignCount } = useTeacherContractsToSign({
     organizationId,
-    courseProductRelationId,
+    offeringId,
   });
-  const hasContractToDownload = useHasContractToDownload(organizationId, courseProductRelationId);
+  const hasContractToDownload = useHasContractToDownload(organizationId, offeringId);
 
   const nbAvailableActions = [canSignContracts, hasContractToDownload].filter((val) => val).length;
-  const courseProductRelationIds = courseProductRelationId ? [courseProductRelationId] : undefined;
+  const offeringIds = offeringId ? [offeringId] : undefined;
   return (
     nbAvailableActions > 0 && (
       <div
@@ -31,17 +31,14 @@ const ContractActionsBar = ({ organizationId, courseProductRelationId }: Contrac
         {canSignContracts && (
           <div>
             <SignOrganizationContractButton
-              courseProductRelationIds={courseProductRelationIds}
+              offeringIds={offeringIds}
               organizationId={organizationId}
               contractToSignCount={contractsToSignCount}
             />
           </div>
         )}
         {hasContractToDownload && (
-          <BulkDownloadContractButton
-            organizationId={organizationId}
-            courseProductRelationId={courseProductRelationId}
-          />
+          <BulkDownloadContractButton organizationId={organizationId} offeringId={offeringId} />
         )}
       </div>
     )

package/js/pages/TeacherDashboardContractsLayout/components/SignOrganizationContractButton/index.spec.tsx

@@ -70,19 +70,19 @@ describe('TeacherDashboardContractsLayout/SignOrganizationContractButton', () =>
     {
       label: "organization's contracts",
       organizationId: faker.string.uuid(),
-      courseProductRelationIds: undefined,
+      offeringIds: undefined,
     },
     {
       label: "organization's training contracts",
       organizationId: faker.string.uuid(),
-      courseProductRelationIds: [faker.string.uuid()],
+      offeringIds: [faker.string.uuid()],
     },
-  ])('should open $label frame on click', async ({ organizationId, courseProductRelationIds }) => {
+  ])('should open $label frame on click', async ({ organizationId, offeringIds }) => {
     render(
       <Wrapper>
         <SignOrganizationContractButton
           organizationId={organizationId}
-          courseProductRelationIds={courseProductRelationIds}
+          offeringIds={offeringIds}
           contractToSignCount={12}
         />
       </Wrapper>,
@@ -92,8 +92,8 @@ describe('TeacherDashboardContractsLayout/SignOrganizationContractButton', () =>
     const user = userEvent.setup();
 
     let getInvitationLinkUrl = `https://joanie.test/api/v1.0/organizations/${organizationId}/contracts-signature-link/`;
-    if (courseProductRelationIds) {
-      getInvitationLinkUrl += `?course_product_relation_ids=${courseProductRelationIds[0]}`;
+    if (offeringIds) {
+      getInvitationLinkUrl += `?offering_ids=${offeringIds[0]}`;
     }
 
     fetchMock.get(getInvitationLinkUrl, {

package/js/pages/TeacherDashboardContractsLayout/components/SignOrganizationContractButton/index.tsx

@@ -3,7 +3,7 @@ import { defineMessages, FormattedMessage } from 'react-intl';
 import { Button } from '@openfun/cunningham-react';
 import { OrganizationContractFrame } from 'components/ContractFrame';
 
-import { CourseProductRelation, Organization } from 'types/Joanie';
+import { Offering, Organization } from 'types/Joanie';
 
 const messages = defineMessages({
   signAllPendingContracts: {
@@ -14,7 +14,7 @@ const messages = defineMessages({
 });
 
 interface Props {
-  courseProductRelationIds?: CourseProductRelation['id'][];
+  offeringIds?: Offering['id'][];
   organizationId: Organization['id'];
   contractToSignCount: number;
 }
@@ -22,7 +22,7 @@ interface Props {
 const SignOrganizationContractButton = ({
   organizationId,
   contractToSignCount,
-  courseProductRelationIds = [],
+  offeringIds = [],
 }: Props) => {
   const [contractFrameOpened, setContractFrameOpened] = useState(false);
   const hasContractToSign = contractToSignCount > 0;
@@ -48,7 +48,7 @@ const SignOrganizationContractButton = ({
         </Button>
       )}
       <OrganizationContractFrame
-        courseProductRelationIds={courseProductRelationIds}
+        offeringIds={offeringIds}
         organizationId={organizationId}
         isOpen={contractFrameOpened}
         onClose={() => setContractFrameOpened(false)}

package/js/pages/TeacherDashboardContractsLayout/hooks/useCheckContractArchiveExists/index.spec.tsx

@@ -5,7 +5,7 @@ import { IntlProvider } from 'react-intl';
 import { PropsWithChildren } from 'react';
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
 import JoanieApiProvider from 'contexts/JoanieApiContext';
-import { CourseProductRelationFactory, OrganizationFactory } from 'utils/test/factories/joanie';
+import { OfferingFactory, OrganizationFactory } from 'utils/test/factories/joanie';
 import {
   LocalStorageArchiveFilters,
   storeContractArchiveId,
@@ -41,24 +41,24 @@ describe.each([
   {
     testLabel: 'for all organization and all trainings',
     organization: undefined,
-    courseProductRelation: undefined,
+    offering: undefined,
   },
   {
     testLabel: 'for a training in an organization',
     organization: OrganizationFactory().one(),
-    courseProductRelation: CourseProductRelationFactory().one(),
+    offering: OfferingFactory().one(),
   },
   {
     testLabel: 'for an organization',
     organization: OrganizationFactory().one(),
-    courseProductRelation: undefined,
+    offering: undefined,
   },
   {
     testLabel: 'for a training',
     organization: undefined,
-    courseProductRelation: CourseProductRelationFactory().one(),
+    offering: OfferingFactory().one(),
   },
-])('useCheckContractArchiveExists $testLabel', ({ organization, courseProductRelation }) => {
+])('useCheckContractArchiveExists $testLabel', ({ organization, offering }) => {
   const Wrapper = ({ children }: PropsWithChildren) => {
     return (
       <IntlProvider locale="en">
@@ -71,7 +71,7 @@ describe.each([
   beforeEach(() => {
     localStorageArchiveFilters = {
       organizationId: organization ? organization.id : undefined,
-      courseProductRelationId: courseProductRelation ? courseProductRelation.id : undefined,
+      offeringId: offering ? offering.id : undefined,
     };
 
     // Joanie providers calls

package/js/pages/TeacherDashboardContractsLayout/hooks/useCheckContractArchiveExists/index.tsx

@@ -2,17 +2,17 @@ import { useEffect, useRef, useState } from 'react';
 import useContractArchive from 'hooks/useContractArchive';
 import { CONTRACT_DOWNLOAD_SETTINGS } from 'settings';
 import { Nullable } from 'types/utils';
-import { CourseProductRelation, Organization } from 'types/Joanie';
+import { Offering, Organization } from 'types/Joanie';
 import { getStoredContractArchiveId } from '../useDownloadContractArchive/contractArchiveLocalStorage';
 
 export interface UseCheckContractArchiveExistsProps {
   organizationId?: Organization['id'];
-  courseProductRelationId?: CourseProductRelation['id'];
+  offeringId?: Offering['id'];
   enable?: boolean;
 }
 
 const useCheckContractArchiveExist = (
-  { organizationId, courseProductRelationId, enable = true }: UseCheckContractArchiveExistsProps = {
+  { organizationId, offeringId, enable = true }: UseCheckContractArchiveExistsProps = {
     enable: true,
   },
 ) => {
@@ -55,7 +55,7 @@ const useCheckContractArchiveExist = (
   useEffect(() => {
     const storedContractArchiveId = getStoredContractArchiveId({
       organizationId,
-      courseProductRelationId,
+      offeringId,
     });
 
     if (enable && storedContractArchiveId) {
@@ -63,7 +63,7 @@ const useCheckContractArchiveExist = (
     } else {
       setIsContractArchiveExists(false);
     }
-  }, [enable, organizationId, courseProductRelationId]);
+  }, [enable, organizationId, offeringId]);
 
   // Be sure to clear any timeout before unmouting the hook.
   useEffect(() => {