refactor(server/sse): rename WithBasePath to WithStaticBasePath

[rwjblue-glean]

The new name makes its relationship to WithDynamicBasePath clearer.

---

I preserved WithBasePath but added a build time deprecation warning (when using go 1.21+).

Summary by CodeRabbit

• Refactor
  • Improved naming for SSE server configuration to enhance clarity.
• Chores
  • Deprecated the previous configuration option and added guidance for transitioning.
  • Updated tests to reflect the new configuration option name.

[coderabbitai]

Walkthrough

This change renames the WithBasePath function to WithStaticBasePath in the SSE server implementation to clarify its intent. A deprecated wrapper named WithBasePath is added, which internally calls the new function and is marked as deprecated for future removal. Corresponding updates are made in the test suite, replacing all uses of WithBasePath with WithStaticBasePath. No other logic or test behavior is altered.

Changes

Files	Change Summary
server/sse.go	Renamed WithBasePath to WithStaticBasePath; added deprecated WithBasePath wrapper with deprecation notice.
server/sse_test.go	Updated all test cases to use WithStaticBasePath instead of WithBasePath when instantiating SSEServer.

Possibly related PRs

• fix SSEOption #63: Also modifies WithBasePath, changing how base paths and URLs are handled, indicating overlap in function modification.
• feat(server): add option to customize basePath #45: Originally introduced the WithBasePath option, which is directly renamed and wrapped in this PR.

Suggested reviewers

• ezynda3

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e7dbce6 and 66de5fa.

📒 Files selected for processing (2)

• server/sse.go (1 hunks)
• server/sse_test.go (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• server/sse.go
• server/sse_test.go

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[ezynda3]

@robert-jackson-glean try merging the latest from main to see if the tests run plz

[rwjblue-glean]

@ezynda3 nice, that resolved things

I've seen that failure a few times (it's what made me do #215), I'm not 100% sure what's going on there. I can't seem to replicate it locally (even with many runs).

[rwjblue-glean]

I see you did #240 (lol, after I had done #241), trying to help out with the CI flakiness. I think they're probably both complimentary though?