search

yorkie-team / yorkie

Yorkie is a document store for collaborative applications.
https://yorkie.dev
Apache License 2.0
748 stars 133 forks source link

Add GetDocuments API returning document summaries #909

Closed hackerwins closed 2 weeks ago

hackerwins commented 2 weeks ago

What this PR does / why we need it:

Add GetDocuments API returning document summaries

Which issue(s) this PR fixes:

Fixes #823

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes include updates and enhancements to the Yorkie project, optimizing API documentation and adding features such as a Bulk GET REST API for retrieving multiple documents. Several formatting corrections in YAML files were made, new methods were introduced in admin.proto and corresponding Go files, and new functionalities were created for handling projects and documents within server files.

Changes

File(s) Change Summary
api/docs/yorkie/v1/resources.openapi.yaml Minor formatting, quotation changes, and URL updates.
api/docs/yorkie/v1/yorkie.openapi.yaml Description updates and URLs for server modifications.
api/yorkie/v1/admin.proto Added GetDocuments RPC method along with corresponding request and response message types.
api/yorkie/v1/v1connect/admin.connect.go Introduced GetDocuments method to AdminServiceClient and associated handling mechanisms.
server/documents/documents.go Added GetDocumentSummaries function to return a list of document summaries.
server/rpc/admin_server.go Added GetDocuments function to interact with project and document entities to retrieve documents based on specified keys.
server/server.go Modified DeactivateClient method to use DefaultProject, added DefaultProject and CreateProject methods for handling projects.
test/helper/helper.go Updated TestDocKey function to accept an additional variadic parameter prefix ...int.
test/integration/restapi_test.go Added test functions for REST API interactions related to document retrieval including single, bulk, and listing documents.

Sequence Diagram(s)

sequenceDiagram
    actor User
    user ->> AdminService: GetBulkDocumentsRequest
    AdminService ->> ProjectManager: RetrieveProject(projectName)
    ProjectManager -->> AdminService: Project
    AdminService ->> DocumentStore: FetchDocuments(project, documentKeys)
    DocumentStore -->> AdminService: List of Documents
    AdminService -->> user: GetBulkDocumentsResponse

Assessment against linked issues

Objective (Issue #823) Addressed Explanation
Introduce Bulk GET REST API for retrieving multiple documents (#823) ✅
Optimize the process of retrieving document information ✅
Ensure reduced number of API calls ✅
Implement the described request and response formats ✅

In code where data dances swift, We send requests, responses drift. Bulk documents gather in a line, Streamlined access, so divine! Yorkie's APIs now, robust and clean, In the world of bytes, they reign supreme.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 0% with 31 lines in your changes missing coverage. Please review.

Project coverage is 50.57%. Comparing base (4226417) to head (5a1d1fd).

Files Patch % Lines
server/rpc/admin_server.go 0.00% 22 Missing :warning:
server/server.go 0.00% 9 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #909 +/- ## ========================================== - Coverage 50.72% 50.57% -0.15% ========================================== Files 70 70 Lines 10479 10509 +30 ========================================== Hits 5315 5315 - Misses 4636 4666 +30 Partials 528 528 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.