richie-education 2.25.0-b2.dev32 → 2.25.0-b2.dev35

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

@@ -0,0 +1,100 @@
+import fetchMock from 'fetch-mock';
+import { faker } from '@faker-js/faker';
+import { renderHook, waitFor } from '@testing-library/react';
+import { IntlProvider } from 'react-intl';
+import { QueryClientProvider } from '@tanstack/react-query';
+import { PropsWithChildren } from 'react';
+import { PER_PAGE } from 'settings';
+import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
+import { ContractState } from 'types/Joanie';
+import { ContractFactory } from 'utils/test/factories/joanie';
+import { createTestQueryClient } from 'utils/test/createTestQueryClient';
+import JoanieSessionProvider from 'contexts/SessionContext/JoanieSessionProvider';
+import useHasContractToDownload from '.';
+
+jest.mock('utils/context', () => ({
+  __esModule: true,
+  default: mockRichieContextFactory({
+    authentication: { backend: 'fonzie', endpoint: 'https://auth.test' },
+    joanie_backend: { endpoint: 'https://joanie.test' },
+  }).one(),
+}));
+
+describe('hooks/useHasContractToDownload', () => {
+  const Wrapper = ({ children }: PropsWithChildren) => {
+    return (
+      <IntlProvider locale="en">
+        <QueryClientProvider client={createTestQueryClient({ user: true })}>
+          <JoanieSessionProvider>{children}</JoanieSessionProvider>
+        </QueryClientProvider>
+      </IntlProvider>
+    );
+  };
+
+  beforeEach(() => {
+    // Joanie providers calls
+    fetchMock.get('https://joanie.test/api/v1.0/orders/', []);
+    fetchMock.get('https://joanie.test/api/v1.0/credit-cards/', []);
+    fetchMock.get('https://joanie.test/api/v1.0/addresses/', []);
+  });
+
+  afterEach(() => {
+    fetchMock.restore();
+  });
+
+  it('should return null when joanie request is pending', async () => {
+    const organizationId = faker.string.uuid();
+    const contractListUrl = `https://joanie.test/api/v1.0/organizations/${organizationId}/contracts/?signature_state=${ContractState.SIGNED}&page=1&page_size=${PER_PAGE.teacherContractList}`;
+    fetchMock.get(contractListUrl, {
+      count: 1,
+      next: null,
+      previous: null,
+      results: [ContractFactory().one()],
+    });
+
+    const { result } = renderHook(() => useHasContractToDownload(organizationId), {
+      wrapper: Wrapper,
+    });
+
+    expect(result.current).toBeNull();
+  });
+
+  it('should return true when joanie return some signed contracts', async () => {
+    const organizationId = faker.string.uuid();
+    const contractListUrl = `https://joanie.test/api/v1.0/organizations/${organizationId}/contracts/?signature_state=${ContractState.SIGNED}&page=1&page_size=${PER_PAGE.teacherContractList}`;
+    fetchMock.get(contractListUrl, {
+      count: 1,
+      next: null,
+      previous: null,
+      results: [ContractFactory().one()],
+    });
+
+    const { result } = renderHook(() => useHasContractToDownload(organizationId), {
+      wrapper: Wrapper,
+    });
+
+    await waitFor(() => {
+      expect(fetchMock.calls().map((call) => call[0])).toContain(contractListUrl);
+      expect(result.current).toBe(true);
+    });
+  });
+
+  it("should return false when joanie doesn't return any signed contracts", async () => {
+    const organizationId = faker.string.uuid();
+    const contractListUrl = `https://joanie.test/api/v1.0/organizations/${organizationId}/contracts/?signature_state=${ContractState.SIGNED}&page=1&page_size=${PER_PAGE.teacherContractList}`;
+    fetchMock.get(contractListUrl, {
+      count: 0,
+      next: null,
+      previous: null,
+      results: [],
+    });
+
+    const { result } = renderHook(() => useHasContractToDownload(organizationId), {
+      wrapper: Wrapper,
+    });
+    await waitFor(() => {
+      expect(fetchMock.calls().map((call) => call[0])).toContain(contractListUrl);
+      expect(result.current).toBe(false);
+    });
+  });
+});

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

@@ -0,0 +1,23 @@
+import { useOrganizationContracts } from 'hooks/useContracts';
+import { PER_PAGE } from 'settings';
+import { ContractState, Organization } from 'types/Joanie';
+
+const useHasContractToDownload = (organizationId: Organization['id']) => {
+  const {
+    items: contracts,
+    states: { isFetched },
+  } = useOrganizationContracts({
+    organization_id: organizationId,
+    signature_state: ContractState.SIGNED,
+    page: 1,
+    page_size: PER_PAGE.teacherContractList,
+  });
+
+  if (!isFetched) {
+    return null;
+  }
+
+  return contracts.length > 0;
+};
+
+export default useHasContractToDownload;

package/js/settings.ts

@@ -46,6 +46,13 @@ export const CONTRACT_SETTINGS = {
   dummySignatureSignTimeout: 2000,
 };
 
+export const CONTRACT_DOWNLOAD_SETTINGS = {
+  // Interval in ms to poll the related contract's archive.
+  pollInterval: 1000,
+  contractArchiveLocalStorageKey: 'RICHIE_CONTRACT_ARCHIVE',
+  contractArchiveLocalVaklidityDurationMs: 10 * 60 * 60 * 1000, // 10min
+};
+
 const DEFAULT_PER_PAGE = 50;
 export const PER_PAGE = {
   teacherContractList: 25,

package/js/types/Joanie.ts

@@ -520,6 +520,11 @@ interface APIUser {
       ? Promise<Nullable<Contract>>
       : Promise<PaginatedResponse<Contract>>;
     download(id: string): Promise<File>;
+    zip_archive: {
+      check: (id: string) => Promise<Response>;
+      create: ({ organization_id }: { organization_id: string }) => Promise<{ url: string }>;
+      get: (id: string) => Promise<File>;
+    };
   };
 }
 

package/js/utils/errors/HttpError.ts

@@ -25,6 +25,7 @@ export function isHttpError(error: any): error is HttpError {
 
 export enum HttpStatusCode {
   OK = 200,
+  NO_CONTENT = 204,
   UNAUTHORIZED = 401,
   BAD_REQUEST = 400,
   FORBIDDEN = 403,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "richie-education",
-  "version": "2.25.0-b2.dev32",
+  "version": "2.25.0-b2.dev35",
   "description": "A CMS to build learning portals for Open Education",
   "main": "sandbox/manage.py",
   "scripts": {