Fix and improve Spray JSON docs #330

jonas · 2016-09-18T13:47:17Z

CompactPrinter is now the default so change the JSON printer example to mention PrettyPrinter
Replace project version in the SBT snippet.
Reformat Markdown

NOTE: the last point is something we might want to raise upstream in Paradox, to see if we can make it optional whether line breaks are honours in the Markdown rendering. Alternatively, we can reformat all docs to not use new lines inside paragraphs.

akka-ci · 2016-09-18T13:50:03Z

Can one of the repo owners verify this patch?

jonas · 2016-09-18T17:46:56Z

docs/src/test/scala/docs/http/scaladsl/SprayJsonPrettyMarshalSpec.scala


      // format: OFF
      val route =
        get {
          pathSingleSlash {
            complete {
-              // should complete with spray.json.JsValue = {"name":"akka","id":42}
-              CompactPrintedItem("akka", 42) // will render as JSON
+              // should complete with spray.json.JsValue = { "name": "akka", "id": 42 }


Note, I didn't actually test this.

AFAIR pretty is:

{ "name": "akka", "id": 42 }

You can add

Get("/") ~> route ~> check { responseAs[String] shouldEqual """...""" }

Awesome, added a test to the example.

ktoso · 2016-09-19T06:06:40Z

OK TO TEST

ktoso

Good changes overall, thanks. LGTM

ktoso · 2016-09-19T06:05:22Z

docs/src/main/paradox/scala/http/common/json-support.md

+```sbt
+"com.typesafe.akka" %% "akka-http-spray-json-experimental" % "$project.version$"`
+```
+@@@


ktoso · 2016-09-19T06:05:40Z

docs/src/main/paradox/scala/http/common/json-support.md

+
+```scala
+import akka.http.scaladsl.marshallers.sprayjson.SprayJsonSupport._
+```


ktoso · 2016-09-19T06:06:19Z

docs/src/test/scala/docs/http/scaladsl/SprayJsonPrettyMarshalSpec.scala


      // format: OFF
      val route =
        get {
          pathSingleSlash {
            complete {
-              // should complete with spray.json.JsValue = {"name":"akka","id":42}
-              CompactPrintedItem("akka", 42) // will render as JSON
+              // should complete with spray.json.JsValue = { "name": "akka", "id": 42 }


AFAIR pretty is:

{ "name": "akka", "id": 42 }

ktoso · 2016-09-19T06:07:42Z

@akka/akka-http-team, @jrudolph please feel free to LGTM and merge once PR hits 2 LGTMs (anyone within http-team is welcome to do so) :-)

akka-ci · 2016-09-19T06:15:45Z

Test PASSed.

akka-ci · 2016-09-19T18:10:54Z

Test FAILed.

jonas · 2016-09-19T18:20:21Z

The failure looks unrelated:

[info]   - the config setting (chunked entity) *** FAILED ***
[info]     null did not equal EntityStreamSizeException: actual entity size (None) exceeded content length limit (10 bytes)! You can configure this by setting `akka.http.[server|client].parsing.max-content-length` or calling `HttpEntity.withSizeLimit` before materializing the dataBytes stream.,
[info]     inside HttpResponse(200 OK,List(),HttpEntity.Chunked(application/octet-stream),HttpProtocol(HTTP/1.1)) (LowLevelOutgoingConnectionSpec.scala:564)

jypma · 2016-09-19T18:44:49Z

Mmm, we just had the exact same test failure over at #323. Coincidence? I think NOT! :)

jonas · 2016-09-20T10:35:14Z

Is there a way to ask @akka-ci to rebuild?

ktoso · 2016-09-20T18:26:55Z

PLS BUILD

akka-ci · 2016-09-20T18:35:39Z

Test FAILed.

jonas · 2016-09-20T19:01:58Z

Thanks. Now it is failing with the error mentioned in #298:

[info]   - a 200 response to a HEAD request *** FAILED ***
[info]     java.util.concurrent.TimeoutException: Futures timed out after [500 milliseconds]
[info]     at scala.concurrent.impl.Promise$DefaultPromise.ready(Promise.scala:219)
[info]     at scala.concurrent.impl.Promise$DefaultPromise.result(Promise.scala:223)
[info]     at scala.concurrent.Await$$anonfun$result$1.apply(package.scala:190)
[info]     at scala.concurrent.BlockContext$DefaultBlockContext$.blockOn(BlockContext.scala:53)
[info]     at scala.concurrent.Await$.result(package.scala:190)
[info]     at akka.http.impl.engine.parsing.ResponseParserSpec$Test.collectBlocking(ResponseParserSpec.scala:321)

and

[info] - must not reset the connection when no data are flowing and the connection is closed from the client *** FAILED ***
[info]   java.lang.AssertionError: assertion failed: expected OnNext(TextMessage.Strict(hello)), found OnComplete
[info]   at scala.Predef$.assert(Predef.scala:170)
[info]   at akka.testkit.TestKitBase$class.expectMsg_internal(TestKit.scala:388)
[info]   at akka.testkit.TestKitBase$class.expectMsg(TestKit.scala:364)
[info]   at akka.testkit.TestKit.expectMsg(TestKit.scala:814)
[info]   at akka.stream.testkit.TestSubscriber$ManualProbe.expectNext(StreamTestKit.scala:280)
[info]   at akka.http.impl.engine.ws.WebSocketIntegrationSpec$$anonfun$1$$anonfun$apply$mcV$sp$2$$anonfun$apply$3.apply(WebSocketIntegrationSpec.scala:123)
[info]   at akka.http.impl.engine.ws.WebSocketIntegrationSpec$$anonfun$1$$anonfun$apply$mcV$sp$2$$anonfun$apply$3.apply(WebSocketIntegrationSpec.scala:68)
[info]   at akka.stream.testkit.Utils$.assertAllStagesStopped(Utils.scala:25)
[info]   at akka.http.impl.engine.ws.WebSocketIntegrationSpec$$anonfun$1$$anonfun$apply$mcV$sp$2.apply(WebSocketIntegrationSpec.scala:68)
[info]   at akka.http.impl.engine.ws.WebSocketIntegrationSpec$$anonfun$1$$anonfun$apply$mcV$sp$2.apply(WebSocketIntegrationSpec.scala:68)
[info]   ...

ktoso · 2016-09-20T19:23:16Z

That's too tight timeouts IMO,

By default the CompactPrinter is used, so change the example to show how to use the PrettyPrinter.

…kka#318) This allows to use `@@vars` to replace the project version in the SBT snippet.

Paradox currently honours new lines which breaks formatting.

jonas · 2016-09-20T22:43:05Z

Rebased to see if this will trigger a rebuild now that jenkins.akka.io seems more quiet.

akka-ci · 2016-09-20T22:50:49Z

Test PASSed.

jonas · 2016-09-20T22:53:22Z

🎱

ktoso · 2016-09-20T23:56:03Z

LGTM, thanks!

* =doc Use reference-style links for linking to the spray-json site * =doc Create section on changing the JSON format and reflect reality By default the CompactPrinter is used, so change the example to show how to use the PrettyPrinter. * =doc Rewrite the spray-json section to spell out the list of steps (akka#318) This allows to use `@@vars` to replace the project version in the SBT snippet. * =doc Format spray JSON docs on single lines Paradox currently honours new lines which breaks formatting. * =doc Bring back "automatic support for ..." * Verify the pretty printed JSON output

jonas commented Sep 18, 2016

View reviewed changes

ktoso approved these changes Sep 19, 2016

View reviewed changes

akka-ci added validating PR that is currently being validated by Jenkins tested PR that was successfully built and tested by Jenkins and removed validating PR that is currently being validated by Jenkins labels Sep 19, 2016

akka-ci added validating PR that is currently being validated by Jenkins needs-attention Indicates a PR validation failure (set by CI infrastructure) and removed tested PR that was successfully built and tested by Jenkins validating PR that is currently being validated by Jenkins labels Sep 19, 2016

gosubpl mentioned this pull request Sep 20, 2016

=htc FrameOutHandler and FrameEventRenderer as graph stages (#341) #342

Merged

jonas added 4 commits September 20, 2016 18:40

=doc Use reference-style links for linking to the spray-json site

f9798d1

=doc Create section on changing the JSON format and reflect reality

943d566

By default the CompactPrinter is used, so change the example to show how to use the PrettyPrinter.

=doc Rewrite the spray-json section to spell out the list of steps (a…

ac5d0f2

…kka#318) This allows to use `@@vars` to replace the project version in the SBT snippet.

=doc Format spray JSON docs on single lines

590a74e

Paradox currently honours new lines which breaks formatting.

jonas added 2 commits September 20, 2016 18:40

=doc Bring back "automatic support for ..."

8064007

Verify the pretty printed JSON output

360229f

jonas force-pushed the json-support-docs branch from ed8b046 to 360229f Compare September 20, 2016 22:40

akka-ci added validating PR that is currently being validated by Jenkins tested PR that was successfully built and tested by Jenkins and removed needs-attention Indicates a PR validation failure (set by CI infrastructure) validating PR that is currently being validated by Jenkins labels Sep 20, 2016

ktoso merged commit 10b3ca2 into akka:master Sep 20, 2016

jonas deleted the json-support-docs branch September 21, 2016 00:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix and improve Spray JSON docs #330

Fix and improve Spray JSON docs #330

jonas commented Sep 18, 2016 •

edited

Loading

akka-ci commented Sep 18, 2016

jonas Sep 18, 2016

ktoso Sep 19, 2016 •

edited

Loading

aruediger Sep 19, 2016

jonas Sep 19, 2016

ktoso commented Sep 19, 2016

ktoso left a comment

ktoso Sep 19, 2016

ktoso Sep 19, 2016

ktoso Sep 19, 2016 •

edited

Loading

ktoso commented Sep 19, 2016

akka-ci commented Sep 19, 2016

akka-ci commented Sep 19, 2016

jonas commented Sep 19, 2016

jypma commented Sep 19, 2016

jonas commented Sep 20, 2016

ktoso commented Sep 20, 2016

akka-ci commented Sep 20, 2016

jonas commented Sep 20, 2016 •

edited

Loading

ktoso commented Sep 20, 2016

jonas commented Sep 20, 2016

akka-ci commented Sep 20, 2016

jonas commented Sep 20, 2016

ktoso commented Sep 20, 2016

Fix and improve Spray JSON docs #330

Fix and improve Spray JSON docs #330

Conversation

jonas commented Sep 18, 2016 • edited Loading

akka-ci commented Sep 18, 2016

jonas Sep 18, 2016

Choose a reason for hiding this comment

ktoso Sep 19, 2016 • edited Loading

Choose a reason for hiding this comment

aruediger Sep 19, 2016

Choose a reason for hiding this comment

jonas Sep 19, 2016

Choose a reason for hiding this comment

ktoso commented Sep 19, 2016

ktoso left a comment

Choose a reason for hiding this comment

ktoso Sep 19, 2016

Choose a reason for hiding this comment

ktoso Sep 19, 2016

Choose a reason for hiding this comment

ktoso Sep 19, 2016 • edited Loading

Choose a reason for hiding this comment

ktoso commented Sep 19, 2016

akka-ci commented Sep 19, 2016

akka-ci commented Sep 19, 2016

jonas commented Sep 19, 2016

jypma commented Sep 19, 2016

jonas commented Sep 20, 2016

ktoso commented Sep 20, 2016

akka-ci commented Sep 20, 2016

jonas commented Sep 20, 2016 • edited Loading

ktoso commented Sep 20, 2016

jonas commented Sep 20, 2016

akka-ci commented Sep 20, 2016

jonas commented Sep 20, 2016

ktoso commented Sep 20, 2016

jonas commented Sep 18, 2016 •

edited

Loading

ktoso Sep 19, 2016 •

edited

Loading

ktoso Sep 19, 2016 •

edited

Loading

jonas commented Sep 20, 2016 •

edited

Loading