-
Notifications
You must be signed in to change notification settings - Fork 1
added way to build without ee features #11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @Wojtach, I'm Gemini Code Assist1! 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 introduces a mechanism to allow the application to be built and run without requiring Couchbase Lite Enterprise Edition (EE) features. It achieves this by abstracting access to EE-specific functionalities, such as database encryption and self-signed certificate handling, behind a reflection-based helper. This change prevents compile-time warnings or runtime errors when the EE components are not present in the build environment.
Highlights
- New Reflection Helper: Introduced a new file,
CouchbaseReflectionHelper.kt
, which encapsulates calls to Couchbase Lite Enterprise Edition (EE) features using Java Reflection. This includes methods for setting/changing encryption keys and handling self-signed server certificates, designed to gracefully handle cases where EE classes are not available. - Database Encryption Refactor: Modified
DatabaseManager.kt
to delegate calls for setting and changing database encryption keys to the newCouchbaseReflectionHelper
. This replaces direct instantiation ofEncryptionKey
with reflection-based access. - Replicator Configuration Refactor: Updated
ReplicatorHelper.kt
to useCouchbaseReflectionHelper
for setting theacceptOnlySelfSignedServerCertificate
option. This ensures that this EE-specific feature is accessed via reflection, preventing warnings or errors in non-EE builds.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a CouchbaseReflectionHelper
to decouple the main codebase from Enterprise Edition (EE) features, enabling builds without EE dependencies. This is a solid approach that uses reflection to access EE-specific functionality at runtime.
The changes correctly replace direct calls to EE features with calls to the new reflection helper. My review identifies a critical issue in the exception handling within the new helper, which could mask bugs. I've also provided suggestions to improve code quality and maintainability.
} catch (e: Exception) { | ||
Log.w("CouchbaseLite", "Failed to set encryption key: ${e.message}") | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Catching a generic Exception
is dangerous as it can swallow any exception, including RuntimeException
s that indicate a bug in the code, not just the absence of EE features. This can hide bugs and lead to unpredictable application behavior.
You should only catch specific reflection-related exceptions. Any other exception should be allowed to propagate. This ensures you are only handling the expected 'feature not available' scenario.
} catch (e: java.lang.reflect.ReflectiveOperationException) {
Log.w("CouchbaseLite", "Failed to set encryption key: ${e.message}")
} catch (e: ClassNotFoundException) {
Log.w("CouchbaseLite", "Failed to set encryption key: ${e.message}")
}
CouchbaseReflectionHelper.changeEncryptionKey(db, null) | ||
return | ||
} | ||
val encryptionKeyValue = EncryptionKey(encryptionKey) | ||
db.changeEncryptionKey(encryptionKeyValue) | ||
CouchbaseReflectionHelper.changeEncryptionKey(db, encryptionKey) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The if
statement here is now redundant. CouchbaseReflectionHelper.changeEncryptionKey
is called in both branches, just with different values for encryptionKey
. You can simplify this by removing the conditional and calling the helper method once, since the helper already handles the null
case.
CouchbaseReflectionHelper.changeEncryptionKey(db, null) | |
return | |
} | |
val encryptionKeyValue = EncryptionKey(encryptionKey) | |
db.changeEncryptionKey(encryptionKeyValue) | |
CouchbaseReflectionHelper.changeEncryptionKey(db, encryptionKey) | |
CouchbaseReflectionHelper.changeEncryptionKey(db, encryptionKey) |
ReflectionHelper checks if EE classes are available in build. If not we get warning