Merge pull request #491 from catenax-ng/main

Merge from CatenaX

Author: ds-jhartmann

.github/workflows/publish-swagger-hub.yml

@@ -0,0 +1,50 @@
+name: "Publish OpenAPI to Swaggerhub"
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        required: true
+        description: Version that will be published to Swaggerhub
+        type: string
+
+jobs:
+  swagger-api:
+    runs-on: ubuntu-latest
+    env:
+      SWAGGERHUB_API_KEY: ${{ secrets.SWAGGERHUB_API_KEY }}
+      SWAGGERHUB_USER: ${{ secrets.SWAGGERHUB_USER }}
+      DOWNSTREAM_VERSION: ${{ inputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+
+      - name: Install Swagger CLI
+        run: |
+          npm i -g swaggerhub-cli
+
+      # create API, will fail if exists
+      - name: Create API
+        continue-on-error: true
+        run: |
+          swaggerhub api:create ${{ env.SWAGGERHUB_USER }}/item-relationship-service/${{ env.DOWNSTREAM_VERSION }} -f docs/src/api/irs-api.yaml --visibility=public --published=unpublish
+
+      # Post the API to SwaggerHub as "unpublished", because published APIs cannot be overwritten
+      - name: Publish API Specs to SwaggerHub
+        run: |
+          if [[ ${{ env.DOWNSTREAM_VERSION }} != *-SNAPSHOT ]]; then
+            echo "[INFO] - no snapshot, will set the API to 'published'";
+            swaggerhub api:update ${{ env.SWAGGERHUB_USER }}/item-relationship-service/${{ env.DOWNSTREAM_VERSION }} -f docs/src/api/irs-api.yaml --visibility=public --published=publish
+            swaggerhub api:setdefault ${{ env.SWAGGERHUB_USER }}/item-relationship-service/${{ env.DOWNSTREAM_VERSION }}
+          else
+            echo "[INFO] - snapshot, will set the API to 'unpublished'";
+            swaggerhub api:update ${{ env.SWAGGERHUB_USER }}/item-relationship-service/${{ env.DOWNSTREAM_VERSION }} -f docs/src/api/irs-api.yaml --visibility=public --published=unpublish
+          fi

.github/workflows/release.yaml

@@ -59,6 +59,17 @@ jobs:
     needs:
       - release
     uses: ./.github/workflows/jira-publish-release.yaml
+    with:
+      version: ${{ github.ref_name }}
+    secrets: inherit
+
+  publish-to-swaggerhub:
+    name: "Publish OpenAPI spec to Swaggerhub"
+    permissions:
+      contents: read
+    needs:
+      - release
+    uses: ./.github/workflows/publish-swagger-hub.yml
     with:
       version: ${{ github.ref_name }}
     secrets: inherit

.gitignore

@@ -70,3 +70,8 @@ docs/src/diagram-replacer/package-lock.json
 docs/src/diagram-replacer/package.json
 docs/src/diagram-replacer/plantuml.jar
 
+# Helm Chart Dependencies
+/charts/irs-helm/Chart.lock
+/charts/irs-helm/charts/
+
+

CHANGELOG.md

@@ -7,13 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 _**For better traceability add the corresponding GitHub issue number in each changelog entry, please.**_
 
 ## [Unreleased]
-### Changed
 
-- EdcPolicyDefinitionService, EdcContractDefinitionService and EdcAssetService return throw AlreadyExist exceptions when Conflict is returned from EDC
+## [4.8.0] - 2024-03-18
+### Changed
+- Improved maintainability in EdcSubmodelClientImpl by reduced method visibility and better naming (in context of #448).
+- EdcPolicyDefinitionService, EdcContractDefinitionService and EdcAssetService return throw AlreadyExist exceptions when Conflict is returned from
+  EDC
 - Added AssetAdministrationShellDescriptor specificAssetIds support for externalSubjectId required for data provisioning
 - Registering a job - aspects array is now accepting full urn of aspect model instead of name only, eg. 'urn:bamm:io.catenax.single_level_bom_as_built:2.0.0#SingleLevelBomAsBuilt' instead 'SingleLevelBomAsBuilt'. #439
 - Changed the version of irs-registry-client from 1.6.0-SNAPSHOT to 1.6.0
 
+## Fixed
+- Fixed missing timeouts including configuration. #448
+
 ## [4.7.0] - 2024-03-04
 ### Added
 - DigitalTwinRegistryCreateShellService in irs-registry-client for creating shells in DTR directly
@@ -574,7 +580,8 @@ _**For better traceability add the corresponding GitHub issue number in each cha
 ### Unresolved
 - **Select Aspects you need**  You are able to select the needed aspects for which you want to collect the correct endpoint information.
 
-[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.7.0...HEAD
+[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.8.0...HEAD
+[4.8.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.7.0...4.8.0
 [4.7.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.6.0...4.7.0
 [4.6.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.5.2...4.6.0
 [4.5.2]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.5.1...4.5.2

COMPATIBILITY_MATRIX.md

@@ -1,6 +1,19 @@
 # Compatibility matrix IRS
 
 Full changelog of IRS: [changelog](CHANGELOG.md)
+## [4.8.0] - 2024-03-18
+| Dependency                | Version                      | Helm       | Comments        |
+|---------------------------|------------------------------|------------|-----------------|
+| EDC                       | 0.5.3                        | 0.5.3      |                 |
+| EDC PostgresSQL           | 15.1.0-debian-11-r12         | 12.1.6     | Optional        |
+| MIW                       | 0.1.0                        | 0.1.0      | REST connection |
+| Semantics Hub             | 0.1.29                       | v0.2.11-M1 | REST connection |
+| DTR                       | 0.3.14-M1                    | 0.3.22     | REST connection |
+| Minio                     | RELEASE.2022-11-11T03-44-20Z | 5.0.1      |                 |
+| SingleLevelBomAsBuilt     | 2.0.0                        | -          | Model version   | 
+| SingleLevelBomAsPlanned   | 2.0.0                        | -          | Model version   | 
+| SingleLevelBomAsSpecified | 1.0.0                        | -          | Model version   | 
+| SingleLevelUsageAsBuilt   | 2.0.0                        | -          | Model version   | 
 
 
 ## [4.7.0] - 2024-03-04

CONTRIBUTING.md

@@ -176,13 +176,14 @@ https://github.com/google/google-java-format/blob/master/README.md#intellij-jre-
    - Check if the changelog entries for the release are complete.
    - Add the corresponding GitHub issue numbers to each entry if missing.
 3. Update [COMPATIBILITY_MATRIX.md](COMPATIBILITY_MATRIX.md).
-4. Create pull request from [release preparation branch to main](https://github.com/eclipse-tractusx/item-relationship-service/compare/chore/prepare-release-x.x.x) and merge to main.
-5. Create Git tag for the desired release version `git tag x.x.x`
+4. Update IRS API version in IrsApplication class and irs-api.yaml
+5. Create pull request from [release preparation branch to main](https://github.com/eclipse-tractusx/item-relationship-service/compare/chore/prepare-release-x.x.x) and merge to main.
+6. Create Git tag for the desired release version `git tag x.x.x`
    (note: the irs-helm tag will be created automatically by the GitHub workflow based on the version in the irs-helm changelog). 
-6. Push Git tag to repository `git push origin x.x.x` (this will trigger the GitHub release workflow).
-7. Wait for release workflow to complete.
-8. Merge the automatically opened PR by GitHub actions bot.
-9. Notify about the release in IRS Matrix Chat using the following template: 
+7. Push Git tag to repository `git push origin x.x.x` (this will trigger the GitHub release workflow).
+8. Wait for release workflow to complete.
+9. Merge the automatically opened PR by GitHub actions bot.
+10. Notify about the release in IRS Matrix Chat using the following template: 
 
    >   **IRS Release x.x.x**
    >

README.md

@@ -91,17 +91,22 @@ See [INSTALL](INSTALL.md).
 The following subsection provides instructions for running the infrastructure on docker-compose and the application in
 the IDE.
 
-After the application is up and running the local IRS API is available at the following URLs:
+Start the application with the commands in the subsection further below. 
+After everything is up and running the local IRS API is available at the following URLs:
 
 - Swagger UI: http://localhost:8080/api/swagger-ui
 - API docs: http://localhost:8080/api/api-docs
 - API docs in yaml: http://localhost:8080/api/api-docs.yaml
 
-
 #### Docker-compose + IDE
 
-1. Start the necessary infrastructure by running `docker-compose up`
-2.  Start the application from your favorite IDE. For IntelliJ, a run configuration is available in the `.run` folder.
+1. `cd local/deployment`
+2. Start the necessary infrastructure by running `docker-compose up`
+3. Start the application from your favorite IDE. For IntelliJ, a run configuration is available in the `.run` folder.
+
+In case of problems connecting to MinIO check whether the MinIO console is accessible in your webbrowser 
+(see URL in the output of step 2). You might need to wait some time before MinIO is up and accepts connections.
+If that does not help, execute `docker-compose down` and repeat from step 2.
 
 
 ## Usage

charts/irs-helm/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.17.0] - 2024-03-18
+### Added
+- Added property `edc.controlplane.asyncTimeout` which allows to set a global time-to-live for all async requests over EDC
+
+### Changed
+- Update IRS version to 4.8.0
+
 ## [6.16.0] - 2024-03-04
 ### Added
 - Added configuration property `edc.controlplane.endpoint.contractAgreements`

charts/irs-helm/Chart.yaml

@@ -35,12 +35,12 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 6.16.0
+version: 6.17.0
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "4.7.0"
+appVersion: "4.8.0"
 dependencies:
   - name: common
     repository: https://charts.bitnami.com/bitnami

charts/irs-helm/templates/configmap-spring-app-config.yaml

@@ -100,6 +100,7 @@ data:
 
     irs-edc-client:
       callback-url: {{ tpl (.Values.edc.callbackurl | default (printf "http://%s%s" .Release.Name "-irs-helm:8181/internal/endpoint-data-reference")) . | quote }}
+      asyncTimeout: {{ tpl .Values.edc.asyncTimeout . | default "PT10M" | quote }}
       controlplane:
         request-ttl: {{ .Values.edc.controlplane.request.ttl | default "PT10M" | quote }}
         endpoint: