feat(server): multi region module base w/ a test (mocked) mutation

packages/frontend-2/lib/common/generated/gql/graphql.ts

@@ -4196,7 +4196,9 @@ export type WorkspacePlan = {
 };
 
 export enum WorkspacePlanStatuses {
+  CancelationScheduled = 'cancelationScheduled',
   Canceled = 'canceled',
+  Expired = 'expired',
   PaymentFailed = 'paymentFailed',
   Trial = 'trial',
   Valid = 'valid'

packages/server/assets/multiregion/typedefs/multiregion.graphql

@@ -0,0 +1,26 @@
+type ServerRegionItem {
+  id: String!
+  key: String!
+  name: String!
+  description: String!
+}
+
+input CreateServerRegionInput {
+  key: String!
+  name: String!
+  description: String!
+}
+
+type ServerRegionMutations {
+  create(input: CreateServerRegionInput!): ServerRegionItem!
+}
+
+type ServerInfoMutations {
+  multiRegion: ServerRegionMutations!
+}
+
+extend type Mutation {
+  serverInfoMutations: ServerInfoMutations!
+    @hasServerRole(role: SERVER_ADMIN)
+    @hasScope(scope: "server:setup")
+}

packages/server/codegen.yml

@@ -25,7 +25,6 @@ generates:
         User: '@/modules/core/helpers/graphTypes#UserGraphQLReturn'
         ActiveUserMutations: '@/modules/core/helpers/graphTypes#MutationsObjectGraphQLReturn'
         UserEmailMutations: '@/modules/core/helpers/graphTypes#MutationsObjectGraphQLReturn'
-        UserWorkspaceMutations: '@/modules/core/helpers/graphTypes#MutationsObjectGraphQLReturn'
         ProjectMutations: '@/modules/core/helpers/graphTypes#MutationsObjectGraphQLReturn'
         ProjectInviteMutations: '@/modules/core/helpers/graphTypes#MutationsObjectGraphQLReturn'
         ModelMutations: '@/modules/core/helpers/graphTypes#MutationsObjectGraphQLReturn'

packages/server/modules/core/graph/generated/graphql.ts

@@ -858,6 +858,12 @@ export type CreateModelInput = {
   projectId: Scalars['ID']['input'];
 };
 
+export type CreateServerRegionInput = {
+  description: Scalars['String']['input'];
+  key: Scalars['String']['input'];
+  name: Scalars['String']['input'];
+};
+
 export type CreateUserEmailInput = {
   email: Scalars['String']['input'];
 };
@@ -1318,6 +1324,7 @@ export type Mutation = {
   /** (Re-)send the account verification e-mail */
   requestVerification: Scalars['Boolean']['output'];
   requestVerificationByEmail: Scalars['Boolean']['output'];
+  serverInfoMutations: ServerInfoMutations;
   serverInfoUpdate?: Maybe<Scalars['Boolean']['output']>;
   /** Note: The required scope to invoke this is not given out to app or personal access tokens */
   serverInviteBatchCreate: Scalars['Boolean']['output'];
@@ -2830,6 +2837,11 @@ export type ServerInfo = {
   workspaces: ServerWorkspacesInfo;
 };
 
+export type ServerInfoMutations = {
+  __typename?: 'ServerInfoMutations';
+  multiRegion: ServerRegionMutations;
+};
+
 export type ServerInfoUpdateInput = {
   adminContact?: InputMaybe<Scalars['String']['input']>;
   company?: InputMaybe<Scalars['String']['input']>;
@@ -2860,6 +2872,24 @@ export type ServerMigration = {
   movedTo?: Maybe<Scalars['String']['output']>;
 };
 
+export type ServerRegionItem = {
+  __typename?: 'ServerRegionItem';
+  description: Scalars['String']['output'];
+  id: Scalars['String']['output'];
+  key: Scalars['String']['output'];
+  name: Scalars['String']['output'];
+};
+
+export type ServerRegionMutations = {
+  __typename?: 'ServerRegionMutations';
+  create: ServerRegionItem;
+};
+
+
+export type ServerRegionMutationsCreateArgs = {
+  input: CreateServerRegionInput;
+};
+
 export enum ServerRole {
   ServerAdmin = 'SERVER_ADMIN',
   ServerArchivedUser = 'SERVER_ARCHIVED_USER',
@@ -4216,7 +4246,9 @@ export type WorkspacePlan = {
 };
 
 export enum WorkspacePlanStatuses {
+  CancelationScheduled = 'cancelationScheduled',
   Canceled = 'canceled',
+  Expired = 'expired',
   PaymentFailed = 'paymentFailed',
   Trial = 'trial',
   Valid = 'valid'
@@ -4469,6 +4501,7 @@ export type ResolversTypes = {
   CreateCommentInput: CreateCommentInput;
   CreateCommentReplyInput: CreateCommentReplyInput;
   CreateModelInput: CreateModelInput;
+  CreateServerRegionInput: CreateServerRegionInput;
   CreateUserEmailInput: CreateUserEmailInput;
   CreateVersionInput: CreateVersionInput;
   Currency: Currency;
@@ -4564,10 +4597,13 @@ export type ResolversTypes = {
   ServerAutomateInfo: ResolverTypeWrapper<ServerAutomateInfo>;
   ServerConfiguration: ResolverTypeWrapper<ServerConfiguration>;
   ServerInfo: ResolverTypeWrapper<ServerInfoGraphQLReturn>;
+  ServerInfoMutations: ResolverTypeWrapper<ServerInfoMutations>;
   ServerInfoUpdateInput: ServerInfoUpdateInput;
   ServerInvite: ResolverTypeWrapper<ServerInviteGraphQLReturnType>;
   ServerInviteCreateInput: ServerInviteCreateInput;
   ServerMigration: ResolverTypeWrapper<ServerMigration>;
+  ServerRegionItem: ResolverTypeWrapper<ServerRegionItem>;
+  ServerRegionMutations: ResolverTypeWrapper<ServerRegionMutations>;
   ServerRole: ServerRole;
   ServerRoleItem: ResolverTypeWrapper<ServerRoleItem>;
   ServerStatistics: ResolverTypeWrapper<GraphQLEmptyReturn>;
@@ -4739,6 +4775,7 @@ export type ResolversParentTypes = {
   CreateCommentInput: CreateCommentInput;
   CreateCommentReplyInput: CreateCommentReplyInput;
   CreateModelInput: CreateModelInput;
+  CreateServerRegionInput: CreateServerRegionInput;
   CreateUserEmailInput: CreateUserEmailInput;
   CreateVersionInput: CreateVersionInput;
   DateTime: Scalars['DateTime']['output'];
@@ -4820,10 +4857,13 @@ export type ResolversParentTypes = {
   ServerAutomateInfo: ServerAutomateInfo;
   ServerConfiguration: ServerConfiguration;
   ServerInfo: ServerInfoGraphQLReturn;
+  ServerInfoMutations: ServerInfoMutations;
   ServerInfoUpdateInput: ServerInfoUpdateInput;
   ServerInvite: ServerInviteGraphQLReturnType;
   ServerInviteCreateInput: ServerInviteCreateInput;
   ServerMigration: ServerMigration;
+  ServerRegionItem: ServerRegionItem;
+  ServerRegionMutations: ServerRegionMutations;
   ServerRoleItem: ServerRoleItem;
   ServerStatistics: GraphQLEmptyReturn;
   ServerStats: GraphQLEmptyReturn;
@@ -5517,6 +5557,7 @@ export type MutationResolvers<ContextType = GraphQLContext, ParentType extends R
   projectMutations?: Resolver<ResolversTypes['ProjectMutations'], ParentType, ContextType>;
   requestVerification?: Resolver<ResolversTypes['Boolean'], ParentType, ContextType>;
   requestVerificationByEmail?: Resolver<ResolversTypes['Boolean'], ParentType, ContextType, RequireFields<MutationRequestVerificationByEmailArgs, 'email'>>;
+  serverInfoMutations?: Resolver<ResolversTypes['ServerInfoMutations'], ParentType, ContextType>;
   serverInfoUpdate?: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType, RequireFields<MutationServerInfoUpdateArgs, 'info'>>;
   serverInviteBatchCreate?: Resolver<ResolversTypes['Boolean'], ParentType, ContextType, RequireFields<MutationServerInviteBatchCreateArgs, 'input'>>;
   serverInviteCreate?: Resolver<ResolversTypes['Boolean'], ParentType, ContextType, RequireFields<MutationServerInviteCreateArgs, 'input'>>;
@@ -5914,6 +5955,11 @@ export type ServerInfoResolvers<ContextType = GraphQLContext, ParentType extends
   __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
+export type ServerInfoMutationsResolvers<ContextType = GraphQLContext, ParentType extends ResolversParentTypes['ServerInfoMutations'] = ResolversParentTypes['ServerInfoMutations']> = {
+  multiRegion?: Resolver<ResolversTypes['ServerRegionMutations'], ParentType, ContextType>;
+  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
+};
+
 export type ServerInviteResolvers<ContextType = GraphQLContext, ParentType extends ResolversParentTypes['ServerInvite'] = ResolversParentTypes['ServerInvite']> = {
   email?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
@@ -5927,6 +5973,19 @@ export type ServerMigrationResolvers<ContextType = GraphQLContext, ParentType ex
   __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
+export type ServerRegionItemResolvers<ContextType = GraphQLContext, ParentType extends ResolversParentTypes['ServerRegionItem'] = ResolversParentTypes['ServerRegionItem']> = {
+  description?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  key?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  name?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
+};
+
+export type ServerRegionMutationsResolvers<ContextType = GraphQLContext, ParentType extends ResolversParentTypes['ServerRegionMutations'] = ResolversParentTypes['ServerRegionMutations']> = {
+  create?: Resolver<ResolversTypes['ServerRegionItem'], ParentType, ContextType, RequireFields<ServerRegionMutationsCreateArgs, 'input'>>;
+  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
+};
+
 export type ServerRoleItemResolvers<ContextType = GraphQLContext, ParentType extends ResolversParentTypes['ServerRoleItem'] = ResolversParentTypes['ServerRoleItem']> = {
   id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   title?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
@@ -6497,8 +6556,11 @@ export type Resolvers<ContextType = GraphQLContext> = {
   ServerAutomateInfo?: ServerAutomateInfoResolvers<ContextType>;
   ServerConfiguration?: ServerConfigurationResolvers<ContextType>;
   ServerInfo?: ServerInfoResolvers<ContextType>;
+  ServerInfoMutations?: ServerInfoMutationsResolvers<ContextType>;
   ServerInvite?: ServerInviteResolvers<ContextType>;
   ServerMigration?: ServerMigrationResolvers<ContextType>;
+  ServerRegionItem?: ServerRegionItemResolvers<ContextType>;
+  ServerRegionMutations?: ServerRegionMutationsResolvers<ContextType>;
   ServerRoleItem?: ServerRoleItemResolvers<ContextType>;
   ServerStatistics?: ServerStatisticsResolvers<ContextType>;
   ServerStats?: ServerStatsResolvers<ContextType>;

packages/server/modules/cross-server-sync/graph/generated/graphql.ts

@@ -841,6 +841,12 @@ export type CreateModelInput = {
   projectId: Scalars['ID']['input'];
 };
 
+export type CreateServerRegionInput = {
+  description: Scalars['String']['input'];
+  key: Scalars['String']['input'];
+  name: Scalars['String']['input'];
+};
+
 export type CreateUserEmailInput = {
   email: Scalars['String']['input'];
 };
@@ -1301,6 +1307,7 @@ export type Mutation = {
   /** (Re-)send the account verification e-mail */
   requestVerification: Scalars['Boolean']['output'];
   requestVerificationByEmail: Scalars['Boolean']['output'];
+  serverInfoMutations: ServerInfoMutations;
   serverInfoUpdate?: Maybe<Scalars['Boolean']['output']>;
   /** Note: The required scope to invoke this is not given out to app or personal access tokens */
   serverInviteBatchCreate: Scalars['Boolean']['output'];
@@ -2813,6 +2820,11 @@ export type ServerInfo = {
   workspaces: ServerWorkspacesInfo;
 };
 
+export type ServerInfoMutations = {
+  __typename?: 'ServerInfoMutations';
+  multiRegion: ServerRegionMutations;
+};
+
 export type ServerInfoUpdateInput = {
   adminContact?: InputMaybe<Scalars['String']['input']>;
   company?: InputMaybe<Scalars['String']['input']>;
@@ -2843,6 +2855,24 @@ export type ServerMigration = {
   movedTo?: Maybe<Scalars['String']['output']>;
 };
 
+export type ServerRegionItem = {
+  __typename?: 'ServerRegionItem';
+  description: Scalars['String']['output'];
+  id: Scalars['String']['output'];
+  key: Scalars['String']['output'];
+  name: Scalars['String']['output'];
+};
+
+export type ServerRegionMutations = {
+  __typename?: 'ServerRegionMutations';
+  create: ServerRegionItem;
+};
+
+
+export type ServerRegionMutationsCreateArgs = {
+  input: CreateServerRegionInput;
+};
+
 export enum ServerRole {
   ServerAdmin = 'SERVER_ADMIN',
   ServerArchivedUser = 'SERVER_ARCHIVED_USER',
@@ -4199,7 +4229,9 @@ export type WorkspacePlan = {
 };
 
 export enum WorkspacePlanStatuses {
+  CancelationScheduled = 'cancelationScheduled',
   Canceled = 'canceled',
+  Expired = 'expired',
   PaymentFailed = 'paymentFailed',
   Trial = 'trial',
   Valid = 'valid'

packages/server/modules/index.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/no-var-requires */
+
 import fs from 'fs'
 import path from 'path'
 import { appRoot, packageRoot } from '@/bootstrap'
@@ -22,6 +22,7 @@ import {
 } from '@/modules/core/graph/helpers/directiveHelper'
 import { AppMocksConfig } from '@/modules/mocks'
 import { SpeckleModuleMocksConfig } from '@/modules/shared/helpers/mocks'
+import { LogicError } from '@/modules/shared/errors'
 
 /**
  * Cached speckle module requires
@@ -77,7 +78,8 @@ const getEnabledModuleNames = () => {
     'serverinvites',
     'stats',
     'webhooks',
-    'workspacesCore'
+    'workspacesCore',
+    'multiregion'
   ]
 
   if (FF_AUTOMATE_MODULE_ENABLED) moduleNames.push('automate')
@@ -93,7 +95,13 @@ async function getSpeckleModules() {
   const moduleNames = getEnabledModuleNames()
 
   for (const dir of moduleNames) {
-    loadedModules.push(require(`./${dir}`))
+    const moduleIndex = await import(`./${dir}/index`)
+    const moduleDefinition = 'init' in moduleIndex ? moduleIndex : moduleIndex.default
+    if (!('init' in moduleDefinition)) {
+      throw new LogicError(`Module ${dir} does not have an init function`)
+    }
+
+    loadedModules.push(moduleDefinition)
   }
 
   return loadedModules
@@ -185,7 +193,10 @@ const graphComponents = (): Pick<ApolloServerOptions<any>, 'resolvers'> & {
     // first pass load of resolvers
     const resolversPath = path.join(fullPath, 'graph', 'resolvers')
     if (fs.existsSync(resolversPath)) {
-      resolverObjs = [...resolverObjs, ...values(autoloadFromDirectory(resolversPath))]
+      const newResolverObjs = values(autoloadFromDirectory(resolversPath)).map((o) =>
+        'default' in o ? o.default : o
+      )
+      resolverObjs = [...resolverObjs, ...newResolverObjs]
     }
 
     // load directives

packages/server/modules/multiregion/domain/operations.ts

@@ -0,0 +1,3 @@
+import { RegionServerConfig } from '@/modules/multiregion/domain/types'
+
+export type GetAvailableRegionConfigs = () => Promise<RegionServerConfig[]>

packages/server/modules/multiregion/domain/types.ts

@@ -0,0 +1,11 @@
+// TODO: Need to coordinate w/ Iain on how this is actually gonna work
+export type RegionServerConfig = {
+  /**
+   * Full Postgres connection URI (e.g. "postgres://user:password@host:port/dbname")
+   */
+  connectionUri: string
+  /**
+   * Acts as a key, needs to be globally unique
+   */
+  locale: string
+}

packages/server/modules/multiregion/errors/index.ts

@@ -0,0 +1,6 @@
+import { BaseError } from '@/modules/shared/errors'
+
+export class MultiRegionSupportDisabledError extends BaseError {
+  static code = 'MULTI_REGION_SUPPORT_DISABLED'
+  static defaultMessage = 'Multi region support is disabled'
+}

packages/server/modules/multiregion/graph/mocks/index.ts

@@ -0,0 +1,16 @@
+import { SpeckleModuleMocksConfig } from '@/modules/shared/helpers/mocks'
+import { faker } from '@faker-js/faker'
+
+export default {
+  mocks: {
+    ServerRegionItem: () => {
+      const key = faker.string.uuid()
+      return {
+        id: key,
+        key,
+        name: faker.address.country(),
+        description: faker.lorem.sentence()
+      }
+    }
+  }
+} as SpeckleModuleMocksConfig

packages/server/modules/multiregion/graph/resolvers/index.ts

@@ -0,0 +1,5 @@
+import { Resolvers } from '@/modules/core/graph/generated/graphql'
+
+// TODO: Real implementation? Need to discuss questions regarding data model & region config first
+
+export default {} as Resolvers

packages/server/modules/multiregion/helpers/index.ts

@@ -0,0 +1,7 @@
+import { getFeatureFlags } from '@/modules/shared/helpers/envHelper'
+
+export const isMultiRegionEnabled = () => {
+  const { FF_WORKSPACES_MODULE_ENABLED, FF_WORKSPACES_MULTI_REGION_ENABLED } =
+    getFeatureFlags()
+  return !!(FF_WORKSPACES_MODULE_ENABLED && FF_WORKSPACES_MULTI_REGION_ENABLED)
+}

packages/server/modules/multiregion/index.ts

@@ -0,0 +1,14 @@
+import { moduleLogger } from '@/logging/logging'
+import { isMultiRegionEnabled } from '@/modules/multiregion/helpers'
+import { SpeckleModule } from '@/modules/shared/helpers/typeHelper'
+
+const multiregion: SpeckleModule = {
+  init() {
+    const isEnabled = isMultiRegionEnabled()
+    if (isEnabled) {
+      moduleLogger.info('🌍 Init multiregion module')
+    }
+  }
+}
+
+export default multiregion