@ui5/task-adaptation 1.0.8 → 1.0.11

package/dist/index.js

@@ -11,39 +11,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const appVariantManager_1 = require("./appVariantManager");
 const baseAppManager_1 = require("./baseAppManager");
-const html5RepoManager_1 = require("./html5RepoManager");
-const resourceUtil_1 = require("./util/resourceUtil");
+const updateCache_1 = require("./updateCache");
 /**
  * Creates an appVariant bundle from the provided resources.
  */
 module.exports = ({ workspace, options, taskUtil }) => {
     function process(workspace, taskUtil) {
         return __awaiter(this, void 0, void 0, function* () {
-            const baseAppFiles = getBaseAppFiles(options.configuration);
+            const baseAppFiles = updateCache_1.default(options.configuration);
             const appVariantResources = yield appVariantManager_1.default.getAppVariantResources(workspace);
             const appVariantInfo = appVariantManager_1.default.process(appVariantResources, options.projectNamespace, taskUtil);
             const baseAppResources = yield baseAppManager_1.default.process(yield baseAppFiles, yield appVariantInfo, options);
             yield Promise.all(appVariantResources.concat(baseAppResources).map(resource => workspace.write(resource)));
         });
     }
-    function getBaseAppFiles(configuration) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let result = new Map();
-            if (!configuration.ignoreCache) {
-                result = yield resourceUtil_1.default.readTemp(configuration);
-            }
-            if (result.size === 0) {
-                const [metadata, baseAppFiles] = yield Promise.all([
-                    html5RepoManager_1.default.getMetadata(configuration),
-                    html5RepoManager_1.default.getBaseAppFiles(configuration)
-                ]);
-                const metadataMap = new Map([[resourceUtil_1.default.METADATA_FILENAME, JSON.stringify(metadata)]]);
-                yield resourceUtil_1.default.writeTemp(configuration, new Map([...baseAppFiles, ...metadataMap]));
-                return baseAppFiles;
-            }
-            return result;
-        });
-    }
     return process(workspace, taskUtil);
 };
 //# sourceMappingURL=index.js.map

package/dist/model/types.d.ts

@@ -6,7 +6,6 @@ export interface IConfiguration {
     spaceGuid?: string;
     orgGuid?: string;
     sapCloudService?: string;
-    ignoreCache?: boolean;
 }
 export interface IProjectOptions {
     configuration: IConfiguration;
@@ -59,11 +58,13 @@ export interface IAppVariantInfo {
 export interface IAppVariantManifest {
     id: string;
     reference: string;
+    layer?: string;
     content: IChange[];
 }
 export interface IChange {
     changeType: string;
     texts: IChangeText;
+    layer?: string;
 }
 export interface IChangeText {
     i18n: string;

package/dist/updateCache.d.ts

@@ -2,4 +2,4 @@ import { IConfiguration } from "./model/types";
 /**
  * Updates temporary stored original app files
  */
-export default function (configuration: IConfiguration): Promise<boolean>;
+export default function (configuration: IConfiguration): Promise<Map<string, string>>;

package/dist/updateCache.js

@@ -23,11 +23,13 @@ function default_1(configuration) {
         const metadata = yield metadataPromise;
         if (metadata.changedOn !== (tempMetadata === null || tempMetadata === void 0 ? void 0 : tempMetadata.changedOn)) {
             const baseAppFiles = yield html5RepoManager_1.default.getBaseAppFiles(configuration);
-            baseAppFiles.set(resourceUtil_1.default.METADATA_FILENAME, JSON.stringify(metadata));
-            yield resourceUtil_1.default.writeTemp(configuration, baseAppFiles);
-            return true;
+            const metadataMap = new Map([[resourceUtil_1.default.METADATA_FILENAME, JSON.stringify(metadata)]]);
+            yield resourceUtil_1.default.writeTemp(configuration, new Map([...baseAppFiles, ...metadataMap]));
+            return baseAppFiles;
+        }
+        else {
+            return resourceUtil_1.default.readTemp(configuration);
         }
-        return false;
     });
 }
 exports.default = default_1;

package/dist/util/requestUtil.js

@@ -9,29 +9,24 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const node_fetch_1 = require("node-fetch");
+const axios_1 = require("axios");
 class RequestUtil {
     static get(uri, options) {
-        return node_fetch_1.default(uri, options).then(res => res.json());
+        return axios_1.default.get(uri, options).then(response => response.data);
     }
     static download(token, appHostId, uri) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!token) {
                 throw new Error("HTML5 token is undefined");
             }
-            const response = yield node_fetch_1.default(uri, {
+            return axios_1.default.get(uri, {
+                responseType: "arraybuffer",
                 headers: {
                     "Content-Type": "application/json",
                     "Authorization": "Bearer " + token,
                     "x-app-host-id": appHostId
                 }
-            });
-            return new Promise((resolve, reject) => {
-                const data = [];
-                response.body.on("error", err => reject(err));
-                response.body.on("data", block => data.push(block));
-                response.body.on("end", () => resolve(Buffer.concat(data)));
-            });
+            }).then(response => response.data);
         });
     }
 }

package/package.json

@@ -1,18 +1,20 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.0.8",
+    "version": "1.0.11",
     "description": "Custom task for ui5-builder which allows building UI5 Flexibility Adaptation Projects for SAP BTP, Cloud Foundry environment",
     "main": "index.js",
     "scripts": {
         "test": "npm run build && npm run coverage",
         "dev": "mocha --no-timeouts -r ts-node/register 'test/**/*.spec.ts'",
-        "coverage": "nyc node_modules/.bin/mocha -r ts-node/register 'test/**/*.spec.ts'",
-        "coverage-verbose": "nyc --reporter=html --reporter=text node_modules/.bin/mocha -r ts-node/register 'test/**/*.spec.ts'",
+        "perf": "mocha --no-timeouts -r ts-node/register 'test/**/*.perf.ts'",
+        "coverage": "nyc mocha -r ts-node/register 'test/**/*.spec.ts'",
+        "coverage-verbose": "nyc --reporter=html --reporter=text mocha -r ts-node/register 'test/**/*.spec.ts'",
         "preversion": "npm test",
         "version": "git-chglog --next-tag v$npm_package_version -o CHANGELOG.md && git add CHANGELOG.md",
         "postversion": "git push --follow-tags",
         "release-note": "git-chglog -c .chglog/release-config.yml v$npm_package_version",
-        "build": "rollup -c rollup.config.js && tsc -p ."
+        "rollup": "ts-node scripts/rollup.ts ./dist/bundle.js",
+        "build": "npm run rollup && tsc -p ./"
     },
     "repository": {
         "type": "git",
@@ -30,38 +32,42 @@
     "author": "SAP SE",
     "license": "Apache-2.0",
     "dependencies": {
-        "@sap/cf-tools": "^1.1.0",
+        "@buxlabs/amd-to-es6": "^0.16.1",
+        "@rollup/plugin-node-resolve": "^13.0.4",
+        "@sap/cf-tools": "^2.0.1",
         "@ui5/fs": "^2.0.6",
         "@ui5/logger": "^2.0.1",
+        "@ui5/project": "^2.6.0",
         "adm-zip": "^0.5.5",
-        "js-yaml": "^4.0.0",
-        "node-fetch": "^2.6.1",
+        "amdextract": "^3.0.0",
+        "axios": "^0.25.0",
+        "builtin-modules": "^3.2.0",
+        "js-yaml": "^4.1.0",
         "rimraf": "^3.0.2",
+        "rollup": "^2.56.3",
+        "semver": "^7.3.5",
         "temp-dir": "^2.0.0"
     },
     "devDependencies": {
-        "@buxlabs/amd-to-es6": "^0.16.0",
         "@istanbuljs/nyc-config-typescript": "^1.0.1",
-        "@rollup/plugin-node-resolve": "^11.2.1",
         "@types/adm-zip": "^0.4.34",
-        "@types/chai": "^4.2.16",
-        "@types/mocha": "^8.2.2",
-        "@types/node-fetch": "^2.5.9",
-        "@types/request": "^2.48.5",
-        "@types/rimraf": "^3.0.0",
-        "@types/sinon": "^9.0.11",
-        "@ui5/project": "^2.3.1",
-        "amdextract": "^3.0.0",
-        "builtin-modules": "^3.2.0",
+        "@types/chai": "^4.2.21",
+        "@types/chai-as-promised": "^7.1.4",
+        "@types/js-yaml": "^4.0.3",
+        "@types/mocha": "^9.1.0",
+        "@types/rimraf": "^3.0.2",
+        "@types/semver": "^7.3.8",
+        "@types/sinon": "^10.0.2",
         "chai": "^4.3.4",
-        "mocha": "^8.3.2",
+        "chai-as-promised": "^7.1.1",
+        "chalk": "^4.1.2",
+        "mocha": "^9.2.0",
         "mock-require": "^3.0.3",
         "nyc": "^15.1.0",
-        "rollup": "^2.44.0",
-        "sinon": "^10.0.0",
+        "sinon": "^11.1.2",
         "source-map-support": "^0.5.19",
-        "ts-node": "^9.1.1",
-        "typescript": "^4.2.3"
+        "ts-node": "^10.4.0",
+        "typescript": "^4.3.5"
     },
     "nyc": {
         "reporter": [
@@ -77,10 +83,10 @@
             "test/**",
             "lib/processors/jsdoc/lib/**",
             "dist/**",
-            "rollup.config.js",
-            "rollup/**",
             "src/model/types.ts",
-            "src/util/requestUtil.ts"
+            "src/util/requestUtil.ts",
+            "scripts/**/*.js",
+            "scripts/git/octokitUtil.ts"
         ],
         "check-coverage": true,
         "statements": 85,

package/scripts/rollup/bundleDefinition.js

@@ -0,0 +1,11 @@
+import Applier from "sap/ui/fl/apply/_internal/changes/descriptor/Applier";
+import ApplyUtil from "sap/ui/fl/apply/_internal/changes/descriptor/ApplyUtil";
+import Change from "sap/ui/fl/Change";
+import RegistrationBuild from "sap/ui/fl/apply/_internal/changes/descriptor/RegistrationBuild";
+
+export {
+    Applier,
+    ApplyUtil,
+    Change,
+    RegistrationBuild
+};

package/scripts/rollup/overrides/sap/ui/fl/Change.js

@@ -0,0 +1,72 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2020 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+
+], function (
+
+) {
+	"use strict";
+
+	/**
+	 * Flexibility change class. Stores change content and related information.
+	 *
+	 * @param {object} oFile - File content and admin data
+	 *
+	 * @class sap.ui.fl.Change
+	 * @private
+	 * @ui5-restricted
+	 * @experimental Since 1.25.0
+	 */
+	var Change = function (oFile) {
+		this._oDefinition = oFile;
+	};
+
+	/**
+	 * Returns the change type.
+	 *
+	 * @returns {String} Change type of the file, for example <code>LabelChange</code>
+	 * @public
+	 */
+	Change.prototype.getChangeType = function () {
+		if (this._oDefinition) {
+			return this._oDefinition.changeType;
+		}
+	};
+
+	/**
+	 * Gets the layer type for the change.
+	 * @returns {string} Layer of the change file
+	 *
+	 * @public
+	 */
+	 Change.prototype.getLayer = function () {
+		return this._oDefinition.layer;
+	};
+
+	/**
+	 * Returns the content section of the change.
+	 * @returns {string} Content of the change file. The content structure can be any JSON.
+	 *
+	 * @public
+	 */
+	Change.prototype.getContent = function () {
+		return this._oDefinition.content;
+	};
+
+	/**
+	 * Returns all texts.
+	 *
+	 * @returns {object} All texts
+	 *
+	 * @function
+	 */
+	Change.prototype.getTexts = function () {
+		return this._oDefinition.texts;
+	};
+
+	return Change;
+}, true);

package/scripts/rollup/overrides/sap/ui/thirdparty/URI.js

@@ -0,0 +1,16 @@
+import * as path from "path";
+
+export default class URI {
+    constructor(value) {
+        this.value = value;
+    }
+
+    normalize() {
+        this.value = path.normalize(this.value);
+        return this;
+    }
+
+    path() {
+        return this.value;
+    }
+}

package/scripts/rollup/project/package.json

@@ -0,0 +1,3 @@
+{
+    "name": "rollup"
+}

package/scripts/rollup/project/ui5.yaml

@@ -0,0 +1,13 @@
+---
+specVersion: "2.2"
+type: application
+metadata:
+  name: rollup
+  allowSapInternal: true
+framework:
+  name: SAPUI5
+  version: "1.91.0"
+  libraries:
+    - name: sap.ui.fl
+    - name: sap.suite.ui.generic.template
+    - name: sap.fe.core

package/scripts/rollup/project/webapp/manifest.json

@@ -0,0 +1,5 @@
+{
+    "sap.app": {
+        "id": "rollup"
+    }
+}

package/scripts/rollup/ui5Resolve.ts

@@ -0,0 +1,134 @@
+import * as crypto from "crypto";
+import * as fs from "fs";
+import * as path from "path";
+import * as stream from "stream";
+
+import { promisify } from "util";
+
+const convertAMDtoES6 = require("@buxlabs/amd-to-es6");
+const log = require("@ui5/logger").getLogger("rollup-plugin-ui5-resolve-task-adaptation");
+const { resourceFactory } = require("@ui5/fs");
+
+
+export default function (options: any) {
+
+    let dependencies: any;
+
+    const skipTransformation = (id: string) => !options.skipTransformation?.includes(id);
+
+    return {
+
+        name: "ui5-resolve",
+
+        buildStart: async (_: any) => {
+
+            dependencies = resourceFactory.createCollectionsForTree(options.project, {}).dependencies;
+
+            const pipe = promisify(stream.pipeline);
+            const resources: any[] = await Promise.all(options.assets.map((asset: string) => dependencies.byGlob(asset)));
+            const writePromises = [].concat(...resources).map((resource: any) => {
+                const file = `./dist${resource.getPath()}`;
+                const folder = path.dirname(file);
+                if (!fs.existsSync(folder)) {
+                    fs.mkdirSync(folder, { recursive: true });
+                }
+                if (fs.existsSync(file)) {
+                    fs.unlinkSync(file);
+                }
+                return pipe(resource.getStream(), fs.createWriteStream(file));
+            });
+            await Promise.all(writePromises);
+        },
+
+
+        /*
+         * Right before writing result to dist
+         */
+        renderChunk: (code: string) => {
+            return `//${options.ui5version}\nvar window = {};\n${code}`;
+        },
+
+
+        resolveId: (source: string, importer: string) => {
+            log.verbose(`resolveId: ${source} from ${importer}`);
+            if (importer && source.startsWith(".")) {
+                source = path.posix.join(path.dirname(importer), source);
+            }
+            log.verbose(" --> resolve to: " + source);
+            return source;
+        },
+
+
+        load: async (id: string) => {
+            log.verbose(`load: ${id}`);
+
+            if (!dependencies) {
+                dependencies = resourceFactory.createCollectionsForTree(options.project, {}).dependencies;
+            }
+
+            const localFile = path.join(__dirname, id);
+            if (fs.existsSync(localFile)) {
+                log.info(`Using local file "${id}"`);
+                return fs.readFileSync(localFile, {
+                    encoding: "utf8"
+                });
+            }
+
+            const localOverride = path.resolve(__dirname, "overrides", id + ".js");
+            if (fs.existsSync(localOverride)) {
+                log.info(`Using local override for "${id}"`);
+                return fs.readFileSync(localOverride, { encoding: "utf8" });
+            }
+
+            const resource = await dependencies.byPath(`/resources/${id}.js`);
+            return resource.getString();
+        },
+
+
+        transform: (code: string, id: string): string | undefined => {
+            const skipped = !skipTransformation(id);
+            log.verbose(`transform: ${id} ${skipped ? "skipped" : ""}`);
+            if (skipped) {
+                return;
+            }
+
+            code = replaceRequireAsync(code);
+
+            code = code
+            .replace(/sap\.ui\.define/g, "define")
+            .replace(/\, \/\* bExport\= \*\/ true\)/g, ")")
+            .replace(/}, (true|false)\);$/g, "});")
+            .replace(/}, (true|false)\);(\n\/\/# sourceMappingURL=)*/g, "});\n//# sourceMappingURL=");
+            return convertAMDtoES6(code);
+        }
+
+    };
+};
+
+
+function replaceRequireAsync(code: string) {
+    const requireAsyncPattern = /requireAsync((.bind\(this, ")|(\("))+(?<url>[\/\w]*)"\)/mg;
+    let match, defineUrls = [], defineVars = [], matches = new Map();
+    while (match = requireAsyncPattern.exec(code)) {
+        if (match.groups?.url) {
+            const varaibleName = match.groups.url.split("/").pop() + crypto.randomBytes(16).toString("hex");
+            defineUrls.push(`"${match.groups.url}"`);
+            defineVars.push(varaibleName);
+            const value = match[0].includes("requireAsync.bind")
+                ? `() => Promise.resolve(${varaibleName})`
+                : varaibleName;
+            matches.set(match[0], value);
+        }
+    }
+    if (defineUrls.length > 0 && defineVars.length > 0) {
+        matches.forEach((value, key) => code = code.replace(key, value));
+        code = replaceRequireAsyncWith(code, `"sap/ui/fl/requireAsync"`, defineUrls);
+        code = replaceRequireAsyncWith(code, "requireAsync", defineVars);
+    }
+    return code;
+}
+
+
+function replaceRequireAsyncWith(code: string, requireAsyncSearchKeyword: string, inserts: string[]) {
+    return code.replace(requireAsyncSearchKeyword, inserts.join(",\n\t"));
+}

package/scripts/rollup.ts

@@ -0,0 +1,111 @@
+import * as fs from "fs";
+import * as path from "path";
+
+import * as builtins from "builtin-modules";
+import { nodeResolve } from "@rollup/plugin-node-resolve";
+import * as rollup from "rollup";
+import * as semver from "semver";
+import * as yaml from "js-yaml";
+import ui5 from "./rollup/ui5Resolve";
+
+const { normalizer } = require("@ui5/project");
+const log = require("@ui5/logger").getLogger("rollup-plugin-ui5-resolve-task-adaptation");
+
+const projectPaths = [
+    path.resolve(__dirname, "rollup", "project")
+];
+
+export default class Builder {
+
+    static async getProjectInfo(projectPaths: string[]) {
+        for (const cwd of projectPaths) {
+            try {
+                let options = {
+                    cwd,
+                    frameworkOptions: {
+                        versionOverride: "latest"
+                    }
+                };
+                const project = await normalizer.generateProjectTree(options);
+                this.validateProjectSettings(cwd);
+                return project;
+            } catch (error: any) {
+                log.info(`${error.message}`);
+            }
+        }
+    }
+
+    static validateProjectSettings(projectPath: string) {
+        const FRAMEWORK_TYPES = ["OpenUI5", "SAPUI5"];
+        const content = fs.readFileSync(path.join(projectPath, "ui5.yaml"), { encoding: "utf-8" });
+        const yamlJson = <any>yaml.load(content);
+        const framework = yamlJson["framework"];
+        if (!FRAMEWORK_TYPES.includes(framework.name)) {
+            throw new Error(`UI5 framework name is incorrect, possible values: ${FRAMEWORK_TYPES.join(" or ")}`);
+        }
+        if (!semver.valid(framework.version)) {
+            throw new Error(`UI5 framework version should correspond semantic version standard, e.g: 1.85.2`);
+        }
+    }
+
+    static getBundledUI5Version(destination: string) {
+        const bundleFilePath = path.join(process.cwd(), destination);
+        if (fs.existsSync(bundleFilePath)) {
+            const bundle = fs.readFileSync(bundleFilePath, { encoding: "utf-8" });
+            const version = bundle.substring(2, bundle.indexOf("\n"));
+            return semver.coerce(version);
+        }
+    }
+
+    static async run(destination: string): Promise<void> {
+        const bundledUI5Version = this.getBundledUI5Version(destination);
+        const project = await this.getProjectInfo(projectPaths);
+        if (!project) {
+            throw new Error("ui5.yaml is not found or incorrect");
+        }
+        const isSapUiFl = (dependency: any) => dependency.id.endsWith("/sap.ui.fl");
+        const sapUiFlDependency = project.dependencies.find(isSapUiFl);
+        if (bundledUI5Version == null || sapUiFlDependency && semver.lt(bundledUI5Version, sapUiFlDependency.version)) {
+            if (sapUiFlDependency.version) {
+                log.info(`[ROLLUP] New UI5 version ${sapUiFlDependency.version.toString()} available to bundle`);
+            }
+            const inputOptions = <rollup.RollupOptions>{
+                input: "bundleDefinition.js",
+                plugins: [
+                    ui5({
+                        assets: [
+                            "/resources/sap/ui/fl/**",
+                            "/resources/sap/suite/ui/generic/template/**"
+                        ],
+                        skipTransformation: [
+                            "bundleDefinition.js",
+                            "sap/ui/thirdparty/URI"
+                        ],
+                        output: destination,
+                        project: project,
+                        ui5version: sapUiFlDependency.version
+                    }),
+                    nodeResolve({
+                        preferBuiltins: true
+                    })
+                ],
+                external: builtins
+            }
+            const bundle = await rollup.rollup(inputOptions);
+
+            const outputOptions = <rollup.RollupOptions>{
+                file: destination,
+                format: "commonjs"
+            }
+            await bundle.write(outputOptions);
+            await bundle.close();
+        } else {
+            log.info(`[ROLLUP] UI5 version ${bundledUI5Version!.toString()} is already bundled`);
+        }
+
+    }
+}
+
+if (process.argv.length === 3) {
+    Builder.run(process.argv[2]);
+}