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.

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

refactor: switches EDC over to using the runtime-metamodel library #2002

Conversation

paullatzelsperger
Copy link
Member

@paullatzelsperger paullatzelsperger commented Sep 22, 2022

What this PR changes/adds

Some of the metamodel annotations and classes have been relocated into the runtime-metamodel library, which is available as Maven artifact. Specifically the following things were done:

  • remove tooling/
  • remove metamodel annotations like @Inject, @Provides, etc.
  • add dependency onto org.eclipse.dataspaceconnector:runtime-metamodel:0.0.1-SNAPSHOT
  • adapt all affected import statements

Why it does that

Both EDC and the documentation generator Gradle plugin ("autodoc") need access to this information, so we needed to move it out to break a cyclic dependency.

Further notes

  • runtime-metamodel will be available as 0.0.1-SNAPSHOT until such time as we have a decision on how we deal with these components in regard to versioning, group ids, etc.

  • the amount of files changed is mostly caused by updated import statements

Linked Issue(s)

Closes #1988
closes #2001

Checklist

  • added appropriate tests?
  • performed checkstyle check locally?
  • added/updated copyright headers?
  • documented public classes/methods?
  • added/updated relevant documentation?
  • assigned appropriate label? (exclude from changelog with label no-changelog)
  • formatted title correctly? (take a look at the CONTRIBUTING and styleguide for details)

@paullatzelsperger paullatzelsperger added refactoring Cleaning up code and dependencies build Anything related to the CI/CD Pipeline on Github Actions dependencies Pull requests that update a dependency file labels Sep 22, 2022
@paullatzelsperger paullatzelsperger added this to the Milestone 7 milestone Sep 22, 2022
@paullatzelsperger paullatzelsperger force-pushed the cleanup/1988_move_out_metamodel_and_annotations branch from 05c250e to 479bf65 Compare September 22, 2022 13:25
@paullatzelsperger paullatzelsperger temporarily deployed to Azure-dev September 22, 2022 13:25 Inactive
@paullatzelsperger paullatzelsperger marked this pull request as ready for review September 22, 2022 13:32
@paullatzelsperger paullatzelsperger changed the title cleanup: switches EDC over to using the runtime-metamodel library refactor: switches EDC over to using the runtime-metamodel library Sep 22, 2022
Copy link
Contributor

@juliapampus juliapampus left a comment

Choose a reason for hiding this comment

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

Could you pls also update the codeowners file?

@juliapampus
Copy link
Contributor

In addition, I was wondering whether our decision to extract the metamodel should be documented by a decision record? I know we have not done this for the other components, however, this is a new dependency the connector relies on, so it would be nice to write it down and link to the decision record 2022-08-04-documentation-automation as this already talks about using a Gradle plugin.

@paullatzelsperger
Copy link
Member Author

paullatzelsperger commented Sep 23, 2022

Could you pls also update the codeowners file?

Sure. Thanks for noticing.

Decision record

yup I agree, will create one

@paullatzelsperger paullatzelsperger temporarily deployed to Azure-dev September 23, 2022 07:45 Inactive
@codecov-commenter
Copy link

Codecov Report

Base: 63.24% // Head: 63.68% // Increases project coverage by +0.43% 🎉

Coverage data is based on head (d931a5a) compared to base (3e46d70).
Patch coverage: 13.63% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2002      +/-   ##
==========================================
+ Coverage   63.24%   63.68%   +0.43%     
==========================================
  Files         789      772      -17     
  Lines       16655    16347     -308     
  Branches     1084     1053      -31     
==========================================
- Hits        10533    10410     -123     
+ Misses       5670     5493     -177     
+ Partials      452      444       -8     
Impacted Files Coverage Δ
...ceconnector/core/CoreDefaultServicesExtension.java 76.47% <ø> (ø)
...dataspaceconnector/core/CoreServicesExtension.java 93.93% <ø> (ø)
...aspaceconnector/core/base/OkHttpClientFactory.java 92.85% <ø> (ø)
...ataspaceconnector/boot/system/DependencyGraph.java 98.52% <ø> (ø)
...injection/lifecycle/ExtensionLifecycleManager.java 100.00% <ø> (ø)
.../contract/ContractNegotiationCommandExtension.java 100.00% <ø> (ø)
...ceconnector/contract/ContractServiceExtension.java 95.77% <ø> (ø)
...rolplane/ControlPlaneDefaultServicesExtension.java 0.00% <ø> (ø)
...connector/transfer/core/CoreTransferExtension.java 0.00% <ø> (ø)
...transfer/core/TransferProcessCommandExtension.java 0.00% <ø> (ø)
... and 81 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@paullatzelsperger paullatzelsperger merged commit ff345c3 into eclipse-edc:main Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Anything related to the CI/CD Pipeline on Github Actions dependencies Pull requests that update a dependency file refactoring Cleaning up code and dependencies
Projects
None yet
5 participants