fix: URL-encode workflow names with special characters in _resolve_workflow_id#294
Open
patoo0x wants to merge 1 commit intoMagnivOrg:masterfrom
Open
fix: URL-encode workflow names with special characters in _resolve_workflow_id#294patoo0x wants to merge 1 commit intoMagnivOrg:masterfrom
patoo0x wants to merge 1 commit intoMagnivOrg:masterfrom
Conversation
…rkflow_id Fixes MagnivOrg#254 The _resolve_workflow_id() function builds a URL like: {base_url}/workflows/{workflow_id_or_name} When workflow_id_or_name contains special characters such as slashes (e.g. 'team/my-workflow'), the slash is treated as a URL path separator by the server, resulting in a 404 or wrong-resource response. Fix: apply urllib.parse.quote(str(workflow_id_or_name), safe='') to encode ALL special characters before interpolating into the URL. The prompt-templates endpoint already received this fix (via PR MagnivOrg#291). This commit closes the remaining gap in _resolve_workflow_id. Tests added to TestUrlEncodingInResolveWorkflowId: - test_resolve_workflow_id_encodes_slashes - test_resolve_workflow_id_encodes_special_chars - test_resolve_workflow_id_integer_unchanged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Fixes #254
When a workflow is created with a name containing special characters like slashes (e.g.
team/my-workflow), calling it via the Python client fails because_resolve_workflow_idbuilds the lookup URL as:The unencoded slash is interpreted by the server as a path separator, causing a 404 or wrong-resource lookup.
Root Cause
_resolve_workflow_idinpromptlayer/utils.pyinterpolatesworkflow_id_or_namedirectly into the URL path without encoding:The
prompt-templatesendpoint already received this same fix (merged in PR #291). This PR closes the remaining gap for workflow name lookup.Fix
urllib.parse.quote(..., safe=)— already imported inutils.py— encodes ALL special characters so the workflow name is always transmitted as a single opaque path segment.Tests
Added
TestUrlEncodingInResolveWorkflowIdtotests/test_get_prompt_template.py:test_resolve_workflow_id_encodes_slashesteam/my-workflow→team%2Fmy-workflowin URLtest_resolve_workflow_id_encodes_special_charsorg/project:v2@prod→ all chars encodedtest_resolve_workflow_id_integer_unchangedAll 11 tests in
test_get_prompt_template.pypass (pytest tests/test_get_prompt_template.py).