feat(server): new projects are placed in a configurable region (#3801)

* feat(server): log subscription started messages with info

* feat(server): create projects in a default region

* feat(server): allow project default region config

* feat(server): load project region from multi region config

packages/server/modules/core/graph/resolvers/projects.ts

@@ -35,6 +35,13 @@ import {
   insertCommitsFactory,
   insertStreamCommitsFactory
 } from '@/modules/core/repositories/commits'
+import { storeModelFactory } from '@/modules/core/repositories/models'
+import {
+  deleteProjectFactory,
+  getProjectFactory,
+  storeProjectFactory,
+  storeProjectRoleFactory
+} from '@/modules/core/repositories/projects'
 import { getServerInfoFactory } from '@/modules/core/repositories/server'
 import {
   getStreamFactory,
@@ -49,6 +56,7 @@ import {
   getUserStreamsCountFactory
 } from '@/modules/core/repositories/streams'
 import { getUserFactory, getUsersFactory } from '@/modules/core/repositories/users'
+import { createNewProjectFactory } from '@/modules/core/services/projects'
 import {
   getRateLimitResult,
   isRateLimitBreached
@@ -68,7 +76,11 @@ import {
 } from '@/modules/core/services/streams/management'
 import { createOnboardingStreamFactory } from '@/modules/core/services/streams/onboarding'
 import { getOnboardingBaseProjectFactory } from '@/modules/cross-server-sync/services/onboardingProject'
-import { getProjectDbClient } from '@/modules/multiregion/utils/dbSelector'
+import {
+  getDb,
+  getProjectDbClient,
+  getValidDefaultProjectRegionKey
+} from '@/modules/multiregion/utils/dbSelector'
 import {
   deleteAllResourceInvitesFactory,
   findUserByTargetFactory,
@@ -283,10 +295,23 @@ export = {
         throw new RateLimitError(rateLimitResult)
       }
 
-      const project = await createStreamReturnRecord({
+      const regionKey = await getValidDefaultProjectRegionKey()
+      const projectDb = await getDb({ regionKey })
+
+      const createNewProject = createNewProjectFactory({
+        storeProject: storeProjectFactory({ db: projectDb }),
+        getProject: getProjectFactory({ db }),
+        deleteProject: deleteProjectFactory({ db: projectDb }),
+        storeModel: storeModelFactory({ db: projectDb }),
+        // THIS MUST GO TO THE MAIN DB
+        storeProjectRole: storeProjectRoleFactory({ db }),
+        projectsEventsEmitter: ProjectsEmitter.emit
+      })
+
+      const project = await createNewProject({
         ...(args.input || {}),
         ownerId: context.userId!,
-        ownerResourceAccessRules: context.resourceAccessRules
+        regionKey
       })
 
       return project

packages/server/modules/multiregion/index.ts

@@ -1,5 +1,8 @@
 import { moduleLogger } from '@/logging/logging'
-import { initializeRegisteredRegionClients as initDb } from '@/modules/multiregion/utils/dbSelector'
+import {
+  getValidDefaultProjectRegionKey,
+  initializeRegisteredRegionClients as initDb
+} from '@/modules/multiregion/utils/dbSelector'
 import { isMultiRegionEnabled } from '@/modules/multiregion/helpers'
 import { SpeckleModule } from '@/modules/shared/helpers/typeHelper'
 import {
@@ -18,6 +21,8 @@ const multiRegion: SpeckleModule = {
 
     // Init registered region clients
     await initDb()
+    // validate default project region key
+    await getValidDefaultProjectRegionKey()
 
     const isBlobStorageEnabled = isMultiRegionBlobStorageEnabled()
     if (isBlobStorageEnabled) {

packages/server/modules/multiregion/regionConfig.ts

@@ -58,3 +58,8 @@ export const getMainRegionConfig = async (): Promise<MainRegionConfig> => {
 export const getAvailableRegionConfig: GetAvailableRegionConfig = async () => {
   return (await getMultiRegionConfig()).regions
 }
+
+export const getDefaultProjectRegionKey = async (): Promise<string | null> => {
+  const defaultRegionKey = (await getMultiRegionConfig()).defaultProjectRegionKey
+  return defaultRegionKey ?? null
+}

packages/server/modules/multiregion/utils/dbSelector.ts

@@ -6,11 +6,12 @@ import {
 } from '@/modules/multiregion/services/projectRegion'
 import { Knex } from 'knex'
 import { getRegionFactory } from '@/modules/multiregion/repositories'
-import { DatabaseError } from '@/modules/shared/errors'
+import { DatabaseError, MisconfiguredEnvironmentError } from '@/modules/shared/errors'
 import { configureClient } from '@/knexfile'
 import { InitializeRegion } from '@/modules/multiregion/domain/operations'
 import {
   getAvailableRegionConfig,
+  getDefaultProjectRegionKey,
   getMainRegionConfig
 } from '@/modules/multiregion/regionConfig'
 import { ensureError, MaybeNullOrUndefined } from '@speckle/shared'
@@ -72,6 +73,24 @@ export const getProjectDbClient: GetProjectDb = async ({ projectId }) => {
   return await getter({ projectId })
 }
 
+// the default region key is a config value, we're caching this globally
+let defaultRegionKeyCache: string | null | undefined = undefined
+
+export const getValidDefaultProjectRegionKey = async (): Promise<string | null> => {
+  if (defaultRegionKeyCache !== undefined) return defaultRegionKeyCache
+  const defaultRegionKey = await getDefaultProjectRegionKey()
+
+  if (!defaultRegionKey) return defaultRegionKey
+  const registeredRegionClients = await getRegisteredRegionClients()
+  if (!(defaultRegionKey in registeredRegionClients))
+    throw new MisconfiguredEnvironmentError(
+      `There is no region client registered for the default region key ${defaultRegionKey} `
+    )
+
+  defaultRegionKeyCache = defaultRegionKey
+  return defaultRegionKey
+}
+
 type RegionClients = Record<string, Knex>
 let registeredRegionClients: RegionClients | undefined = undefined
 

packages/server/modules/workspaces/services/projects.ts

@@ -34,7 +34,10 @@ import {
 } from '@/modules/core/domain/streams/operations'
 import { ProjectNotFoundError } from '@/modules/core/errors/projects'
 import { WorkspaceProjectCreateInput } from '@/test/graphql/generated/graphql'
-import { getDb } from '@/modules/multiregion/utils/dbSelector'
+import {
+  getDb,
+  getValidDefaultProjectRegionKey
+} from '@/modules/multiregion/utils/dbSelector'
 import { createNewProjectFactory } from '@/modules/core/services/projects'
 import {
   deleteProjectFactory,
@@ -265,7 +268,8 @@ export const createWorkspaceProjectFactory =
     const workspaceDefaultRegion = await deps.getDefaultRegion({
       workspaceId: input.workspaceId
     })
-    const regionKey = workspaceDefaultRegion?.key
+    const regionKey =
+      workspaceDefaultRegion?.key ?? (await getValidDefaultProjectRegionKey())
     const projectDb = await getDb({ regionKey })
     const db = mainDb
 

packages/shared/src/environment/multiRegionConfig.ts

@@ -41,7 +41,8 @@ const regionConfigSchema = z.object({
 
 const multiRegionConfigSchema = z.object({
   main: regionConfigSchema,
-  regions: z.record(z.string(), regionConfigSchema)
+  regions: z.record(z.string(), regionConfigSchema),
+  defaultProjectRegionKey: z.string().min(3).nullish()
 })
 
 export type MultiRegionConfig = z.infer<typeof multiRegionConfigSchema>