New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor two of the missing invocation routes to FastAPI #17237

Merged

mvdbeek merged 34 commits into galaxyproject:dev from heisner-tillman:invocations_

Jan 16, 2024

Contributor

heisner-tillman commented Jan 2, 2024 •

edited

Loading

This is a part of #10889 and continues the work done in #16707.

Summary

Refactored API routes
- POST: /api/invocations/from_store
- GET: /api/invocations
- GET: /api/workflows/{workflow_id}/invocations
- GET: /api/workflows/{workflow_id}/usage
Added pydantic models to input and return
Removed the mapping to the legacy routes

How to test the changes?

This is a refactoring of components with existing test coverage.
I added automated tests for the operations missing tests
Instructions for manual testing are as follows:
You can find the interactive API documentation here: http://127.0.0.1:8080/api/docs#/workflows

heisner-tillman marked this pull request as draft

January 2, 2024 14:10

github-actions bot added the area/API label

github-actions bot added this to the 24.0 milestone

mvdbeek reviewed

View reviewed changes

lib/galaxy/schema/invocation.py Outdated Show resolved Hide resolved

heisner-tillman force-pushed the invocations_ branch from 534072f to ebd3e71 Compare

January 6, 2024 12:51

mvdbeek reviewed

View reviewed changes

lib/galaxy/schema/invocation.py Outdated Show resolved Hide resolved

mvdbeek reviewed

View reviewed changes

lib/galaxy/schema/invocation.py Outdated Show resolved Hide resolved

heisner-tillman force-pushed the invocations_ branch 2 times, most recently from 6adb682 to e69078c Compare

January 11, 2024 14:24

mvdbeek reviewed

View reviewed changes

lib/galaxy/schema/invocation.py Outdated Show resolved Hide resolved

mvdbeek reviewed

View reviewed changes

lib/galaxy/schema/invocation.py Outdated Show resolved Hide resolved

lib/galaxy/webapps/galaxy/api/workflows.py Outdated Show resolved Hide resolved

lib/galaxy/webapps/galaxy/api/workflows.py Outdated Show resolved Hide resolved

lib/galaxy/webapps/galaxy/api/workflows.py Outdated Show resolved Hide resolved

lib/galaxy/webapps/galaxy/api/workflows.py Outdated Show resolved Hide resolved

heisner-tillman force-pushed the invocations_ branch 2 times, most recently from 45dbff0 to 6630653 Compare

January 14, 2024 11:52

heisner-tillman marked this pull request as ready for review

January 14, 2024 13:21

heisner-tillman force-pushed the invocations_ branch from 9f589f1 to 6630653 Compare

January 14, 2024 14:28

mvdbeek reviewed

View reviewed changes

lib/galaxy/webapps/galaxy/api/workflows.py Outdated Show resolved Hide resolved

mvdbeek reviewed

View reviewed changes

lib/galaxy/webapps/galaxy/api/workflows.py Outdated Show resolved Hide resolved

mvdbeek reviewed

View reviewed changes

lib/galaxy_test/api/test_workflows.py Outdated Show resolved Hide resolved

mvdbeek reviewed

View reviewed changes

lib/galaxy_test/api/test_workflows.py Outdated Show resolved Hide resolved

mvdbeek reviewed

View reviewed changes

lib/galaxy_test/api/test_workflows.py Outdated Show resolved Hide resolved

heisner-tillman added 10 commits

January 16, 2024 12:52


          Start refactoring on index_invocations operations

9eecaef


          Modify param definition to make it reusable

416d629


          Remove mapping to legacy route

d7a81bb


          Refactor index_invocations operations

ac2c3b2


          Move model CreateInvocationFromStore to invocation schema file

8a1604e


          Refactor internal method create_from_store into invocations service

687b65c


          Move model InvocationSerializationParams to invocations schema file

714011e


          Refactor create_invocations_from_store operation to FastAPI

dd8269a


          Remove mapping to legacy route

cdc9a94


          Refactor pydantic model to enable reuse

975a070

heisner-tillman added 22 commits

January 16, 2024 12:52


          Remove comment

101505e


          Set total_matches in response headers of index_inovcation operation

7a50e8b


          Specify body of the payload of the create_invocations_from_store oper…

f0c34d1

…ations


          Remove unnecessary encoding of id's

bf9d1f5


          Specify extra fields and adjust default values of fields in Invocatio…

7195af8

…nReport model


          Rename WorkFlowInvocationResponse models

11a5b8a


          Add missing query params for index_invocations operations

e02eee5


          Remove testing deprecated route

5a8a89a


          Refine pydantic models

48b355f


          Resolve issue with pydnatic 2 and new models

44d909a


          Revert some changes

0d375fd


          Regenerate the client schema

7719c5b


          Resolve merge mistakes

ac7e7a8


          Fix typing

bd42cd0


          Fix typing

1f561c3


          Regenerate the client schema

ff8b7cd


          Refine pydantic models

b6186cc


          Remove comments

d9b663d


          Regenerate the client schema

2bfca31


          Include deprecated route in tests

d1487e9


          Add deprecated path to index_workflow_invocations operation

fa69fd1


          Regnerate client schema

03a04c0

heisner-tillman force-pushed the invocations_ branch from 6630653 to 03a04c0 Compare

January 16, 2024 11:53

heisner-tillman marked this pull request as draft

January 16, 2024 11:59

heisner-tillman changed the title ~~Refactor the missing invocation routes to FastAPI~~ Refactor two of the missing invocation routes to FastAPI

heisner-tillman marked this pull request as ready for review

January 16, 2024 12:12

mvdbeek merged commit 1e3051d into galaxyproject:dev

58 checks passed

Member

mvdbeek commented Jan 16, 2024

Thank you, great work as usual @heisner-tillman!

github-actions bot commented Jan 16, 2024

This PR was merged without a "kind/" label, please correct.

bgruening added the kind/refactoring label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/API kind/refactoring