Log sink api

[jayant-dhingra-cb]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @jayant-dhingra-cb, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the logging capabilities of Couchbase Lite React Native by introducing a new Log Sink API. Developers can now configure console, file, and custom log destinations with specified levels and domains. Alongside this, the PR includes a major refactoring of how change listeners are managed across the native modules, moving to a unified token-based system for improved consistency and ease of use. The underlying Couchbase Lite SDKs have also been updated to version 3.3.0, and new examples and tests are provided to cover these changes.

Highlights

• Log Sink API Implementation: Introduced a comprehensive Log Sink API for Couchbase Lite React Native, enabling configuration of console, file, and custom logging mechanisms on both Android and iOS platforms. This allows developers to direct and filter Couchbase Lite logs according to their needs.
• Unified Listener Management Refactoring: Refactored the internal listener management system on both Android (Kotlin) and iOS (Swift) to use a single, unified dictionary for tracking all change listeners (collection, document, query, replicator). This simplifies the process of adding and removing listeners, particularly with the introduction of a generic listenerToken_Remove method.
• Couchbase Lite SDK Version Update: Updated the underlying Couchbase Lite SDK dependencies for both Android (couchbase-lite-android-ee-ktx) and iOS (CouchbaseLite-Swift-Enterprise) from version 3.2.1 to 3.3.0.
• New collection_GetFullName Method: Added a new collection_GetFullName method, providing a programmatic way to retrieve the full name of a collection, which is now an asynchronous operation.
• Expanded Example and Test Coverage: Included extensive new example screens and dedicated test cases within the Expo application to demonstrate and validate the functionality of the new Log Sink API and the refactored listener management.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new Log Sinks API and significantly refactors the change listener management across both Android and iOS platforms. The listener refactoring, which unifies different listener types under a single management system, is a great improvement for code clarity and maintainability. The new Log Sinks API is well-implemented with corresponding test files. I've identified a few areas for improvement, including replacing GlobalScope with a lifecycle-aware CoroutineScope on Android for better resource management, fixing some minor import formatting in test files, and correcting a duplicate key issue in the test navigation configuration.

[gemini-code-assist]

There are duplicate id values in this array, starting with id: 15 on this line. React keys for list items must be unique to avoid potential rendering issues. I've suggested renumbering the subsequent items to ensure all IDs are unique.

Suggested change

	id: 15,
	title: 'LogSinks API',
	path: '/tests/logsinks',
	},
	{
	id: 16,
	title: 'Log Sink Console Logs',
	path: '/tests/console-logging',
	},
	{
	id: 17,
	title: 'File Logging Test',
	path: '/tests/file-logging',
	},
	{
	id: 18,
	title: 'Custom Logging Test',
	path: '/tests/custom-logging',
	id: 16,
	title: 'LogSinks API',
	path: '/tests/logsinks',
	},
	{
	id: 17,
	title: 'Log Sink Console Logs',
	path: '/tests/console-logging',
	},
	{
	id: 18,
	title: 'File Logging Test',
	path: '/tests/file-logging',
	},
	{
	id: 19,
	title: 'Custom Logging Test',
	path: '/tests/custom-logging',

[gemini-code-assist]

Using GlobalScope is discouraged as it can lead to memory leaks and makes coroutines difficult to manage and test. It's better to use a CoroutineScope that is tied to the lifecycle of the module. You can create a CoroutineScope at the class level and cancel it in onCatalystInstanceDestroy(). This change should be applied to all usages of GlobalScope.launch in this file (lines 1641, 1668, 1696).

Example of creating a module-scoped coroutine:

class CblReactnativeModule(...) {
    private val moduleScope = CoroutineScope(SupervisorJob() + Dispatchers.Default)

    override fun onCatalystInstanceDestroy() {
        super.onCatalystInstanceDestroy()
        moduleScope.cancel()
    }

    // ... in your method
    @ReactMethod
    fun collection_GetFullName(...) {
        moduleScope.launch(Dispatchers.IO) {
            // ...
        }
    }
}

[gemini-code-assist]

There's a formatting issue here. The import statement for getFileDefaultPath should be on a new line for better readability and to follow standard code style.

Suggested change

	} from 'cbl-reactnative';import getFileDefaultPath from '@/service/file/getFileDefaultPath';
	} from 'cbl-reactnative';
	import getFileDefaultPath from '@/service/file/getFileDefaultPath';

[gemini-code-assist]

There's a formatting issue here. The import statement for getFileDefaultPath should be on a new line for better readability and to follow standard code style.

Suggested change

	} from 'cbl-reactnative';import getFileDefaultPath from '@/service/file/getFileDefaultPath';
	} from 'cbl-reactnative';
	import getFileDefaultPath from '@/service/file/getFileDefaultPath';

[gemini-code-assist]

There's a formatting issue here. The import statement for getFileDefaultPath should be on a new line for better readability and to follow standard code style.

Suggested change

	} from 'cbl-reactnative';import getFileDefaultPath from '@/service/file/getFileDefaultPath';
	} from 'cbl-reactnative';
	import getFileDefaultPath from '@/service/file/getFileDefaultPath';