frontend: migrate API projects namespace to flask-restx #2807

nikromen · 2023-07-11T15:07:52Z

Fixes #2995

frontend/coprs_frontend/coprs/views/apiv3_ns/__init__.py

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py

frontend/coprs_frontend/coprs/views/apiv3_ns/schema.py

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py

with this we can get information about Actions in projects and show it to user Closes: fedora-copr#2807

nikromen · 2023-08-07T11:47:40Z

I accidentally closed it in 1c8f37f (typo in issue number)

frontend/coprs_frontend/coprs/views/apiv3_ns/schema.py

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py

frontend/coprs_frontend/coprs/views/apiv3_ns/__init__.py

FrostyX · 2023-09-14T17:14:33Z

Looking at the rendered documentation

All of the fields for add/edit are required but shouldn't be:

Fork has incorrect parameters (see CoprForkFormFactory):

Same with deleting a project.

FrostyX · 2023-09-14T18:27:17Z

I am also getting tracebacks from

from copr.v3 import Client
client = Client.create_from_config_file();
client.project_proxy.fork("@copr", "copr", "frostyx", "forked-copr")

and

client.project_proxy.delete("frostyx", "forked-copr")

nikromen · 2023-10-23T10:49:16Z

no progress

github-advanced-security

vcs-diff-lint found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

frontend/coprs_frontend/coprs/constants.py

FrostyX

Thank you for all of the updates. I was honestly a bit worried about the number of changes in this PR but as it turns out, it looks really good!

I am adding some in-code comments and then do some testing and submit a follow-up.

FrostyX · 2023-09-14T17:04:03Z

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_builds.py

@@ -38,8 +38,6 @@
 from .json2form import get_form_compatible_data


-
-


A leftover change here

this is just syntax fix since it has 4 new lines instead of 2

frontend/coprs_frontend/coprs/helpers.py

frontend/coprs_frontend/coprs/views/apiv3_ns/__init__.py

FrostyX · 2023-11-30T10:11:15Z

frontend/coprs_frontend/coprs/views/apiv3_ns/__init__.py

@@ -51,48 +47,67 @@ def home():
 # HTTP methods
 GET = ["GET"]
 POST = ["POST"]
+# TODO: POST != PUT nor DELETE, we should use at least use these methods according
+#  conventions -> POST to create new element, PUT to update element, DELETE to delete
+#  https://www.ibm.com/docs/en/urbancode-release/6.1.1?topic=reference-rest-api-conventions


Sounds reasonable but if we decide to do this, we need to fix python-copr, ideally a few releases beforehand.

yep, this is just todo - I deprecated it in docs so users are lightly pushed to use methods according to convention but I have no intention to discuss/bring a plan to drop them... just tell users the should use something else but keep it working.

I even introduced a warning header message that the endpoint is deprecated - but yes, this will be better once python-copr is fixed accordingly because then it would make response with warning headers even using copr's official python library which isn't good - thanks for pointing to it

frontend/coprs_frontend/coprs/views/apiv3_ns/__init__.py

FrostyX · 2023-11-30T10:47:58Z

frontend/coprs_frontend/coprs/views/apiv3_ns/schema/docs.py

+    if extra_fields is None:
+        return result_dict
+
+    return result_dict | extra_fields


At first sight, this function looks like a really good idea. I want to circle back here when finishing the review to check again.

frontend/coprs_frontend/coprs/views/misc.py

FrostyX · 2023-12-01T11:43:52Z

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py

@@ -40,6 +72,11 @@ def to_dict(copr):
        "packit_forge_projects_allowed": copr.packit_forge_projects_allowed_list,
        "follow_fedora_branching": copr.follow_fedora_branching,
        "repo_priority": copr.repo_priority,
+        # TODO: unify projectname and name or (good luck) force marshaling to work


FrostyX · 2023-12-01T12:04:44Z

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py

+        """
+        Edit Copr project
+        Edit existing Copr project for ownername/projectname in form.
+        """


If I understand correctly, we are going to deprecate this in the future and keep only PUT? Please don't use the @deprecated decorator yet but it'd be a good idea to mention that we plan to deprecate it in the docstring. Same for other POST -> PUT/DELETE routes.

It would be nice to warn users to use the proper HTTP method - e.g. PUT and fix it in python-copr.

I think mentioning it somewhere (e.g. release notes) is a good idea.

we are going to deprecate this in the future and keep only PUT

I think a lot of users use our API in this "bad" way and I don't want to force them to fix their already working scripts. This idea is mainly about documentation saying it is deprecated and a warning header saying it is deprecated but no plan to drop the functionality whatsoever

frontend/coprs_frontend/coprs/views/apiv3_ns/schema/__init__.py

FrostyX · 2023-12-01T12:55:48Z

I found a difference for GET /package route, IMHO for the worse.

Production:

This PR:

Additionally, when you click "Try it out", and then "Excecute", you get Undocumented TypeError: Failed to execute 'fetch' on 'Window': Request with GET/HEAD method cannot have body. in the Swagger UI.

FrostyX · 2023-12-01T13:02:31Z

frontend/coprs_frontend/coprs/views/apiv3_ns/schema/schemas.py

+    is_background: Boolean
+    ownername: String
+    project_dirname: String
+    projectname: String


I am quite unhappy, that we define the same data type on multiple places. Here, and in fields.py.

projectname = String( description="Name of the project", example="copr-dev", )

Can we do something about that?

I am not 100% sure but I think there isn't a way to do it :/ pydantic/marshmallow or dataclasses needs to define somehow the types for i/o checking

one possible solution is to get rid of fields.py but that will mean defining the same descriptions, etc. on multiple place

or with dataclasses we could just write some_field: ... or some_field: Any - it doesn't matter (python's syntax just needs some type definition), but pydantic/marshmallow will require it to check the input/output

I saw this way as the "lesser evil" and allowing #3031 happen with the least amount of pain as possible (thus dropping the deprecated parsers)

FrostyX · 2023-12-02T17:40:33Z

The following beaker tests fail, some of them possibly related to this PR:

pagure67.sh
runtest-autospec.sh
runtest-build-attrs.sh
runtest-custom-method.sh
runtest-distgit.sh
runtest-dnf-copr.sh
runtest-regenerate-repos.sh
runtest.sh

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_packages.py

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_project_chroots.py

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py

frontend/coprs_frontend/coprs/views/misc.py

nikromen · 2023-12-15T00:52:35Z

@FrostyX I fixed hopefully everything - some beaker tests still fail but I think it isn't fault of this PR.

some were falling mainly because of @editable_copr -> @api_login_required has to be used before it

nikromen · 2023-12-15T15:32:40Z

I run beaker tests against the current main and the same tests fail as with this PR:

runtest-custom-method.sh
runtest-fedora-review.sh
runtest-modules.sh
runtest-openmandriva.sh
runtest-pyp2spec.sh

and runtest-architectures are stuck upon s390x

FrostyX · 2023-12-20T12:10:17Z

Thank you for the progress. This is not an easy one.
There is for sure room for improvement but we need to do that in steps. Some of the not-so-pretty things will get dropped once we migrate every API route to flask-restx.

github-advanced-security bot found potential problems Jul 11, 2023

View reviewed changes

nikromen force-pushed the openapi-more-steps branch 2 times, most recently from a4c578e to 5278c29 Compare July 12, 2023 15:18

github-advanced-security bot found potential problems Jul 12, 2023

View reviewed changes

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py Fixed Show fixed Hide fixed

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py Fixed Show fixed Hide fixed

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py Fixed Show fixed Hide fixed

nikromen force-pushed the openapi-more-steps branch from 5278c29 to 40f44af Compare July 12, 2023 15:22

github-advanced-security bot found potential problems Jul 12, 2023

View reviewed changes

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py Fixed Show fixed Hide fixed

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py Fixed Show fixed Hide fixed

nikromen force-pushed the openapi-more-steps branch from 40f44af to e97587d Compare July 13, 2023 10:26

github-advanced-security bot found potential problems Jul 13, 2023

View reviewed changes

praiskup assigned FrostyX Jul 24, 2023

praiskup pushed a commit to nikromen/copr that referenced this pull request Aug 4, 2023

frontend: add relationship between Action model and Copr model

910ed2c

with this we can get information about Actions in projects and show it to user Closes: fedora-copr#2807

nikromen closed this in 1c8f37f Aug 7, 2023

nikromen reopened this Aug 7, 2023

nikromen force-pushed the openapi-more-steps branch 2 times, most recently from b66bf04 to e7f70da Compare August 7, 2023 16:33

github-advanced-security bot found potential problems Aug 7, 2023

View reviewed changes

frontend/coprs_frontend/coprs/views/apiv3_ns/schema.py Fixed Show fixed Hide fixed

nikromen force-pushed the openapi-more-steps branch from e7f70da to 93bd0d7 Compare August 17, 2023 16:46

github-advanced-security bot found potential problems Aug 17, 2023

View reviewed changes

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py Fixed Show fixed Hide fixed

nikromen force-pushed the openapi-more-steps branch from 93bd0d7 to 4efd3c6 Compare August 17, 2023 17:03

github-advanced-security bot found potential problems Aug 17, 2023

View reviewed changes

frontend/coprs_frontend/coprs/views/apiv3_ns/__init__.py Fixed Show fixed Hide fixed

nikromen force-pushed the openapi-more-steps branch 2 times, most recently from f8e6766 to 8c1c418 Compare August 17, 2023 17:21

nikromen force-pushed the openapi-more-steps branch from 8c1c418 to fe32d34 Compare November 19, 2023 00:13

github-advanced-security bot found potential problems Nov 19, 2023

View reviewed changes

nikromen force-pushed the openapi-more-steps branch 3 times, most recently from 7ffc918 to a6129a6 Compare November 21, 2023 16:26

nikromen force-pushed the openapi-more-steps branch 2 times, most recently from c8a09b6 to 007c77e Compare November 21, 2023 17:58

github-advanced-security bot found potential problems Nov 21, 2023

View reviewed changes

frontend/coprs_frontend/coprs/constants.py Fixed Show fixed Hide fixed

frontend/coprs_frontend/coprs/constants.py Fixed Show fixed Hide fixed

frontend/coprs_frontend/coprs/constants.py Fixed Show fixed Hide fixed

frontend/coprs_frontend/coprs/constants.py Fixed Show fixed Hide fixed

nikromen force-pushed the openapi-more-steps branch 2 times, most recently from bdc2824 to 3b21979 Compare November 27, 2023 13:18

This was referenced Nov 27, 2023

Use some common descriptions between Fask-restx fields and WTForms #3029

Open

frontend: use common enum constants for sharing descriptions #3030

Closed

Use I/O validation for flask-restx #3031

Open

nikromen force-pushed the openapi-more-steps branch 2 times, most recently from fbbb56c to 4e6ac08 Compare November 27, 2023 14:14

FrostyX reviewed Dec 1, 2023

View reviewed changes

nikromen force-pushed the openapi-more-steps branch 2 times, most recently from 6a986b2 to 700adf8 Compare December 3, 2023 18:54

nikromen force-pushed the openapi-more-steps branch from 700adf8 to dd17175 Compare December 12, 2023 16:43

github-advanced-security bot found potential problems Dec 12, 2023

View reviewed changes

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_packages.py Fixed Show fixed Hide fixed

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_project_chroots.py Fixed Show fixed Hide fixed

frontend/coprs_frontend/coprs/views/apiv3_ns/apiv3_projects.py Fixed Show fixed Hide fixed

nikromen force-pushed the openapi-more-steps branch 2 times, most recently from a3d4ba7 to ab18608 Compare December 12, 2023 16:51

github-advanced-security bot found potential problems Dec 12, 2023

View reviewed changes

frontend/coprs_frontend/coprs/views/misc.py Fixed Show fixed Hide fixed

frontend/coprs_frontend/coprs/views/misc.py Fixed Show fixed Hide fixed

nikromen force-pushed the openapi-more-steps branch from ab18608 to a787b5e Compare December 12, 2023 16:58

frontend: migrate API projects namespace to flask-restx

49d17cd

nikromen force-pushed the openapi-more-steps branch from a787b5e to 49d17cd Compare December 15, 2023 00:49

FrostyX merged commit 0383577 into fedora-copr:main Dec 20, 2023
7 checks passed

FrostyX mentioned this pull request Jan 4, 2024

frontend, python: allow ignoring errors that a project already exists #3085

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

frontend: migrate API projects namespace to flask-restx #2807

frontend: migrate API projects namespace to flask-restx #2807

nikromen commented Jul 11, 2023 •

edited

Loading

nikromen commented Aug 7, 2023

FrostyX commented Sep 14, 2023

FrostyX commented Sep 14, 2023

nikromen commented Oct 23, 2023

github-advanced-security bot left a comment

FrostyX left a comment

FrostyX Sep 14, 2023

nikromen Dec 3, 2023

FrostyX Nov 30, 2023

nikromen Dec 3, 2023

FrostyX Nov 30, 2023

FrostyX Dec 1, 2023

FrostyX Dec 1, 2023

nikromen Dec 3, 2023

FrostyX commented Dec 1, 2023

FrostyX Dec 1, 2023

nikromen Dec 3, 2023 •

edited

Loading

FrostyX commented Dec 2, 2023

nikromen commented Dec 15, 2023

nikromen commented Dec 15, 2023

FrostyX commented Dec 20, 2023

		@@ -38,8 +38,6 @@
		from .json2form import get_form_compatible_data

frontend: migrate API projects namespace to flask-restx #2807

frontend: migrate API projects namespace to flask-restx #2807

Conversation

nikromen commented Jul 11, 2023 • edited Loading

nikromen commented Aug 7, 2023

FrostyX commented Sep 14, 2023

FrostyX commented Sep 14, 2023

nikromen commented Oct 23, 2023

github-advanced-security bot left a comment

Choose a reason for hiding this comment

FrostyX 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FrostyX commented Dec 1, 2023

Choose a reason for hiding this comment

nikromen Dec 3, 2023 • edited Loading

Choose a reason for hiding this comment

FrostyX commented Dec 2, 2023

nikromen commented Dec 15, 2023

nikromen commented Dec 15, 2023

FrostyX commented Dec 20, 2023

nikromen commented Jul 11, 2023 •

edited

Loading

nikromen Dec 3, 2023 •

edited

Loading