@ui5/task-adaptation 1.6.0 → 1.6.1

package/dist/util/renamingHandlers/jsonRenamingHandler.js

@@ -0,0 +1,34 @@
+export default class JsonRenamingHandler {
+    original = new Map();
+    before(files) {
+        const content = files.get(this.filePath);
+        if (content) {
+            const json = JSON.parse(content);
+            this.jsonPathsToRestore.forEach(path => this.store(json, path));
+        }
+    }
+    after(files) {
+        const content = files.get(this.filePath);
+        if (content) {
+            const json = JSON.parse(content);
+            this.restore(json);
+            files.set(this.filePath, JSON.stringify(json));
+        }
+    }
+    store(obj, path) {
+        this.original.set(path, this.getByPath(obj, path.split("/")));
+    }
+    restore(obj) {
+        this.original.forEach((value, path) => this.setByPath(obj, value, path.split("/")));
+    }
+    getByPath(obj, path) {
+        return path.reduce((o, p) => (o && o[p]) || undefined, obj);
+    }
+    setByPath(obj, value, path) {
+        const target = this.getByPath(obj, path.slice(0, -1));
+        if (target) {
+            target[path[path.length - 1]] = value;
+        }
+    }
+}
+//# sourceMappingURL=jsonRenamingHandler.js.map

package/dist/util/renamingHandlers/manifestRenamingHandler.d.ts

@@ -1,6 +1,5 @@
-import { IRenamingHandler } from "./renamingHandler.js";
-export default class ManifestRenamingHandler implements IRenamingHandler {
-    private appVariantIdHierarchy;
-    before(files: ReadonlyMap<string, string>): void;
-    after(files: Map<string, string>): void;
+import JsonRenamingHandler from "./jsonRenamingHandler.js";
+export default class ManifestRenamingHandler extends JsonRenamingHandler {
+    protected readonly filePath = "manifest.json";
+    protected readonly jsonPathsToRestore: string[];
 }

package/dist/util/renamingHandlers/manifestRenamingHandler.js

@@ -1,20 +1,9 @@
-export default class ManifestRenamingHandler {
-    appVariantIdHierarchy = [];
-    before(files) {
-        const manifest = files.get("manifest.json");
-        if (manifest) {
-            const manifestJson = JSON.parse(manifest);
-            this.appVariantIdHierarchy = manifestJson["sap.ui5"].appVariantIdHierarchy;
-        }
-    }
-    after(files) {
-        const manifest = files.get("manifest.json");
-        if (manifest) {
-            const manifestJson = JSON.parse(manifest);
-            manifestJson["sap.ui5"].appVariantIdHierarchy = this.appVariantIdHierarchy;
-            files.set("manifest.json", JSON.stringify(manifestJson));
-        }
-    }
-    ;
+import JsonRenamingHandler from "./jsonRenamingHandler.js";
+export default class ManifestRenamingHandler extends JsonRenamingHandler {
+    filePath = "manifest.json";
+    // path to the JSON properties, forward slash separated, e.g. "sap.ui5/appVariantIdHierarchy"
+    jsonPathsToRestore = [
+        "sap.ui5/appVariantIdHierarchy"
+    ];
 }
 //# sourceMappingURL=manifestRenamingHandler.js.map

package/dist/util/requestUtil.d.ts

@@ -1,7 +1,7 @@
 import { AxiosRequestConfig } from "axios";
 export default class RequestUtil {
     static head(url: string): Promise<any>;
-    static get(url: string, options?: any): Promise<any>;
+    static get(url: string, options: any, expectedStatus?: number): Promise<any>;
     static request(url: string, method: (url: string, config?: AxiosRequestConfig) => any, options?: any): Promise<any>;
     private static handleError;
 }

package/dist/util/requestUtil.js

@@ -4,8 +4,11 @@ export default class RequestUtil {
     static async head(url) {
         return this.request(url, axios.head);
     }
-    static async get(url, options) {
-        return this.request(url, axios.get, options).then(response => response.data);
+    static async get(url, options, expectedStatus = 200) {
+        return this.request(url, axios.get, {
+            ...options,
+            validateStatus: (status) => status === expectedStatus
+        }).then(response => response.data);
     }
     static async request(url, method, options) {
         try {

package/dist/util/resourceUtil.d.ts

@@ -6,16 +6,9 @@ export default class ResourceUtil {
     static writeInProject(dir: string, files: Map<string, string>): Promise<void[]>;
     static byGlob(dir: string, pattern: string, excludes?: string[]): Promise<Map<string, string>>;
     static byGlobInProject(pattern: string, excludes?: string[]): Promise<Map<string, string>>;
-    static readInProject(filepath: string): Promise<string>;
     static getString(resource: any): Promise<string>;
     static getJson(resource: any): Promise<any>;
     static setString(resource: any, str: string): void;
-    /**
-     * Check whether a file or directory exists (non-throwing).
-     * @param filePath Absolute or relative path
-     * @returns true if the path exists, false if not
-     */
-    private static fileExists;
     static createResource(filename: string, projectNamespace: string, content: string): any;
     static toFileMap(resources: ReadonlyArray<Resource>, projectNamespace?: string): Promise<Map<string, string>>;
 }

package/dist/util/resourceUtil.js

@@ -1,6 +1,5 @@
 import * as resourceFactory from "@ui5/fs/resourceFactory";
 import { posix as path } from "path";
-import * as fs from "fs/promises";
 const UTF8 = "utf8";
 export default class ResourceUtil {
     static getRootFolder(projectNamespace) {
@@ -78,24 +77,6 @@ export default class ResourceUtil {
             "/.adp/reuse"
         ].concat(excludes));
     }
-    /*
-     * Read the file by filepath from the project root (folder where 'webapp',
-     * 'package.json', 'ui5.yaml' located).
-     * @param filepath The relative file path from the project root (e.g. 'ui5AppInfo.json').
-     * @returns A promise that resolves to the file content as a string.
-     */
-    static async readInProject(filepath) {
-        try {
-            return await fs.readFile(path.resolve(process.cwd(), filepath), UTF8);
-        }
-        catch (error) {
-            const isProjectRoot = await ResourceUtil.fileExists(path.join(process.cwd(), "ui5.yaml"));
-            if (!isProjectRoot) {
-                throw new Error(`Please make sure that build has been started from the project root: ${error?.message ?? ""}`);
-            }
-            throw error;
-        }
-    }
     static getString(resource) {
         return resource.getBuffer().then((buffer) => buffer.toString(UTF8));
     }
@@ -105,23 +86,6 @@ export default class ResourceUtil {
     static setString(resource, str) {
         resource.setBuffer(Buffer.from(str, UTF8));
     }
-    /**
-     * Check whether a file or directory exists (non-throwing).
-     * @param filePath Absolute or relative path
-     * @returns true if the path exists, false if not
-     */
-    static async fileExists(filePath) {
-        try {
-            await fs.access(filePath);
-            return true;
-        }
-        catch (e) {
-            if (e?.code === "ENOENT") {
-                return false;
-            }
-            throw e;
-        }
-    }
     static createResource(filename, projectNamespace, content) {
         return resourceFactory.createResource({
             path: this.getResourcePath(projectNamespace, filename),

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.6.0",
+    "version": "1.6.1",
     "description": "Custom task for ui5-builder which allows building UI5 Flexibility Adaptation Projects for SAP BTP, Cloud Foundry environment",
     "main": "index.js",
     "scripts": {
@@ -114,7 +114,8 @@
             "src/annotations/comparator/diffCase.ts",
             "src/annotations/transformers/transformer.ts",
             "src/model/configuration.ts",
-            "src/model/appVariantIdHierarchyItem.ts"
+            "src/model/appVariantIdHierarchyItem.ts",
+            "src/adapters/adapter.ts"
         ],
         "check-coverage": true,
         "statements": 85,

package/dist/util/movingHandler/fileMoveHandler.d.ts

@@ -1,8 +0,0 @@
-export declare const moveFiles: (inputFiles: ReadonlyMap<string, string>, prefix: string, id: string) => {
-    files: Map<string, string>;
-    renamingPaths: Map<string, string>;
-};
-export declare const moveFile: (filename: string, content: string, prefix: string, id: string) => {
-    newFilename: string;
-    renamingPath: Map<string, string>;
-};

package/dist/util/movingHandler/fileMoveHandler.js

@@ -1,77 +0,0 @@
-import path from "path";
-import { isManifestChange } from "../commonUtil.js";
-const EXT_DIR = "ext/";
-const CHANGES_DIR = "changes/";
-const nameSpaceRegex = new RegExp(`(?<=ControllerExtension.extend\\(")([^"]*)(?=")`);
-/**
-* 2p. We move to appVariantFolder (prefix) only files that go along the
-* change files, like js or fragments. Changes are renamed in resources,
-* packed in flexibility-bundle and removed.
-* @param filename - The filename relative to the root
-*/
-function shouldMove(filename, content) {
-    //TODO: is it more reliable to check change/fileType?
-    if (isManifestChange(filename, content)) {
-        return true;
-    }
-    return filename.startsWith(CHANGES_DIR) && [".change", ".variant", ".ctrl_variant", ".ctrl_variant_change", ".ctrl_variant_management_change"].every(ext => !filename.endsWith(ext))
-        || filename.startsWith(EXT_DIR);
-}
-/**
- * For controller extension the namespace needs a prefix
- * The namespace needs to be unique for clear identification
- * If controller extension have the same namespace the last one will be used
- * @param filename  - The filename relative to the root
- * @returns
- */
-function shouldNamespaceRenamed(filename) {
-    return filename.startsWith(CHANGES_DIR) && filename.endsWith(".js");
-}
-/**
- * Returns path without first directory (which is usually "changes" or
- * "ext") and without file extension. For example, for
- * "changes/coding/FixingDay.js" it returns "coding/FixingDay", for
- * "changes/customer_app_variant5/fragments/hello_world_fixing_day.fragment.xml"
- * it returns
- * "changes/customer_app_variant5/fragments/hello_world_fixing_day". We
- * remove all extensions not to rename it with slashes instead of dots. And
- * we also exclude "changes" or "ext" include the prefix after them and then
- * the filename. Without 'changes' or 'ext' directory, we need to replace
- * only rest: coding/FixingDay.js to app_var_id1/coding/FixingDay.js
- * @param filename
- * @returns
- */
-function getPathWithoutExtensions(filename) {
-    const [_dir, ...rest] = filename.split("/");
-    const restWOExt = [...rest];
-    restWOExt[restWOExt.length - 1] = restWOExt[restWOExt.length - 1].split(".")[0];
-    return restWOExt.join("/");
-}
-export const moveFiles = (inputFiles, prefix, id) => {
-    const files = new Map();
-    let renamingPaths = new Map();
-    inputFiles.forEach((content, filename) => {
-        const { newFilename, renamingPath } = moveFile(filename, content, prefix, id);
-        files.set(newFilename, content);
-        renamingPaths = new Map([...renamingPaths, ...renamingPath]);
-    });
-    return { files, renamingPaths };
-};
-export const moveFile = (filename, content, prefix, id) => {
-    let newFilename = filename;
-    let renamingPath = new Map();
-    if (shouldMove(filename, content)) {
-        const [dir, ...rest] = filename.split("/");
-        newFilename = path.join(dir, prefix, rest.join("/"));
-        const restWOExtPath = getPathWithoutExtensions(filename);
-        renamingPath.set(restWOExtPath, path.join(prefix, restWOExtPath));
-    }
-    if (shouldNamespaceRenamed(filename)) {
-        const namespaceMatch = nameSpaceRegex.exec(content.trim());
-        const controllerExtensionPath = namespaceMatch ? namespaceMatch[0] : "";
-        const fileName = controllerExtensionPath.replace(id, "");
-        renamingPath.set(controllerExtensionPath, `${id}.${prefix}${fileName}`);
-    }
-    return { newFilename, renamingPath };
-};
-//# sourceMappingURL=fileMoveHandler.js.map

package/scripts/publish.ts

@@ -1,256 +0,0 @@
-import { promises as fs } from "fs";
-import path from "path";
-import yargs from "yargs";
-import { hideBin } from "yargs/helpers";
-import { Octokit } from "@octokit/rest";
-import { retry } from "@octokit/plugin-retry";
-
-const OctokitClass = Octokit.plugin(retry);
-
-
-/**
- * Recursively get all file paths in the workspace root, excluding:
- *   - test/lib/integration
- *   - test/fixtures
- *   - test/expected
- *   - test/lib/index.perf.ts
- * Returns relative paths from the root.
- */
-async function getAllRootFilesExceptTestExclusions(root: string): Promise<string[]> {
-    const excludeDirs = [
-        "test/lib/integration",
-        "test/fixtures",
-        "test/expected",
-        ".git",
-        "coverage",
-        ".DS_Store",
-        "node_modules",
-        ".nyc_output",
-        "coverage",
-        "dist",
-        "dist-debug",
-        "dist.zip",
-        ".env",
-        "test/resources/metadata/download"
-    ];
-    const excludeFiles = [
-        "test/lib/index.perf.ts",
-        "scripts/test-integration-prep.sh",
-        "Jenkinsfile"
-    ];
-
-    async function walk(dir: string): Promise<string[]> {
-        const dirents = await fs.readdir(dir, { withFileTypes: true });
-        const files: string[] = [];
-        for (const dirent of dirents) {
-            const relPath = path.relative(root, path.join(dir, dirent.name));
-            if (excludeDirs.some(ex => relPath === ex || relPath.startsWith(ex + path.sep))) {
-                continue;
-            }
-            if (excludeFiles.includes(relPath)) {
-                continue;
-            }
-            if (dirent.isDirectory()) {
-                files.push(...await walk(path.join(dir, dirent.name)));
-            } else {
-                files.push(relPath);
-            }
-        }
-        return files;
-    }
-    return walk(root);
-}
-
-const FILES = await getAllRootFilesExceptTestExclusions(process.cwd());
-
-
-interface PublishArgs {
-    p?: string;
-    dryRun?: boolean;
-    tag?: string;
-    branch?: string;
-    [key: string]: unknown;
-}
-
-async function publish() {
-    const argv = yargs(hideBin(process.argv))
-        .option("p", {
-            type: "string",
-            description: "GitHub token (-p)",
-            alias: "p"
-        })
-        .option("dryRun", {
-            type: "boolean",
-            description: "Run without publishing",
-            default: false
-        })
-        .option("tag", {
-            type: "string",
-            description: "Publish with a specific tag"
-        })
-        .option("branch", {
-            type: "string",
-            description: "Branch to update (default: main)",
-            default: "main",
-            alias: "b"
-        })
-        .help()
-        .alias("h", "help")
-        .parseSync() as PublishArgs;
-
-    if (argv.dryRun) {
-        console.log("Dry run: no publishing will be performed.");
-        return;
-    }
-    const auth = argv.p;
-    if (auth) {
-        const octokit = new OctokitClass({ auth });
-        const ORGANIZATION = "SAP";
-        const REPO = "ui5-task-adaptation";
-        await uploadToRepo(octokit, ORGANIZATION, REPO, argv.branch);
-        if (argv.tag) {
-            console.log(`Published with tag: ${argv.tag}`);
-        }
-    } else {
-        console.log("Github token is not provided.");
-    }
-}
-
-
-async function getLatestVersion(): Promise<string> {
-    const pkg = await fs.readFile(path.join(process.cwd(), "package.json"), { encoding: "utf-8" });
-    const pkgJson = JSON.parse(pkg);
-    return pkgJson.version;
-}
-
-
-async function uploadToRepo(
-    octokit: InstanceType<typeof OctokitClass>,
-    org: string,
-    repo: string,
-    branch: string = "main"
-): Promise<void> {
-    const fileBlobs = await Promise.all(Object.values(FILES).map(file => toBlob(octokit, org, repo, path.join(process.cwd(), file))));
-    const currentCommit = await getCurrentCommit(octokit, org, repo, branch);
-    const newTree = await createNewTree(
-        octokit,
-        org,
-        repo,
-        fileBlobs,
-        FILES,
-        currentCommit.treeSha
-    );
-    const currentVersion = await getLatestVersion();
-    const commitMessage = `Release ${currentVersion}`;
-    const newCommit = await createNewCommit(
-        octokit,
-        org,
-        repo,
-        commitMessage,
-        newTree.sha,
-        currentCommit.commitSha
-    );
-    await setBranchToCommit(octokit, org, repo, branch, newCommit.sha);
-}
-
-
-async function getCurrentCommit(
-    octokit: InstanceType<typeof OctokitClass>,
-    org: string,
-    repo: string,
-    branch: string = "main"
-): Promise<{ commitSha: string; treeSha: string }> {
-    const { data: refData } = await octokit.git.getRef({
-        owner: org,
-        repo,
-        ref: `heads/${branch}`,
-    });
-    const commitSha = refData.object.sha
-    const { data: commitData } = await octokit.git.getCommit({
-        owner: org,
-        repo,
-        commit_sha: commitSha,
-    });
-    return {
-        commitSha,
-        treeSha: commitData.tree.sha,
-    }
-}
-
-
-async function toBlob(
-    octokit: InstanceType<typeof OctokitClass>,
-    org: string,
-    repo: string,
-    filePath: string
-): Promise<{ sha: string }> {
-    const content = await fs.readFile(filePath, { encoding: "utf8" });
-    const blobData = await octokit.git.createBlob({
-        owner: org,
-        repo,
-        content,
-        encoding: "utf-8",
-    })
-    return blobData.data;
-}
-
-
-async function createNewTree(
-    octokit: InstanceType<typeof OctokitClass>,
-    owner: string,
-    repo: string,
-    blobs: { sha: string }[],
-    paths: string[],
-    parentTreeSha: string
-): Promise<any> {
-    const tree = blobs.map(({ sha }, i) => ({
-        path: paths[i],
-        mode: "100644" as const,
-        type: "blob" as const,
-        sha,
-    }));
-    const { data } = await octokit.git.createTree({
-        owner,
-        repo,
-        tree,
-        base_tree: parentTreeSha,
-    })
-    return data;
-}
-
-
-async function createNewCommit(
-    octokit: InstanceType<typeof OctokitClass>,
-    org: string,
-    repo: string,
-    message: string,
-    currentTreeSha: string,
-    currentCommitSha: string
-): Promise<any> {
-    const commit = await octokit.git.createCommit({
-        owner: org,
-        repo,
-        message,
-        tree: currentTreeSha,
-        parents: [currentCommitSha],
-    });
-    return commit.data;
-};
-
-
-async function setBranchToCommit(
-    octokit: InstanceType<typeof OctokitClass>,
-    org: string,
-    repo: string,
-    branch: string = "main",
-    commitSha: string
-): Promise<any> {
-    return octokit.git.updateRef({
-        owner: org,
-        repo,
-        ref: `heads/${branch}`,
-        sha: commitSha,
-    });
-}
-
-publish();

package/scripts/test-integration-prep.sh

@@ -1,4 +0,0 @@
-for d in test/fixtures/*/ ; do
-    echo "$d"
-    npm --prefix $d i
-done