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

Add prefix to namespace #297

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Add prefix to namespace #297

merged 1 commit into from
Dec 2, 2024

Conversation

neekolas
Copy link
Contributor

@neekolas neekolas commented Dec 2, 2024

tl;dr

  • Add prefix to namespace

Summary by CodeRabbit

  • New Features

    • Enhanced error messages for namespace validation to include the invalid input.
    • Updated output format of the namespace to include a "xmtpd-" prefix.
  • Bug Fixes

    • Improved clarity of error messages related to namespace validation.

Copy link

coderabbitai bot commented Dec 2, 2024

Warning

Rate limit exceeded

@neekolas has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 42 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

Reviewing files that changed from the base of the PR and between c9e9bcf and d62d33f.

Walkthrough

The pull request introduces two main changes across two files. In pkg/db/pgx.go, the error message in the isValidNamespace function is updated to include the invalid namespace in the output. In pkg/utils/namespace.go, the BuildNamespace function's return value format is modified to prefix the hexadecimal string with "xmtpd-". The overall logic and functionality of the affected functions remain unchanged.

Changes

File Change Summary
pkg/db/pgx.go Modified the error message in isValidNamespace to include the invalid namespace in the output.
pkg/utils/namespace.go Changed the return value format of BuildNamespace to prefix the hexadecimal string with "xmtpd-".

Possibly related PRs

  • Add support for creating namespaced databases #294: This PR modifies the pkg/db/pgx.go file, specifically the createNamespace function, which is related to the changes made in the isValidNamespace function in the main PR, as both involve namespace validation and management within the same file.

Suggested reviewers

  • mkysel
  • richardhuaaa

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
Contributor Author

neekolas commented Dec 2, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

@neekolas neekolas marked this pull request as ready for review December 2, 2024 23:12
@neekolas neekolas requested a review from a team as a code owner December 2, 2024 23:12
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: 1

🧹 Outside diff range and nitpick comments (2)
pkg/db/pgx.go (2)

74-75: Consider sanitizing namespace value in error message

While including the invalid namespace in the error message improves debugging, consider sanitizing or truncating the value to prevent potential information disclosure.

Consider this approach:

-			"namespace must start with a letter or underscore and contain only letters, numbers, and underscores. Instead is %s",
-			namespace,
+			"namespace must start with a letter or underscore and contain only letters, numbers, and underscores. Instead got: %.32s",
+			namespace,

This ensures the error message won't expose more than 32 characters of potentially sensitive data.


Line range hint 16-16: Critical: Namespace prefix incompatible with PostgreSQL identifier rules

The new "xmtpd-" prefix in BuildNamespace contains a dash (-) character, which violates the PostgreSQL identifier rules enforced by isValidNamespace. This will cause validation failures as the regex pattern ^[a-zA-Z_][a-zA-Z0-9_]*$ only allows letters, numbers, and underscores.

Consider these options:

  1. Use underscore instead of dash: "xmtpd_"
  2. Modify the validation regex to allow dashes
  3. Use a different namespace format that complies with PostgreSQL rules

Example fix for option 1:

-	return fmt.Sprintf("xmtpd-%s", HexEncode(hash)[:12])
+	return fmt.Sprintf("xmtpd_%s", HexEncode(hash)[:12])

Also applies to: 74-75

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a50c51e and c9e9bcf.

📒 Files selected for processing (2)
  • pkg/db/pgx.go (1 hunks)
  • pkg/utils/namespace.go (2 hunks)

pkg/utils/namespace.go Outdated Show resolved Hide resolved
@neekolas neekolas force-pushed the 12-02-add_prefix_to_namespace branch from c9e9bcf to d62d33f Compare December 2, 2024 23:19
@neekolas neekolas merged commit 906ba3f into main Dec 2, 2024
9 checks passed
@neekolas neekolas deleted the 12-02-add_prefix_to_namespace branch December 2, 2024 23:44
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.

2 participants