Skip to content

Conversation

@asukaminato0721
Copy link
Contributor

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

part of #28015 , port controllers/console/app/app.py to BaseModel

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 dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @asukaminato0721, 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 undertakes a significant refactoring of the application controller, transitioning its data models and serialization mechanisms to leverage Pydantic BaseModels. This change aims to modernize the API response structures, enforce stricter type validation, and streamline the development process by providing a more robust and maintainable data layer.

Highlights

  • Pydantic Migration: The core of this pull request involves migrating data serialization and validation within api/controllers/console/app/app.py from flask_restx.fields to Pydantic BaseModels. This standardizes data handling and improves type safety.
  • New Pydantic Models: Introduced several new Pydantic models, including ResponseModel, Tag, WorkflowPartial, ModelConfigPartial, ModelConfig, Site, DeletedTool, AppPartial, AppDetail, AppDetailWithSite, AppPagination, and AppExportResponse, to define the structure of API responses.
  • Serialization Logic Update: Replaced flask_restx.marshal calls with Pydantic's model_dump(mode="json") for serializing API responses and model_validate for deserialization, ensuring consistent data output.
  • Timestamp and Icon URL Handling: Added utility functions _to_timestamp for normalizing datetime objects to Unix timestamps and _build_icon_url with a computed_field for dynamic icon URL generation, enhancing data consistency and presentation.
  • Unit Tests for Models: A new unit test file, api/tests/unit_tests/controllers/console/app/test_app_response_models.py, has been added to verify the correct serialization and aliasing behavior of the new Pydantic models.

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

Copy link
Contributor

@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

This pull request refactors the API response serialization in api/controllers/console/app/app.py by migrating from flask_restx.fields and marshal to Pydantic BaseModel for defining all response schemas. The changes involve removing flask_restx.fields imports and related model definitions, introducing a ResponseModel base class with Pydantic ConfigDict for attribute mapping and serialization, and utilizing AliasChoices, computed_field, and field_validator for flexible data handling, including timestamp conversions and icon URL generation. API endpoints are updated to explicitly validate and serialize responses using Pydantic's model_validate and model_dump methods, replacing the marshal_with decorator. A new test file, api/tests/unit_tests/controllers/console/app/test_app_response_models.py, was added to verify the correct serialization behavior of the new Pydantic models.

@asukaminato0721 asukaminato0721 marked this pull request as ready for review January 4, 2026 11:24
Copilot AI review requested due to automatic review settings January 4, 2026 11:24
@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Jan 4, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR refactors controllers/console/app/app.py to use Pydantic BaseModel for response serialization instead of flask-restx's field-based marshaling approach. This is part of a larger effort (#28015) to modernize the codebase with Pydantic models for better type safety and validation.

Key Changes:

  • Replaced flask-restx field definitions with Pydantic response models (AppPartial, AppDetail, AppDetailWithSite, etc.)
  • Migrated from marshal and marshal_with decorators to explicit model_validate and model_dump calls
  • Added comprehensive unit tests for response model serialization and field aliasing

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
api/controllers/console/app/app.py Replaced flask-restx field definitions with Pydantic BaseModel classes for response serialization; refactored endpoints to use explicit model validation and dumping instead of marshal decorators
api/tests/unit_tests/controllers/console/app/test_app_response_models.py Added comprehensive unit tests validating response model serialization, field aliasing, timestamp conversion, and icon URL generation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 6, 2026
@crazywoola crazywoola merged commit f320fd5 into langgenius:main Jan 6, 2026
11 checks passed
@asukaminato0721 asukaminato0721 deleted the 28015 branch January 6, 2026 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants