chore(sdl): codemod it all #6228

mattkrick · 2022-03-18T03:11:13Z

This moves graphql/intranetSchema to graphql/private.

It refactors all the objects to SDL-driven development.
It's big, but half of the changes are deletions. The other half are generated, no need to read through the resolve functions, they haven't changed a bit (except for the type errors that this caught 🎉 )

You can learn more here: https://www.loom.com/share/10ffe21d92014cb6b82f7d8aeb435516

TEST

Goto /admin/graphql and query something on the private schema. it works

mattkrick · 2022-03-18T23:35:10Z

packages/server/graphql/private/mutations/addNewFeature.ts

+      reject(e)
+    })
+  })
+  return {newFeature}


already paying off! the old resolve function wasn't returning anything and the new type caught the error 🎉

mattkrick · 2022-03-18T23:37:33Z

packages/server/graphql/private/resolvers.ts

+  return collector
+}
+
+const resolverMap: Resolvers = {


we'll never have to touch this file again, everything is automatically imported 🎉

mattkrick · 2022-03-18T23:37:43Z

packages/server/graphql/private/rootSchema.ts

+  path.join(__PROJECT_ROOT__, 'packages/server/graphql/private/typeDefs/*.graphql')
+)
+
+const schema = makeExecutableSchema({typeDefs, resolvers})


we'll never have to touch this file again, everything is automatically imported 🎉

mattkrick · 2022-03-18T23:38:41Z

packages/server/graphql/private/types/DraftEnterpriseInvoicePayload.ts

@@ -0,0 +1,15 @@
+import {DraftEnterpriseInvoicePayloadResolvers} from '../resolverTypes'
+
+export type DraftEnterpriseInvoicePayloadSource =


this type has to be manually added & then we have to add it into codegen.json, which isn't great, but it already caught some more type errors

mattkrick · 2022-03-18T23:39:50Z

scripts/codeshift/extractResolver.ts

@@ -0,0 +1,166 @@
+/*
+ Usage: jscodeshift --extensions=tsx,ts,js --parser=tsx -t ./scripts/codeshift/extractResolver.ts ./packages/server/graphql/intranetSchema/queries


i walk through this in the loom video.
it's kinda fun if you like metaprogramming

scripts/codeshift/extractResolver.ts

mattkrick · 2022-03-21T20:40:18Z

@Dschoordsch I experimented with a default mapper being void or never in order to force devs to explicitly write a *Source type definition. Here's my takeaways:

The current behavior has a default type == the GraphQL type. This works great for the following cases:

The return type is a primitive. no mapper is necessary.
The Source type is a superset of the GraphQL type. no mapper is necessary.

Now the cool part is when the Source type is a subset of the GraphQL type, typescript still throws an error.

A good example is user.ts:

the user query returns the type IUser, which comes from postgres
the user query is expected to return the typescript equivalent of /graphql/types/User.ts
Therefore, we get an error because e.g. IUser does not include the field timeline.
to play around with it, remove the User mapper & recompile to see the error showing up

This error forces the developer to add an entry to the codegen#mappers list. there's no implicit any in the logic chain 🎉

mattkrick · 2022-03-21T20:45:22Z

@JimmyLv thought this would be a fun PR for you to review! it's mainly a refactor to make our feature building a little more modern

blimmer · 2022-03-22T16:09:32Z

packages/server/graphql/private/mutations/connectSocket.ts

@@ -0,0 +1,87 @@
+import {InvoiceItemType, SubscriptionChannel} from 'parabol-client/types/constEnums'
+import adjustUserCount from '../../../billing/helpers/adjustUserCount'


Should we consider using a typescript path to make these ../../../ imports simpler to read?

yes, absolutely. in some places we use ~ to mean parabol-client, and in other places we use symlinks via lerna to get to different packages (e.g. parabol-server, parabol-client) but getting vscode, webpack, and typescript to all suggest the same pattern has been a bear. We need to take a fresh look at our configs because there's a devil in one of them...

blimmer · 2022-03-22T16:15:24Z

packages/server/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
+  // "*.{ts,tsx}": 'organize-imports-cli',


Btw, there's a prettier plugin that does this for you if you want to enable it again someday: https://github.com/simonhaenisch/prettier-plugin-organize-imports#readme

ahhh i've gotta try that next time! this one was buggy & slow

blimmer

I didn't review each individual resolver, but this is a great step to further leveraging the modern GraphQL ecosystem!

mattkrick · 2022-03-23T14:32:13Z

@JimmyLv hows the review going? any questions or comments?

This reverts commit a71b95a. The commit breaks the internal resolver.

JimmyLv · 2022-03-25T12:47:11Z

@mattkrick Hey Matt! This is really excellent! I watched the video earlier, to understand the intent behind this.

This is also the first time, I learned how to write a jscodeshift script, understand the magic behind it!
As you mentioned in the loom video, will we move on to the public schema next? what and how different are these folders of public stuff?

mattkrick · 2022-03-28T19:01:42Z

yep, next step is the public schema!
the public schema is about 20x larger than this private schema, so that's why i wanted to make this private schema patterns perfect before we tackle the MASSIVE amount of work in the public schema

JimmyLv · 2022-03-30T12:32:17Z

Makes sense! I believe the jscodeshift for private schema could be adapted to public schema, it would be a lifesaver!

mattkrick added 24 commits March 3, 2022 18:42

feat(ping): try new typed graphql pattern

2fde161

feat(ping) add internal context

48dcc95

fix(ping) add missing paren

9d03215

feat(sdl): require.context whole directories

8f6d827

feat(sdl): move updateEmail to new pattern as example

e477235

feat(sdl): move logins to sdl to explore mappers

6c7eebf

feat(sdl): rename source

aa84a62

feat(sdl): move typeDefs to sdl

07c339d

feat(sdl) move update schema logic

88dc187

feat(sdl) fix include patterns

880c83f

add resolverTypes to gitignore

3f5dbab

ignore resolverTypes

1871697

Merge branch 'master' into feat/4754/pingpongwallawallabingbong

8871bde

feat(ping): make ping more robust

a16684b

feat(sdl): add extractResolver codemod

7c41105

codegen all types in private schema

2b14db0

move non-operations from intranetSchema to private

a39f3b1

first pass at query codemod

e138afc

first pass at queries

4f67990

handle resolve methods

f18ec68

it works on queries!

cb6d423

it works on mutations

a346fb6

remove intranetSchema

ed1265f

fixup draftEnterpriseInvoice

1b64e9b

mattkrick marked this pull request as ready for review March 18, 2022 23:31

reset lint-staged

5c7dbce

mattkrick commented Mar 21, 2022

View reviewed changes

mattkrick mentioned this pull request Mar 21, 2022

More typesafety for GraphQL code #6167

Merged

1 task

mattkrick changed the base branch from master to 5385/template-illustrations March 21, 2022 17:17

mattkrick changed the base branch from 5385/template-illustrations to master March 21, 2022 17:18

mattkrick added 2 commits March 21, 2022 10:32

Merge branch 'master' into chore/jscodeshift

85f0178

fix mapper types

2b7a360

mattkrick requested a review from JimmyLv March 21, 2022 20:43

mattkrick mentioned this pull request Mar 21, 2022

DX(PrivateSchema): separate authorization from resolvers #6248

Closed

2 tasks

blimmer reviewed Mar 22, 2022

View reviewed changes

blimmer approved these changes Mar 22, 2022

View reviewed changes

mattkrick added this to To Prioritize in Sprint Board via automation Mar 24, 2022

mattkrick added 2 commits March 23, 2022 20:39

generate schema first, then resolverTypes

abbb2c7

fix prod.js build

b2967a2

mattkrick merged commit a71b95a into master Mar 24, 2022

mattkrick deleted the chore/jscodeshift branch March 24, 2022 03:48

Dschoordsch added a commit that referenced this pull request Mar 24, 2022

Revert "chore(sdl): codemod it all (#6228)"

4b63660

This reverts commit a71b95a. The commit breaks the internal resolver.

adaniels-parabol mentioned this pull request Mar 25, 2022

Release test 6.51.0 #6276

Closed

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(sdl): codemod it all #6228

chore(sdl): codemod it all #6228

mattkrick commented Mar 18, 2022 •

edited

mattkrick Mar 18, 2022 •

edited

mattkrick Mar 18, 2022

mattkrick Mar 18, 2022

mattkrick Mar 18, 2022

mattkrick Mar 18, 2022

mattkrick commented Mar 21, 2022 •

edited

mattkrick commented Mar 21, 2022

blimmer Mar 22, 2022

mattkrick Mar 22, 2022

blimmer Mar 22, 2022

mattkrick Mar 22, 2022

blimmer left a comment

mattkrick commented Mar 23, 2022

JimmyLv commented Mar 25, 2022

mattkrick commented Mar 28, 2022

JimmyLv commented Mar 30, 2022

		@@ -0,0 +1,15 @@
		import {DraftEnterpriseInvoicePayloadResolvers} from '../resolverTypes'

		export type DraftEnterpriseInvoicePayloadSource =

		@@ -0,0 +1,166 @@
		/*
		Usage: jscodeshift --extensions=tsx,ts,js --parser=tsx -t ./scripts/codeshift/extractResolver.ts ./packages/server/graphql/intranetSchema/queries

		@@ -0,0 +1,87 @@
		import {InvoiceItemType, SubscriptionChannel} from 'parabol-client/types/constEnums'
		import adjustUserCount from '../../../billing/helpers/adjustUserCount'

		@@ -1,4 +1,5 @@
		module.exports = {
		// "*.{ts,tsx}": 'organize-imports-cli',

chore(sdl): codemod it all #6228

chore(sdl): codemod it all #6228

Conversation

mattkrick commented Mar 18, 2022 • edited

mattkrick Mar 18, 2022 • edited

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

mattkrick commented Mar 21, 2022 • edited

mattkrick commented Mar 21, 2022

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

blimmer left a comment

Choose a reason for hiding this comment

mattkrick commented Mar 23, 2022

JimmyLv commented Mar 25, 2022

mattkrick commented Mar 28, 2022

JimmyLv commented Mar 30, 2022

mattkrick commented Mar 18, 2022 •

edited

mattkrick Mar 18, 2022 •

edited

mattkrick commented Mar 21, 2022 •

edited