feat(e2e): Add ensureBapiUserExists method (#5647)

Author: dstaley

integration/testUtils/usersService.ts

@@ -53,6 +53,10 @@ export type FakeOrganization = {
 export type UserService = {
   createFakeUser: (options?: FakeUserOptions) => FakeUser;
   createBapiUser: (fakeUser: FakeUser) => Promise<User>;
+  /**
+   * Creates a BAPI user if it doesn't exist, otherwise returns the existing user.
+   */
+  getOrCreateUser: (fakeUser: FakeUser) => Promise<User>;
   deleteIfExists: (opts: { id?: string; email?: string }) => Promise<void>;
   createFakeOrganization: (userId: string) => Promise<FakeOrganization>;
   getUser: (opts: { id?: string; email?: string }) => Promise<User | undefined>;
@@ -102,6 +106,13 @@ export const createUserService = (clerkClient: ClerkClient) => {
         skipPasswordRequirement: fakeUser.password === undefined,
       });
     },
+    getOrCreateUser: async fakeUser => {
+      const existingUser = await self.getUser({ email: fakeUser.email });
+      if (existingUser) {
+        return existingUser;
+      }
+      return await self.createBapiUser(fakeUser);
+    },
     deleteIfExists: async (opts: { id?: string; email?: string }) => {
       let id = opts.id;
 

integration/tests/oauth-flows.test.ts

@@ -117,11 +117,9 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })('oauth flo
   test('sign in modal to sign up modal to transfer respects original forceRedirectUrl', async ({ page, context }) => {
     const u = createTestUtils({ app, page, context });
 
-    try {
-      await u.services.users.createBapiUser(fakeUser);
-    } catch {
-      // User already exists, so we don't need to create it
-    }
+    // The user already exists on the OAuth provider instance, but we want to make sure that the user is created on the
+    // app instance as well so that their sign up is transferred to a sign in.
+    await u.services.users.getOrCreateUser(fakeUser);
 
     await u.page.goToRelative('/buttons');
     await u.page.waitForClerkJsLoaded();