feat(frontend): tenant settings fields for tenant create (#3572)

* feat(frontend): tenant settings fields for tenant create

* fix: tests

* fix: surface form errors for tenant settings

* fix: typings & generated files causing build errors

Author: njlie

localenv/mock-account-servicing-entity/generated/graphql.ts

@@ -7,7 +7,8 @@ import { truncateTables } from '../../tests/tableManager'
 import { createTenant } from '../../tests/tenant'
 import {
   CreateTenantSettingsInput,
-  CreateTenantSettingsMutationResponse
+  CreateTenantSettingsMutationResponse,
+  TenantSettingKey as SchemaTenantSettingKey
 } from '../generated/graphql'
 import {
   ApolloClient,
@@ -101,7 +102,7 @@ describe('Tenant Settings Resolvers', (): void => {
       const input: CreateTenantSettingsInput = {
         settings: [
           {
-            key: TenantSettingKeys.EXCHANGE_RATES_URL.name,
+            key: SchemaTenantSettingKey.ExchangeRatesUrl,
             value: faker.internet.url()
           }
         ]
@@ -137,7 +138,7 @@ describe('Tenant Settings Resolvers', (): void => {
       const input: CreateTenantSettingsInput = {
         settings: [
           {
-            key: TenantSettingKeys.WEBHOOK_MAX_RETRY.name,
+            key: SchemaTenantSettingKey.WebhookMaxRetry,
             value: '-1'
           }
         ]

packages/backend/src/graphql/generated/graphql.schema.json

@@ -5,12 +5,13 @@ import {
   errorToCode,
   errorToMessage
 } from '../../tenants/settings/errors'
-import { TenantSetting } from '../../tenants/settings/model'
+import { TenantSetting, TenantSettingKeys } from '../../tenants/settings/model'
 import {
   ResolversTypes,
   TenantResolvers,
   TenantSetting as SchemaTenantSetting,
-  MutationResolvers
+  MutationResolvers,
+  TenantSettingKey as SchemaTenantSettingKey
 } from '../generated/graphql'
 
 export const getTenantSettings: TenantResolvers<TenantedApolloContext>['settings'] =
@@ -56,10 +57,23 @@ export const createTenantSettings: MutationResolvers<TenantedApolloContext>['cre
     }
   }
 
+const tenantSettingNameToGraphQl: { [key: string]: SchemaTenantSettingKey } = {
+  [TenantSettingKeys.EXCHANGE_RATES_URL.name]:
+    SchemaTenantSettingKey.ExchangeRatesUrl,
+  [TenantSettingKeys.WEBHOOK_URL.name]: SchemaTenantSettingKey.WebhookUrl,
+  [TenantSettingKeys.WEBHOOK_TIMEOUT.name]:
+    SchemaTenantSettingKey.WebhookTimeout,
+  [TenantSettingKeys.WEBHOOK_MAX_RETRY.name]:
+    SchemaTenantSettingKey.WebhookMaxRetry,
+  [TenantSettingKeys.WALLET_ADDRESS_URL.name]:
+    SchemaTenantSettingKey.WalletAddressUrl,
+  [TenantSettingKeys.ILP_ADDRESS.name]: SchemaTenantSettingKey.IlpAddress
+}
+
 const tenantSettingToGraphql = (
   tenantSetting: TenantSetting
 ): SchemaTenantSetting => ({
-  key: tenantSetting.key,
+  key: tenantSettingNameToGraphQl[tenantSetting.key],
   value: tenantSetting.value
 })
 

packages/backend/src/graphql/generated/graphql.ts

@@ -653,7 +653,7 @@ input CreateTenantSettingsInput {
 
 input TenantSettingInput {
   "Key for this setting."
-  key: String!
+  key: TenantSettingKey!
   "Value of a setting for this key."
   value: String!
 }
@@ -1611,9 +1611,18 @@ type TenantEdge {
   cursor: String!
 }
 
+enum TenantSettingKey {
+  EXCHANGE_RATES_URL
+  WEBHOOK_URL
+  WEBHOOK_TIMEOUT
+  WEBHOOK_MAX_RETRY
+  WALLET_ADDRESS_URL
+  ILP_ADDRESS
+}
+
 type TenantSetting {
   "Key for this setting."
-  key: String!
+  key: TenantSettingKey!
   "Value of a setting for this key."
   value: String!
 }

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

@@ -15,10 +15,11 @@ import { createTenant } from '../tests/tenant'
 import { CacheDataStore } from '../middleware/cache/data-stores'
 import { AuthServiceClient } from '../auth-service-client/client'
 import { withConfigOverride } from '../tests/helpers'
-import { TenantSetting, TenantSettingKeys } from './settings/model'
+import { TenantSetting } from './settings/model'
 import { TenantSettingService } from './settings/service'
 import { isTenantError, TenantError } from './errors'
 import { v4 } from 'uuid'
+import { TenantSettingKey as SchemaTenantSettingKey } from '../graphql/generated/graphql'
 
 describe('Tenant Service', (): void => {
   let deps: IocContract<AppServices>
@@ -157,7 +158,7 @@ describe('Tenant Service', (): void => {
         idpSecret: 'test-idp-secret',
         settings: [
           {
-            key: TenantSettingKeys.WALLET_ADDRESS_URL.name,
+            key: SchemaTenantSettingKey.WalletAddressUrl,
             value: walletAddressUrl
           }
         ]
@@ -171,7 +172,7 @@ describe('Tenant Service', (): void => {
       assert(!isTenantError(tenant))
       const tenantSetting = await TenantSetting.query()
         .where('tenantId', tenant.id)
-        .andWhere('key', TenantSettingKeys.WALLET_ADDRESS_URL.name)
+        .andWhere('key', SchemaTenantSettingKey.WalletAddressUrl)
 
       expect(tenantSetting.length).toBe(1)
       expect(tenantSetting[0].value).toEqual(walletAddressUrl)

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

@@ -118,7 +118,10 @@ async function createTenant(
       idpConsentUrl
     })
 
-    const createInitialTenantSettingsOptions = {
+    const createInitialTenantSettingsOptions: {
+      tenantId: string
+      setting: ReturnType<typeof TenantSetting.default>
+    } = {
       tenantId: tenant.id,
       setting: TenantSetting.default()
     }
@@ -130,11 +133,25 @@ async function createTenant(
 
     createInitialTenantSettingsOptions.setting.push(defaultIlpAddressSetting)
 
-    if (settings) {
+    if (
+      settings &&
+      !settings.find(
+        (setting) => setting.key === TenantSettingKeys.ILP_ADDRESS.name
+      )
+    ) {
       createInitialTenantSettingsOptions.setting =
         createInitialTenantSettingsOptions.setting.concat(settings)
+    } else if (settings) {
+      createInitialTenantSettingsOptions.setting = settings
     }
 
+    deps.logger.info(
+      {
+        createInitialTenantSettingsOptions
+      },
+      'initial options'
+    )
+
     await deps.tenantSettingService.create(createInitialTenantSettingsOptions, {
       trx
     })

packages/backend/src/graphql/schema.graphql

@@ -9,7 +9,11 @@ import { truncateTables } from '../../tests/tableManager'
 import { Tenant } from '../model'
 import { TenantService } from '../service'
 import { faker } from '@faker-js/faker'
-import { exchangeRatesSetting, randomSetting } from '../../tests/tenantSettings'
+import {
+  exchangeRatesSetting,
+  randomSetting,
+  createTenantSettings
+} from '../../tests/tenantSettings'
 import { TenantSetting, TenantSettingKeys } from './model'
 import {
   CreateOptions,
@@ -290,7 +294,7 @@ describe('TenantSetting Service', (): void => {
     async function createTenantSetting(): Promise<TenantSetting[]> {
       const options: CreateOptions = {
         tenantId: tenant.id,
-        setting: [randomSetting()]
+        setting: [exchangeRatesSetting()]
       }
 
       const createdTenantSetting = await tenantSettingService.create(options)
@@ -321,7 +325,15 @@ describe('TenantSetting Service', (): void => {
     })
 
     test('should get all tenant settings', async () => {
-      const newTenantSetting = await createTenantSetting()
+      const newTenantSetting = await createTenantSettings(deps, {
+        tenantId: tenant.id,
+        setting: [
+          {
+            key: TenantSettingKeys.WEBHOOK_URL.name,
+            value: faker.internet.url()
+          }
+        ]
+      })
       const dbTenantSettings = await tenantSettingService.get({
         tenantId: tenant.id
       })