refactor(types): migrate enum to const assertion with type inference (WIP)
resolve: https://github.com/langgenius/dify/issues/27998
Summary
Could you please review whether this approach is reasonable? If so, I'll proceed with the complete refactoring, as this is a substantial project.
Checklist
- [ ] This change requires a documentation update, included: Dify Document
- [x] I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
- [x] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
- [x] I've updated the documentation accordingly.
- [x] I ran
dev/reformat(backend) andcd web && npx lint-staged(frontend) to appease the lint gods
Summary of Changes
Hello @coding-ice, I'm Gemini Code Assist[^1]! 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 begins a strategic refactoring of type definitions within the frontend codebase. It specifically targets the MediaType enum, converting it to a const assertion object to improve type inference and align with modern TypeScript practices. The author is seeking early feedback on this approach before extending the refactoring to other parts of the project, aiming for a more robust and maintainable type system.
Highlights
- Type Refactoring: The
MediaTypeenum inweb/hooks/use-breakpoints.tshas been refactored into aconst assertionobject namedmediaTypeMap. This change allows for more precise type inference and potentially better performance or bundle size optimization in TypeScript. - Consistent Usage Update: All instances where
MediaTypeenum members (e.g.,MediaType.mobile,MediaType.pc) were used across various UI components have been updated to reference the newmediaTypeMapobject (e.g.,mediaTypeMap.mobile,mediaTypeMap.pc). This ensures consistency with the new type definition. - New Utility Types: Two new utility types,
ObjectKeysandObjectValues, have been introduced inweb/types/type.d.ts. These types provide enhanced type safety when working with object keys and values, which can be beneficial for future type-driven refactoring.
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 :thumbsup: and :thumbsdown: 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.
[^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.
@crazywoola CC 🙏