Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/breezy-stingrays-give.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/vue": patch
---

Fixed an issue where `useOrganization` would show an incorrect warning and dialog due to checking environment settings before Clerk was fully loaded.
70 changes: 70 additions & 0 deletions packages/vue/src/composables/__tests__/useOrganization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { Clerk } from '@clerk/shared/types';
import { render } from '@testing-library/vue';
import { vi } from 'vitest';
import { defineComponent, shallowRef } from 'vue';

import { useOrganization } from '../useOrganization';

const mockAttemptToEnableEnvironmentSetting = vi.fn();

const mockLoaded = shallowRef(false);
const mockClerk = shallowRef<Partial<Clerk> | null>(null);

vi.mock('../useClerkContext', () => ({
useClerkContext: () => ({
loaded: mockLoaded,
clerk: mockClerk,
organizationCtx: shallowRef(undefined),
}),
}));

vi.mock('../useSession', () => ({
useSession: () => ({
session: shallowRef(null),
}),
}));

describe('useOrganization', () => {
beforeEach(() => {
vi.clearAllMocks();
mockLoaded.value = false;
mockClerk.value = null;
});

it('should not call __internal_attemptToEnableEnvironmentSetting before Clerk is loaded', () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

expect(mockAttemptToEnableEnvironmentSetting).not.toHaveBeenCalled();
});

it('should call __internal_attemptToEnableEnvironmentSetting after Clerk is loaded', async () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

mockLoaded.value = true;

await vi.waitFor(() => {
expect(mockAttemptToEnableEnvironmentSetting).toHaveBeenCalledWith({
for: 'organizations',
caller: 'useOrganization',
});
});
});
});
14 changes: 8 additions & 6 deletions packages/vue/src/composables/useOrganization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,21 +53,23 @@ type UseOrganization = () => ToComputedRefs<UseOrganizationReturn>;
* </template>
*/
export const useOrganization: UseOrganization = () => {
const { clerk, organizationCtx } = useClerkContext('useOrganization');
const { loaded, clerk, organizationCtx } = useClerkContext('useOrganization');

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This loaded ref is set to true when Clerk.load() succeeds so this is more reliable

const { session } = useSession();

watch(
clerk,
loaded,
value => {
if (value) {
// Optional chaining is important for `@clerk/vue` usage with older clerk-js versions that don't have the method
value.__internal_attemptToEnableEnvironmentSetting?.({
clerk.value?.__internal_attemptToEnableEnvironmentSetting?.({

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

We are confident that clerk is defined here

for: 'organizations',
caller: 'useOrganization',
});
}
},
{ once: true },
{
once: true,
},
);

const result = computed<UseOrganizationReturn>(() => {
Expand All@@ -80,7 +82,7 @@ export const useOrganization: UseOrganization = () => {
}

/** In SSR context we include only the organization object when loadOrg is set to true. */
if (!clerk.value?.loaded) {
if (!loaded.value) {
return {
isLoaded: true,
organization: organizationCtx.value,
Expand All@@ -89,7 +91,7 @@ export const useOrganization: UseOrganization = () => {
}

return {
isLoaded: clerk.value.loaded,
isLoaded: loaded.value,
organization: organizationCtx.value,
membership: getCurrentOrganizationMembership(
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,6 +167,7 @@ export const clerkPlugin: Plugin<[PluginOptions]> = {
const organizationCtx = computed(() => derivedState.value.organization);

app.provide(ClerkInjectionKey, {
loaded,
clerk,
authCtx,
clientCtx,
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type {
import type { Component, ComputedRef, ShallowRef, Slot, VNode } from 'vue';

export interface VueClerkInjectionKeyType {
loaded: ShallowRef<boolean>;
clerk: ShallowRef<Clerk | null>;
authCtx: ComputedRef<{
userId: string | null | undefined;
Expand Down
Loading
, '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" + '
fix(vue): Defer `useOrganization` environment check until Clerk is loaded by wobsoriano · Pull Request #7982 · clerk/javascript · GitHub
Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/breezy-stingrays-give.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/vue": patch
---

Fixed an issue where `useOrganization` would show an incorrect warning and dialog due to checking environment settings before Clerk was fully loaded.
70 changes: 70 additions & 0 deletions packages/vue/src/composables/__tests__/useOrganization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { Clerk } from '@clerk/shared/types';
import { render } from '@testing-library/vue';
import { vi } from 'vitest';
import { defineComponent, shallowRef } from 'vue';

import { useOrganization } from '../useOrganization';

const mockAttemptToEnableEnvironmentSetting = vi.fn();

const mockLoaded = shallowRef(false);
const mockClerk = shallowRef<Partial<Clerk> | null>(null);

vi.mock('../useClerkContext', () => ({
useClerkContext: () => ({
loaded: mockLoaded,
clerk: mockClerk,
organizationCtx: shallowRef(undefined),
}),
}));

vi.mock('../useSession', () => ({
useSession: () => ({
session: shallowRef(null),
}),
}));

describe('useOrganization', () => {
beforeEach(() => {
vi.clearAllMocks();
mockLoaded.value = false;
mockClerk.value = null;
});

it('should not call __internal_attemptToEnableEnvironmentSetting before Clerk is loaded', () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

expect(mockAttemptToEnableEnvironmentSetting).not.toHaveBeenCalled();
});

it('should call __internal_attemptToEnableEnvironmentSetting after Clerk is loaded', async () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

mockLoaded.value = true;

await vi.waitFor(() => {
expect(mockAttemptToEnableEnvironmentSetting).toHaveBeenCalledWith({
for: 'organizations',
caller: 'useOrganization',
});
});
});
});
14 changes: 8 additions & 6 deletions packages/vue/src/composables/useOrganization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,21 +53,23 @@ type UseOrganization = () => ToComputedRefs<UseOrganizationReturn>;
* </template>
*/
export const useOrganization: UseOrganization = () => {
const { clerk, organizationCtx } = useClerkContext('useOrganization');
const { loaded, clerk, organizationCtx } = useClerkContext('useOrganization');

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This loaded ref is set to true when Clerk.load() succeeds so this is more reliable

const { session } = useSession();

watch(
clerk,
loaded,
value => {
if (value) {
// Optional chaining is important for `@clerk/vue` usage with older clerk-js versions that don't have the method
value.__internal_attemptToEnableEnvironmentSetting?.({
clerk.value?.__internal_attemptToEnableEnvironmentSetting?.({

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

We are confident that clerk is defined here

for: 'organizations',
caller: 'useOrganization',
});
}
},
{ once: true },
{
once: true,
},
);

const result = computed<UseOrganizationReturn>(() => {
Expand All@@ -80,7 +82,7 @@ export const useOrganization: UseOrganization = () => {
}

/** In SSR context we include only the organization object when loadOrg is set to true. */
if (!clerk.value?.loaded) {
if (!loaded.value) {
return {
isLoaded: true,
organization: organizationCtx.value,
Expand All@@ -89,7 +91,7 @@ export const useOrganization: UseOrganization = () => {
}

return {
isLoaded: clerk.value.loaded,
isLoaded: loaded.value,
organization: organizationCtx.value,
membership: getCurrentOrganizationMembership(
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,6 +167,7 @@ export const clerkPlugin: Plugin<[PluginOptions]> = {
const organizationCtx = computed(() => derivedState.value.organization);

app.provide(ClerkInjectionKey, {
loaded,
clerk,
authCtx,
clientCtx,
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type {
import type { Component, ComputedRef, ShallowRef, Slot, VNode } from 'vue';

export interface VueClerkInjectionKeyType {
loaded: ShallowRef<boolean>;
clerk: ShallowRef<Clerk | null>;
authCtx: ComputedRef<{
userId: string | null | undefined;
Expand Down
Loading
, '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('^' + ".*" + ' fix(vue): Defer `useOrganization` environment check until Clerk is loaded by wobsoriano · Pull Request #7982 · clerk/javascript · GitHub
Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/breezy-stingrays-give.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/vue": patch
---

Fixed an issue where `useOrganization` would show an incorrect warning and dialog due to checking environment settings before Clerk was fully loaded.
70 changes: 70 additions & 0 deletions packages/vue/src/composables/__tests__/useOrganization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { Clerk } from '@clerk/shared/types';
import { render } from '@testing-library/vue';
import { vi } from 'vitest';
import { defineComponent, shallowRef } from 'vue';

import { useOrganization } from '../useOrganization';

const mockAttemptToEnableEnvironmentSetting = vi.fn();

const mockLoaded = shallowRef(false);
const mockClerk = shallowRef<Partial<Clerk> | null>(null);

vi.mock('../useClerkContext', () => ({
useClerkContext: () => ({
loaded: mockLoaded,
clerk: mockClerk,
organizationCtx: shallowRef(undefined),
}),
}));

vi.mock('../useSession', () => ({
useSession: () => ({
session: shallowRef(null),
}),
}));

describe('useOrganization', () => {
beforeEach(() => {
vi.clearAllMocks();
mockLoaded.value = false;
mockClerk.value = null;
});

it('should not call __internal_attemptToEnableEnvironmentSetting before Clerk is loaded', () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

expect(mockAttemptToEnableEnvironmentSetting).not.toHaveBeenCalled();
});

it('should call __internal_attemptToEnableEnvironmentSetting after Clerk is loaded', async () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

mockLoaded.value = true;

await vi.waitFor(() => {
expect(mockAttemptToEnableEnvironmentSetting).toHaveBeenCalledWith({
for: 'organizations',
caller: 'useOrganization',
});
});
});
});
14 changes: 8 additions & 6 deletions packages/vue/src/composables/useOrganization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,21 +53,23 @@ type UseOrganization = () => ToComputedRefs<UseOrganizationReturn>;
* </template>
*/
export const useOrganization: UseOrganization = () => {
const { clerk, organizationCtx } = useClerkContext('useOrganization');
const { loaded, clerk, organizationCtx } = useClerkContext('useOrganization');

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This loaded ref is set to true when Clerk.load() succeeds so this is more reliable

const { session } = useSession();

watch(
clerk,
loaded,
value => {
if (value) {
// Optional chaining is important for `@clerk/vue` usage with older clerk-js versions that don't have the method
value.__internal_attemptToEnableEnvironmentSetting?.({
clerk.value?.__internal_attemptToEnableEnvironmentSetting?.({

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

We are confident that clerk is defined here

for: 'organizations',
caller: 'useOrganization',
});
}
},
{ once: true },
{
once: true,
},
);

const result = computed<UseOrganizationReturn>(() => {
Expand All@@ -80,7 +82,7 @@ export const useOrganization: UseOrganization = () => {
}

/** In SSR context we include only the organization object when loadOrg is set to true. */
if (!clerk.value?.loaded) {
if (!loaded.value) {
return {
isLoaded: true,
organization: organizationCtx.value,
Expand All@@ -89,7 +91,7 @@ export const useOrganization: UseOrganization = () => {
}

return {
isLoaded: clerk.value.loaded,
isLoaded: loaded.value,
organization: organizationCtx.value,
membership: getCurrentOrganizationMembership(
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,6 +167,7 @@ export const clerkPlugin: Plugin<[PluginOptions]> = {
const organizationCtx = computed(() => derivedState.value.organization);

app.provide(ClerkInjectionKey, {
loaded,
clerk,
authCtx,
clientCtx,
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type {
import type { Component, ComputedRef, ShallowRef, Slot, VNode } from 'vue';

export interface VueClerkInjectionKeyType {
loaded: ShallowRef<boolean>;
clerk: ShallowRef<Clerk | null>;
authCtx: ComputedRef<{
userId: string | null | undefined;
Expand Down
Loading
, '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('^' + ".*" + ' fix(vue): Defer `useOrganization` environment check until Clerk is loaded by wobsoriano · Pull Request #7982 · clerk/javascript · GitHub
Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/breezy-stingrays-give.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/vue": patch
---

Fixed an issue where `useOrganization` would show an incorrect warning and dialog due to checking environment settings before Clerk was fully loaded.
70 changes: 70 additions & 0 deletions packages/vue/src/composables/__tests__/useOrganization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { Clerk } from '@clerk/shared/types';
import { render } from '@testing-library/vue';
import { vi } from 'vitest';
import { defineComponent, shallowRef } from 'vue';

import { useOrganization } from '../useOrganization';

const mockAttemptToEnableEnvironmentSetting = vi.fn();

const mockLoaded = shallowRef(false);
const mockClerk = shallowRef<Partial<Clerk> | null>(null);

vi.mock('../useClerkContext', () => ({
useClerkContext: () => ({
loaded: mockLoaded,
clerk: mockClerk,
organizationCtx: shallowRef(undefined),
}),
}));

vi.mock('../useSession', () => ({
useSession: () => ({
session: shallowRef(null),
}),
}));

describe('useOrganization', () => {
beforeEach(() => {
vi.clearAllMocks();
mockLoaded.value = false;
mockClerk.value = null;
});

it('should not call __internal_attemptToEnableEnvironmentSetting before Clerk is loaded', () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

expect(mockAttemptToEnableEnvironmentSetting).not.toHaveBeenCalled();
});

it('should call __internal_attemptToEnableEnvironmentSetting after Clerk is loaded', async () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

mockLoaded.value = true;

await vi.waitFor(() => {
expect(mockAttemptToEnableEnvironmentSetting).toHaveBeenCalledWith({
for: 'organizations',
caller: 'useOrganization',
});
});
});
});
14 changes: 8 additions & 6 deletions packages/vue/src/composables/useOrganization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,21 +53,23 @@ type UseOrganization = () => ToComputedRefs<UseOrganizationReturn>;
* </template>
*/
export const useOrganization: UseOrganization = () => {
const { clerk, organizationCtx } = useClerkContext('useOrganization');
const { loaded, clerk, organizationCtx } = useClerkContext('useOrganization');

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This loaded ref is set to true when Clerk.load() succeeds so this is more reliable

const { session } = useSession();

watch(
clerk,
loaded,
value => {
if (value) {
// Optional chaining is important for `@clerk/vue` usage with older clerk-js versions that don't have the method
value.__internal_attemptToEnableEnvironmentSetting?.({
clerk.value?.__internal_attemptToEnableEnvironmentSetting?.({

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

We are confident that clerk is defined here

for: 'organizations',
caller: 'useOrganization',
});
}
},
{ once: true },
{
once: true,
},
);

const result = computed<UseOrganizationReturn>(() => {
Expand All@@ -80,7 +82,7 @@ export const useOrganization: UseOrganization = () => {
}

/** In SSR context we include only the organization object when loadOrg is set to true. */
if (!clerk.value?.loaded) {
if (!loaded.value) {
return {
isLoaded: true,
organization: organizationCtx.value,
Expand All@@ -89,7 +91,7 @@ export const useOrganization: UseOrganization = () => {
}

return {
isLoaded: clerk.value.loaded,
isLoaded: loaded.value,
organization: organizationCtx.value,
membership: getCurrentOrganizationMembership(
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,6 +167,7 @@ export const clerkPlugin: Plugin<[PluginOptions]> = {
const organizationCtx = computed(() => derivedState.value.organization);

app.provide(ClerkInjectionKey, {
loaded,
clerk,
authCtx,
clientCtx,
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type {
import type { Component, ComputedRef, ShallowRef, Slot, VNode } from 'vue';

export interface VueClerkInjectionKeyType {
loaded: ShallowRef<boolean>;
clerk: ShallowRef<Clerk | null>;
authCtx: ComputedRef<{
userId: string | null | undefined;
Expand Down
Loading
, '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" + ' fix(vue): Defer `useOrganization` environment check until Clerk is loaded by wobsoriano · Pull Request #7982 · clerk/javascript · GitHub
Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/breezy-stingrays-give.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/vue": patch
---

Fixed an issue where `useOrganization` would show an incorrect warning and dialog due to checking environment settings before Clerk was fully loaded.
70 changes: 70 additions & 0 deletions packages/vue/src/composables/__tests__/useOrganization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { Clerk } from '@clerk/shared/types';
import { render } from '@testing-library/vue';
import { vi } from 'vitest';
import { defineComponent, shallowRef } from 'vue';

import { useOrganization } from '../useOrganization';

const mockAttemptToEnableEnvironmentSetting = vi.fn();

const mockLoaded = shallowRef(false);
const mockClerk = shallowRef<Partial<Clerk> | null>(null);

vi.mock('../useClerkContext', () => ({
useClerkContext: () => ({
loaded: mockLoaded,
clerk: mockClerk,
organizationCtx: shallowRef(undefined),
}),
}));

vi.mock('../useSession', () => ({
useSession: () => ({
session: shallowRef(null),
}),
}));

describe('useOrganization', () => {
beforeEach(() => {
vi.clearAllMocks();
mockLoaded.value = false;
mockClerk.value = null;
});

it('should not call __internal_attemptToEnableEnvironmentSetting before Clerk is loaded', () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

expect(mockAttemptToEnableEnvironmentSetting).not.toHaveBeenCalled();
});

it('should call __internal_attemptToEnableEnvironmentSetting after Clerk is loaded', async () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

mockLoaded.value = true;

await vi.waitFor(() => {
expect(mockAttemptToEnableEnvironmentSetting).toHaveBeenCalledWith({
for: 'organizations',
caller: 'useOrganization',
});
});
});
});
14 changes: 8 additions & 6 deletions packages/vue/src/composables/useOrganization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,21 +53,23 @@ type UseOrganization = () => ToComputedRefs<UseOrganizationReturn>;
* </template>
*/
export const useOrganization: UseOrganization = () => {
const { clerk, organizationCtx } = useClerkContext('useOrganization');
const { loaded, clerk, organizationCtx } = useClerkContext('useOrganization');

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This loaded ref is set to true when Clerk.load() succeeds so this is more reliable

const { session } = useSession();

watch(
clerk,
loaded,
value => {
if (value) {
// Optional chaining is important for `@clerk/vue` usage with older clerk-js versions that don't have the method
value.__internal_attemptToEnableEnvironmentSetting?.({
clerk.value?.__internal_attemptToEnableEnvironmentSetting?.({

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

We are confident that clerk is defined here

for: 'organizations',
caller: 'useOrganization',
});
}
},
{ once: true },
{
once: true,
},
);

const result = computed<UseOrganizationReturn>(() => {
Expand All@@ -80,7 +82,7 @@ export const useOrganization: UseOrganization = () => {
}

/** In SSR context we include only the organization object when loadOrg is set to true. */
if (!clerk.value?.loaded) {
if (!loaded.value) {
return {
isLoaded: true,
organization: organizationCtx.value,
Expand All@@ -89,7 +91,7 @@ export const useOrganization: UseOrganization = () => {
}

return {
isLoaded: clerk.value.loaded,
isLoaded: loaded.value,
organization: organizationCtx.value,
membership: getCurrentOrganizationMembership(
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,6 +167,7 @@ export const clerkPlugin: Plugin<[PluginOptions]> = {
const organizationCtx = computed(() => derivedState.value.organization);

app.provide(ClerkInjectionKey, {
loaded,
clerk,
authCtx,
clientCtx,
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type {
import type { Component, ComputedRef, ShallowRef, Slot, VNode } from 'vue';

export interface VueClerkInjectionKeyType {
loaded: ShallowRef<boolean>;
clerk: ShallowRef<Clerk | null>;
authCtx: ComputedRef<{
userId: string | null | undefined;
Expand Down
Loading
, '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('^' + ".*" + ' fix(vue): Defer `useOrganization` environment check until Clerk is loaded by wobsoriano · Pull Request #7982 · clerk/javascript · GitHub
Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/breezy-stingrays-give.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/vue": patch
---

Fixed an issue where `useOrganization` would show an incorrect warning and dialog due to checking environment settings before Clerk was fully loaded.
70 changes: 70 additions & 0 deletions packages/vue/src/composables/__tests__/useOrganization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { Clerk } from '@clerk/shared/types';
import { render } from '@testing-library/vue';
import { vi } from 'vitest';
import { defineComponent, shallowRef } from 'vue';

import { useOrganization } from '../useOrganization';

const mockAttemptToEnableEnvironmentSetting = vi.fn();

const mockLoaded = shallowRef(false);
const mockClerk = shallowRef<Partial<Clerk> | null>(null);

vi.mock('../useClerkContext', () => ({
useClerkContext: () => ({
loaded: mockLoaded,
clerk: mockClerk,
organizationCtx: shallowRef(undefined),
}),
}));

vi.mock('../useSession', () => ({
useSession: () => ({
session: shallowRef(null),
}),
}));

describe('useOrganization', () => {
beforeEach(() => {
vi.clearAllMocks();
mockLoaded.value = false;
mockClerk.value = null;
});

it('should not call __internal_attemptToEnableEnvironmentSetting before Clerk is loaded', () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

expect(mockAttemptToEnableEnvironmentSetting).not.toHaveBeenCalled();
});

it('should call __internal_attemptToEnableEnvironmentSetting after Clerk is loaded', async () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

mockLoaded.value = true;

await vi.waitFor(() => {
expect(mockAttemptToEnableEnvironmentSetting).toHaveBeenCalledWith({
for: 'organizations',
caller: 'useOrganization',
});
});
});
});
14 changes: 8 additions & 6 deletions packages/vue/src/composables/useOrganization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,21 +53,23 @@ type UseOrganization = () => ToComputedRefs<UseOrganizationReturn>;
* </template>
*/
export const useOrganization: UseOrganization = () => {
const { clerk, organizationCtx } = useClerkContext('useOrganization');
const { loaded, clerk, organizationCtx } = useClerkContext('useOrganization');

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This loaded ref is set to true when Clerk.load() succeeds so this is more reliable

const { session } = useSession();

watch(
clerk,
loaded,
value => {
if (value) {
// Optional chaining is important for `@clerk/vue` usage with older clerk-js versions that don't have the method
value.__internal_attemptToEnableEnvironmentSetting?.({
clerk.value?.__internal_attemptToEnableEnvironmentSetting?.({

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

We are confident that clerk is defined here

for: 'organizations',
caller: 'useOrganization',
});
}
},
{ once: true },
{
once: true,
},
);

const result = computed<UseOrganizationReturn>(() => {
Expand All@@ -80,7 +82,7 @@ export const useOrganization: UseOrganization = () => {
}

/** In SSR context we include only the organization object when loadOrg is set to true. */
if (!clerk.value?.loaded) {
if (!loaded.value) {
return {
isLoaded: true,
organization: organizationCtx.value,
Expand All@@ -89,7 +91,7 @@ export const useOrganization: UseOrganization = () => {
}

return {
isLoaded: clerk.value.loaded,
isLoaded: loaded.value,
organization: organizationCtx.value,
membership: getCurrentOrganizationMembership(
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,6 +167,7 @@ export const clerkPlugin: Plugin<[PluginOptions]> = {
const organizationCtx = computed(() => derivedState.value.organization);

app.provide(ClerkInjectionKey, {
loaded,
clerk,
authCtx,
clientCtx,
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type {
import type { Component, ComputedRef, ShallowRef, Slot, VNode } from 'vue';

export interface VueClerkInjectionKeyType {
loaded: ShallowRef<boolean>;
clerk: ShallowRef<Clerk | null>;
authCtx: ComputedRef<{
userId: string | null | undefined;
Expand Down
Loading
, '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); } })(); })(); fix(vue): Defer `useOrganization` environment check until Clerk is loaded by wobsoriano · Pull Request #7982 · clerk/javascript · GitHub
Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/breezy-stingrays-give.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/vue": patch
---

Fixed an issue where `useOrganization` would show an incorrect warning and dialog due to checking environment settings before Clerk was fully loaded.
70 changes: 70 additions & 0 deletions packages/vue/src/composables/__tests__/useOrganization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { Clerk } from '@clerk/shared/types';
import { render } from '@testing-library/vue';
import { vi } from 'vitest';
import { defineComponent, shallowRef } from 'vue';

import { useOrganization } from '../useOrganization';

const mockAttemptToEnableEnvironmentSetting = vi.fn();

const mockLoaded = shallowRef(false);
const mockClerk = shallowRef<Partial<Clerk> | null>(null);

vi.mock('../useClerkContext', () => ({
useClerkContext: () => ({
loaded: mockLoaded,
clerk: mockClerk,
organizationCtx: shallowRef(undefined),
}),
}));

vi.mock('../useSession', () => ({
useSession: () => ({
session: shallowRef(null),
}),
}));

describe('useOrganization', () => {
beforeEach(() => {
vi.clearAllMocks();
mockLoaded.value = false;
mockClerk.value = null;
});

it('should not call __internal_attemptToEnableEnvironmentSetting before Clerk is loaded', () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

expect(mockAttemptToEnableEnvironmentSetting).not.toHaveBeenCalled();
});

it('should call __internal_attemptToEnableEnvironmentSetting after Clerk is loaded', async () => {
mockClerk.value = {
__internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting,
};

const Component = defineComponent(() => {
useOrganization();
return () => null;
});

render(Component);

mockLoaded.value = true;

await vi.waitFor(() => {
expect(mockAttemptToEnableEnvironmentSetting).toHaveBeenCalledWith({
for: 'organizations',
caller: 'useOrganization',
});
});
});
});
14 changes: 8 additions & 6 deletions packages/vue/src/composables/useOrganization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,21 +53,23 @@ type UseOrganization = () => ToComputedRefs<UseOrganizationReturn>;
* </template>
*/
export const useOrganization: UseOrganization = () => {
const { clerk, organizationCtx } = useClerkContext('useOrganization');
const { loaded, clerk, organizationCtx } = useClerkContext('useOrganization');

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This loaded ref is set to true when Clerk.load() succeeds so this is more reliable

const { session } = useSession();

watch(
clerk,
loaded,
value => {
if (value) {
// Optional chaining is important for `@clerk/vue` usage with older clerk-js versions that don't have the method
value.__internal_attemptToEnableEnvironmentSetting?.({
clerk.value?.__internal_attemptToEnableEnvironmentSetting?.({

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

We are confident that clerk is defined here

for: 'organizations',
caller: 'useOrganization',
});
}
},
{ once: true },
{
once: true,
},
);

const result = computed<UseOrganizationReturn>(() => {
Expand All@@ -80,7 +82,7 @@ export const useOrganization: UseOrganization = () => {
}

/** In SSR context we include only the organization object when loadOrg is set to true. */
if (!clerk.value?.loaded) {
if (!loaded.value) {
return {
isLoaded: true,
organization: organizationCtx.value,
Expand All@@ -89,7 +91,7 @@ export const useOrganization: UseOrganization = () => {
}

return {
isLoaded: clerk.value.loaded,
isLoaded: loaded.value,
organization: organizationCtx.value,
membership: getCurrentOrganizationMembership(
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,6 +167,7 @@ export const clerkPlugin: Plugin<[PluginOptions]> = {
const organizationCtx = computed(() => derivedState.value.organization);

app.provide(ClerkInjectionKey, {
loaded,
clerk,
authCtx,
clientCtx,
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import type {
import type { Component, ComputedRef, ShallowRef, Slot, VNode } from 'vue';

export interface VueClerkInjectionKeyType {
loaded: ShallowRef<boolean>;
clerk: ShallowRef<Clerk | null>;
authCtx: ComputedRef<{
userId: string | null | undefined;
Expand Down
Loading