Unify API for stanzas #3814
Merged
Unify API for stanzas #3814
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
Codecov ReportBase: 83.03% // Head: 83.01% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #3814 +/- ##
==========================================
- Coverage 83.03% 83.01% -0.03%
==========================================
Files 529 528 -1
Lines 33886 33822 -64
==========================================
- Hits 28138 28076 -62
+ Misses 5748 5746 -2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
chrzaszcz
force-pushed
the
api-module-rework
branch
from
9cccf4e
to
25da911
Compare
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
api-module-rework
branch
from
25da911
to
689ad91
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
api-module-rework
branch
from
163bde2
to
d1f6c81
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
api-module-rework
branch
from
48a5bba
to
8cca662
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
api-module-rework
branch
from
f78be93
to
27bcfdd
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
api-module-rework
branch
from
27bcfdd
to
e27870e
Compare
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
api-module-rework
branch
from
e27870e
to
8cbd065
Compare
- Move functions from mongoose_stanza_helper, because there is no need for two separate modules here. - Perform a fold over individual steps to organize error handling. The 'fold' function can be later reused, and moved e.g. to mongoose_api_common. - Handle more error cases, that were caught only by graphql-specific code. Now the REST api handles them as well. - Allow stanza without 'from' when 'user' is known. 'from' is set to the user JID later in the routing process anyway. - Use Stanza ID not only for REST. MAM ID was used for GraphQL. We can add MAM ID as a separate GraphQL field when needed. - Set Stanza ID if the stanza does not already have one - this is similar to the behaviour for messages. - Do not treat 0 and <<>> values as undefined - this is a bit unexpected, and now in the unified API the user can always omit them when needed. - Set correct max_result_limit - previously it was set to 1.
- Call the new API, which makes it possible to ged rid of some checks. - Remove unused helper functions. - Make format_error/2 more flexible.
- The new API makes it possible to avoid some checks
chrzaszcz
force-pushed
the
api-module-rework
branch
from
8cbd065
to
a29930d
Compare
This comment was marked as outdated.
This comment was marked as outdated.
- The Id is a stanza Id now. - It is possible to send a stanza with predefined Id and/or without 'from'. - Update error messages.
- Update error messages - Test getting messages for a non-existent user
chrzaszcz
force-pushed
the
api-module-rework
branch
from
a29930d
to
4c81efb
Compare
This comment was marked as outdated.
This comment was marked as outdated.
| get_id(Stanza) -> | ||
| exml_query:attr(Stanza, <<"id">>, undefined). | ||
|
|
||
| fold({_, _} = Result, _) -> |
There was a problem hiding this comment.
I really enjoyed reading this fragment of code 😄
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.
The main goal is to make
mongoose_stanza_api:{ok, Result}or{ErrorReasonAtom, ErrorMsg}like the remaining API modules.Functional changes
0and<<>>values as undefined - this was a bit unexpected, and now in the unified API the user can always omit them when needed.max_result_limit- previously it was set to 1.mod_mam_pmbefore querying the last messages with GraphQL. This is not done for REST, as we don't have a simple way to do it. We are not developing REST further anyway.Refactoring notes
mongoose_stanza_api. We could reuse it in other modules as well (by moving to a separate module later on), but I don't want to force it. Anyway, thefoldfunction, which has all the logic, is very simple. The advantages are steps reusability (even between API's in the future), and readability (the happy path is easy to follow).