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

feat(clerk-js): Sign Out from multiple tabs at once #2094

Merged
merged 7 commits into from
Nov 13, 2023
Merged

feat(clerk-js): Sign Out from multiple tabs at once #2094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
83c7ab8
feat(clerk-js): Enable BroadcastChannel
octoper Nov 9, 2023
ecfed06
chore(clerk-js): Remove object passed as it is the default value of t…
octoper Nov 9, 2023
8d2d54c
chore(repo): Add Clerk types in integrations tests
octoper Nov 9, 2023
7b6afab
test(repo): Add tests for Sign Out functionality
octoper Nov 9, 2023
f2877bb
chore(repo): Adds Changeset
octoper Nov 10, 2023
66fafe8
fix(repo): Import expect form @playwright/test
octoper Nov 10, 2023
3391990
test(repo): Check if user is signed out
octoper Nov 10, 2023
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
5 changes: 5 additions & 0 deletions .changeset/dry-sheep-poke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Introducing sign out from all open tabs at once.
1 change: 0 additions & 1 deletion integration/testUtils/appPageObject.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ export const createAppPageObject = (testArgs: { page: Page }, app: Application)
},
waitForClerkJsLoaded: async () => {
return page.waitForFunction(() => {
// @ts-ignore
return window.Clerk?.isReady();
});
},
Expand Down
2 changes: 0 additions & 2 deletions integration/testUtils/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,11 @@ const createExpectPageObject = ({ page }: TestArgs) => {
return {
toBeSignedOut: () => {
return page.waitForFunction(() => {
// @ts-ignore
return !window.Clerk?.user;
});
},
toBeSignedIn: async () => {
return page.waitForFunction(() => {
// @ts-ignore
return !!window.Clerk?.user;
});
},
Expand Down
48 changes: 48 additions & 0 deletions integration/tests/sign-out-smoke.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { expect, test } from '@playwright/test';

import { appConfigs } from '../presets';
import type { FakeUser } from '../testUtils';
import { createTestUtils, testAgainstRunningApps } from '../testUtils';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })('sign out smoke test @generic', ({ app }) => {
test.describe.configure({ mode: 'serial' });

let fakeUser: FakeUser;

test.beforeAll(async () => {
const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
await u.services.users.createBapiUser(fakeUser);
});

test.afterAll(async () => {
await fakeUser.deleteIfExists();
await app.teardown();
});

test('sign out throught all open tabs at once', async ({ page, context }) => {
const mainTab = createTestUtils({ app, page, context });
await mainTab.po.signIn.goTo();
await mainTab.po.signIn.setIdentifier(fakeUser.email);
await mainTab.po.signIn.continue();
await mainTab.po.signIn.setPassword(fakeUser.password);
await mainTab.po.signIn.continue();
await mainTab.po.expect.toBeSignedIn();

await mainTab.tabs.runInNewTab(async m => {
await m.page.goToStart();

await m.page.waitForClerkJsLoaded();

await m.po.expect.toBeSignedIn();

await m.page.evaluate(async () => {
await window.Clerk.signOut();
});
dimkl marked this conversation as resolved.
Show resolved Hide resolved

await m.po.expect.toBeSignedOut();
});

expect(await mainTab.page.evaluate('!window.Clerk.user')).toBe(false);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙃 let's add a await m.po.expect.toBeSignedOut(); test helper and use it here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The helper exists but there is a problem with it, the page.waitFucntion that is underneath mainTab.po.expect.toBeSignedOut() helper is getting a timeout at this point, I'm not exactly sure why is that, but it's probably has something to do with with the new tab we are opening.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's add a comment about why we cannot use the helper and fix this later.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❓ shouldn't this be toBe(true)? If we're trying to replicate toBeSignedOut().

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right! Just opened a PR for that #2125

});
});
2 changes: 1 addition & 1 deletion integration/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
"esModuleInterop": true,
"allowSyntheticDefaultImports": true
},
"include": ["./tests"],
"include": ["./tests", "types.d.ts"],
"exclude": ["templates"]
}
7 changes: 7 additions & 0 deletions integration/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import type { Clerk } from '@clerk/types';

declare global {
interface Window {
Clerk: Clerk;
}
}
5 changes: 3 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { LocalStorageBroadcastChannel } from '@clerk/shared';
import {
addClerkPrefix,
handleValueOrFn,
Expand All @@ -7,6 +6,7 @@ import {
isHttpOrHttps,
isValidBrowserOnline,
isValidProxyUrl,
LocalStorageBroadcastChannel,
noop,
parsePublishableKey,
proxyUrlToAbsoluteURL,
Expand Down Expand Up @@ -1282,6 +1282,7 @@ export default class Clerk implements ClerkInterface {

const isInAccountsHostedPages = isDevAccountPortalOrigin(window?.location.hostname);

this.#broadcastChannel = new LocalStorageBroadcastChannel('clerk');
this.#setupListeners();

let retries = 0;
Expand Down Expand Up @@ -1375,7 +1376,7 @@ export default class Clerk implements ClerkInterface {

this.#broadcastChannel?.addEventListener('message', ({ data }) => {
if (data.type === 'signout') {
void this.handleUnauthenticated({ broadcast: false });
void this.handleUnauthenticated();
}
});
};
Expand Down
Loading