Skip to content

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

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

Merged
octoper 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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();
});
Comment thread
dimkl marked this conversation as resolved.

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

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

@dimkldimklNov 10, 2023

Copy link
Copy Markdown
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.

@octoperoctoperNov 10, 2023

Copy link
Copy Markdown
ContributorAuthor

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.

@dimkldimklNov 13, 2023

Copy link
Copy Markdown
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.

@brkalowbrkalowNov 13, 2023

Copy link
Copy Markdown
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().

@octoperoctoperNov 13, 2023

Copy link
Copy Markdown
ContributorAuthor

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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(clerk-js): Sign Out from multiple tabs at once by octoper · Pull Request #2094 · clerk/javascript · GitHub
Skip to content
feat(clerk-js): Sign Out from multiple tabs at once#2094

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

 Merged

octoper
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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();
 });
Comment thread
dimkl marked this conversation as resolved.


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

 expect(await mainTab.page.evaluate('!window.Clerk.user')).toBe(false);
@dimkldimklNov 10, 2023

Copy link


Copy Markdown

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.
@octoperoctoperNov 10, 2023

Copy link


Copy Markdown

ContributorAuthor
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.
@dimkldimklNov 13, 2023

Copy link


Copy Markdown

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.
@brkalowbrkalowNov 13, 2023

Copy link


Copy Markdown

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().
@octoperoctoperNov 13, 2023

Copy link


Copy Markdown

ContributorAuthor
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js): Sign Out from multiple tabs at once by octoper · Pull Request #2094 · clerk/javascript · GitHub
Skip to content
feat(clerk-js): Sign Out from multiple tabs at once#2094

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

 Merged

octoper
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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();
 });
Comment thread
dimkl marked this conversation as resolved.


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

 expect(await mainTab.page.evaluate('!window.Clerk.user')).toBe(false);
@dimkldimklNov 10, 2023

Copy link


Copy Markdown

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.
@octoperoctoperNov 10, 2023

Copy link


Copy Markdown

ContributorAuthor
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.
@dimkldimklNov 13, 2023

Copy link


Copy Markdown

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.
@brkalowbrkalowNov 13, 2023

Copy link


Copy Markdown

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().
@octoperoctoperNov 13, 2023

Copy link


Copy Markdown

ContributorAuthor
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js): Sign Out from multiple tabs at once by octoper · Pull Request #2094 · clerk/javascript · GitHub
Skip to content
feat(clerk-js): Sign Out from multiple tabs at once#2094

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

 Merged

octoper
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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();
 });
Comment thread
dimkl marked this conversation as resolved.


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

 expect(await mainTab.page.evaluate('!window.Clerk.user')).toBe(false);
@dimkldimklNov 10, 2023

Copy link


Copy Markdown

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.
@octoperoctoperNov 10, 2023

Copy link


Copy Markdown

ContributorAuthor
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.
@dimkldimklNov 13, 2023

Copy link


Copy Markdown

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.
@brkalowbrkalowNov 13, 2023

Copy link


Copy Markdown

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().
@octoperoctoperNov 13, 2023

Copy link


Copy Markdown

ContributorAuthor
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(clerk-js): Sign Out from multiple tabs at once by octoper · Pull Request #2094 · clerk/javascript · GitHub
Skip to content
feat(clerk-js): Sign Out from multiple tabs at once#2094

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

 Merged

octoper
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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();
 });
Comment thread
dimkl marked this conversation as resolved.


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

 expect(await mainTab.page.evaluate('!window.Clerk.user')).toBe(false);
@dimkldimklNov 10, 2023

Copy link


Copy Markdown

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.
@octoperoctoperNov 10, 2023

Copy link


Copy Markdown

ContributorAuthor
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.
@dimkldimklNov 13, 2023

Copy link


Copy Markdown

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.
@brkalowbrkalowNov 13, 2023

Copy link


Copy Markdown

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().
@octoperoctoperNov 13, 2023

Copy link


Copy Markdown

ContributorAuthor
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js): Sign Out from multiple tabs at once by octoper · Pull Request #2094 · clerk/javascript · GitHub
Skip to content
feat(clerk-js): Sign Out from multiple tabs at once#2094

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

 Merged

octoper
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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();
 });
Comment thread
dimkl marked this conversation as resolved.


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

 expect(await mainTab.page.evaluate('!window.Clerk.user')).toBe(false);
@dimkldimklNov 10, 2023

Copy link


Copy Markdown

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.
@octoperoctoperNov 10, 2023

Copy link


Copy Markdown

ContributorAuthor
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.
@dimkldimklNov 13, 2023

Copy link


Copy Markdown

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.
@brkalowbrkalowNov 13, 2023

Copy link


Copy Markdown

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().
@octoperoctoperNov 13, 2023

Copy link


Copy Markdown

ContributorAuthor
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
feat(clerk-js): Sign Out from multiple tabs at once by octoper · Pull Request #2094 · clerk/javascript · GitHub
Skip to content
feat(clerk-js): Sign Out from multiple tabs at once#2094

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

 Merged

octoper
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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();
 });
Comment thread
dimkl marked this conversation as resolved.


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

 expect(await mainTab.page.evaluate('!window.Clerk.user')).toBe(false);
@dimkldimklNov 10, 2023

Copy link


Copy Markdown

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.
@octoperoctoperNov 10, 2023

Copy link


Copy Markdown

ContributorAuthor
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.
@dimkldimklNov 13, 2023

Copy link


Copy Markdown

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.
@brkalowbrkalowNov 13, 2023

Copy link


Copy Markdown

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().
@octoperoctoperNov 13, 2023

Copy link


Copy Markdown

ContributorAuthor
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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