Add Description to Job Types #104268

Taylor-Wiebe · 2023-11-20T04:02:51+01:00

Taylor-Wiebe commented

2023-11-20 04:02:51 +01:00

Add a description field to job types, which was requested in the issue #102429

Descriptions can be added to job types, and they will appear in Blender when the user hovers over the job type in the UI.

I am open to suggestions for the description of Simple Blender Render, or the description for that job could be left blank.

Add a description field to job types, which was requested in the issue https://projects.blender.org/studio/flamenco/issues/102429 Descriptions can be added to job types, and they will appear in Blender when the user hovers over the job type in the UI. ![image](/attachments/2d9f3926-2067-4e6e-9f63-3c9e3e5846a6) I am open to suggestions for the description of `Simple Blender Render`, or the description for that job could be left blank.

image.png

145 KiB

Taylor-Wiebe added 2 commits 2023-11-20 04:02:55 +01:00

5d770a3ffa add job description to backend and addon

dbe39c610a clean up description

Sybren A. Stüvel requested changes 2023-12-04 15:25:32 +01:00

Dismissed

Sybren A. Stüvel left a comment

Thanks for the PR @Taylor-Wiebe!

I think "Render a Blender file" offers a bit too little information. How about "Render a sequence of frames, and create a preview video file"?

Thanks for the PR @Taylor-Wiebe! I think "Render a Blender file" offers a bit too little information. How about "Render a sequence of frames, and create a preview video file"?

Taylor-Wiebe added 1 commit 2023-12-06 03:28:32 +01:00

cb92bc6157 update description

Taylor-Wiebe commented

2023-12-06 03:30:28 +01:00

@dr.sybren That description sounds good, I have updated it.

Sybren A. Stüvel added this to the 3.5 milestone 2024-02-24 11:59:08 +01:00

Taylor-Wiebe added 2 commits 2024-03-24 05:23:52 +01:00

d4b9a6fb14 Merge branch 'main' into job-description

4a59a7ca40 regen openapi spec

Taylor-Wiebe commented

2024-03-25 03:42:01 +01:00

@dr.sybren I noticed some merge conflicts in this PR, so I have fixed them.

Sybren A. Stüvel requested changes 2024-03-25 09:43:20 +01:00

Dismissed

Sybren A. Stüvel left a comment

Thanks for fixing the conflicts. I tried to test your changes, but make test shows errors:

--- FAIL: TestEtag (0.00s)
    job_compilers_test.go:292: 
                Error Trace:    /home/sybren/workspace/flamenco/internal/manager/job_compilers/job_compilers_test.go:292
                Error:          Not equal: 
                                expected: "eba586e16d6b55baaa43e32f9e78ae514b457fee"
                                actual  : "d9c1be066f6ecbd2ef0d80a94a64925ee599cf1a"
                            
                                Diff:
                                --- Expected
                                +++ Actual
                                @@ -1 +1 @@
                                -eba586e16d6b55baaa43e32f9e78ae514b457fee
                                +d9c1be066f6ecbd2ef0d80a94a64925ee599cf1a
                Test:           TestEtag
    job_compilers_test.go:323: 
                Error Trace:    /home/sybren/workspace/flamenco/internal/manager/job_compilers/job_compilers_test.go:323
                Error:          Received unexpected error:
                                job type etag does not match: expecting "d9c1be066f6ecbd2ef0d80a94a64925ee599cf1a", submitted job has "eba586e16d6b55baaa43e32f9e78ae514b457fee"
                Test:           TestEtag
                Messages:       job with correct etag should be accepted
FAIL

Also I think it would be a good idea to either add a test, or to adjust an existing test, to test that the description is properly loaded. I think extending TestSimpleBlenderRenderHappy would be fine for this.

Thanks for fixing the conflicts. I tried to test your changes, but `make test` shows errors: ``` --- FAIL: TestEtag (0.00s) job_compilers_test.go:292: Error Trace: /home/sybren/workspace/flamenco/internal/manager/job_compilers/job_compilers_test.go:292 Error: Not equal: expected: "eba586e16d6b55baaa43e32f9e78ae514b457fee" actual : "d9c1be066f6ecbd2ef0d80a94a64925ee599cf1a" Diff: --- Expected +++ Actual @@ -1 +1 @@ -eba586e16d6b55baaa43e32f9e78ae514b457fee +d9c1be066f6ecbd2ef0d80a94a64925ee599cf1a Test: TestEtag job_compilers_test.go:323: Error Trace: /home/sybren/workspace/flamenco/internal/manager/job_compilers/job_compilers_test.go:323 Error: Received unexpected error: job type etag does not match: expecting "d9c1be066f6ecbd2ef0d80a94a64925ee599cf1a", submitted job has "eba586e16d6b55baaa43e32f9e78ae514b457fee" Test: TestEtag Messages: job with correct etag should be accepted FAIL ``` Also I think it would be a good idea to either add a test, or to adjust an existing test, to test that the description is properly loaded. I think extending `TestSimpleBlenderRenderHappy` would be fine for this.

Taylor-Wiebe added 4 commits 2024-03-29 05:16:10 +01:00

52e329b3d7 Merge branch 'main' into job-description

8e522f4ea1 job type description should be optional

d110136342 fix optional description in addon

c4b0d4a35f add test for AvailableJobType description

Taylor-Wiebe added 1 commit 2024-03-29 05:24:44 +01:00

02103d1374 keep slashes the same

Taylor-Wiebe commented

2024-03-29 05:33:52 +01:00

@dr.sybren Ah, that test was failing because I mistakenly had the description set as required so it was included in the json when building the etag. I fixed the description and fixed the addon to handle None descriptions.

I added a test TestGetJobTypeWithDescriptionHappy to test that the description will be returned via the API. I noticed when I run the tests, TestSetSchedule is failing, although it's also failing on the main branch for me.

@dr.sybren Ah, that test was failing because I mistakenly had the description set as required so it was included in the json when building the etag. I fixed the description and fixed the addon to handle `None` descriptions. I added a test `TestGetJobTypeWithDescriptionHappy` to test that the description will be returned via the API. I noticed when I run the tests, `TestSetSchedule` is failing, although it's also failing on the main branch for me.

Sybren A. Stüvel approved these changes 2024-04-04 11:06:10 +02:00

Sybren A. Stüvel left a comment

Thanks, this works well now!

I noticed when I run the tests, TestSetSchedule is failing, although it's also failing on the main branch for me.

Please file a new bug report about this. The tests shouldn't fail.

Thanks, this works well now! > I noticed when I run the tests, `TestSetSchedule` is failing, although it's also failing on the main branch for me. Please file a new bug report about this. The tests shouldn't fail.

Sybren A. Stüvel manually merged commit a0cb8735c9 into main

2024-04-04 11:16:11 +02:00

Sybren A. Stüvel commented

2024-04-04 11:19:52 +02:00

This was merged as 03a88934, 2bbb7b48, and a0cb8735

Thanks again Taylor!

This was merged as 03a88934, 2bbb7b48, and a0cb8735 Thanks again Taylor!

Sybren A. Stüvel deleted branch job-description

2024-04-04 11:19:56 +02:00

Sign in to join this conversation.

No reviewers