feat: feature flag consumption (bloom-housing#4489) (#820)

* feat: feature flag controller service and tests

4459

* feat: associate jurisdictions tests

* feat: permissions and permission tests

* feat: make naming random

* feat: edge case coverage

* feat: refine uuid array validation

* feat: remove unused import

* feat: controller cleanup

api/prisma/seed-helpers/feature-flag-factory.ts

@@ -0,0 +1,23 @@
+import { Prisma } from '@prisma/client';
+import { randomBoolean } from './boolean-generator';
+import { randomAdjective, randomName } from './word-generator';
+
+export const featureFlagFactory = (
+  name = randomName(),
+  active = randomBoolean(),
+  description = `${randomAdjective()} feature flag`,
+  jurisdictionIds?: string[],
+): Prisma.FeatureFlagsCreateInput => ({
+  name: name,
+  description: description,
+  active: active,
+  jurisdictions: jurisdictionIds
+    ? {
+        connect: jurisdictionIds.map((jurisdiction) => {
+          return {
+            id: jurisdiction,
+          };
+        }),
+      }
+    : undefined,
+});

api/src/controllers/feature-flag.controller.ts

@@ -0,0 +1,110 @@
+import {
+  Body,
+  Controller,
+  Delete,
+  Get,
+  Param,
+  ParseUUIDPipe,
+  Post,
+  Put,
+  UseGuards,
+  UsePipes,
+  ValidationPipe,
+} from '@nestjs/common';
+import {
+  ApiExtraModels,
+  ApiOkResponse,
+  ApiOperation,
+  ApiTags,
+} from '@nestjs/swagger';
+import { FeatureFlagService } from '../services/feature-flag.service';
+import { FeatureFlag } from '../dtos/feature-flags/feature-flag.dto';
+import { FeatureFlagAssociate } from '../dtos/feature-flags/feature-flag-associate.dto';
+import { FeatureFlagCreate } from '../dtos/feature-flags/feature-flag-create.dto';
+import { FeatureFlagUpdate } from '../dtos/feature-flags/feature-flag-update.dto';
+import { defaultValidationPipeOptions } from '../utilities/default-validation-pipe-options';
+import { IdDTO } from '../dtos/shared/id.dto';
+import { SuccessDTO } from '../dtos/shared/success.dto';
+import { PermissionTypeDecorator } from '../decorators/permission-type.decorator';
+import { OptionalAuthGuard } from '../guards/optional.guard';
+import { PermissionGuard } from '../guards/permission.guard';
+import { ApiKeyGuard } from '../guards/api-key.guard';
+
+@Controller('featureFlags')
+@ApiTags('featureFlags')
+@UsePipes(new ValidationPipe(defaultValidationPipeOptions))
+@ApiExtraModels(
+  FeatureFlagAssociate,
+  FeatureFlagCreate,
+  FeatureFlagUpdate,
+  IdDTO,
+)
+@PermissionTypeDecorator('featureFlags')
+@UseGuards(ApiKeyGuard, OptionalAuthGuard, PermissionGuard)
+export class FeatureFlagController {
+  constructor(private readonly featureFlagService: FeatureFlagService) {}
+
+  @Get()
+  @ApiOperation({ summary: 'List of feature flags', operationId: 'list' })
+  @ApiOkResponse({ type: FeatureFlag, isArray: true })
+  async list(): Promise<FeatureFlag[]> {
+    return await this.featureFlagService.list();
+  }
+
+  @Post()
+  @ApiOperation({
+    summary: 'Create a feature flag',
+    operationId: 'create',
+  })
+  @ApiOkResponse({ type: FeatureFlag })
+  async create(@Body() featureFlag: FeatureFlagCreate): Promise<FeatureFlag> {
+    return await this.featureFlagService.create(featureFlag);
+  }
+
+  @Put()
+  @ApiOperation({
+    summary: 'Update a feature flag',
+    operationId: 'update',
+  })
+  @ApiOkResponse({ type: FeatureFlag })
+  async update(@Body() featureFlag: FeatureFlagUpdate): Promise<FeatureFlag> {
+    return await this.featureFlagService.update(featureFlag);
+  }
+
+  @Delete()
+  @ApiOperation({
+    summary: 'Delete a feature flag by id',
+    operationId: 'delete',
+  })
+  @ApiOkResponse({ type: SuccessDTO })
+  async delete(@Body() dto: IdDTO): Promise<SuccessDTO> {
+    return await this.featureFlagService.delete(dto.id);
+  }
+
+  @Put(`associateJurisdictions`)
+  @ApiOperation({
+    summary: 'Associate and disassociate jurisdictions with a feature flag',
+    operationId: 'associateJurisdictions',
+  })
+  @ApiOkResponse({ type: FeatureFlag })
+  async associateJurisdictions(
+    @Body() featureFlagAssociate: FeatureFlagAssociate,
+  ): Promise<FeatureFlag> {
+    return await this.featureFlagService.associateJurisdictions(
+      featureFlagAssociate,
+    );
+  }
+
+  @Get(`:featureFlagId`)
+  @ApiOperation({
+    summary: 'Get a feature flag by id',
+    operationId: 'retrieve',
+  })
+  @ApiOkResponse({ type: FeatureFlag })
+  async retrieve(
+    @Param('featureFlagId', new ParseUUIDPipe({ version: '4' }))
+    featureFlagId: string,
+  ): Promise<FeatureFlag> {
+    return this.featureFlagService.findOne(featureFlagId);
+  }
+}

api/src/dtos/feature-flags/feature-flag-associate.dto.ts

@@ -0,0 +1,31 @@
+import { Expose } from 'class-transformer';
+import { IsArray, IsDefined, IsString, IsUUID } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
+
+export class FeatureFlagAssociate {
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @IsUUID(4, { groups: [ValidationsGroupsEnum.default] })
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
+  id: string;
+
+  @Expose()
+  @IsArray({ groups: [ValidationsGroupsEnum.default] })
+  @IsUUID(4, {
+    groups: [ValidationsGroupsEnum.default],
+    each: true,
+  })
+  @ApiProperty()
+  associate: string[];
+
+  @Expose()
+  @IsArray({ groups: [ValidationsGroupsEnum.default] })
+  @IsUUID(4, {
+    groups: [ValidationsGroupsEnum.default],
+    each: true,
+  })
+  @ApiProperty()
+  remove: string[];
+}

api/src/dtos/feature-flags/feature-flag-create.dto.ts

@@ -0,0 +1,4 @@
+import { OmitType } from '@nestjs/swagger';
+import { FeatureFlagUpdate } from './feature-flag-update.dto';
+
+export class FeatureFlagCreate extends OmitType(FeatureFlagUpdate, ['id']) {}

api/src/dtos/feature-flags/feature-flag-update.dto.ts

@@ -0,0 +1,8 @@
+import { OmitType } from '@nestjs/swagger';
+import { FeatureFlag } from './feature-flag.dto';
+
+export class FeatureFlagUpdate extends OmitType(FeatureFlag, [
+  'createdAt',
+  'updatedAt',
+  'jurisdictions',
+]) {}

api/src/dtos/feature-flags/feature-flag.dto.ts

@@ -0,0 +1,39 @@
+import { Expose, Type } from 'class-transformer';
+import {
+  IsBoolean,
+  IsDefined,
+  IsString,
+  MaxLength,
+  ValidateNested,
+} from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+import { AbstractDTO } from '../shared/abstract.dto';
+import { IdDTO } from '../shared/id.dto';
+import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
+
+export class FeatureFlag extends AbstractDTO {
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @MaxLength(256, { groups: [ValidationsGroupsEnum.default] })
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
+  name: string;
+
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
+  description: string;
+
+  @Expose()
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
+  active: boolean;
+
+  @Expose()
+  @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
+  @Type(() => IdDTO)
+  @ApiProperty({ type: IdDTO, isArray: true })
+  jurisdictions: IdDTO[];
+}

api/src/dtos/jurisdictions/jurisdiction-update.dto.ts

@@ -4,5 +4,6 @@ import { Jurisdiction } from './jurisdiction.dto';
 export class JurisdictionUpdate extends OmitType(Jurisdiction, [
   'createdAt',
   'updatedAt',
+  'featureFlags',
   'multiselectQuestions',
 ]) {}

api/src/dtos/jurisdictions/jurisdiction.dto.ts

@@ -1,4 +1,4 @@
-import { AbstractDTO } from '../shared/abstract.dto';
+import { Expose, Type } from 'class-transformer';
 import {
   IsString,
   MaxLength,
@@ -9,11 +9,12 @@ import {
   ValidateNested,
   IsBoolean,
 } from 'class-validator';
-import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
-import { LanguagesEnum, UserRoleEnum } from '@prisma/client';
-import { Expose, Type } from 'class-transformer';
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { LanguagesEnum, UserRoleEnum } from '@prisma/client';
+import { FeatureFlag } from '../feature-flags/feature-flag.dto';
+import { AbstractDTO } from '../shared/abstract.dto';
 import { IdDTO } from '../shared/id.dto';
+import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
 
 export class Jurisdiction extends AbstractDTO {
   @Expose()
@@ -140,4 +141,11 @@ export class Jurisdiction extends AbstractDTO {
     isArray: true,
   })
   duplicateListingPermissions: UserRoleEnum[];
+
+  @Expose()
+  @ValidateNested({ groups: [ValidationsGroupsEnum.default] })
+  @Type(() => FeatureFlag)
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty({ type: FeatureFlag, isArray: true })
+  featureFlags: FeatureFlag[];
 }

api/src/modules/app.module.ts

@@ -22,6 +22,7 @@ import { ThrottlerModule } from '@nestjs/throttler';
 import { ThrottleGuard } from '../guards/throttler.guard';
 import { ScirptRunnerModule } from './script-runner.module';
 import { LotteryModule } from './lottery.module';
+import { FeatureFlagModule } from './feature-flag.module';
 
 @Module({
   imports: [
@@ -42,6 +43,7 @@ import { LotteryModule } from './lottery.module';
     MapLayerModule,
     ScirptRunnerModule,
     LotteryModule,
+    FeatureFlagModule,
     ThrottlerModule.forRoot([
       {
         ttl: Number(process.env.THROTTLE_TTL),
@@ -77,6 +79,7 @@ import { LotteryModule } from './lottery.module';
     MapLayerModule,
     ScirptRunnerModule,
     LotteryModule,
+    FeatureFlagModule,
   ],
 })
 export class AppModule {}

api/src/modules/feature-flag.module.ts

@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common';
+import { FeatureFlagController } from '../controllers/feature-flag.controller';
+import { FeatureFlagService } from '../services/feature-flag.service';
+import { JurisdictionModule } from './jurisdiction.module';
+import { PermissionModule } from './permission.module';
+import { PrismaModule } from './prisma.module';
+
+@Module({
+  imports: [JurisdictionModule, PermissionModule, PrismaModule],
+  controllers: [FeatureFlagController],
+  providers: [FeatureFlagService],
+  exports: [FeatureFlagService],
+})
+export class FeatureFlagModule {}

api/src/permission-configs/permission_policy.csv

@@ -81,6 +81,8 @@ p, partner, paperApplication, true, read
 p, admin, mapLayers, true, .*
 p, jurisdictionAdmin, mapLayers, true, .*
 
+p, admin, featureFlags, true, .*
+
 g, admin, jurisdictionAdmin
 g, jurisdictionAdmin, partner
 g, partner, user