feat: Add version_of and matches to rules and conditions

[zachaysan]

Changes

When creating a new change request for segments we need a way of tracing which provided rules and conditions match the candidate change request so that the frontend can more visually associate which rules and conditions match between the change request and the targeted segment (the one that will be updated).

To do so I've reused the concept of version_of which was originally used for segments and I associate a rule to another rule (or sub-rule to sub-rule) and in that process also match up conditions at the same layer. If at least one condition matches, then the sub-rule and rule match and future matching for the subsequent sub-rule is guided by holding onto the match between the parent rule and its sister rule. This way matches are only ever tree like in nature.

Remaining work

Since the matching code is ready in this PR another PR will need to be opened to tie in these changes into the relevant code. Probably both the Workflows and Commons will need to be updated.

How did you test this code?

Lots of new tests. Some are simple, like checking that version_of gets correctly set, which is necessary due to an audit log bug we had when version_of was setup for the segments work.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
flagsmith-frontend-preview	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 31, 2025 2:37pm
flagsmith-frontend-staging	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 31, 2025 2:37pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
docs	⬜️ Ignored (Inspect)	Visit Preview		Jan 31, 2025 2:37pm

[github-actions]

Docker builds report

Image	Build Status	Security report
ghcr.io/flagsmith/flagsmith-e2e:pr-4988	Finished ✅	Skipped
ghcr.io/flagsmith/flagsmith-api-test:pr-4988	Finished ✅	Skipped
ghcr.io/flagsmith/flagsmith-api-test:pr-4988	Finished ✅	Skipped
ghcr.io/flagsmith/flagsmith-e2e:pr-4988	Finished ✅	Skipped
ghcr.io/flagsmith/flagsmith-frontend:pr-4988	Finished ✅	Results ✅
ghcr.io/flagsmith/flagsmith-api:pr-4988	Finished ✅	Results ✅
ghcr.io/flagsmith/flagsmith-frontend:pr-4988	Finished ✅	Results ✅
ghcr.io/flagsmith/flagsmith:pr-4988	Finished ✅	Results ✅
ghcr.io/flagsmith/flagsmith:pr-4988	Finished ✅	Results ✅
ghcr.io/flagsmith/flagsmith-private-cloud:pr-4988	Finished ✅	Results ✅
ghcr.io/flagsmith/flagsmith-private-cloud:pr-4988	Finished ✅	Results ✅

[github-actions]

Uffizzi Ephemeral Environment deployment-59778

☁️ https://app.uffizzi.com/github.com/Flagsmith/flagsmith/pull/4988

📄 View Application Logs etc.

What is Uffizzi? Learn more!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.45%. Comparing base (b0d0a80) to head (41ec3ad).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4988      +/-   ##
==========================================
+ Coverage   97.43%   97.45%   +0.01%     
==========================================
  Files        1214     1216       +2     
  Lines       42253    42544     +291     
==========================================
+ Hits        41169    41460     +291     
  Misses       1084     1084              

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

[matthewelwell]

Let's remember to update these once we've got builds in those packages.

[zachaysan]

Good idea.

[zachaysan]

Since I'm on my last day I'd like to add some comments to this PR about where we are at.

Overall this work should be considered to be feature complete. Change requests for segments can be created, updated, approved, and committed in order to update the underlying segment. The attribute version_of was added to rules and conditions to allow for the frontend to assign diffs in conjunction with what a likely diff should be.

In order to properly merge this code the following updates need to happen:

1. flagsmith-common in pyproject.toml must be updated to a new tag that include previously merged work, which includes feat: Add version_of to rules and conditions serializers flagsmith-common#11.
2. This PR https://github.com/Flagsmith/flagsmith-workflows/pull/63 needs updating as well, both for the same flagsmith-common library as well as for the image in the docker-compose file which must be set to ghcr.io/flagsmith/flagsmith-api-test:main. I'm not sure how to solve the circular dependency because we also must...
3. Update the workflows-logic in pyproject.toml in this repo once step 2 can be merged into the workflows repository and tagged as a release.

When in doubt about how to run some chunk of functionality, look into the tests in the workflows PR here: https://github.com/Flagsmith/flagsmith-workflows/pull/63 including tests that pre-exist that PR.