Skip to content

fix: Amplitude list creation response shape - #8402

Merged
gagantrivedi merged 6 commits into
mainfrom
fix/amplitude-list-response-envelope
Aug 31, 2026
Merged

fix: Amplitude list creation response shape#8402
gagantrivedi merged 6 commits into
mainfrom
fix/amplitude-list-response-envelope

Conversation

@gagantrivedi

@gagantrivedi gagantrivedi commented Aug 28, 2026

Copy link
Copy Markdown
Member
  • 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

Amplitude's production sync worker and its portal Testing tab read the list ID from our create response at the same configured path, but against different objects, so a single copy of the ID always fails one of them.

How did you test this code?

Verified each shape against staging with real Amplitude syncs: nested-only passes production but fails the Testing tab, flat-only the reverse, both together pass both.

@gagantrivedi
gagantrivedi requested review from a team as code owners August 28, 2026 12:04
@vercel

vercel Bot commented Aug 28, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 31, 2026 5:26am
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
flagsmith-frontend-preview Ignored Ignored Preview Aug 31, 2026 5:26am
flagsmith-frontend-staging Ignored Ignored Preview Aug 31, 2026 5:26am

Request Review

@gagantrivedi
gagantrivedi requested review from khvn26 and removed request for a team August 28, 2026 12:04
@github-actions github-actions Bot added api Issue related to the REST API docs Documentation updates labels Aug 28, 2026
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 10964587-e0e2-418f-97de-639dc4329b9d

📥 Commits

Reviewing files that changed from the base of the PR and between ac9a65f and cbbbb43.

📒 Files selected for processing (2)
  • api/cohorts/sync_views.py
  • docs/docs/deployment-self-hosting/observability/_events-catalogue.md

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The Amplitude create response now returns the cohort UUID as root list_id and nested response.list_id. The OpenAPI schemas define both required fields. Unit tests use list_id and verify that both values match. The observability documentation updates the rejected webhook source line.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to cbbbb

The PR makes the cohort ID available in both response locations required by existing consumers without changing access or creation behavior. No actionable merge-blocking risk remains after normal checks and review.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added fix and removed docs Documentation updates labels Aug 28, 2026
@github-actions

github-actions Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Docker builds report

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

@flagsmith-engineering
flagsmith-engineering Bot requested a review from a team as a code owner August 28, 2026 12:06
@github-actions github-actions Bot added the docs Documentation updates label Aug 28, 2026
@github-actions

github-actions Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor
❌ private-cloud · depot-ubuntu-latest-16 — run #19954 (attempt 1)

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

failed  2 failed

Details

stats  2 tests across 2 suites
duration  1 minute, 9 seconds
commit  d57ea31
info  📦 Artifacts: View test results and HTML report
🔄 Run: #19954 (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

🗂️ Previous results
✅ private-cloud · depot-ubuntu-latest-arm-16 — run #19954 (attempt 1)

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

passed  2 passed

Details

stats  2 tests across 2 suites
duration  36 seconds
commit  d57ea31
info  🔄 Run: #19954 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #19954 (attempt 1)

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

passed  1 passed

Details

stats  1 test across 1 suite
duration  47.5 seconds
commit  d57ea31
info  🔄 Run: #19954 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #19955 (attempt 1)

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

passed  2 passed

Details

stats  2 tests across 2 suites
duration  47 seconds
commit  cbbbb43
info  🔄 Run: #19955 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #19954 (attempt 1)

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

passed  1 passed

Details

stats  1 test across 1 suite
duration  42 seconds
commit  d57ea31
info  🔄 Run: #19954 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #19955 (attempt 1)

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

passed  1 passed

Details

stats  1 test across 1 suite
duration  40.7 seconds
commit  cbbbb43
info  🔄 Run: #19955 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-arm-16 — run #19953 (attempt 1)

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

passed  3 passed

Details

stats  3 tests across 3 suites
duration  37.2 seconds
commit  ac9a65f
info  🔄 Run: #19953 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-16 — run #19953 (attempt 1)

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

passed  3 passed

Details

stats  3 tests across 3 suites
duration  33.1 seconds
commit  ac9a65f
info  🔄 Run: #19953 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #19953 (attempt 1)

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

passed  1 passed

Details

stats  1 test across 1 suite
duration  36.1 seconds
commit  ac9a65f
info  🔄 Run: #19953 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #19953 (attempt 1)

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

passed  1 passed

Details

stats  1 test across 1 suite
duration  33.7 seconds
commit  ac9a65f
info  🔄 Run: #19953 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-arm-16 — run #19952 (attempt 1)

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

passed  3 passed

Details

stats  3 tests across 3 suites
duration  35.8 seconds
commit  0752af0
info  🔄 Run: #19952 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-16 — run #19952 (attempt 1)

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

passed  3 passed

Details

stats  3 tests across 3 suites
duration  32.6 seconds
commit  0752af0
info  🔄 Run: #19952 (attempt 1)

@github-actions

github-actions Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Visual Regression

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

@codecov

codecov Bot commented Aug 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.81%. Comparing base (e252a36) to head (cbbbb43).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8402   +/-   ##
=======================================
  Coverage   98.81%   98.81%           
=======================================
  Files        1621     1621           
  Lines       66102    66104    +2     
=======================================
+ Hits        65318    65320    +2     
  Misses        784      784           

☔ View full report in Codecov by Harness.
📢 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.

Zaimwa9
Zaimwa9 previously approved these changes Aug 28, 2026
@gagantrivedi gagantrivedi changed the title fix: restore the response envelope Amplitude's production parser reads fix: shape parameter to pin down Amplitude's list ID contract Aug 31, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f9792baf-adbb-4236-9981-a264cf61b27a

📥 Commits

Reviewing files that changed from the base of the PR and between dcd30fb and 0752af0.

📒 Files selected for processing (3)
  • api/cohorts/sync_views.py
  • api/tests/unit/cohorts/test_sync_views.py
  • docs/docs/deployment-self-hosting/observability/_events-catalogue.md

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.

Comment thread api/cohorts/sync_views.py Outdated
@github-actions github-actions Bot added the docs Documentation updates label Aug 31, 2026
@gagantrivedi gagantrivedi changed the title fix: shape parameter to pin down Amplitude's list ID contract fix: return the Amplitude list ID in the shapes both their parsers read Aug 31, 2026
@github-actions github-actions Bot added fix and removed fix docs Documentation updates labels Aug 31, 2026
@gagantrivedi gagantrivedi changed the title fix: return the Amplitude list ID in the shapes both their parsers read fix: Amplitude list creation response shape Aug 31, 2026
@github-actions github-actions Bot added docs Documentation updates fix and removed fix docs Documentation updates labels Aug 31, 2026
@gagantrivedi
gagantrivedi merged commit e7ffc35 into main Aug 31, 2026
34 checks passed
@gagantrivedi
gagantrivedi deleted the fix/amplitude-list-response-envelope branch August 31, 2026 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api Issue related to the REST API docs Documentation updates fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants