Merge pull request #1060 from eclipse-tractusx/feat/create-master-data-via-ui

feat/create master data via UI

Author: tom-rm-meyer-ISST

CHANGELOG.md

@@ -5,6 +5,71 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v5.0.0
+
+The following Changelog lists the changes. Please refer to the [documentation](docs/README.md) for configuration needs and understanding the concept changes.
+
+The **need for configuration updates** is **marked bold**.
+
+### Added
+
+- added Master data page for viewing all materials and option to add material as an admin ([#1044](https://github.com/eclipse-tractusx/puris/pull/1044))
+- added Partner table and creation modal to Master data page ([#1054](https://github.com/eclipse-tractusx/puris/pull/1054))
+- added Material-Partner Relation table and creation modal to master data page ([#1059](https://github.com/eclipse-tractusx/puris/pull/1059))
+
+### Changed
+
+- /
+
+### Fixes
+
+- /
+
+### Known Knowns
+
+#### Running With Shared DTR and EDC
+
+PURIS FOSS may not be run on a shared DTR and EDC with full scope. See [Admin Guide](docs/admin/Admin_Guide.md#running-the-puris-foss-application-on-shared-enablement-services) for more information of possible scenarios.
+
+#### Upgradeability
+
+Data base migrations are performed but assets.
+
+#### Data Sovereignty
+
+For productive use the following enhancements are encouraged
+
+* User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role  
+  --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
+* Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this  
+  --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration)  
+  --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
+* As a non-Admin user I do not have ability to view policies in detail  
+  --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
+* ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented  
+  --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
+* unclear meaning of different stati in negotations  
+  --> add view of successfull contract agreeements wrt which data have been closed
+* current logging only done on info level  
+  --> enhance logging of policies (currently only available at debug level)
+* in case of non-matching policies (tested in various scenarios) no negotiation takes place  
+  --> enhance visualization or specific Error message to user
+* no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)
+
+#### Styleguide
+
+##### Overall
+
+* Brief description at the top of each page describing content would be nice for better user experience.
+
+##### Catalog
+
+* No action possible -> unclear to user when and how user will consume an offer
+
+##### Negotiations
+
+* Add filters for transparency (bpnl, state)
+
 ## v4.1.1
 
 The following Changelog lists the changes. Please refer to the [documentation](docs/README.md) for configuration needs and understanding the concept changes.

DEPENDENCIES_BACKEND

@@ -6,9 +6,9 @@ maven/mavencentral/com.fasterxml.jackson.core/jackson-core/2.19.2, Apache-2.0 AN
 maven/mavencentral/com.fasterxml.jackson.core/jackson-databind/2.19.2, Apache-2.0, approved, #21909
 maven/mavencentral/com.fasterxml.jackson.dataformat/jackson-dataformat-yaml/2.19.2, Apache-2.0, approved, #21912
 maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jakarta-jsonp/2.19.2, Apache-2.0, approved, #20841
-maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jdk8/2.19.2, Apache-2.0, approved, clearlydefined
+maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jdk8/2.19.2, Apache-2.0, approved, #24939
 maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jsr310/2.19.2, Apache-2.0, approved, #23299
-maven/mavencentral/com.fasterxml.jackson.module/jackson-module-parameter-names/2.19.2, Apache-2.0, approved, clearlydefined
+maven/mavencentral/com.fasterxml.jackson.module/jackson-module-parameter-names/2.19.2, Apache-2.0, approved, #24938
 maven/mavencentral/com.fasterxml/classmate/1.7.1, Apache-2.0, approved, #24482
 maven/mavencentral/com.github.stephenc.jcip/jcip-annotations/1.0-1, Apache-2.0, approved, CQ21949
 maven/mavencentral/com.github.virtuald/curvesapi/1.08, BSD-3-Clause AND Apache-2.0, approved, #23170

DEPENDENCIES_FRONTEND

@@ -29,7 +29,7 @@ npm/npmjs/-/inline-style-parser/0.1.1, MIT, approved, #2971
 npm/npmjs/-/is-arrayish/0.2.1, MIT, approved, clearlydefined
 npm/npmjs/-/is-buffer/2.0.5, MIT, approved, clearlydefined
 npm/npmjs/-/is-core-module/2.15.1, MIT, approved, clearlydefined
-npm/npmjs/-/is-number/7.0.0, MIT, approved, clearlydefined
+npm/npmjs/-/is-number/7.0.0, MIT, approved, #24836
 npm/npmjs/-/is-plain-obj/4.1.0, MIT, approved, clearlydefined
 npm/npmjs/-/js-sha256/0.11.0, MIT, approved, clearlydefined
 npm/npmjs/-/json-parse-even-better-errors/2.3.1, MIT, approved, clearlydefined
@@ -61,13 +61,13 @@ npm/npmjs/-/micromark-util-subtokenize/1.1.0, MIT, approved, clearlydefined
 npm/npmjs/-/micromark-util-symbol/1.1.0, MIT, approved, clearlydefined
 npm/npmjs/-/micromark-util-types/1.1.0, MIT, approved, clearlydefined
 npm/npmjs/-/micromark/3.2.0, MIT, approved, clearlydefined
-npm/npmjs/-/micromatch/4.0.8, MIT, approved, clearlydefined
+npm/npmjs/-/micromatch/4.0.8, MIT, approved, #24818
 npm/npmjs/-/minimatch/9.0.3, ISC, approved, #9190
 npm/npmjs/-/minimatch/9.0.5, ISC, approved, #9190
 npm/npmjs/-/mri/1.2.0, MIT, approved, clearlydefined
 npm/npmjs/-/parse-json/5.2.0, MIT, approved, clearlydefined
 npm/npmjs/-/path-parse/1.0.7, MIT, approved, clearlydefined
-npm/npmjs/-/picocolors/1.1.1, ISC, approved, clearlydefined
+npm/npmjs/-/picocolors/1.1.1, ISC, approved, #24873
 npm/npmjs/-/postcss/8.4.49, MIT, approved, #3545
 npm/npmjs/-/property-information/6.5.0, MIT, approved, clearlydefined
 npm/npmjs/-/querystringify/2.2.0, MIT, approved, clearlydefined
@@ -88,7 +88,7 @@ npm/npmjs/-/source-map/0.5.7, BSD-3-Clause, approved, #2400
 npm/npmjs/-/space-separated-tokens/2.0.2, MIT, approved, clearlydefined
 npm/npmjs/-/style-to-object/0.4.4, MIT, approved, #6637
 npm/npmjs/-/supports-preserve-symlinks-flag/1.0.0, MIT, approved, clearlydefined
-npm/npmjs/-/to-regex-range/5.0.1, MIT, approved, clearlydefined
+npm/npmjs/-/to-regex-range/5.0.1, MIT, approved, #24810
 npm/npmjs/-/trim-lines/3.0.1, MIT, approved, clearlydefined
 npm/npmjs/-/trough/2.2.0, MIT, approved, clearlydefined
 npm/npmjs/-/ts-api-utils/1.4.3, MIT, approved, #17411
@@ -106,7 +106,7 @@ npm/npmjs/-/vfile/5.3.7, MIT, approved, clearlydefined
 npm/npmjs/-/vite/5.4.11, MIT AND (ISC AND MIT) AND (Apache-2.0 AND BSD-2-Clause AND BlueOak-1.0.0 AND CC0-1.0 AND ISC AND MIT) AND (BSD-3-Clause AND MIT) AND ISC AND (BSD-2-Clause AND BSD-3-Clause), approved, #15844
 npm/npmjs/-/websocket-driver/0.7.4, Apache-2.0, approved, clearlydefined
 npm/npmjs/-/websocket-extensions/0.1.4, Apache-2.0, approved, CQ23021
-npm/npmjs/-/yaml/1.10.2, ISC, approved, clearlydefined
+npm/npmjs/-/yaml/1.10.2, ISC, approved, #24847
 npm/npmjs/@babel/runtime/7.24.0, MIT AND (BSD-2-Clause AND ISC AND MIT) AND BSD-2-Clause AND BSD-3-Clause, approved, #13900
 npm/npmjs/@catena-x/portal-shared-components/2.1.31, Apache-2.0 AND CC-BY-4.0, approved, #10502
 npm/npmjs/@emotion/babel-plugin/11.13.5, MIT AND (BSD-2-Clause AND MIT), approved, #17718

backend/pom.xml

@@ -33,7 +33,7 @@
     </parent>
     <groupId>org.eclipse.tractusx.puris</groupId>
     <artifactId>puris-backend</artifactId>
-    <version>4.1.1</version>
+    <version>5.0.0</version>
     <name>puris-backend</name>
     <description>PURIS Backend</description>
     <properties>

backend/src/main/java/org/eclipse/tractusx/puris/backend/masterdata/controller/MaterialController.java

@@ -21,29 +21,41 @@
  */
 package org.eclipse.tractusx.puris.backend.masterdata.controller;
 
-import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.media.Content;
-import io.swagger.v3.oas.annotations.responses.ApiResponse;
-import io.swagger.v3.oas.annotations.responses.ApiResponses;
-import jakarta.validation.Validator;
-import lombok.extern.slf4j.Slf4j;
+import java.util.Base64;
+import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+import javax.management.openmbean.KeyAlreadyExistsException;
+
 import org.eclipse.tractusx.puris.backend.common.util.PatternStore;
 import org.eclipse.tractusx.puris.backend.masterdata.domain.model.Material;
 import org.eclipse.tractusx.puris.backend.masterdata.logic.dto.MaterialEntityDto;
 import org.eclipse.tractusx.puris.backend.masterdata.logic.service.MaterialRefreshService;
 import org.eclipse.tractusx.puris.backend.masterdata.logic.service.MaterialService;
 import org.modelmapper.ModelMapper;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatusCode;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
-import org.springframework.web.bind.annotation.*;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.server.ResponseStatusException;
 
-import java.util.Base64;
-import java.util.List;
-import java.util.regex.Pattern;
-import java.util.stream.Collectors;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import jakarta.validation.Validator;
+import lombok.extern.slf4j.Slf4j;
 
 @RestController
 @RequestMapping("materials")
@@ -71,31 +83,32 @@ public class MaterialController {
         @ApiResponse(responseCode = "409", description = "Material with the given ownMaterialNumber already exists."),
         @ApiResponse(responseCode = "500", description = "Internal Server error.")
     })
-    public ResponseEntity<?> createMaterial(@RequestBody MaterialEntityDto materialDto) {
+    public MaterialEntityDto createMaterial(@RequestBody MaterialEntityDto materialDto) {
         if(!validator.validate(materialDto).isEmpty()) {
             log.warn("Rejected invalid message body.");
-            return ResponseEntity.status(400).build();
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Material is invalid.");
         }
         if (materialDto.getOwnMaterialNumber() == null || materialDto.getOwnMaterialNumber().isEmpty()) {
             // Cannot create material without ownMaterialNumber
-            return new ResponseEntity<>(HttpStatusCode.valueOf(400));
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Material information misses material identification.");
         }
         if (materialService.findByOwnMaterialNumber(materialDto.getOwnMaterialNumber()) != null) {
             // Cannot create material, ownMaterialNumber is already assigned
-            return new ResponseEntity<>(HttpStatusCode.valueOf(409));
+            throw new ResponseStatusException(HttpStatus.CONFLICT, "Material already exists. Use PUT instead.");
         }
         Material createdMaterial;
         try {
-            createdMaterial = modelMapper.map(materialDto, Material.class);
-        } catch (Exception e) {
-            return new ResponseEntity<>(HttpStatusCode.valueOf(400));
+            Material entity = modelMapper.map(materialDto, Material.class);
+            createdMaterial = materialService.create(entity);
+        } catch (KeyAlreadyExistsException e) {
+            throw new ResponseStatusException(HttpStatus.CONFLICT, "Material already exists. Use PUT instead.");
+        } catch (IllegalArgumentException e) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Material is invalid.");
+        } catch (IllegalStateException e) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, e.getMessage());
         }
 
-        createdMaterial = materialService.create(createdMaterial);
-        if (createdMaterial == null) {
-            return new ResponseEntity<>(HttpStatusCode.valueOf(500));
-        }
-        return new ResponseEntity<>(HttpStatusCode.valueOf(200));
+        return modelMapper.map(createdMaterial, MaterialEntityDto.class);
     }
 
     @PreAuthorize("hasRole('PURIS_ADMIN')")
@@ -107,32 +120,29 @@ public ResponseEntity<?> createMaterial(@RequestBody MaterialEntityDto materialD
         @ApiResponse(responseCode = "404", description = "No existing Material Entity found, no update was performed."),
         @ApiResponse(responseCode = "500", description = "Internal Server Error.")
     })
-    public ResponseEntity<?> updateMaterial(@RequestBody MaterialEntityDto materialDto) {
+    public MaterialEntityDto updateMaterial(@RequestBody MaterialEntityDto materialDto) {
         if(!validator.validate(materialDto).isEmpty()) {
             log.warn("Rejected invalid message body.");
-            return ResponseEntity.status(400).build();
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Material is invalid.");
         }
         if (materialDto.getOwnMaterialNumber() == null || materialDto.getOwnMaterialNumber().isEmpty()) {
             // Cannot update material without ownMaterialNumber
-            return new ResponseEntity<>(HttpStatusCode.valueOf(400));
-        }
-        Material existingMaterial = materialService.findByOwnMaterialNumber(materialDto.getOwnMaterialNumber());
-        if (existingMaterial == null) {
-            // Cannot update non-existent Material
-            return new ResponseEntity<>(HttpStatusCode.valueOf(404));
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Material information misses material identification.");
         }
         Material updatedMaterial;
         try {
-            updatedMaterial = modelMapper.map(materialDto, Material.class);
+            Material entity = modelMapper.map(materialDto, Material.class);
+            updatedMaterial = materialService.update(entity);
+        } catch (NoSuchElementException e) {
+            throw new ResponseStatusException(HttpStatus.NOT_FOUND, e.getMessage());
+        } catch (IllegalArgumentException e) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, e.getMessage());
         } catch (Exception e) {
-            return new ResponseEntity<>(HttpStatusCode.valueOf(400));
-        }
-        updatedMaterial = materialService.update(updatedMaterial);
-        if (updatedMaterial == null) {
-            return new ResponseEntity<>(HttpStatusCode.valueOf(500));
+            log.error("Unexpected error while updating material", e);
+            throw new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, "Internal Server Error");
         }
 
-        return new ResponseEntity<>(HttpStatusCode.valueOf(200));
+        return modelMapper.map(updatedMaterial, MaterialEntityDto.class);
     }
 
     @GetMapping