[PR #23935] feat: integrate flask-orjson for improved JSON serialization performance #30449

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

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

State: closed
Merged: Yes


Summary

This PR integrates flask-orjson to significantly improve JSON serialization/deserialization performance in the Dify API. Orjson is a fast, correct JSON library that provides 2-3x performance improvements over the standard library's json module.

Fixes #23934

Key Changes

  1. Added flask-orjson dependency (flask-orjson~=2.0.0) to pyproject.toml
  2. Created ext_orjson extension to properly initialize OrjsonProvider on the Flask app
  3. Updated custom JSON encoders to be compatible with orjson:
    • Added dumps_with_segments() function for Segment type serialization
    • Added dumps_with_sets() function for set type serialization
    • Maintained backward compatibility with existing SegmentJSONEncoder and SetEncoder classes
  4. Updated all JSON encoding usages to use the new orjson-based functions

Backward Compatibility

This is a drop-in replacement that maintains full backward compatibility:

  • No changes required to controller code
  • All existing Flask jsonify() calls work automatically
  • Custom encoders maintain their original interfaces
  • Easy rollback if needed

Screenshots

Before After
Standard json module used for all JSON operations Orjson provides 2-3x faster serialization

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/23935 **State:** closed **Merged:** Yes --- ## Summary This PR integrates [flask-orjson](https://github.com/pallets-eco/flask-orjson) to significantly improve JSON serialization/deserialization performance in the Dify API. Orjson is a fast, correct JSON library that provides 2-3x performance improvements over the standard library's json module. Fixes #23934 ### Key Changes 1. **Added flask-orjson dependency** (`flask-orjson~=2.0.0`) to pyproject.toml 2. **Created ext_orjson extension** to properly initialize OrjsonProvider on the Flask app 3. **Updated custom JSON encoders** to be compatible with orjson: - Added `dumps_with_segments()` function for Segment type serialization - Added `dumps_with_sets()` function for set type serialization - Maintained backward compatibility with existing SegmentJSONEncoder and SetEncoder classes 4. **Updated all JSON encoding usages** to use the new orjson-based functions ### Backward Compatibility This is a drop-in replacement that maintains full backward compatibility: - No changes required to controller code - All existing Flask jsonify() calls work automatically - Custom encoders maintain their original interfaces - Easy rollback if needed ## Screenshots | Before | After | |--------|-------| | Standard json module used for all JSON operations | Orjson provides 2-3x faster serialization | ## 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:47:31 -05:00
yindo closed this issue 2026-02-21 20:47:31 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#30449