Skip to content
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

feat/bug: Add JSON schema + add missing pool default init #121

Merged
merged 2 commits into from
Oct 25, 2024
Merged

Conversation

nickdnk
Copy link
Member

@nickdnk nickdnk commented Oct 24, 2024

fix missing pool default init

Reason for This PR

Added JSON schema.
Pool did not have its defaults set if you provided partial values.

Description of Changes

Added JSON schema.
Moved c.Pool.InitDefaults() outside the init method.

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the MIT license.

PR Checklist

[Author TODO: Meet these criteria.]
[Reviewer TODO: Verify that these criteria are met. Request changes if not]

  • All commits in this PR are signed (git commit -s).
  • The reason for this PR is clearly provided (issue no. or explanation).
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • Any user-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.

Summary by CodeRabbit

  • New Features

    • Introduced a JSON schema for the Centrifugo plugin, defining required configuration parameters.
    • Added support for TLS settings within the schema, ensuring proper configuration for secure connections.
  • Bug Fixes

    • Updated the initialization logic for the Pool configuration to ensure defaults are always set correctly.

fix missing pool default init
@nickdnk nickdnk added bug Something isn't working documentation Improvements or additions to documentation labels Oct 24, 2024
@nickdnk nickdnk requested a review from rustatian October 24, 2024 19:21
@nickdnk nickdnk self-assigned this Oct 24, 2024
Copy link

coderabbitai bot commented Oct 24, 2024

Warning

Rate limit exceeded

@nickdnk has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 969b885 and bcb87d0.

Walkthrough

The changes introduced in this pull request involve modifications to the InitDefaults method in config.go, ensuring that the c.Pool.InitDefaults() method is called unconditionally after the c.Pool initialization. Additionally, a new JSON schema file, schema.json, has been added to define the configuration parameters for the Centrifugo plugin for RoadRunner, including properties such as proxy_address, grpc_api_address, and TLS settings.

Changes

File Change Summary
config.go Modified InitDefaults method to unconditionally call c.Pool.InitDefaults() after initialization.
schema.json Introduced a new schema defining configuration parameters for the Centrifugo plugin, including proxy_address, grpc_api_address, and TLS settings.

Poem

In the code where rabbits hop,
Defaults now won't ever stop.
With schemas bright and parameters clear,
Our plugin sings, oh what a cheer!
Hopping through the lines we trace,
Configs now find their rightful place. 🐇✨


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 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: 6

🧹 Outside diff range and nitpick comments (3)
config.go (3)

Line range hint 56-75: Simplify TLS validation logic and remove unnecessary linter directive.

The TLS validation block can be simplified, and the //nolint:nestif comment is no longer necessary as the nesting isn't complex.

-	if c.TLS != nil { //nolint:nestif
-		if _, err := os.Stat(c.TLS.Key); err != nil {
-			if os.IsNotExist(err) {
-				return errors.E(op, errors.Errorf("key file '%s' does not exists", c.TLS.Key))
-			}
-
-			return errors.E(op, err)
-		}
-
-		if _, err := os.Stat(c.TLS.Cert); err != nil {
-			if os.IsNotExist(err) {
-				return errors.E(op, errors.Errorf("cert file '%s' does not exists", c.TLS.Cert))
-			}
-
-			return errors.E(op, err)
-		}
-	}
+	if c.TLS == nil {
+		return nil
+	}
+	
+	for file, fileType := range map[string]string{
+		c.TLS.Key:  "key",
+		c.TLS.Cert: "cert",
+	} {
+		if _, err := os.Stat(file); err != nil {
+			if os.IsNotExist(err) {
+				return errors.E(op, errors.Errorf("%s file '%s' does not exist", fileType, file))
+			}
+			return errors.E(op, errors.Wrapf(err, "failed to check %s file", fileType))
+		}
+	}

Line range hint 24-43: Consider using constants for default values.

To improve maintainability and make it easier to update default values in the future, consider extracting the default values into constants.

+const (
+    defaultGRPCAddress = "127.0.0.1:10000"
+    defaultProxyAddress = "tcp://127.0.0.1:30000"
+    defaultName = "roadrunner"
+    defaultVersion = "1.0.0"
+)

 func (c *Config) InitDefaults() error {
     const op = errors.Op("centrifuge_init_defaults")
 
     if c.GrpcAPIAddress == "" {
-        c.GrpcAPIAddress = "127.0.0.1:10000"
+        c.GrpcAPIAddress = defaultGRPCAddress
     }
 
     if len(c.GrpcAPIAddress) > 7 && c.GrpcAPIAddress[0:6] == "tcp://" {
         c.GrpcAPIAddress = c.GrpcAPIAddress[6:]
     }
 
     if c.ProxyAddress == "" {
-        c.ProxyAddress = "tcp://127.0.0.1:30000"
+        c.ProxyAddress = defaultProxyAddress
     }
 
     if c.Name == "" {
-        c.Name = "roadrunner"
+        c.Name = defaultName
     }
 
     if c.Version == "" {
-        c.Version = "1.0.0"
+        c.Version = defaultVersion
     }

Line range hint 29-31: Improve GrpcAPIAddress prefix handling.

The current implementation uses magic numbers and could be more robust. Consider using strings.TrimPrefix for better readability and maintainability.

-    if len(c.GrpcAPIAddress) > 7 && c.GrpcAPIAddress[0:6] == "tcp://" {
-        c.GrpcAPIAddress = c.GrpcAPIAddress[6:]
-    }
+    const tcpPrefix = "tcp://"
+    c.GrpcAPIAddress = strings.TrimPrefix(c.GrpcAPIAddress, tcpPrefix)

Don't forget to add the import:

+import "strings"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0792a15 and 969b885.

📒 Files selected for processing (2)
  • config.go (1 hunks)
  • schema.json (1 hunks)
🔇 Additional comments (1)
schema.json (1)

35-54: Verify external schema references are accessible.

Let's ensure all external schema references are valid and accessible.

✅ Verification successful

External schema references are accessible and valid

All referenced schema URLs are accessible:

  • https://raw.githubusercontent.com/roadrunner-server/pool/refs/heads/master/schema.json
  • https://raw.githubusercontent.com/roadrunner-server/http/refs/heads/master/schema.json
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that all external schema references are accessible

echo "Checking external schema references..."

# List of schema URLs to check
urls=(
  "https://raw.githubusercontent.com/roadrunner-server/pool/refs/heads/master/schema.json"
  "https://raw.githubusercontent.com/roadrunner-server/http/refs/heads/master/schema.json"
)

for url in "${urls[@]}"; do
  if curl --output /dev/null --silent --head --fail "$url"; then
    echo "✓ Schema accessible: $url"
  else
    echo "✗ Schema not accessible: $url"
  fi
done

Length of output: 1047

config.go Show resolved Hide resolved
schema.json Show resolved Hide resolved
schema.json Show resolved Hide resolved
schema.json Show resolved Hide resolved
schema.json Outdated Show resolved Hide resolved
schema.json Outdated Show resolved Hide resolved
@nickdnk nickdnk merged commit 7310319 into master Oct 25, 2024
7 checks passed
@nickdnk nickdnk deleted the schema branch October 25, 2024 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants