feat: create use case for getting e2ei certificate (WPB-3214) #2129

ohassine · 2023-10-11T13:50:01Z

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?

Description

In this PR I created

a use case to get e2ei certificate that will have 4 different statues
a certificate decoder to be use in the above use case, I added bouncy-castle dependency for JVM

Dependencies (Optional)

If there are some other pull requests related to this one (e.g. new releases of frameworks), specify them here.

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.

…te_usecase # Conflicts: # logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/UserSessionScope.kt

github-actions · 2023-10-11T16:31:55Z

Unit Test Results

  463 files   463 suites 3m 4s ⏱️
2 568 tests 2 464 ✔️ 104 💤 0 ❌

Results for commit 41927d7.

♻️ This comment has been updated with latest results.

codecov-commenter · 2023-10-11T16:41:48Z

Codecov Report

Merging #2129 (bbd0f2f) into develop (872981a) will increase coverage by 0.01%.
Report is 3 commits behind head on develop.
The diff coverage is 70.93%.

@@              Coverage Diff              @@
##             develop    #2129      +/-   ##
=============================================
+ Coverage      57.88%   57.90%   +0.01%     
  Complexity        21       21              
=============================================
  Files           1059     1064       +5     
  Lines          40190    40258      +68     
  Branches        3722     3729       +7     
=============================================
+ Hits           23265    23311      +46     
- Misses         15314    15336      +22     
  Partials        1611     1611

Files	Coverage Δ
...c/data/conversation/ConversationGroupRepository.kt	`97.65% <100.00%> (+0.04%)`	⬆️
...ation/NewGroupConversationSystemMessagesCreator.kt	`91.81% <100.00%> (+0.90%)`	⬆️
...ature/connection/AcceptConnectionRequestUseCase.kt	`100.00% <100.00%> (ø)`
...ire/kalium/logic/feature/e2ei/CertificateStatus.kt	`100.00% <100.00%> (ø)`
.../wire/kalium/logic/feature/e2ei/E2eiCertificate.kt	`100.00% <100.00%> (ø)`
...um/logic/feature/e2ei/usecase/EnrollE2EIUseCase.kt	`100.00% <ø> (ø)`
.../feature/e2ei/usecase/GetE2EICertificateUseCase.kt	`100.00% <100.00%> (ø)`
...re/kalium/logic/sync/receiver/UserEventReceiver.kt	`82.25% <100.00%> (+0.59%)`	⬆️
...ceiver/conversation/NewConversationEventHandler.kt	`89.65% <100.00%> (+0.36%)`	⬆️
...otlin/com/wire/kalium/logic/util/E2eiExtensions.kt	`100.00% <100.00%> (ø)`
... and 12 more

... and 2 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 50fa995...bbd0f2f. Read the comment docs.

datadog-wireapp · 2023-10-11T16:43:08Z

Datadog Report

All test runs 2115ed9 🔗

❌ 2 Total Test Services: 1 Failed, 0 with New Flaky, 1 Passed

Test Services

Service Name	Failed	Known Flaky	New Flaky	Passed	Skipped	Wall Time	Branch View
`kalium-jvm`	1	0	0	582	39	8m 41.66s	Link
`kalium-ios`	0	0	0	2175	121	12m 45.1s	Link

❌ Failed Tests (1)

givenEmailAndPasswordWhenLoggingInThenRegisterClientAndLogout - PocIntegrationTest - Details

Expand for error

 java.lang.AssertionError: no expected response was found for POST:https://test.api.com/v1/access/logout
 
 java.lang.AssertionError: no expected response was found for POST:https://test.api.com/v1/access/logout
 	at org.junit.Assert.fail(Assert.java:89)
 	at kotlin.test.junit.JUnitAsserter.fail(JUnitSupport.kt:56)
 	at kotlin.test.AssertionsKt__AssertionsKt.fail(Assertions.kt:520)
 	at kotlin.test.AssertionsKt.fail(Unknown Source)
 	at util.MockUnboundNetworkClient$createMockEngine$1.invokeSuspend(MockUnboundNetworkClient.kt:88)
 	at util.MockUnboundNetworkClient$createMockEngine$1.invoke(MockUnboundNetworkClient.kt)
 	at util.MockUnboundNetworkClient$createMockEngine$1.invoke(MockUnboundNetworkClient.kt)
 ...

...mmonMain/kotlin/com/wire/kalium/logic/feature/e2ei/usecase/DownloadE2eiCertificateUseCase.kt

logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/e2ei/E2eiCertificate.kt

…te_usecase

...ommonJvmAndroid/kotlin/com/wire/kalium/logic/feature/e2ei/decodePemCertificate.JvmAndroid.kt

mchenani · 2023-10-23T08:10:44Z

logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/e2ei/CertificateStatus.kt

+enum class CertificateStatus {
+    REVOKED,
+    EXPIRED,
+    VALID


suggestion: either here as 'Valid(until: Date)' or in the certificate details the expiresAt... to the properties. we need it atleast for the current client's renewal button.

I'd say let's add it when we need it

mchenani

LGTM, please add tests for the decoder and the usecase.

datadog-wireapp · 2023-10-23T08:58:48Z

Datadog Report

All test runs 552698e 🔗

✅ 2 Total Test Services: 0 Failed, 0 with New Flaky, 2 Passed

Test Services

Service Name	Failed	Known Flaky	New Flaky	Passed	Skipped	Wall Time	Branch View
`kalium-ios`	0	0	0	2341	119	13m 7.12s	Link
`kalium-jvm`	0	0	0	2464	104	14m 40.01s	Link

…te_usecase

mchenani · 2023-10-25T08:10:49Z

logic/src/commonMain/kotlin/com/wire/kalium/logic/data/e2ei/E2eiCertificateRepository.kt

+    fun getE2eiCertificate(clientId: ClientId): Either<E2EIFailure, String>
+}
+
+class E2eiCertificateRepositoryImpl : E2eiCertificateRepository {


suggestion: instead of having a new repository, you an move this function to the E2EIRepository we have at the moment.

Actually E2EIRepository is already doing too much, I think it's better to have a newer one than having a God class.

mchenani · 2023-10-25T08:12:18Z

logic/src/appleMain/kotlin/com/wire/kalium/logic/feature/e2ei/CertificateStatusChecker.kt

+package com.wire.kalium.logic.feature.e2ei
+
+actual interface CertificateStatusChecker {
+    actual fun status(notAfterTimestamp: Long): CertificateStatus


question: why we need to pass the time? how is not the current system time?

We are getting current time in CertificateStatusChecker implementation and we compare it with this passed one to know if it's expired or not

mchenani · 2023-10-25T08:13:37Z

logic/src/jvmTest/kotlin/com/wire/kalium/logic/feature/e2ei/PemCertificateDecoderTest.kt

+class PemCertificateDecoderTest {
+
+    @Test
+    fun givenAValidCertificate_whenDecodingIt_thenReturnCertificateObject() {


question: can you add an actual comparison here on the data you expect? based on the PEM string you passed.

mchenani

Looking good 👍, added some other questions and suggestions.

ohassine added 2 commits October 11, 2023 15:43

feat: create use case for getting e2ei certificate

d538642

Merge remote-tracking branch 'origin/develop' into get_e2ei_certifica…

b3ddd58

…te_usecase # Conflicts: # logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/UserSessionScope.kt

github-actions bot assigned ohassine Oct 11, 2023

github-actions bot added 🚨 Potential breaking changes type: feature ✨ 👕 size: M labels Oct 11, 2023

ohassine added 2 commits October 11, 2023 16:15

chore: detekt

89ec697

chore: add missing documentation

796d558

mchenani reviewed Oct 12, 2023

View reviewed changes

...mmonMain/kotlin/com/wire/kalium/logic/feature/e2ei/usecase/DownloadE2eiCertificateUseCase.kt Outdated Show resolved Hide resolved

mchenani reviewed Oct 12, 2023

View reviewed changes

logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/e2ei/E2eiCertificate.kt Show resolved Hide resolved

ohassine added the WIP work in progress label Oct 12, 2023

ohassine added 6 commits October 13, 2023 12:32

chore: address comments

63cb45e

chore: detekt

cb5b7f0

Merge branch 'develop' into get_e2ei_certificate_usecase

c83139c

chore: add empty line

dbfaf56

Merge remote-tracking branch 'origin/develop' into get_e2ei_certifica…

4dd81fe

…te_usecase

Merge branch 'develop' into get_e2ei_certificate_usecase

6a6c452

ohassine removed the WIP work in progress label Oct 16, 2023

ohassine requested review from mchenani, a team, gongracr, borichellow, vitorhugods and Garzas and removed request for a team October 20, 2023 08:17

mchenani reviewed Oct 23, 2023

View reviewed changes

...ommonJvmAndroid/kotlin/com/wire/kalium/logic/feature/e2ei/decodePemCertificate.JvmAndroid.kt Outdated Show resolved Hide resolved

mchenani reviewed Oct 23, 2023

View reviewed changes

Merge branch 'develop' into get_e2ei_certificate_usecase

344986b

mchenani suggested changes Oct 23, 2023

View reviewed changes

chore: add missing unit test

8cb2c84

github-actions bot added 👕 size: XL and removed 👕 size: M labels Oct 25, 2023

Merge remote-tracking branch 'origin/develop' into get_e2ei_certifica…

e9f0235

…te_usecase

ohassine requested a review from mchenani October 25, 2023 07:53

chore: detekt

bbd0f2f

mchenani reviewed Oct 25, 2023

View reviewed changes

mchenani approved these changes Oct 25, 2023

View reviewed changes

ohassine added 2 commits October 25, 2023 10:54

chore: address comments

98064ad

chore: cleanup

41927d7

Garzas approved these changes Oct 25, 2023

View reviewed changes

ohassine added this pull request to the merge queue Oct 25, 2023

Merged via the queue into develop with commit 290418d Oct 25, 2023
15 checks passed

ohassine deleted the get_e2ei_certificate_usecase branch October 25, 2023 11:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: create use case for getting e2ei certificate (WPB-3214) #2129

feat: create use case for getting e2ei certificate (WPB-3214) #2129

ohassine commented Oct 11, 2023 •

edited

Loading

github-actions bot commented Oct 11, 2023 •

edited

Loading

codecov-commenter commented Oct 11, 2023 •

edited

Loading

datadog-wireapp bot commented Oct 11, 2023 •

edited

Loading

mchenani Oct 23, 2023

ohassine Oct 25, 2023

mchenani left a comment

datadog-wireapp bot commented Oct 23, 2023 •

edited

Loading

mchenani Oct 25, 2023

ohassine Oct 25, 2023

mchenani Oct 25, 2023

ohassine Oct 25, 2023

mchenani Oct 25, 2023

mchenani left a comment

feat: create use case for getting e2ei certificate (WPB-3214) #2129

feat: create use case for getting e2ei certificate (WPB-3214) #2129

Conversation

ohassine commented Oct 11, 2023 • edited Loading

PR Submission Checklist for internal contributors

What's new in this PR?

Description

Dependencies (Optional)

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

github-actions bot commented Oct 11, 2023 • edited Loading

Unit Test Results

codecov-commenter commented Oct 11, 2023 • edited Loading

Codecov Report

datadog-wireapp bot commented Oct 11, 2023 • edited Loading

Datadog Report

❌ Failed Tests (1)

mchenani Oct 23, 2023

Choose a reason for hiding this comment

ohassine Oct 25, 2023

Choose a reason for hiding this comment

mchenani left a comment

Choose a reason for hiding this comment

datadog-wireapp bot commented Oct 23, 2023 • edited Loading

Datadog Report

mchenani Oct 25, 2023

Choose a reason for hiding this comment

ohassine Oct 25, 2023

Choose a reason for hiding this comment

mchenani Oct 25, 2023

Choose a reason for hiding this comment

ohassine Oct 25, 2023

Choose a reason for hiding this comment

mchenani Oct 25, 2023

Choose a reason for hiding this comment

mchenani left a comment

Choose a reason for hiding this comment

ohassine commented Oct 11, 2023 •

edited

Loading

github-actions bot commented Oct 11, 2023 •

edited

Loading

codecov-commenter commented Oct 11, 2023 •

edited

Loading

datadog-wireapp bot commented Oct 11, 2023 •

edited

Loading

datadog-wireapp bot commented Oct 23, 2023 •

edited

Loading