feat(backend): allow tenant id to be specified during tenant creation

localenv/cloud-ten-wallet/seed.yml

@@ -97,3 +97,4 @@ tenants:
     idpSecret: 'ue3ixgIiWLIlWOd4w5KO78scYpFH+vHuCJ33lnjgzEg='
     walletAddressPrefix: 'https://cloud-nine-wallet-backend/cloud-ten'
     webhookUrl: 'http://cloud-ten-wallet/webhooks'
+    id: 'bc293b79-8609-47bd-b914-6438b470aff8'

packages/backend/src/graphql/resolvers/tenant.test.ts

@@ -21,6 +21,8 @@ import { truncateTables } from '../../tests/tableManager'
 import { ApolloClient } from '@apollo/client'
 import { GraphQLErrorCode } from '../errors'
 import { Tenant as TenantModel } from '../../tenants/model'
+import { v4 } from 'uuid'
+import { errorToMessage, TenantError } from '../../tenants/errors'
 
 describe('Tenant Resolvers', (): void => {
   let deps: IocContract<AppServices>
@@ -256,6 +258,77 @@ describe('Tenant Resolvers', (): void => {
         })
       })
 
+      test('can create a tenant with specific id', async (): Promise<void> => {
+        const inputId = v4()
+        const input = { ...generateTenantInput(), id: inputId }
+
+        const mutation = await appContainer.apolloClient
+          .mutate({
+            mutation: gql`
+              mutation CreateTenant($input: CreateTenantInput!) {
+                createTenant(input: $input) {
+                  tenant {
+                    id
+                    email
+                    apiSecret
+                    idpConsentUrl
+                    idpSecret
+                    publicName
+                  }
+                }
+              }
+            `,
+            variables: {
+              input
+            }
+          })
+          .then((query): TenantMutationResponse => query.data?.createTenant)
+
+        expect(mutation.tenant).toEqual({
+          ...input,
+          __typename: 'Tenant'
+        })
+      })
+
+      test('cannot create tenant with invalid uuid specified', async (): Promise<void> => {
+        expect.assertions(2)
+        try {
+          const input = { ...generateTenantInput(), id: 'invalid-id-format' }
+
+          await appContainer.apolloClient
+            .mutate({
+              mutation: gql`
+                mutation CreateTenant($input: CreateTenantInput!) {
+                  createTenant(input: $input) {
+                    tenant {
+                      id
+                      email
+                      apiSecret
+                      idpConsentUrl
+                      idpSecret
+                      publicName
+                    }
+                  }
+                }
+              `,
+              variables: {
+                input
+              }
+            })
+            .then((query): TenantMutationResponse => query.data?.createTenant)
+        } catch (error) {
+          expect(error).toBeInstanceOf(ApolloError)
+          expect((error as ApolloError).graphQLErrors).toContainEqual(
+            expect.objectContaining({
+              message: errorToMessage[TenantError.InvalidTenantId],
+              extensions: expect.objectContaining({
+                code: GraphQLErrorCode.BadUserInput
+              })
+            })
+          )
+        }
+      })
+
       test('cannot create tenant as non-operator', async (): Promise<void> => {
         const input = generateTenantInput()
         const tenant = await createTenant(deps)

packages/backend/src/graphql/resolvers/tenant.ts

@@ -11,6 +11,7 @@ import { Tenant } from '../../tenants/model'
 import { Pagination, SortOrder } from '../../shared/baseModel'
 import { getPageInfo } from '../../shared/pagination'
 import { tenantSettingsToGraphql } from './tenant_settings'
+import { errorToMessage, isTenantError } from '../../tenants/errors'
 
 export const whoami: QueryResolvers<TenantedApolloContext>['whoami'] = async (
   parent,
@@ -102,9 +103,16 @@ export const createTenant: MutationResolvers<TenantedApolloContext>['createTenan
     }
 
     const tenantService = await ctx.container.use('tenantService')
-    const tenant = await tenantService.create(args.input)
+    const tenantOrError = await tenantService.create(args.input)
+    if (isTenantError(tenantOrError)) {
+      throw new GraphQLError(errorToMessage[tenantOrError], {
+        extensions: {
+          code: GraphQLErrorCode.BadUserInput
+        }
+      })
+    }
 
-    return { tenant: tenantToGraphQl(tenant) }
+    return { tenant: tenantToGraphQl(tenantOrError) }
   }
 
 export const updateTenant: MutationResolvers<TenantedApolloContext>['updateTenant'] =

packages/backend/src/graphql/schema.graphql

@@ -1619,6 +1619,8 @@ type TenantSetting {
 }
 
 input CreateTenantInput {
+  "Unique identifier of the tenant. Must be compliant with uuid v4. Will be generated automatically if not provided."
+  id: ID
   "Contact email of the tenant owner."
   email: String
   "Secret used to secure requests made for this tenant."

packages/backend/src/tenants/errors.ts

@@ -1,5 +1,6 @@
 export enum TenantError {
-  TenantNotFound = 'TenantNotFound'
+  TenantNotFound = 'TenantNotFound',
+  InvalidTenantId = 'InvalidTenantId'
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
@@ -9,5 +10,6 @@ export const isTenantError = (o: any): o is TenantError =>
 export const errorToMessage: {
   [key in TenantError]: string
 } = {
-  [TenantError.TenantNotFound]: 'Tenant not found'
+  [TenantError.TenantNotFound]: 'Tenant not found',
+  [TenantError.InvalidTenantId]: 'Invalid Tenant ID'
 }

packages/backend/src/tenants/service.test.ts

@@ -18,6 +18,7 @@ import { withConfigOverride } from '../tests/helpers'
 import { TenantSetting, TenantSettingKeys } from './settings/model'
 import { TenantSettingService } from './settings/service'
 import { isTenantError, TenantError } from './errors'
+import { v4 } from 'uuid'
 
 describe('Tenant Service', (): void => {
   let deps: IocContract<AppServices>
@@ -128,7 +129,7 @@ describe('Tenant Service', (): void => {
         .mockImplementationOnce(async () => undefined)
 
       const tenant = await tenantService.create(createOptions)
-
+      assert(!isTenantError(tenant))
       expect(tenant).toEqual(expect.objectContaining(createOptions))
 
       expect(spy).toHaveBeenCalledWith(
@@ -167,6 +168,7 @@ describe('Tenant Service', (): void => {
         .mockImplementationOnce(async () => undefined)
 
       const tenant = await tenantService.create(createOptions)
+      assert(!isTenantError(tenant))
       const tenantSetting = await TenantSetting.query()
         .where('tenantId', tenant.id)
         .andWhere('key', TenantSettingKeys.WALLET_ADDRESS_URL.name)
@@ -175,6 +177,26 @@ describe('Tenant Service', (): void => {
       expect(tenantSetting[0].value).toEqual(walletAddressUrl)
     })
 
+    test('can create tenant with a specified id', async (): Promise<void> => {
+      const inputId = v4()
+      const createOptions = {
+        id: inputId,
+        apiSecret: 'test-api-secret',
+        publicName: 'test tenant',
+        email: faker.internet.email(),
+        idpConsentUrl: faker.internet.url(),
+        idpSecret: 'test-idp-secret'
+      }
+
+      jest
+        .spyOn(authServiceClient.tenant, 'create')
+        .mockImplementationOnce(async () => undefined)
+
+      const tenant = await tenantService.create(createOptions)
+      assert(!isTenantError(tenant))
+      expect(tenant.id).toEqual(inputId)
+    })
+
     test('tenant creation rolls back if auth tenant create fails', async (): Promise<void> => {
       const createOptions = {
         apiSecret: 'test-api-secret',
@@ -226,6 +248,7 @@ describe('Tenant Service', (): void => {
         .mockImplementationOnce(async () => undefined)
 
       const tenant = await tenantService.create(originalTenantInfo)
+      assert(!isTenantError(tenant))
 
       const updatedTenantInfo = {
         id: tenant.id,
@@ -262,6 +285,7 @@ describe('Tenant Service', (): void => {
         .mockImplementationOnce(async () => undefined)
 
       const tenant = await tenantService.create(originalTenantInfo)
+      assert(!isTenantError(tenant))
       const updatedTenantInfo = {
         id: tenant.id,
         apiSecret: 'test-api-secret-two',
@@ -338,6 +362,7 @@ describe('Tenant Service', (): void => {
         .spyOn(authServiceClient.tenant, 'create')
         .mockImplementationOnce(async () => undefined)
       const tenant = await tenantService.create(createOptions)
+      assert(!isTenantError(tenant))
 
       const spy = jest
         .spyOn(authServiceClient.tenant, 'delete')
@@ -370,6 +395,7 @@ describe('Tenant Service', (): void => {
         .spyOn(authServiceClient.tenant, 'create')
         .mockImplementationOnce(async () => undefined)
       const tenant = await tenantService.create(createOptions)
+      assert(!isTenantError(tenant))
 
       const spy = jest
         .spyOn(authServiceClient.tenant, 'delete')
@@ -420,6 +446,7 @@ describe('Tenant Service', (): void => {
 
             const spyCacheSet = jest.spyOn(tenantCache, 'set')
             const tenant = await tenantService.create(createOptions)
+            assert(!isTenantError(tenant))
             expect(tenant).toMatchObject({
               ...createOptions,
               id: tenant.id

packages/backend/src/tenants/service.ts

@@ -1,3 +1,4 @@
+import { validate as validateUuid } from 'uuid'
 import { Tenant } from './model'
 import { BaseService } from '../shared/baseService'
 import { TransactionOrKnex } from 'objection'
@@ -7,12 +8,12 @@ import type { AuthServiceClient } from '../auth-service-client/client'
 import { TenantSettingService } from './settings/service'
 import { TenantSetting } from './settings/model'
 import type { IAppConfig } from '../config/app'
-import { TenantError } from './errors'
+import { isTenantError, TenantError } from './errors'
 import { TenantSettingInput } from '../graphql/generated/graphql'
 
 export interface TenantService {
   get: (id: string, includeDeleted?: boolean) => Promise<Tenant | undefined>
-  create: (options: CreateTenantOptions) => Promise<Tenant>
+  create: (options: CreateTenantOptions) => Promise<Tenant | TenantError>
   update: (options: UpdateTenantOptions) => Promise<Tenant>
   delete: (id: string) => Promise<void>
   getPage: (pagination?: Pagination, sortOrder?: SortOrder) => Promise<Tenant[]>
@@ -75,6 +76,7 @@ async function getTenantPage(
 }
 
 interface CreateTenantOptions {
+  id?: string
   email?: string
   apiSecret: string
   idpSecret?: string
@@ -86,12 +88,23 @@ interface CreateTenantOptions {
 async function createTenant(
   deps: ServiceDependencies,
   options: CreateTenantOptions
-): Promise<Tenant> {
+): Promise<Tenant | TenantError> {
   const trx = await deps.knex.transaction()
   try {
-    const { email, apiSecret, publicName, idpSecret, idpConsentUrl, settings } =
-      options
+    const {
+      id,
+      email,
+      apiSecret,
+      publicName,
+      idpSecret,
+      idpConsentUrl,
+      settings
+    } = options
+    if (id && !validateUuid(id)) {
+      throw TenantError.InvalidTenantId
+    }
     const tenant = await Tenant.query(trx).insertAndFetch({
+      id,
       email,
       publicName,
       apiSecret,
@@ -125,6 +138,7 @@ async function createTenant(
     return tenant
   } catch (err) {
     await trx.rollback()
+    if (isTenantError(err)) return err
     throw err
   }
 }

packages/backend/src/tenants/settings/service.test.ts

@@ -21,6 +21,7 @@ import { AuthServiceClient } from '../../auth-service-client/client'
 import { v4 as uuid } from 'uuid'
 import { createTenant } from '../../tests/tenant'
 import { isTenantSettingError, TenantSettingError } from './errors'
+import { isTenantError } from '../errors'
 
 describe('TenantSetting Service', (): void => {
   let deps: IocContract<AppServices>
@@ -50,12 +51,14 @@ describe('TenantSetting Service', (): void => {
       .spyOn(authServiceClient.tenant, 'delete')
       .mockResolvedValueOnce(undefined)
 
-    tenant = await tenantService.create({
+    const tenantOrError = await tenantService.create({
       apiSecret: faker.string.uuid(),
       email: faker.internet.email(),
       idpConsentUrl: faker.internet.url(),
       idpSecret: faker.string.uuid()
     })
+    assert(!isTenantError(tenantOrError))
+    tenant = tenantOrError
   })
 
   afterEach(async (): Promise<void> => {

packages/backend/src/tests/tenant.ts

@@ -11,6 +11,7 @@ import {
 } from '@apollo/client'
 import { setContext } from '@apollo/client/link/context'
 import { TestContainer } from './app'
+import { isTenantError } from '../tenants/errors'
 
 interface CreateOptions {
   email: string
@@ -75,7 +76,7 @@ export async function createTenant(
   jest
     .spyOn(authServiceClient.tenant, 'create')
     .mockImplementationOnce(async () => undefined)
-  const tenant = await tenantService.create(
+  const tenantOrError = await tenantService.create(
     options || {
       email: faker.internet.email(),
       apiSecret: 'test-api-secret',
@@ -85,9 +86,9 @@ export async function createTenant(
     }
   )
 
-  if (!tenant) {
+  if (!tenantOrError || isTenantError(tenantOrError)) {
     throw Error('Failed to create test tenant')
   }
 
-  return tenant
+  return tenantOrError
 }