[RKOTLIN-1038] Implement new log category for RealmLogger #1692

clementetb · 2024-03-15T12:17:47Z

RealmLog would see the current level property deprecated in favor of a setter and getter functions.

RealmLog {
    @Deprecated
    public var level: LogLevel

    public fun setLevel(level: LogLevel, category: LogCategory)
    public fun getLevel(category: LogCategory): LogLevel
}

The custom logger interface also gets modified adding a new method that has the category in its signature. Backward compatibility would be ensured to the current deprecated methods.

RealmLogger {
    public fun log(
        category: LogCategory, 
        level: LogLevel, 
        throwable: Throwable?, 
        message: String?, 
        vararg args: Any?
    )
}

Co-authored-by: clementetb <[email protected]>

Deprecated method validation Changelog

packages/cinterop/src/commonMain/kotlin/io/realm/kotlin/internal/interop/Callback.kt

packages/cinterop/src/nativeDarwin/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt

rorbech · 2024-05-07T07:45:11Z

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/log/LogLevel.kt

@@ -20,3 +21,31 @@ public enum class LogLevel(public val priority: Int) {
    WTF(6),
    NONE(7);
 }
+
+internal fun LogLevel.toCoreLogLevel(): CoreLogLevel {


Internal stuff should go into an internal package/class/file

These internal helper functions will not be visible to the end-user, unless they inspect the code.

Wasn't the original purpose of the internal package to hide internal classes that had to be made public because of the base/sync split?

I think having these two helper functions next to the enum they are helping makes for better discoverability, rather than having to jump between files to see if all enum elements are listed or not.

I don't have a strong opinion, if you like them moved I will displace them 😉

The reason for the internal packages was to split it so that it was obvious what the public API was and that users wouldn't end up browsing internal code unless they intentionally navigated to it from the public API. We haven't been completely strict on this, but I don't see why we should not try to follow it 🤷

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/log/RealmLog.kt

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/log/RealmLogger.kt

packages/test-base/src/commonTest/kotlin/io/realm/kotlin/test/common/RealmConfigurationTests.kt

rorbech · 2024-05-07T08:23:44Z

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/log/LogCategory.kt

+package io.realm.kotlin.log
+
+/*
+ * Core does not expose the different categories in compile time.


I think we should move all the internal stuff to an internal package/class/file. It confuses users if they end up here.

Does this comment belong here. Seems like it is dangling and that the code has moved.

rorbech

Nice clean ups. I like the idea of always logging to a specific logger instead of RealmLog.

There are some minors and then we need to bump the version and highlight the breaking changes.

rorbech · 2024-05-15T13:44:05Z

CHANGELOG.md

@@ -9,6 +9,7 @@ This release will bump the Realm file format from version 23 to 24. Opening a fi
 ### Enhancements
 * Support for RealmLists and RealmDictionaries in `RealmAny`. (Issue [#1434](https://github.com/realm/realm-kotlin/issues/1434))
 * Optimized `RealmList.indexOf()` and `RealmList.contains()` using Core implementation of operations instead of iterating elements and comparing them in Kotlin. (Issue [#1625](https://github.com/realm/realm-kotlin/pull/1666) [RKOTLIN-995](https://jira.mongodb.org/browse/RKOTLIN-995)).
+* Add support for filtering logs by category. (Issue [#1691](https://github.com/realm/realm-kotlin/issues/1691) [JIRA](https://jira.mongodb.org/browse/RKOTLIN-1038))


With the new interface this is actually a breaking change, and we should bump the version to 2.0.0-SNAPSHOT.

We should also highlight that the LogConfiguration is gone.

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/internal/LogUtils.kt

rorbech · 2024-05-16T07:28:58Z

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/log/LogCategory.kt

+package io.realm.kotlin.log
+
+/*
+ * Core does not expose the different categories in compile time.


Does this comment belong here. Seems like it is dangling and that the code has moved.

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/log/LogCategory.kt

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/log/RealmLog.kt

...library-sync/src/androidMain/kotlin/io/realm/kotlin/mongodb/internal/RealmSyncInitializer.kt

packages/test-base/src/commonTest/kotlin/io/realm/kotlin/test/common/RealmLogTests.kt

packages/test-base/src/commonTest/kotlin/io/realm/kotlin/test/common/RealmConfigurationTests.kt

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/internal/ContextLogger.kt

...ages/test-sync/src/commonTest/kotlin/io/realm/kotlin/test/mongodb/common/SyncedRealmTests.kt

rorbech and others added 25 commits March 15, 2024 09:03

Update to Core 14.0.1

b7ecb4d

Dump cmake version on GHA build

5b83ad2

Additional GHA debug info

06c75b8

Update CMAKE on JVM linux docker image

2f02b5b

Bump NDK to fix core link issues

8fdd84e

Bump NDK to fix core link issues

b8232d3

Fix expected exception text in query test

f6364d2

Clean up debug output

7f2257c

More clean up

d74df61

Revert NDK to debug arm7v issues

7a9933b

More debug info

2afec66

Included core updates in CHANGELOG

85781aa

Included core updates in CHANGELOG

0bf3895

Cleanup CHANGELOG

dceaf9d

Upgrade to Core 14.2.0

408fe19

Update CHANGELOG.md

5d1e739

Co-authored-by: clementetb <[email protected]>

Add structure for log categories

496cf2c

Add tests

8950932

Add setters/getters

f797f60

Pass category in logs callback

ea211de

Propagate log category in callbacks

1b75cd9

Fix compile issues on darwin

668a618

Restore default log level

57682c9

Add documentation

a708d6f

Contains support

7739e2a

Deprecated method validation Changelog

clementetb self-assigned this Mar 15, 2024

cla-bot bot added the cla: yes label Mar 15, 2024

clementetb requested a review from rorbech March 15, 2024 12:18

clementetb changed the base branch from main to cr/core-upgrade March 15, 2024 13:18

Fix expression did not evaluate to a constant compile error in windows

76b51bb

Fix changelog merge issue

c6384fa

rorbech reviewed May 7, 2024

View reviewed changes

clementetb added 21 commits May 9, 2024 15:45

defaults

1cbecdc

Update test

6d3c84d

Add category to log output.

e434e90

Fix cycle in Logger.log

86f48ed

Clean up

b935051

Add test to show SDK logs are not filtered out

b31baba

refactor interface

9442e73

filter sdk messages

a6863cd

Refactor RealmLogger interface an ContextLogger

450d6cb

move to internal

8c01bbf

ktlint

510c946

Clean up

6f4d1e3

Remove unused imports

67bd60c

Test fixes

f669ee8

Remove leftovers

8640eb1

Remove redundant code

469e233

Remove obsolete code

acf8f57

Update test cases

52c2921

Use context logger with app services client

9874107

Remove obsolete code

b1923ad

Linting

2153043

rorbech reviewed May 16, 2024

View reviewed changes

clementetb added 2 commits May 16, 2024 12:36

Pr review changes

123d59d

Set log level for RealmLogTests

718d042

rorbech approved these changes May 17, 2024

View reviewed changes

rorbech merged commit fd5a5ca into main May 17, 2024
56 checks passed

rorbech deleted the ct/loging-categories branch May 17, 2024 07:10

github-actions bot locked as resolved and limited conversation to collaborators Jun 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RKOTLIN-1038] Implement new log category for RealmLogger #1692

[RKOTLIN-1038] Implement new log category for RealmLogger #1692

clementetb commented Mar 15, 2024

rorbech May 7, 2024

clementetb May 9, 2024 •

edited

Loading

rorbech May 13, 2024

rorbech May 7, 2024

rorbech May 16, 2024

rorbech left a comment

rorbech May 15, 2024

rorbech May 16, 2024

rorbech May 16, 2024

[RKOTLIN-1038] Implement new log category for RealmLogger #1692

[RKOTLIN-1038] Implement new log category for RealmLogger #1692

Conversation

clementetb commented Mar 15, 2024

rorbech May 7, 2024

Choose a reason for hiding this comment

clementetb May 9, 2024 • edited Loading

Choose a reason for hiding this comment

rorbech May 13, 2024

Choose a reason for hiding this comment

rorbech May 7, 2024

Choose a reason for hiding this comment

rorbech May 16, 2024

Choose a reason for hiding this comment

rorbech left a comment

Choose a reason for hiding this comment

rorbech May 15, 2024

Choose a reason for hiding this comment

rorbech May 16, 2024

Choose a reason for hiding this comment

rorbech May 16, 2024

Choose a reason for hiding this comment

clementetb May 9, 2024 •

edited

Loading