feat(experimentation): add Experiment base model and CRUD endpoints by Zaimwa9 · Pull Request #7591 · Flagsmith/flagsmith

Zaimwa9 · 2026-05-25T09:49:36Z

Thanks for submitting a PR! Please check the boxes below:

I have read the Contributing Guide.
I have added information to docs/ if required so people know about the feature.
I have filled in the "Changes" section below.
I have filled in the "How did you test this code" section below.

Changes

Adds the foundation Experiment model and CRUD endpoints to the experimentation app, enough to wire up the frontend wizard's Step 1 (Setup) and the experiments list page.

Model:

Experiment with FK to Environment and Feature, fields: name, hypothesis, status, created_at, updated_at, started_at, ended_at
ExperimentStatus enum: created, running, paused, completed
DB-level UniqueConstraint on (feature, environment) excluding completed — one active experiment per flag per environment
Soft delete via SoftDeleteExportableModel

Endpoints (nested under /environments/{env_key}/experiments/):

GET / — list, filterable by ?status=
POST / — create (multivariate flags only)
GET /{id}/ — retrieve
PATCH /{id}/ — update name, hypothesis, status

Validations:

Only multivariate features allowed
Feature must belong to the environment's project
Status transitions enforced (created→running, running→paused/completed, paused→running/completed)
Cannot reassign feature after creation
started_at auto-set on first transition to running, ended_at auto-set on completed

Other:

ExperimentPermission gated behind experimental_flags feature flag + environment admin
Audit logging for create/update/delete via RelatedObjectType.EXPERIMENT

How did you test this code?

New tests

make test opts='-k "test_experiment" -n0'

vercel · 2026-05-25T09:49:41Z

The latest updates on your projects. Learn more about Vercel for GitHub.

3 Skipped Deployments

Project	Deployment	Actions	Updated (UTC)
docs	Ignored	Preview	May 27, 2026 9:32am
flagsmith-frontend-preview	Ignored	Preview	May 27, 2026 9:32am
flagsmith-frontend-staging	Ignored	Preview	May 27, 2026 9:32am

github-actions · 2026-05-25T09:50:42Z

Docker builds report

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

gemini-code-assist

Code Review

This pull request introduces a new experimentation framework, including the Experiment model, associated API endpoints, and audit logging. Key additions include status transition logic, permissions based on feature flags, and comprehensive unit tests. Review feedback suggests moving timestamp management to model lifecycle hooks for better consistency, optimizing environment lookups in permission classes by utilizing cached data, and updating the error response status code to 409 when an active experiment already exists to align with existing patterns and handle potential race conditions.

github-actions · 2026-05-25T09:56:24Z

Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
38.9 seconds
b27797d
🔄 Run: #16970 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
36.8 seconds
b27797d
🔄 Run: #16970 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

3 passed

Details

3 tests across 3 suites
39.8 seconds
b27797d
🔄 Run: #16970 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
41.2 seconds
b27797d
🔄 Run: #16970 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
38.6 seconds
43b0897
🔄 Run: #16971 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
43.5 seconds
43b0897
🔄 Run: #16971 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

3 passed

Details

3 tests across 3 suites
38.4 seconds
43b0897
🔄 Run: #16971 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

2 passed

Details

2 tests across 2 suites
1 minute, 7 seconds
43b0897
🔄 Run: #16971 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
39.3 seconds
5d55695
🔄 Run: #16972 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
42.4 seconds
5d55695
🔄 Run: #16972 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
47.8 seconds
5d55695
🔄 Run: #16972 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

2 failed

Details

2 tests across 2 suites
1 minute, 13 seconds
5d55695
📦 Artifacts: View test results and HTML report
🔄 Run: #16972 (attempt 1)

Failed tests

firefox › tests/environment-permission-test.pw.ts › Environment Permission Tests › Environment-level permissions control access to features, identities, and segments @enterprise
firefox › tests/project-permission-test.pw.ts › Project Permission Tests › Project-level permissions control access to features, environments, audit logs, and segments @enterprise

### Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
33.1 seconds
4269a8a
🔄 Run: #16973 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
42.2 seconds
4269a8a
🔄 Run: #16973 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

3 passed

Details

3 tests across 3 suites
51.2 seconds
4269a8a
🔄 Run: #16973 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

2 passed

Details

2 tests across 2 suites
55.3 seconds
4269a8a
🔄 Run: #16973 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
42.5 seconds
52fa070
🔄 Run: #16974 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
37.9 seconds
52fa070
🔄 Run: #16974 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

3 passed

Details

3 tests across 3 suites
32.6 seconds
52fa070
🔄 Run: #16974 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
42.8 seconds
52fa070
🔄 Run: #16974 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
39.1 seconds
683fc69
🔄 Run: #16980 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
39.4 seconds
683fc69
🔄 Run: #16980 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

3 passed

Details

3 tests across 3 suites
32.4 seconds
683fc69
🔄 Run: #16980 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

3 passed

Details

3 tests across 3 suites
41.4 seconds
683fc69
🔄 Run: #16980 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
39.2 seconds
39b1a5d
🔄 Run: #17017 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
43.1 seconds
39b1a5d
🔄 Run: #17017 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

3 passed

Details

3 tests across 3 suites
37.9 seconds
39b1a5d
🔄 Run: #17017 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

2 passed

Details

2 tests across 2 suites
57 seconds
39b1a5d
🔄 Run: #17017 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
33.3 seconds
d560403
🔄 Run: #17018 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
43.1 seconds
d560403
🔄 Run: #17018 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

3 passed

Details

3 tests across 3 suites
58 seconds
d560403
🔄 Run: #17018 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
48.3 seconds
d560403
🔄 Run: #17018 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

1 passed

Details

1 test across 1 suite
39.1 seconds
421a070
🔄 Run: #17021 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
41 seconds
421a070
🔄 Run: #17021 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

3 passed

Details

3 tests across 3 suites
32.8 seconds
421a070
🔄 Run: #17021 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

1 passed

Details

1 test across 1 suite
58.1 seconds
421a070
🔄 Run: #17021 (attempt 1)

github-actions · 2026-05-25T09:57:10Z

Visual Regression

19 screenshots compared. See report for details.
View full report

codecov · 2026-05-25T09:57:43Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.51%. Comparing base (7d3b541) to head (421a070).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #7591    +/-   ##
========================================
  Coverage   98.51%   98.51%            
========================================
  Files        1436     1439     +3     
  Lines       54363    54690   +327     
========================================
+ Hits        53553    53880   +327     
  Misses        810      810

☔ 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.

…nd use hooks to set timestamps

Zaimwa9 added 3 commits May 25, 2026 11:10

feat(experimentation): add Experiment model and CRUD endpoints

05c82fd

feat(experimentation): rebased main

005ae23

feat(experimentation): reworked-tests

b27797d

Zaimwa9 requested a review from a team as a code owner May 25, 2026 09:49

Zaimwa9 requested review from emyller and removed request for a team May 25, 2026 09:49

Zaimwa9 requested review from gagantrivedi and removed request for emyller May 25, 2026 09:49

github-actions Bot added api Issue related to the REST API feature New feature or request labels May 25, 2026

feat(experimentation): type-linting

43b0897