New graphql schema #662

adriangmweb · 2021-03-08T13:55:47Z

Description

Note: This branch has been extended from #616 as the metadata reflection introduced by the TypeScript transformers is necessary. Unfortunately, this has its limitations as stated in #661.

This branch introduces the GraphQL new schema in the core, allowing filtering by more than one property at the same time and by complex properties as well in queries and subscriptions.

Changes

The GraphQL schema now is way more secure and complete, allows complex and multiple filters instead of just one basic one. Also, the filter API is way more user-friendly.

Checks

Project Builds
Project passes tests and checks
Updated documentation accordingly

Additional information

This PR solves: #600 #602 and also #603

Due to a DynamoDB limitation, the schema has to make use of generic GraphQLJSONType types, which doesn't give much info to the user and doesn't give us full security when updating types. This also doesn't give us the ability yet to query by properties of a complex property that is inside a List. You can see more information about this limitation here #652

Next steps

Refactor the rest of the providers to use the new GraphQL schema, see #601

juanjoman

LGTM!! Just left some minor questions ✌️

PS: The docs are amazing <3

packages/framework-integration-tests/src/common/address.ts

adrian-lorenzo

LGTM!

NickSeagull

Thanks a lot! Left some suggestions

NickSeagull · 2021-03-24T12:18:58Z

docs/README.md

+
+```graphql
+query {
+  ProductReadModels(filter: { sku: { begingsWith: "jelwery" } }) {


Suggested change

ProductReadModels(filter: { sku: { begingsWith: "jelwery" } }) {

ProductReadModels(filter: { sku: { begingsWith: "jewelry" } }) {

NickSeagull · 2021-03-24T12:20:22Z

docs/README.md

@@ -1582,6 +1582,142 @@ For more information about queries and how to use them, please check the [GraphQ

 Booster GraphQL API also provides support for real-time updates using subscriptions and websocket, to get more information about it go to the [GraphQL API](#subscribing-to-read-models) section.

+#### Filtering a read model
+
+Booster GraphQL API provides support for filtering ReadModels on queries, subscriptions and at code level.


Suggested change

Booster GraphQL API provides support for filtering ReadModels on queries, subscriptions and at code level.

The Booster GraphQL API provides support for filtering Read Models on queries, subscriptions and at code level.

NickSeagull · 2021-03-24T12:20:34Z

docs/README.md

+
+Booster GraphQL API provides support for filtering ReadModels on queries, subscriptions and at code level.
+
+Using the GraphQL API endpoint you can retrieve the schema of your application so you can see what are the filters for every ReadModel and its properties. You can filter like this:


Suggested change

Using the GraphQL API endpoint you can retrieve the schema of your application so you can see what are the filters for every ReadModel and its properties. You can filter like this:

Using the GraphQL API endpoint you can retrieve the schema of your application so you can see what are the filters for every Read Model and its properties. You can filter like this:

NickSeagull · 2021-03-24T12:20:49Z

docs/README.md

+
+Using the GraphQL API endpoint you can retrieve the schema of your application so you can see what are the filters for every ReadModel and its properties. You can filter like this:
+
+Searching for a specific ReadModel by id


Suggested change

Searching for a specific ReadModel by id

Searching for a specific Read Model by `id`

NickSeagull · 2021-03-24T12:21:06Z

docs/README.md

+
+#### Supported filters
+
+The currently supported filters are in the following ones. |


Suggested change

The currently supported filters are in the following ones. |

The currently supported filters are the following ones:

NickSeagull · 2021-03-24T12:23:39Z

docs/README.md

+| and | [Filters] | AND - all filters on the list have a match |
+| or | [Filters] | OR - At least one filter of the list has a match |
+| not | Filter/and/or | The element does not match the filter


This should be formatted probably

NickSeagull · 2021-03-24T12:25:36Z

packages/cli/src/templates/project/package-json.ts

@@ -37,7 +39,7 @@ export const template = `{
  "scripts": {
    "lint:check": "eslint --ext '.js,.ts' **/*.ts",
    "lint:fix": "eslint --quiet --fix --ext '.js,.ts' **/*.ts",
-    "compile": "npx tsc -b tsconfig.json",
+    "compile": "npx ttypescript -b tsconfig.json",


[rant]

Whyyyyyy 😭😭😭😭 Would've been better to use ts-patch...

Anyways, go on... 🥲

[/rant]

I just extended form the existing branch, we'll have plenty of time to change it in the future 🙌🏻

NickSeagull · 2021-03-24T12:26:04Z

packages/framework-core/src/decorators/metadata.ts

-  const propertyTypes = Reflect.getMetadata('design:paramtypes', classType)
-  if (propertyNames.length != propertyTypes.length) {
+  const meta: ClassMetadata = Reflect.getMetadata('booster:typeinfo', classType)
+  if (!meta) {
    // eslint-disable-next-line prettier/prettier


I believe this line is not needed anymore

Suggested change

// eslint-disable-next-line prettier/prettier

NickSeagull · 2021-03-24T12:27:50Z

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

+          ...{
+            type: GraphQLJSONObject,
+          },


Why doing this and not instead:

Suggested change

...{

type: GraphQLJSONObject,

},

type: GraphQLJSONObject,

NickSeagull · 2021-03-24T12:31:31Z

packages/framework-core/src/services/graphql/graphql-type-informer.ts

+  private generateOperationEnumValuesFor(operationsEnum: AnyClass): GraphQLEnumValueConfigMap {
+    const enumValuesConfig: GraphQLEnumValueConfigMap = {}
+    for (const opSymbol in operationsEnum) {
+      const opName = (operationsEnum as any)[opSymbol]


any police 👮🏻‍♂️

What's the contents of operationsEnum? Maybe we can type it in a better way? Can you explain more please?

I didn't create that function, it was added after a rebase, so there isn't much I can tell you here 😅

Ok, keep circulating 👮

boostercloud locked and limited conversation to collaborators Mar 8, 2021

boostercloud unlocked this conversation Mar 8, 2021

This was linked to issues Mar 8, 2021

Migrate aws subscriptions to the new GraphQL filters #602

Closed

Refactor read models subscriptions filter #600

Closed

Document new filter DSL #603

Closed

boostercloud locked and limited conversation to collaborators Mar 9, 2021

boostercloud unlocked this conversation Mar 9, 2021

adriangmweb marked this pull request as ready for review March 9, 2021 17:50

boostercloud locked and limited conversation to collaborators Mar 9, 2021

boostercloud unlocked this conversation Mar 9, 2021

boostercloud locked and limited conversation to collaborators Mar 9, 2021

boostercloud unlocked this conversation Mar 9, 2021

boostercloud locked and limited conversation to collaborators Mar 9, 2021

boostercloud unlocked this conversation Mar 9, 2021

boostercloud locked and limited conversation to collaborators Mar 10, 2021

boostercloud unlocked this conversation Mar 10, 2021

adriangmweb requested a review from a team March 10, 2021 08:59

juanjoman approved these changes Mar 10, 2021

View reviewed changes

packages/framework-integration-tests/src/common/address.ts Show resolved Hide resolved

adriangmweb requested a review from a team March 17, 2021 08:44

adriangmweb force-pushed the new-graphql-schema branch from 2cbf3b6 to ce670f0 Compare March 19, 2021 11:20

boostercloud locked and limited conversation to collaborators Mar 19, 2021

boostercloud unlocked this conversation Mar 19, 2021

adriangmweb force-pushed the new-graphql-schema branch from 300dbca to b671a76 Compare March 19, 2021 18:12

boostercloud locked and limited conversation to collaborators Mar 19, 2021

boostercloud unlocked this conversation Mar 19, 2021

boostercloud locked and limited conversation to collaborators Mar 19, 2021

boostercloud unlocked this conversation Mar 19, 2021

adrian-lorenzo approved these changes Mar 22, 2021

View reviewed changes

NickSeagull requested changes Mar 24, 2021

View reviewed changes

adriangmweb force-pushed the new-graphql-schema branch from 0636d6b to ef39cf3 Compare March 24, 2021 13:06

adriangmweb added 23 commits March 25, 2021 13:27

fix read-model-pub-sub.ts compatibility

8bec8dd

fix integration tests

0636f54

fix and add more unit tests

052204b

fix unit tests adding canFilter mock

923507f

include filter combinators in query and subscription

5e52175

extract filter property from filters

124c5ee

force array types to Object type to add flexibility

fb72b3d

fix unit tests

7e01969

fix cli tests from extended branch in development

432bb43

fix tsconfig JSON format

a7e556c

fix cross-fetch package version to avoid a breaking change

6e8b79d

fix unit tests after rebase

1735f46

fix dependencies versions and ttsc compiler on cli

11b07c3

fix integration tests

a1291cc

fix cli integration test

fb171cf

update gte and lte filters and fix some typos

153e1c0

remove unnecessary line

383fb79

improve object construction

cd5165b

update package-lock

fffcaf8

rename canFilter function

becec20

remove unnecesario elipsis

d1b56ee

improve array types

d8fa122

add todo for subscriptions

6a904cd

adriangmweb force-pushed the new-graphql-schema branch from ef39cf3 to 6a904cd Compare March 25, 2021 16:16

boostercloud locked and limited conversation to collaborators Mar 25, 2021

boostercloud unlocked this conversation Mar 25, 2021

adriangmweb merged commit 23b4537 into main Mar 25, 2021

adriangmweb deleted the new-graphql-schema branch March 25, 2021 17:17

alvaroloes mentioned this pull request Mar 26, 2021

Revert "Implement optimistic concurrency for read models" #754

Merged

adriangmweb restored the new-graphql-schema branch March 29, 2021 09:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New graphql schema #662

New graphql schema #662

adriangmweb commented Mar 8, 2021 •

edited

Loading

juanjoman left a comment •

edited

Loading

adrian-lorenzo left a comment

NickSeagull left a comment

NickSeagull Mar 24, 2021

NickSeagull Mar 24, 2021

NickSeagull Mar 24, 2021

NickSeagull Mar 24, 2021

NickSeagull Mar 24, 2021

NickSeagull Mar 24, 2021

NickSeagull Mar 24, 2021

adriangmweb Mar 24, 2021

NickSeagull Mar 24, 2021

NickSeagull Mar 24, 2021

NickSeagull Mar 24, 2021

adriangmweb Mar 24, 2021

NickSeagull Mar 24, 2021

	ProductReadModels(filter: { sku: { begingsWith: "jelwery" } }) {
	ProductReadModels(filter: { sku: { begingsWith: "jewelry" } }) {

	Booster GraphQL API provides support for filtering ReadModels on queries, subscriptions and at code level.
	The Booster GraphQL API provides support for filtering Read Models on queries, subscriptions and at code level.


		Booster GraphQL API provides support for filtering ReadModels on queries, subscriptions and at code level.

		Using the GraphQL API endpoint you can retrieve the schema of your application so you can see what are the filters for every ReadModel and its properties. You can filter like this:


		Using the GraphQL API endpoint you can retrieve the schema of your application so you can see what are the filters for every ReadModel and its properties. You can filter like this:

		Searching for a specific ReadModel by id

	Searching for a specific ReadModel by id
	Searching for a specific Read Model by `id`


		#### Supported filters

		The currently supported filters are in the following ones. \|

	The currently supported filters are in the following ones. \|
	The currently supported filters are the following ones:

New graphql schema #662

New graphql schema #662

Conversation

adriangmweb commented Mar 8, 2021 • edited Loading

Description

Changes

Checks

Additional information

Next steps

juanjoman left a comment • edited Loading

Choose a reason for hiding this comment

adrian-lorenzo left a comment

Choose a reason for hiding this comment

NickSeagull left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adriangmweb commented Mar 8, 2021 •

edited

Loading

juanjoman left a comment •

edited

Loading