search

digital-land / submit

0 stars 1 forks source link

608 check not accepting endpoints #623

Closed GeorgeGoodall-GovUk closed 3 weeks ago

GeorgeGoodall-GovUk commented 3 weeks ago

What type of PR is this? (check all applicable)

Description

after a url is submitted in check, During local validation when we get the HEAD object of the url. if the server that hosts the submitted URL doesn't allow head requests, or if the head request fails. don't attempt to perform validations on the head object

Related Tickets & Documents

QA Instructions, Screenshots, Recordings

You can test with this known endpoint, where a head request returns status 405 (method not allowed). but the file itself is valid and should return some check results

Added/updated tests?

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes in this pull request involve modifications to the SubmitUrlController class in src/controllers/submitUrlController.js and the addition of new unit tests in test/unit/submitUrlController.test.js. A new constant for HTTP status 405 is introduced, and the localUrlValidation method is enhanced to improve error handling for HEAD requests, including logging warnings and returning null for specific failure scenarios. Corresponding unit tests are added to ensure these new behaviours are correctly validated.

Changes

Files Change Summary
src/controllers/submitUrlController.js Added constant HTTP_STATUS_METHOD_NOT_ALLOWED for HTTP 405; updated localUrlValidation method for improved error handling with HEAD requests.
test/unit/submitUrlController.test.js Added new test cases for localUrlValidation to cover HEAD request failures and HTTP 405 responses.

Assessment against linked issues

Objective Addressed Explanation
Check not accepting endpoints (#[608]) ✅

Suggested labels

bug

Poem

In the burrows deep, where the code does leap,
A controller now handles with care, not a peep.
HEAD requests may falter, yet warnings will show,
With tests that ensure our logic will flow.
Hop, skip, and jump, through the lines we weave,
A patch for the bugs, oh, how we believe! 🐰✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 3 weeks ago

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 63.04% 3729 / 5915
🔵 Statements 63.04% 3729 / 5915
🔵 Functions 64.65% 161 / 249
🔵 Branches 81.09% 446 / 550
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
src/controllers/submitUrlController.js 91.39% 78.57% 100% 91.39% 39-41, 121-124, 147-149, 163-165, 180-182
Generated in workflow #196 for commit 36a5787 by the Vitest Coverage Report Action