Skip to content

Conversation

@anshuman9468
Copy link

@anshuman9468 anshuman9468 commented Dec 10, 2025

This PR introduces the initial gRPC API definition for the Visdom service.

Key Additions

  • Added visdom.proto under the /proto directory.
  • Defined core messages: Window, CreateWindowRequest, UpdateWindowRequest, GetWindowRequest, etc.
  • Added service definition Visdom with the following RPC methods:
    • CreateWindow
    • UpdateWindow
    • GetWindow
    • ListWindows

Purpose

This proto file provides a cross-language, strongly-typed API contract for the Visdom system.
It will allow generating client and server stubs for multiple languages (Go, Python, JS, Java, C#, etc.) using protoc.

Notes

  • The structure follows proto3 standards.
  • Language-specific options (Java, Go, C#) are included for compatibility.
  • Ready for integration with the existing project backend.

Please review and let me know if any additional fields or RPC methods should be added.

Summary by Sourcery

Introduce the initial gRPC API contract for the Visdom service as a proto3 definition.

New Features:

  • Add visdom.proto defining core Visdom messages such as windows and related request/response types.
  • Define the Visdom gRPC service with RPCs for creating, updating, retrieving, and listing windows.

@sourcery-ai
Copy link

sourcery-ai bot commented Dec 10, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Introduces the initial gRPC API contract for the Visdom service via a new visdom.proto definition, including core window-related messages, RPC methods, and language-specific options for multi-language stub generation.

File-Level Changes

Change Details Files
Add initial proto3-based Visdom gRPC API definition
  • Create visdom.proto under the proto directory using proto3 syntax
  • Define core request/response and entity messages such as Window, CreateWindowRequest, UpdateWindowRequest, and GetWindowRequest to model window operations
  • Declare Visdom service with RPCs CreateWindow, UpdateWindow, GetWindow, and ListWindows for managing windows
  • Include language-specific options (e.g., Java, Go, C#) to support code generation across multiple runtimes and integration with the existing backend
proto/visdom.proto

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes - here's some feedback:

  • For ListWindows, consider adding explicit pagination (page_size/page_token and next_page_token) and basic filtering/sorting fields now, so the API doesn’t need a breaking change once the number of windows grows.
  • Ensure request messages for mutations (e.g., CreateWindowRequest/UpdateWindowRequest) clearly separate server-assigned identifiers from client-specified ones and provide an idempotency key if these calls may be retried.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- For `ListWindows`, consider adding explicit pagination (page_size/page_token and next_page_token) and basic filtering/sorting fields now, so the API doesn’t need a breaking change once the number of windows grows.
- Ensure request messages for mutations (e.g., `CreateWindowRequest`/`UpdateWindowRequest`) clearly separate server-assigned identifiers from client-specified ones and provide an idempotency key if these calls may be retried.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant