fix: RND-98: correct response schema for tasks.get() #6012

niklub · 2024-06-18T15:48:45Z

Calling tasks.get() returns error due to incorrect Task schema

…tput type

netlify · 2024-06-18T15:49:01Z

✅ Deploy Preview for heartex-docs canceled.

Name	Link
🔨 Latest commit	`fcf37ee`
🔍 Latest deploy log	https://app.netlify.com/sites/heartex-docs/deploys/667548f54b8ccf0008d3a4c7

netlify · 2024-06-18T15:49:02Z

✅ Deploy Preview for label-studio-docs-new-theme canceled.

Name	Link
🔨 Latest commit	`fcf37ee`
🔍 Latest deploy log	https://app.netlify.com/sites/label-studio-docs-new-theme/deploys/667548f5707cdc0008dd1e05

makseq

Tests are failed in LS and LSE

makseq · 2024-06-18T23:24:32Z

label_studio/data_manager/serializers.py

-    annotators = serializers.SerializerMethodField(required=False, read_only=True)
+    predictions = PredictionSerializer(required=False, many=True, default=[], read_only=True)
+    annotations = AnnotationsDMFieldSerializer(required=False, many=True, default=[], read_only=True)
+    drafts = AnnotationDraftDMFieldSerializer(required=False, many=True, default=[], read_only=True)


It will break the call of DataManagerTaskSerializer::get_drafts() + LseTaskSerializer::get_drafts()

some-2024-06-19_00.20.54.mp4

Fixed for predictions and drafts - schemas were rewritten manually on top of serializers.SerializerMethodField

makseq · 2024-06-18T23:26:10Z

label_studio/data_manager/serializers.py

-    drafts = serializers.SerializerMethodField(required=False, read_only=True)
-    annotators = serializers.SerializerMethodField(required=False, read_only=True)
+    predictions = PredictionSerializer(required=False, many=True, default=[], read_only=True)
+    annotations = AnnotationsDMFieldSerializer(required=False, many=True, default=[], read_only=True)


It might affect the calls of LseTaskSerializer::get_annotations() and LseTaskSerializerForAnnotators::get_annotations() from LSE

makseq · 2024-06-18T23:42:48Z

label_studio/data_manager/serializers.py

+    predictions = PredictionSerializer(required=False, many=True, default=[], read_only=True)
+    annotations = AnnotationsDMFieldSerializer(required=False, many=True, default=[], read_only=True)
+    drafts = AnnotationDraftDMFieldSerializer(required=False, many=True, default=[], read_only=True)
+    annotators = AnnotatorsDMField(required=False, read_only=True)


the same problem as with get_drafts() + LseTaskSerializer::get_annotators()

makseq · 2024-06-18T23:44:11Z

label_studio/data_manager/serializers.py

@@ -222,7 +270,7 @@ class DataManagerTaskSerializer(TaskSerializer):
    predictions_model_versions = serializers.SerializerMethodField(required=False)
    avg_lead_time = serializers.FloatField(required=False)
    draft_exists = serializers.BooleanField(required=False)
-    updated_by = serializers.SerializerMethodField(required=False, read_only=True)
+    updated_by = UpdatedByDMField(required=False, read_only=True)


the same problem as with get_drafts()

Are you sure the problem does appear for this field as well? As it is just as shallow override over serializers.SerializerMethodField

makseq · 2024-06-18T23:49:06Z

label_studio/tasks/openapi_schema.py

@@ -34,8 +34,8 @@
    'comment_count': 0,
    'unresolved_comment_count': 0,
    'last_comment_updated_at': '2024-01-15T09:30:00Z',


I believe it should be like this:
2024-06-18T23:45:46.048490Z

pls, fix created_at and updated_at too.

Or maybe it's better to use the full version of api/tasks response:

{ "id": 13, "predictions": [], "annotations": [], "drafts": [], "annotators": [], "inner_id": 2, "cancelled_annotations": 0, "total_annotations": 0, "total_predictions": 0, "completed_at": null, "annotations_results": "", "predictions_results": "", "predictions_score": null, "file_upload": "6b25fc23-some_3.mp4", "storage_filename": null, "annotations_ids": "", "predictions_model_versions": "", "avg_lead_time": null, "draft_exists": false, "updated_by": [], "data": { "image": "/data/upload/1/6b25fc23-some_3.mp4" }, "meta": {}, "created_at": "2024-06-18T23:45:46.048490Z", "updated_at": "2024-06-18T23:45:46.048538Z", "is_labeled": false, "overlap": 1, "comment_count": 0, "unresolved_comment_count": 0, "last_comment_updated_at": null, "project": 1, "comment_authors": [] }

@niklub

Hi @niklub! This PR was [created](https://github.com/HumanSignal/label-studio/actions/runs/9580652200) in a response to PRs in upstream repos: - HumanSignal/label-studio-sdk#252 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: bmartel <brandonmartel@gmail.com> Co-authored-by: robot-ci-heartex <robot-ci-heartex@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: niklub <nikolai@heartex.com>

codecov · 2024-06-19T12:09:51Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.76%. Comparing base (dbeba0f) to head (fcf37ee).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #6012      +/-   ##
===========================================
+ Coverage    76.71%   76.76%   +0.05%     
===========================================
  Files          168      168              
  Lines        13582    13602      +20     
===========================================
+ Hits         10419    10442      +23     
+ Misses        3163     3160       -3

Flag	Coverage Δ
pytests	`76.76% <100.00%> (+0.05%)`	⬆️

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.

niklub · 2024-06-21T09:18:59Z

/git merge develop

Workflow run
Successfully merged: 19 files changed, 242 insertions(+), 181 deletions(-)

Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/9611323314

nik added 3 commits June 14, 2024 16:05

fix: RND-98: correct response schema for tasks.get()

0e1dcd6

Merge branch 'develop' into fb-RND-98

312a5ae

Modify task serializer with updated_by, file_upload of the correct ou…

da492a1

…tput type

github-actions bot added the fix label Jun 18, 2024

nik added 2 commits June 18, 2024 22:58

Adjust task api schema with DMTaskSerializer

15019e1

Reformat code

6f3294c

niklub requested review from makseq and triklozoid June 18, 2024 21:59

nik added 2 commits June 18, 2024 23:35

Fix AnnotatorsDMField

77b2efc

Fix serializer fields in DM

a8e443d

makseq requested changes Jun 18, 2024

View reviewed changes

nik added 4 commits June 19, 2024 11:06

Replace back serializers with SerializerMethodFields

3795960

Reformat

a82bbed

Add datetime examples

9bed4be

Add dm task response example

e31fb2b

makseq approved these changes Jun 19, 2024

View reviewed changes

nik and others added 2 commits June 19, 2024 12:57

Merge branch 'develop' into fb-RND-98

a4da046

triklozoid approved these changes Jun 20, 2024

View reviewed changes

niklub and others added 2 commits June 21, 2024 09:21

Merge branch 'develop' into 'fb-RND-98'

0f26d2d

Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/9611323314

Use pyproject from develop

fcf37ee

niklub merged commit 19afc18 into develop Jun 21, 2024
40 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: RND-98: correct response schema for tasks.get() #6012

fix: RND-98: correct response schema for tasks.get() #6012

niklub commented Jun 18, 2024

netlify bot commented Jun 18, 2024 •

edited

Loading

netlify bot commented Jun 18, 2024 •

edited

Loading

makseq left a comment

makseq Jun 18, 2024

niklub Jun 19, 2024

makseq Jun 18, 2024

makseq Jun 18, 2024

makseq Jun 18, 2024

makseq Jun 18, 2024 •

edited

Loading

niklub Jun 19, 2024

makseq Jun 18, 2024

makseq Jun 18, 2024

niklub Jun 19, 2024

codecov bot commented Jun 19, 2024 •

edited

Loading

niklub commented Jun 21, 2024 •

edited by robot-ci-heartex

Loading

fix: RND-98: correct response schema for tasks.get() #6012

fix: RND-98: correct response schema for tasks.get() #6012

Conversation

niklub commented Jun 18, 2024

netlify bot commented Jun 18, 2024 • edited Loading

✅ Deploy Preview for heartex-docs canceled.

netlify bot commented Jun 18, 2024 • edited Loading

✅ Deploy Preview for label-studio-docs-new-theme canceled.

makseq left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

makseq Jun 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jun 19, 2024 • edited Loading

Codecov Report

niklub commented Jun 21, 2024 • edited by robot-ci-heartex Loading

netlify bot commented Jun 18, 2024 •

edited

Loading

netlify bot commented Jun 18, 2024 •

edited

Loading

makseq Jun 18, 2024 •

edited

Loading

codecov bot commented Jun 19, 2024 •

edited

Loading

niklub commented Jun 21, 2024 •

edited by robot-ci-heartex

Loading