fix: webauth no need to validate hostname on cli request

[fengmk2]

closes #718

Summary by CodeRabbit

• Refactor

  • Updated login processing to allow for optional hostname information, aligning with the latest CLI behavior.

• Tests

  • Modified test case for the login endpoint to reflect the change in hostname requirement, now asserting a successful response without a hostname.

[coderabbitai]

Walkthrough

This pull request updates the LoginRequestRule type within the WebauthController. The hostname property, previously required, is now optional to reflect changes in reporting from the npm CLI. Additionally, the test for the login endpoint has been modified to reflect this change, asserting that requests without a hostname now return a successful response instead of an error. No modifications to method signatures, control flow, or additional logic have been made.

Changes

File	Change Summary
app/.../WebauthController.ts	Modified LoginRequestRule: changed hostname from a required string to an optional string with limits.
test/.../webauthController.test.ts	Updated test case for /-/v1/login: renamed and changed logic to assert successful response without hostname.

Assessment against linked issues

Objective	Addressed	Explanation
Update hostname handling in login request (#718)	✅
Ensure API responds correctly without hostname	✅

Suggested labels

enhancement

Suggested reviewers

• elrrrrrrr
• killagu

Poem

In the realm of code, I hop so light,
A tweak in types brings a new delight.
Hostnames optional, like a secret treat,
Adjustments in code make the rhythm complete.
With a twitch of my nose and a joyful leap,
I celebrate changes that are smooth and neat!

✨ 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

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

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.

[elrrrrrrr]

LGTM

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

test/port/webauth/webauthController.test.ts (1)

29-34: Improve test coverage and fix grammatical error in test name.

The test case has a grammatical error in its name and could benefit from additional test scenarios.

Apply this diff to improve the test:

-    it('should hostname is optional', async () => {
+    it('should accept requests with or without hostname', async () => {
+      // Test without hostname
       const res = await app.httpRequest()
         .post('/-/v1/login');
       assert.equal(res.status, 200);
+
+      // Test with hostname
+      const resWithHostname = await app.httpRequest()
+        .post('/-/v1/login')
+        .send({
+          hostname: 'test',
+        });
+      assert.equal(resWithHostname.status, 200);
     });

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9537aad and 1bd7352.

📒 Files selected for processing (1)

• test/port/webauth/webauthController.test.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (10)

• GitHub Check: test-mysql57-fs-nfs (22, ubuntu-latest)
• GitHub Check: test-postgresql-fs-nfs (22, ubuntu-latest)
• GitHub Check: test-mysql57-fs-nfs (20, ubuntu-latest)
• GitHub Check: test-postgresql-fs-nfs (20, ubuntu-latest)
• GitHub Check: test-mysql57-fs-nfs (18, ubuntu-latest)
• GitHub Check: test-postgresql-fs-nfs (18, ubuntu-latest)
• GitHub Check: test-mysql57-fs-nfs (18.20.0, ubuntu-latest)
• GitHub Check: Analyze (typescript)
• GitHub Check: test-postgresql-fs-nfs (18.20.0, ubuntu-latest)
• GitHub Check: Analyze (javascript)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.42%. Comparing base (1850c8b) to head (1bd7352).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #752      +/-   ##
==========================================
- Coverage   96.47%   96.42%   -0.05%     
==========================================
  Files         191      191              
  Lines       19232    19232              
  Branches     2508     2503       -5     
==========================================
- Hits        18554    18545       -9     
- Misses        678      687       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.