Skip to content

Add validation for Old and New URL in both the interface and CSV import #175

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

GeekInTheNorth
Copy link

See #174

Add validation to ensure Old Url and New Url are valid absolute or relative Uris
Updated the CSV import functionality to skip entries where either the Old or New Url is not a valid absolute or relative Uri.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @GeekInTheNorth, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the robustness of URL handling within the redirect management system. It introduces comprehensive validation for both user-entered and CSV-imported redirect URLs, ensuring that only well-formed absolute or relative URIs are accepted. This prevents the creation of broken redirects and enhances data integrity across the application.

Highlights

  • UI Validation for Redirects: I've added client-side validation to the RedirectModel by implementing IValidatableObject. This ensures that when users manually create or edit redirects via the admin interface, both the 'Old Url' and 'New Url' fields are validated to be well-formed absolute or relative URIs before submission. This prevents invalid URLs from being saved.
  • CSV Import Validation and Skipping: I've enhanced the CSV import functionality to include validation for 'Old Url' and 'New Url' entries. During the import process, each row is now checked for valid URI formats. If either URL in a CSV entry is not a well-formed absolute or relative URI, that specific entry will be skipped, and a warning will be logged, preventing malformed redirects from being imported into the system.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

The pull request successfully adds URL validation for OldUrl and NewUrl in both the admin interface model (RedirectModel.cs) and the CSV import process (RedirectsCsvParser.cs). The validation ensures that these URLs are well-formed, either as relative or absolute URIs. The CSV import now correctly skips and logs entries with invalid URLs. The changes are clear and address the stated objectives. A minor suggestion is provided to potentially centralize the URL validation logic for improved long-term maintainability if this pattern is expected to proliferate.

Comment on lines +65 to +69
private static bool IsValidRedirect(CsvImportModel model)
{
return Uri.IsWellFormedUriString(model.OldUrl, UriKind.RelativeOrAbsolute)
&& Uri.IsWellFormedUriString(model.NewUrl, UriKind.RelativeOrAbsolute);
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The URL validation logic Uri.IsWellFormedUriString(url, UriKind.RelativeOrAbsolute) is also used in RedirectModel.Validate. While not a major issue with only two occurrences, consider centralizing this logic into a shared static utility method if this validation pattern is expected to be used elsewhere or might evolve. This would improve maintainability by ensuring a single source of truth for what constitutes a valid redirect URL string.

For example, you could have a utility class:

public static class UrlValidationHelper
{
    public static bool IsValidRedirectUri(string uriString)
    {
        return Uri.IsWellFormedUriString(uriString, UriKind.RelativeOrAbsolute);
    }
}

Then, both RedirectModel.Validate and this IsValidRedirect method could call UrlValidationHelper.IsValidRedirectUri().

@GeekInTheNorth
Copy link
Author

@valdisiljuconoks Assuming you're okay with the initial approach, I can refactor the model validation into an extension method. I can also then apply this to the TXT and XML imports as well.

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.

1 participant