feat: Create `UserCreationService` and use in API V1 create user endpoint #19150

joeauyeung · 2025-02-07T02:06:44Z

What does this PR do?

Introduces a UserCreationService
Uses the service in API v1 create new user endpoint

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected).
I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

Use v1 API to create a new user

Checklist

I haven't read the contributing guide
My code doesn't follow the style guidelines of this project
I haven't commented my code, particularly in hard-to-understand areas
I haven't checked if my changes generate no new warnings

…move business logic

vercel · 2025-02-07T02:10:40Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
cal-com-ui-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 10, 2025 4:21am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
cal	⬜️ Ignored (Inspect)	Visit Preview		Feb 10, 2025 4:21am
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview		Feb 10, 2025 4:21am

keithwillcode · 2025-02-07T10:56:32Z

packages/lib/server/service/userCreationService.ts

+  identityProvider?: IdentityProvider;
+}
+
+export class UserCreationService {


This is exactly what we are looking for with application services coordinating these calls. Very nice.

joeauyeung · 2025-02-07T02:10:13Z

packages/lib/server/repository/user.ts

-    const password = createHash("md5").update(`${email}${process.env.CALENDSO_ENCRYPTION_KEY}`).digest("hex");
-    const hashedPassword = await hashPassword(password);


Moving this business logic to the service

joeauyeung · 2025-02-07T02:10:33Z

packages/lib/server/repository/user.ts

    const t = await getTranslation("en", "common");
    const availability = getAvailabilityFromSchedule(DEFAULT_SCHEDULE);

    return await prisma.user.create({
      data: {
-        username: slugify(username),


Also moving this business logic to the service

joeauyeung · 2025-02-07T02:11:25Z

packages/lib/server/repository/user.ts

+      locked: boolean;
+    }
+  ) {
+    const organizationId = data.organizationId;


Need to get organizationId like this because typescript may see organizationId as a part of the ...rest below

joeauyeung · 2025-02-07T02:13:24Z

packages/lib/server/service/userCreationService.ts

+import slugify from "../../slugify";
+import { UserRepository } from "../repository/user";
+
+interface CreateUserInput {


For the service I don't want any dependence on Prisma so I'm declaring the input here. When calling the UserRepository the type is Prisma.UserCreateInput so it'll throw an type error if this input is misalligned with what Prisma expects.

joeauyeung · 2025-02-07T02:13:56Z

packages/lib/server/service/userCreationService.ts

+  static async createUser(data: CreateUserInput) {
+    const { email, password, username } = data;
+
+    const shouldLockByDefault = await checkIfEmailIsBlockedInWatchlistController(email);


Since we're introducing this service, we'll check the watchlist for any blocked emails/domains whenever we create a new user.

joeauyeung · 2025-02-09T02:51:55Z

packages/lib/server/service/userCreationService.ts

+    const { locked, ...rest } = user;
+
+    return rest;


We shouldn't return the locked status back to the user

joeauyeung · 2025-02-09T22:43:27Z

packages/lib/server/repository/organization.ts

@@ -90,6 +90,7 @@ export class OrganizationRepository {
      email: owner.email,
      username: ownerUsernameInOrg,
      organizationId: organization.id,
+      locked: false,


We'll check the new org owner against the watch list in this PR #19201

graphite-app · 2025-02-10T02:50:10Z

Graphite Automations

"Add consumer team as reviewer" took an action on this PR • (02/10/25)

1 reviewer was added to this PR based on Keith Williams's automation.

github-actions · 2025-02-10T04:38:45Z

E2E results are ready!

Workflow #46974.1 latest results

joeauyeung added 5 commits February 6, 2025 21:00

Create createUser method in userCreationService

a5fff6d

Refactor UserRepository create method to accept prisma input and re…

898377b

…move business logic

API use UserCreationService

a3a7583

Move slugify to service

852dad7

Use hashPassword instead

ec9bc6c

keithwillcode added consumer core area: core, team members only labels Feb 7, 2025

vercel bot had a problem deploying to Preview – api February 7, 2025 02:07 Failure

vercel bot deployed to Preview – cal-com-ui-playground February 7, 2025 02:10 View deployment

keithwillcode reviewed Feb 7, 2025

View reviewed changes

joeauyeung added 2 commits February 7, 2025 10:29

Type fixes in UserCreationService

d486212

Add userCreationService tests

f823030

vercel bot had a problem deploying to Preview – api February 7, 2025 15:44 Failure

vercel bot deployed to Preview – cal-com-ui-playground February 7, 2025 16:22 View deployment

vercel bot deployed to Preview – dev February 7, 2025 16:38 View deployment

joeauyeung added 3 commits February 7, 2025 16:05

API accept data object

01637f4

Type fixes

a888781

Add user _post test

4e0d12e

vercel bot had a problem deploying to Preview – api February 7, 2025 21:22 Failure

vercel bot deployed to Preview – cal-com-ui-playground February 7, 2025 21:24 View deployment

vercel bot deployed to Preview – dev February 7, 2025 21:34 View deployment

joeauyeung added 3 commits February 8, 2025 21:04

Add test for locked user

3e18a61

Add locked param to log

a679abf

Add user repository tests

cf319e9

vercel bot had a problem deploying to Preview – api February 9, 2025 02:17 Failure

vercel bot deployed to Preview – cal-com-ui-playground February 9, 2025 02:20 View deployment

vercel bot deployed to Preview – dev February 9, 2025 02:30 View deployment

joeauyeung added 2 commits February 8, 2025 21:39

Do not return locked status

4aa04d4

Explicitly pass locked prop

86200ec

Fix tests when locked isn't returned

ea94100

joeauyeung commented Feb 9, 2025

View reviewed changes

vercel bot had a problem deploying to Preview – api February 9, 2025 02:54 Failure

vercel bot deployed to Preview – cal-com-ui-playground February 9, 2025 02:57 View deployment

vercel bot deployed to Preview – dev February 9, 2025 03:07 View deployment

joeauyeung mentioned this pull request Feb 9, 2025

refactor: User UserCreationService in self serve admin creation #19200

Open

3 tasks

Fix tests

8e56c25

vercel bot had a problem deploying to Preview – api February 9, 2025 21:45 Failure

vercel bot deployed to Preview – cal-com-ui-playground February 9, 2025 21:48 View deployment

vercel bot deployed to Preview – dev February 9, 2025 21:57 View deployment

Pass locked prop

1eae797

joeauyeung commented Feb 9, 2025

View reviewed changes

vercel bot deployed to Preview – api February 9, 2025 22:49 View deployment

vercel bot deployed to Preview – cal-com-ui-playground February 9, 2025 22:56 View deployment

vercel bot deployed to Preview – dev February 9, 2025 23:12 View deployment

joeauyeung marked this pull request as ready for review February 10, 2025 02:46

joeauyeung requested a review from a team as a code owner February 10, 2025 02:46

graphite-app bot requested a review from a team February 10, 2025 02:47

joeauyeung added the ready-for-e2e label Feb 10, 2025

dosubot bot added api area: API, enterprise API, access token, OAuth ✨ feature New feature or request labels Feb 10, 2025

Edit test name

571ae02

vercel bot deployed to Preview – api February 10, 2025 04:20 View deployment

vercel bot deployed to Preview – cal-com-ui-playground February 10, 2025 04:21 View deployment

vercel bot deployed to Preview – dev February 10, 2025 04:34 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Create `UserCreationService` and use in API V1 create user endpoint #19150

feat: Create `UserCreationService` and use in API V1 create user endpoint #19150

joeauyeung commented Feb 7, 2025 •

edited

Loading

vercel bot commented Feb 7, 2025 •

edited

Loading

keithwillcode Feb 7, 2025

joeauyeung Feb 7, 2025

joeauyeung Feb 7, 2025

joeauyeung Feb 7, 2025

joeauyeung Feb 7, 2025

joeauyeung Feb 7, 2025

joeauyeung Feb 9, 2025

joeauyeung Feb 9, 2025

graphite-app bot commented Feb 10, 2025

github-actions bot commented Feb 10, 2025

		const password = createHash("md5").update(`${email}${process.env.CALENDSO_ENCRYPTION_KEY}`).digest("hex");
		const hashedPassword = await hashPassword(password);

feat: Create UserCreationService and use in API V1 create user endpoint #19150

Are you sure you want to change the base?

feat: Create UserCreationService and use in API V1 create user endpoint #19150

Conversation

joeauyeung commented Feb 7, 2025 • edited Loading

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

Checklist

vercel bot commented Feb 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

graphite-app bot commented Feb 10, 2025

Graphite Automations

github-actions bot commented Feb 10, 2025

E2E results are ready!

feat: Create `UserCreationService` and use in API V1 create user endpoint #19150

feat: Create `UserCreationService` and use in API V1 create user endpoint #19150

joeauyeung commented Feb 7, 2025 •

edited

Loading

vercel bot commented Feb 7, 2025 •

edited

Loading