feat: adapt api v8 changes [WPB-15722] #3288

MohamadJaara · 2025-02-10T08:51:09Z

WPB-15722 [Android] - Adopt API v8 changes in existing endpoints

PR Submission Checklist for internal contributors

The PR Title
- conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
- contains a reference JIRA issue number like SQPIT-764
- answers the question: If merged, this PR will: ... ³
The PR Description
- is free of optional paragraphs and you have filled the relevant parts to the best of your ability

What's new in this PR?

Issues

add the following changes

Removed endpoints in V8

GET /calls/config. Use GET /calls/config/v2 instead. (Do not mind the double versioning. This will be cleaned up as soon as we get to it)
- already used
POST /password-reset/:key. Use POST /password-reset/complete instead.
- not used
POST /onboarding/v3
- not used
PUT /conversations/:cnv. Use PUT /conversations/:domain/:conv/name instead.
- already uesd
PUT /conversations/:cnv/name. Use PUT /conversations/:domain/:conv/name instead.
- already used
- PUT /conversations/:cnv/message-timer. Use /conversations/:domain/:cnv/message-timer instead
  - done
PUT /conversations/:cnv/receit-mode. Use PUT /conversations/:domain/:cnv/receipt-mode instead
- already used
PUT /conversations/:cnv/self. Use /conversations/:domain/:conv/self instead.
- already used
GET /conversations/:cnv/self.
- not used

Changed endpoints in V8

There is a new type of capability in capabilities field for Client: consumable-notifications. This will only show up when using API v7. In the notifications containing the Client structure, this capability will not be visible.
- done
GET /scim/auth-tokens returns an array of ScimTokenInfoitems which now have a (non-optional) additional field: name.
- not used in the app
POST /scim/auth-tokens request has a new optional field: name. If not specified, the name will be set to the ID of the SCIM token by the backend. (Same for scim token info coming back from the server in this or other routes, except on the way back from the server the name field is always set to a value, either user-specified or the UUID, like in get.)
- not used
POST /scim/auth-tokens request has a new optional field: idp id (UUIDv4). If specified, the scim peer will associate with the given idp and share the same user base. If not, the scim peer will provision password-authenticated users. (Same field in idp info coming back from the server in this or other routes; the idp id field may be missing if no idp id was specified).
NOTE: this changes the behavior of a request without idp:
- V1..V7: if there is an idp registered with the team, associate.
- V8 and higher (later, younger): never associate.
- The restriction that you can only have at least one scim token or multiple IdPs configured in one team, but not both, has been lifted: you can now create multiple IdPs, and associate multiple scim tokens with 0 or 1 or the existing idps.
  - not used
The ciphersuite or ciphersuites query parameters were optional before and are required now for the endpoints
- POST /mls/key-packages/claim/{user_domain}/{user} (claim key packages),
  - already required
- DELETE /mls/key-packages/self/{client} (delete key packages),
  - not used
- PUT /mls/key-packages/self/{client} (replace key packages), and
  - already done
- GET /mls/key-packages/self/{client}/count (count key packages).
  - done

Needs releases with:

GitHub link to other pull request

Testing

Test Coverage (Optional)

I have added automated test to this contribution

How to Test

Briefly describe how this change was tested and if applicable the exact steps taken to verify that it works as expected.

Notes (Optional)

Specify here any other facts that you think are important for this issue.

Attachments (Optional)

Attachments like images, videos, etc. (drag and drop in the text box)

PR Post Submission Checklist for internal contributors (Optional)

Wire's Github Workflow has automatically linked the PR to a JIRA issue

PR Post Merge Checklist for internal contributors

If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.

References

https://sparkbox.com/foundry/semantic_commit_messages
https://github.com/wireapp/.github#usage
E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

MohamadJaara · 2025-02-10T08:57:46Z

network/src/commonMain/kotlin/com/wire/kalium/network/api/v0/authenticated/ConversationApiV0.kt

@@ -370,7 +370,7 @@ internal open class ConversationApiV0 internal constructor(
        messageTimer: Long?
    ): NetworkResponse<EventContentDTO.Conversation.MessageTimerUpdate> =
        wrapKaliumResponse {
-            httpClient.put("$PATH_CONVERSATIONS/${conversationId.value}/$PATH_MESSAGE_TIMER") {
+            httpClient.put("$PATH_CONVERSATIONS/${conversationId.domain}/${conversationId.value}/$PATH_MESSAGE_TIMER") {


the change log mentions that the nonqualified will be removed in v8 but checking swagger the qualified one exists since v0 so i just changed it to all versions

github-actions · 2025-02-10T09:00:15Z

Test Results

3 519 tests +4 3 411 ✅ +4 6m 4s ⏱️ +5s
603 suites ±0 108 💤 ±0
603 files ±0 0 ❌ ±0

Results for commit f0e8c18. ± Comparison against base commit a5d42e4.

♻️ This comment has been updated with latest results.

yamilmedina

lgtm !

sonarqubecloud · 2025-02-10T16:30:38Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2025-02-10T16:45:57Z

Bencher Report

Branch	feat/api-v8
Testbed	ubuntu-latest

⚠️ WARNING: No Threshold found!
Without a Threshold, no Alerts will ever be generated.
Latency (nanoseconds (ns))
Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds flag.

Click to view all benchmark results

Benchmark	Latency	microseconds (µs)
com.wire.kalium.benchmarks.logic.CoreLogicBenchmark.createObjectInFiles	📈 view plot ⚠️ NO THRESHOLD	685.12
com.wire.kalium.benchmarks.logic.CoreLogicBenchmark.createObjectInMemory	📈 view plot ⚠️ NO THRESHOLD	340,647.14
com.wire.kalium.benchmarks.persistence.MessagesNoPragmaTuneBenchmark.messageInsertionBenchmark	📈 view plot ⚠️ NO THRESHOLD	1,341,301.73
com.wire.kalium.benchmarks.persistence.MessagesNoPragmaTuneBenchmark.queryMessagesBenchmark	📈 view plot ⚠️ NO THRESHOLD	22,204.47

🐰 View full continuous benchmarking report in Bencher

codecov-commenter · 2025-02-10T17:02:43Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.84%. Comparing base (a5d42e4) to head (f0e8c18).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3288      +/-   ##
===========================================
- Coverage    50.84%   50.84%   -0.01%     
===========================================
  Files         1607     1607              
  Lines        58059    58082      +23     
  Branches      5204     5208       +4     
===========================================
+ Hits         29521    29531      +10     
- Misses       26522    26535      +13     
  Partials      2016     2016

see 11 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

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

datadog-wireapp · 2025-02-10T17:04:00Z

Datadog Report

Branch report: feat/api-v8
Commit report: 80e4a8b
Test service: kalium-jvm

✅ 0 Failed, 3411 Passed, 108 Skipped, 1m 0.69s Total Time

feat: adapt api v8 changes

6465793

github-actions bot assigned MohamadJaara Feb 10, 2025

github-actions bot added 👕 size: S type: feature ✨ labels Feb 10, 2025

tests

6ee2dc5

MohamadJaara changed the title ~~feat: adapt api v8 changes~~ feat: adapt api v8 changes [WPB-15722] Feb 10, 2025

MohamadJaara commented Feb 10, 2025

View reviewed changes

MohamadJaara requested review from yamilmedina and Garzas February 10, 2025 08:58

Merge remote-tracking branch 'origin/develop' into feat/api-v8

8ff9800

yamilmedina approved these changes Feb 10, 2025

View reviewed changes

adapt changes to api making cipher suite mandatory

22a2b1c

github-actions bot added 🚨 Potential breaking changes 👕 size: M and removed 👕 size: S labels Feb 10, 2025

detekt

f0e8c18

vitorhugods approved these changes Feb 11, 2025

View reviewed changes

MohamadJaara added this pull request to the merge queue Feb 11, 2025

Merged via the queue into develop with commit 23e2243 Feb 11, 2025
22 checks passed

MohamadJaara deleted the feat/api-v8 branch February 11, 2025 12:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adapt api v8 changes [WPB-15722] #3288

feat: adapt api v8 changes [WPB-15722] #3288

MohamadJaara commented Feb 10, 2025 •

edited by github-actions bot

Loading

MohamadJaara Feb 10, 2025

github-actions bot commented Feb 10, 2025 •

edited

Loading

yamilmedina left a comment

sonarqubecloud bot commented Feb 10, 2025

github-actions bot commented Feb 10, 2025

⚠️ WARNING: No Threshold found!

codecov-commenter commented Feb 10, 2025

datadog-wireapp bot commented Feb 10, 2025

feat: adapt api v8 changes [WPB-15722] #3288

feat: adapt api v8 changes [WPB-15722] #3288

Conversation

MohamadJaara commented Feb 10, 2025 • edited by github-actions bot Loading

PR Submission Checklist for internal contributors

What's new in this PR?

Issues

Removed endpoints in V8

Changed endpoints in V8

Testing

Test Coverage (Optional)

How to Test

Notes (Optional)

Attachments (Optional)

PR Post Submission Checklist for internal contributors (Optional)

PR Post Merge Checklist for internal contributors

References

MohamadJaara Feb 10, 2025

Choose a reason for hiding this comment

github-actions bot commented Feb 10, 2025 • edited Loading

Test Results

yamilmedina left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Feb 10, 2025

Quality Gate passed

github-actions bot commented Feb 10, 2025

Bencher Report

⚠️ WARNING: No Threshold found!

codecov-commenter commented Feb 10, 2025

Codecov Report

datadog-wireapp bot commented Feb 10, 2025

Datadog Report

MohamadJaara commented Feb 10, 2025 •

edited by github-actions bot

Loading

github-actions bot commented Feb 10, 2025 •

edited

Loading