feat(backend): tenanted assets #3206

mkurapov · 2025-01-08T20:47:34Z

Changes proposed in this pull request

Backfills existing assets with operator tenant id
Adds tenantId to asset model
Requires tenantId in aset delete, update, getPage methods (optional in get)
Adds separate tenant Admin API middleware for tests
Adds a config value to allow setting/creating custom knex/db schema

Checking the correct asset is used during wallet address creation will be done in #3114

Context

Fixes #3033

Checklist

Related issues linked using fixes #number
Tests added/updated
Make sure that all checks pass
Bruno collection updated (if necessary)
Documentation issue created with user-docs label (if necessary)
OpenAPI specs updated (if necessary)

netlify · 2025-01-08T20:47:53Z

✅ Deploy Preview for brilliant-pasca-3e80ec ready!

Name	Link
🔨 Latest commit	`2edea03`
🔍 Latest deploy log	https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/677ee469d03401000821f5dd
😎 Deploy Preview	https://deploy-preview-3206--brilliant-pasca-3e80ec.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mkurapov · 2025-01-08T20:55:08Z

packages/backend/src/tests/tableManager.ts

@@ -14,7 +14,8 @@ export async function truncateTables(
    'knex_migrations',
    'knex_migrations_lock',
    'knex_migrations_backend',
-    'knex_migrations_backend_lock'
+    'knex_migrations_backend_lock',
+    'tenants' // So we do not truncate the operator tenant


otherwise, we lose the operator tenant in the tenants table, and we can't insert any assets (leading to almost all tests to fail, basically).

mkurapov · 2025-01-09T22:32:43Z

packages/backend/src/app.ts

+    // For tests, we still need to get the tenant in the middleware, but
+    // we don't need to verify the signature nor prevent replay attacks
+    koa.use(
+      this.config.env !== 'test'
+        ? tenantSignatureMiddleware
+        : testTenantSignatureMiddleware
+    )


Basically, had an issue where the replay attack prevention via redis (ie canApiSignature function) was resulting a 401 Unauthorized error for many resolver tests (for cases where we call the same resolver back to back)

mkurapov · 2025-01-10T19:35:01Z

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

+        assetService.getPage({
+          pagination,
+          sortOrder,
+          tenantId: ctx.tenant.id


passing in tenant id

mkurapov · 2025-01-10T19:52:56Z

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

@@ -42,9 +43,13 @@ describe('Tenant Service', (): void => {
  let config: IAppConfig
  let apolloClient: ApolloClient<NormalizedCacheObject>
  let knex: Knex
+  const dbSchema = 'tenant_service_test_schema'


This allows us to have the tenant service tests run cleanly without dropping the tenants table other tests are using

In my PR, I have updated the truncateTables to not delete the tenant.
#3152

Same here. I also added a way to configure db schema, because for the tenant service tests, we do want to truncate the tenants table. But then of course, we break all of the other tests :) so I needed to isolate it somehow

I like that. I will merge yours into mine @mkurapov

koekiebox

Mostly looks good. Have a couple of queries regarding conflicting functionality.

koekiebox · 2025-01-13T14:55:32Z

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

+      getPage: (pagination: Pagination, sortOrder?: SortOrder) =>
+        assetService.getPage({
+          pagination,
+          sortOrder,


@mkurapov Will you have a look at what I said here:
#3152 (comment)

We may want to use that mechanism of being able to provide alternative tenantId for the operator?

Might even be worth allowing no tenant filtering if the requester is an operator

koekiebox · 2025-01-13T14:56:09Z

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

+    const asset = await assetService.getByCodeAndScale({
+      code: args.code,
+      scale: args.scale,
+      tenantId: ctx.tenant.id


Please also see:
#3152 (comment)

koekiebox · 2025-01-13T14:56:22Z

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

@@ -93,7 +105,8 @@ export const updateAsset: MutationResolvers<ApolloContext>['updateAsset'] =
    const assetOrError = await assetService.update({
      id: args.input.id,
      withdrawalThreshold: args.input.withdrawalThreshold ?? null,
-      liquidityThreshold: args.input.liquidityThreshold ?? null
+      liquidityThreshold: args.input.liquidityThreshold ?? null,


Please see: #3152 (comment)

koekiebox · 2025-01-13T14:56:44Z

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

@@ -168,6 +181,7 @@ export const deleteAsset: MutationResolvers<ApolloContext>['deleteAsset'] =
    const assetService = await ctx.container.use('assetService')
    const assetOrError = await assetService.delete({
      id: args.input.id,


Please see: #3152 (comment)

koekiebox · 2025-01-13T14:57:53Z

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

@@ -42,9 +43,13 @@ describe('Tenant Service', (): void => {
  let config: IAppConfig
  let apolloClient: ApolloClient<NormalizedCacheObject>
  let knex: Knex
+  const dbSchema = 'tenant_service_test_schema'


In my PR, I have updated the truncateTables to not delete the tenant.
#3152

# Conflicts: # packages/backend/src/app.ts # packages/backend/src/tenants/service.test.ts

mkurapov added 4 commits January 8, 2025 21:45

feat(backend): migration to backfill tenantId on assets

3827964

feat(backend): add tenantId to asset, use it in service

0ad9b69

feat(backend): use tenantId in asset resolvers

f47c6a0

test(backend): update tests to use asset tenantId where necessary

2edea03

mkurapov changed the base branch from main to 2893/multi-tenancy-v1 January 8, 2025 20:47

github-actions bot added type: tests Testing related pkg: backend Changes in the backend package. type: source Changes business logic labels Jan 8, 2025

test(backend): truncate tenant table manually in tenant tests

54434cb

mkurapov commented Jan 8, 2025

View reviewed changes

mkurapov force-pushed the 3033/mk/tenanted-assets branch from 8cfb09f to c2a2563 Compare January 8, 2025 22:23

test(backend): update failing accounting tests

54ef8b7

mkurapov force-pushed the 3033/mk/tenanted-assets branch from c2a2563 to 25f6248 Compare January 8, 2025 22:54

mkurapov added 2 commits January 9, 2025 14:53

test(backend): update tenant service test

4255595

test: fix accounting tests linting

5dce25b

mkurapov force-pushed the 3033/mk/tenanted-assets branch from 25f6248 to 5dce25b Compare January 9, 2025 13:53

test(backend): update accounting tests

5a31294

mkurapov force-pushed the 3033/mk/tenanted-assets branch from 7696f5e to 5a31294 Compare January 9, 2025 14:02

mkurapov added 2 commits January 9, 2025 23:29

feat(backend): use tenantId when fetching asset

8151328

test(backend): make tests work with separate middleware

5c507fd

mkurapov commented Jan 9, 2025

View reviewed changes

mkurapov force-pushed the 3033/mk/tenanted-assets branch from 6399d96 to b4ad6b7 Compare January 9, 2025 23:49

test(backend): keep operator tenant when truncating tables

557e78a

mkurapov force-pushed the 3033/mk/tenanted-assets branch from b4ad6b7 to 557e78a Compare January 9, 2025 23:50

mkurapov added 5 commits January 10, 2025 16:30

test(backend): skip tenant pagination tests for now

62be42b

test(backend): seed operator tenant in truncateTable

2ae9bd0

test(backend): seed operator tenant after tenants service is done

1b57e15

test(backend): use separate schema for tenant tests

c89d84e

test(backend): pass operator tenant id in pagination tests

5c38bf0

mkurapov added 2 commits January 10, 2025 18:16

feat(backend): make tenantId required in asset pagination

79422ed

test(backend): update tenant service tests

f3eadec

mkurapov force-pushed the 3033/mk/tenanted-assets branch from 6538887 to f3eadec Compare January 10, 2025 17:29

chore(backend): update config file

34a05c2

mkurapov force-pushed the 3033/mk/tenanted-assets branch from 51ea55e to 0fe4d19 Compare January 10, 2025 19:26

test: update truncateTables to take in dbSchema

d3fa2b2

mkurapov force-pushed the 3033/mk/tenanted-assets branch from 0fe4d19 to d3fa2b2 Compare January 10, 2025 19:28

mkurapov commented Jan 10, 2025

View reviewed changes

mkurapov marked this pull request as ready for review January 13, 2025 13:22

mkurapov requested review from njlie, koekiebox, BlairCurrey and oana-lolea January 13, 2025 13:23

oana-lolea approved these changes Jan 13, 2025

View reviewed changes

koekiebox requested changes Jan 13, 2025

View reviewed changes

mkurapov linked an issue Jan 13, 2025 that may be closed by this pull request

[Multi-Tenant] Tenanted Assets #3033

Closed

3 tasks

mkurapov added 2 commits January 14, 2025 11:03

feat(backend): make tenantId optional in asset pagination

bf85eb6

Merge branch '2893/multi-tenancy-v1' into 3033/mk/tenanted-assets

279a3d2

# Conflicts: # packages/backend/src/app.ts # packages/backend/src/tenants/service.test.ts

koekiebox approved these changes Jan 15, 2025

View reviewed changes

njlie approved these changes Jan 15, 2025

View reviewed changes

mkurapov merged commit 0b6fb1a into 2893/multi-tenancy-v1 Jan 15, 2025
30 of 36 checks passed

mkurapov deleted the 3033/mk/tenanted-assets branch January 15, 2025 15:17

mkurapov mentioned this pull request Jan 27, 2025

feat(backend): backend tenant graphql resolvers #3234

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(backend): tenanted assets #3206

feat(backend): tenanted assets #3206

mkurapov commented Jan 8, 2025 •

edited

Loading

netlify bot commented Jan 8, 2025 •

edited

Loading

mkurapov Jan 8, 2025 •

edited

Loading

mkurapov Jan 9, 2025 •

edited

Loading

mkurapov Jan 10, 2025

mkurapov Jan 10, 2025

koekiebox Jan 13, 2025

mkurapov Jan 13, 2025

mkurapov Jan 13, 2025

koekiebox Jan 15, 2025

koekiebox left a comment

koekiebox Jan 13, 2025

njlie Jan 14, 2025

koekiebox Jan 13, 2025

koekiebox Jan 13, 2025

koekiebox Jan 13, 2025

koekiebox Jan 13, 2025

feat(backend): tenanted assets #3206

feat(backend): tenanted assets #3206

Conversation

mkurapov commented Jan 8, 2025 • edited Loading

Changes proposed in this pull request

Context

Checklist

netlify bot commented Jan 8, 2025 • edited Loading

✅ Deploy Preview for brilliant-pasca-3e80ec ready!

mkurapov Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

mkurapov Jan 9, 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

koekiebox left a 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

mkurapov commented Jan 8, 2025 •

edited

Loading

netlify bot commented Jan 8, 2025 •

edited

Loading

mkurapov Jan 8, 2025 •

edited

Loading

mkurapov Jan 9, 2025 •

edited

Loading