Skip to content

docs: add ADR for persisted competency deletability signal#661

Open
mgwozdz-unicon wants to merge 1 commit into
openedx:mainfrom
mgwozdz-unicon:cbe-deletability-signal-adr
Open

docs: add ADR for persisted competency deletability signal#661
mgwozdz-unicon wants to merge 1 commit into
openedx:mainfrom
mgwozdz-unicon:cbe-deletability-signal-adr

Conversation

@mgwozdz-unicon

Copy link
Copy Markdown
Contributor

Why

openedx-core#655 proposes how to enforce the
delete/edit guardrails ADR-0002 and ADR-0003 already decided for competency taxonomy data, and
raised surfacing a deletable signal on the relevant GET endpoints so Studio can disable/warn on
the delete action instead of only discovering the block from a failed request. How to compute that
signal turned into a real design question (read-time cost vs. write-path complexity), so it gets
its own ADR rather than staying an implementation detail of that issue.

Summary

  • Adds ADR 0005: persist a deletable boolean on the five delete-protected models (Taxonomy,
    CompetencyTaxonomy, Tag, ObjectTag, CompetencyCriteriaGroup, CompetencyCriteria) rather
    than computing it per-request or caching it.
  • The flip is one-directional (True to False only, never back), set synchronously in the same
    transaction as the learner-status write that triggers it. No cache-invalidation logic needed as a
    result.
  • No backfill migration needed: the referencing learner-status tables are new, so no existing row
    can already be non-deletable.
  • Enforcement stays on the write path; the persisted field is a UX convenience, not the guardrail
    itself.
  • Rejects two alternatives considered in [Arch] Implementation approach for competency data delete/edit guardrails #655: a per-request Exists()/OuterRef() annotation, and
    caching that computed value with a TTL.

Related to #655.

Decides how API clients learn a competency guardrail record (Taxonomy,
Tag, ObjectTag, CompetencyCriteriaGroup, CompetencyCriteria) is
delete-protected before attempting a delete: a persisted, monotonic
`deletable` boolean set at learner-status write time, rather than
computed per-request or cached.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 15, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @mgwozdz-unicon!

This repository is currently maintained by @axim-engineering.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants