Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Trigger les services tiers à la navigation #3473

Merged
merged 3 commits into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/client/services/cookies/cookies.service.fixture.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export function aCookiesService(override?: Partial<CookiesService>): CookiesServ
allowService: jest.fn(),
isServiceAllowed: jest.fn(() => true),
openPanel: jest.fn(),
triggerServices: jest.fn(),
...override,
};
}
2 changes: 2 additions & 0 deletions src/client/services/cookies/cookies.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,6 @@ export interface CookiesService {
allowService(nom: string): void;

openPanel(): void;

triggerServices(): void;
}
4 changes: 4 additions & 0 deletions src/client/services/cookies/null/null.cookies.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,8 @@ export class NullCookiesService implements CookiesService {
openPanel(): void {
return;
}

triggerServices() {
return;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,15 @@ describe('TarteAuCitronCookiesService', () => {
expect(tarteaucitron.userInterface.openPanel).toHaveBeenCalledTimes(1);
});
});

describe('triggerServices', () => {
it('appelle triggerJobsAfterAjaxCall', () => {
const tarteaucitron = aTarteAuCitron({ triggerJobsAfterAjaxCall: jest.fn() });
const cookiesService = new TarteAuCitronCookiesService(tarteaucitron);

cookiesService.triggerServices();

expect(tarteaucitron.triggerJobsAfterAjaxCall).toHaveBeenCalled();
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ export type TarteAuCitron = {
respond: (bouton: HTMLButtonElement, value: boolean) => void,
openPanel: () => void,
}
state: Record<TarteAuCitron.ServiceName, boolean>;
state: Record<TarteAuCitron.ServiceName, boolean>,
triggerJobsAfterAjaxCall: () => void,
}

export class TarteAuCitronCookiesService implements CookiesService {
Expand Down Expand Up @@ -84,4 +85,8 @@ export class TarteAuCitronCookiesService implements CookiesService {
openPanel(): void {
return this.tarteaucitron.userInterface.openPanel();
}

triggerServices() {
this.tarteaucitron.triggerJobsAfterAjaxCall();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export function aTarteAuCitron(override?: Partial<TarteAuCitron>): TarteAuCitron
job: undefined,
services: {},
state: {},
triggerJobsAfterAjaxCall: jest.fn(),
user: {},
userInterface: {
openPanel: jest.fn(),
Expand Down
43 changes: 43 additions & 0 deletions src/pages/_app.page.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,17 @@ import React from 'react';

import { createMockRouter, mockUseRouter } from '~/client/components/useRouter.mock';
import { mockUUID } from '~/client/components/window.mock';
import { Dependencies } from '~/client/dependencies.container';
import { aCookiesService } from '~/client/services/cookies/cookies.service.fixture';

import App from './_app.page';


const mockDependencies: Partial<Dependencies> = {
cookiesService: aCookiesService(),
};
jest.mock('~/client/dependencies.container', () => (() => mockDependencies));

describe('<App />', () => {
beforeAll(() => {
mockUUID();
Expand All @@ -31,4 +39,39 @@ describe('<App />', () => {
const cible = screen.getByText('Cible');
await waitFor(() => expect(cible).toHaveFocus());
});
describe('Trigger services tiers', () => {
it('ne trigger pas les cookies à l’arrivée sur la page', () => {
// NOTE (GAFI 26-11-2024): Les services sont automatiquement triggered au chargement de tarteaucitron
const router = createMockRouter() as Router;
mockUseRouter({});
mockDependencies.cookiesService = aCookiesService({ triggerServices: jest.fn() });
const Component = Object.assign(
function Component() {
return null;
},
{ getLayout: (page: React.ReactElement) => <>{page}</> },
);

render(<App pageProps={{}} Component={Component} router={router} />);

expect(mockDependencies.cookiesService.triggerServices).not.toHaveBeenCalled();
});
it('trigger les cookies au changement de page', () => {
mockDependencies.cookiesService = aCookiesService({ triggerServices: jest.fn() });
const router = createMockRouter() as Router;
mockUseRouter({ asPath: '/page-1' });
const Component = Object.assign(
function Component() {
return null;
},
{ getLayout: (page: React.ReactElement) => <>{page}</> },
);
const { rerender } = render(<App pageProps={{}} Component={Component} router={router} />);

mockUseRouter({ asPath: '/page-2' });
rerender(<App pageProps={{}} Component={Component} router={router} />);

expect(mockDependencies.cookiesService.triggerServices).toHaveBeenCalledTimes(1);
});
});
});
44 changes: 25 additions & 19 deletions src/pages/_app.page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ import { NextPage } from 'next';
import { AppProps } from 'next/app';
import Head from 'next/head';
import { useRouter } from 'next/router';
import React, { ReactElement, ReactNode, useEffect, useMemo } from 'react';
import React, { ReactElement, ReactNode, useEffect, useMemo, useRef } from 'react';

import ErrorServer from '~/client/components/layouts/Error/ErrorServer';
import { Layout } from '~/client/components/layouts/Layout';
import { DependenciesProvider } from '~/client/context/dependenciesContainer.context';
import dependenciesContainer from '~/client/dependencies.container';
import usePageHistory from '~/client/hooks/usePageHistory';
import useSessionId from '~/client/hooks/useSessionId';
import { CookiesService } from '~/client/services/cookies/cookies.service';

export type NextPageWithLayout<P = object> = NextPage<P, P> & {
getLayout?: (page: ReactElement) => ReactNode;
Expand All @@ -21,25 +22,34 @@ type AppPropsWithLayout = AppProps & {
Component: NextPageWithLayout;
}

function useTriggerServicesOnNavigation(cookiesService: CookiesService) {
const router = useRouter();

const previousPath = useRef(router.asPath);
useEffect(function triggerAnalyticsServices() {
if (previousPath.current === router.asPath) {
return;
}
cookiesService.triggerServices();
previousPath.current = router.asPath;
}, [cookiesService, router.asPath]);
}

export default function App({ Component, pageProps }: AppPropsWithLayout) {
const sessionId = useSessionId();

/* isClientSide permet de générer l'essentiel de la page uniquement côté client
Il est nécessaire pour le moment car la codebase contient toujours des appels à des méthodes comme useBreakpoint
qui causent des hydration mismatch = différence de rendu entre serveur et premier chargement du JS côté client
La suppression de isClientSide permettra un rendu SSR / SSG complet */

const dependenciesContainerInstance = useMemo(() => dependenciesContainer(sessionId), [sessionId]);
const router = useRouter();

usePageHistory();
useTriggerServicesOnNavigation(dependenciesContainerInstance.cookiesService);

useEffect(() => {
useEffect(function focusAnchor() {
const [/* full path */, targetId] = router.asPath.match(/^[^#]*#(.+)$/) ?? [];
if (targetId) {
document.getElementById(targetId)?.focus();
}
}, [router.asPath, sessionId]);
}, [router.asPath]);

const getLayout = Component.getLayout ?? defaultLayout;
return (
Expand All @@ -50,17 +60,13 @@ export default function App({ Component, pageProps }: AppPropsWithLayout) {
content="width=device-width, height=device-height, initial-scale=1, viewport-fit=cover, minimum-scale=1.0" />
<meta name="description" content="Toutes les solutions pour l‘avenir des jeunes" />
</Head>
{
dependenciesContainerInstance && (
<DependenciesProvider {...dependenciesContainerInstance}>
{getLayout(
pageProps.error
? <ErrorServer error={pageProps.error} />
: <Component {...pageProps} />,
)}
</DependenciesProvider>
)
}
<DependenciesProvider {...dependenciesContainerInstance}>
{getLayout(
pageProps.error
? <ErrorServer error={pageProps.error} />
: <Component {...pageProps} />,
)}
</DependenciesProvider>
</>
);
}
Expand Down
Loading