feat: Switch Adaptation Project's generator/wizard to use Open Source writers

.changeset/famous-panthers-occur.md

@@ -0,0 +1,7 @@
+---
+'@sap-ux/adp-tooling': minor
+'@sap-ux/preview-middleware': patch
+'@sap-ux/axios-extension': patch
+---
+
+Adds writer functionality for generation of adaptation projects

packages/adp-tooling/src/types.ts

@@ -1,6 +1,7 @@
 import type { UI5FlexLayer } from '@sap-ux/project-access';
 import type { DestinationAbapTarget, UrlAbapTarget } from '@sap-ux/system-access';
-import type { Adp } from '@sap-ux/ui5-config';
+import type { Adp, BspApp } from '@sap-ux/ui5-config';
+import type { OperationsType } from '@sap-ux/axios-extension';
 import type { Editor } from 'mem-fs-editor';
 
 export interface DescriptorVariant {
@@ -31,19 +32,34 @@ export interface AdpWriterConfig {
         reference: string;
         layer?: UI5FlexLayer;
         title?: string;
+        content?: Content[];
     };
     target: AbapTarget;
     ui5?: {
         minVersion?: string;
+        version?: string;
+        frameworkUrl?: string;
     };
     package?: {
         name?: string;
         description?: string;
     };
+    flp?: {
+        title?: string;
+        subtitle?: string;
+        inboundId?: string;
+        bspName?: string;
+        languages?: Language[];
+        credentials?: {
+            username: string;
+            password: string;
+        };
+    };
+    customConfig?: AdpCustomConfig;
     /**
      * Optional: configuration for deployment to ABAP
      */
-    deploy?: Adp;
+    deploy?: Adp | BspApp;
     options?: {
         /**
          * Optional: if set to true then the generated project will be recognized by the SAP Fiori tools
@@ -52,6 +68,11 @@ export interface AdpWriterConfig {
     };
 }
 
+export interface Language {
+    sap: string;
+    i18n: string;
+}
+
 export interface ManifestAppdescr {
     fileName: string;
     layer: string;
@@ -171,6 +192,7 @@ export type IWriterData<T extends ChangeType> = IWriter<GeneratorData<T>>;
  *
  * @template T - The specific type of data the writer will handle, determined by the associated ChangeType.
  */
+
 export interface IWriter<T> {
     /**
      * Writes the provided data to the project.
@@ -340,3 +362,10 @@ export interface AdpProjectData {
     reference: string;
     id: string;
 }
+
+export interface AdpCustomConfig {
+    adp: {
+        safeMode: boolean;
+        environment: OperationsType;
+    };
+}

packages/adp-tooling/src/writer/index.ts

@@ -1,10 +1,12 @@
 import { join } from 'path';
 import { create as createStorage } from 'mem-fs';
-import type { Editor } from 'mem-fs-editor';
-import { create } from 'mem-fs-editor';
+import { create, type Editor } from 'mem-fs-editor';
 import type { AdpWriterConfig } from '../types';
-import { UI5Config } from '@sap-ux/ui5-config';
-import { enhanceUI5Yaml, enhanceUI5DeployYaml, hasDeployConfig } from './options';
+import {
+    writeTemplateToFolder,
+    writeUI5Yaml,
+    writeUI5DeployYaml,
+} from './project-utils';
 
 const tmplPath = join(__dirname, '../../templates/project');
 
@@ -20,7 +22,9 @@ function setDefaults(config: AdpWriterConfig): AdpWriterConfig {
         target: { ...config.target },
         ui5: { ...config.ui5 },
         deploy: config.deploy ? { ...config.deploy } : undefined,
-        options: { ...config.options }
+        options: { ...config.options },
+        flp: config.flp ? { ...config.flp } : undefined,
+        customConfig: config.customConfig ? { ...config.customConfig } : undefined,
     };
     configWithDefaults.app.title ??= `Adaptation of ${config.app.reference}`;
     configWithDefaults.app.layer ??= 'CUSTOMER_BASE';
@@ -32,21 +36,6 @@ function setDefaults(config: AdpWriterConfig): AdpWriterConfig {
     return configWithDefaults;
 }
 
-async function writeUi5Yaml(basePath: string, config: AdpWriterConfig, fs: Editor) {
-    // ui5.yaml
-    const ui5ConfigPath = join(basePath, 'ui5.yaml');
-    const baseUi5ConfigContent = fs.read(ui5ConfigPath);
-    const ui5Config = await UI5Config.newInstance(baseUi5ConfigContent);
-    enhanceUI5Yaml(ui5Config, config);
-    fs.write(ui5ConfigPath, ui5Config.toString());
-    // ui5-deploy.yaml
-    if (hasDeployConfig(config)) {
-        const ui5DeployConfig = await UI5Config.newInstance(baseUi5ConfigContent);
-        enhanceUI5DeployYaml(ui5DeployConfig, config);
-        fs.write(join(basePath, 'ui5-deploy.yaml'), ui5DeployConfig.toString());
-    }
-}
-
 /**
  * Writes the adp-project template to the mem-fs-editor instance.
  *
@@ -59,14 +48,12 @@ export async function generate(basePath: string, config: AdpWriterConfig, fs?: E
     if (!fs) {
         fs = create(createStorage());
     }
-    const fullConfig = setDefaults(config);
 
-    fs.copyTpl(join(tmplPath, '**/*.*'), join(basePath), fullConfig, undefined, {
-        globOptions: { dot: true },
-        processDestinationPath: (filePath: string) => filePath.replace(/gitignore.tmpl/g, '.gitignore')
-    });
+    const fullConfig = setDefaults(config);
 
-    await writeUi5Yaml(basePath, fullConfig, fs);
+    writeTemplateToFolder(join(tmplPath, '**/*.*'), join(basePath), fullConfig, fs);
+    await writeUI5DeployYaml(basePath, fullConfig, fs);
+    await writeUI5Yaml(basePath, fullConfig, fs);
 
     return fs;
 }
@@ -109,7 +96,8 @@ export async function migrate(basePath: string, config: AdpWriterConfig, fs?: Ed
         fs.delete(join(basePath, 'neo-app.json'));
     }
 
-    await writeUi5Yaml(basePath, fullConfig, fs);
+    await writeUI5Yaml(basePath, fullConfig, fs);
+    await writeUI5DeployYaml(basePath, fullConfig, fs);
 
     return fs;
-}
+}

packages/adp-tooling/src/writer/options.ts

@@ -1,5 +1,5 @@
-import type { CustomMiddleware, UI5Config } from '@sap-ux/ui5-config';
-import type { AdpWriterConfig } from '../types';
+import type { CustomMiddleware, UI5Config, CustomTask, AbapTarget } from '@sap-ux/ui5-config';
+import type { AdpCustomConfig, AdpWriterConfig, Language } from '../types';
 
 /**
  * Generate the configuration for the middlewares required for the ui5.yaml.
@@ -9,9 +9,34 @@ import type { AdpWriterConfig } from '../types';
  */
 export function enhanceUI5Yaml(ui5Config: UI5Config, config: AdpWriterConfig) {
     const middlewares = config.options?.fioriTools ? getFioriToolsMiddlwares(config) : getOpenSourceMiddlewares(config);
+    ui5Config.setConfiguration({ propertiesFileSourceEncoding: 'UTF-8' });
     ui5Config.addCustomMiddleware(middlewares);
 }
 
+/**
+ * Generate the configuration for the custom tasks required for the ui5.yaml.
+ *
+ * @param ui5Config configuration representing the ui5.yaml
+ * @param config full project configuration
+ */
+export function enhanceUI5YamlWithCustomTask(ui5Config: UI5Config, config: AdpWriterConfig) {
+    const tasks = getAdpCloudCustomTasks(config);
+    ui5Config.addCustomTasks(tasks);
+}
+
+/**
+ * Generate custom configuration required for the ui5.yaml.
+ *
+ * @param ui5Config configuration representing the ui5.yaml
+ * @param config full project configuration
+ */
+export function enhanceUI5YamlWithCustomConfig(ui5Config: UI5Config, config?: AdpCustomConfig) {
+    if (config?.adp) {
+        const { safeMode } = config.adp;
+        ui5Config.addCustomConfiguration('adp', { safeMode });
+    }
+}
+
 /**
  * Writer configuration with deploy configuration.
  */
@@ -46,8 +71,17 @@ export function enhanceUI5DeployYaml(ui5Config: UI5Config, config: AdpWriterConf
 function getFioriToolsMiddlwares(config: AdpWriterConfig): CustomMiddleware<unknown>[] {
     return [
         {
-            name: 'fiori-tools-preview',
+            name: 'fiori-tools-appreload',
             afterMiddleware: 'compression',
+            configuration: {
+              port: 35729,
+              path: 'webapp',
+              delay: 300,
+            }
+        },
+        {
+            name: 'fiori-tools-preview',
+            afterMiddleware: 'fiori-tools-appreload',
             configuration: {
                 adp: {
                     target: config.target,
@@ -61,8 +95,9 @@ function getFioriToolsMiddlwares(config: AdpWriterConfig): CustomMiddleware<unkn
             configuration: {
                 ignoreCertErrors: false,
                 ui5: {
+                    version: config?.ui5?.minVersion,
                     path: ['/resources', '/test-resources'],
-                    url: 'https://ui5.sap.com'
+                    url: config?.ui5?.frameworkUrl ?? 'https://ui5.sap.com'
                 },
                 backend: [
                     {
@@ -83,6 +118,15 @@ function getFioriToolsMiddlwares(config: AdpWriterConfig): CustomMiddleware<unkn
  */
 function getOpenSourceMiddlewares(config: AdpWriterConfig): CustomMiddleware<object | undefined>[] {
     return [
+        {
+            name: 'reload-middleware',
+            afterMiddleware: 'compression',
+            configuration: {
+              port: 35729,
+              path: 'webapp',
+              delay: 300,
+            }
+        },
         {
             name: 'preview-middleware',
             afterMiddleware: 'compression',
@@ -120,3 +164,36 @@ function getOpenSourceMiddlewares(config: AdpWriterConfig): CustomMiddleware<obj
         }
     ];
 }
+
+/**
+ * Get a list of required custom tasks for S4.
+ *
+ * @param config full project configuration
+ * @returns list of required tasks.
+ */
+function getAdpCloudCustomTasks(config: AdpWriterConfig & { target: AbapTarget }): CustomTask[] {
+    const user = 'env:FIORI_TOOLS_USER';
+    const pass = 'env:FIORI_TOOLS_PASSWORD';
+
+    return [
+        {
+            name: 'app-variant-bundler-build',
+            beforeTask: 'escapeNonAsciiCharacters',
+            configuration: {
+                type: 'abap',
+                destination: config.target?.destination,
+                appName: config?.flp?.bspName,
+                languages: config?.flp?.languages?.map((language: Language) => {
+                    return {
+                        sap: language.sap,
+                        i18n: language.i18n
+                    };
+                }),
+                credentials: {
+                    username: user,
+                    password: pass
+                }
+            }
+        }
+    ];
+}

packages/adp-tooling/src/writer/project-utils.ts

@@ -0,0 +1,84 @@
+import { join } from 'path';
+import type { Editor } from 'mem-fs-editor';
+import { AdpWriterConfig } from '../types';
+import {
+    enhanceUI5DeployYaml,
+    enhanceUI5Yaml,
+    hasDeployConfig,
+    enhanceUI5YamlWithCustomConfig,
+    enhanceUI5YamlWithCustomTask
+} from './options';
+import { UI5Config } from '@sap-ux/ui5-config';
+
+/**
+ * Writes a given project template files within a specified folder in the project directory.
+ *
+ * @param {string} templatePath - The root path of the project template.
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfModuleData | AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export function writeTemplateToFolder(
+    templatePath: string,
+    projectPath: string,
+    data: AdpWriterConfig,
+    fs: Editor,
+): void {
+    try {
+        fs.copyTpl(templatePath, projectPath, data, undefined, {
+            globOptions: { dot: true },
+            processDestinationPath: (filePath: string) => filePath.replace(/gitignore.tmpl/g, '.gitignore')
+        });
+    } catch (e) {
+        throw new Error(`Could not write template files to folder. Reason: ${e.message}`);
+    }
+}
+
+/**
+ * Writes a ui5.yaml file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export async function writeUI5Yaml(projectPath: string, data: AdpWriterConfig, fs: Editor): Promise<void> {
+    try {
+        const ui5ConfigPath = join(projectPath, 'ui5.yaml');
+        const baseUi5ConfigContent = fs.read(ui5ConfigPath);
+        const ui5Config = await UI5Config.newInstance(baseUi5ConfigContent);
+        enhanceUI5Yaml(ui5Config, data);
+        enhanceUI5YamlWithCustomConfig(ui5Config, data?.customConfig);
+        if (data.customConfig?.adp?.environment === "C") {
+            enhanceUI5YamlWithCustomTask(ui5Config, data);
+        }
+
+        fs.write(ui5ConfigPath, ui5Config.toString());
+    } catch (e) {
+        throw new Error(`Could not write ui5.yaml file. Reason: ${e.message}`);
+    }
+}
+
+/**
+ * Writes a ui5-deploy.yaml file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export async function writeUI5DeployYaml(projectPath: string, data: AdpWriterConfig, fs: Editor): Promise<void> {
+    try {
+        if (hasDeployConfig(data)) {
+            const ui5ConfigPath = join(projectPath, 'ui5.yaml');
+            const baseUi5ConfigContent = fs.read(ui5ConfigPath);
+            const ui5DeployConfig = await UI5Config.newInstance(baseUi5ConfigContent);
+            enhanceUI5DeployYaml(ui5DeployConfig, data);
+
+            fs.write(join(projectPath, 'ui5-deploy.yaml'), ui5DeployConfig.toString());
+        }
+    } catch (e) {
+        throw new Error(`Could not write ui5-deploy.yaml file. Reason: ${e.message}`);
+    }
+}