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.

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

fix(instantsearch.js): prevent authenticated token being set as the userToken #6443

Merged
merged 10 commits into from
Dec 9, 2024
+69 −200
Merged

fix(instantsearch.js): prevent authenticated token being set as the userToken #6443

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0f5af82
remove auth token
shaejaz Nov 19, 2024
8dc50e5
remove auth tests
shaejaz Nov 19, 2024
97fc570
clean vars
shaejaz Nov 19, 2024
d08d931
add tests
shaejaz Nov 19, 2024
87003e7
add test for init props
shaejaz Nov 19, 2024
eaa8915
fix typo
shaejaz Nov 19, 2024
a3a0e9c
remove immediate flag
shaejaz Nov 19, 2024
2a5f605
fix assertion
shaejaz Nov 20, 2024
0f8f835
add immediate flag
shaejaz Nov 20, 2024
0bd80c0
Merge branch 'master' into fix/remove-auth-token
Haroenv Nov 20, 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
96 changes: 29 additions & 67 deletions packages/instantsearch.js/src/middlewares/__tests__/createInsightsMiddleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,7 @@ describe('insights', () => {

describe('authenticatedUserToken', () => {
describe('before `init`', () => {
it('uses the `authenticatedUserToken` as the `userToken` when defined', () => {
it('does not use `authenticatedUserToken` as the `userToken` when defined', () => {
const { insightsClient, instantSearchInstance, getUserToken } =
createTestEnvironment();

Expand All @@ -937,10 +937,10 @@ describe('insights', () => {
createInsightsMiddleware({ insightsClient })
);

expect(getUserToken()).toEqual('abc');
expect(getUserToken()).not.toEqual('abc');
shaejaz marked this conversation as resolved.
Show resolved Hide resolved
});

it('uses the `authenticatedUserToken` as the `userToken` when both are defined', () => {
it('does not use `authenticatedUserToken` as the `userToken` when both are defined', () => {
const { insightsClient, instantSearchInstance, getUserToken } =
createTestEnvironment();

Expand All @@ -951,60 +951,60 @@ describe('insights', () => {
createInsightsMiddleware({ insightsClient })
);

expect(getUserToken()).toEqual('def');
expect(getUserToken()).toEqual('abc');
});

it('reverts to the `userToken` when unsetting the `authenticatedUserToken`', () => {
it('does not use `authenticatedUserToken` when a `userToken` is set after', () => {
const { insightsClient, instantSearchInstance, getUserToken } =
createTestEnvironment();

insightsClient('setUserToken', 'abc');
insightsClient('setAuthenticatedUserToken', 'def');
insightsClient('setAuthenticatedUserToken', undefined);

instantSearchInstance.use(
createInsightsMiddleware({ insightsClient })
);

insightsClient('setUserToken', 'abc');

expect(getUserToken()).toEqual('abc');
});
});

it('uses the `authenticatedUserToken` when a `userToken` is set after', () => {
describe('from `init` props', () => {
it('does not use `authenticatedUserToken` as the `userToken` when defined', () => {
const { insightsClient, instantSearchInstance, getUserToken } =
createTestEnvironment();

insightsClient('setAuthenticatedUserToken', 'def');

instantSearchInstance.use(
createInsightsMiddleware({ insightsClient })
createInsightsMiddleware({
insightsClient,
insightsInitParams: { authenticatedUserToken: 'abc' },
})
);

insightsClient('setUserToken', 'abc');

expect(getUserToken()).toEqual('def');
expect(getUserToken()).not.toEqual('abc');
});

it('resets the token to the `userToken` when `authenticatedUserToken` is set as undefined', () => {
it('does not use `authenticatedUserToken` as the `userToken` when both are defined', () => {
const { insightsClient, instantSearchInstance, getUserToken } =
createTestEnvironment();

insightsClient('setUserToken', 'abc');
insightsClient('setAuthenticatedUserToken', 'def');

instantSearchInstance.use(
createInsightsMiddleware({ insightsClient })
createInsightsMiddleware({
insightsClient,
insightsInitParams: {
authenticatedUserToken: 'abc',
userToken: 'def',
},
})
);

expect(getUserToken()).toEqual('def');

insightsClient('setAuthenticatedUserToken', undefined);

expect(getUserToken()).toEqual('abc');
});
});

describe('after `init`', () => {
it('uses the `authenticatedUserToken` as the `userToken` when defined', async () => {
it('does not use `authenticatedUserToken` as the `userToken` when defined', async () => {
const { insightsClient, instantSearchInstance, getUserToken } =
createTestEnvironment();
instantSearchInstance.use(
Expand All @@ -1015,25 +1015,10 @@ describe('insights', () => {

await wait(0);

expect(getUserToken()).toEqual('abc');
});

it('uses the `authenticatedUserToken` as the `userToken` when both are defined', async () => {
const { insightsClient, instantSearchInstance, getUserToken } =
createTestEnvironment();
instantSearchInstance.use(
createInsightsMiddleware({ insightsClient })
);

insightsClient('setUserToken', 'abc');
insightsClient('setAuthenticatedUserToken', 'def');

await wait(0);

expect(getUserToken()).toEqual('def');
expect(getUserToken()).not.toEqual('abc');
});

it('reverts to the `userToken` when unsetting the `authenticatedUserToken`', async () => {
it('does not use `authenticatedUserToken` as the `userToken` when both are defined', async () => {
const { insightsClient, instantSearchInstance, getUserToken } =
createTestEnvironment();
instantSearchInstance.use(
Expand All @@ -1042,7 +1027,6 @@ describe('insights', () => {

insightsClient('setUserToken', 'abc');
insightsClient('setAuthenticatedUserToken', 'def');
insightsClient('setAuthenticatedUserToken', undefined);

await wait(0);

Expand All @@ -1051,7 +1035,7 @@ describe('insights', () => {
});

describe('from queue', () => {
it('uses the `authenticatedUserToken` as the `userToken` when defined', () => {
it('does not use `authenticatedUserToken` as the `userToken` when defined', () => {
const {
insightsClient,
libraryLoadedAndProcessQueue,
Expand All @@ -1069,10 +1053,10 @@ describe('insights', () => {
);
libraryLoadedAndProcessQueue();

expect(getUserToken()).toEqual('abc');
expect(getUserToken()).not.toEqual('abc');
});

it('uses the `authenticatedUserToken` as the `userToken` when both are defined', () => {
it('does not use `authenticatedUserToken` as the `userToken` when both are defined', () => {
const {
insightsClient,
libraryLoadedAndProcessQueue,
Expand All @@ -1091,28 +1075,6 @@ describe('insights', () => {
);
libraryLoadedAndProcessQueue();

expect(getUserToken()).toEqual('def');
});

it('reverts to the `userToken` when unsetting the `authenticatedUserToken`', () => {
const {
insightsClient,
libraryLoadedAndProcessQueue,
instantSearchInstance,
getUserToken,
} = createUmdTestEnvironment();

insightsClient('setUserToken', 'abc');
insightsClient('setAuthenticatedUserToken', 'def');
insightsClient('setAuthenticatedUserToken', undefined);

instantSearchInstance.use(
createInsightsMiddleware({
insightsClient,
})
);
libraryLoadedAndProcessQueue();

expect(getUserToken()).toEqual('abc');
});
});
Expand Down
Loading