Adding GCP Firestore implementations for CertRecordStore and SSHRecordStore

[psasidhar]

Description

Adding Certificate and SSH Record storage implementions in GCP using Firestore

Contribution Checklist:

• The pull request does not introduce any breaking changes
• I have read the contribution guidelines.
• Create an issue and link to the pull request.

Attach Screenshots (Optional)

[gemini-code-assist]

Summary of Changes

Hello @psasidhar, 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 expands Athenz's data persistence capabilities by integrating Google Cloud Firestore as a backend for storing both X.509 certificate records and SSH certificate records. This change provides a scalable and managed NoSQL database option for environments running on Google Cloud Platform, enhancing flexibility and operational efficiency for certificate and SSH key management within Athenz.

Highlights

• GCP Firestore Integration: Introduced new implementations for CertRecordStore and SSHRecordStore using Google Cloud Firestore, enabling Athenz to leverage Firestore for certificate and SSH record persistence.
• New Firestore Store Implementations: Added FirestoreCertRecordStore and FirestoreSSHRecordStore classes, which serve as the main entry points for interacting with Firestore for their respective record types.
• Firestore Connection and CRUD Operations: Developed FirestoreCertRecordStoreConnection and FirestoreSSHRecordStoreConnection to handle the underlying CRUD (Create, Read, Update, Delete) operations with Firestore, including logic for TTL-based expiry and certificate notification.
• Factory Classes for Firestore Stores: Implemented FirestoreCertRecordStoreFactory and FirestoreSSHRecordStoreFactory to facilitate the creation and configuration of the Firestore-backed record stores, using system properties for project ID, collection name, and database ID.
• Dependency and Build Updates: The google-cloud-firestore dependency was added to libs/java/server_gcp_common/pom.xml, and .gitignore was updated to include new ZTS utility binaries.
• Comprehensive Unit Tests: New unit tests were added for all Firestore-related classes (FirestoreCertRecordStoreConnectionTest, FirestoreCertRecordStoreFactoryTest, FirestoreSSHRecordStoreConnectionTest, FirestoreSSHRecordStoreFactoryTest, FirestoreCertRecordStoreTest, FirestoreSSHRecordStoreTest) to ensure the correctness and reliability of the new implementations.

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 GCP Firestore implementations for CertRecordStore and SSHRecordStore, along with corresponding factories and tests. The overall implementation is well-structured and the tests are quite thorough. However, I've identified a few significant issues related to performance and correctness that should be addressed:

• A potential N+1 query problem in FirestoreCertRecordStoreConnection which could lead to performance degradation.
• An inefficient data update pattern in FirestoreCertRecordStoreConnection that involves redundant database reads.
• Both FirestoreCertRecordStoreConnection and FirestoreSSHRecordStoreConnection ignore the expiryTimeMins parameter in their deleteExpired... methods, which is a deviation from the interface contract.
  My detailed comments and suggestions are provided below.

[havetisyan]

/gemini review

[gemini-code-assist]

Code Review

This pull request introduces GCP Firestore implementations for CertRecordStore and SSHRecordStore, along with corresponding factories and comprehensive unit tests. The implementation is solid, but I've identified a couple of areas for performance improvement in the FirestoreCertRecordStoreConnection class. Specifically, one method can be optimized by using batch writes, and another method exhibits an N+1 query pattern that could be problematic at scale. My review includes suggestions to address these points.