refactor: split data plane module into two separate modules #3676

hamidonos · 2023-11-30T13:23:20Z

What this PR changes/adds

Split data-plane-api module into two separate modules data-plane-control-api & data-plane-public-api
Map data-plane-public-api module to public-api group

Why it does that

Interfaces under data-plane-public-api should not be under control-api api group because this api group is intended for internal communication.

Further notes

This introduces a breaking change because the data-plane-api module has been split into data-plane-control-api and data-plane-public-api. Downstream projects need to adjust their dependencies.

Note that the migration of the data-plane-api README file will be handled in a separate PR.

Linked Issue(s)

Closes #3373
Depends on #3686

# Conflicts: # spi/common/core-spi/src/main/java/org/eclipse/edc/spi/monitor/Monitor.java # spi/common/core-spi/src/main/java/org/eclipse/edc/spi/monitor/PrefixMonitor.java

codecov-commenter · 2023-11-30T13:39:51Z

Codecov Report

Attention: 7 lines in your changes are missing coverage. Please review.

Comparison is base (bdd6a2a) 71.73% compared to head (b1da7d9) 71.72%.

Files	Patch %	Lines
...or/dataplane/api/DataPlaneControlApiExtension.java	0.00%	4 Missing ⚠️
.../api/controller/DataPlaneControlApiController.java	66.66%	2 Missing ⚠️
...tor/dataplane/api/DataPlanePublicApiExtension.java	0.00%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3676      +/-   ##
==========================================
- Coverage   71.73%   71.72%   -0.02%     
==========================================
  Files         919      919              
  Lines       18465    18468       +3     
  Branches     1034     1034              
==========================================
  Hits        13246    13246              
- Misses       4760     4763       +3     
  Partials      459      459

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…_api_context_into_dedicated_swagger_hub_page

…ncy to tests

.github/workflows/apidoc.yaml

extensions/data-plane/data-plane-control-api/README.md

extensions/data-plane/data-plane-public-api/README.md

extensions/data-plane/data-plane-public-api/build.gradle.kts

jimmarino

Can we please break this into two PRs because the module shift has implications for downstream repositories and is not a "doc" change?

hamidonos · 2023-12-01T11:56:42Z

Can we please break this into two PRs because the module shift has implications for downstream repositories and is not a "doc" change?

The creation of the new public hub & split of the modules is the minimum requirement for this PR
If we split the "doc" part into a separate PR then we will release two modules (this PR) with wrong/missing doc
To me the modularization + doc change is one unit

jimmarino · 2023-12-01T14:15:18Z

Can we please break this into two PRs because the module shift has implications for downstream repositories and is not a "doc" change?

The creation of the new public hub & split of the modules is the minimum requirement for this PR If we split the "doc" part into a separate PR then we will release two modules (this PR) with wrong/missing doc To me the modularization + doc change is one unit

We are not releasing the doc at this point. The two changes are distinct, particularly because the module split has significant downstream implications. Please make these changes in two separate PRs so that they can be reviewed and documented correctly.

…into_dedicated_swagger_hub_page' into docs/publish_public_api_context_into_dedicated_swagger_hub_page # Conflicts: # extensions/data-plane/data-plane-control-api/README.md # extensions/data-plane/data-plane-public-api/README.md

extensions/data-plane/data-plane-common/build.gradle.kts

ndr-brt

LGTM

jimmarino

This PR does not appear to break out the changes into two PRs as requested (at least the title does not indicate that, and my issue was not marked as resolved).

Please put the module refactor in its own PR.

…_api_context_into_dedicated_swagger_hub_page

hamidonos · 2023-12-05T10:45:06Z

This PR does not appear to break out the changes into two PRs as requested (at least the title does not indicate that, and my issue was not marked as resolved).

Please put the module refactor in its own PR.

This PR is now solely responsible for the module migration

I'm unable to resolve your comment tho

hamidonos and others added 6 commits November 14, 2023 14:05

feat: add PrefixMonitor (eclipse-edc#3510)

b27df54

Merge remote-tracking branch 'upstream/main'

b1567fc

Merge remote-tracking branch 'origin/main'

d8a378a

Merge remote-tracking branch 'upstream/main'

4dbc1a6

# Conflicts: # spi/common/core-spi/src/main/java/org/eclipse/edc/spi/monitor/Monitor.java # spi/common/core-spi/src/main/java/org/eclipse/edc/spi/monitor/PrefixMonitor.java

Merge remote-tracking branch 'upstream/main'

357576a

docs: publish data plane public api into dedicated swagger hub page

b51c0fb

hamidonos requested review from ndr-brt, bscholtes1A, jimmarino and paullatzelsperger as code owners November 30, 2023 13:23

hamidonos self-assigned this Nov 30, 2023

hamidonos added documentation Improvements or additions to documentation refactoring Cleaning up code and dependencies labels Nov 30, 2023

fix: remove extensions/data-plane/data-plane-common/README.md

ba032b4

hamidonos marked this pull request as draft November 30, 2023 14:03

hamidonos added 2 commits November 30, 2023 16:09

Merge remote-tracking branch 'upstream/main' into docs/publish_public…

af350ca

…_api_context_into_dedicated_swagger_hub_page

fix: add missing :extensions:data-plane:data-plane-public-api depende…

eb16811

…ncy to tests

hamidonos marked this pull request as ready for review November 30, 2023 15:20

hamidonos added the breaking-change Will require manual intervention for version update label Nov 30, 2023

ndr-brt requested changes Dec 1, 2023

View reviewed changes

fix: fix pr comments

b31757d

hamidonos requested a review from juliapampus as a code owner December 1, 2023 10:54

jimmarino requested changes Dec 1, 2023

View reviewed changes

hamidonos added 3 commits December 1, 2023 16:54

fix: fix pr comments

7b514aa

fix: revert changes in data-transfer.md

5a199d4

hamidonos requested a review from ndr-brt December 4, 2023 09:32

hamidonos requested a review from jimmarino December 4, 2023 09:32

ndr-brt requested changes Dec 4, 2023

View reviewed changes

extensions/data-plane/data-plane-common/build.gradle.kts Outdated Show resolved Hide resolved

fix: pr fixes

2ff5071

hamidonos requested a review from ndr-brt December 4, 2023 14:09

ndr-brt approved these changes Dec 4, 2023

View reviewed changes

jimmarino requested changes Dec 4, 2023

View reviewed changes

hamidonos changed the title ~~docs: publish public api context into dedicated swagger hub page~~ enhancement: publish public api context into dedicated swagger hub page Dec 4, 2023

hamidonos added enhancement New feature or request and removed documentation Improvements or additions to documentation labels Dec 4, 2023

hamidonos changed the title ~~enhancement: publish public api context into dedicated swagger hub page~~ refactor: split data plane module into two separate modules Dec 5, 2023

hamidonos marked this pull request as draft December 5, 2023 09:38

hamidonos removed the enhancement New feature or request label Dec 5, 2023

Merge remote-tracking branch 'upstream/main' into docs/publish_public…

b1da7d9

…_api_context_into_dedicated_swagger_hub_page

hamidonos marked this pull request as ready for review December 5, 2023 10:08

hamidonos requested a review from jimmarino December 5, 2023 10:42

bscholtes1A approved these changes Dec 6, 2023

View reviewed changes

jimmarino approved these changes Dec 6, 2023

View reviewed changes

ndr-brt merged commit dba3109 into eclipse-edc:main Dec 11, 2023
16 of 22 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: split data plane module into two separate modules #3676

refactor: split data plane module into two separate modules #3676

hamidonos commented Nov 30, 2023 •

edited

Loading

codecov-commenter commented Nov 30, 2023 •

edited

Loading

jimmarino left a comment

hamidonos commented Dec 1, 2023

jimmarino commented Dec 1, 2023

ndr-brt left a comment

jimmarino left a comment

hamidonos commented Dec 5, 2023

refactor: split data plane module into two separate modules #3676

refactor: split data plane module into two separate modules #3676

Conversation

hamidonos commented Nov 30, 2023 • edited Loading

What this PR changes/adds

Why it does that

Further notes

Linked Issue(s)

codecov-commenter commented Nov 30, 2023 • edited Loading

Codecov Report

jimmarino left a comment

Choose a reason for hiding this comment

hamidonos commented Dec 1, 2023

jimmarino commented Dec 1, 2023

ndr-brt left a comment

Choose a reason for hiding this comment

jimmarino left a comment

Choose a reason for hiding this comment

hamidonos commented Dec 5, 2023

hamidonos commented Nov 30, 2023 •

edited

Loading

codecov-commenter commented Nov 30, 2023 •

edited

Loading