[FC-0118] docs: Add ADR for ensuring GET requests are idempotent#38249
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @taimoor-ahmed-1! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
|
@bmtcril I'd love to get your thoughts on this. @taimoor-ahmed-1 while I'm not generally opposed to idempotent GET requests, I think an exception for telemetry data should exist. Pushing that to async calls increases cost of what should be low overhead calls. |
|
I think there is a difference between GETs that side-effect the domain or transactional state and those that trigger changes in a different domain. Analytics and other telemetry are separate domains from, say, student state and aren't modifying any data relevant to the GET request, which is what the distinction is really about. I totally agree with things like the student state not being modified by side-effects in GET requests, but I think logging and telemetry are separate concerns. |
Add edx-platform/docs/decisions/0030-ensure-get-requests-are-idempotent.rst as an accepted ADR. Define policy that GET endpoints must be strictly read-only, with side effects moved to explicit write endpoints or async event pipelines. Include edx-platform relevance, anti-pattern vs preferred code examples, and rollout guidance for testing and migration.
taimoor-ahmed-1
force-pushed
the
docs/ADR-ensure_get_requests_idempotent
branch
from
9f4a500 to
e581b94
Compare
@feanil @bmtcril I have updated the ADR based on your feedback |
| 3. Add regression tests to ensure ``GET`` handlers do not modify domain state. | ||
| 4. Document exceptions (if any) and provide migration notes for clients. | ||
|
|
||
| Relevance in edx-platform |
There was a problem hiding this comment.
This section still has references to tracking and logging. I think the types of events we're more concerned about in this ADR are things like openedx-events and Django signals being fired.
| return Response(ProgressSerializer(compute_progress(...)).data) | ||
|
|
||
| @require_POST | ||
| def track_progress_view(request, course_id): |
There was a problem hiding this comment.
I think this is also actually a tracking log example
7 participants
Description
This PR adds ADR-0030 to document and standardize idempotent GET behavior across Open edX REST APIs. The ADR establishes that GET must be read-only and that any state mutations or tracking writes should be handled via explicit write endpoints or decoupled async telemetry.
What changed
Added edx-platform/docs/decisions/0030-ensure-get-requests-are-idempotent.rst
Context on current non-idempotent GET risks
Decision and required implementation rules
edx-platform-specific relevance notes
Code examples showing anti-pattern and preferred approach
related issue: #38248