Skip to content

chore(clerk-js): Fix broken Organization methods#1871

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
panteliselef merged 1 commit into from
Oct 12, 2023
Merged

chore(clerk-js): Fix broken Organization methods #1871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions .changeset/unlucky-carrots-exist.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': patch
'@clerk/clerk-react': patch
'@clerk/types': patch
---

Fix methods in clerk-js that consumede paginated endpoints in order to retrieve single resources.

@dimkldimklOct 12, 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.

🙃 Should we replace consumede with consume ?

26 changes: 25 additions & 1 deletion packages/clerk-js/src/core/clerk.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { mockNativeRuntime } from '../testUtils';
import Clerk from './clerk';
import { eventBus, events } from './events';
import type { AuthConfig, DisplayConfig, Organization } from './resources/internal';
import { Client, EmailLinkErrorCode, Environment, MagicLinkErrorCode, SignIn, SignUp } from './resources/internal';
import {
BaseResource,
Client,
EmailLinkErrorCode,
Environment,
MagicLinkErrorCode,
SignIn,
SignUp,
} from './resources/internal';
import { SessionCookieService } from './services';
import { mockJwt } from './test/fixtures';

Expand DownExpand Up@@ -2012,4 +2020,20 @@ describe('Clerk singleton', () => {
expect(url).toBe('https://rested-anemone-14.accounts.dev/?__dev_session=deadbeef');
});
});

describe('Organizations', () => {
it('getOrganization', async () => {
// @ts-ignore
BaseResource._fetch = jest.fn().mockResolvedValue({});
const sut = new Clerk(devFrontendApi);

await sut.getOrganization('some-org-id');

// @ts-ignore
expect(BaseResource._fetch).toHaveBeenCalledWith({
method: 'GET',
path: '/organizations/some-org-id',
});
});
});
});
6 changes: 2 additions & 4 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1152,10 +1152,8 @@ export default class Clerk implements ClerkInterface {
return await OrganizationMembership.retrieve();
};

public getOrganization = async (organizationId: string): Promise<Organization | undefined> => {
return (await OrganizationMembership.retrieve()).find(orgMem => orgMem.organization.id === organizationId)
?.organization;
};
public getOrganization = async (organizationId: string): Promise<OrganizationResource> =>
Organization.get(organizationId);

public updateEnvironment(environment: EnvironmentResource) {
this.#environment = environment;
Expand Down
25 changes: 13 additions & 12 deletions packages/clerk-js/src/core/resources/Organization.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -342,18 +342,19 @@ export class Organization extends BaseResource implements OrganizationResource {

public async reload(params?: ClerkResourceReloadParams): Promise<this> {
const { rotatingTokenNonce } = params || {};
const json = await BaseResource._fetch(
{
method: 'GET',
path: `/me/organization_memberships`,
rotatingTokenNonce,
},
{ forceUpdateClient: true },

@chanioxarischanioxarisOct 12, 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.

Don't we need to include this parameter as well?

@panteliselefpanteliselefOct 12, 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.

brought it back

);
const currentOrganization = (json?.response as unknown as OrganizationMembershipJSON[]).find(
orgMem => orgMem.organization.id === this.id,
);
return this.fromJSON(currentOrganization?.organization as OrganizationJSON);

const json = (
await BaseResource._fetch<OrganizationJSON>(
{
path: `/organizations/${this.id}`,
method: 'GET',
rotatingTokenNonce,
},
{ forceUpdateClient: true },
)
)?.response as unknown as OrganizationJSON;

return this.fromJSON(json);
}
}

Expand Down
6 changes: 3 additions & 3 deletions packages/clerk-js/src/ui/components/OrganizationList/UserInvitationList.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
import type { OrganizationResource, UserOrganizationInvitationResource } from '@clerk/types';
import { useState } from 'react';

import { Organization } from '../../../core/resources/Organization';
import { useCoreOrganizationList } from '../../contexts';
import { useCoreClerk, useCoreOrganizationList } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { useCardState, withCardStateProvider } from '../../elements';
import { handleError } from '../../utils';
Expand All@@ -25,6 +24,7 @@ export const AcceptRejectInvitationButtons = (props: { onAccept: () => void }) =

export const InvitationPreview = withCardStateProvider((props: UserOrganizationInvitationResource) => {
const card = useCardState();
const { getOrganization } = useCoreClerk();
const [acceptedOrganization, setAcceptedOrganization] = useState<OrganizationResource | null>(null);
const { userInvitations } = useCoreOrganizationList({
userInvitations: organizationListParams.userInvitations,
Expand All@@ -34,7 +34,7 @@ export const InvitationPreview = withCardStateProvider((props: UserOrganizationI
return card
.runAsync(async () => {
const updatedItem = await props.accept();
const organization = await Organization.get(props.publicOrganizationData.id);
const organization = await getOrganization(props.publicOrganizationData.id);
return [updatedItem, organization] as const;
})
.then(([updatedItem, organization]) => {
Expand Down
85 changes: 84 additions & 1 deletion packages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,11 @@ import { describe } from '@jest/globals';

import { render, waitFor } from '../../../../testUtils';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { createFakeUserOrganizationMembership } from '../../OrganizationSwitcher/__tests__/utlis';
import { createFakeOrganization } from '../../CreateOrganization/__tests__/CreateOrganization.test';
import {
createFakeUserOrganizationInvitation,
createFakeUserOrganizationMembership,
} from '../../OrganizationSwitcher/__tests__/utlis';
import { OrganizationList } from '../OrganizationList';

const { createFixtures } = bindCreateFixtures('OrganizationList');
Expand DownExpand Up@@ -109,6 +113,85 @@ describe('OrganizationList', () => {
expect(queryByRole('button', { name: 'Create organization' })).toBeInTheDocument();
});
});

it('lists invitations', async () => {
const { wrapper, props, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.dev'],
});
});

fixtures.clerk.user?.getOrganizationMemberships.mockReturnValueOnce(
Promise.resolve({
data: [
createFakeUserOrganizationMembership({
id: '1',
organization: {
id: '1',
name: 'Org1',
slug: 'org1',
membersCount: 1,
adminDeleteEnabled: false,
maxAllowedMemberships: 1,
pendingInvitationsCount: 1,
},
}),
],
total_count: 1,
}),
);

const invitation = createFakeUserOrganizationInvitation({
id: '1',
emailAddress: 'one@clerk.com',
publicOrganizationData: {
name: 'OrgOne',
},
});

invitation.accept = jest.fn().mockResolvedValue(
createFakeUserOrganizationInvitation({
id: '1',
emailAddress: 'one@clerk.com',
publicOrganizationData: {
name: 'OrgOne',
},
status: 'accepted',
}),
);

fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
Promise.resolve({
data: [invitation],
total_count: 1,
}),
);

fixtures.clerk.getOrganization.mockResolvedValue(
createFakeOrganization({
adminDeleteEnabled: false,
id: '2',
maxAllowedMemberships: 0,
membersCount: 1,
name: 'OrgOne',
pendingInvitationsCount: 0,
slug: '',
}),
);

props.setProps({ hidePersonal: true });
const { queryByText, userEvent, getByRole, queryByRole } = render(<OrganizationList />, { wrapper });

await waitFor(async () => {
// Display membership
expect(queryByText('Org1')).toBeInTheDocument();
// Display invitation
expect(queryByText('OrgOne')).toBeInTheDocument();
await userEvent.click(getByRole('button', { name: 'Join' }));
expect(queryByRole('button', { name: 'Join' })).not.toBeInTheDocument();
});
});
});

describe('CreateOrganization', () => {
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/isomorphicClerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -719,10 +719,10 @@ export default class IsomorphicClerk {
}
};

getOrganization = async (organizationId: string): Promise<OrganizationResource | undefined | void> => {
getOrganization = async (organizationId: string): Promise<OrganizationResource | void> => {
const callback = () => this.clerkjs?.getOrganization(organizationId);
if (this.clerkjs && this.#loaded) {
return callback() as Promise<OrganizationResource | undefined>;
return callback() as Promise<OrganizationResource>;
} else {
this.premountMethodCalls.set('getOrganization', callback);
}
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -442,7 +442,7 @@ export interface Clerk {
/**
* Retrieves a single organization by id.
*/
getOrganization: (organizationId: string) => Promise<OrganizationResource | undefined>;
getOrganization: (organizationId: string) => Promise<OrganizationResource>;

/**
* Handles a 401 response from Frontend API by refreshing the client and session object accordingly
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" + '
chore(clerk-js): Fix broken Organization methods by panteliselef · Pull Request #1871 · clerk/javascript · GitHub
Skip to content
chore(clerk-js): Fix broken Organization methods#1871

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

panteliselef
merged 1 commit into

from

Oct 12, 2023
 Merged


chore(clerk-js): Fix broken Organization methods
#1871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
.changeset/unlucky-carrots-exist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': patch
'@clerk/clerk-react': patch
'@clerk/types': patch
---

Fix methods in clerk-js that consumede paginated endpoints in order to retrieve single resources.
@dimkldimklOct 12, 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.

🙃 Should we replace consumede with consume ?

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/core/clerk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { mockNativeRuntime } from '../testUtils';
import Clerk from './clerk';
import { eventBus, events } from './events';
import type { AuthConfig, DisplayConfig, Organization } from './resources/internal';
import { Client, EmailLinkErrorCode, Environment, MagicLinkErrorCode, SignIn, SignUp } from './resources/internal';
import {
 BaseResource,
 Client,
 EmailLinkErrorCode,
 Environment,
 MagicLinkErrorCode,
 SignIn,
 SignUp,
} from './resources/internal';
import { SessionCookieService } from './services';
import { mockJwt } from './test/fixtures';

Expand DownExpand Up@@ -2012,4 +2020,20 @@ describe('Clerk singleton', () => {
 expect(url).toBe('https://rested-anemone-14.accounts.dev/?__dev_session=deadbeef');
 });
 });

 describe('Organizations', () => {
 it('getOrganization', async () => {
 // @ts-ignore
 BaseResource._fetch = jest.fn().mockResolvedValue({});
 const sut = new Clerk(devFrontendApi);

 await sut.getOrganization('some-org-id');

 // @ts-ignore
 expect(BaseResource._fetch).toHaveBeenCalledWith({
 method: 'GET',
 path: '/organizations/some-org-id',
 });
 });
 });
});

6 changes: 2 additions & 4 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1152,10 +1152,8 @@ export default class Clerk implements ClerkInterface {
 return await OrganizationMembership.retrieve();
 };

 public getOrganization = async (organizationId: string): Promise<Organization | undefined> => {
 return (await OrganizationMembership.retrieve()).find(orgMem => orgMem.organization.id === organizationId)
 ?.organization;
 };
 public getOrganization = async (organizationId: string): Promise<OrganizationResource> =>
 Organization.get(organizationId);

 public updateEnvironment(environment: EnvironmentResource) {
 this.#environment = environment;
Expand Down

25 changes: 13 additions & 12 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,18 +342,19 @@ export class Organization extends BaseResource implements OrganizationResource {

 public async reload(params?: ClerkResourceReloadParams): Promise<this> {
 const { rotatingTokenNonce } = params || {};
 const json = await BaseResource._fetch(
 {
 method: 'GET',
 path: `/me/organization_memberships`,
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
@chanioxarischanioxarisOct 12, 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.

Don't we need to include this parameter as well?
@panteliselefpanteliselefOct 12, 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.

brought it back
 );
 const currentOrganization = (json?.response as unknown as OrganizationMembershipJSON[]).find(
 orgMem => orgMem.organization.id === this.id,
 );
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);

 const json = (
 await BaseResource._fetch<OrganizationJSON>(
 {
 path: `/organizations/${this.id}`,
 method: 'GET',
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
 )
 )?.response as unknown as OrganizationJSON;

 return this.fromJSON(json);
 }
}

Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationList/UserInvitationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
import type { OrganizationResource, UserOrganizationInvitationResource } from '@clerk/types';
import { useState } from 'react';

import { Organization } from '../../../core/resources/Organization';
import { useCoreOrganizationList } from '../../contexts';
import { useCoreClerk, useCoreOrganizationList } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { useCardState, withCardStateProvider } from '../../elements';
import { handleError } from '../../utils';
Expand All@@ -25,6 +24,7 @@ export const AcceptRejectInvitationButtons = (props: { onAccept: () => void }) =

export const InvitationPreview = withCardStateProvider((props: UserOrganizationInvitationResource) => {
 const card = useCardState();
 const { getOrganization } = useCoreClerk();
 const [acceptedOrganization, setAcceptedOrganization] = useState<OrganizationResource | null>(null);
 const { userInvitations } = useCoreOrganizationList({
 userInvitations: organizationListParams.userInvitations,
Expand All@@ -34,7 +34,7 @@ export const InvitationPreview = withCardStateProvider((props: UserOrganizationI
 return card
 .runAsync(async () => {
 const updatedItem = await props.accept();
 const organization = await Organization.get(props.publicOrganizationData.id);
 const organization = await getOrganization(props.publicOrganizationData.id);
 return [updatedItem, organization] as const;
 })
 .then(([updatedItem, organization]) => {
Expand Down

85 changes: 84 additions & 1 deletion
packages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,11 @@ import { describe } from '@jest/globals';

import { render, waitFor } from '../../../../testUtils';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { createFakeUserOrganizationMembership } from '../../OrganizationSwitcher/__tests__/utlis';
import { createFakeOrganization } from '../../CreateOrganization/__tests__/CreateOrganization.test';
import {
 createFakeUserOrganizationInvitation,
 createFakeUserOrganizationMembership,
} from '../../OrganizationSwitcher/__tests__/utlis';
import { OrganizationList } from '../OrganizationList';

const { createFixtures } = bindCreateFixtures('OrganizationList');
Expand DownExpand Up@@ -109,6 +113,85 @@ describe('OrganizationList', () => {
 expect(queryByRole('button', { name: 'Create organization' })).toBeInTheDocument();
 });
 });

 it('lists invitations', async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 fixtures.clerk.user?.getOrganizationMemberships.mockReturnValueOnce(
 Promise.resolve({
 data: [
 createFakeUserOrganizationMembership({
 id: '1',
 organization: {
 id: '1',
 name: 'Org1',
 slug: 'org1',
 membersCount: 1,
 adminDeleteEnabled: false,
 maxAllowedMemberships: 1,
 pendingInvitationsCount: 1,
 },
 }),
 ],
 total_count: 1,
 }),
 );

 const invitation = createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 });

 invitation.accept = jest.fn().mockResolvedValue(
 createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 status: 'accepted',
 }),
 );

 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [invitation],
 total_count: 1,
 }),
 );

 fixtures.clerk.getOrganization.mockResolvedValue(
 createFakeOrganization({
 adminDeleteEnabled: false,
 id: '2',
 maxAllowedMemberships: 0,
 membersCount: 1,
 name: 'OrgOne',
 pendingInvitationsCount: 0,
 slug: '',
 }),
 );

 props.setProps({ hidePersonal: true });
 const { queryByText, userEvent, getByRole, queryByRole } = render(<OrganizationList />, { wrapper });

 await waitFor(async () => {
 // Display membership
 expect(queryByText('Org1')).toBeInTheDocument();
 // Display invitation
 expect(queryByText('OrgOne')).toBeInTheDocument();
 await userEvent.click(getByRole('button', { name: 'Join' }));
 expect(queryByRole('button', { name: 'Join' })).not.toBeInTheDocument();
 });
 });
 });

 describe('CreateOrganization', () => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -719,10 +719,10 @@ export default class IsomorphicClerk {
 }
 };

 getOrganization = async (organizationId: string): Promise<OrganizationResource | undefined | void> => {
 getOrganization = async (organizationId: string): Promise<OrganizationResource | void> => {
 const callback = () => this.clerkjs?.getOrganization(organizationId);
 if (this.clerkjs && this.#loaded) {
 return callback() as Promise<OrganizationResource | undefined>;
 return callback() as Promise<OrganizationResource>;
 } else {
 this.premountMethodCalls.set('getOrganization', callback);
 }
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,7 +442,7 @@ export interface Clerk {
 /**
 * Retrieves a single organization by id.
 */
 getOrganization: (organizationId: string) => Promise<OrganizationResource | undefined>;
 getOrganization: (organizationId: string) => Promise<OrganizationResource>;

 /**
 * Handles a 401 response from Frontend API by refreshing the client and session object accordingly
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('^' + ".*" + '
chore(clerk-js): Fix broken Organization methods by panteliselef · Pull Request #1871 · clerk/javascript · GitHub
Skip to content
chore(clerk-js): Fix broken Organization methods#1871

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

panteliselef
merged 1 commit into

from

Oct 12, 2023
 Merged


chore(clerk-js): Fix broken Organization methods
#1871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
.changeset/unlucky-carrots-exist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': patch
'@clerk/clerk-react': patch
'@clerk/types': patch
---

Fix methods in clerk-js that consumede paginated endpoints in order to retrieve single resources.
@dimkldimklOct 12, 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.

🙃 Should we replace consumede with consume ?

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/core/clerk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { mockNativeRuntime } from '../testUtils';
import Clerk from './clerk';
import { eventBus, events } from './events';
import type { AuthConfig, DisplayConfig, Organization } from './resources/internal';
import { Client, EmailLinkErrorCode, Environment, MagicLinkErrorCode, SignIn, SignUp } from './resources/internal';
import {
 BaseResource,
 Client,
 EmailLinkErrorCode,
 Environment,
 MagicLinkErrorCode,
 SignIn,
 SignUp,
} from './resources/internal';
import { SessionCookieService } from './services';
import { mockJwt } from './test/fixtures';

Expand DownExpand Up@@ -2012,4 +2020,20 @@ describe('Clerk singleton', () => {
 expect(url).toBe('https://rested-anemone-14.accounts.dev/?__dev_session=deadbeef');
 });
 });

 describe('Organizations', () => {
 it('getOrganization', async () => {
 // @ts-ignore
 BaseResource._fetch = jest.fn().mockResolvedValue({});
 const sut = new Clerk(devFrontendApi);

 await sut.getOrganization('some-org-id');

 // @ts-ignore
 expect(BaseResource._fetch).toHaveBeenCalledWith({
 method: 'GET',
 path: '/organizations/some-org-id',
 });
 });
 });
});

6 changes: 2 additions & 4 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1152,10 +1152,8 @@ export default class Clerk implements ClerkInterface {
 return await OrganizationMembership.retrieve();
 };

 public getOrganization = async (organizationId: string): Promise<Organization | undefined> => {
 return (await OrganizationMembership.retrieve()).find(orgMem => orgMem.organization.id === organizationId)
 ?.organization;
 };
 public getOrganization = async (organizationId: string): Promise<OrganizationResource> =>
 Organization.get(organizationId);

 public updateEnvironment(environment: EnvironmentResource) {
 this.#environment = environment;
Expand Down

25 changes: 13 additions & 12 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,18 +342,19 @@ export class Organization extends BaseResource implements OrganizationResource {

 public async reload(params?: ClerkResourceReloadParams): Promise<this> {
 const { rotatingTokenNonce } = params || {};
 const json = await BaseResource._fetch(
 {
 method: 'GET',
 path: `/me/organization_memberships`,
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
@chanioxarischanioxarisOct 12, 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.

Don't we need to include this parameter as well?
@panteliselefpanteliselefOct 12, 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.

brought it back
 );
 const currentOrganization = (json?.response as unknown as OrganizationMembershipJSON[]).find(
 orgMem => orgMem.organization.id === this.id,
 );
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);

 const json = (
 await BaseResource._fetch<OrganizationJSON>(
 {
 path: `/organizations/${this.id}`,
 method: 'GET',
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
 )
 )?.response as unknown as OrganizationJSON;

 return this.fromJSON(json);
 }
}

Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationList/UserInvitationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
import type { OrganizationResource, UserOrganizationInvitationResource } from '@clerk/types';
import { useState } from 'react';

import { Organization } from '../../../core/resources/Organization';
import { useCoreOrganizationList } from '../../contexts';
import { useCoreClerk, useCoreOrganizationList } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { useCardState, withCardStateProvider } from '../../elements';
import { handleError } from '../../utils';
Expand All@@ -25,6 +24,7 @@ export const AcceptRejectInvitationButtons = (props: { onAccept: () => void }) =

export const InvitationPreview = withCardStateProvider((props: UserOrganizationInvitationResource) => {
 const card = useCardState();
 const { getOrganization } = useCoreClerk();
 const [acceptedOrganization, setAcceptedOrganization] = useState<OrganizationResource | null>(null);
 const { userInvitations } = useCoreOrganizationList({
 userInvitations: organizationListParams.userInvitations,
Expand All@@ -34,7 +34,7 @@ export const InvitationPreview = withCardStateProvider((props: UserOrganizationI
 return card
 .runAsync(async () => {
 const updatedItem = await props.accept();
 const organization = await Organization.get(props.publicOrganizationData.id);
 const organization = await getOrganization(props.publicOrganizationData.id);
 return [updatedItem, organization] as const;
 })
 .then(([updatedItem, organization]) => {
Expand Down

85 changes: 84 additions & 1 deletion
packages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,11 @@ import { describe } from '@jest/globals';

import { render, waitFor } from '../../../../testUtils';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { createFakeUserOrganizationMembership } from '../../OrganizationSwitcher/__tests__/utlis';
import { createFakeOrganization } from '../../CreateOrganization/__tests__/CreateOrganization.test';
import {
 createFakeUserOrganizationInvitation,
 createFakeUserOrganizationMembership,
} from '../../OrganizationSwitcher/__tests__/utlis';
import { OrganizationList } from '../OrganizationList';

const { createFixtures } = bindCreateFixtures('OrganizationList');
Expand DownExpand Up@@ -109,6 +113,85 @@ describe('OrganizationList', () => {
 expect(queryByRole('button', { name: 'Create organization' })).toBeInTheDocument();
 });
 });

 it('lists invitations', async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 fixtures.clerk.user?.getOrganizationMemberships.mockReturnValueOnce(
 Promise.resolve({
 data: [
 createFakeUserOrganizationMembership({
 id: '1',
 organization: {
 id: '1',
 name: 'Org1',
 slug: 'org1',
 membersCount: 1,
 adminDeleteEnabled: false,
 maxAllowedMemberships: 1,
 pendingInvitationsCount: 1,
 },
 }),
 ],
 total_count: 1,
 }),
 );

 const invitation = createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 });

 invitation.accept = jest.fn().mockResolvedValue(
 createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 status: 'accepted',
 }),
 );

 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [invitation],
 total_count: 1,
 }),
 );

 fixtures.clerk.getOrganization.mockResolvedValue(
 createFakeOrganization({
 adminDeleteEnabled: false,
 id: '2',
 maxAllowedMemberships: 0,
 membersCount: 1,
 name: 'OrgOne',
 pendingInvitationsCount: 0,
 slug: '',
 }),
 );

 props.setProps({ hidePersonal: true });
 const { queryByText, userEvent, getByRole, queryByRole } = render(<OrganizationList />, { wrapper });

 await waitFor(async () => {
 // Display membership
 expect(queryByText('Org1')).toBeInTheDocument();
 // Display invitation
 expect(queryByText('OrgOne')).toBeInTheDocument();
 await userEvent.click(getByRole('button', { name: 'Join' }));
 expect(queryByRole('button', { name: 'Join' })).not.toBeInTheDocument();
 });
 });
 });

 describe('CreateOrganization', () => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -719,10 +719,10 @@ export default class IsomorphicClerk {
 }
 };

 getOrganization = async (organizationId: string): Promise<OrganizationResource | undefined | void> => {
 getOrganization = async (organizationId: string): Promise<OrganizationResource | void> => {
 const callback = () => this.clerkjs?.getOrganization(organizationId);
 if (this.clerkjs && this.#loaded) {
 return callback() as Promise<OrganizationResource | undefined>;
 return callback() as Promise<OrganizationResource>;
 } else {
 this.premountMethodCalls.set('getOrganization', callback);
 }
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,7 +442,7 @@ export interface Clerk {
 /**
 * Retrieves a single organization by id.
 */
 getOrganization: (organizationId: string) => Promise<OrganizationResource | undefined>;
 getOrganization: (organizationId: string) => Promise<OrganizationResource>;

 /**
 * Handles a 401 response from Frontend API by refreshing the client and session object accordingly
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('^' + ".*" + '
chore(clerk-js): Fix broken Organization methods by panteliselef · Pull Request #1871 · clerk/javascript · GitHub
Skip to content
chore(clerk-js): Fix broken Organization methods#1871

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

panteliselef
merged 1 commit into

from

Oct 12, 2023
 Merged


chore(clerk-js): Fix broken Organization methods
#1871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
.changeset/unlucky-carrots-exist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': patch
'@clerk/clerk-react': patch
'@clerk/types': patch
---

Fix methods in clerk-js that consumede paginated endpoints in order to retrieve single resources.
@dimkldimklOct 12, 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.

🙃 Should we replace consumede with consume ?

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/core/clerk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { mockNativeRuntime } from '../testUtils';
import Clerk from './clerk';
import { eventBus, events } from './events';
import type { AuthConfig, DisplayConfig, Organization } from './resources/internal';
import { Client, EmailLinkErrorCode, Environment, MagicLinkErrorCode, SignIn, SignUp } from './resources/internal';
import {
 BaseResource,
 Client,
 EmailLinkErrorCode,
 Environment,
 MagicLinkErrorCode,
 SignIn,
 SignUp,
} from './resources/internal';
import { SessionCookieService } from './services';
import { mockJwt } from './test/fixtures';

Expand DownExpand Up@@ -2012,4 +2020,20 @@ describe('Clerk singleton', () => {
 expect(url).toBe('https://rested-anemone-14.accounts.dev/?__dev_session=deadbeef');
 });
 });

 describe('Organizations', () => {
 it('getOrganization', async () => {
 // @ts-ignore
 BaseResource._fetch = jest.fn().mockResolvedValue({});
 const sut = new Clerk(devFrontendApi);

 await sut.getOrganization('some-org-id');

 // @ts-ignore
 expect(BaseResource._fetch).toHaveBeenCalledWith({
 method: 'GET',
 path: '/organizations/some-org-id',
 });
 });
 });
});

6 changes: 2 additions & 4 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1152,10 +1152,8 @@ export default class Clerk implements ClerkInterface {
 return await OrganizationMembership.retrieve();
 };

 public getOrganization = async (organizationId: string): Promise<Organization | undefined> => {
 return (await OrganizationMembership.retrieve()).find(orgMem => orgMem.organization.id === organizationId)
 ?.organization;
 };
 public getOrganization = async (organizationId: string): Promise<OrganizationResource> =>
 Organization.get(organizationId);

 public updateEnvironment(environment: EnvironmentResource) {
 this.#environment = environment;
Expand Down

25 changes: 13 additions & 12 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,18 +342,19 @@ export class Organization extends BaseResource implements OrganizationResource {

 public async reload(params?: ClerkResourceReloadParams): Promise<this> {
 const { rotatingTokenNonce } = params || {};
 const json = await BaseResource._fetch(
 {
 method: 'GET',
 path: `/me/organization_memberships`,
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
@chanioxarischanioxarisOct 12, 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.

Don't we need to include this parameter as well?
@panteliselefpanteliselefOct 12, 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.

brought it back
 );
 const currentOrganization = (json?.response as unknown as OrganizationMembershipJSON[]).find(
 orgMem => orgMem.organization.id === this.id,
 );
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);

 const json = (
 await BaseResource._fetch<OrganizationJSON>(
 {
 path: `/organizations/${this.id}`,
 method: 'GET',
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
 )
 )?.response as unknown as OrganizationJSON;

 return this.fromJSON(json);
 }
}

Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationList/UserInvitationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
import type { OrganizationResource, UserOrganizationInvitationResource } from '@clerk/types';
import { useState } from 'react';

import { Organization } from '../../../core/resources/Organization';
import { useCoreOrganizationList } from '../../contexts';
import { useCoreClerk, useCoreOrganizationList } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { useCardState, withCardStateProvider } from '../../elements';
import { handleError } from '../../utils';
Expand All@@ -25,6 +24,7 @@ export const AcceptRejectInvitationButtons = (props: { onAccept: () => void }) =

export const InvitationPreview = withCardStateProvider((props: UserOrganizationInvitationResource) => {
 const card = useCardState();
 const { getOrganization } = useCoreClerk();
 const [acceptedOrganization, setAcceptedOrganization] = useState<OrganizationResource | null>(null);
 const { userInvitations } = useCoreOrganizationList({
 userInvitations: organizationListParams.userInvitations,
Expand All@@ -34,7 +34,7 @@ export const InvitationPreview = withCardStateProvider((props: UserOrganizationI
 return card
 .runAsync(async () => {
 const updatedItem = await props.accept();
 const organization = await Organization.get(props.publicOrganizationData.id);
 const organization = await getOrganization(props.publicOrganizationData.id);
 return [updatedItem, organization] as const;
 })
 .then(([updatedItem, organization]) => {
Expand Down

85 changes: 84 additions & 1 deletion
packages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,11 @@ import { describe } from '@jest/globals';

import { render, waitFor } from '../../../../testUtils';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { createFakeUserOrganizationMembership } from '../../OrganizationSwitcher/__tests__/utlis';
import { createFakeOrganization } from '../../CreateOrganization/__tests__/CreateOrganization.test';
import {
 createFakeUserOrganizationInvitation,
 createFakeUserOrganizationMembership,
} from '../../OrganizationSwitcher/__tests__/utlis';
import { OrganizationList } from '../OrganizationList';

const { createFixtures } = bindCreateFixtures('OrganizationList');
Expand DownExpand Up@@ -109,6 +113,85 @@ describe('OrganizationList', () => {
 expect(queryByRole('button', { name: 'Create organization' })).toBeInTheDocument();
 });
 });

 it('lists invitations', async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 fixtures.clerk.user?.getOrganizationMemberships.mockReturnValueOnce(
 Promise.resolve({
 data: [
 createFakeUserOrganizationMembership({
 id: '1',
 organization: {
 id: '1',
 name: 'Org1',
 slug: 'org1',
 membersCount: 1,
 adminDeleteEnabled: false,
 maxAllowedMemberships: 1,
 pendingInvitationsCount: 1,
 },
 }),
 ],
 total_count: 1,
 }),
 );

 const invitation = createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 });

 invitation.accept = jest.fn().mockResolvedValue(
 createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 status: 'accepted',
 }),
 );

 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [invitation],
 total_count: 1,
 }),
 );

 fixtures.clerk.getOrganization.mockResolvedValue(
 createFakeOrganization({
 adminDeleteEnabled: false,
 id: '2',
 maxAllowedMemberships: 0,
 membersCount: 1,
 name: 'OrgOne',
 pendingInvitationsCount: 0,
 slug: '',
 }),
 );

 props.setProps({ hidePersonal: true });
 const { queryByText, userEvent, getByRole, queryByRole } = render(<OrganizationList />, { wrapper });

 await waitFor(async () => {
 // Display membership
 expect(queryByText('Org1')).toBeInTheDocument();
 // Display invitation
 expect(queryByText('OrgOne')).toBeInTheDocument();
 await userEvent.click(getByRole('button', { name: 'Join' }));
 expect(queryByRole('button', { name: 'Join' })).not.toBeInTheDocument();
 });
 });
 });

 describe('CreateOrganization', () => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -719,10 +719,10 @@ export default class IsomorphicClerk {
 }
 };

 getOrganization = async (organizationId: string): Promise<OrganizationResource | undefined | void> => {
 getOrganization = async (organizationId: string): Promise<OrganizationResource | void> => {
 const callback = () => this.clerkjs?.getOrganization(organizationId);
 if (this.clerkjs && this.#loaded) {
 return callback() as Promise<OrganizationResource | undefined>;
 return callback() as Promise<OrganizationResource>;
 } else {
 this.premountMethodCalls.set('getOrganization', callback);
 }
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,7 +442,7 @@ export interface Clerk {
 /**
 * Retrieves a single organization by id.
 */
 getOrganization: (organizationId: string) => Promise<OrganizationResource | undefined>;
 getOrganization: (organizationId: string) => Promise<OrganizationResource>;

 /**
 * Handles a 401 response from Frontend API by refreshing the client and session object accordingly
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" + '
chore(clerk-js): Fix broken Organization methods by panteliselef · Pull Request #1871 · clerk/javascript · GitHub
Skip to content
chore(clerk-js): Fix broken Organization methods#1871

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

panteliselef
merged 1 commit into

from

Oct 12, 2023
 Merged


chore(clerk-js): Fix broken Organization methods
#1871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
.changeset/unlucky-carrots-exist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': patch
'@clerk/clerk-react': patch
'@clerk/types': patch
---

Fix methods in clerk-js that consumede paginated endpoints in order to retrieve single resources.
@dimkldimklOct 12, 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.

🙃 Should we replace consumede with consume ?

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/core/clerk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { mockNativeRuntime } from '../testUtils';
import Clerk from './clerk';
import { eventBus, events } from './events';
import type { AuthConfig, DisplayConfig, Organization } from './resources/internal';
import { Client, EmailLinkErrorCode, Environment, MagicLinkErrorCode, SignIn, SignUp } from './resources/internal';
import {
 BaseResource,
 Client,
 EmailLinkErrorCode,
 Environment,
 MagicLinkErrorCode,
 SignIn,
 SignUp,
} from './resources/internal';
import { SessionCookieService } from './services';
import { mockJwt } from './test/fixtures';

Expand DownExpand Up@@ -2012,4 +2020,20 @@ describe('Clerk singleton', () => {
 expect(url).toBe('https://rested-anemone-14.accounts.dev/?__dev_session=deadbeef');
 });
 });

 describe('Organizations', () => {
 it('getOrganization', async () => {
 // @ts-ignore
 BaseResource._fetch = jest.fn().mockResolvedValue({});
 const sut = new Clerk(devFrontendApi);

 await sut.getOrganization('some-org-id');

 // @ts-ignore
 expect(BaseResource._fetch).toHaveBeenCalledWith({
 method: 'GET',
 path: '/organizations/some-org-id',
 });
 });
 });
});

6 changes: 2 additions & 4 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1152,10 +1152,8 @@ export default class Clerk implements ClerkInterface {
 return await OrganizationMembership.retrieve();
 };

 public getOrganization = async (organizationId: string): Promise<Organization | undefined> => {
 return (await OrganizationMembership.retrieve()).find(orgMem => orgMem.organization.id === organizationId)
 ?.organization;
 };
 public getOrganization = async (organizationId: string): Promise<OrganizationResource> =>
 Organization.get(organizationId);

 public updateEnvironment(environment: EnvironmentResource) {
 this.#environment = environment;
Expand Down

25 changes: 13 additions & 12 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,18 +342,19 @@ export class Organization extends BaseResource implements OrganizationResource {

 public async reload(params?: ClerkResourceReloadParams): Promise<this> {
 const { rotatingTokenNonce } = params || {};
 const json = await BaseResource._fetch(
 {
 method: 'GET',
 path: `/me/organization_memberships`,
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
@chanioxarischanioxarisOct 12, 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.

Don't we need to include this parameter as well?
@panteliselefpanteliselefOct 12, 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.

brought it back
 );
 const currentOrganization = (json?.response as unknown as OrganizationMembershipJSON[]).find(
 orgMem => orgMem.organization.id === this.id,
 );
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);

 const json = (
 await BaseResource._fetch<OrganizationJSON>(
 {
 path: `/organizations/${this.id}`,
 method: 'GET',
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
 )
 )?.response as unknown as OrganizationJSON;

 return this.fromJSON(json);
 }
}

Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationList/UserInvitationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
import type { OrganizationResource, UserOrganizationInvitationResource } from '@clerk/types';
import { useState } from 'react';

import { Organization } from '../../../core/resources/Organization';
import { useCoreOrganizationList } from '../../contexts';
import { useCoreClerk, useCoreOrganizationList } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { useCardState, withCardStateProvider } from '../../elements';
import { handleError } from '../../utils';
Expand All@@ -25,6 +24,7 @@ export const AcceptRejectInvitationButtons = (props: { onAccept: () => void }) =

export const InvitationPreview = withCardStateProvider((props: UserOrganizationInvitationResource) => {
 const card = useCardState();
 const { getOrganization } = useCoreClerk();
 const [acceptedOrganization, setAcceptedOrganization] = useState<OrganizationResource | null>(null);
 const { userInvitations } = useCoreOrganizationList({
 userInvitations: organizationListParams.userInvitations,
Expand All@@ -34,7 +34,7 @@ export const InvitationPreview = withCardStateProvider((props: UserOrganizationI
 return card
 .runAsync(async () => {
 const updatedItem = await props.accept();
 const organization = await Organization.get(props.publicOrganizationData.id);
 const organization = await getOrganization(props.publicOrganizationData.id);
 return [updatedItem, organization] as const;
 })
 .then(([updatedItem, organization]) => {
Expand Down

85 changes: 84 additions & 1 deletion
packages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,11 @@ import { describe } from '@jest/globals';

import { render, waitFor } from '../../../../testUtils';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { createFakeUserOrganizationMembership } from '../../OrganizationSwitcher/__tests__/utlis';
import { createFakeOrganization } from '../../CreateOrganization/__tests__/CreateOrganization.test';
import {
 createFakeUserOrganizationInvitation,
 createFakeUserOrganizationMembership,
} from '../../OrganizationSwitcher/__tests__/utlis';
import { OrganizationList } from '../OrganizationList';

const { createFixtures } = bindCreateFixtures('OrganizationList');
Expand DownExpand Up@@ -109,6 +113,85 @@ describe('OrganizationList', () => {
 expect(queryByRole('button', { name: 'Create organization' })).toBeInTheDocument();
 });
 });

 it('lists invitations', async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 fixtures.clerk.user?.getOrganizationMemberships.mockReturnValueOnce(
 Promise.resolve({
 data: [
 createFakeUserOrganizationMembership({
 id: '1',
 organization: {
 id: '1',
 name: 'Org1',
 slug: 'org1',
 membersCount: 1,
 adminDeleteEnabled: false,
 maxAllowedMemberships: 1,
 pendingInvitationsCount: 1,
 },
 }),
 ],
 total_count: 1,
 }),
 );

 const invitation = createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 });

 invitation.accept = jest.fn().mockResolvedValue(
 createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 status: 'accepted',
 }),
 );

 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [invitation],
 total_count: 1,
 }),
 );

 fixtures.clerk.getOrganization.mockResolvedValue(
 createFakeOrganization({
 adminDeleteEnabled: false,
 id: '2',
 maxAllowedMemberships: 0,
 membersCount: 1,
 name: 'OrgOne',
 pendingInvitationsCount: 0,
 slug: '',
 }),
 );

 props.setProps({ hidePersonal: true });
 const { queryByText, userEvent, getByRole, queryByRole } = render(<OrganizationList />, { wrapper });

 await waitFor(async () => {
 // Display membership
 expect(queryByText('Org1')).toBeInTheDocument();
 // Display invitation
 expect(queryByText('OrgOne')).toBeInTheDocument();
 await userEvent.click(getByRole('button', { name: 'Join' }));
 expect(queryByRole('button', { name: 'Join' })).not.toBeInTheDocument();
 });
 });
 });

 describe('CreateOrganization', () => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -719,10 +719,10 @@ export default class IsomorphicClerk {
 }
 };

 getOrganization = async (organizationId: string): Promise<OrganizationResource | undefined | void> => {
 getOrganization = async (organizationId: string): Promise<OrganizationResource | void> => {
 const callback = () => this.clerkjs?.getOrganization(organizationId);
 if (this.clerkjs && this.#loaded) {
 return callback() as Promise<OrganizationResource | undefined>;
 return callback() as Promise<OrganizationResource>;
 } else {
 this.premountMethodCalls.set('getOrganization', callback);
 }
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,7 +442,7 @@ export interface Clerk {
 /**
 * Retrieves a single organization by id.
 */
 getOrganization: (organizationId: string) => Promise<OrganizationResource | undefined>;
 getOrganization: (organizationId: string) => Promise<OrganizationResource>;

 /**
 * Handles a 401 response from Frontend API by refreshing the client and session object accordingly
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('^' + ".*" + '
chore(clerk-js): Fix broken Organization methods by panteliselef · Pull Request #1871 · clerk/javascript · GitHub
Skip to content
chore(clerk-js): Fix broken Organization methods#1871

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

panteliselef
merged 1 commit into

from

Oct 12, 2023
 Merged


chore(clerk-js): Fix broken Organization methods
#1871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
.changeset/unlucky-carrots-exist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': patch
'@clerk/clerk-react': patch
'@clerk/types': patch
---

Fix methods in clerk-js that consumede paginated endpoints in order to retrieve single resources.
@dimkldimklOct 12, 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.

🙃 Should we replace consumede with consume ?

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/core/clerk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { mockNativeRuntime } from '../testUtils';
import Clerk from './clerk';
import { eventBus, events } from './events';
import type { AuthConfig, DisplayConfig, Organization } from './resources/internal';
import { Client, EmailLinkErrorCode, Environment, MagicLinkErrorCode, SignIn, SignUp } from './resources/internal';
import {
 BaseResource,
 Client,
 EmailLinkErrorCode,
 Environment,
 MagicLinkErrorCode,
 SignIn,
 SignUp,
} from './resources/internal';
import { SessionCookieService } from './services';
import { mockJwt } from './test/fixtures';

Expand DownExpand Up@@ -2012,4 +2020,20 @@ describe('Clerk singleton', () => {
 expect(url).toBe('https://rested-anemone-14.accounts.dev/?__dev_session=deadbeef');
 });
 });

 describe('Organizations', () => {
 it('getOrganization', async () => {
 // @ts-ignore
 BaseResource._fetch = jest.fn().mockResolvedValue({});
 const sut = new Clerk(devFrontendApi);

 await sut.getOrganization('some-org-id');

 // @ts-ignore
 expect(BaseResource._fetch).toHaveBeenCalledWith({
 method: 'GET',
 path: '/organizations/some-org-id',
 });
 });
 });
});

6 changes: 2 additions & 4 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1152,10 +1152,8 @@ export default class Clerk implements ClerkInterface {
 return await OrganizationMembership.retrieve();
 };

 public getOrganization = async (organizationId: string): Promise<Organization | undefined> => {
 return (await OrganizationMembership.retrieve()).find(orgMem => orgMem.organization.id === organizationId)
 ?.organization;
 };
 public getOrganization = async (organizationId: string): Promise<OrganizationResource> =>
 Organization.get(organizationId);

 public updateEnvironment(environment: EnvironmentResource) {
 this.#environment = environment;
Expand Down

25 changes: 13 additions & 12 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,18 +342,19 @@ export class Organization extends BaseResource implements OrganizationResource {

 public async reload(params?: ClerkResourceReloadParams): Promise<this> {
 const { rotatingTokenNonce } = params || {};
 const json = await BaseResource._fetch(
 {
 method: 'GET',
 path: `/me/organization_memberships`,
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
@chanioxarischanioxarisOct 12, 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.

Don't we need to include this parameter as well?
@panteliselefpanteliselefOct 12, 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.

brought it back
 );
 const currentOrganization = (json?.response as unknown as OrganizationMembershipJSON[]).find(
 orgMem => orgMem.organization.id === this.id,
 );
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);

 const json = (
 await BaseResource._fetch<OrganizationJSON>(
 {
 path: `/organizations/${this.id}`,
 method: 'GET',
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
 )
 )?.response as unknown as OrganizationJSON;

 return this.fromJSON(json);
 }
}

Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationList/UserInvitationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
import type { OrganizationResource, UserOrganizationInvitationResource } from '@clerk/types';
import { useState } from 'react';

import { Organization } from '../../../core/resources/Organization';
import { useCoreOrganizationList } from '../../contexts';
import { useCoreClerk, useCoreOrganizationList } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { useCardState, withCardStateProvider } from '../../elements';
import { handleError } from '../../utils';
Expand All@@ -25,6 +24,7 @@ export const AcceptRejectInvitationButtons = (props: { onAccept: () => void }) =

export const InvitationPreview = withCardStateProvider((props: UserOrganizationInvitationResource) => {
 const card = useCardState();
 const { getOrganization } = useCoreClerk();
 const [acceptedOrganization, setAcceptedOrganization] = useState<OrganizationResource | null>(null);
 const { userInvitations } = useCoreOrganizationList({
 userInvitations: organizationListParams.userInvitations,
Expand All@@ -34,7 +34,7 @@ export const InvitationPreview = withCardStateProvider((props: UserOrganizationI
 return card
 .runAsync(async () => {
 const updatedItem = await props.accept();
 const organization = await Organization.get(props.publicOrganizationData.id);
 const organization = await getOrganization(props.publicOrganizationData.id);
 return [updatedItem, organization] as const;
 })
 .then(([updatedItem, organization]) => {
Expand Down

85 changes: 84 additions & 1 deletion
packages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,11 @@ import { describe } from '@jest/globals';

import { render, waitFor } from '../../../../testUtils';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { createFakeUserOrganizationMembership } from '../../OrganizationSwitcher/__tests__/utlis';
import { createFakeOrganization } from '../../CreateOrganization/__tests__/CreateOrganization.test';
import {
 createFakeUserOrganizationInvitation,
 createFakeUserOrganizationMembership,
} from '../../OrganizationSwitcher/__tests__/utlis';
import { OrganizationList } from '../OrganizationList';

const { createFixtures } = bindCreateFixtures('OrganizationList');
Expand DownExpand Up@@ -109,6 +113,85 @@ describe('OrganizationList', () => {
 expect(queryByRole('button', { name: 'Create organization' })).toBeInTheDocument();
 });
 });

 it('lists invitations', async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 fixtures.clerk.user?.getOrganizationMemberships.mockReturnValueOnce(
 Promise.resolve({
 data: [
 createFakeUserOrganizationMembership({
 id: '1',
 organization: {
 id: '1',
 name: 'Org1',
 slug: 'org1',
 membersCount: 1,
 adminDeleteEnabled: false,
 maxAllowedMemberships: 1,
 pendingInvitationsCount: 1,
 },
 }),
 ],
 total_count: 1,
 }),
 );

 const invitation = createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 });

 invitation.accept = jest.fn().mockResolvedValue(
 createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 status: 'accepted',
 }),
 );

 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [invitation],
 total_count: 1,
 }),
 );

 fixtures.clerk.getOrganization.mockResolvedValue(
 createFakeOrganization({
 adminDeleteEnabled: false,
 id: '2',
 maxAllowedMemberships: 0,
 membersCount: 1,
 name: 'OrgOne',
 pendingInvitationsCount: 0,
 slug: '',
 }),
 );

 props.setProps({ hidePersonal: true });
 const { queryByText, userEvent, getByRole, queryByRole } = render(<OrganizationList />, { wrapper });

 await waitFor(async () => {
 // Display membership
 expect(queryByText('Org1')).toBeInTheDocument();
 // Display invitation
 expect(queryByText('OrgOne')).toBeInTheDocument();
 await userEvent.click(getByRole('button', { name: 'Join' }));
 expect(queryByRole('button', { name: 'Join' })).not.toBeInTheDocument();
 });
 });
 });

 describe('CreateOrganization', () => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -719,10 +719,10 @@ export default class IsomorphicClerk {
 }
 };

 getOrganization = async (organizationId: string): Promise<OrganizationResource | undefined | void> => {
 getOrganization = async (organizationId: string): Promise<OrganizationResource | void> => {
 const callback = () => this.clerkjs?.getOrganization(organizationId);
 if (this.clerkjs && this.#loaded) {
 return callback() as Promise<OrganizationResource | undefined>;
 return callback() as Promise<OrganizationResource>;
 } else {
 this.premountMethodCalls.set('getOrganization', callback);
 }
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,7 +442,7 @@ export interface Clerk {
 /**
 * Retrieves a single organization by id.
 */
 getOrganization: (organizationId: string) => Promise<OrganizationResource | undefined>;
 getOrganization: (organizationId: string) => Promise<OrganizationResource>;

 /**
 * Handles a 401 response from Frontend API by refreshing the client and session object accordingly
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); }
})();
})();
chore(clerk-js): Fix broken Organization methods by panteliselef · Pull Request #1871 · clerk/javascript · GitHub
Skip to content
chore(clerk-js): Fix broken Organization methods#1871

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

panteliselef
merged 1 commit into

from

Oct 12, 2023
 Merged


chore(clerk-js): Fix broken Organization methods
#1871
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
.changeset/unlucky-carrots-exist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': patch
'@clerk/clerk-react': patch
'@clerk/types': patch
---

Fix methods in clerk-js that consumede paginated endpoints in order to retrieve single resources.
@dimkldimklOct 12, 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.

🙃 Should we replace consumede with consume ?

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/core/clerk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { mockNativeRuntime } from '../testUtils';
import Clerk from './clerk';
import { eventBus, events } from './events';
import type { AuthConfig, DisplayConfig, Organization } from './resources/internal';
import { Client, EmailLinkErrorCode, Environment, MagicLinkErrorCode, SignIn, SignUp } from './resources/internal';
import {
 BaseResource,
 Client,
 EmailLinkErrorCode,
 Environment,
 MagicLinkErrorCode,
 SignIn,
 SignUp,
} from './resources/internal';
import { SessionCookieService } from './services';
import { mockJwt } from './test/fixtures';

Expand DownExpand Up@@ -2012,4 +2020,20 @@ describe('Clerk singleton', () => {
 expect(url).toBe('https://rested-anemone-14.accounts.dev/?__dev_session=deadbeef');
 });
 });

 describe('Organizations', () => {
 it('getOrganization', async () => {
 // @ts-ignore
 BaseResource._fetch = jest.fn().mockResolvedValue({});
 const sut = new Clerk(devFrontendApi);

 await sut.getOrganization('some-org-id');

 // @ts-ignore
 expect(BaseResource._fetch).toHaveBeenCalledWith({
 method: 'GET',
 path: '/organizations/some-org-id',
 });
 });
 });
});

6 changes: 2 additions & 4 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1152,10 +1152,8 @@ export default class Clerk implements ClerkInterface {
 return await OrganizationMembership.retrieve();
 };

 public getOrganization = async (organizationId: string): Promise<Organization | undefined> => {
 return (await OrganizationMembership.retrieve()).find(orgMem => orgMem.organization.id === organizationId)
 ?.organization;
 };
 public getOrganization = async (organizationId: string): Promise<OrganizationResource> =>
 Organization.get(organizationId);

 public updateEnvironment(environment: EnvironmentResource) {
 this.#environment = environment;
Expand Down

25 changes: 13 additions & 12 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,18 +342,19 @@ export class Organization extends BaseResource implements OrganizationResource {

 public async reload(params?: ClerkResourceReloadParams): Promise<this> {
 const { rotatingTokenNonce } = params || {};
 const json = await BaseResource._fetch(
 {
 method: 'GET',
 path: `/me/organization_memberships`,
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
@chanioxarischanioxarisOct 12, 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.

Don't we need to include this parameter as well?
@panteliselefpanteliselefOct 12, 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.

brought it back
 );
 const currentOrganization = (json?.response as unknown as OrganizationMembershipJSON[]).find(
 orgMem => orgMem.organization.id === this.id,
 );
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);

 const json = (
 await BaseResource._fetch<OrganizationJSON>(
 {
 path: `/organizations/${this.id}`,
 method: 'GET',
 rotatingTokenNonce,
 },
 { forceUpdateClient: true },
 )
 )?.response as unknown as OrganizationJSON;

 return this.fromJSON(json);
 }
}

Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationList/UserInvitationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
import type { OrganizationResource, UserOrganizationInvitationResource } from '@clerk/types';
import { useState } from 'react';

import { Organization } from '../../../core/resources/Organization';
import { useCoreOrganizationList } from '../../contexts';
import { useCoreClerk, useCoreOrganizationList } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { useCardState, withCardStateProvider } from '../../elements';
import { handleError } from '../../utils';
Expand All@@ -25,6 +24,7 @@ export const AcceptRejectInvitationButtons = (props: { onAccept: () => void }) =

export const InvitationPreview = withCardStateProvider((props: UserOrganizationInvitationResource) => {
 const card = useCardState();
 const { getOrganization } = useCoreClerk();
 const [acceptedOrganization, setAcceptedOrganization] = useState<OrganizationResource | null>(null);
 const { userInvitations } = useCoreOrganizationList({
 userInvitations: organizationListParams.userInvitations,
Expand All@@ -34,7 +34,7 @@ export const InvitationPreview = withCardStateProvider((props: UserOrganizationI
 return card
 .runAsync(async () => {
 const updatedItem = await props.accept();
 const organization = await Organization.get(props.publicOrganizationData.id);
 const organization = await getOrganization(props.publicOrganizationData.id);
 return [updatedItem, organization] as const;
 })
 .then(([updatedItem, organization]) => {
Expand Down

85 changes: 84 additions & 1 deletion
packages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,11 @@ import { describe } from '@jest/globals';

import { render, waitFor } from '../../../../testUtils';
import { bindCreateFixtures } from '../../../utils/test/createFixtures';
import { createFakeUserOrganizationMembership } from '../../OrganizationSwitcher/__tests__/utlis';
import { createFakeOrganization } from '../../CreateOrganization/__tests__/CreateOrganization.test';
import {
 createFakeUserOrganizationInvitation,
 createFakeUserOrganizationMembership,
} from '../../OrganizationSwitcher/__tests__/utlis';
import { OrganizationList } from '../OrganizationList';

const { createFixtures } = bindCreateFixtures('OrganizationList');
Expand DownExpand Up@@ -109,6 +113,85 @@ describe('OrganizationList', () => {
 expect(queryByRole('button', { name: 'Create organization' })).toBeInTheDocument();
 });
 });

 it('lists invitations', async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 fixtures.clerk.user?.getOrganizationMemberships.mockReturnValueOnce(
 Promise.resolve({
 data: [
 createFakeUserOrganizationMembership({
 id: '1',
 organization: {
 id: '1',
 name: 'Org1',
 slug: 'org1',
 membersCount: 1,
 adminDeleteEnabled: false,
 maxAllowedMemberships: 1,
 pendingInvitationsCount: 1,
 },
 }),
 ],
 total_count: 1,
 }),
 );

 const invitation = createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 });

 invitation.accept = jest.fn().mockResolvedValue(
 createFakeUserOrganizationInvitation({
 id: '1',
 emailAddress: 'one@clerk.com',
 publicOrganizationData: {
 name: 'OrgOne',
 },
 status: 'accepted',
 }),
 );

 fixtures.clerk.user?.getOrganizationInvitations.mockReturnValueOnce(
 Promise.resolve({
 data: [invitation],
 total_count: 1,
 }),
 );

 fixtures.clerk.getOrganization.mockResolvedValue(
 createFakeOrganization({
 adminDeleteEnabled: false,
 id: '2',
 maxAllowedMemberships: 0,
 membersCount: 1,
 name: 'OrgOne',
 pendingInvitationsCount: 0,
 slug: '',
 }),
 );

 props.setProps({ hidePersonal: true });
 const { queryByText, userEvent, getByRole, queryByRole } = render(<OrganizationList />, { wrapper });

 await waitFor(async () => {
 // Display membership
 expect(queryByText('Org1')).toBeInTheDocument();
 // Display invitation
 expect(queryByText('OrgOne')).toBeInTheDocument();
 await userEvent.click(getByRole('button', { name: 'Join' }));
 expect(queryByRole('button', { name: 'Join' })).not.toBeInTheDocument();
 });
 });
 });

 describe('CreateOrganization', () => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -719,10 +719,10 @@ export default class IsomorphicClerk {
 }
 };

 getOrganization = async (organizationId: string): Promise<OrganizationResource | undefined | void> => {
 getOrganization = async (organizationId: string): Promise<OrganizationResource | void> => {
 const callback = () => this.clerkjs?.getOrganization(organizationId);
 if (this.clerkjs && this.#loaded) {
 return callback() as Promise<OrganizationResource | undefined>;
 return callback() as Promise<OrganizationResource>;
 } else {
 this.premountMethodCalls.set('getOrganization', callback);
 }
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,7 +442,7 @@ export interface Clerk {
 /**
 * Retrieves a single organization by id.
 */
 getOrganization: (organizationId: string) => Promise<OrganizationResource | undefined>;
 getOrganization: (organizationId: string) => Promise<OrganizationResource>;

 /**
 * Handles a 401 response from Frontend API by refreshing the client and session object accordingly
Expand Down