fix(workflows): route unlisted tasks through unknown parameter/output types by JustAnotherNormalDev · Pull Request #2606 · cognitedata/cognite-sdk-python

JustAnotherNormalDev · 2026-05-06T10:29:27Z

Problem

Listing workflow versions and loading executions could fail when the API returns task types that are not first-class in the SDK (for example new or beta task kinds in responses).

Solution

Route unlisted task types through UnknownWorkflowTaskParameters and UnknownWorkflowTaskOutput so the wire JSON is preserved and load no longer throws. Keep known task types on their existing dedicated classes.

UnknownWorkflowTaskParameters is constructed from the task type / taskType plus the parameters / input blob (not the full task envelope), so WorkflowTask.dump() stays aligned with the API shape.

For generic CogniteResource JSON/YAML round-trips, dump() must always yield a top-level dict. When _parameters is not a dict (for example a string from the fake resource generator in unit tests), dump() wraps the value in a single-key dict using _OPAQUE_WRAPPER_KEY ("cogniteSdkUnknownWorkflowTaskParametersOpaque"). That satisfies CogniteResource.load → load_resource_to_dict, which only accepts parsed JSON/YAML that resolves to a dict. _load detects that exact one-key shape and unwraps the inner value so the in-memory payload matches what was stored before serialization. Normal API dict payloads are returned unchanged and never use this wrapper.

Files

cognite/client/data_classes/workflows.py — unknown task parameters/output handling, load_parameters wiring, _OPAQUE_WRAPPER_KEY wrap/unwrap for non-dict unknown parameter bodies.
cognite/client/data_classes/init.py — export surface for updated workflow types.
tests/tests_unit/test_data_classes/test_workflows.py — coverage for unknown task serialization and related behavior.
tests/tests_unit/test_base.py — UnknownWorkflowTaskParameters included in generic CogniteResource round-trip tests where applicable.
cognite/client/_cognite_client.py — generated/synced client updates.
cognite/client/_sync_cognite_client.py — generated/synced sync client updates.
scripts/sync_client_codegen/sync_client_template.txt — codegen template updates matching generated client changes.

Parse functionApp parameters and execution output as first-class types. Route unrecognized task types through Unknown parameters/output so listing workflow versions no longer fails when the API adds new task kinds. Co-authored-by: Cursor <cursoragent@cursor.com>

gemini-code-assist

Code Review

This pull request introduces support for the functionApp task type and adds UnknownWorkflowTaskParameters and UnknownWorkflowTaskOutput classes to handle unrecognized task types gracefully. Feedback was provided to improve the robustness of these new classes by handling non-dictionary data in their dump methods and ensuring consistent task_type tracking.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

…-dict output Co-authored-by: Cursor <cursoragent@cursor.com>

…omplete normalize Co-authored-by: Cursor <cursoragent@cursor.com>

codecov · 2026-05-06T11:14:08Z

Codecov Report

❌ Patch coverage is 94.00000% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 93.02%. Comparing base (4b38aa0) to head (63ad6ab).

Files with missing lines	Patch %	Lines
cognite/client/data_classes/workflows.py	92.30%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2606      +/-   ##
==========================================
- Coverage   93.05%   93.02%   -0.04%     
==========================================
  Files         486      486              
  Lines       49481    49528      +47     
==========================================
+ Hits        46047    46072      +25     
- Misses       3434     3456      +22

Files with missing lines	Coverage Δ
cognite/client/data_classes/__init__.py	`100.00% <ø> (ø)`
...sts/tests_unit/test_data_classes/test_workflows.py	`100.00% <100.00%> (ø)`
cognite/client/data_classes/workflows.py	`95.98% <92.30%> (+0.07%)`	⬆️

... and 12 files with indirect coverage changes

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

…r functionApp Co-authored-by: Cursor <cursoragent@cursor.com>

VerstraeteBert

LGTM

haakonvt · 2026-05-07T09:35:19Z

+        return cls(task_type, output if isinstance(output, dict) else {})
+
+    @property
+    def task_type(self) -> str:  # type: ignore[override]


This should pretend to return a ValidTaskType

Let me know if this works

haakonvt

A few comments, otherwise looks good!

…ionapp-task-type

… on unknown dumps Co-authored-by: Cursor <cursoragent@cursor.com>

Co-authored-by: Cursor <cursoragent@cursor.com>

…com/cognitedata/cognite-sdk-python into fix/workflows-functionapp-task-type

Co-authored-by: Cursor <cursoragent@cursor.com>

haakonvt · 2026-05-08T07:58:38Z

+                UserWarning,
+                stacklevel=2,
+            )
+        params = self._parameters if isinstance(self._parameters, dict) else {}


You ignore parameters if it is not a dict. That means your init should say dict rather than Any?

agree. Its dict now. dict[str, Any]:

haakonvt · 2026-05-08T08:00:23Z

+                UserWarning,
+                stacklevel=2,
+            )
+        out = self._output if isinstance(self._output, dict) else {}


Same question here

I also dont think we should have any kind of such logic? The payload is unkown, so we should return what we got instantiated with

i changed it to dict. But do you mean , remove the warn message as well?

No the warning is great! I mean, if self._output is not dict we ignore it in the output. I don't think we should

Reason: The unknown class should just accept what gets passed to it - maybe in the future you want this to be a list or whatever, then this would break

Co-authored-by: Cursor <cursoragent@cursor.com>

…eters Co-authored-by: Cursor <cursoragent@cursor.com>

Co-authored-by: Cursor <cursoragent@cursor.com>

…com/cognitedata/cognite-sdk-python into fix/workflows-functionapp-task-type

haakonvt · 2026-05-10T18:46:52Z

If you are exempting your data classes from automatic testing, you need to add a better explanation please

please ignore this one. i reverted it back. Pushed it by mistake . I had added it for testing.

Merge origin/master. Align UnknownWorkflowTaskOutput typing with raw load. Add TestUnknownWorkflowTaskParametersCogniteResourceParity for envelope round-trips. Shorten test_base exclude comment for UnknownWorkflowTaskParameters. Co-authored-by: Cursor <cursoragent@cursor.com>

…est; trim workflow tests Co-authored-by: Cursor <cursoragent@cursor.com>

… wiring Wrap non-dict payloads in an opaque dict so CogniteResource.load round-trips. Build unknown parameters from task type plus parameters blob, not full task dict. Narrow dynamic_task_type to str | None; document opaque wrap/unwrap in comments. Keep UnknownWorkflowTaskParameters in generic CogniteResource base tests. Co-authored-by: Cursor <cursoragent@cursor.com>

Co-authored-by: Cursor <cursoragent@cursor.com>

…com/cognitedata/cognite-sdk-python into fix/workflows-functionapp-task-type

UnknownWorkflowTaskParameters round-trips are covered by workflows opaque wrapper. Co-authored-by: Cursor <cursoragent@cursor.com>

JustAnotherNormalDev requested review from a team as code owners May 6, 2026 10:29

gemini-code-assist Bot reviewed May 6, 2026

View reviewed changes

Comment thread cognite/client/data_classes/workflows.py Outdated

Comment thread cognite/client/data_classes/workflows.py Outdated

JustAnotherNormalDev and others added 3 commits May 6, 2026 16:18

Update cognite/client/data_classes/workflows.py

e031d8b

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Workflows: UnknownWorkflowTaskOutput stores task type and handles non…

ff2e4dd

…-dict output Co-authored-by: Cursor <cursoragent@cursor.com>

Workflows: always dict-shaped unknown task dump; function-only asyncC…

345eae0

…omplete normalize Co-authored-by: Cursor <cursoragent@cursor.com>

JustAnotherNormalDev changed the title ~~fix(workflows): support functionApp task type and unknown workflow task fallbacks~~ [ CDF-27867] fix(workflows): support functionApp task type and unknown workflow task fallbacks May 6, 2026

JustAnotherNormalDev changed the title ~~[ CDF-27867] fix(workflows): support functionApp task type and unknown workflow task fallbacks~~ fix(workflows): support functionApp task type and unknown workflow task fallbacks May 6, 2026

VerstraeteBert requested changes May 6, 2026

View reviewed changes

Comment thread cognite/client/data_classes/workflows.py Outdated

Workflows: drop FunctionApp task classes; use unknown param/output fo…

0288a36

…r functionApp Co-authored-by: Cursor <cursoragent@cursor.com>

JustAnotherNormalDev changed the title ~~fix(workflows): support functionApp task type and unknown workflow task fallbacks~~ fix(workflows): route functionApp and unlisted tasks through unknown parameter/output types May 7, 2026

JustAnotherNormalDev changed the title ~~fix(workflows): route functionApp and unlisted tasks through unknown parameter/output types~~ fix(workflows): route unlisted tasks through unknown parameter/output types May 7, 2026

JustAnotherNormalDev enabled auto-merge May 7, 2026 05:56

VerstraeteBert previously approved these changes May 7, 2026

View reviewed changes

haakonvt reviewed May 7, 2026

View reviewed changes

Comment thread cognite/client/data_classes/workflows.py Outdated

haakonvt reviewed May 7, 2026

View reviewed changes

Comment thread cognite/client/data_classes/workflows.py Outdated

haakonvt reviewed May 7, 2026

View reviewed changes

Comment thread cognite/client/data_classes/workflows.py Outdated

haakonvt requested changes May 7, 2026

View reviewed changes

JustAnotherNormalDev and others added 2 commits May 8, 2026 11:04

Merge remote-tracking branch 'origin/master' into fix/workflows-funct…

9705e42

…ionapp-task-type

Workflows: delegate unknown load to _load; drop recursive key convert…

f34bac0

… on unknown dumps Co-authored-by: Cursor <cursoragent@cursor.com>

JustAnotherNormalDev dismissed VerstraeteBert’s stale review via f34bac0 May 8, 2026 05:36

Merge branch 'master' into fix/workflows-functionapp-task-type

7ebc261

haakonvt reviewed May 8, 2026

View reviewed changes

Comment thread cognite/client/data_classes/workflows.py Outdated

JustAnotherNormalDev and others added 3 commits May 8, 2026 12:51

Merge origin/master into fix/workflows-functionapp-task-type

ed1756a

Align WorkflowTask.type with ValidTaskType from parameters

1ccc163

Co-authored-by: Cursor <cursoragent@cursor.com>

Merge branch 'fix/workflows-functionapp-task-type' of https://github.…

5cfe95b

…com/cognitedata/cognite-sdk-python into fix/workflows-functionapp-task-type

VerstraeteBert previously approved these changes May 8, 2026

View reviewed changes

Type WorkflowTaskExecution.task_type as ValidTaskType

4892116

Co-authored-by: Cursor <cursoragent@cursor.com>

JustAnotherNormalDev dismissed VerstraeteBert’s stale review via 4892116 May 8, 2026 07:27

VerstraeteBert previously approved these changes May 8, 2026

View reviewed changes

haakonvt reviewed May 8, 2026

View reviewed changes

Address review: unknown workflow task params/output dump and load

ee0d026

Co-authored-by: Cursor <cursoragent@cursor.com>

JustAnotherNormalDev dismissed VerstraeteBert’s stale review via ee0d026 May 8, 2026 10:50

JustAnotherNormalDev and others added 7 commits May 8, 2026 16:30

Skip generic CogniteResource round-trips for UnknownWorkflowTaskParam…

0febb29

…eters Co-authored-by: Cursor <cursoragent@cursor.com>

Empty commit to retrigger CI

3a7d59f

Co-authored-by: Cursor <cursoragent@cursor.com>

Empty commit to trigger CI

ebf3a2d

Co-authored-by: Cursor <cursoragent@cursor.com>

Merge branch 'master' into fix/workflows-functionapp-task-type

f2a86ed

Merge origin/master into fix/workflows-functionapp-task-type

5a6db47

Type UnknownWorkflowTaskOutput as dict; align workflow tests

19e70c5

Co-authored-by: Cursor <cursoragent@cursor.com>

Merge branch 'fix/workflows-functionapp-task-type' of https://github.…

a6a6e03

…com/cognitedata/cognite-sdk-python into fix/workflows-functionapp-task-type

haakonvt reviewed May 10, 2026

View reviewed changes

JustAnotherNormalDev and others added 9 commits May 11, 2026 11:33

Merge origin/master into fix/workflows-functionapp-task-type

ebe6eba

Fix UnknownWorkflowTaskParameters init; exclude from json serialize t…

8f4df5c

…est; trim workflow tests Co-authored-by: Cursor <cursoragent@cursor.com>

Merge branch 'master' into fix/workflows-functionapp-task-type

235b0b1

Merge origin/master

8ce243a

chore(workflows): drop functionApp from ValidTaskType literal

28353ac

Co-authored-by: Cursor <cursoragent@cursor.com>

Merge branch 'fix/workflows-functionapp-task-type' of https://github.…

015145c

…com/cognitedata/cognite-sdk-python into fix/workflows-functionapp-task-type

test: restore test_base.py to match master

63ad6ab

UnknownWorkflowTaskParameters round-trips are covered by workflows opaque wrapper. Co-authored-by: Cursor <cursoragent@cursor.com>

Conversation

JustAnotherNormalDev commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

VerstraeteBert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

haakonvt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JustAnotherNormalDev May 8, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JustAnotherNormalDev commented May 6, 2026 •

edited

Loading

codecov Bot commented May 6, 2026 •

edited

Loading

JustAnotherNormalDev May 8, 2026 •

edited

Loading