@sap-ux/axios-extension 1.22.3 → 1.22.4

package/dist/abap/catalog/base.d.ts

@@ -40,13 +40,20 @@ export declare abstract class CatalogService extends ODataService {
     entitySet: string;
     services: ODataServiceInfo[];
     isS4Cloud: Promise<boolean>;
-    protected abstract fetchServices(): Promise<ODataServiceInfo[]>;
+    /**
+     * Fetch all services from the backend.
+     *
+     * @param useNextLink if true, the next link will be used to fetch the next page of results, pages are fetched serially.
+     */
+    protected abstract fetchServices(useNextLink?: boolean): Promise<ODataServiceInfo[]>;
     /**
      * Returns list of services from the catalog service.
      *
+     * @param useNextLink if true, the next link tags will be used to fetch the next page of results, pages are fetched serially.
+     * Note that this will be less performant for larger datasets.
      * @returns list of services
      */
-    listServices(): Promise<ODataServiceInfo[]>;
+    listServices(useNextLink?: boolean): Promise<ODataServiceInfo[]>;
     abstract getAnnotations({ id, title, path }: FilterOptions): Promise<Annotations[]>;
     abstract getServiceType(path: string): Promise<ServiceType | undefined>;
 }

package/dist/abap/catalog/base.js

@@ -18,11 +18,13 @@ class CatalogService extends odata_service_1.ODataService {
     /**
      * Returns list of services from the catalog service.
      *
+     * @param useNextLink if true, the next link tags will be used to fetch the next page of results, pages are fetched serially.
+     * Note that this will be less performant for larger datasets.
      * @returns list of services
      */
-    async listServices() {
+    async listServices(useNextLink = false) {
         if (!this.services) {
-            this.services = await this.fetchServices();
+            this.services = await this.fetchServices(useNextLink);
         }
         return this.services;
     }

package/dist/abap/catalog/v4-catalog-service.d.ts

@@ -25,21 +25,37 @@ export interface ServiceGroup {
  * OData V4 specific implmentation of SAP's catalog service
  */
 export declare class V4CatalogService extends CatalogService {
+    private readonly logger;
     static readonly PATH = "/sap/opu/odata4/iwfnd/config/default/iwfnd/catalog/0002";
     /**
      * Map the V4 service information to a version independent structure.
      *
      * @param groups v4 service groups
-     * @param entitySet entity set used for service selection
+     * @param entitySet entity set used for service selection. e.g. `RecommendedServices`
+     * @param dedup if true, duplicate services will be removed based on their id. Duplicate services may appear in multiple groups, e.g. '/IWBEP/ALL'.
      * @returns version independent information
      */
-    protected mapServices(groups: ServiceGroup[], entitySet: string): ODataServiceInfo[];
+    protected mapServices(groups: ServiceGroup[], entitySet: string, dedup?: boolean): ODataServiceInfo[];
     /**
-     * Fetch all services from the backend.
+     * Fetch all services from the backend using the @nexlink parameter to fetch all pages serially.
      *
      * @returns version independent service information
      */
-    protected fetchServices(): Promise<ODataServiceInfo[]>;
+    protected fetchServicesNextLink(): Promise<ODataServiceInfo[]>;
+    /**
+     * Fetches all services from the catalog.
+     *
+     * @param useNextLink if true, uses the nextLink parameter to fetch all pages serially, otherwise fetches all pages in parallel.
+     * @returns v4 services
+     */
+    protected fetchServices(useNextLink?: boolean): Promise<ODataServiceInfo[]>;
+    /**
+     * Fetches all services from the catalog in parallel. Uses the total service count to fetch all service group pages in parallel
+     * to improve performance where larger numbers of services and therefore pages are available.
+     *
+     * @returns List of unique services
+     */
+    protected fetchServicesParallel(): Promise<ODataServiceInfo[]>;
     /**
      * For OData v4, all annotations are already included in the metadata and no additional request is required.
      *

package/dist/abap/catalog/v4-catalog-service.js

@@ -4,26 +4,37 @@ exports.V4CatalogService = void 0;
 const base_1 = require("./base");
 const odata_service_1 = require("../../base/odata-service");
 const odata_request_error_1 = require("../../base/odata-request-error");
+const logger_1 = require("@sap-ux/logger");
 const V4_RECOMMENDED_ENTITYSET = 'RecommendedServices';
 const V4_CLASSIC_ENTITYSET = 'Services';
 /**
  * OData V4 specific implmentation of SAP's catalog service
  */
 class V4CatalogService extends base_1.CatalogService {
+    logger = new logger_1.ToolsLogger();
     static PATH = '/sap/opu/odata4/iwfnd/config/default/iwfnd/catalog/0002';
     /**
      * Map the V4 service information to a version independent structure.
      *
      * @param groups v4 service groups
-     * @param entitySet entity set used for service selection
+     * @param entitySet entity set used for service selection. e.g. `RecommendedServices`
+     * @param dedup if true, duplicate services will be removed based on their id. Duplicate services may appear in multiple groups, e.g. '/IWBEP/ALL'.
      * @returns version independent information
      */
-    mapServices(groups, entitySet) {
+    mapServices(groups, entitySet, dedup = false) {
         const services = [];
+        // Duplicates can appear in multiple groups, e.g. '/IWBEP/ALL'
+        const uniqueServiceIds = new Set();
         groups
             .filter((group) => group?.DefaultSystem?.[entitySet]?.length > 0)
             .forEach((group) => {
-            services.push(...group.DefaultSystem[entitySet].map((service) => {
+            services.push(...group.DefaultSystem[entitySet].flatMap((service) => {
+                if (dedup) {
+                    if (uniqueServiceIds.has(service.ServiceId)) {
+                        return [];
+                    }
+                    uniqueServiceIds.add(service.ServiceId);
+                }
                 return {
                     id: service.ServiceId,
                     group: group.GroupId,
@@ -38,11 +49,11 @@ class V4CatalogService extends base_1.CatalogService {
         return services;
     }
     /**
-     * Fetch all services from the backend.
+     * Fetch all services from the backend using the @nexlink parameter to fetch all pages serially.
      *
      * @returns version independent service information
      */
-    async fetchServices() {
+    async fetchServicesNextLink() {
         if (this.entitySet === undefined) {
             const metadata = await this.metadata();
             this.entitySet = metadata.includes('Name="RecommendedServices"')
@@ -56,18 +67,85 @@ class V4CatalogService extends base_1.CatalogService {
         const response = await this.get('/ServiceGroups', { params }, true);
         let serviceGroupResponseOdata = response.odata();
         const serviceGroups = serviceGroupResponseOdata.value;
+        let numPageRequests = 1;
         // Page by using the backends nextLink search parameters for the next request
         while (serviceGroupResponseOdata['@odata.nextLink']) {
             const nextLink = new URL(serviceGroupResponseOdata['@odata.nextLink'], this.defaults.baseURL);
             serviceGroupResponseOdata = (await this.get('/ServiceGroups', { params: nextLink.searchParams }, true)).odata();
+            numPageRequests++;
             serviceGroups.push(...serviceGroupResponseOdata.value);
         }
+        this.logger.log(`Fetched ${serviceGroups.length} service groups in ${numPageRequests} requests.`);
         // check if the service responded with an odata error
         if (odata_request_error_1.ODataRequestError.containsError(serviceGroups)) {
             throw new odata_request_error_1.ODataRequestError(serviceGroups);
         }
         return this.mapServices(serviceGroups, this.entitySet);
     }
+    /**
+     * Fetches all services from the catalog.
+     *
+     * @param useNextLink if true, uses the nextLink parameter to fetch all pages serially, otherwise fetches all pages in parallel.
+     * @returns v4 services
+     */
+    async fetchServices(useNextLink = false) {
+        if (useNextLink) {
+            return this.fetchServicesNextLink();
+        }
+        return this.fetchServicesParallel();
+    }
+    /**
+     * Fetches all services from the catalog in parallel. Uses the total service count to fetch all service group pages in parallel
+     * to improve performance where larger numbers of services and therefore pages are available.
+     *
+     * @returns List of unique services
+     */
+    async fetchServicesParallel() {
+        const defaultInitialPageSize = 1000; // default page size for the services, large enough to get the first page and skiptoken to determine max page size
+        if (this.entitySet === undefined) {
+            const metadata = await this.metadata();
+            this.entitySet = metadata.includes('Name="RecommendedServices"')
+                ? V4_RECOMMENDED_ENTITYSET
+                : V4_CLASSIC_ENTITYSET;
+        }
+        const params = new URLSearchParams([
+            ['$count', 'true'],
+            ['$top', defaultInitialPageSize.toString()], // Get the first page of services,
+            ['$expand', `DefaultSystem($expand=${this.entitySet})`]
+        ]);
+        const response = await this.get('/ServiceGroups', { params }, true);
+        const serviceGroupResponseOdata = response.odata();
+        const serviceGroups = serviceGroupResponseOdata.value;
+        const serviceGroupCount = serviceGroupResponseOdata['@odata.count'];
+        const pageSize = parseInt(serviceGroupResponseOdata['@odata.nextLink']?.split('skiptoken=')[1], 10);
+        let numPageRequests = 1;
+        // If we dont have a valid skip token, we assume we have all services in the first page
+        if (!isNaN(pageSize)) {
+            const numPages = Math.ceil(serviceGroupCount / pageSize);
+            // Create an array of promises to fetch all pages in parallel
+            const fetchPromises = Array.from({ length: numPages - 1 }, (_, index) => {
+                const nextParams = new URLSearchParams([
+                    ['$count', 'true'],
+                    ['$skip', String((index + 1) * pageSize)],
+                    ['$top', pageSize.toString()], // Fetch the next 200 services
+                    ['$expand', `DefaultSystem($expand=${this.entitySet})`]
+                ]);
+                numPageRequests++;
+                return this.get('/ServiceGroups', { params: nextParams }, true);
+            });
+            const pageResults = await Promise.all(fetchPromises); // Fetch all remaining pages in parallel
+            pageResults.forEach((pageResponse) => {
+                const pageData = pageResponse.odata();
+                serviceGroups.push(...pageData.value);
+            });
+        }
+        this.logger.log(`Fetched ${serviceGroups.length} service groups in ${numPageRequests} requests.`);
+        // check if the service responded with an odata error
+        if (odata_request_error_1.ODataRequestError.containsError(serviceGroups)) {
+            throw new odata_request_error_1.ODataRequestError(serviceGroups);
+        }
+        return this.mapServices(serviceGroups, this.entitySet, true);
+    }
     /**
      * For OData v4, all annotations are already included in the metadata and no additional request is required.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/axios-extension",
-  "version": "1.22.3",
+  "version": "1.22.4",
   "description": "Extension of the Axios module adding convenience methods to interact with SAP systems especially with OData services.",
   "repository": {
     "type": "git",
@@ -34,7 +34,7 @@
     "nock": "13.4.0",
     "supertest": "6.3.3",
     "@types/proxy-from-env": "1.0.1",
-    "@sap-ux/project-access": "1.30.3"
+    "@sap-ux/project-access": "1.30.7"
   },
   "files": [
     "dist",