improved unit test case coverage for controller/common module

[rajatagarwal-oss]

Important

1. Make sure you have read our contribution guidelines
2. Ensure there is an associated issue and you have been assigned to it
3. Use the correct syntax to link this PR: Fixes #<issue number>.

Summary

Improved the unit test case coverage for the controller/common module.

Screenshots

Before	After
...	...

Checklist

• This change requires a documentation update, included: Dify Document
• I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
• I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
• I've updated the documentation accordingly.
• I ran make lint and make type-check (backend) and cd web && npx lint-staged (frontend) to appease the lint gods

[gemini-code-assist]

Summary of Changes

Hello @rajatagarwal-oss, I'm Gemini Code Assist¹! 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 unit test coverage for the controllers/common module. It introduces new test files and expands existing ones to validate the behavior of error classes, file response utilities, file information helpers, and schema registration functions. The changes aim to enhance the reliability and maintainability of these core components by ensuring their correctness across various scenarios.

Highlights

• New Unit Tests for Error Handling: Introduced comprehensive unit tests for various error classes within controllers.common.errors, ensuring their default codes and descriptions are correctly set.
• Enhanced File Response Utility Tests: Expanded test coverage for controllers.common.file_response utilities, including _normalize_mime_type, is_html_content, and enforce_download_for_html, to cover more edge cases and ensure robust header manipulation for HTML content.
• New Unit Tests for File Information Helpers: Added a new test file for controllers.common.helpers, specifically for the guess_file_info_from_response function, covering various scenarios of extracting file metadata from HTTP responses, and also tests for magic library import warnings.
• New Unit Tests for Schema Registration: Implemented new unit tests for schema-related helper functions in controllers.common.schema, verifying the correct registration of Pydantic models and Python enums with Flask-RESTX namespaces.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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

[gemini-code-assist]

Code Review

This pull request significantly improves the unit test coverage for the controller/common module by adding new test files for errors, helpers, and schema logic, and by expanding existing tests for file responses. The new tests are well-structured and cover many scenarios, including edge cases. My feedback focuses on making one of the new tests more robust by handling environment variations explicitly.

[gemini-code-assist]

The test test_generated_filename_when_missing implicitly depends on the python-magic library being installed. This makes the test result dependent on the environment. To make the test more robust and explicit, it's better to test both scenarios: when python-magic is available and when it's not.

I suggest parameterizing this test to cover both cases. This will ensure the fallback logic (using .bin extension) is also tested.

    @pytest.mark.parametrize(
        "magic_available, expected_ext",
        [
            (True, "txt"),
            (False, "bin"),
        ],
    )
    def test_generated_filename_when_missing(self, monkeypatch, magic_available, expected_ext):
        if magic_available:
            if helpers.magic is None:
                pytest.skip("python-magic is not installed, cannot run 'magic_available=True' test variant")
        else:
            monkeypatch.setattr(helpers, "magic", None)

        response = make_response(
            url="https://example.com/",
            content=b"Hello World",
        )

        info = guess_file_info_from_response(response)

        name, ext = info.filename.split(".")
        UUID(name)  # validates UUID
        assert ext == expected_ext