include Playground IDE in graphql-kotlin-spring-server #377

aarestu · 2019-09-25T19:19:26Z

📝 Description

Make initialize project more simple by making playground service by default include in module graphql-kotlin-spring-server
Make service playground be adjustable can be [enable/disable] and where endpoint service will use

codecov-io · 2019-09-25T19:46:32Z

Codecov Report

Merging #377 into master will increase coverage by 1.84%.
The diff coverage is 83.33%.

@@             Coverage Diff              @@
##             master     #377      +/-   ##
============================================
+ Coverage     95.76%   97.61%   +1.84%     
+ Complexity      347      318      -29     
============================================
  Files            98      104       +6     
  Lines          1205     1215      +10     
  Branches        213      198      -15     
============================================
+ Hits           1154     1186      +32     
+ Misses           11        9       -2     
+ Partials         40       20      -20

Impacted Files	Coverage Δ	Complexity Δ
...iagroup/graphql/spring/GraphQLAutoConfiguration.kt	`87.5% <ø> (ø)`	`6 <0> (ø)`	⬇️
...p/graphql/spring/GraphQLConfigurationProperties.kt	`100% <100%> (ø)`	`3 <0> (ø)`	⬇️
...roup/graphql/spring/PlaygroundAutoConfiguration.kt	`75% <75%> (ø)`	`2 <2> (?)`
.../expediagroup/graphql/generator/SchemaGenerator.kt	`100% <0%> (ø)`	`23% <0%> (ø)`	⬇️
...group/graphql/exceptions/InvalidSchemaException.kt
.../extensions/GraphQLDirectiveContainerExtensions.kt	`100% <0%> (ø)`	`0% <0%> (?)`
...graphql/federation/validation/validateDirective.kt	`90.9% <0%> (ø)`	`0% <0%> (?)`
...aphql/federation/validation/validateKeySetField.kt	`100% <0%> (ø)`	`0% <0%> (?)`
...federation/validation/validateProvidesDirective.kt	`100% <0%> (ø)`	`0% <0%> (?)`
... and 10 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7f2214c...e812918. Read the comment docs.

smyrick · 2019-09-25T20:44:53Z

examples/spring/src/main/resources/application.yml

+
+  playground:
+    enabled: true
+    endpoint: "/"


We would also need to set the urls in the Playground html file. Not sure how we do this dynamically the best way

graphql-kotlin/examples/spring/src/main/resources/graphql-playground.html

Lines 52 to 55 in 7f2214c

GraphQLPlayground.init(document.getElementById('root'), {

endpoint: '/graphql',

subscriptionEndpoint: '/subscriptions'

})

Ahh graphql-spqr solves this issue like so. If we added that I think we can merge this

https://github.com/leangen/graphql-spqr-spring-boot-starter/blob/787041aff9ab1a87164f034ecd443e638f0febfb/graphql-spqr-spring-boot-autoconfigure/src/main/java/io/leangen/graphql/spqr/spring/web/GuiController.java#L25-L28

@smyrick
Ahh, sorry I forgot to add that.
copy -> paste -> done :D

lets change the default to /playground to avoid potential conflicts

alright @dariuszkuc
wait

Right now implementing (in progress) Graphql and Altair.. should I merge with this branch..
@dariuszkuc @smyrick

graphql: ide: - playground: enabled: true endpoin: "/playground" - graphiql: enabled: true endpoin: "/graphiql" - altair: enabled: true endpoin: "/altair"

No need for graphiql or altair. Lets be opinionated and include just playground. Can you fix the Javadocs on the PlaygroundConfigurationProperties (currently javadoc is specified on enabled instead of endpoint)?

alright then.
oke wait

dariuszkuc · 2019-09-25T21:52:21Z

While Prisma GraphQL Playground is indeed very useful it is not required to start a valid GraphQL server. There are also a number of other IDEs that could be preferred to use instead such as GraphiQL or Altair. Therefore I am not sure whether we should be including it.

aarestu · 2019-09-26T00:58:36Z

While Prisma GraphQL Playground is indeed very useful it is not required to start a valid GraphQL server. There are also a number of other IDEs that could be preferred to use instead such as GraphiQL or Altair. Therefore I am not sure whether we should be including it.

hmmm, do we need to make separate module like SPQR do for this?

dariuszkuc · 2019-09-26T01:05:10Z

...spring-server/src/main/kotlin/com/expediagroup/graphql/spring/PlaygroundAutoConfiguration.kt

+    fun playGroundRoute() = coRouter {
+        GET(config.playground.endpoint) {
+            ok().html().bodyAndAwait(
+                playgroundHtml.file.readText()


if we are to do this then this should be done only once and not on every route hit

Ahhh I understand, wait I can solve this

graphql-kotlin-spring-server/src/main/resources/graphql-playground.html

…once

...ing-server/src/main/kotlin/com/expediagroup/graphql/spring/GraphQLConfigurationProperties.kt

...spring-server/src/main/kotlin/com/expediagroup/graphql/spring/PlaygroundAutoConfiguration.kt

dariuszkuc · 2019-09-26T01:56:13Z

...ing-server/src/main/kotlin/com/expediagroup/graphql/spring/GraphQLConfigurationProperties.kt

+ * Play ground configuration properties.
+ */
+class PlayGroundConfigurationProperties {
+    /** playground service endpoint, defaults to '/' */


this comment should be on endpoint I believe. Let's make it explicit -> Prisma Labs Playground GraphQL IDE endpoint, defaults to "/"

aarestu · 2019-09-26T01:59:44Z

wait The Travis CI was failed what happened?
@dariuszkuc @smyrick

travis CI can't found file inside:
graphql-kotlin-spring-server-1.0.0-RC11-SNAPSHOT.jar!/graphql-playground.html

and return coRouter from inside reader

…conflicts

) Include [Prisma Labs Playground IDE](https://github.com/prisma-labs/graphql-playground) in `graphql-kotlin-spring-server` auto-configuration library. By default, playground will be enabled under `/playground` route. You can disable it by specifying `graphql.playground.enabled=false` property. Similarly default endpoint can be changed by setting new value to the `graphql.playground.endpoint` property.

aarestu added 2 commits September 26, 2019 02:07

make auto config route playground

1731f50

reformat code

437dc63

smyrick reviewed Sep 25, 2019

View reviewed changes

smyrick added changes: patch Changes require a patch version type: enhancement New feature or request labels Sep 25, 2019

Playground html: make graphql/websocket endpoint url dynamic

fe309e2

dariuszkuc reviewed Sep 26, 2019

View reviewed changes

graphql-kotlin-spring-server/src/main/resources/graphql-playground.html Outdated Show resolved Hide resolved

aarestu added 2 commits September 26, 2019 08:14

rename subscriptionsEndpoint config & build body playgroundHtml only …

a4bb7bc

…once

init body playgroundHtml inside function playGroundRoute

62be0bb

dariuszkuc reviewed Sep 26, 2019

View reviewed changes

...ing-server/src/main/kotlin/com/expediagroup/graphql/spring/GraphQLConfigurationProperties.kt Outdated Show resolved Hide resolved

dariuszkuc reviewed Sep 26, 2019

View reviewed changes

...spring-server/src/main/kotlin/com/expediagroup/graphql/spring/PlaygroundAutoConfiguration.kt Outdated Show resolved Hide resolved

dariuszkuc reviewed Sep 26, 2019

View reviewed changes

aarestu added 7 commits September 26, 2019 09:07

rename Playground and keep the same naming

9f6cc78

read graphql-playground.html from inputstream

c49d9ba

use function bufferedReader for read inputStream and replace content

1b9d2ab

use function bufferedReader for read inputStream and replace content

1d43a3b

and return coRouter from inside reader

make sure bufferedReader closed

dd3d1bf

change default path playground ide to /playground to avoid potential …

7cfe98c

…conflicts

update javadocs

e812918

dariuszkuc approved these changes Sep 26, 2019

View reviewed changes

dariuszkuc changed the title ~~[Proposal] Playground service~~ include Playground IDE in graphql-kotlin-spring-server Sep 26, 2019

dariuszkuc merged commit b02bc91 into ExpediaGroup:master Sep 26, 2019

aarestu deleted the feature/auto-config-playground-route branch September 26, 2019 15:30

aarestu mentioned this pull request Sep 27, 2019

remove playground route configuration in example #387

Merged

	GraphQLPlayground.init(document.getElementById('root'), {
	endpoint: '/graphql',
	subscriptionEndpoint: '/subscriptions'
	})

include Playground IDE in graphql-kotlin-spring-server #377

include Playground IDE in graphql-kotlin-spring-server #377

Uh oh!

Conversation

aarestu commented Sep 25, 2019

📝 Description

Uh oh!

codecov-io commented Sep 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

smyrick Sep 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

smyrick Sep 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dariuszkuc commented Sep 25, 2019

Uh oh!

aarestu commented Sep 26, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dariuszkuc Sep 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aarestu commented Sep 26, 2019

Uh oh!

Uh oh!

codecov-io commented Sep 25, 2019 •

edited

Loading

smyrick Sep 25, 2019 •

edited

Loading

smyrick Sep 25, 2019 •

edited

Loading

dariuszkuc Sep 26, 2019 •

edited

Loading