v0.26.0 - Major Release (UX and polish focused)

[TkTech]

(This is a huge release, changelog to come. WIP)

0.26.0

✨ Improvements

• Reworked the dashboard, much more informative for operational insights, light/dark themes.
• Added much, much better composable filtering widgets to both jobs and workflows.
• Added a visualization of your upcoming (and past) cron schedule, making it easy to identify overloaded periods.
• Added a realtime view of the internal Chancy communication traffic, helping to debug and identify pain points (like using push() in a loop instead of a single push_many())
• HTTP API now supports mutation - create queues on the fly, move jobs around, retry workflows, etc...
• HTTP API is now stable, with documentation still a work in progress.
• HTTP API now includes an unauthenticated endpoint for health checks, meant for docker/containers (Best way to do containerised healthchecks on workers #54)
• Added dozens of new metrics, including metrics for the metrics plugin and metrics on workflows.
• Added postgres 18 to test matrix (@jklaise)
• The starlette app can now be created without being started for advanced use cases, and the mounting prefix for the SPA can be changed (@jklaise, Feature request: Expose Starlette API app so it can be mounted onto an existing FastAPI/ASGI app #64)
• Workflow performance has been significantly improved and can now handle many, individual workflows with thousands of jobs without issue.
• Workflows will now be validated before saving, verifying there are no unreachable nodes in the DAG, no cycles, etc
• Can now be used as a django-tasks backend, albeit with less functionality than using Chancy directly

🐛 Fixes

• Respect CLI flags for API plugin configuration by @alfawal (Respect CLI flags for API plugin configuration #68)

[codecov]

Codecov Report

❌ Patch coverage is 25.48180% with 348 lines in your changes missing coverage. Please review.
✅ Project coverage is 67.13%. Comparing base (0cb14b1) to head (afed624).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
chancy/plugins/api/core.py	0.00%	210 Missing ⚠️
chancy/plugins/api/auth.py	0.00%	60 Missing ⚠️
chancy/plugins/debug.py	0.00%	19 Missing ⚠️
chancy/plugins/workflow/api.py	0.00%	15 Missing ⚠️
chancy/contrib/django/task_wrapper.py	50.00%	12 Missing ⚠️
chancy/cli/worker.py	0.00%	11 Missing ⚠️
chancy/contrib/django/auth.py	0.00%	8 Missing ⚠️
chancy/contrib/django/backend.py	94.28%	4 Missing ⚠️
chancy/rule.py	62.50%	3 Missing ⚠️
chancy/plugins/api/__init__.py	0.00%	2 Missing ⚠️
... and 3 more

❗ There is a different number of reports uploaded between BASE (0cb14b1) and HEAD (afed624). Click for more details.

HEAD has 8 uploads less than BASE

Flag	BASE (0cb14b1)	HEAD (afed624)
unittests	11	3

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #58      +/-   ##
==========================================
- Coverage   73.19%   67.13%   -6.06%     
==========================================
  Files          58       61       +3     
  Lines        3193     3600     +407     
==========================================
+ Hits         2337     2417      +80     
- Misses        856     1183     +327     

Flag	Coverage Δ
unittests	67.13% <25.48%> (-6.06%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[TkTech]

Added a cron job visualizer.

[fcortes]

Hi! I saw that you mentioned django-tasks compatibility on this PR but couldn't find any reference about it on the code. Do you mind committing those changes or maybe open a new PR with it (to avoid getting this one so large). I was playing around with chancy and also have a semi-functional implementation and it would be nice to see how you managed some issues I've been encountering.

Great project btw!

[phillycheeze]

@TkTech We just started leveraging chancy and super excited for this new dashboard! Any outstanding items you're looking for help with?

[TkTech]

@TkTech We just started leveraging chancy and super excited for this new dashboard! Any outstanding items you're looking for help with?

It's been running for testing in a production environment since Monday, so I'd say we'll release this weekend if all goes well.

[TkTech]

Hi! I saw that you mentioned django-tasks compatibility on this PR but couldn't find any reference about it on the code. Do you mind committing those changes or maybe open a new PR with it (to avoid getting this one so large). I was playing around with chancy and also have a semi-functional implementation and it would be nice to see how you managed some issues I've been encountering.

Great project btw!

I've left some comments in the #82 ticket regarding this, there are some behavioral Qs to answer before we commit to anything.