feat: refactoring rest-api (#53)

* feat: refactoring rest-api * tests: sonar issues
onecx · Jul 23, 2024 · 577fc8e · 577fc8e
1 parent 7d1d3b2
commit 577fc8e
Show file tree

Hide file tree

Showing 19 changed files with 329 additions and 227 deletions.
diff --git a/docs/modules/onecx-help-svc/pages/index.adoc b/docs/modules/onecx-help-svc/pages/index.adoc
@@ -4,5 +4,7 @@ include::onecx-help-svc-attributes.adoc[opts=optional]
 
 include::docs.adoc[opts=optional]
 
+=== Configuration
+include::onecx-help-svc.adoc[opts=optional]
 
 include::onecx-help-svc-docs.adoc[opts=optional]
diff --git a/docs/modules/onecx-help-svc/pages/onecx-help-svc-extensions.adoc b/docs/modules/onecx-help-svc/pages/onecx-help-svc-extensions.adoc
@@ -12,13 +12,13 @@ h| Version
 
 | https://onecx.github.io/docs/onecx-quarkus/current/onecx-quarkus/onecx-core.html[Link]
 | 
-| 0.22.0
+| 0.24.0
 
 | onecx-tenant
 
 | https://onecx.github.io/docs/onecx-quarkus/current/onecx-quarkus/onecx-tenant.html[Link]
-| https://github.com/onecx/onecx-quarkus/blob/0.22.0/docs/modules/onecx-quarkus/pages/includes/onecx-tenant.adoc[Link]
-| 0.22.0
+| https://github.com/onecx/onecx-quarkus/blob/0.24.0/docs/modules/onecx-quarkus/pages/includes/onecx-tenant.adoc[Link]
+| 0.24.0
 
 | quarkus-oidc
 
@@ -29,50 +29,50 @@ h| Version
 | tkit-quarkus-rest-context
 
 | https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-rest-context.html[Link]
-| https://github.com/1000kit/tkit-quarkus/blob/2.27.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-rest-context.adoc[Link]
-| 2.27.0
+| https://github.com/1000kit/tkit-quarkus/blob/2.28.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-rest-context.adoc[Link]
+| 2.28.0
 
 | tkit-quarkus-jpa-tenant
 
 | https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-jpa-tenant.html[Link]
-| https://github.com/1000kit/tkit-quarkus/blob/2.27.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-jpa-tenant.adoc[Link]
-| 2.27.0
+| https://github.com/1000kit/tkit-quarkus/blob/2.28.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-jpa-tenant.adoc[Link]
+| 2.28.0
 
 | tkit-quarkus-data-import
 
 | https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-data-import.html[Link]
-| https://github.com/1000kit/tkit-quarkus/blob/2.27.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-data-import.adoc[Link]
-| 2.27.0
+| https://github.com/1000kit/tkit-quarkus/blob/2.28.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-data-import.adoc[Link]
+| 2.28.0
 
 | tkit-quarkus-jpa
 
 | https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-jpa.html[Link]
-| https://github.com/1000kit/tkit-quarkus/blob/2.27.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-jpa.adoc[Link]
-| 2.27.0
+| https://github.com/1000kit/tkit-quarkus/blob/2.28.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-jpa.adoc[Link]
+| 2.28.0
 
 | tkit-quarkus-log-cdi
 
 | https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-cdi.html[Link]
-| https://github.com/1000kit/tkit-quarkus/blob/2.27.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-cdi.adoc[Link]
-| 2.27.0
+| https://github.com/1000kit/tkit-quarkus/blob/2.28.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-cdi.adoc[Link]
+| 2.28.0
 
 | tkit-quarkus-log-rs
 
 | https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-rs.html[Link]
-| https://github.com/1000kit/tkit-quarkus/blob/2.27.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-rs.adoc[Link]
-| 2.27.0
+| https://github.com/1000kit/tkit-quarkus/blob/2.28.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-rs.adoc[Link]
+| 2.28.0
 
 | tkit-quarkus-log-json
 
 | https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-json.html[Link]
-| https://github.com/1000kit/tkit-quarkus/blob/2.27.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-json.adoc[Link]
-| 2.27.0
+| https://github.com/1000kit/tkit-quarkus/blob/2.28.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-json.adoc[Link]
+| 2.28.0
 
 | tkit-quarkus-rest
 
 | https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-rest.html[Link]
-| https://github.com/1000kit/tkit-quarkus/blob/2.27.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-rest.adoc[Link]
-| 2.27.0
+| https://github.com/1000kit/tkit-quarkus/blob/2.28.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-rest.adoc[Link]
+| 2.28.0
 
 | quarkus-arc
 
@@ -143,8 +143,8 @@ h| Version
 | tkit-quarkus-security
 
 | https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-security.html[Link]
-| https://github.com/1000kit/tkit-quarkus/blob/2.27.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-security.adoc[Link]
-| 2.27.0
+| https://github.com/1000kit/tkit-quarkus/blob/2.28.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-security.adoc[Link]
+| 2.28.0
 
 | quarkus-container-image-docker
 
@@ -157,7 +157,7 @@ h| Version
 
 | 
 | 
-| 0.22.0
+| 0.24.0
 
 | quarkus-smallrye-context-propagation
 

diff --git a/docs/modules/onecx-help-svc/pages/onecx-help-svc.adoc b/docs/modules/onecx-help-svc/pages/onecx-help-svc.adoc
@@ -0,0 +1,63 @@
+
+:summaryTableId: onecx-help-svc
+[.configuration-legend]
+icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
+[.configuration-reference.searchable, cols="80,.^10,.^10"]
+|===
+
+h|[[onecx-help-svc_configuration]]link:#onecx-help-svc_configuration[Configuration property]
+
+h|Type
+h|Default
+
+a| [[onecx-help-svc_onecx-help-default-enabled]]`link:#onecx-help-svc_onecx-help-default-enabled[onecx.help.default.enabled]`
+
+
+[.description]
+--
+Enable or disable default help
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++ONECX_HELP_DEFAULT_ENABLED+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++ONECX_HELP_DEFAULT_ENABLED+++`
+endif::add-copy-button-to-env-var[]
+--|boolean 
+|`false`
+
+
+a| [[onecx-help-svc_onecx-help-default-url]]`link:#onecx-help-svc_onecx-help-default-url[onecx.help.default.url]`
+
+
+[.description]
+--
+Default help URL
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++ONECX_HELP_DEFAULT_URL+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++ONECX_HELP_DEFAULT_URL+++`
+endif::add-copy-button-to-env-var[]
+--|string 
+|`https://github.com/onecx`
+
+
+a| [[onecx-help-svc_onecx-help-product-item-id]]`link:#onecx-help-svc_onecx-help-product-item-id[onecx.help.product-item-id]`
+
+
+[.description]
+--
+Default help URL
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++ONECX_HELP_PRODUCT_ITEM_ID+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++ONECX_HELP_PRODUCT_ITEM_ID+++`
+endif::add-copy-button-to-env-var[]
+--|string 
+|`PRODUCT_BASE_DOC_URL`
+
+|===
diff --git a/pom.xml b/pom.xml
@@ -220,18 +220,6 @@
                             <modelNameSuffix>DTO</modelNameSuffix>
                         </configuration>
                     </execution>
-                    <execution>
-                        <id>v1</id>
-                        <goals>
-                            <goal>generate</goal>
-                        </goals>
-                        <configuration>
-                            <inputSpec>src/main/openapi/onecx-help-v1-openapi.yaml</inputSpec>
-                            <apiPackage>gen.org.tkit.onecx.help.rs.v1</apiPackage>
-                            <modelPackage>gen.org.tkit.onecx.help.rs.v1.model</modelPackage>
-                            <modelNameSuffix>DTOV1</modelNameSuffix>
-                        </configuration>
-                    </execution>
                     <execution>
                         <id>di-help-v1</id>
                         <goals>

diff --git a/src/main/java/org/tkit/onecx/help/domain/config/HelpConfig.java b/src/main/java/org/tkit/onecx/help/domain/config/HelpConfig.java
@@ -0,0 +1,35 @@
+package org.tkit.onecx.help.domain.config;
+
+import io.quarkus.runtime.annotations.ConfigDocFilename;
+import io.quarkus.runtime.annotations.ConfigPhase;
+import io.quarkus.runtime.annotations.ConfigRoot;
+import io.smallrye.config.ConfigMapping;
+import io.smallrye.config.WithDefault;
+import io.smallrye.config.WithName;
+
+@ConfigDocFilename("onecx-help-svc.adoc")
+@ConfigRoot(phase = ConfigPhase.RUN_TIME)
+@ConfigMapping(prefix = "onecx.help")
+public interface HelpConfig {
+
+    /**
+     * Enable or disable default help
+     */
+    @WithName("default.enabled")
+    @WithDefault("false")
+    boolean defaultHelpEnabled();
+
+    /**
+     * Default help URL
+     */
+    @WithName("default.url")
+    @WithDefault("https://github.com/onecx")
+    String defaultHelpUrl();
+
+    /**
+     * Default help URL
+     */
+    @WithName("product-item-id")
+    @WithDefault("PRODUCT_BASE_DOC_URL")
+    String productItemId();
+}
diff --git a/src/main/java/org/tkit/onecx/help/rs/internal/controllers/HelpsRestController.java b/src/main/java/org/tkit/onecx/help/rs/internal/controllers/HelpsRestController.java
@@ -13,6 +13,7 @@
 
 import org.jboss.resteasy.reactive.RestResponse;
 import org.jboss.resteasy.reactive.server.ServerExceptionMapper;
+import org.tkit.onecx.help.domain.config.HelpConfig;
 import org.tkit.onecx.help.domain.daos.HelpDAO;
 import org.tkit.onecx.help.rs.internal.mappers.ExceptionMapper;
 import org.tkit.onecx.help.rs.internal.mappers.HelpMapper;
@@ -41,6 +42,9 @@ public class HelpsRestController implements HelpsInternalApi {
     @Context
     UriInfo uriInfo;
 
+    @Inject
+    HelpConfig config;
+
     @Override
     @Transactional
     public Response createNewHelp(CreateHelpDTO createHelpDTO) {
@@ -96,6 +100,25 @@ public Response updateHelp(String id, UpdateHelpDTO updateHelpDTO) {
         return Response.noContent().build();
     }
 
+    @Override
+    public Response getHelpByProductNameItemId(String productName, String helpItemId) {
+        var help = dao.findByProductNameAndItemId(productName, helpItemId);
+        if (help != null) {
+            return Response.ok(mapper.map(help)).build();
+        }
+
+        help = dao.findByProductNameAndItemId(productName, config.productItemId());
+        if (help != null) {
+            return Response.ok(mapper.map(help)).build();
+        }
+
+        if (config.defaultHelpEnabled()) {
+            return Response.ok(mapper.createDefault(productName, helpItemId, config.defaultHelpUrl())).build();
+        }
+
+        return Response.status(Response.Status.NOT_FOUND).build();
+    }
+
     @ServerExceptionMapper
     public RestResponse<ProblemDetailResponseDTO> exception(ConstraintException ex) {
         return exceptionMapper.exception(ex);

diff --git a/src/main/java/org/tkit/onecx/help/rs/internal/mappers/HelpMapper.java b/src/main/java/org/tkit/onecx/help/rs/internal/mappers/HelpMapper.java
@@ -36,6 +36,16 @@ public interface HelpMapper {
 
     HelpDTO map(Help help);
 
+    @Mapping(target = "id", ignore = true)
+    @Mapping(target = "creationDate", ignore = true)
+    @Mapping(target = "creationUser", ignore = true)
+    @Mapping(target = "modificationDate", ignore = true)
+    @Mapping(target = "modificationUser", ignore = true)
+    @Mapping(target = "modificationCount", ignore = true)
+    @Mapping(target = "context", ignore = true)
+    @Mapping(target = "resourceUrl", ignore = true)
+    HelpDTO createDefault(String productName, String itemId, String baseUrl);
+
     @Mapping(target = "id", ignore = true)
     @Mapping(target = "creationDate", ignore = true)
     @Mapping(target = "creationUser", ignore = true)

diff --git a/src/main/java/org/tkit/onecx/help/rs/v1/controllers/HelpsV1RestController.java b/src/main/java/org/tkit/onecx/help/rs/v1/controllers/HelpsV1RestController.java
diff --git a/src/main/java/org/tkit/onecx/help/rs/v1/mappers/ExternalV1Mapper.java b/src/main/java/org/tkit/onecx/help/rs/v1/mappers/ExternalV1Mapper.java
diff --git a/src/main/openapi/onecx-help-internal-openapi.yaml b/src/main/openapi/onecx-help-internal-openapi.yaml
@@ -8,6 +8,36 @@ servers:
 tags:
   - name: helpsInternal
 paths:
+  /internal/helps/{productName}/{helpItemId}:
+    get:
+      security:
+        - oauth2: [ ocx-hp:all, ocx-hp:read ]
+      tags:
+        - helpsInternal
+      description: search help item by product name and item id
+      operationId: getHelpByProductNameItemId
+      parameters:
+        - name: productName
+          in: path
+          required: true
+          description: product name
+          schema:
+            type: string
+        - name: helpItemId
+          in: path
+          required: true
+          description: help item ID
+          schema:
+            type: string
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Help'
+        404:
+          description: Help not found
   /internal/helps:
     post:
       security: