Skip to content
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

http-api: T6736: move REST API to a node distinct from GraphQL API #4110

Merged
merged 9 commits into from
Oct 4, 2024
Merged

http-api: T6736: move REST API to a node distinct from GraphQL API #4110

merged 9 commits into from
Oct 4, 2024

Conversation

jestabro
Copy link
Contributor

@jestabro jestabro commented Sep 30, 2024 •
edited
Loading

Change Summary

The REST API was originally implemented under the node ['service', 'https', 'api'], and the GraphQL API implemented as a subnode of that path. Refactor the http-api server into distinct configuration nodes:

['service', 'https', 'api', 'rest']
['service', 'https', 'api', 'graphql']

Structures shared by the apis are simplified; distinct structures are organized more symmetrically.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

  • New feature (non-breaking change which adds functionality)

  • Code style update (formatting, renaming)

  • Refactoring (no functional changes)
    --- the one functional change is that the GraphQL API may now be made available independently of the REST API.

  • Migration from an old Vyatta component to vyos-1x, please link to related PR inside obsoleted component

  • Other (please describe):

Related Task(s)

Related PR(s)

vyos/vyos-documentation#1557

Component(s) name

Proposed changes

How to test

Smoketest result

DEBUG - Running Testcase: /usr/libexec/vyos/tests/smoke/cli/test_service_https.py
DEBUG - test_api_add_delete (__main__.TestHTTPSService.test_api_add_delete) ... ok
DEBUG - test_api_auth (__main__.TestHTTPSService.test_api_auth) ... ok
DEBUG - test_api_config_file (__main__.TestHTTPSService.test_api_config_file) ... ok
DEBUG - test_api_config_file_load_http (__main__.TestHTTPSService.test_api_config_file_load_http) ... ok
DEBUG - test_api_configure (__main__.TestHTTPSService.test_api_configure) ... ok
DEBUG - test_api_generate (__main__.TestHTTPSService.test_api_generate) ... ok
DEBUG - test_api_image (__main__.TestHTTPSService.test_api_image) ... ok
DEBUG - test_api_incomplete_key (__main__.TestHTTPSService.test_api_incomplete_key) ... ok
DEBUG - test_api_missing_keys (__main__.TestHTTPSService.test_api_missing_keys) ... ok
DEBUG - test_api_reset (__main__.TestHTTPSService.test_api_reset) ... ok
DEBUG - test_api_show (__main__.TestHTTPSService.test_api_show) ... ok
DEBUG - test_certificate (__main__.TestHTTPSService.test_certificate) ... ok
DEBUG -
DEBUG - ----------------------------------------------------------------------
DEBUG - Ran 12 tests in 70.122s
DEBUG -
DEBUG - OK

Checklist:

  • I have read the CONTRIBUTING document
  • I have linked this PR to one or more Phabricator Task(s)
  • I have run the components SMOKETESTS if applicable
  • My commit headlines contain a valid Task id
  • My change requires a change to the documentation
  • I have updated the documentation accordingly

@jestabro
http-api: T6736: update for deprecated/renamed in Pydantic V2
3ad911a
@jestabro
http-api: T6736: separate REST API and GraphQL API activation
fc9885f 
The GraphQL API was implemented as an addition to the existing REST API.
As there is no necessary dependency, separate the initialization of the
respective endpoints. Factor out the REST Pydantic models and FastAPI
routes for symmetry and clarity.
@jestabro
http-api: T6736: remove routes on config delete
954be34 
Avoid duplicate entries in the list of routes when adding/deleting
endpoints.
@jestabro
http-api: T6736: regenerate openapi docs
9f7767c
@jestabro
http-api: T6736: add distinct XML path for REST API
8183e2c
@jestabro
http-api: T6736: update smoketest for syntax change
8322cc4
@jestabro
http-api: T6736: add migration script and update version
40d9663
@jestabro jestabro self-assigned this Sep 30, 2024
@jestabro jestabro requested a review from a team as a code owner September 30, 2024 03:47
@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 30, 2024 •
edited
Loading

👍
No issues in PR Title / Commit Title

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 30, 2024 •
edited
Loading

✅ No issues found in unused-imports check.. Please refer the workflow run

github-advanced-security[bot]
github-advanced-security bot found potential problems Sep 30, 2024
View reviewed changes
src/services/api/rest/models.py Fixed Show fixed Hide fixed
src/services/api/rest/models.py Fixed Show fixed Hide fixed
github-advanced-security[bot]
github-advanced-security bot found potential problems Oct 1, 2024
View reviewed changes
src/services/api/rest/models.py Dismissed Show dismissed Hide dismissed
src/services/api/rest/models.py Dismissed Show dismissed Hide dismissed
@jestabro
Copy link
Contributor Author

jestabro commented Oct 1, 2024 •
edited
Loading

The only remaining linting errors are due to an attempt to apply ruff to a now deleted file (since listed as a 'changed' file). Need to use added|modified in filter here:
https://github.com/vyos/.github/blob/current/.github/workflows/lint-with-ruff.yml#L28

@jestabro
Copy link
Contributor Author

jestabro commented Oct 1, 2024

Comments as to why the CodeQL scans are now dismissed are under 'Show dismissed'/'Show more details', namely:

  1. The stack trace does not expose any structure that is not already apparent by inspection of the open source code repository.
  2. The code scan is missing the fact that the return value is now sanitized by html.escape().

@jestabro jestabro mentioned this pull request Oct 1, 2024
Merged
10 tasks
@jestabro
Copy link
Contributor Author

jestabro commented Oct 1, 2024

Linting error fixed with:
vyos/.github#49

@jestabro jestabro mentioned this pull request Oct 1, 2024
Merged
1 task
dmbaturin
dmbaturin approved these changes Oct 3, 2024
View reviewed changes
Copy link
Member

@dmbaturin dmbaturin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a feeling that we should avoid mixing formatting changes with logic updates in the future, since PRs can be quite hard to review if they contain a lot of non-functional code changes.

@jestabro
Copy link
Contributor Author

jestabro commented Oct 3, 2024

Agreed, however, we need formatting updates in order to pass the linting check: the compromise here was to have all formatting changes is a single commit. Other PR's currently being prepared make the formatting update the initial commit, with logic changes following, which may be easier to read.

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 3, 2024

CI integration ❌ failed!

Details

CI logs

  • CLI Smoketests ❌ failed
  • Config tests 👍 passed
  • RAID1 tests 👍 passed
  • TPM tests 👍 passed

@c-po c-po merged commit 5a59d85 into vyos:current Oct 4, 2024
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dmbaturin dmbaturin dmbaturin approved these changes

@sever-sever sever-sever sever-sever approved these changes

@sarthurdev sarthurdev Awaiting requested review from sarthurdev sarthurdev is a code owner automatically assigned from vyos/reviewers

@zdc zdc Awaiting requested review from zdc zdc is a code owner automatically assigned from vyos/reviewers

@c-po c-po Awaiting requested review from c-po c-po is a code owner automatically assigned from vyos/reviewers

@nicolas-fort nicolas-fort Awaiting requested review from nicolas-fort nicolas-fort is a code owner automatically assigned from vyos/reviewers

Assignees

@jestabro jestabro

Labels
current
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jestabro @dmbaturin @sever-sever @c-po