Build stripe integration on backend side (twentyhq#5246)

Adding stripe integration by making the server logic independent of the
input fields:
- query factories (remote server, foreign data wrapper, foreign table)
to loop on fields and values without hardcoding the names of the fields
- adding stripe input and type
- add the logic to handle static schema. Simply creating a big object to
store into the server

Additional work:
- rename username field to user. This is the input intended for postgres
user mapping and we now need a matching by name

---------

Co-authored-by: Thomas Trompette <thomast@twenty.com>

packages/twenty-front/src/generated-metadata/gql.ts

@@ -13,7 +13,7 @@ import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/
  * Therefore it is highly recommended to use the babel or swc plugin for production.
  */
 const documents = {
-    "\n  fragment RemoteServerFields on RemoteServer {\n    id\n    createdAt\n    foreignDataWrapperId\n    foreignDataWrapperOptions\n    foreignDataWrapperType\n    userMappingOptions {\n      username\n    }\n    updatedAt\n    schema\n  }\n": types.RemoteServerFieldsFragmentDoc,
+    "\n  fragment RemoteServerFields on RemoteServer {\n    id\n    createdAt\n    foreignDataWrapperId\n    foreignDataWrapperOptions\n    foreignDataWrapperType\n    userMappingOptions {\n      user\n    }\n    updatedAt\n    schema\n  }\n": types.RemoteServerFieldsFragmentDoc,
     "\n  fragment RemoteTableFields on RemoteTable {\n    id\n    name\n    schema\n    status\n  }\n": types.RemoteTableFieldsFragmentDoc,
     "\n  \n  mutation createServer($input: CreateRemoteServerInput!) {\n    createOneRemoteServer(input: $input) {\n      ...RemoteServerFields\n    }\n  }\n": types.CreateServerDocument,
     "\n  mutation deleteServer($input: RemoteServerIdInput!) {\n    deleteOneRemoteServer(input: $input) {\n      id\n    }\n  }\n": types.DeleteServerDocument,
@@ -50,7 +50,7 @@ export function graphql(source: string): unknown;
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
-export function graphql(source: "\n  fragment RemoteServerFields on RemoteServer {\n    id\n    createdAt\n    foreignDataWrapperId\n    foreignDataWrapperOptions\n    foreignDataWrapperType\n    userMappingOptions {\n      username\n    }\n    updatedAt\n    schema\n  }\n"): (typeof documents)["\n  fragment RemoteServerFields on RemoteServer {\n    id\n    createdAt\n    foreignDataWrapperId\n    foreignDataWrapperOptions\n    foreignDataWrapperType\n    userMappingOptions {\n      username\n    }\n    updatedAt\n    schema\n  }\n"];
+export function graphql(source: "\n  fragment RemoteServerFields on RemoteServer {\n    id\n    createdAt\n    foreignDataWrapperId\n    foreignDataWrapperOptions\n    foreignDataWrapperType\n    userMappingOptions {\n      user\n    }\n    updatedAt\n    schema\n  }\n"): (typeof documents)["\n  fragment RemoteServerFields on RemoteServer {\n    id\n    createdAt\n    foreignDataWrapperId\n    foreignDataWrapperOptions\n    foreignDataWrapperType\n    userMappingOptions {\n      user\n    }\n    updatedAt\n    schema\n  }\n"];
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */

packages/twenty-front/src/generated/graphql.tsx

@@ -577,14 +577,14 @@ export type RemoteServer = {
   id: Scalars['ID'];
   schema?: Maybe<Scalars['String']>;
   updatedAt: Scalars['DateTime'];
-  userMappingOptions?: Maybe<UserMappingOptionsUsername>;
+  userMappingOptions?: Maybe<UserMappingOptionsUser>;
 };
 
 export type RemoteTable = {
   __typename?: 'RemoteTable';
   id?: Maybe<Scalars['UUID']>;
   name: Scalars['String'];
-  schema: Scalars['String'];
+  schema?: Maybe<Scalars['String']>;
   status: RemoteTableStatus;
 };
 
@@ -772,9 +772,9 @@ export type UserExists = {
   exists: Scalars['Boolean'];
 };
 
-export type UserMappingOptionsUsername = {
-  __typename?: 'UserMappingOptionsUsername';
-  username?: Maybe<Scalars['String']>;
+export type UserMappingOptionsUser = {
+  __typename?: 'UserMappingOptionsUser';
+  user?: Maybe<Scalars['String']>;
 };
 
 export type UserWorkspace = {

packages/twenty-front/src/modules/databases/graphql/fragments/databaseConnectionFragment.ts

@@ -8,7 +8,7 @@ export const DATABASE_CONNECTION_FRAGMENT = gql`
     foreignDataWrapperOptions
     foreignDataWrapperType
     userMappingOptions {
-      username
+      user
     }
     updatedAt
     schema

packages/twenty-front/src/modules/settings/integrations/database-connection/components/SettingsIntegrationDatabaseConnectionForm.tsx

@@ -8,7 +8,7 @@ export const settingsIntegrationPostgreSQLConnectionFormSchema = z.object({
   dbname: z.string().min(1),
   host: z.string().min(1),
   port: z.preprocess((val) => parseInt(val as string), z.number().positive()),
-  username: z.string().min(1),
+  user: z.string().min(1),
   password: z.string().min(1),
   schema: z.string().min(1),
 });
@@ -52,9 +52,9 @@ export const SettingsIntegrationPostgreSQLConnectionForm = ({
         { name: 'host' as const, label: 'Host', placeholder: 'host' },
         { name: 'port' as const, label: 'Port', placeholder: '5432' },
         {
-          name: 'username' as const,
-          label: 'Username',
-          placeholder: 'username',
+          name: 'user' as const,
+          label: 'User',
+          placeholder: 'user',
         },
         {
           name: 'password' as const,

packages/twenty-front/src/modules/settings/integrations/database-connection/utils/editDatabaseConnection.ts

@@ -28,7 +28,7 @@ export const getFormDefaultValuesFromConnection = ({
         dbname: connection.foreignDataWrapperOptions.dbname,
         host: connection.foreignDataWrapperOptions.host,
         port: connection.foreignDataWrapperOptions.port,
-        username: connection.userMappingOptions?.username || undefined,
+        user: connection.userMappingOptions?.user || undefined,
         schema: connection.schema || undefined,
         password: '',
       };
@@ -51,7 +51,7 @@ export const formatValuesForUpdate = ({
       const formattedValues = {
         userMappingOptions: pickBy(
           {
-            username: formValues.username,
+            user: formValues.user,
             password: formValues.password,
           },
           identity,

packages/twenty-front/src/pages/settings/integrations/SettingsIntegrationNewDatabaseConnection.tsx

@@ -41,7 +41,7 @@ const createRemoteServerInputSchema = newConnectionSchema
     },
     userMappingOptions: {
       password: values.password,
-      username: values.username,
+      user: values.user,
     },
     schema: values.schema,
   }));

packages/twenty-front/src/testing/mock-data/remote-servers.ts

@@ -12,7 +12,7 @@ export const mockedRemoteServers = [
     foreignDataWrapperType: 'postgres_fdw',
     userMappingOptions: {
       __typename: 'UserMappingOptionsDTO',
-      username: 'twenty',
+      user: 'twenty',
     },
     updatedAt: '2024-04-30T13:41:25.858Z',
     schema: 'public',

packages/twenty-server/src/database/typeorm-seeds/core/feature-flags.ts

@@ -45,6 +45,11 @@ export const seedFeatureFlags = async (
         workspaceId: workspaceId,
         value: true,
       },
+      {
+        key: FeatureFlagKeys.IsStripeIntegrationEnabled,
+        workspaceId: workspaceId,
+        value: true,
+      },
     ])
     .execute();
 };

packages/twenty-server/src/engine/api/graphql/workspace-query-builder/factories/factories.ts

@@ -1,4 +1,4 @@
-import { ForeignDataWrapperQueryFactory } from 'src/engine/api/graphql/workspace-query-builder/factories/foreign-data-wrapper-query.factory';
+import { ForeignDataWrapperServerQueryFactory } from 'src/engine/api/graphql/workspace-query-builder/factories/foreign-data-wrapper-server-query.factory';
 
 import { ArgsAliasFactory } from './args-alias.factory';
 import { ArgsStringFactory } from './args-string.factory';
@@ -30,5 +30,5 @@ export const workspaceQueryBuilderFactories = [
   UpdateOneQueryFactory,
   UpdateManyQueryFactory,
   DeleteManyQueryFactory,
-  ForeignDataWrapperQueryFactory,
+  ForeignDataWrapperServerQueryFactory,
 ];

packages/twenty-server/src/engine/api/graphql/workspace-query-builder/factories/foreign-data-wrapper-server-query.factory.ts

@@ -0,0 +1,69 @@
+import { Injectable } from '@nestjs/common';
+
+import {
+  ForeignDataWrapperOptions,
+  RemoteServerType,
+} from 'src/engine/metadata-modules/remote-server/remote-server.entity';
+import { UserMappingOptions } from 'src/engine/metadata-modules/remote-server/types/user-mapping-options';
+
+@Injectable()
+export class ForeignDataWrapperServerQueryFactory {
+  createForeignDataWrapperServer(
+    foreignDataWrapperId: string,
+    foreignDataWrapperType: RemoteServerType,
+    foreignDataWrapperOptions: ForeignDataWrapperOptions<RemoteServerType>,
+  ) {
+    const options = this.buildQueryOptions(foreignDataWrapperOptions, false);
+
+    return `CREATE SERVER "${foreignDataWrapperId}" FOREIGN DATA WRAPPER ${foreignDataWrapperType} OPTIONS (${options})`;
+  }
+
+  updateForeignDataWrapperServer({
+    foreignDataWrapperId,
+    foreignDataWrapperOptions,
+  }: {
+    foreignDataWrapperId: string;
+    foreignDataWrapperOptions: Partial<
+      ForeignDataWrapperOptions<RemoteServerType>
+    >;
+  }) {
+    const options = this.buildQueryOptions(foreignDataWrapperOptions, true);
+
+    return `ALTER SERVER "${foreignDataWrapperId}" OPTIONS (${options})`;
+  }
+
+  createUserMapping(
+    foreignDataWrapperId: string,
+    userMappingOptions: UserMappingOptions,
+  ) {
+    const options = this.buildQueryOptions(userMappingOptions, false);
+
+    // CURRENT_USER works for now since we are using only one user. But if we switch to a user per workspace, we need to change this.
+    return `CREATE USER MAPPING IF NOT EXISTS FOR CURRENT_USER SERVER "${foreignDataWrapperId}" OPTIONS (${options})`;
+  }
+
+  updateUserMapping(
+    foreignDataWrapperId: string,
+    userMappingOptions: Partial<UserMappingOptions>,
+  ) {
+    const options = this.buildQueryOptions(userMappingOptions, true);
+
+    // CURRENT_USER works for now since we are using only one user. But if we switch to a user per workspace, we need to change this.
+    return `ALTER USER MAPPING FOR CURRENT_USER SERVER "${foreignDataWrapperId}" OPTIONS (${options})`;
+  }
+
+  private buildQueryOptions(
+    options:
+      | ForeignDataWrapperOptions<RemoteServerType>
+      | Partial<ForeignDataWrapperOptions<RemoteServerType>>
+      | UserMappingOptions
+      | Partial<UserMappingOptions>,
+    isUpdate: boolean,
+  ) {
+    const prefix = isUpdate ? 'SET ' : '';
+
+    return Object.entries(options)
+      .map(([key, value]) => `${prefix}${key} '${value}'`)
+      .join(', ');
+  }
+}

packages/twenty-server/src/engine/core-modules/feature-flag/feature-flag.entity.ts

@@ -21,6 +21,7 @@ export enum FeatureFlagKeys {
   IsEventObjectEnabled = 'IS_EVENT_OBJECT_ENABLED',
   IsAirtableIntegrationEnabled = 'IS_AIRTABLE_INTEGRATION_ENABLED',
   IsPostgreSQLIntegrationEnabled = 'IS_POSTGRESQL_INTEGRATION_ENABLED',
+  IsStripeIntegrationEnabled = 'IS_STRIPE_INTEGRATION_ENABLED',
   IsMultiSelectEnabled = 'IS_MULTI_SELECT_ENABLED',
 }
 

packages/twenty-server/src/engine/metadata-modules/remote-server/dtos/create-remote-server.input.ts

@@ -7,7 +7,7 @@ import {
   ForeignDataWrapperOptions,
   RemoteServerType,
 } from 'src/engine/metadata-modules/remote-server/remote-server.entity';
-import { UserMappingOptions } from 'src/engine/metadata-modules/remote-server/utils/user-mapping-options.utils';
+import { UserMappingOptions } from 'src/engine/metadata-modules/remote-server/types/user-mapping-options';
 
 @InputType()
 export class CreateRemoteServerInput<T extends RemoteServerType> {

packages/twenty-server/src/engine/metadata-modules/remote-server/dtos/update-remote-server.input.ts

@@ -10,7 +10,7 @@ import {
 import {
   UserMappingOptions,
   UserMappingOptionsUpdateInput,
-} from 'src/engine/metadata-modules/remote-server/utils/user-mapping-options.utils';
+} from 'src/engine/metadata-modules/remote-server/types/user-mapping-options';
 
 @InputType()
 export class UpdateRemoteServerInput<T extends RemoteServerType> {

packages/twenty-server/src/engine/metadata-modules/remote-server/dtos/user-mapping-dto.ts

@@ -2,9 +2,9 @@ import { ObjectType, Field } from '@nestjs/graphql';
 
 import { IsOptional } from 'class-validator';
 
-@ObjectType('UserMappingOptionsUsername')
+@ObjectType('UserMappingOptionsUser')
 export class UserMappingOptionsDTO {
   @IsOptional()
   @Field(() => String, { nullable: true })
-  username: string;
+  user: string;
 }

packages/twenty-server/src/engine/metadata-modules/remote-server/remote-server.entity.ts

@@ -10,11 +10,12 @@ import {
 } from 'typeorm';
 
 import { RemoteTableEntity } from 'src/engine/metadata-modules/remote-server/remote-table/remote-table.entity';
-import { UserMappingOptions } from 'src/engine/metadata-modules/remote-server/utils/user-mapping-options.utils';
+import { UserMappingOptions } from 'src/engine/metadata-modules/remote-server/types/user-mapping-options';
 import { DistantTables } from 'src/engine/metadata-modules/remote-server/remote-table/distant-table/types/distant-table';
 
 export enum RemoteServerType {
   POSTGRES_FDW = 'postgres_fdw',
+  STRIPE_FDW = 'stripe_fdw',
 }
 
 type PostgresForeignDataWrapperOptions = {
@@ -23,10 +24,17 @@ type PostgresForeignDataWrapperOptions = {
   dbname: string;
 };
 
+type StripeForeignDataWrapperOptions = {
+  api_key: string;
+};
+
 export type ForeignDataWrapperOptions<T extends RemoteServerType> =
   T extends RemoteServerType.POSTGRES_FDW
     ? PostgresForeignDataWrapperOptions
-    : never;
+    : T extends RemoteServerType.STRIPE_FDW
+      ? StripeForeignDataWrapperOptions
+      : never;
+
 @Entity('remoteServer')
 export class RemoteServerEntity<T extends RemoteServerType> {
   @PrimaryGeneratedColumn('uuid')