Feature flags seeds, queries and hooks (#2769)

* seed is working

* allow graphql to retrieve feature flag data

* create useIsFeatureEnabled hook

* hook is working

* Update icons.ts

server/src/core/core.module.ts

@@ -4,6 +4,7 @@ import { WorkspaceModule } from 'src/core/workspace/workspace.module';
 import { UserModule } from 'src/core/user/user.module';
 import { RefreshTokenModule } from 'src/core/refresh-token/refresh-token.module';
 import { AuthModule } from 'src/core/auth/auth.module';
+import { FeatureFlagModule } from 'src/core/feature-flag/feature-flag.module';
 
 import { AnalyticsModule } from './analytics/analytics.module';
 import { FileModule } from './file/file.module';
@@ -18,7 +19,14 @@ import { ClientConfigModule } from './client-config/client-config.module';
     AnalyticsModule,
     FileModule,
     ClientConfigModule,
+    FeatureFlagModule,
+  ],
+  exports: [
+    AuthModule,
+    WorkspaceModule,
+    UserModule,
+    AnalyticsModule,
+    FeatureFlagModule,
   ],
-  exports: [AuthModule, WorkspaceModule, UserModule, AnalyticsModule],
 })
 export class CoreModule {}

server/src/core/feature-flag/feature-flag.entity.ts

@@ -1,3 +1,5 @@
+import { Field, ID, ObjectType } from '@nestjs/graphql';
+
 import {
   Entity,
   Unique,
@@ -7,18 +9,23 @@ import {
   UpdateDateColumn,
   ManyToOne,
 } from 'typeorm';
+import { IDField } from '@ptc-org/nestjs-query-graphql';
 
 import { Workspace } from 'src/core/workspace/workspace.entity';
 
 @Entity({ name: 'featureFlag', schema: 'core' })
+@ObjectType('FeatureFlag')
 @Unique('IndexOnKeyAndWorkspaceIdUnique', ['key', 'workspaceId'])
 export class FeatureFlagEntity {
+  @IDField(() => ID)
   @PrimaryGeneratedColumn('uuid')
   id: string;
 
+  @Field()
   @Column({ nullable: false, type: 'text' })
   key: string;
 
+  @Field()
   @Column({ nullable: false, type: 'uuid' })
   workspaceId: string;
 
@@ -27,6 +34,7 @@ export class FeatureFlagEntity {
   })
   workspace: Workspace;
 
+  @Field()
   @Column({ nullable: false })
   value: boolean;
 

server/src/core/feature-flag/feature-flag.module.ts

@@ -0,0 +1,23 @@
+import { Module } from '@nestjs/common';
+
+import { NestjsQueryGraphQLModule } from '@ptc-org/nestjs-query-graphql';
+import { NestjsQueryTypeOrmModule } from '@ptc-org/nestjs-query-typeorm';
+
+import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
+import { FeatureFlagEntity } from 'src/core/feature-flag/feature-flag.entity';
+
+@Module({
+  imports: [
+    TypeORMModule,
+    NestjsQueryGraphQLModule.forFeature({
+      imports: [
+        NestjsQueryTypeOrmModule.forFeature([FeatureFlagEntity], 'core'),
+      ],
+      services: [],
+      resolvers: [],
+    }),
+  ],
+  exports: [],
+  providers: [],
+})
+export class FeatureFlagModule {}

server/src/core/workspace/workspace.entity.ts

@@ -1,6 +1,6 @@
 import { Field, ID, ObjectType } from '@nestjs/graphql';
 
-import { IDField } from '@ptc-org/nestjs-query-graphql';
+import { IDField, UnPagedRelation } from '@ptc-org/nestjs-query-graphql';
 import {
   Column,
   CreateDateColumn,
@@ -15,6 +15,7 @@ import { FeatureFlagEntity } from 'src/core/feature-flag/feature-flag.entity';
 
 @Entity({ name: 'workspace', schema: 'core' })
 @ObjectType('Workspace')
+@UnPagedRelation('featureFlags', () => FeatureFlagEntity, { nullable: true })
 export class Workspace {
   @IDField(() => ID)
   @PrimaryGeneratedColumn('uuid')

server/src/core/workspace/workspace.module.ts

@@ -7,6 +7,7 @@ import { FileModule } from 'src/core/file/file.module';
 import { WorkspaceManagerModule } from 'src/workspace/workspace-manager/workspace-manager.module';
 import { WorkspaceResolver } from 'src/core/workspace/workspace.resolver';
 import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
+import { FeatureFlagEntity } from 'src/core/feature-flag/feature-flag.entity';
 
 import { Workspace } from './workspace.entity';
 import { workspaceAutoResolverOpts } from './workspace.auto-resolver-opts';
@@ -18,7 +19,10 @@ import { WorkspaceService } from './services/workspace.service';
     TypeORMModule,
     NestjsQueryGraphQLModule.forFeature({
       imports: [
-        NestjsQueryTypeOrmModule.forFeature([Workspace], 'core'),
+        NestjsQueryTypeOrmModule.forFeature(
+          [Workspace, FeatureFlagEntity],
+          'core',
+        ),
         WorkspaceManagerModule,
         FileModule,
       ],

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

@@ -0,0 +1,24 @@
+import { DataSource } from 'typeorm';
+
+const tableName = 'featureFlag';
+
+import { SeedWorkspaceId } from 'src/database/typeorm-seeds/core/workspaces';
+
+export const seedFeatureFlags = async (
+  workspaceDataSource: DataSource,
+  schemaName: string,
+) => {
+  await workspaceDataSource
+    .createQueryBuilder()
+    .insert()
+    .into(`${schemaName}.${tableName}`, ['key', 'workspaceId', 'value'])
+    .orIgnore()
+    .values([
+      {
+        key: 'IS_RELATION_FIELD_TYPE_ENABLED',
+        workspaceId: SeedWorkspaceId,
+        value: true,
+      },
+    ])
+    .execute();
+};

server/src/database/typeorm-seeds/core/index.ts

@@ -2,9 +2,11 @@ import { DataSource } from 'typeorm';
 
 import { seedUsers } from 'src/database/typeorm-seeds/core/users';
 import { seedWorkspaces } from 'src/database/typeorm-seeds/core/workspaces';
+import { seedFeatureFlags } from 'src/database/typeorm-seeds/core/feature-flags';
 
 export const seedCoreSchema = async (workspaceDataSource: DataSource) => {
   const schemaName = 'core';
   await seedWorkspaces(workspaceDataSource, schemaName);
   await seedUsers(workspaceDataSource, schemaName);
+  await seedFeatureFlags(workspaceDataSource, schemaName);
 };