refactor: organization creation handler #14911
Open
+343
−96
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for following the naming conventions! 🙏 Feel free to join our discord and post your PR link. |
keithwillcode
added
core
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Ignored Deployments
|
Graphite Automations"Add platform team as reviewer" took an action on this PR • (05/07/24)1 reviewer was added to this PR based on Keith Williams's automation. |
📦 Next.js Bundle Analysis for @calcom/webThis analysis was generated by the Next.js Bundle Analysis action. 🤖 Three Pages Changed SizeThe following pages changed size from the code in this PR compared to its base branch:
DetailsOnly the gzipped size is provided here based on an expert tip. First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If Any third party scripts you have added directly to your app using the The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored. |
Current Playwright Test Results Summary✅ 310 Passing - ❌ 5 Failing - Run may still be in progress, this comment will be updated as current testing workflow or job completes... (Last updated on 05/17/2024 08:23:57am UTC) Run DetailsRunning Workflow PR Update on Github Actions Commit: bee7ff3 Started: 05/17/2024 08:20:29am UTC ❌ Failures📄 apps/web/playwright/profile.e2e.ts • 2 FailuresTest Case Results
📄 apps/web/playwright/webhook.e2e.ts • 1 FailureTest Case Results
📄 apps/web/playwright/team/team-invitation.e2e.ts • 1 FailureTest Case Results
📄 apps/web/playwright/organization/organization-creation.e2e.ts • 1 FailureTest Case Results
|
| Test Case | Last 7 days Failures | Last 7 days Flakes |
|---|---|---|
|
Stripe integration Paid booking should be able to be rescheduled
Retry 1 • Initial Attempt |
3.03% (6)6 / 198 runsfailed over last 7 days |
14.14% (28)28 / 198 runsflaked over last 7 days |
📄 apps/web/playwright/event-types.e2e.ts • 2 Flakes
Top 1 Common Error Messages
|
|
2 Test Cases Affected |
Test Case Results
| Test Case | Last 7 days Failures | Last 7 days Flakes |
|---|---|---|
|
Event Types tests -- legacy user Different Locations Tests Can remove location from multiple locations that are saved
Retry 2 • Retry 1 • Initial Attempt |
3.72% (8)8 / 215 runsfailed over last 7 days |
19.53% (42)42 / 215 runsflaked over last 7 days |
|
Event Types tests -- legacy user Different Locations Tests can add single organizer address location without display location public option
Retry 1 • Initial Attempt |
0% (0)0 / 216 runsfailed over last 7 days |
5.09% (11)11 / 216 runsflaked over last 7 days |
📄 apps/web/playwright/teams.e2e.ts • 1 Flake
Test Case Results
| Test Case | Last 7 days Failures | Last 7 days Flakes |
|---|---|---|
|
Teams - NonOrg -- legacy Can create a booking for Round Robin EventType
Retry 1 • Initial Attempt |
7.11% (16)16 / 225 runsfailed over last 7 days |
28.89% (65)65 / 225 runsflaked over last 7 days |
📄 apps/web/playwright/team/team-invitation.e2e.ts • 1 Flake
Test Case Results
| Test Case | Last 7 days Failures | Last 7 days Flakes |
|---|---|---|
|
Team Invitation (verified)
Retry 2 • Retry 1 • Initial Attempt |
3.49% (8)8 / 229 runsfailed over last 7 days |
6.99% (16)16 / 229 runsflaked over last 7 days |
📄 packages/embeds/embed-core/playwright/tests/namespacing.e2e.ts • 4 Flakes
Top 1 Common Error Messages
|
|
4 Test Cases Affected |
Test Case Results
| Test Case | Last 7 days Failures | Last 7 days Flakes |
|---|---|---|
|
Namespacing Inline Embed Add inline embed using a namespace without reload
Retry 1 • Initial Attempt |
0.47% (1)1 / 213 runfailed over last 7 days |
60.56% (129)129 / 213 runsflaked over last 7 days |
|
Namespacing Inline Embed Double install Embed Snippet with inline embed using a namespace
Retry 1 • Initial Attempt |
0.47% (1)1 / 213 runfailed over last 7 days |
59.62% (127)127 / 213 runsflaked over last 7 days |
|
Namespacing Inline Embed Double install Embed Snippet with inline embed without a namespace(i.e. default namespace)
Retry 1 • Initial Attempt |
0% (0)0 / 213 runsfailed over last 7 days |
63.38% (135)135 / 213 runsflaked over last 7 days |
|
Namespacing Different namespaces can have different init configs
Retry 1 • Initial Attempt |
0% (0)0 / 211 runsfailed over last 7 days |
60.19% (127)127 / 211 runsflaked over last 7 days |
📄 apps/web/playwright/profile.e2e.ts • 1 Flake
Test Case Results
| Test Case | Last 7 days Failures | Last 7 days Flakes |
|---|---|---|
|
Update Profile Newly added secondary email should show as Unverified
Retry 1 • Initial Attempt |
2.06% (5)5 / 243 runsfailed over last 7 days |
26.75% (65)65 / 243 runsflaked over last 7 days |
📄 packages/app-store/routing-forms/playwright/tests/basic.e2e.ts • 1 Flake
Test Case Results
| Test Case | Last 7 days Failures | Last 7 days Flakes |
|---|---|---|
|
Routing Forms Seeded Routing Form Router URL should work
Retry 1 • Initial Attempt |
0.47% (1)1 / 215 runfailed over last 7 days |
15.35% (33)33 / 215 runsflaked over last 7 days |
📄 apps/web/playwright/organization/booking.e2e.ts • 1 Flake
Test Case Results
| Test Case | Last 7 days Failures | Last 7 days Flakes |
|---|---|---|
|
Bookings Team Event Can create a booking for Round Robin EventType
Retry 1 • Initial Attempt |
8.11% (18)18 / 222 runsfailed over last 7 days |
26.58% (59)59 / 222 runsflaked over last 7 days |
sean-brydon
reviewed
May 7, 2024
| @@ -38,6 +47,93 @@ const getIPAddress = async (url: string): Promise<string> => { | |||
| }); | |||
| }; | |||
|
|
|||
| const checkUserIsAdmin = ( | |||
There was a problem hiding this comment.
Can we rename this to something a bit more descriptive - In my eyes checkUserISAdmin would just return a true or false but this is doing a bit more than just checking if a user is admin as it throws also
Suggested change
| const checkUserIsAdmin = ( | |
| const checkUserIsAdminOrThrow = ( |
Comment on lines
96
to
98
| const publishedTeams = teams.filter((team) => !!team.team.slug); | ||
| if (!isAdmin && publishedTeams.length < ORG_MINIMUM_PUBLISHED_TEAMS_SELF_SERVE) { | ||
| throw new TRPCError({ code: "FORBIDDEN", message: "You need to have atleast two published teams." }); |
There was a problem hiding this comment.
Lets make this a little easier to figure out whats going on
Suggested change
| const publishedTeams = teams.filter((team) => !!team.team.slug); | |
| if (!isAdmin && publishedTeams.length < ORG_MINIMUM_PUBLISHED_TEAMS_SELF_SERVE) { | |
| throw new TRPCError({ code: "FORBIDDEN", message: "You need to have atleast two published teams." }); | |
| if(isAdmin) return; | |
| const publishedTeams = teams.filter((team) => !!team.team.slug); | |
| if (publishedTeams.length < ORG_MINIMUM_PUBLISHED_TEAMS_SELF_SERVE) { | |
| throw new TRPCError({ code: "FORBIDDEN", message: "You need to have atleast two published teams." }); |
There was a problem hiding this comment.
Agreed, this is actually much much better
packages/trpc/server/routers/viewer/organizations/create.handler.ts
Outdated
Show resolved
Hide resolved
Comment on lines
337
to
357
| !orgData.isPlatform && | ||
| (await sendEmailVerification({ | ||
| email: orgOwnerEmail, | ||
| language: userLocale, | ||
| username: ownerProfile.username || "", | ||
| })); | ||
|
|
||
| const user = await sendEmailAndEnrichProfile({ | ||
| org: { | ||
| owner: organizationOwner, | ||
| id: organization.id, | ||
| name: organization.name, | ||
| ownerEmail: orgOwnerEmail, | ||
| }, | ||
| slug: orgData.slug, | ||
| userName: userName, | ||
| ownerProfileUsername: ownerProfile.username, | ||
| nonOrgUsernameForOwner: null, | ||
| inputLanguageTranslation: translation, | ||
| isPlatform: orgData.isPlatform, | ||
| }); |
There was a problem hiding this comment.
not a fan of using isPlatform here and also inside of sendEmailAndEnrichProfile passed as a parameter, we should try to extract those functions and call them directly in the createOrgUser/Platform functions
Comment on lines
418
to
441
| return !orgOwner | ||
| ? persistOrganizationWithNonExistentOwner({ | ||
| orgData: orgData, | ||
| orgOwner: orgOwner, | ||
| orgOwnerEmail: orgOwnerEmail, | ||
| userLocale: userLocale, | ||
| userName: userName, | ||
| translation: inputLanguageTranslation, | ||
| }) | ||
| : persistOrganizationWithExistingUserAsOwner({ | ||
| orgData: orgData, | ||
| orgOwner: orgOwner, | ||
| orgOwnerEmail: orgOwnerEmail, | ||
| userName: userName, | ||
| existingOwnerDetails: { | ||
| ownerId: orgOwner.id, | ||
| orgId: orgId, | ||
| ownerUsername: orgOwner.username, | ||
| }, | ||
| translation: inputLanguageTranslation, | ||
| loggedInUserId: loggedInUser.id, | ||
| availability: availability, | ||
| }); | ||
| }; |
There was a problem hiding this comment.
Suggested change
| return !orgOwner | |
| ? persistOrganizationWithNonExistentOwner({ | |
| orgData: orgData, | |
| orgOwner: orgOwner, | |
| orgOwnerEmail: orgOwnerEmail, | |
| userLocale: userLocale, | |
| userName: userName, | |
| translation: inputLanguageTranslation, | |
| }) | |
| : persistOrganizationWithExistingUserAsOwner({ | |
| orgData: orgData, | |
| orgOwner: orgOwner, | |
| orgOwnerEmail: orgOwnerEmail, | |
| userName: userName, | |
| existingOwnerDetails: { | |
| ownerId: orgOwner.id, | |
| orgId: orgId, | |
| ownerUsername: orgOwner.username, | |
| }, | |
| translation: inputLanguageTranslation, | |
| loggedInUserId: loggedInUser.id, | |
| availability: availability, | |
| }); | |
| }; | |
| const persistParams = { | |
| orgData: orgData, | |
| orgOwner: orgOwner, | |
| orgOwnerEmail: orgOwnerEmail, | |
| userName: userName, | |
| existingOwnerDetails: { | |
| ownerId: orgOwner.id, | |
| orgId: orgId, | |
| ownerUsername: orgOwner.username, | |
| }, | |
| translation: inputLanguageTranslation, | |
| loggedInUserId: loggedInUser.id, | |
| availability: availability, | |
| }; | |
| return !orgOwner | |
| ? persistOrganizationWithNonExistentOwner(persistParams) | |
| : persistOrganizationWithExistingUserAsOwner(persistParams); |
Comment on lines
511
to
537
| const user = isPlatform | ||
| ? await createPlatformUser({ | ||
| userId: ctx.user.id, | ||
| name: name, | ||
| slug: slug, | ||
| orgOwnerEmail: orgOwnerEmail, | ||
| seats: seats, | ||
| pricePerSeat: pricePerSeat, | ||
| isPlatform: isPlatform, | ||
| inputLanguageTranslation: inputLanguageTranslation, | ||
| availability: availability, | ||
| autoAcceptEmail: autoAcceptEmail, | ||
| ctx: { userLocale: ctx.user.locale, userName: ctx.user.name, orgId: ctx.user.profile.organizationId }, | ||
| }) | ||
| : await createOrgUser({ | ||
| userId: ctx.user.id, | ||
| name: name, | ||
| slug: slug, | ||
| orgOwnerEmail: orgOwnerEmail, | ||
| seats: seats, | ||
| pricePerSeat: pricePerSeat, | ||
| isPlatform: isPlatform, | ||
| inputLanguageTranslation: inputLanguageTranslation, | ||
| availability: availability, | ||
| autoAcceptEmail: autoAcceptEmail, | ||
| ctx: { userLocale: ctx.user.locale, userName: ctx.user.name, orgId: ctx.user.profile.organizationId }, | ||
| }); |
There was a problem hiding this comment.
Suggested change
| const user = isPlatform | |
| ? await createPlatformUser({ | |
| userId: ctx.user.id, | |
| name: name, | |
| slug: slug, | |
| orgOwnerEmail: orgOwnerEmail, | |
| seats: seats, | |
| pricePerSeat: pricePerSeat, | |
| isPlatform: isPlatform, | |
| inputLanguageTranslation: inputLanguageTranslation, | |
| availability: availability, | |
| autoAcceptEmail: autoAcceptEmail, | |
| ctx: { userLocale: ctx.user.locale, userName: ctx.user.name, orgId: ctx.user.profile.organizationId }, | |
| }) | |
| : await createOrgUser({ | |
| userId: ctx.user.id, | |
| name: name, | |
| slug: slug, | |
| orgOwnerEmail: orgOwnerEmail, | |
| seats: seats, | |
| pricePerSeat: pricePerSeat, | |
| isPlatform: isPlatform, | |
| inputLanguageTranslation: inputLanguageTranslation, | |
| availability: availability, | |
| autoAcceptEmail: autoAcceptEmail, | |
| ctx: { userLocale: ctx.user.locale, userName: ctx.user.name, orgId: ctx.user.profile.organizationId }, | |
| }); | |
| const createUserParams = { | |
| userId: ctx.user.id, | |
| name: name, | |
| slug: slug, | |
| orgOwnerEmail: orgOwnerEmail, | |
| seats: seats, | |
| pricePerSeat: pricePerSeat, | |
| isPlatform: isPlatform, | |
| inputLanguageTranslation: inputLanguageTranslation, | |
| availability: availability, | |
| autoAcceptEmail: autoAcceptEmail, | |
| ctx: { userLocale: ctx.user.locale, userName: ctx.user.name, orgId: ctx.user.profile.organizationId }, | |
| } | |
| const user = isPlatform | |
| ? await createPlatformUser(createUserParams) | |
| : await createOrgUser(createUserParams); |
| userName, | ||
| translation, | ||
| }: PersistOrganizationWithNonExistentOwnerProps) => { | ||
| let organizationOwner = orgOwner; |
There was a problem hiding this comment.
not sure to understand why we need to do this, organizationOwner is fully replaced with data.orgOwner,
the orgOwner passed as a param of this function does not seem to be used at all really
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR refactors the create handler that we use for organizations. We use the same handler in order to create a platform user as well, thats why now we have two different handlers, one that handles the creation of a platform user i.e.
createPlatformUserand the other one that handles the creation of an org user i.e.createOrgUser. I've tried to split everything else in smaller and more meaningful functions for better readability and understanding of what piece does what.