richie-education 2.25.0-b2.dev69 → 2.25.0-b2.dev77

package/js/components/ContractFrame/OrganizationContractFrame.spec.tsx

@@ -6,9 +6,14 @@ import { IntlProvider } from 'react-intl';
 import fetchMock from 'fetch-mock';
 import { QueryStateFactory } from 'utils/test/factories/reactQuery';
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
-import { ContractFactory, OrganizationFactory } from 'utils/test/factories/joanie';
+import {
+  ContractFactory,
+  CourseProductRelationFactory,
+  OrganizationFactory,
+} from 'utils/test/factories/joanie';
 import { createTestQueryClient } from 'utils/test/createTestQueryClient';
 import JoanieSessionProvider from 'contexts/SessionContext/JoanieSessionProvider';
+import { isCourseProductRelation } from 'types/Joanie';
 import { Props } from './AbstractContractFrame';
 import { OrganizationContractFrame } from '.';
 
@@ -70,132 +75,93 @@ describe('OrganizationContractFrame', () => {
     fetchMock.restore();
   });
 
-  it('should implement AbstractContractFrame for organization', async () => {
-    const organization = OrganizationFactory().one();
-    const contract = ContractFactory().one();
-    const isOpen = faker.datatype.boolean();
-
-    const expectedUrls = {
-      getInvitationLink: `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/contracts-signature-link/`,
-      checkSignature: `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/contracts/?id=${contract.id}`,
-    };
-
-    fetchMock
-      .get(expectedUrls.getInvitationLink, {
-        invitation_link: faker.internet.url(),
-        contract_ids: [contract.id],
-      })
-      .get(expectedUrls.checkSignature, { results: [contract] });
-
-    const handleDone = jest.fn();
-    const handleClose = jest.fn();
-
-    const client = createTestQueryClient({
-      user: true,
-      queriesCallback: (queries) => {
-        // Push contract and orders queries
-        queries.push(QueryStateFactory(['user', 'organization_contracts'], { data: [] }));
-      },
-    });
-
-    let contractsQueryState = client.getQueryState(['user', 'organization_contracts']);
-    expect(contractsQueryState?.isInvalidated).toBe(false);
-
-    await act(async () => {
-      render(
-        <Wrapper client={client}>
-          <OrganizationContractFrame
-            organizationId={organization.id}
-            isOpen={isOpen}
-            onDone={handleDone}
-            onClose={handleClose}
-          />
-        </Wrapper>,
-      );
-    });
-
-    // isOpen should be passed down to AbstractContractFrame
-    const contractFrame = await screen.getByTestId('AbstractContractFrame');
-    expect(contractFrame).toHaveAttribute('data-is-open', String(isOpen));
-
-    // getInvitationLink should post on order/submit-for-signature endpoint
-    expect(fetchMock.called(expectedUrls.getInvitationLink)).toBe(true);
-
-    // checkSignature should get on order endpoint
-    expect(fetchMock.called(expectedUrls.checkSignature)).toBe(true);
-
-    // onDone should be tweaked to invalidate the user orders and contracts queries
-    // and passed down to AbstractContractFrame
-    contractsQueryState = client.getQueryState(['user', 'organization_contracts']);
-    expect(contractsQueryState?.isInvalidated).toBe(true);
-    expect(handleDone).toHaveBeenCalledTimes(1);
-
-    // onClose should be passed down to AbstractContractFrame
-    expect(handleClose).toHaveBeenCalledTimes(1);
-  });
-
-  it('should implement AbstractContractFrame for organization with a list of contract ids', async () => {
-    const organization = OrganizationFactory().one();
-    const contracts = ContractFactory().many(2);
-    const isOpen = faker.datatype.boolean();
-
-    const expectedUrls = {
-      getInvitationLink: `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/contracts-signature-link/?contracts_ids=${contracts[0].id}&contracts_ids=${contracts[1].id}`,
-      checkSignature: `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/contracts/?id=${contracts[0].id}&id=${contracts[1].id}`,
-    };
-
-    fetchMock
-      .get(expectedUrls.getInvitationLink, {
-        invitation_link: faker.internet.url(),
-        contract_ids: contracts.map((contract) => contract.id),
-      })
-      .get(expectedUrls.checkSignature, { results: [contracts] });
-
-    const handleDone = jest.fn();
-    const handleClose = jest.fn();
-
-    const client = createTestQueryClient({
-      user: true,
-      queriesCallback: (queries) => {
-        // Push contract and orders queries
-        queries.push(QueryStateFactory(['user', 'organization_contracts'], { data: [] }));
-      },
-    });
-
-    let contractsQueryState = client.getQueryState(['user', 'organization_contracts']);
-    expect(contractsQueryState?.isInvalidated).toBe(false);
-
-    await act(async () => {
-      render(
-        <Wrapper client={client}>
-          <OrganizationContractFrame
-            organizationId={organization.id}
-            contractIds={contracts.map((contract) => contract.id)}
-            isOpen={isOpen}
-            onDone={handleDone}
-            onClose={handleClose}
-          />
-        </Wrapper>,
-      );
-    });
-
-    // isOpen should be passed down to AbstractContractFrame
-    const contractFrame = await screen.getByTestId('AbstractContractFrame');
-    expect(contractFrame).toHaveAttribute('data-is-open', String(isOpen));
-
-    // getInvitationLink should post on order/submit-for-signature endpoint
-    expect(fetchMock.called(expectedUrls.getInvitationLink)).toBe(true);
-
-    // checkSignature should get on order endpoint
-    expect(fetchMock.called(expectedUrls.checkSignature)).toBe(true);
-
-    // onDone should be tweaked to invalidate the user orders and contracts queries
-    // and passed down to AbstractContractFrame
-    contractsQueryState = client.getQueryState(['user', 'organization_contracts']);
-    expect(contractsQueryState?.isInvalidated).toBe(true);
-    expect(handleDone).toHaveBeenCalledTimes(1);
-
-    // onClose should be passed down to AbstractContractFrame
-    expect(handleClose).toHaveBeenCalledTimes(1);
-  });
+  it.each([
+    {
+      label: 'contractList: undefined, courseProductRelation: undefined',
+      contractList: undefined,
+      courseProductRelation: undefined,
+    },
+    {
+      label: 'contractList: 2 Contract, courseProductRelation: undefined',
+      contractList: ContractFactory().many(2),
+      courseProductRelation: undefined,
+    },
+    {
+      label: 'contractList: undefined, courseProductRelation: one CourseProductRelation',
+      contractList: undefined,
+      courseProductRelation: CourseProductRelationFactory().one(),
+    },
+  ])(
+    'should implement AbstractContractFrame for organization and $label',
+    async ({ contractList, courseProductRelation }) => {
+      const organization = OrganizationFactory().one();
+      const contracts = contractList || ContractFactory().many(2);
+      const isOpen = faker.datatype.boolean();
+
+      const invitationLinkQueryString =
+        courseProductRelation && isCourseProductRelation(courseProductRelation)
+          ? `?course_product_relation_ids=${courseProductRelation.id}`
+          : '';
+      const expectedUrls = {
+        getInvitationLink: `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/contracts-signature-link/${invitationLinkQueryString}`,
+        checkSignature: `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/contracts/?id=${contracts[0].id}&id=${contracts[1].id}`,
+      };
+
+      fetchMock
+        .get(expectedUrls.getInvitationLink, {
+          invitation_link: faker.internet.url(),
+          contract_ids: contracts.map((contract) => contract.id),
+        })
+        .get(expectedUrls.checkSignature, { results: [contracts] });
+
+      const handleDone = jest.fn();
+      const handleClose = jest.fn();
+
+      const client = createTestQueryClient({
+        user: true,
+        queriesCallback: (queries) => {
+          // Push contract and orders queries
+          queries.push(QueryStateFactory(['user', 'organization_contracts'], { data: [] }));
+        },
+      });
+
+      let contractsQueryState = client.getQueryState(['user', 'organization_contracts']);
+      expect(contractsQueryState?.isInvalidated).toBe(false);
+
+      await act(async () => {
+        render(
+          <Wrapper client={client}>
+            <OrganizationContractFrame
+              organizationId={organization.id}
+              courseProductRelationIds={
+                courseProductRelation ? [courseProductRelation.id] : undefined
+              }
+              isOpen={isOpen}
+              onDone={handleDone}
+              onClose={handleClose}
+            />
+          </Wrapper>,
+        );
+      });
+
+      // isOpen should be passed down to AbstractContractFrame
+      const contractFrame = screen.getByTestId('AbstractContractFrame');
+      expect(contractFrame).toHaveAttribute('data-is-open', String(isOpen));
+
+      // getInvitationLink should post on order/submit-for-signature endpoint
+      expect(fetchMock.called(expectedUrls.getInvitationLink)).toBe(true);
+
+      // checkSignature should get on order endpoint
+      expect(fetchMock.called(expectedUrls.checkSignature)).toBe(true);
+
+      // onDone should be tweaked to invalidate the user orders and contracts queries
+      // and passed down to AbstractContractFrame
+      contractsQueryState = client.getQueryState(['user', 'organization_contracts']);
+      expect(contractsQueryState?.isInvalidated).toBe(true);
+      expect(handleDone).toHaveBeenCalledTimes(1);
+
+      // onClose should be passed down to AbstractContractFrame
+      expect(handleClose).toHaveBeenCalledTimes(1);
+    },
+  );
 });

package/js/components/ContractFrame/OrganizationContractFrame.tsx

@@ -4,14 +4,21 @@ import { useJoanieApi } from 'contexts/JoanieApiContext';
 import AbstractContractFrame, {
   AbstractProps,
 } from 'components/ContractFrame/AbstractContractFrame';
-import { Contract } from 'types/Joanie';
+import { Contract, CourseProductRelation } from 'types/Joanie';
 
 interface Props extends AbstractProps {
   contractIds?: Contract['id'][];
   organizationId: string;
+  courseProductRelationIds?: CourseProductRelation['id'][];
 }
 
-const OrganizationContractFrame = ({ organizationId, contractIds, onDone, ...props }: Props) => {
+const OrganizationContractFrame = ({
+  organizationId,
+  courseProductRelationIds = [],
+  contractIds,
+  onDone,
+  ...props
+}: Props) => {
   const api = useJoanieApi();
   const queryClient = useQueryClient();
   const [contractIdsToCheck, setContractIdsToCheck] = useState(contractIds);
@@ -22,6 +29,7 @@ const OrganizationContractFrame = ({ organizationId, contractIds, onDone, ...pro
      be signed. We need to keep track of these ids to check if all contracts have been signed.
      */
     const response = await api.organizations.contracts.getSignatureLinks({
+      course_product_relation_ids: courseProductRelationIds,
       organization_id: organizationId,
       contracts_ids: contractIds,
     });

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

@@ -76,18 +76,19 @@ describe('pages/TeacherDashboardContracts', () => {
       student_signed_on: Date.toString(),
       organization_signed_on: Date.toString(),
     }).many(3);
-    const organization = OrganizationFactory().one();
+    const organizations = OrganizationFactory().many(2);
+    const defaultOrganization = organizations[0];
 
     // OrganizationContractFilter request all organizations forwho the user have access
-    fetchMock.get(`https://joanie.test/api/v1.0/organizations/`, [organization]);
+    fetchMock.get(`https://joanie.test/api/v1.0/organizations/`, organizations);
     // TeacherDashboardContracts request a paginated list of contracts to display
     fetchMock.get(
-      `https://joanie.test/api/v1.0/organizations/${organization.id}/contracts/?course_product_relation_id=2&signature_state=signed&page=1&page_size=25`,
+      `https://joanie.test/api/v1.0/organizations/${defaultOrganization.id}/contracts/?course_product_relation_id=2&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.test/api/v1.0/organizations/${organization.id}/contracts/?course_product_relation_id=2&signature_state=half_signed`,
+      `https://joanie.test/api/v1.0/organizations/${defaultOrganization.id}/contracts/?signature_state=half_signed&course_product_relation_id=2`,
       { results: [], count: 0, previous: null, next: null },
     );
 
@@ -101,10 +102,10 @@ describe('pages/TeacherDashboardContracts', () => {
     await expectNoSpinner();
 
     // Organization filter should have been rendered
-    const organizationFilter: HTMLInputElement = screen.getByRole('combobox', {
+    const organizationFilter: HTMLInputElement = await screen.findByRole('combobox', {
       name: 'Organization',
     });
-    expect(organizationFilter).toHaveAttribute('value', organization.title);
+    expect(organizationFilter).toHaveAttribute('value', defaultOrganization.title);
 
     // Signature state filter should have been rendered
     const signatureStateFilter: HTMLInputElement = screen.getByRole('combobox', {
@@ -330,4 +331,34 @@ describe('pages/TeacherDashboardContracts', () => {
     await expectNoSpinner();
     await expectBannerError('An error occurred while fetching contracts. Please retry later.');
   });
+
+  it('should hide organization filter when user only have one organization', async () => {
+    const defaultOrganization = OrganizationFactory().one();
+    fetchMock.get('https://joanie.test/api/v1.0/organizations/', [defaultOrganization]);
+
+    const contracts = ContractFactory({
+      student_signed_on: Date.toString(),
+      abilities: { sign: true },
+    }).many(3);
+    fetchMock.get(
+      `https://joanie.test/api/v1.0/organizations/${defaultOrganization.id}/contracts/?signature_state=signed&page=1&page_size=25`,
+      { results: [], count: 0, previous: null, next: null },
+    );
+    fetchMock.get(
+      `https://joanie.test/api/v1.0/organizations/${defaultOrganization.id}/contracts/?signature_state=half_signed`,
+      { results: contracts, count: 3, previous: null, next: null },
+    );
+    render(<Wrapper path="/" initialEntry="" />);
+    await expectNoSpinner();
+
+    // Signature state filter should have been rendered
+    screen.getByRole('combobox', {
+      name: 'Signature state',
+      hidden: true,
+    });
+
+    // Organization filter should not have been rendered
+    const organizationFilter = screen.queryByRole('combobox', { name: 'Organization' });
+    expect(organizationFilter).not.toBeInTheDocument();
+  });
 });

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

@@ -9,6 +9,7 @@ import Banner, { BannerType } from 'components/Banner';
 import { PER_PAGE } from 'settings';
 import { ContractResourceQuery } from 'types/Joanie';
 
+import { useOrganizations } from 'hooks/useOrganizations';
 import ContractFiltersBar from '../components/ContractFiltersBar';
 import useTeacherContractFilters, {
   TeacherDashboardContractsParams,
@@ -41,7 +42,15 @@ const TeacherDashboardContracts = () => {
     defaultPage: page ? parseInt(page, 10) : 1,
     pageSize: PER_PAGE.teacherContractList,
   });
-  const { organizationId } = useParams<TeacherDashboardContractsParams>();
+  const { organizationId: routeOrganizationId } = 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(undefined, { enabled: !!routeOrganizationId });
+  const hasMultipleOrganizations = isOrganizationListFetched && organizationList.length > 1;
   const { initialFilters, filters, setFilters } = useTeacherContractFilters();
   const {
     items: contracts,
@@ -88,7 +97,7 @@ const TeacherDashboardContracts = () => {
         <ContractFiltersBar
           defaultValues={initialFilters}
           onFiltersChange={handleFiltersChange}
-          hideFilterOrganization={!!organizationId}
+          hideFilterOrganization={!!(routeOrganizationId || !hasMultipleOrganizations)}
         />
       </div>
       <DataGrid

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

@@ -19,6 +19,7 @@ const ContractActionsBar = ({ organizationId, courseProductRelationId }: Contrac
 
   const canDownloadContracts = hasContractToDownload && !courseProductRelationId;
   const nbAvailableActions = [canSignContracts, canDownloadContracts].filter((val) => val).length;
+  const courseProductRelationIds = courseProductRelationId ? [courseProductRelationId] : undefined;
   return (
     nbAvailableActions > 0 && (
       <div
@@ -31,6 +32,7 @@ const ContractActionsBar = ({ organizationId, courseProductRelationId }: Contrac
         {canSignContracts && (
           <div>
             <SignOrganizationContractButton
+              courseProductRelationIds={courseProductRelationIds}
               organizationId={organizationId}
               contractToSignCount={contractsToSignCount}
             />

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

@@ -1,12 +1,13 @@
 import { faker } from '@faker-js/faker';
 import { render, screen } from '@testing-library/react';
-import { IntlProvider } from 'react-intl';
 import { PropsWithChildren } from 'react';
+import { IntlProvider } from 'react-intl';
 import { QueryClientProvider } from '@tanstack/react-query';
+import fetchMock from 'fetch-mock';
+import userEvent from '@testing-library/user-event';
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
 import JoanieApiProvider from 'contexts/JoanieApiContext';
 import { createTestQueryClient } from 'utils/test/createTestQueryClient';
-
 import SignOrganizationContractButton from '.';
 
 jest.mock('utils/context', () => ({
@@ -35,26 +36,27 @@ describe('TeacherDashboardContractsLayout/SignOrganizationContractButton', () =>
   });
 
   afterEach(() => {
-    jest.resetAllMocks();
+    fetchMock.restore();
   });
 
-  it("shouldn't render sign button and <OrganizationContractFrame/> when contractToSignCount > 0", () => {
+  it('should display sign button user have some contract to sign', () => {
     render(
       <Wrapper>
         <SignOrganizationContractButton
           organizationId={faker.string.uuid()}
-          contractToSignCount={1}
+          contractToSignCount={12}
         />
       </Wrapper>,
     );
 
-    expect(screen.getByRole('button', { name: /Sign all pending contracts/ })).toBeInTheDocument();
-
+    expect(
+      screen.getByRole('button', { name: 'Sign all pending contracts (12)' }),
+    ).toBeInTheDocument();
     const DashboardContractFramePortal = document.getElementsByClassName('ReactModalPortal');
     expect(DashboardContractFramePortal).toHaveLength(1);
   });
 
-  it("shouldn't only render <OrganizationContractFrame/> when contractToSignCount is 0", () => {
+  it("shouldn't display sign button user don't have some contract to sign", () => {
     render(
       <Wrapper>
         <SignOrganizationContractButton
@@ -67,8 +69,47 @@ describe('TeacherDashboardContractsLayout/SignOrganizationContractButton', () =>
     expect(
       screen.queryByRole('button', { name: /Sign all pending contracts/ }),
     ).not.toBeInTheDocument();
-
     const DashboardContractFramePortal = document.getElementsByClassName('ReactModalPortal');
     expect(DashboardContractFramePortal).toHaveLength(1);
   });
+
+  it.each([
+    {
+      label: "organization's contracts",
+      organizationId: faker.string.uuid(),
+      courseProductRelationIds: undefined,
+    },
+    {
+      label: "organization's training contracts",
+      organizationId: faker.string.uuid(),
+      courseProductRelationIds: [faker.string.uuid()],
+    },
+  ])('should open $label frame on click', async ({ organizationId, courseProductRelationIds }) => {
+    render(
+      <Wrapper>
+        <SignOrganizationContractButton
+          organizationId={organizationId}
+          courseProductRelationIds={courseProductRelationIds}
+          contractToSignCount={12}
+        />
+      </Wrapper>,
+    );
+
+    const $button = screen.getByRole('button', { name: /Sign all pending contracts/ });
+    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]}`;
+    }
+
+    fetchMock.get(getInvitationLinkUrl, {
+      invitation_link: 'https://dummysignaturebackend.fr',
+      contract_ids: [],
+    });
+    await user.click($button);
+
+    expect(screen.getByTestId('dashboard-contract-frame')).toBeInTheDocument();
+    expect(fetchMock.called(getInvitationLinkUrl)).toBe(true);
+  });
 });

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 { Organization } from 'types/Joanie';
+import { CourseProductRelation, Organization } from 'types/Joanie';
 
 const messages = defineMessages({
   signAllPendingContracts: {
@@ -14,11 +14,16 @@ const messages = defineMessages({
 });
 
 interface Props {
+  courseProductRelationIds?: CourseProductRelation['id'][];
   organizationId: Organization['id'];
   contractToSignCount: number;
 }
 
-const SignOrganizationContractButton = ({ organizationId, contractToSignCount }: Props) => {
+const SignOrganizationContractButton = ({
+  organizationId,
+  contractToSignCount,
+  courseProductRelationIds = [],
+}: Props) => {
   const [contractFrameOpened, setContractFrameOpened] = useState(false);
   const hasContractToSign = contractToSignCount > 0;
 
@@ -43,6 +48,7 @@ const SignOrganizationContractButton = ({ organizationId, contractToSignCount }:
         </Button>
       )}
       <OrganizationContractFrame
+        courseProductRelationIds={courseProductRelationIds}
         organizationId={organizationId}
         isOpen={contractFrameOpened}
         onClose={() => setContractFrameOpened(false)}

package/js/types/Joanie.ts

@@ -452,6 +452,7 @@ export interface ContractResourceQuery extends PaginatedResourceQuery {
 export interface OrganizationContractSignatureLinksFilters {
   contracts_ids?: string[];
   organization_id: Organization['id'];
+  course_product_relation_ids?: CourseProductRelation['id'][];
 }
 
 export interface ContractInvitationLinkResponse {

package/js/widgets/Dashboard/components/DashboardItem/CourseEnrolling/hooks/useCourseRunPeriodMessage.ts

@@ -0,0 +1,76 @@
+import { defineMessages, useIntl } from 'react-intl';
+import useDateRelative from 'hooks/useDateRelative';
+import { Priority } from 'types';
+import { CourseRun } from 'types/Joanie';
+import useDateFormat, { DEFAULT_DATE_FORMAT } from 'hooks/useDateFormat';
+
+const messages = defineMessages({
+  onGoingRunPeriod: {
+    id: 'components.useCourseRunPeriodMessage.onGoingRunPeriod',
+    description: 'Text to display when a course run is on going.',
+    defaultMessage: 'This session started on {startDate} and will end on {endDate}',
+  },
+  futureRunPeriod: {
+    id: 'components.useCourseRunPeriodMessage.futureRunPeriod',
+    description: 'Text to display the period of a future course run.',
+    defaultMessage: 'This session starts {relativeStartDate}, the {startDate}',
+  },
+  onGoingEnrolledRunPeriod: {
+    id: 'components.useCourseRunPeriodMessage.onGoingEnrolledRunPeriod',
+    description: 'Text to display when a course run is ongoing and the user is enrolled to.',
+    defaultMessage: "You are enrolled for this session. It's open from {startDate} to {endDate}",
+  },
+  futureEnrolledRunPeriod: {
+    id: 'components.useCourseRunPeriodMessage.futureEnrolledRunPeriod',
+    description: 'Text to display when a course run is not yet opened and the user is enrolled to.',
+    defaultMessage:
+      'You are enrolled for this session. It starts {relativeStartDate}, the {startDate}.',
+  },
+  archivedEnrolledRunPeriod: {
+    id: 'components.useCourseRunPeriodMessage.archivedEnrolledRunPeriod',
+    description: 'Text to display when a course run is archived and the user is enrolled to.',
+    defaultMessage: 'You are enrolled for this session.',
+  },
+});
+
+const useCourseRunPeriodMessage = (courseRun: CourseRun, enrolled: boolean = false) => {
+  const intl = useIntl();
+  const formatDate = useDateFormat();
+
+  const relativeStartDate = useDateRelative(new Date(courseRun.start));
+  const startDate = formatDate(courseRun.start, DEFAULT_DATE_FORMAT);
+  const endDate = formatDate(courseRun.end, DEFAULT_DATE_FORMAT);
+  const isArchived = [Priority.ARCHIVED_CLOSED, Priority.ARCHIVED_OPEN].includes(
+    courseRun.state.priority,
+  );
+  const isOnGoing = [Priority.ONGOING_OPEN, Priority.ONGOING_CLOSED].includes(
+    courseRun.state.priority,
+  );
+  if (enrolled) {
+    if (isArchived) {
+      return intl.formatMessage(messages.archivedEnrolledRunPeriod);
+    }
+    if (isOnGoing) {
+      return intl.formatMessage(messages.onGoingEnrolledRunPeriod, {
+        startDate,
+        endDate,
+      });
+    }
+    return intl.formatMessage(messages.futureEnrolledRunPeriod, {
+      relativeStartDate,
+      startDate,
+    });
+  }
+  if (isOnGoing) {
+    return intl.formatMessage(messages.onGoingRunPeriod, {
+      startDate,
+      endDate,
+    });
+  }
+  return intl.formatMessage(messages.futureRunPeriod, {
+    relativeStartDate,
+    startDate,
+  });
+};
+
+export default useCourseRunPeriodMessage;