Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Investigate hooks replaced once #958

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.

Sign up for GitHub

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

Closed
wants to merge 4 commits into from
Closed

Investigate hooks replaced once #958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e64e95
Accept combination of hook modifiers
daun Sep 25, 2024
8ec5246
Add test for replacing hook handler once
daun Sep 25, 2024
bcd5498
Fix modifier test
daun Sep 25, 2024
44bf30b
Fix combination of replace and once handlers
daun Sep 26, 2024
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
8 changes: 4 additions & 4 deletions src/modules/Hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ export type Handlers = {

export type HookInitOptions = {
[K in HookName as K | `${K}.${HookModifier}`]: HookHandler<K>;
} & {
[K in HookName as K | `${K}.${HookModifier}.${HookModifier}`]: HookHandler<K>;
};

/** Unregister a previously registered hook handler. */
Expand Down Expand Up @@ -524,7 +526,7 @@ export class Hooks {
handler = [{ id: 0, hook, handler: defaultHandler }];
if (replaced) {
const index = replace.length - 1;
const replacingHandler = replace[index].handler;
const { handler: replacingHandler, once } = replace[index];
const createDefaultHandler = (index: number): HookDefaultHandler<T> | undefined => {
const next = replace[index - 1];
if (next) {
Expand All @@ -535,9 +537,7 @@ export class Hooks {
}
};
const nestedDefaultHandler = createDefaultHandler(index);
handler = [
{ id: 0, hook, handler: replacingHandler, defaultHandler: nestedDefaultHandler }
];
handler = [{ id: 0, hook, once, handler: replacingHandler, defaultHandler: nestedDefaultHandler }]; // prettier-ignore
}
}

Expand Down
22 changes: 20 additions & 2 deletions tests/unit/hooks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,22 @@ describe('Hook registry', () => {
expect(listener).toBeCalledWith(visit, undefined, undefined);
});

it('should allow replacing original handler only once', async () => {
const swup = new Swup();
const customHandler = vi.fn();
const defaultHandler = vi.fn();

swup.hooks.on('enable', customHandler, { replace: true, once: true });

await swup.hooks.call('enable', undefined, undefined, defaultHandler);
expect(defaultHandler).toBeCalledTimes(0);
expect(customHandler).toBeCalledTimes(1);

await swup.hooks.call('enable', undefined, undefined, defaultHandler);
expect(defaultHandler).toBeCalledTimes(1);
expect(customHandler).toBeCalledTimes(1);
});

it('should trigger hook handler with visit and args', async () => {
const swup = new SwupWithPublicVisitMethods();
const handler: HookHandler<'history:popstate'> = vi.fn();
Expand Down Expand Up @@ -377,14 +393,16 @@ describe('Hook registry', () => {
hooks: {
'visit:start': handler,
'visit:start.before': handler,
'visit:start.once': handler
'visit:start.once': handler,
'visit:start.once.before': handler
}
});

expect(hookSpy).toBeCalledTimes(3);
expect(hookSpy).toBeCalledTimes(4);
expect(hookSpy).toBeCalledWith('visit:start', handler, {});
expect(hookSpy).toBeCalledWith('visit:start', handler, { before: true });
expect(hookSpy).toBeCalledWith('visit:start', handler, { once: true });
expect(hookSpy).toBeCalledWith('visit:start', handler, { once: true, before: true });
});
});

Expand Down
Loading