[PR #27675] refactor: replace hardcoded user plan strings with CloudPlan enum #31832

Closed
opened 2026-02-21 20:50:13 -05:00 by yindo · 0 comments
Owner

Original Pull Request: https://github.com/langgenius/dify/pull/27675

State: closed
Merged: Yes


Summary

This PR introduces a CloudPlan StrEnum to replace hardcoded user plan string literals throughout the backend codebase, improving type safety and maintainability.

Changes:

  • Created api/enums/cloud_plan.py with CloudPlan enum (SANDBOX, PROFESSIONAL, TEAM)
  • Used Python's auto() for automatic lowercase value generation
  • Replaced hardcoded 'sandbox' strings with CloudPlan.SANDBOX in 18 production files
  • Updated 4 test files for consistency
  • All existing tests pass, lint and type checks pass

Benefits:

  • Type Safety: Compile-time checking prevents typos and invalid plan values
  • Maintainability: Centralized plan definitions in one location
  • Code Clarity: Explicit enum members are more self-documenting than string literals
  • Consistency: Ensures uniform plan identifiers across the codebase

Fixes #27674

Screenshots

N/A - Backend refactoring only, no UI changes

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
**Original Pull Request:** https://github.com/langgenius/dify/pull/27675 **State:** closed **Merged:** Yes --- ## Summary This PR introduces a `CloudPlan` StrEnum to replace hardcoded user plan string literals throughout the backend codebase, improving type safety and maintainability. **Changes:** - Created `api/enums/cloud_plan.py` with CloudPlan enum (SANDBOX, PROFESSIONAL, TEAM) - Used Python's `auto()` for automatic lowercase value generation - Replaced hardcoded 'sandbox' strings with `CloudPlan.SANDBOX` in 18 production files - Updated 4 test files for consistency - All existing tests pass, lint and type checks pass **Benefits:** - **Type Safety**: Compile-time checking prevents typos and invalid plan values - **Maintainability**: Centralized plan definitions in one location - **Code Clarity**: Explicit enum members are more self-documenting than string literals - **Consistency**: Ensures uniform plan identifiers across the codebase Fixes #27674 ## Screenshots N/A - Backend refactoring only, no UI changes ## Checklist - [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) - [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) and `cd web && npx lint-staged`(frontend) to appease the lint gods
yindo added the pull-request label 2026-02-21 20:50:13 -05:00
yindo closed this issue 2026-02-21 20:50:13 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#31832