Deprecates the StructuredService framework and provides a replacement using plain Controllers. #855
Conversation
This file contains 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
Using the annotations @publicservice or @InternalService, one can define that a route is considered a service call with a certain response format. Previously this was done using Routed.jsonCall. We now use extra annotations to support XML as additional format. Using @publicservice also provides the benefit of self-documentation as these services are listed in the Public API explorer.
If the response is already committed, we do not need to care about the HTTP code, we simply have to submit an error so that the underlying channel is closed. Also, if the response for a service call was already commited as the internal buffer is full, we can no longer report and error. This (edge) case is now logged at least to support debugging.
qw3ry
reviewed
Jun 21, 2021
| */ | ||
| public List<PublicApiInfo> getApis() { | ||
| synchronized (apis) { | ||
| return new ArrayList<>(apis); |
There was a problem hiding this comment.
We need to copy because of threading issues - the copy doesn't need to be unmodifyable as it is unused elsewhere..
| if (apiInfo == null) { | ||
| apiInfo = buildApiInfo(publicService.apiName(), route); | ||
| apis.add(apiInfo); | ||
| apis.sort(Comparator.comparing(PublicApiInfo::getPriority).thenComparing(PublicApiInfo::getApiName)); |
There was a problem hiding this comment.
If you'd make apis a TreeSet it takes care of the order by itself, but it's fine like that as well
| Watch w = Watch.start(); | ||
|
|
||
| CommandParser parser = new CommandParser(webContext.require("command").asString()); | ||
| if (Strings.isEmpty(parser.parseCommand())) { |
There was a problem hiding this comment.
parse command is a noop the 2nd and 3rd call...
sabieber
requested changes
Jun 21, 2021
sabieber
requested changes
Jun 21, 2021
idlira
approved these changes
Jun 21, 2021
andyHa
added
the
💣 BREAKING CHANGE
Co-authored-by: Matthias Keck <60612914+mkeckmkeck@users.noreply.github.com>
Co-authored-by: Matthias Keck <60612914+mkeckmkeck@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This contains some internal breaking changes as i.e. the API of Intereptor has changed.
Public API Explorer
Also, we now detect and show all recognized public APIs:
Migrating Services
Migrating from StructuredService(s) to the new API is as simple as moving the call(..) method into a Controller and replacing the ServiceCall parameter by WebContext and the StructuredOutput by either JSONStructuredOutput or XMLStructuredOutput (depending on the format). Finally either a @InternalService or @publicservice annotation has to be added to the method.