Skip to content

Conversation

@efortish
Copy link
Contributor

@efortish efortish commented Feb 6, 2026

related issue: #89 (comment)

Validate prompt_template existence in AIWorkflowProfile

Description

Prompt templates can be referenced by slug or UUID in workflow profiles, but there was no validation checking if the referenced template actually exists in the database. This caused silent failures at runtime — the system would fall back to inline prompts or send no custom prompt to the LLM without any warning.

Changes

  • template_utils.py: Added _validate_prompt_templates() function that iterates over all processors in processor_config, checks for prompt_template fields, and verifies they exist in the DB via PromptTemplate.load_prompt(). Integrated into the existing _validate_semantics() pipeline.
  • admin.py: Added clean() method to AIWorkflowProfileAdminForm that builds the effective config (base template + patch) and runs validate_workflow_config(). Invalid prompt templates now block saving in Django Admin with a descriptive error message.

Tests

Added TestValidatePromptTemplates covering: existing slug/UUID, nonexistent slug/UUID, multiple processors, mixed valid/invalid, empty/null values, and Admin form integration

image

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 6, 2026
@openedx-webhooks
Copy link

Thanks for the pull request, @efortish!

This repository is currently maintained by @felipemontoya.

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.

@codecov
Copy link

codecov bot commented Feb 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.98%. Comparing base (e6caf77) to head (e0885c4).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #121      +/-   ##
==========================================
+ Coverage   90.74%   90.98%   +0.23%     
==========================================
  Files          48       48              
  Lines        4389     4504     +115     
  Branches      271      277       +6     
==========================================
+ Hits         3983     4098     +115     
  Misses        317      317              
  Partials       89       89              
Flag Coverage Δ
unittests 90.98% <ø> (+0.23%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Member

@felipemontoya felipemontoya left a comment

Choose a reason for hiding this comment

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

Thanks @efortish. The PR does exactly what it says. The code is well tested and will solve this issue.

It could still happen that an existing prompt_template is deleted and the profile becomes invalid silently. I think this is acceptable for now (same pattern as ForeignKey without CASCADE), but worth remembering as a known limitation. I'll merge this now, but If you want to document that feel free to open a new PR.

@felipemontoya felipemontoya merged commit e9eea41 into openedx:main Feb 6, 2026
10 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Feb 6, 2026
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

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants