Improve error handling for user lookup by email (#1766)

Part of OPS-3009.

Author: cezudas

packages/server/api/src/app/authentication/new-user/organization-assignment.ts

@@ -17,9 +17,9 @@ export async function assignDefaultOrganization(
 ): Promise<UserWithOrganization> {
   let organization = await organizationService.getOldestOrganization();
 
-  const adminUser = await userService.getUserByEmailOrFail({
-    email: system.getOrThrow(AppSystemProp.OPENOPS_ADMIN_EMAIL),
-  });
+  const adminUser = await userService.getUserByEmailOrThrow(
+    system.getOrThrow(AppSystemProp.OPENOPS_ADMIN_EMAIL),
+  );
 
   organization = !isNil(adminUser.organizationId)
     ? await organizationService.getOne(adminUser.organizationId)

packages/server/api/src/app/openops-tables/auth-admin-tables.ts

@@ -23,7 +23,7 @@ export async function authenticateAdminUserInOpenOpsTables(
 
   if (!tokens) {
     const email = system.getOrThrow(AppSystemProp.OPENOPS_ADMIN_EMAIL);
-    const user = await userService.getUserByEmailOrFail({ email });
+    const user = await userService.getUserByEmailOrThrow(email);
 
     tokens = await authenticateUserInOpenOpsTables(
       email,

packages/server/api/src/app/user/user-service.ts

@@ -160,8 +160,18 @@ export const userService = {
       .execute();
   },
 
-  async getUserByEmailOrFail({ email }: { email: string }): Promise<User> {
-    return userRepo().findOneByOrFail({ email });
+  async getUserByEmailOrThrow(email: string): Promise<User> {
+    const user = await userRepo().findOneBy({ email });
+    if (isNil(user)) {
+      throw new ApplicationError({
+        code: ErrorCode.ENTITY_NOT_FOUND,
+        params: {
+          entityType: 'user',
+          entityId: email,
+        },
+      });
+    }
+    return user;
   },
 
   async getUsersByEmail({ email }: { email: string }): Promise<User[]> {

packages/server/api/test/unit/openops-tables/auth-admin-tables.test.ts

@@ -18,10 +18,10 @@ jest.mock('@openops/server-shared', () => ({
   },
 }));
 
-const getUserByEmailOrFailMock = jest.fn().mockResolvedValue({});
+const getUserByEmailOrThrowMock = jest.fn().mockResolvedValue({});
 jest.mock('../../../src/app/user/user-service', () => ({
   userService: {
-    getUserByEmailOrFail: getUserByEmailOrFailMock,
+    getUserByEmailOrThrow: getUserByEmailOrThrowMock,
   },
 }));
 
@@ -41,7 +41,7 @@ describe('Authenticate admin user in OpenOps Tables', () => {
       password: 'secret',
     };
 
-    getUserByEmailOrFailMock.mockResolvedValue(user);
+    getUserByEmailOrThrowMock.mockResolvedValue(user);
   });
 
   it('returns cached tokens when available', async () => {