New Logging API Obj-C #3351

velicuvlad · 2024-12-20T20:04:16Z

CBL-6455
old Logging API uses the new LogSink API, thanks @pasin
do NOT allow the use new and old API at the same time.
CBL-6460 changed/adapted existing tests to use the new API.
renamed old tests under LogTestOld, which will be removed altogether with the old api, when time comes
mark the old api as deprecated

velicuvlad · 2025-01-06T18:04:46Z

Jenkins still failing only on [MiscTest testCBLVersionAndLiteCoreVersion] ... again, is just a sanity check - will be fixed once we get a 3.2 LiteCore including couchbase/couchbase-lite-core#2198

bmeike

Looks pretty good. Not a close read but the parts I understand seem fine.

bmeike · 2025-01-07T16:27:30Z

Objective-C/LogSink/CBLConsoleLogSink.mm

+    NSString* domainName = [self domainName: domain];
+    NSLog(@"CouchbaseLite %@ %@: %@", domainName, levelName, message);
+}
+


Isn't this an attribute of the LiteCore interface? Should it be somewhere generic for use by all of the loggers?

Not sure what you mean here? NSLog is an Obj-C native method to write to console only.

bmeike · 2025-01-07T16:28:33Z

Objective-C/LogSink/CBLFileLogSink.mm

+        options = {
+            .base_path = CBLStringBytes(logSink.directory),
+            .log_level = (C4LogLevel)logSink.level,
+            .max_rotate_count = static_cast<int32_t>(logSink.maxKeptFiles - 1),


Nice! I missed this...

bmeike · 2025-01-07T16:32:43Z

Objective-C/LogSink/CBLLogSinks.mm

+    CBLFileLogSink* file = self.file;
+    CBLLogLevel fileLevel = file != nil ? file.level : kCBLLogLevelNone;
+
+    CBLLogLevel callbackLevel = std::min(consoleLevel, customLevel);


At first I thought that the two vars were redundant... but this is really nice and readable.

bmeike · 2025-01-07T16:34:22Z

Objective-C/LogSink/CBLLogTypes.h

+ Log domain.
+ */
+typedef NS_OPTIONS(NSUInteger, CBLLogDomain) {
+    kCBLLogDomainAll            = 1 << 0 | 1 << 1 | 1 << 2 | 1 << 3 | 1 << 4, ///< All domains


Would this be better as
kCBLLogDomainDatabase | kCBLLogDomainQuery | ...

I actually did that for Swift as the namings are way shorter. As you now mentioned it now, I will change that for readability for Obj-C as well. Thanks!

pasin · 2025-01-06T18:48:00Z

Objective-C/CBLDatabase.mm

@@ -131,7 +131,7 @@ + (void) CBLInit {

 /** Check and show warning if file logging is not configured. */
 + (void) checkFileLogging {
-    if (!CBLDatabase.log.file.config) {
+    if (!CBLDatabase.log.file.config || !CBLLogSinks.file) {


Only need !CBLLogSinks.file.

pasin · 2025-01-06T18:48:31Z

Objective-C/CBLConsoleLogger.m

+}
+
+- (CBLLogDomain) domains {
+    [CBLLogSinks checkLogApiVersion: LogAPIOld];


This check is not in CBL_LOCK(self) while the others are.

pasin · 2025-01-07T16:40:22Z

Objective-C/LogSink/CBLLogSinks.mm

+    CBLLogDomain domain = toCBLLogDomain(c4domain);
+
+    CBLStringBytes c4msg(message);
+    c4slog(c4domain, c4level, c4msg);


When looking at this, I think CBLFileLogSink should implement CBLLogSinkProtocol protocol so this can be moved to CBLFileLogSink's writeLogWithLevel() the same way as the console and custom log sink below.

pasin · 2025-01-07T16:41:59Z

Objective-C/LogSink/CBLLogSinks.mm

+}
+
+ (void)checkLogApiVersion: (LogAPI)version {
+    if (!isInitialized)


Not sure if it's required to be checked? Is there a case that the initialize() is not called and what will happen if not checking at all?

needed to bypass 1 time (every test instance, at init) in order to be able to run both old and new tests. Should I just disable old tests (and remove this workaround)?

I don't understand how this works. I don't see any code reset isInitialized. I think reset _vAPI to none would be enough for testing both old and new API?

After reading the code, I have noticed that the isInitialized is reset to NO in CBLLogSinks's initialize. I couldn't find where that method is called in this PR. Also I think a better way is to have an internal method that the test can used to reset the API version.

pasin · 2025-01-07T16:44:34Z

Objective-C/LogSink/CBLLogTypes.h

+ Log domain.
+ */
+typedef NS_OPTIONS(NSUInteger, CBLLogDomain) {
+    kCBLLogDomainAll            = 1 << 0 | 1 << 1 | 1 << 2 | 1 << 3 | 1 << 4, ///< All domains


Maybe 0xFF?

I will go with Blake's recommendation of using kCBL.... I don't really want to go for 0xFF as we only have 5 bits not 8. The first thought I have for using 0xFF is that if LiteCore adds a new domain, All will include the new one as well and it can go unnoticed. As if we get a new domain from LiteCore we most probably going to need a singular entry as well for the new domain.

pasin · 2025-01-07T16:50:50Z

Objective-C/Tests/VectorSearchTest.m

@@ -76,12 +76,11 @@ - (void) setUp {
    AssertNotNil(_wordDB);

    _logger = [[CustomLogger alloc] init];
-    _logger.level = kCBLLogLevelInfo;
-    CBLDatabase.log.custom = _logger;
+    CBLLogSinks.custom = [[CBLCustomLogSink alloc] initWithLevel: kCBLLogLevelInfo logSink: _logger];


I don't remember why we have a custom logger set for the VectorSearchTest?

It is used to check for Untrained index; queries may be slow. I remember a conversation about this vaguely, but I wasn't sure enough to remove such checks. So I kept the custom logger in place. Do we still want to check for untrained? If not, I will remove this logger altogether.

I see. Let's keep it for now I think.

pasin · 2025-01-07T16:55:56Z

Objective-C/Tests/LogTest.m

-    _backupConsoleDomain = CBLDatabase.log.console.domains;
+    _backup = [[CBLFileLogSink alloc] initWithLevel: CBLLogSinks.file.level directory: logFileDirectory];
+    _backupConsoleLevel = CBLLogSinks.console.level;
+    _backupConsoleDomain = CBLLogSinks.console.domain;


The backup could just be some thing like this:

_file = CBLLogSinks.file; _console = CBLLogSinks.console;

I think after all the only backup is the console log sink for the case that we have enabled the console log sink for debugging purpose.

pasin · 2025-01-07T16:57:26Z

Objective-C/Tests/LogTestOld.m

+@implementation LogTestOld {
+    FileLoggerBackup* _backup;
+    CBLLogLevel _backupConsoleLevel;
+    CBLLogDomain _backupConsoleDomain;


I think, there is no need to backup anything for testing the old API. The backup is for the case that we enable a console log in the base test case for debugging purpose.

How do you handle the new and the old API are both used as the new logging tests and the old logging tests will be both run? Doesn't an exception will be thrown?

How do you handle the new and the old API are both used as the new logging tests and the old logging tests will be both run? Doesn't an exception will be thrown?

Both suites run one after the other. I've used isInitialized to allow this only once, for the old custom logger needed in the old tests. Without that check, it will throw indeed

velicuvlad added 8 commits December 20, 2024 21:34

api implementation and defaults

cfcd55e

update existing tests to use new api

9385faf

rename tests using old api

30c15f1

deprecate old logging api

8134620

fix iOS build and remove unused var

be176df

update project config and specifically cast bool obj-c to c

325de58

include old custom logger for test target

a3963f0

fix swift build

cf652f6

velicuvlad requested review from bmeike and pasin January 6, 2025 18:05

bmeike approved these changes Jan 7, 2025

View reviewed changes

pasin requested changes Jan 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Logging API Obj-C #3351

New Logging API Obj-C #3351

velicuvlad commented Dec 20, 2024 •

edited by jira bot

Loading

velicuvlad commented Jan 6, 2025 •

edited

Loading

bmeike left a comment

bmeike Jan 7, 2025

velicuvlad Jan 7, 2025

bmeike Jan 7, 2025

bmeike Jan 7, 2025

bmeike Jan 7, 2025

velicuvlad Jan 7, 2025

pasin Jan 6, 2025

pasin Jan 6, 2025

pasin Jan 7, 2025

pasin Jan 7, 2025

velicuvlad Jan 7, 2025

pasin Jan 7, 2025

pasin Jan 7, 2025

pasin Jan 7, 2025

velicuvlad Jan 7, 2025

pasin Jan 7, 2025

velicuvlad Jan 7, 2025

pasin Jan 7, 2025

pasin Jan 7, 2025

pasin Jan 7, 2025

pasin Jan 7, 2025

velicuvlad Jan 7, 2025

New Logging API Obj-C #3351

Are you sure you want to change the base?

New Logging API Obj-C #3351

Conversation

velicuvlad commented Dec 20, 2024 • edited by jira bot Loading

velicuvlad commented Jan 6, 2025 • edited Loading

bmeike left a comment

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

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

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

velicuvlad commented Dec 20, 2024 •

edited by jira bot

Loading

velicuvlad commented Jan 6, 2025 •

edited

Loading