chore: Core crypto 2.0 migration [WPB-14635] #3141

m-zagorski · 2024-12-02T16:22:17Z

WPB-14635 Upgrade to CoreCrypto 2.0

https://wearezeta.atlassian.net/browse/WPB-14635

What's new in this PR?

Solutions

Update core crypto to version 2.0.0. Migrate exception error codes mappings, add logger with default log level set to INFO

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.

m-zagorski · 2024-12-02T16:22:39Z

cryptography/src/commonJvmAndroid/kotlin/com.wire.kalium.cryptography/CoreCryptoCentral.kt

@@ -36,12 +39,19 @@ actual suspend fun coreCryptoCentral(
        key = databaseKey
    )
    coreCrypto.setCallbacks(Callbacks())
+    setLogger(CoreCryptoLoggerImpl(), CoreCryptoLogLevel.INFO)


would we want to have some other log level for debug builds?

Maybe we can set to the lowest level (CoreCryptoLogLevel.Trace), and within the CoreCryptoLoggerImpl we can map to different kaliumLogger functions, which alreadys implement log-level filtering within it.

Warning ⚠️ this can have a negative performance impact since a lot of messages will go over the ffi boundary.

@typfel should we then make it default to INFO ? or we should have it disabled for prod at all?

We want it enabled in Prod at the INFO level which will not generate large amounts of logs.

Setting the level TRACE will potentially generate a lot of logs so it should not be enabled in Prod.

Reverted to INFO there

m-zagorski · 2024-12-02T16:24:27Z

...aphy/src/commonJvmAndroid/kotlin/com.wire.kalium.cryptography/ProteusClientCoreCryptoImpl.kt

+        }
+
+        @Suppress("MagicNumber")
+        private fun mapProteusExceptionToRawIntErrorCode(proteusException: ProteusExceptionNative): Int {


Those mappers are here because we've to rely on the native ProteusException type directly, and we're not having the right dependency in the ProteusException

Going forward I'd suggest aligning ProteusException with the ProteusExceptionNative. We want to go away from dealing Int numbers for error handling.

Doesn't have to be done right away but maybe create a TODO with a ticket?

Makes sense to have it in a different task, there is also some corecryptobox mappings to the ProteusException - but indeed would be nice to also clean it up

github-actions · 2024-12-02T16:33:02Z

Test Results

3 339 tests +5 3 232 ✅ +5 5m 32s ⏱️ +50s
572 suites ±0 107 💤 ±0
572 files ±0 0 ❌ ±0

Results for commit b11ad65. ± Comparison against base commit 346034a.

♻️ This comment has been updated with latest results.

github-actions · 2024-12-02T16:38:34Z

Bencher Report

Branch	chore/core-crypto-2.0-migration
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 CLI flag.

Click to view all benchmark results

Benchmark	Latency	nanoseconds (ns)
com.wire.kalium.benchmarks.logic.CoreLogicBenchmark.createObjectInFiles	📈 view plot ⚠️ NO THRESHOLD	651,450.35
com.wire.kalium.benchmarks.logic.CoreLogicBenchmark.createObjectInMemory	📈 view plot ⚠️ NO THRESHOLD	353,355,858.12
com.wire.kalium.benchmarks.persistence.MessagesNoPragmaTuneBenchmark.messageInsertionBenchmark	📈 view plot ⚠️ NO THRESHOLD	1,316,585,825.94
com.wire.kalium.benchmarks.persistence.MessagesNoPragmaTuneBenchmark.queryMessagesBenchmark	📈 view plot ⚠️ NO THRESHOLD	21,660,040.31

🐰 View full continuous benchmarking report in Bencher

codecov-commenter · 2024-12-02T16:58:58Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.19%. Comparing base (ee39af7) to head (b11ad65).
Report is 2 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3141      +/-   ##
===========================================
+ Coverage    54.18%   54.19%   +0.01%     
===========================================
  Files         1251     1251              
  Lines        36403    36444      +41     
  Branches      3680     3689       +9     
===========================================
+ Hits         19725    19752      +27     
- Misses       15259    15268       +9     
- Partials      1419     1424       +5

Files with missing lines	Coverage Δ
...kalium/cryptography/exceptions/ProteusException.kt	`51.02% <ø> (+1.02%)`	⬆️

... and 8 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 ee39af7...b11ad65. Read the comment docs.

datadog-wireapp · 2024-12-02T17:00:44Z

Datadog Report

Branch report: chore/core-crypto-2.0-migration
Commit report: 9da936c
Test service: kalium-jvm

✅ 0 Failed, 3232 Passed, 107 Skipped, 1m 8.07s Total Time

vitorhugods · 2024-12-03T09:29:43Z

cryptography/src/commonJvmAndroid/kotlin/com.wire.kalium.cryptography/CoreCryptoCentral.kt

@@ -36,12 +39,19 @@ actual suspend fun coreCryptoCentral(
        key = databaseKey
    )
    coreCrypto.setCallbacks(Callbacks())
+    setLogger(CoreCryptoLoggerImpl(), CoreCryptoLogLevel.INFO)


Maybe we can set to the lowest level (CoreCryptoLogLevel.Trace), and within the CoreCryptoLoggerImpl we can map to different kaliumLogger functions, which alreadys implement log-level filtering within it.

cryptography/src/commonJvmAndroid/kotlin/com.wire.kalium.cryptography/CoreCryptoCentral.kt

sonarqubecloud · 2024-12-05T08:50:35Z

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

johnxnguyen · 2024-12-05T10:25:45Z

cryptography/src/commonJvmAndroid/kotlin/com.wire.kalium.cryptography/CoreCryptoCentral.kt

+private class CoreCryptoLoggerImpl : CoreCryptoLogger {
+    override fun log(level: CoreCryptoLogLevel, message: String, context: String?) {
+        when (level) {
+            CoreCryptoLogLevel.TRACE -> kaliumLogger.v("$message. $context")


@m-zagorski is the message and the context concatenated together? Or do they get sent to datadog separately?

the message will be concatenated - is that correct ? @johnxnguyen

chore: Core crypto 2.0 migration [WPB-14635]

6be6175

m-zagorski requested review from MohamadJaara and vitorhugods December 2, 2024 16:22

github-actions bot assigned m-zagorski Dec 2, 2024

github-actions bot added type: chore 🧹 👕 size: S labels Dec 2, 2024

m-zagorski commented Dec 2, 2024

View reviewed changes

vitorhugods reviewed Dec 3, 2024

View reviewed changes

Code review

2932f04

github-actions bot added 👕 size: M and removed 👕 size: S labels Dec 3, 2024

m-zagorski requested a review from vitorhugods December 3, 2024 15:38

vitorhugods approved these changes Dec 4, 2024

View reviewed changes

Rollback to INFO logs

b11ad65

typfel approved these changes Dec 5, 2024

View reviewed changes

m-zagorski added this pull request to the merge queue Dec 5, 2024

johnxnguyen reviewed Dec 5, 2024

View reviewed changes

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 5, 2024

m-zagorski added this pull request to the merge queue Dec 6, 2024

Merged via the queue into develop with commit d2b92a0 Dec 6, 2024
23 checks passed

m-zagorski deleted the chore/core-crypto-2.0-migration branch December 6, 2024 13:19

echoes-hq bot added the echoes: product-roadmap Work aligned with the customer-announced roadmap, targeting a specific release date. label Dec 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Core crypto 2.0 migration [WPB-14635] #3141

chore: Core crypto 2.0 migration [WPB-14635] #3141

m-zagorski commented Dec 2, 2024 •

edited by github-actions bot

Loading

m-zagorski Dec 2, 2024

vitorhugods Dec 3, 2024

typfel Dec 3, 2024

m-zagorski Dec 4, 2024

typfel Dec 4, 2024 •

edited

Loading

m-zagorski Dec 5, 2024

m-zagorski Dec 2, 2024

typfel Dec 4, 2024 •

edited

Loading

m-zagorski Dec 5, 2024

github-actions bot commented Dec 2, 2024 •

edited

Loading

github-actions bot commented Dec 2, 2024 •

edited

Loading

⚠️ WARNING: No Threshold found!

codecov-commenter commented Dec 2, 2024 •

edited

Loading

datadog-wireapp bot commented Dec 2, 2024 •

edited

Loading

vitorhugods Dec 3, 2024

sonarqubecloud bot commented Dec 5, 2024

johnxnguyen Dec 5, 2024 •

edited

Loading

m-zagorski Dec 6, 2024

chore: Core crypto 2.0 migration [WPB-14635] #3141

chore: Core crypto 2.0 migration [WPB-14635] #3141

Conversation

m-zagorski commented Dec 2, 2024 • edited by github-actions bot Loading

What's new in this PR?

Solutions

PR Post Submission Checklist for internal contributors (Optional)

PR Post Merge Checklist for internal contributors

References

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typfel Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typfel Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Dec 2, 2024 • edited Loading

Test Results

github-actions bot commented Dec 2, 2024 • edited Loading

⚠️ WARNING: No Threshold found!

codecov-commenter commented Dec 2, 2024 • edited Loading

Codecov Report

datadog-wireapp bot commented Dec 2, 2024 • edited Loading

Datadog Report

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 5, 2024

Quality Gate passed

johnxnguyen Dec 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-zagorski commented Dec 2, 2024 •

edited by github-actions bot

Loading

typfel Dec 4, 2024 •

edited

Loading

typfel Dec 4, 2024 •

edited

Loading

github-actions bot commented Dec 2, 2024 •

edited

Loading

github-actions bot commented Dec 2, 2024 •

edited

Loading

codecov-commenter commented Dec 2, 2024 •

edited

Loading

datadog-wireapp bot commented Dec 2, 2024 •

edited

Loading

johnxnguyen Dec 5, 2024 •

edited

Loading