Repository navigation
Conversation
Motivation: There was no Pekko HTTP 1.x to 2.x migration guide, so users had no single place to review new settings and changed defaults in the reference.conf files when upgrading. Modification: Add migration-guide-1.x-2.x.md with a Configuration Changes section covering changed default values, removed settings and new settings, grouped by module, with links to the originating PRs and the relevant docs pages. Link it from the migration guide index. Result: Users migrating from Pekko HTTP 1.x to 2.x can review the configuration changes in one place. Tests: - sbt docs/paradox References: None - sourced from diffing reference.conf files between the 1.4.x and main branches
…ion page Motivation: The configuration page said modules other than core, routing, caching and cors have no configuration, but pekko-http-jackson, pekko-http-jackson3 and pekko-http-testkit all ship a reference.conf. Modification: Add snippets of those reference.conf files to configuration.md. Result: The configuration reference covers every module with settings. Tests: - sbt docs/paradox References: None
Motivation: A review of the 1.x to 2.x migration guide and the pages it links to found inaccuracies, missing migration notes and broken links. Modification: - Add a General changes section to the migration guide (minimum Pekko, Java and Scala versions, removed deprecated code, Java DSL Duration return types, Jackson 3 module). - Correct how pekko.http.server.preview.enable-http2 interacts with pekko.http.server.enable-http2, and note that the RST_STREAM throttle fails connections that exceed the limit. - Note that browser WebSocket connections are compressed by default and that the new chunk and part count limits may need raising. - Note that pekko.http.testkit.routes.timeout applies to the Scala testkit, link it from the testkit page and fix a typo there. - Fix testkit example links that pointed at non-existent akka paths. - Remove a leftover TODO from the Java marshalling docs that linked to a non-existent pekko-http issue (it referred to akka/akka-http#1367). - Document max-chunk-count in reference.conf. Result: The migration guide and the linked pages are accurate and the source links resolve. Tests: - sbt docs/paradox - docs/paradoxValidateInternalLinks reports the same 19 errors as main, none in changed files References: None
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
There was no Pekko HTTP 1.x to 2.x migration guide, so users had no single place to review new settings and changed defaults in the
reference.conffiles when upgrading. This is the pekko-http equivalent of apache/pekko#3513.Modification
Add
migration-guide/migration-guide-1.x-2.x.md, linked from the migration guide index, with a "Configuration Changes in Pekko HTTP 2.x" section based on diffing allsrc/main/resources/reference.conffiles between the1.2.x/1.4.xandmainbranches. It covers:pekko.http.server.enable-http2,pekko.http.server.preview.enable-http2,pekko.http.server.http2.frame-type-throttle.frame-types)pekko.http.server.remote-address-header)Settings added in recent 1.x releases (1.3.0 and 1.4.1) are included too, with a note of the release that introduced them, for users upgrading from older 1.x versions.
The guide also has a "General changes" section (minimum Pekko/Java/Scala versions, removed deprecated code, Java DSL
Durationreturn types, Jackson 3).Related fixes:
configuration.mdnow shows thereference.confofpekko-http-jackson,pekko-http-jackson3andpekko-http-testkit, which it previously said had no configuration.routing-dsl/testkit.md: fix the examples links that pointed at non-existentakka/...source paths, fix a typo, and mentionpekko.http.testkit.routes.timeout.common/marshalling.md: remove a leftover TODO that linked to a non-existent pekko-http issue (it referred to Fix marshalling docs for Java akka/akka-http#1367).reference.conf: documentpekko.http.parsing.max-chunk-count.Result
Users migrating from Pekko HTTP 1.x to 2.x can review the configuration changes in one place.
Tests
sbt docs/paradoxsbt docs/paradoxValidateInternalLinksreports the same 19 errors asmain, none in changed filesReferences
reference.conffiles between the1.2.x,1.4.xandmainbranches