Merge 690aadf into 2bca5ad

ivan-risueno · web-flow · commit 4c22546947fc · 2026-06-17T09:18:23.000+02:00
diff --git a/openapi/openapi-component_catalog-v1.0.0.yaml b/openapi/openapi-component_catalog-v1.0.0.yaml
@@ -35,6 +35,56 @@ tags:
   - name: ProvisionerActions
     description: Provisioning notifications from AWX/Provisioner
 paths:
+  /project/components:
+    get:
+      operationId: getAllProjectComponents
+      parameters:
+        - name: page
+          in: query
+          description: Page number (from 0 until limit)
+          required: false
+          schema:
+            type: integer
+            default: 0
+
+        - name: size
+          in: query
+          description: Page size
+          required: false
+          schema:
+            type: integer
+            default: 20
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ProjectComponentListResponse"
+          description: A paginated list of all the provisioned project components
+        "401":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RestErrorMessage"
+          description: Invalid client token on the request.
+        "403":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RestErrorMessage"
+          description: Insufficient permissions for the client to access the resource.
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RestErrorMessage"
+          description: Server error.
+      summary: Returns the information of the project's components in the Bitbucket
+        repository.
+      tags:
+        - Project-components
+      x-accepts:
+        - application/json
   /project/{projectKey}/components:
     get:
       tags:
@@ -1350,3 +1400,111 @@ components:
                 example:
                   - "production"
                   - "staging"
+
+    ProjectComponentListItem:
+      type: object
+      example:
+        projectKey: SOMEPROJECT
+        componentId: any-component-id-from-backend
+        caller: some-person@email.com
+        catalogItemSlug: some_technology-name
+        createdAt: 1707043200000
+        updatedAt: 1707043200000
+      properties:
+        projectKey:
+          description: The projectKey which the component is provisioned for.
+          example: SOMEPROJECT
+          type: string
+        componentId:
+          description: The componentId set by the user.
+          example: any-component-id-from-backend
+          minLength: 1
+          pattern: ^(?!\s*$).+
+          type: string
+        caller:
+          description: The email of who provisioned the component.
+          example: some-person@email.com
+          type: string
+        catalogItemSlug:
+          description: The provisioned catalog item slug.
+          example: some_technology-name
+          type: string
+        createdAt:
+          description: The timestamp of the provision action.
+          example: 1707043200000
+          type: number
+        updatedAt:
+          description: The timestamp of the last change of the provisioned component.
+          example: 1707043200000
+          type: number
+
+    Pagination:
+      type: object
+      example:
+        page: 0
+        size: 20
+        totalElements: 117
+        totalPages: 6
+        next: "https://api.example.com/resources?page=1&size=20"
+        previous: null
+      properties:
+        page:
+          type: integer
+          example: 0
+          description: Current page of the response.
+        size:
+          type: integer
+          example: 20
+          description: Current page size of the response.
+        totalElements:
+          type: integer
+          format: integer
+          example: 117
+          description: Total number of elements.
+        totalPages:
+          type: integer
+          example: 6
+          description: Total number of pages of this exact size.
+        next:
+          type: string
+          format: uri
+          nullable: true
+          example: "https://api.example.com/resources?page=1&size=20"
+          description: URL of the next page (or null if the current is the last one)
+        previous:
+          type: string
+          format: uri
+          nullable: true
+          example: "https://api.example.com/resources?page=0&size=20"
+          description: URL of the previous page (or null if the current is the first one)
+
+    ProjectComponentListResponse:
+      type: object
+      example:
+        data:
+          - projectKey: SOMEPROJECT
+            componentId: any-component-id-from-backend
+            caller: some-person@email.com
+            catalogItemSlug: some_technology-name
+            createdAt: 1707043200000
+            updatedAt: 1707043200000
+          - projectKey: ANOTHERPROJECT
+            componentId: another-component-id-from-backend
+            caller: some-person2@email.com
+            catalogItemSlug: another_technology-name
+            createdAt: 1707043200001
+            updatedAt: 1707043200002
+        pagination:
+          page: 0
+          size: 20
+          totalElements: 117
+          totalPages: 6
+          next: https://api.example.com/resources?page=1&size=20
+          previous: null
+      properties:
+        data:
+          type: array
+          items:
+            $ref: '#/components/schemas/ProjectComponentListItem'
+        pagination:
+          $ref: '#/components/schemas/Pagination'
diff --git a/openapi/openapi-component_provisioner-v1.0.0.yaml b/openapi/openapi-component_provisioner-v1.0.0.yaml
@@ -667,7 +667,7 @@ components:
           example: 1707043200000
           type: number
         updatedAt:
-          description: The timestamp of the last change of the catalog item.
+          description: The timestamp of the last change of the provisioned component.
           example: 1707043200000
           type: number
     Pagination:
diff --git a/src/main/java/org/opendevstack/component_provisioner/config/ApplicationPropertiesConfiguration.java b/src/main/java/org/opendevstack/component_provisioner/config/ApplicationPropertiesConfiguration.java
@@ -118,6 +118,7 @@ public static class ComponentCatalogServiceProps {
     @Data
     public static class OdsApiServerServiceProps {
         private URL baseRestUrl;
+        private String oid;
     }
 
     @Builder // useful for unit testing
diff --git a/src/main/java/org/opendevstack/component_provisioner/server/controllers/ProjectComponentsApiController.java b/src/main/java/org/opendevstack/component_provisioner/server/controllers/ProjectComponentsApiController.java
@@ -1,24 +1,14 @@
 package org.opendevstack.component_provisioner.server.controllers;
 
 import lombok.AllArgsConstructor;
-import lombok.Generated;
 import lombok.extern.slf4j.Slf4j;
 import org.opendevstack.component_provisioner.server.api.ProjectComponentsWithProvisionStatusApi;
 import org.opendevstack.component_provisioner.server.facade.ProjectComponentsApiFacade;
-import org.opendevstack.component_provisioner.server.model.Pagination;
-import org.opendevstack.component_provisioner.server.model.ProjectComponentListItem;
 import org.opendevstack.component_provisioner.server.model.ProjectComponentListResponse;
 import org.opendevstack.component_provisioner.server.model.ProjectComponentProvisionStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
-
-import java.math.BigDecimal;
-import java.net.URI;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Optional;
 
 @Controller
 @RequestMapping("${openapi.componentProvisionerREST.base-path:/v1}")
@@ -41,65 +31,12 @@ public ResponseEntity<ProjectComponentProvisionStatus> getProjectComponentProvis
         return ResponseEntity.ok(projectComponentExtendedInfo);
     }
 
-    // MOCKED RESULT
-    @Generated
     @Override
     public ResponseEntity<ProjectComponentListResponse> getAllProjectComponents(Integer page, Integer size) {
         log.debug("getAllProjectComponents with page {} and page size of {}", page, size);
 
-        int currentPage = Optional.ofNullable(page).orElse(0);
-        int pageSize = Optional.ofNullable(size).orElse(20);
-
-        int totalElements = 40;
-
-        List<ProjectComponentListItem> allItems = new ArrayList<>();
-
-        for (int i = 0; i < totalElements; i++) {
-            allItems.add(ProjectComponentListItem.builder()
-                    .projectKey("PROJECT_" + i)
-                    .componentId("component-" + i)
-                    .caller("user" + i + "@email.com")
-                    .catalogItemSlug("tech-" + i)
-                    .createdAt(BigDecimal.valueOf(1707043200000L + i))
-                    .updatedAt(BigDecimal.valueOf(1707043200000L + i))
-                    .build());
-        }
-
-        int fromIndex = Math.min(currentPage * pageSize, totalElements);
-        int toIndex = Math.min(fromIndex + pageSize, totalElements);
-
-        List<ProjectComponentListItem> pageItems = allItems.subList(fromIndex, toIndex);
-
-        int totalPages = (int) Math.ceil((double) totalElements / pageSize);
-
-        String next = currentPage < totalPages - 1
-                ? ServletUriComponentsBuilder.fromCurrentRequest()
-                  .replaceQueryParam("page", currentPage + 1)
-                  .replaceQueryParam("size", pageSize)
-                  .toUriString()
-                : null;
-
-        String previous = currentPage > 0
-                ? ServletUriComponentsBuilder.fromCurrentRequest()
-                  .replaceQueryParam("page", currentPage - 1)
-                  .replaceQueryParam("size", pageSize)
-                  .toUriString()
-                : null;
-
-        Pagination pagination = Pagination.builder()
-                .page(currentPage)
-                .size(pageSize)
-                .totalElements(totalElements)
-                .totalPages(totalPages)
-                .next(next != null ? URI.create(next) : null)
-                .previous(previous != null ? URI.create(previous) : null)
-                .build();
-
-        ProjectComponentListResponse response = ProjectComponentListResponse.builder()
-                .data(pageItems)
-                .pagination(pagination)
-                .build();
+        var paginatedProjectComponents = projectComponentsApiFacade.getPaginatedProjectComponents(page, size);
 
-        return ResponseEntity.ok(response);
+        return ResponseEntity.ok(paginatedProjectComponents);
     }
 }
diff --git a/src/main/java/org/opendevstack/component_provisioner/server/facade/ProjectComponentsApiFacade.java b/src/main/java/org/opendevstack/component_provisioner/server/facade/ProjectComponentsApiFacade.java
@@ -4,12 +4,18 @@
 import lombok.extern.slf4j.Slf4j;
 import org.opendevstack.component_provisioner.client.awx.v2.model.JobDetail;
 import org.opendevstack.component_provisioner.client.component_catalog.v1.model.ProjectComponentExtendedInfo;
+import org.opendevstack.component_provisioner.config.ApplicationPropertiesConfiguration.OdsApiServerServiceProps;
 import org.opendevstack.component_provisioner.server.controllers.exceptions.InvalidRestEntityException;
+import org.opendevstack.component_provisioner.server.controllers.exceptions.UserNotAllowedException;
 import org.opendevstack.component_provisioner.server.mappers.EntitiesMapper;
+import org.opendevstack.component_provisioner.server.mappers.ProjectComponentListResponseMapper;
+import org.opendevstack.component_provisioner.server.model.ProjectComponentListResponse;
 import org.opendevstack.component_provisioner.server.model.ProjectComponentProvisionStatus;
+import org.opendevstack.component_provisioner.server.services.ApplicationAuthenticationProvider;
 import org.opendevstack.component_provisioner.server.services.AuthenticationProvider;
 import org.opendevstack.component_provisioner.server.services.AwxService;
 import org.opendevstack.component_provisioner.server.services.ComponentCatalogService;
+import org.opendevstack.component_provisioner.util.JwtUtils;
 import org.springframework.stereotype.Service;
 
 @Service
@@ -21,6 +27,9 @@ public class ProjectComponentsApiFacade {
     private final ComponentCatalogService componentCatalogService;
     private final AwxService awxService;
     private final EntitiesMapper entitiesMapper;
+    private final OdsApiServerServiceProps odsApiServerServiceProps;
+    private final ApplicationAuthenticationProvider applicationAuthenticationProvider;
+    private final ProjectComponentListResponseMapper projectComponentListResponseMapper;
 
     public ProjectComponentExtendedInfo getProjectComponentById(String projectKey, String componentId) {
         var accessToken = authenticationProvider.getAccessToken();
@@ -48,4 +57,21 @@ public ProjectComponentProvisionStatus enrichWithAapInfo(String projectKey, Proj
 
         return provisionStatus;
     }
+
+    public ProjectComponentListResponse getPaginatedProjectComponents(Integer page, Integer size) {
+        String accessToken = authenticationProvider.getAccessToken();
+        if (!validateTokenBelongsToOdsApiService(accessToken)) {
+            throw new UserNotAllowedException("Invalid caller. Please, provide a valid token within the request.");
+        }
+
+        String marketplaceAccessToken = applicationAuthenticationProvider.getAccessToken();
+
+        var response = componentCatalogService.getPaginatedProjectComponents(marketplaceAccessToken, page, size);
+        return projectComponentListResponseMapper.map(response);
+    }
+
+    private boolean validateTokenBelongsToOdsApiService(String accessToken) {
+        var oid = JwtUtils.extractClaim(accessToken, "oid");
+        return oid.map(odsApiServerServiceProps.getOid()::equals).orElse(false);
+    }
 }
diff --git a/src/main/java/org/opendevstack/component_provisioner/server/mappers/ProjectComponentListResponseMapper.java b/src/main/java/org/opendevstack/component_provisioner/server/mappers/ProjectComponentListResponseMapper.java
@@ -0,0 +1,34 @@
+package org.opendevstack.component_provisioner.server.mappers;
+
+import org.mapstruct.Mapper;
+import org.openapitools.jackson.nullable.JsonNullable;
+import org.opendevstack.component_provisioner.server.model.Pagination;
+import org.opendevstack.component_provisioner.server.model.ProjectComponentListItem;
+import org.opendevstack.component_provisioner.server.model.ProjectComponentListResponse;
+
+import java.net.URI;
+import java.util.List;
+
+@Mapper(componentModel = "spring")
+public interface ProjectComponentListResponseMapper {
+
+    ProjectComponentListResponse map(
+            org.opendevstack.component_provisioner.client.component_catalog.v1.model.ProjectComponentListResponse source
+    );
+
+    List<ProjectComponentListItem> mapItems(
+            List<org.opendevstack.component_provisioner.client.component_catalog.v1.model.ProjectComponentListItem> source
+    );
+
+    ProjectComponentListItem mapItem(
+            org.opendevstack.component_provisioner.client.component_catalog.v1.model.ProjectComponentListItem source
+    );
+
+    Pagination mapPagination(
+            org.opendevstack.component_provisioner.client.component_catalog.v1.model.Pagination source
+    );
+
+    default JsonNullable<URI> map(URI value) {
+        return JsonNullable.of(value);
+    }
+}
diff --git a/src/main/java/org/opendevstack/component_provisioner/server/services/ComponentCatalogService.java b/src/main/java/org/opendevstack/component_provisioner/server/services/ComponentCatalogService.java
@@ -227,4 +227,10 @@ private Pair<HttpStatusCode, Optional<CatalogItemUserActionMessageDefinition>> g
             throw new CatalogClientException(e);
         }
     }
+
+    public ProjectComponentListResponse getPaginatedProjectComponents(String accessToken, Integer page, Integer size) {
+        var apiClient = apiClientsBuilder.componentCatalogApiClient(accessToken, componentCatalogServiceProps.getBaseRestUrl().toString());
+        var componentsApi = apiClientsBuilder.projectComponentsApi(apiClient);
+        return componentsApi.getAllProjectComponents(page, size);
+    }
 }
diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
@@ -82,6 +82,7 @@ component-provisioner:
     enabled: ${ODS_API_SERVICE_ENABLED}
     service:
       base-rest-url: ${ODS_API_SERVICE_SERVICE_BASE_REST_URL}
+      oid: ${ODS_API_SERVICE_OID}
     params:
       client_id: ${DEVSTACK_MARKETPLACE_API_CLIENT_ID}
       client_secret: ${DEVSTACK_MARKETPLACE_API_CLIENT_SECRET}
diff --git a/src/test/java/org/opendevstack/component_provisioner/server/controllers/ProjectComponentsApiControllerTest.java b/src/test/java/org/opendevstack/component_provisioner/server/controllers/ProjectComponentsApiControllerTest.java
diff --git a/src/test/java/org/opendevstack/component_provisioner/server/facade/ProjectComponentsApiFacadeTest.java b/src/test/java/org/opendevstack/component_provisioner/server/facade/ProjectComponentsApiFacadeTest.java
diff --git a/src/test/java/org/opendevstack/component_provisioner/server/services/ComponentCatalogServiceTest.java b/src/test/java/org/opendevstack/component_provisioner/server/services/ComponentCatalogServiceTest.java

Original file line number	Diff line number	Diff line change
`@@ -118,6 +118,7 @@ public static class ComponentCatalogServiceProps {`
`118`	`118`	`@Data`
`119`	`119`	`public static class OdsApiServerServiceProps {`
`120`	`120`	`private URL baseRestUrl;`
	`121`	`+ private String oid;`
`121`	`122`	`}`
`122`	`123`
`123`	`124`	`@Builder // useful for unit testing`
Original file line number	Diff line number	Diff line change
`@@ -227,4 +227,10 @@ private Pair<HttpStatusCode, Optional<CatalogItemUserActionMessageDefinition>> g`
`227`	`227`	`throw new CatalogClientException(e);`
`228`	`228`	`}`
`229`	`229`	`}`
	`230`	`+`
	`231`	`+ public ProjectComponentListResponse getPaginatedProjectComponents(String accessToken, Integer page, Integer size) {`
	`232`	`+ var apiClient = apiClientsBuilder.componentCatalogApiClient(accessToken, componentCatalogServiceProps.getBaseRestUrl().toString());`
	`233`	`+ var componentsApi = apiClientsBuilder.projectComponentsApi(apiClient);`
	`234`	`+ return componentsApi.getAllProjectComponents(page, size);`
	`235`	`+ }`
`230`	`236`	`}`