X Tutup
Skip to content

Remove unused host parameter#398

Open
cjbarth wants to merge 1 commit intonode-saml:masterfrom
cjbarth:remove-deprecated
Open

Remove unused host parameter#398
cjbarth wants to merge 1 commit intonode-saml:masterfrom
cjbarth:remove-deprecated

Conversation

@cjbarth
Copy link
Collaborator

@cjbarth cjbarth commented Jul 27, 2025

Description

As referenced here, the host parameter is deprecated and should have been removed in the last breaking release. This PR is queued up for when we're ready for the next breaking release (which will also remove Node@18 support).

Summary by CodeRabbit

  • Refactor
    • Simplified the process for generating authorization URLs and forms by removing an unused parameter from related methods. No changes to user-facing functionality.

@coderabbitai
Copy link

coderabbitai bot commented Jul 27, 2025

Walkthrough

The update removes the host parameter from the signatures and internal calls of three asynchronous methods in the SAML class: getAuthorizeUrlAsync, getAuthorizeMessageAsync, and getAuthorizeFormAsync. Only the method signatures and their invocations are changed; internal logic and control flow remain otherwise unaltered.

Changes

Cohort / File(s) Change Summary
src/saml.ts Removed the host parameter from the signatures and calls of getAuthorizeUrlAsync, getAuthorizeMessageAsync, and getAuthorizeFormAsync methods in the SAML class. No other logic was changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A hop and a skip, the host hops away,
SAML’s methods are lighter today.
No more hosts to pass or track,
Just simpler calls—no looking back!
With every change, the code grows neat,
A rabbit’s work is quite the treat! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 1d8d66f and be414d8.

📒 Files selected for processing (1)
  • src/saml.ts (1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Build Status
src/saml.ts

[warning] 1-1: Prettier formatting check failed. Run 'prettier --write' to fix code style issues.

🔇 Additional comments (1)
src/saml.ts (1)

576-576: Internal call updated correctly

The call to getAuthorizeMessageAsync now matches the new two-parameter signature—nice catch.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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 generate unit tests to generate unit tests for 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.

@cjbarth cjbarth added this to the v6 milestone Jul 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

X Tutup