@ui5/task-adaptation 1.1.1 → 1.1.3

package/CHANGELOG.md

@@ -2,7 +2,13 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task-adaptation/compare/v1.1.1...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task-adaptation/compare/v1.1.3...HEAD).
+
+<a name="v1.1.3"></a>
+## [v1.1.3] - 2024-02-26
+
+<a name="v1.1.2"></a>
+## [v1.1.2] - 2024-02-23
 
 <a name="v1.1.1"></a>
 ## [v1.1.1] - 2024-02-16
@@ -76,6 +82,8 @@ A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task
 <a name="v1.0.0"></a>
 ## v1.0.0 - 2020-12-09
 
+[v1.1.3]: https://github.com/SAP/ui5-task-adaptation/compare/v1.1.2...v1.1.3
+[v1.1.2]: https://github.com/SAP/ui5-task-adaptation/compare/v1.1.1...v1.1.2
 [v1.1.1]: https://github.com/SAP/ui5-task-adaptation/compare/v1.1.0...v1.1.1
 [v1.1.0]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.23...v1.1.0
 [v1.0.23]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.21...v1.0.23

package/README.md

@@ -4,7 +4,7 @@
 [![npm version](https://badge.fury.io/js/@ui5%2Ftask-adaptation.svg)](https://badge.fury.io/js/@ui5%2Ftask-adaptation)
 
 ## Description
-A custom task for [ui5-builder](https://github.com/SAP/ui5-builder) that allows building [UI5 Flexibility adaptation projects](https://help.sap.com/viewer/584e0bcbfd4a4aff91c815cefa0bce2d/Cloud/en-US/019b0c38a6b043d1a66b11d992eed290.html) for SAP BTP, Cloud Foundry environment.
+A custom task for [ui5-builder](https://github.com/SAP/ui5-builder) that allows building SAPUI5 adaptation projects for [SAP S/4HANA Cloud](https://help.sap.com/docs/bas/584e0bcbfd4a4aff91c815cefa0bce2d/6fc4e11a4b1941efa8e37a428d046f8f.html?locale=en-US&state=PRODUCTION&version=Cloud) and [SAP BTP, Cloud Foundry environment](https://help.sap.com/viewer/584e0bcbfd4a4aff91c815cefa0bce2d/Cloud/en-US/019b0c38a6b043d1a66b11d992eed290.html).
 
 ## How to obtain support
 In case you need any support, please create a [GitHub issue](https://github.com/SAP/ui5-task-adaptation/issues).

package/dist/annotations/comparator/comparator.js

@@ -114,8 +114,11 @@ class Comparator {
         const includer_a = new Includer(a, property);
         const includer_b = new Includer(b, property);
         for (let i = 0; i < Math.max(a.length, b.length); i++) {
-            const id_a = a[i]?._attributes[idProperty];
-            const id_b = b[i]?._attributes[idProperty];
+            // There might be an exceptional case, when the object doesn't
+            // contain attributes. In this case we continue traversing, like
+            // UI5 does.
+            const id_a = a[i]?._attributes?.[idProperty];
+            const id_b = b[i]?._attributes?.[idProperty];
             if (id_a !== id_b) {
                 // We go down the array and if suddenly the ids for comparing
                 // items are not the same, we need to find the item with the

package/dist/annotations/dataSource/dataSourceManager.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const dataSourceOData_1 = require("./dataSourceOData");
 const dataSourceODataAnnotation_1 = require("./dataSourceODataAnnotation");
+const dataSourceODataAnnotationBeta_1 = require("./dataSourceODataAnnotationBeta");
 const path_1 = require("path");
 class DataSourceManager {
     constructor() {
@@ -29,8 +30,15 @@ class DataSourceManager {
         }
         // If ODataAnnotation is in OData annotations, pass metadata url to it
         for (const [name, dataSource] of Object.entries(dataSourcesJson)) {
-            if (dataSource.uri?.startsWith("/") && dataSource.type === "ODataAnnotation") {
-                this.dataSources.push(new dataSourceODataAnnotation_1.default(name, dataSource.uri, dataSource, odataAnnotationMap.get(name)));
+            const uri = dataSource.uri;
+            const metadataUrl = odataAnnotationMap.get(name);
+            if (uri?.startsWith("/") && dataSource.type === "ODataAnnotation") {
+                if (config.enableBetaFeatures) {
+                    this.dataSources.push(new dataSourceODataAnnotationBeta_1.default(name, uri, dataSource, metadataUrl));
+                }
+                else {
+                    this.dataSources.push(new dataSourceODataAnnotation_1.default(name, uri, dataSource));
+                }
             }
         }
         for (const dataSource of this.dataSources) {

package/dist/annotations/dataSource/dataSourceODataAnnotation.d.ts

@@ -1,6 +1,6 @@
 import DataSource from "./dataSource";
 export default class DataSourceODataAnnotation extends DataSource {
     private dataSourceJson;
-    constructor(name: string, uri: string, dataSourceJson: any, metadataUrl?: string);
+    constructor(name: string, uri: string, dataSourceJson: any);
     updateManifest(): void;
 }

package/dist/annotations/dataSource/dataSourceODataAnnotation.js

@@ -1,14 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const dataSource_1 = require("./dataSource");
-const traverseReferences_1 = require("../transformers/traverseReferences");
 class DataSourceODataAnnotation extends dataSource_1.default {
-    constructor(name, uri, dataSourceJson, metadataUrl) {
+    constructor(name, uri, dataSourceJson) {
         super(name, uri);
         this.dataSourceJson = dataSourceJson;
-        this.jsonTransformers = [
-            new traverseReferences_1.default(metadataUrl)
-        ];
     }
     updateManifest() {
         this.dataSourceJson.uri = this.getFilename();

package/dist/annotations/dataSource/dataSourceODataAnnotationBeta.d.ts

@@ -0,0 +1,6 @@
+import DataSource from "./dataSource";
+export default class DataSourceODataAnnotation extends DataSource {
+    private dataSourceJson;
+    constructor(name: string, uri: string, dataSourceJson: any, metadataUrl: string | undefined);
+    updateManifest(): void;
+}

package/dist/annotations/dataSource/dataSourceODataAnnotationBeta.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const dataSource_1 = require("./dataSource");
+const traverseReferences_1 = require("../transformers/traverseReferences");
+class DataSourceODataAnnotation extends dataSource_1.default {
+    constructor(name, uri, dataSourceJson, metadataUrl) {
+        super(name, uri);
+        this.dataSourceJson = dataSourceJson;
+        this.jsonTransformers = [
+            new traverseReferences_1.default(metadataUrl)
+        ];
+    }
+    updateManifest() {
+        this.dataSourceJson.uri = this.getFilename();
+    }
+}
+exports.default = DataSourceODataAnnotation;
+//# sourceMappingURL=dataSourceODataAnnotationBeta.js.map

package/dist/annotations/serviceRequestor.js

@@ -1,8 +1,41 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const annotationsCacheManager_1 = require("../cache/annotationsCacheManager");
+const serverError_1 = require("../model/serverError");
 const commonUtil_1 = require("../util/commonUtil");
 const log = require("@ui5/logger").getLogger("@ui5/task-adaptation::ServiceRequestor");
+function retryOnError(maxRetries) {
+    return (_target, _propertyKey, descriptor) => {
+        const originalMethod = descriptor.value;
+        descriptor.value = async function (...args) {
+            let retries = 0;
+            while (true) {
+                try {
+                    const result = await originalMethod.apply(this, args);
+                    return result;
+                }
+                catch (error) {
+                    if (error instanceof serverError_1.default) {
+                        if (retries === maxRetries) {
+                            throw new Error(`Error occurred: ${error.message}. Please try again if this is a temporary issue. If not, please create a ticket on CA-UI5-ABA-AIDX`);
+                        }
+                        retries++;
+                    }
+                    else {
+                        throw new Error(`Failed to fetch annotation by '${args[0]}': ${error.message}`);
+                    }
+                }
+            }
+        };
+        return descriptor;
+    };
+}
 class ServiceRequestor {
     constructor(configuration, abapRepoManager) {
         this.abapRepoManager = abapRepoManager;
@@ -16,25 +49,23 @@ class ServiceRequestor {
         }
         const cacheManager = new annotationsCacheManager_1.default(this.configuration, cacheName);
         log.verbose(`Getting annotation '${cacheName}' ${language} by '${uri}'`);
-        try {
-            let files;
-            if (this.configuration.enableAnnotationCache) {
-                files = await cacheManager.getFiles(() => this.abapRepoManager.getAnnotationMetadata(uri), () => this.abapRepoManager.downloadAnnotationFile(uri));
-            }
-            else {
-                files = await this.abapRepoManager.downloadAnnotationFile(uri);
-            }
-            if (!files || files.size === 0) {
-                throw new Error(`No files were fetched for '${name}' by '${uri}'`);
-            }
-            const xml = [...files][0][1];
-            (0, commonUtil_1.writeTempAnnotations)(this.configuration, name, language, xml);
-            return xml;
+        let files;
+        if (this.configuration.enableAnnotationCache) {
+            files = await cacheManager.getFiles(() => this.abapRepoManager.getAnnotationMetadata(uri), () => this.abapRepoManager.downloadAnnotationFile(uri));
+        }
+        else {
+            files = await this.abapRepoManager.downloadAnnotationFile(uri);
         }
-        catch (error) {
-            throw new Error(`Failed to fetch annotation by '${uri}': ${error.message}`);
+        if (!files || files.size === 0) {
+            throw new Error(`No files were fetched for '${name}' by '${uri}'`);
         }
+        const xml = [...files][0][1];
+        (0, commonUtil_1.writeTempAnnotations)(this.configuration, name, language, xml);
+        return xml;
     }
 }
+__decorate([
+    retryOnError(1)
+], ServiceRequestor.prototype, "downloadAnnotation", null);
 exports.default = ServiceRequestor;
 //# sourceMappingURL=serviceRequestor.js.map

package/dist/annotations/transformers/traverseReferences.d.ts

@@ -3,8 +3,7 @@ export default class TraverseReferences implements Transformer {
     private metadataUrl?;
     constructor(metadataUrl?: string);
     transform({ json, language, serviceRequestor, uri: parentUrl }: TransformerInput): Promise<void>;
-    private isReferenceToMetadata;
-    static joinUrls(relativeUrl: string, parentUrl: string): any;
+    private shouldIgnoreUrl;
     private mergeAnnotations;
     private static isTraversable;
 }

package/dist/annotations/transformers/traverseReferences.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const metadataJsonUtil_1 = require("../converter/metadataJsonUtil");
-const dataSourceODataAnnotation_1 = require("../dataSource/dataSourceODataAnnotation");
-const { URI } = require("../../../dist/bundle-odata");
+const dataSourceODataAnnotationBeta_1 = require("../dataSource/dataSourceODataAnnotationBeta");
+const urlUtil_1 = require("../../util/urlUtil");
 class TraverseReferences {
     constructor(metadataUrl) {
         this.metadataUrl = metadataUrl;
@@ -11,13 +11,13 @@ class TraverseReferences {
         const references = metadataJsonUtil_1.default.getReferences(json).filter(TraverseReferences.isTraversable);
         const promises = [];
         for (const { includes, uri: relativeUrl } of references) {
-            const absoluteUrl = TraverseReferences.joinUrls(relativeUrl, parentUrl);
-            if (this.isReferenceToMetadata(parentUrl, absoluteUrl, this.metadataUrl)) {
-                // If ODataAnnotation has reference to metadata, don't traverse
+            const absoluteUrl = urlUtil_1.default.join(urlUtil_1.default.getResourcePath(relativeUrl), parentUrl);
+            if (this.shouldIgnoreUrl(absoluteUrl, [parentUrl, this.metadataUrl])) {
+                // If reference to metadata or its parent, don't traverse
                 continue;
             }
             const name = includes[0]?.namespace;
-            const dataSource = new dataSourceODataAnnotation_1.default(name, absoluteUrl, {}, this.metadataUrl);
+            const dataSource = new dataSourceODataAnnotationBeta_1.default(name, absoluteUrl, {}, this.metadataUrl);
             promises.push(dataSource.downloadAnnotation(language, serviceRequestor)
                 .then(childAnnotation => ({ name, childAnnotation })));
         }
@@ -27,18 +27,10 @@ class TraverseReferences {
         }
         return json;
     }
-    isReferenceToMetadata(parentUrl, absoluteUrl, metadataUrl) {
+    shouldIgnoreUrl(referenceUrl, urlsToIgnore) {
+        const toResourcePath = (url) => urlUtil_1.default.getResourcePath(url);
         const isEqual = (a, b) => a && b && a.toLowerCase() === b.toLowerCase();
-        return isEqual(parentUrl, metadataUrl) || isEqual(absoluteUrl, metadataUrl);
-    }
-    static joinUrls(relativeUrl, parentUrl) {
-        // Remove trailing slash, otherwise url join can be incorrect Remove
-        // trailing slash, otherwise url join can be incorrect Annotation URLs
-        // defined in manifest might end with .../$value/ or .../$value and both
-        // are accepted by Gateway and produce the same content with same
-        // relative URLs. The first case is actually incorrect and we have to
-        // sanitize the same way as UI5.
-        return new URI(relativeUrl).absoluteTo(parentUrl.replace(/\/$/, "")).toString();
+        return urlsToIgnore.map(toResourcePath).some(url => isEqual(referenceUrl, url));
     }
     mergeAnnotations(parentJson, nestedJson) {
         const parentAnnotations = metadataJsonUtil_1.default.getAnnotations(parentJson);

package/dist/appVariantManager.js

@@ -63,11 +63,14 @@ class AppVariantManager {
             }
         }
         this.validateManifest(manifest);
+        // Order is important: apply manifest.json changes first, then *.change
+        // files. UI5 does the same.
+        const changes = (manifest.content ?? []).concat(manifestChanges);
         return {
             id: manifest.id,
             reference: manifest.reference,
             layer: manifest.layer,
-            changes: manifestChanges.concat(manifest.content)
+            changes
         };
     }
     static validateManifest(manifest) {

package/dist/baseAppManager.js

@@ -59,11 +59,11 @@ class BaseAppManager {
         return (0, commonUtil_1.removePropertiesExtension)(i18nNode["bundleUrl"]);
     }
     static getBaseAppManifest(baseAppFiles) {
-        let filepath = [...baseAppFiles.keys()].find(filepath => filepath.endsWith("manifest.json"));
-        if (filepath) {
+        const manifestContent = baseAppFiles.get("manifest.json");
+        if (manifestContent) {
             return {
-                content: JSON.parse(baseAppFiles.get(filepath)),
-                filepath
+                content: JSON.parse(manifestContent),
+                filepath: "manifest.json"
             };
         }
         throw new Error("Original application should have manifest.json in root folder");
@@ -118,9 +118,9 @@ class BaseAppManager {
     }
     static writeToWorkspace(baseAppFiles, projectNamespace) {
         const IGNORE_FILES = [
-            "/manifest-bundle.zip",
-            "/Component-preload.js",
-            "/sap-ui-cachebuster-info.json"
+            "manifest-bundle.zip",
+            "Component-preload.js",
+            "sap-ui-cachebuster-info.json"
         ];
         const resources = [];
         for (let filename of baseAppFiles.keys()) {

package/dist/model/serverError.d.ts

@@ -0,0 +1,3 @@
+export default class ServerError extends Error {
+    constructor(uri: string, error: any);
+}

package/dist/model/serverError.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ServerError extends Error {
+    constructor(uri, error) {
+        super(`Request ${uri} failed with Server error: ${error.response.status}${error.response.data ?? ""}`);
+    }
+}
+exports.default = ServerError;
+//# sourceMappingURL=serverError.js.map

package/dist/repositories/abapRepoManager.js

@@ -6,12 +6,12 @@ const log = require("@ui5/logger").getLogger("@ui5/task-adaptation::AbapRepoMana
 const REQUEST_OPTIONS_XML = {
     responseType: "text",
     headers: {
-        "Content-Type": "text/xml"
+        "Accept": "text/html,application/xhtml+xml,application/xml"
     }
 };
 const REQUEST_OPTIONS_JSON = {
     headers: {
-        "Content-Type": "application/json"
+        "Accept": "application/json"
     }
 };
 class AbapRepoManager {

package/dist/util/requestUtil.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = require("axios");
 const noAuthorizationProvidedError_1 = require("../model/noAuthorizationProvidedError");
+const serverError_1 = require("../model/serverError");
 class RequestUtil {
     static async head(url, auth) {
         return this.request(url, axios_1.default.head, auth);
@@ -24,6 +25,9 @@ class RequestUtil {
             if (error.response.status === 401) {
                 throw new noAuthorizationProvidedError_1.default(uri);
             }
+            else if (error.response.status >= 500) {
+                throw new serverError_1.default(uri, error);
+            }
             else {
                 throw new Error(`Unexpected response received from '${uri}': ${error.response.status} ${error.response.data ?? ""}`);
             }

package/dist/util/resourceUtil.js

@@ -37,7 +37,7 @@ class ResourceUtil {
             const entryPath = path_1.posix.join(folder, entry);
             const stats = fs.lstatSync(entryPath);
             if (stats.isFile() && !exclude.some(filepath => entryPath.endsWith(filepath))) {
-                const normalized = entryPath.substring(rootFolder.length);
+                const normalized = entryPath.substring(rootFolder.length + 1);
                 files.set(normalized, fs.readFileSync(entryPath, { encoding: "utf-8" }));
             }
             else if (stats.isDirectory()) {

package/dist/util/urlUtil.d.ts

@@ -0,0 +1,4 @@
+export default class UrlUtil {
+    static join(relativeUrl: string, parentUrl: string): any;
+    static getResourcePath(url: string | undefined): any;
+}

package/dist/util/urlUtil.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const { URI } = require("../../dist/bundle-odata");
+class UrlUtil {
+    static join(relativeUrl, parentUrl) {
+        // Remove trailing slash, otherwise url join can be incorrect Remove
+        // trailing slash, otherwise url join can be incorrect Annotation URLs
+        // defined in manifest might end with .../$value/ or .../$value and both
+        // are accepted by Gateway and produce the same content with same
+        // relative URLs. The first case is actually incorrect and we have to
+        // sanitize the same way as UI5. We also trim urls domain/host, because
+        // we need to substitute it with destination to download later.
+        return new URI(relativeUrl).absoluteTo(parentUrl.replace(/\/$/, "")).toString();
+    }
+    static getResourcePath(url) {
+        // Trim urls domain/host.
+        return url && URI.parse(url).path;
+    }
+}
+exports.default = UrlUtil;
+//# sourceMappingURL=urlUtil.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.1.1",
+    "version": "1.1.3",
     "description": "Custom task for ui5-builder which allows building UI5 Flexibility Adaptation Projects for SAP BTP, Cloud Foundry environment",
     "main": "index.js",
     "scripts": {
@@ -45,9 +45,10 @@
         "builtin-modules": "^3.2.0",
         "crc": "^4.3.2",
         "dotenv": "^16.0.3",
+        "glob": "^10.3.10",
         "js-yaml": "^4.1.0",
         "jsdom": "^23.0.1",
-        "rimraf": "^3.0.2",
+        "rimraf": "^5.0.5",
         "rollup": "^2.56.3",
         "semver": "^7.3.5",
         "temp-dir": "^2.0.0",
@@ -62,12 +63,13 @@
         "@types/jsdom": "^21.1.6",
         "@types/lodash": "^4.14.196",
         "@types/mocha": "^9.1.0",
-        "@types/rimraf": "^3.0.2",
+        "@types/rimraf": "^4.0.5",
         "@types/semver": "^7.3.8",
         "@types/sinon": "^10.0.16",
         "chai": "^4.3.4",
         "chai-as-promised": "^7.1.1",
         "chalk": "^4.1.2",
+        "minimatch": "^9.0.3",
         "mocha": "^9.2.0",
         "mock-require": "^3.0.3",
         "nyc": "^15.1.0",