Skip to content

chore: update permify api version v1.3.2 #2050

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

Merged
merged 2 commits into from
Feb 25, 2025

Conversation

tolgaOzen
Copy link
Member

@tolgaOzen tolgaOzen commented Feb 25, 2025

Summary by CodeRabbit

  • Documentation
    • Updated API documentation and references to version v1.3.2.
  • New Features
    • Introduced a customizable option for server identification in distributed deployments, enhancing configuration flexibility.

Copy link

coderabbitai bot commented Feb 25, 2025

Walkthrough

This pull request updates the API version from "v1.3.1" to "v1.3.2" across documentation files and the internal version constant. It also modifies the NewCheckEngineWithBalancer function in the balancer engine by adding a new parameter (no string) for TLS credential initialization and updates the related function call in the serve command file.

Changes

File(s) Change Summary
docs/api-reference/apidocs.swagger.json, docs/api-reference/openapiv2/apidocs.swagger.json, internal/info.go, proto/base/v1/openapi.proto Updated API version from "v1.3.1" to "v1.3.2".
internal/engines/balancer/balancer.go, pkg/cmd/serve.go Modified function signature of NewCheckEngineWithBalancer by adding a no string parameter and updating its call.

Sequence Diagram(s)

sequenceDiagram
    participant S as Serve Component
    participant B as Balancer Engine
    participant T as TLS Creator
    S ->> B: Call NewCheckEngineWithBalancer(cfg.NameOverride, ...)
    B ->> T: Create TLS credentials using 'no'
    T -->> B: Return TLS Credentials
    B -->> S: Return Checker Engine
Loading

Possibly related PRs

Poem

I'm a hopping code bunny on a merry spree,
Upgrading versions swiftly for all to see.
Swagger docs to balancer, each change is in tune,
Adding parameters like a soft spring June.
My code hops along with a joyful, playful beat—
A rabbit's rhyme in every line, oh so sweet! 🐰✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

level=warning msg="[config_reader] The configuration option run.skip-dirs is deprecated, please use issues.exclude-dirs."
level=warning msg="[config_reader] The configuration option linters.govet.check-shadowing is deprecated. Please enable shadow instead, if you are not using enable-all."
level=warning msg="[config_reader] The configuration option linters.gci.local-prefixes is deprecated, please use prefix() inside linters.gci.sections."
Error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24)
Failed executing command with error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24)

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
internal/engines/balancer/balancer.go (1)

36-36: Consider using a more descriptive parameter name.

The parameter name no is not very descriptive. Consider renaming it to something more meaningful like serverNameOverride or tlsServerName to better reflect its purpose as the server name used for TLS credentials.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aee3cf0 and cfa88dd.

⛔ Files ignored due to path filters (1)
  • pkg/pb/base/v1/openapi.pb.go is excluded by !**/*.pb.go
📒 Files selected for processing (6)
  • docs/api-reference/apidocs.swagger.json (1 hunks)
  • docs/api-reference/openapiv2/apidocs.swagger.json (1 hunks)
  • internal/engines/balancer/balancer.go (2 hunks)
  • internal/info.go (1 hunks)
  • pkg/cmd/serve.go (1 hunks)
  • proto/base/v1/openapi.proto (1 hunks)
✅ Files skipped from review due to trivial changes (4)
  • proto/base/v1/openapi.proto
  • internal/info.go
  • docs/api-reference/apidocs.swagger.json
  • docs/api-reference/openapiv2/apidocs.swagger.json
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test with Coverage
  • GitHub Check: Analyze (go)
🔇 Additional comments (2)
pkg/cmd/serve.go (1)

450-458: Function call updated to match new signature.

The code now correctly passes cfg.NameOverride as a parameter to balancer.NewCheckEngineWithBalancer(), which matches the updated function signature in the balancer package. This parameter is used for TLS credential initialization in distributed mode.

internal/engines/balancer/balancer.go (1)

51-51: Parameter now used for TLS server name verification.

The new parameter is correctly passed to credentials.NewClientTLSFromFile() as the server name. This allows for proper TLS verification when connecting to servers in distributed mode.

@tolgaOzen tolgaOzen merged commit 3907c5c into master Feb 25, 2025
12 checks passed
@tolgaOzen tolgaOzen deleted the update-permify-api-version-v1.3.2 branch February 25, 2025 09:21
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