Feature/make graphql queries based on readmodels configurable

package.json

@@ -0,0 +1,5 @@
+{
+  "devDependencies": {
+    "@types/mocha": "^10.0.9"
+  }
+}

packages/framework-core/src/decorators/read-model.ts

@@ -2,8 +2,7 @@ import {
   Class,
   ReadModelAuthorizer,
   ReadModelFilterHooks,
-  ReadModelGraphqlQueryGeneratorConfig,
-  ReadModelGraphqlSubscriptionGeneratorConfig,
+  GenerationStrategy,
   ReadModelInterface,
   ReadModelRoleAccess,
 } from '@boostercloud/framework-types'
@@ -16,7 +15,11 @@ import { getClassMetadata } from './metadata'
  * @param attributes
  */
 export function ReadModel(
-  attributes: ReadModelRoleAccess & ReadModelFilterHooks, graphQLQueryConfiguration: ReadModelGraphqlQueryGeneratorConfig, graphQLSubscriptionConfiguration: ReadModelGraphqlSubscriptionGeneratorConfig
+  attributes: ReadModelRoleAccess & ReadModelFilterHooks,
+  graphQlGeneration?: {
+    queryGeneration: GenerationStrategy[]
+    subscriptionGeneration: GenerationStrategy[]
+  }
 ): (readModelClass: Class<ReadModelInterface>, context?: ClassDecoratorContext) => void {
   return (readModelClass) => {
     Booster.configureCurrentEnv((config): void => {
@@ -25,32 +28,29 @@ export function ReadModel(
         If you think that this is an error, try performing a clean build.`)
       }
 
-      const enableAutomaticGraphQLQueryGenerationFromReadModels = config.enableAutomaticGraphQLQueryGenerationFromReadModels;
-      if (enableAutomaticGraphQLQueryGenerationFromReadModels) {
-        if (!graphQLQueryConfiguration) {
-          graphQLQueryConfiguration = 'GRAPHQL_LIST_AND_SINGLE_QUERIES';
-        }
-        if (!graphQLSubscriptionConfiguration) {
-          graphQLSubscriptionConfiguration = 'GRAPHQL_LIST_AND_SINGLE_SUBSCRIPTION';
-        }
-      }
-      if (!enableAutomaticGraphQLQueryGenerationFromReadModels) {
-        if (!graphQLQueryConfiguration) {
-          graphQLQueryConfiguration = 'NO_GRAPHQL_QUERIES';
-        }
-        if (!graphQLSubscriptionConfiguration) {
-          graphQLSubscriptionConfiguration = 'NO_GRAPHQL_SUBSCRIPTIONS';
+      const enableAutomaticGraphQLQueryGenerationFromReadModels =
+        config.enableAutomaticGraphQLQueryGenerationFromReadModels
+      let queryGeneration: GenerationStrategy[] = []
+      let subscriptionGeneration: GenerationStrategy[] = []
+
+      if (graphQlGeneration) {
+        queryGeneration = graphQlGeneration.queryGeneration
+        subscriptionGeneration = graphQlGeneration.subscriptionGeneration
+      } else {
+        if (enableAutomaticGraphQLQueryGenerationFromReadModels) {
+          queryGeneration = [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE]
+          subscriptionGeneration = [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE]
         }
       }
-          
+
       const authorizer = BoosterAuthorizer.build(attributes) as ReadModelAuthorizer
       config.readModels[readModelClass.name] = {
         class: readModelClass,
         properties: getClassMetadata(readModelClass).fields,
         authorizer,
         before: attributes.before ?? [],
-        graphqlQueryGenerationConfig: graphQLQueryConfiguration,
-        graphqlSubscriptionGenerationConfig: graphQLSubscriptionConfiguration,
+        queryGeneration,
+        subscriptionGeneration,
       }
     })
   }

packages/framework-core/src/services/graphql/common.ts

@@ -6,6 +6,8 @@ import {
   GraphQLOperation,
   ReadModelInterface,
   ContextEnvelope,
+  BoosterConfig,
+  GenerationStrategy,
 } from '@boostercloud/framework-types'
 import {
   GraphQLEnumType,
@@ -88,6 +90,28 @@ export const buildGraphqlSimpleEnumFor = (enumName: string, values: Array<string
   })
 }
 
+export const filterReadModelsThatRequireGraphQLQueries = (
+  readModels: AnyClass[],
+  config: BoosterConfig
+): AnyClass[] => {
+  return readModels.filter((readModel) => {
+    const graphqlQueryGenerationConfig = config.readModels[readModel.name]?.queryGeneration
+    if (!graphqlQueryGenerationConfig) return config.enableAutomaticGraphQLQueryGenerationFromReadModels
+    return graphqlQueryGenerationConfig.includes(GenerationStrategy.GRAPHQL_LIST)
+  })
+}
+
+export const filterReadModelsThatRequireGraphQLSubscriptions = (
+  readModels: AnyClass[],
+  config: BoosterConfig
+): AnyClass[] => {
+  return readModels.filter((readModel) => {
+    const graphqlSubscriptionGenerationConfig = config.readModels[readModel.name]?.subscriptionGeneration
+    if (!graphqlSubscriptionGenerationConfig) return config.enableAutomaticGraphQLQueryGenerationFromReadModels
+    return graphqlSubscriptionGenerationConfig.includes(GenerationStrategy.GRAPHQL_LIST)
+  })
+}
+
 export function nonExcludedFields(
   fields: Array<PropertyMetadata>,
   excludeProps?: Array<string>

packages/framework-core/src/services/graphql/graphql-subcriptions-generator.ts

@@ -1,5 +1,5 @@
 import { GraphQLFieldConfigMap, GraphQLID, GraphQLInputObjectType, GraphQLNonNull, GraphQLObjectType } from 'graphql'
-import { ResolverBuilder } from './common'
+import { filterReadModelsThatRequireGraphQLSubscriptions, ResolverBuilder } from './common'
 import { GraphQLTypeInformer } from './graphql-type-informer'
 import * as inflected from 'inflected'
 import { AnyClass, BoosterConfig } from '@boostercloud/framework-types'
@@ -24,8 +24,12 @@ export class GraphQLSubscriptionGenerator {
   }
 
   public generate(): GraphQLObjectType | undefined {
-    const byIDSubscriptions = this.generateByIDSubscriptions()
-    const filterSubscriptions = this.generateFilterSubscriptions()
+    const readModelsRequiringSubscriptionGeneration = filterReadModelsThatRequireGraphQLSubscriptions(
+      this.readModels,
+      this.config
+    )
+    const byIDSubscriptions = this.generateByIDSubscriptions(readModelsRequiringSubscriptionGeneration)
+    const filterSubscriptions = this.generateFilterSubscriptions(readModelsRequiringSubscriptionGeneration)
     const fields = { ...byIDSubscriptions, ...filterSubscriptions }
     if (Object.keys(fields).length === 0) {
       return undefined
@@ -36,9 +40,9 @@ export class GraphQLSubscriptionGenerator {
     })
   }
 
-  private generateByIDSubscriptions(): GraphQLFieldConfigMap<any, any> {
+  private generateByIDSubscriptions(readModels: AnyClass[]): GraphQLFieldConfigMap<any, any> {
     const subscriptions: GraphQLFieldConfigMap<any, any> = {}
-    for (const readModel of this.readModels) {
+    for (const readModel of readModels) {
       const excludeProps = this.config.nonExposedGraphQLMetadataKey[readModel.name]
       const graphQLType = this.typeInformer.generateGraphQLTypeForClass(readModel, excludeProps)
       subscriptions[readModel.name] = {
@@ -53,9 +57,9 @@ export class GraphQLSubscriptionGenerator {
     return subscriptions
   }
 
-  private generateFilterSubscriptions(): GraphQLFieldConfigMap<any, any> {
+  private generateFilterSubscriptions(readModels: AnyClass[]): GraphQLFieldConfigMap<any, any> {
     const subscriptions: GraphQLFieldConfigMap<any, any> = {}
-    for (const readModel of this.readModels) {
+    for (const readModel of readModels) {
       const excludeProps = this.config.nonExposedGraphQLMetadataKey[readModel.name]
       const graphQLType = this.typeInformer.generateGraphQLTypeForClass(readModel, excludeProps)
       subscriptions[inflected.pluralize(readModel.name)] = {

packages/framework-core/src/services/graphql/query-generators/graphql-query-by-keys-generator.ts

@@ -1,5 +1,5 @@
 import { GraphQLFieldConfig, GraphQLFieldConfigMap, GraphQLID, GraphQLList, GraphQLNonNull } from 'graphql'
-import { GraphQLResolverContext, ResolverBuilder } from '../common'
+import { filterReadModelsThatRequireGraphQLQueries, GraphQLResolverContext, ResolverBuilder } from '../common'
 import { AnyClass, BoosterConfig } from '@boostercloud/framework-types'
 import { GraphQLTypeInformer } from '../graphql-type-informer'
 
@@ -13,7 +13,7 @@ export class GraphqlQueryByKeysGenerator {
 
   public generateByKeysQueries(): GraphQLFieldConfigMap<unknown, GraphQLResolverContext> {
     const queries: GraphQLFieldConfigMap<unknown, GraphQLResolverContext> = {}
-    const readModelsThatRequireGraphQLQueries = this.filterReadModelsThatRequireGraphQLQueries(this.readModels, this.config);
+    const readModelsThatRequireGraphQLQueries = filterReadModelsThatRequireGraphQLQueries(this.readModels, this.config)
 
     for (const readModel of readModelsThatRequireGraphQLQueries) {
       const readModelName = readModel.name
@@ -27,13 +27,6 @@ export class GraphqlQueryByKeysGenerator {
     return queries
   }
 
-  private filterReadModelsThatRequireGraphQLQueries(readModels: any[], config: any): any[] {
-    return readModels.filter((readModel) => {
-      const graphqlQueryGenerationConfig = config.readModels[readModel.name].graphqlQueryGenerationConfig;
-      return graphqlQueryGenerationConfig === 'GRAPHQL_LIST_AND_SINGLE_QUERIES' || graphqlQueryGenerationConfig === 'GRAPHQL_SINGLE_QUERY';
-    });
-  }
-
   private generateByIdQuery(readModel: AnyClass): GraphQLFieldConfig<unknown, GraphQLResolverContext> {
     const graphQLType = this.typeInformer.generateGraphQLTypeForClass(
       readModel,

packages/framework-core/src/services/graphql/query-generators/graphql-query-listed-generator.ts

@@ -7,7 +7,7 @@ import {
   GraphQLNonNull,
   GraphQLObjectType,
 } from 'graphql'
-import { GraphQLResolverContext, ResolverBuilder } from '../common'
+import { filterReadModelsThatRequireGraphQLQueries, GraphQLResolverContext, ResolverBuilder } from '../common'
 import * as inflected from 'inflected'
 import { GraphQLJSON } from 'graphql-scalars'
 
@@ -37,7 +37,7 @@ export class GraphqlQueryListedGenerator {
 
   public generateListedQueries(): GraphQLFieldConfigMap<unknown, GraphQLResolverContext> {
     const queries: GraphQLFieldConfigMap<unknown, GraphQLResolverContext> = {}
-    const readModelsThatRequireGraphQLQueries = this.filterReadModelsThatRequireGraphQLQueries(this.readModels, this.config);
+    const readModelsThatRequireGraphQLQueries = filterReadModelsThatRequireGraphQLQueries(this.readModels, this.config)
     for (const readModel of readModelsThatRequireGraphQLQueries) {
       const excludeProp = this.config.nonExposedGraphQLMetadataKey[readModel.name]
       const graphQLType = this.typeInformer.generateGraphQLTypeForClass(readModel, excludeProp)
@@ -59,13 +59,6 @@ export class GraphqlQueryListedGenerator {
     return queries
   }
 
-  private filterReadModelsThatRequireGraphQLQueries(readModels: any[], config: any): any[] {
-    return readModels.filter((readModel) => {
-      const graphqlQueryGenerationConfig = config.readModels[readModel.name].graphqlQueryGenerationConfig;
-      return graphqlQueryGenerationConfig === 'GRAPHQL_LIST_AND_SINGLE_QUERIES' || graphqlQueryGenerationConfig === 'GRAPHQL_LIST_QUERY';
-    });
-  }
-
   private generateListedQueriesFields(
     name: string,
     type: AnyClass,

packages/framework-core/test/booster-read-models-reader.test.ts

@@ -3,6 +3,7 @@ import { expect } from './expect'
 import {
   BoosterConfig,
   FilterFor,
+  GenerationStrategy,
   GraphQLOperation,
   InvalidParameterError,
   NotAuthorizedError,
@@ -69,12 +70,16 @@ describe('BoosterReadModelReader', () => {
         authorizer: BoosterAuthorizer.authorizeRoles.bind(null, [UserRole]),
         properties: [],
         before: [],
+        queryGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
+        subscriptionGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
       }
       config.readModels[SequencedReadModel.name] = {
         class: SequencedReadModel,
         authorizer: BoosterAuthorizer.authorizeRoles.bind(null, [UserRole]),
         properties: [],
         before: [],
+        queryGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
+        subscriptionGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
       }
     })
 
@@ -262,6 +267,8 @@ describe('BoosterReadModelReader', () => {
         authorizer: BoosterAuthorizer.authorizeRoles.bind(null, [UserRole]),
         properties: [],
         before: [],
+        queryGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
+        subscriptionGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
       }
     })
 
@@ -358,6 +365,8 @@ describe('BoosterReadModelReader', () => {
           authorizer: BoosterAuthorizer.authorizeRoles.bind(null, [UserRole]),
           properties: [],
           before: [],
+          queryGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
+          subscriptionGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
         }
         migratorStub = stub(ReadModelSchemaMigrator.prototype, 'migrate')
       })
@@ -529,6 +538,8 @@ describe('BoosterReadModelReader', () => {
             authorizer: BoosterAuthorizer.authorizeRoles.bind(null, [UserRole]),
             properties: [],
             before: [fakeBeforeFn],
+            queryGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
+            subscriptionGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
           }
 
           replace(Booster, 'config', config) // Needed because the function `Booster.readModel` references `this.config` from `searchFunction`
@@ -564,6 +575,8 @@ describe('BoosterReadModelReader', () => {
             authorizer: BoosterAuthorizer.authorizeRoles.bind(null, [UserRole]),
             properties: [],
             before: [beforeFnSpy, beforeFnV2Spy],
+            queryGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
+            subscriptionGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
           }
 
           replace(Booster, 'config', config) // Needed because the function `Booster.readModel` references `this.config` from `searchFunction`
@@ -610,6 +623,8 @@ describe('BoosterReadModelReader', () => {
             authorizer: BoosterAuthorizer.authorizeRoles.bind(null, [UserRole]),
             properties: [],
             before: [],
+            queryGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
+            subscriptionGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
           }
 
           replace(config.provider.readModels, 'subscribe', providerSubscribeFunctionFake)
@@ -643,6 +658,8 @@ describe('BoosterReadModelReader', () => {
             authorizer: BoosterAuthorizer.authorizeRoles.bind(null, [UserRole]),
             properties: [],
             before: [beforeFn, beforeFnV2],
+            queryGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
+            subscriptionGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
           }
 
           replace(config.provider.readModels, 'subscribe', providerSubscribeFunctionFake)

packages/framework-core/test/decorators/read-model.test.ts

@@ -54,6 +54,8 @@ describe('the `ReadModel` decorator', () => {
             },
           },
         ],
+        queryGeneration: [0, 1],
+        subscriptionGeneration: [0, 1],
       })
     })
   })
@@ -156,6 +158,8 @@ describe('the `ReadModel` decorator', () => {
             },
           },
         ],
+        queryGeneration: [0, 1],
+        subscriptionGeneration: [0, 1],
       })
     })
   })

packages/framework-core/test/services/read-model-store.test.ts

@@ -6,6 +6,7 @@ import { createInstance } from '@boostercloud/framework-common-helpers'
 import {
   BoosterConfig,
   EntitySnapshotEnvelope,
+  GenerationStrategy,
   Level,
   OptimisticConcurrencyUnexpectedVersionError,
   ProjectionMetadata,
@@ -115,12 +116,16 @@ describe('ReadModelStore', () => {
     authorizer: BoosterAuthorizer.allowAccess,
     properties: [],
     before: [],
+    queryGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
+    subscriptionGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
   }
   config.readModels[AnotherReadModel.name] = {
     class: AnotherReadModel,
     authorizer: BoosterAuthorizer.allowAccess,
     properties: [],
     before: [],
+    queryGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
+    subscriptionGeneration: [GenerationStrategy.GRAPHQL_LIST, GenerationStrategy.GRAPHQL_SINGLE],
   }
   config.projections[AnImportantEntity.name] = [
     {