fix: prompt-builder - jinja2 template set vars still shows required

[srini047]

Related Issues

• fixes PromptBuilder incorrectly marks internally set Jinja2 variables as required inputs when using `required_variables='*' #9916

Proposed Changes:

Previously we checked only the undeclared variables and left the set variables.
Now, we find all the variables assigned using set in the template and push it to the variables list.

This behaviour would be seen in multiple components namely:

• PromptBuilder
• ChatPromptBuilder
• LLMMetadataExtractor
• LLMDocumentContentExtractor

How did you test it?

Run the exisiting suite and added test case for the this scenario.

Notes for the reviewer

• Is this logic for addressing the problem is fine.
• Then, do let me know if there's any other component (other than ones mentioned above) as well that needs to be addressed with this logic.

Checklist

• I have read the contributors guidelines and the code of conduct
• I have updated the related issue with new insights and changes
• I added unit tests and updated the docstrings
• I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
• I documented my code
• I ran pre-commit hooks and fixed any issue

[vercel]

@srini047 is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

[coveralls]

Pull Request Test Coverage Report for Build 19204656740

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• 1 unchanged line in 1 file lost coverage.
• Overall coverage decreased (-0.001%) to 91.577%

---

Files with Coverage Reduction	New Missed Lines	%
components/builders/chat_prompt_builder.py	1	98.26%

Totals
Change from base Build 19138199775:	-0.001%
Covered Lines:	13732
Relevant Lines:	14995

---

💛 - Coveralls

[sjrl]

With the above listed changes I think we could then extend this to the other components you mention. It may be wise to add this as a utility method in haystack/utils/ either in misc.py or a new file called jinja2.py

[sjrl]

hey @srini047 do you think you'll have time to work on this, this week?

[srini047]

hey @srini047 do you think you'll have time to work on this, this week?

Yes @sjrl will continue on this today.

[sjrl]

Hey @srini047 could you add a release note for your PR following the instructions here?

Also we still want to bring this change to ChatPromptBuilder.

[srini047]

Hey @srini047 could you add a release note for your PR following the instructions here?

Also we still want to bring this change to ChatPromptBuilder.

@sjrl Done with the requested changes.

[sjrl]

Could we make this a class function instead of inline. Please also keep it as private so fine to leave the name as _extract_from_text

[sjrl]

Hey @srini047 it looks like this function wasn't made into a class function with signature

def _extract_from_text(
    self, text: Optional[str], role: Optional[str] = None, is_filter_allowed: bool = False
) -> list[str]:

yet

[srini047]

@sjrl Can you take a look now. Hope this is the expectation.