feat(guardrails): send execution source and job key headers by valentinabojan · Pull Request #1739 · UiPath/uipath-python

valentinabojan · 2026-06-22T14:47:30Z

Guardrail validation calls now send the execution source (x-uipath-guardrails-source) and job key (x-uipath-jobkey) headers for licensing/metering correlation.

The source is derived from the executing CLI command (run→runtime, debug/dev→playground, eval→eval) on UiPathRuntimeContext.execution_source (added in uipath-runtime 0.11.4), and flows through the execution-context boundary rather than an env var: the CLI calls set_execution_source(ctx.execution_source), which sets a ContextVar that UiPathExecutionContext.execution_source reads, and GuardrailsService builds the header from self._execution_context.execution_source. This keeps the source correctly scoped for concurrent/eval runs and works for both coded and low-code agents, since both run through the uipath CLI. Job key continues to come from UiPathConfig.job_key; both headers are omitted when unset.

Requires uipath-runtime>=0.11.4 (companion PR: UiPath/uipath-runtime-python#132).

🤖 Generated with Claude Code

Copilot

Pull request overview

This PR adds correlation metadata to guardrail validation requests by propagating the CLI execution “source” and orchestrator job key into HTTP headers, aligning guardrails with existing licensing/metering flows.

Changes:

Set UIPATH_EXECUTION_SOURCE at the start of CLI agent-executing commands (run, debug, dev, eval) via a new execution-source resolver.
Send x-uipath-agenthub-config (execution source) and x-uipath-jobkey (job key) headers on guardrail validation requests, omitting each when unset.
Add unit tests to verify presence/absence of the new headers on outgoing guardrails requests.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/uipath/src/uipath/_cli/cli_run.py	Sets execution source for `run` before runtime construction.
packages/uipath/src/uipath/_cli/cli_eval.py	Sets execution source for `eval` before evaluation execution starts.
packages/uipath/src/uipath/_cli/cli_dev.py	Sets execution source for `dev` before launching the developer console/runtime.
packages/uipath/src/uipath/_cli/cli_debug.py	Sets execution source for `debug` before runtime/debug setup.
packages/uipath/src/uipath/_cli/_utils/_execution_source.py	New mapping logic from CLI command → execution source env var.
packages/uipath-platform/src/uipath/platform/guardrails/_guardrails_service.py	Adds execution source + job key headers to guardrails validate requests.
packages/uipath-platform/src/uipath/platform/common/constants.py	Introduces `UIPATH_EXECUTION_SOURCE` env var constant.
packages/uipath-platform/src/uipath/platform/common/_job_context.py	Adds `header_execution_source()` helper alongside existing job key header helper.
packages/uipath-platform/src/uipath/platform/common/_config.py	Exposes `UiPathConfig.execution_source` via the new env var.
packages/uipath-platform/tests/services/test_guardrails_service.py	Adds tests ensuring headers are present when set and omitted when unset.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

radu-mocanu

env vars are acceptable for process bootstrap/config coming from the outside world, but this PR uses an env var as an internal (same-process) message bus from the CLI layer to the platform client. this is not a clean design as it:

makes the state global
can t be scoped in async/concurrent eval runs
etc.

we should make this execution metadata part of runtimecontext and pass it through the existing context boundary, as currently done for for command/job/trace-related execution state.

A cleaner shape would be:


 - map `command -> execution_source` when building `UiPathRuntimeContext`
 - carry it as `runtime_context.execution_source`
 - propagate it into `UiPathExecutionContext` / the platform client context
 - have `GuardrailsService` read `self._execution_context.execution_source` when adding `x-uipath-guardrails-source`

radu-mocanu · 2026-06-25T08:31:52Z

+    Carries the source (e.g. ``runtime``/``playground``/``eval``) via a context
+    variable instead of a process-global env var, and releases it on exit so it


please remove the references to the old impl instead of a process-global env var

radu-mocanu · 2026-06-25T08:39:04Z

+
+    def __init__(self, execution_source: Optional[str]) -> None:
+        self._execution_source = execution_source
+        self._token: Optional[Token[Optional[str]]] = None


nit: let s use the new typing hints please

Suggested change

self._token: Optional[Token[Optional[str]]] = None

self._token: Token[str | None] | None = None

Guardrail validation calls now send the execution source (x-uipath-guardrails-source) and job key (x-uipath-jobkey) headers for licensing/metering correlation. The source is derived from the executing CLI command (run -> runtime, debug/dev -> playground, eval -> eval) on UiPathRuntimeContext.execution_source (uipath-runtime 0.11.4) and flows through the execution-context boundary: the CLI enters ExecutionSourceContext(ctx.execution_source) — a scoped ContextVar that releases its token on exit — UiPathExecutionContext.execution_source reads it, and GuardrailsService builds the header from self._execution_context.execution_source. This keeps the source correctly scoped for concurrent/eval runs and works for both coded and low-code agents. Job key comes from UiPathConfig.job_key; both headers are omitted when unset. Bumps uipath-platform to 0.1.78 and pins uipath-runtime>=0.11.4. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

sonarqubecloud · 2026-06-25T10:37:35Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
95.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2026-06-25T10:51:10Z

🚨 Heads up: `uipath-langchain` cross-tests are FAILING 🚨

Your changes may break the uipath-langchain-python integration.

⚠️ These checks are NOT enforced by branch protection rules. Please review the failures before merging.

🔍 Inspect the failed run →

Co-authored-by: Valentina Bojan <valentina.bojan@uipath.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

Copilot AI review requested due to automatic review settings June 22, 2026 14:47

github-actions Bot added test:uipath-langchain Triggers tests in the uipath-langchain-python repository test:uipath-integrations labels Jun 22, 2026

Copilot started reviewing on behalf of valentinabojan June 22, 2026 14:48 View session

Copilot AI reviewed Jun 22, 2026

View reviewed changes

Comment thread packages/uipath/src/uipath/_cli/_utils/_execution_source.py Outdated

valentinabojan requested a review from radu-mocanu June 23, 2026 09:11

ctiliescuuipath approved these changes Jun 23, 2026

View reviewed changes

apetraru-uipath approved these changes Jun 23, 2026

View reviewed changes

radu-mocanu requested changes Jun 24, 2026

View reviewed changes

radu-mocanu reviewed Jun 24, 2026

View reviewed changes

Comment thread packages/uipath/src/uipath/_cli/cli_debug.py Outdated

valentinabojan requested a review from radu-mocanu June 24, 2026 16:11

radu-mocanu reviewed Jun 25, 2026

View reviewed changes

valentinabojan force-pushed the valentinabojan/guardrails-source-job-headers branch from c5c093c to 7475d93 Compare June 25, 2026 10:24

valentinabojan force-pushed the valentinabojan/guardrails-source-job-headers branch from 7475d93 to ec20883 Compare June 25, 2026 10:34

radu-mocanu approved these changes Jun 25, 2026

View reviewed changes

valentinabojan merged commit 84fbb52 into main Jun 25, 2026
165 checks passed

valentinabojan deleted the valentinabojan/guardrails-source-job-headers branch June 25, 2026 14:38

valentinabojan mentioned this pull request Jun 25, 2026

chore: bump uipath to 2.11.13 and uipath-platform to 0.1.78 UiPath/uipath-langchain-python#940

Merged

viswa-uipath pushed a commit that referenced this pull request Jun 26, 2026

feat(guardrails): send execution source and job key headers (#1739)

125f0f5

Co-authored-by: Valentina Bojan <valentina.bojan@uipath.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(guardrails): send execution source and job key headers#1739

feat(guardrails): send execution source and job key headers#1739
valentinabojan merged 1 commit into
mainfrom
valentinabojan/guardrails-source-job-headers

valentinabojan commented Jun 22, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

radu-mocanu left a comment

Uh oh!

Uh oh!

radu-mocanu Jun 25, 2026

Uh oh!

radu-mocanu Jun 25, 2026 •

edited

Loading

Uh oh!

sonarqubecloud Bot commented Jun 25, 2026

Uh oh!

github-actions Bot commented Jun 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		Carries the source (e.g. ``runtime``/``playground``/``eval``) via a context
		variable instead of a process-global env var, and releases it on exit so it

	self._token: Optional[Token[Optional[str]]] = None
	self._token: Token[str \| None] \| None = None

Uh oh!

Conversation

valentinabojan commented Jun 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

radu-mocanu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

radu-mocanu Jun 25, 2026

Choose a reason for hiding this comment

Uh oh!

radu-mocanu Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Jun 25, 2026

Quality Gate passed

Uh oh!

github-actions Bot commented Jun 25, 2026

🚨 Heads up: uipath-langchain cross-tests are FAILING 🚨

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

valentinabojan commented Jun 22, 2026 •

edited

Loading

radu-mocanu Jun 25, 2026 •

edited

Loading

🚨 Heads up: `uipath-langchain` cross-tests are FAILING 🚨