feat: capabilities (#695)

Author: fenos

src/http/routes/admin/tenants.ts

@@ -8,6 +8,7 @@ import {
   multitenantKnex,
   getTenantConfig,
   jwksManager,
+  getTenantCapabilities,
 } from '@internal/database'
 import { dbSuperUser, storage } from '../../plugins'
 import {
@@ -184,6 +185,8 @@ export default async function routes(fastify: FastifyInstance) {
       disable_events,
     } = tenant
 
+    const capabilities = await getTenantCapabilities(request.params.tenantId)
+
     return {
       anonKey: decrypt(anon_key),
       databaseUrl: decrypt(database_url),
@@ -199,6 +202,7 @@ export default async function routes(fastify: FastifyInstance) {
       jwtSecret: decrypt(jwt_secret),
       jwks,
       serviceKey: decrypt(service_key),
+      capabilities,
       features: {
         imageTransformation: {
           enabled: feature_image_transformation,

src/internal/database/tenant.ts

@@ -5,7 +5,7 @@ import { JWTPayload } from 'jose'
 import { PubSubAdapter } from '../pubsub'
 import { createMutexByKey } from '../concurrency'
 import { ERRORS } from '@internal/errors'
-import { DBMigration } from '@internal/database/migrations'
+import { DBMigration, lastLocalMigrationName } from '@internal/database/migrations'
 import { JWKSManager } from './jwks-manager'
 import { JWKSManagerStoreKnex } from './jwks-manager/store-knex'
 import {
@@ -57,7 +57,8 @@ export enum TenantMigrationStatus {
   FAILED_STALE = 'FAILED_STALE',
 }
 
-const { isMultitenant, dbServiceRole, serviceKeyAsync, jwtSecret } = getConfig()
+const { isMultitenant, dbServiceRole, serviceKeyAsync, jwtSecret, dbMigrationFreezeAt } =
+  getConfig()
 
 const tenantConfigCache = new Map<string, TenantConfig>()
 
@@ -201,6 +202,33 @@ export async function getServiceKey(tenantId: string): Promise<string> {
   return serviceKey
 }
 
+enum Capability {
+  LIST_V2 = 'list_V2',
+}
+
+/**
+ * Get the capabilities for a specific tenant
+ * @param tenantId
+ */
+export async function getTenantCapabilities(tenantId: string) {
+  const capabilities: Record<Capability, boolean> = {
+    [Capability.LIST_V2]: false,
+  }
+
+  let latestMigrationName = dbMigrationFreezeAt || (await lastLocalMigrationName())
+
+  if (isMultitenant) {
+    const { migrationVersion } = await getTenantConfig(tenantId)
+    latestMigrationName = migrationVersion || 'initialmigration'
+  }
+
+  if (DBMigration[latestMigrationName] >= DBMigration['optimise-existing-functions']) {
+    capabilities[Capability.LIST_V2] = true
+  }
+
+  return capabilities
+}
+
 /**
  * Get the jwt key from the tenant config
  * @param tenantId

src/test/tenant.test.ts

@@ -31,6 +31,9 @@ const payload = {
   migrationStatus: 'COMPLETED',
   migrationVersion,
   tracingMode: 'basic',
+  capabilities: {
+    list_V2: true,
+  },
   features: {
     imageTransformation: {
       enabled: true,
@@ -59,6 +62,9 @@ const payload2 = {
   migrationStatus: 'COMPLETED',
   migrationVersion,
   tracingMode: 'basic',
+  capabilities: {
+    list_V2: true,
+  },
   features: {
     imageTransformation: {
       enabled: false,
@@ -113,10 +119,12 @@ describe('Tenant configs', () => {
     })
     expect(response.statusCode).toBe(200)
     const responseJSON = JSON.parse(response.body)
+    const { capabilities, ...finalPayload } = payload
+
     expect(responseJSON).toEqual([
       {
         id: 'abc',
-        ...payload,
+        ...finalPayload,
       },
     ])
   })

src/test/x-forwarded-host.test.ts

@@ -28,15 +28,17 @@ jest.spyOn(tenant, 'getTenantConfig').mockImplementation(async () => ({
   },
 }))
 
-const mockBucketResult = [{ id: 'abc123', name: 'def456' }]
-const storageDbMock = jest.fn().mockImplementation(() => ({
-  listBuckets: jest.fn().mockResolvedValue(mockBucketResult),
+// Mock module with inline implementation that doesn't depend on variables
+jest.mock('@storage/database', () => ({
+  StorageKnexDB: jest.fn().mockImplementation(() => ({
+    listBuckets: jest.fn().mockResolvedValue([{ id: 'abc123', name: 'def456' }]),
+  })),
 }))
-jest.mock('@storage/database', () => {
-  return {
-    StorageKnexDB: storageDbMock,
-  }
-})
+
+// Access the mock after it's been created by the Jest runtime
+const storageDbMock = require('@storage/database').StorageKnexDB
+
+// Use this reference in tests
 
 getConfig()
 mergeConfig({