Move cap updates to generate functions of FE/FF (#2810)

* add enable npm workspaces to appOptions

* removing unecessary console logs

* removing debugger

* lint issues

* Linting auto fix commit

* unit tests

* Linting auto fix commit

* remove unused reference to package type

* sonar qube fix

* add documentation to enable npm workspaces type

* add enableNPMWorkspaces doc to f-f-w

* add comment

* Move  and  types from  to

* remve old changeset

* Linting auto fix commit

* enable npm workspace comment

* js doc fix

* Linting auto fix commit

* js doc fix

* Linting auto fix commit

* remove enable npm workspace options from ff and fe appOptions

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Austin Devine <[email protected]>

Author: 3 people

.changeset/friendly-toes-beg.md

@@ -0,0 +1,8 @@
+---
+'@sap-ux/odata-service-inquirer': major
+'@sap-ux/cap-config-writer': minor
+'@sap-ux/fiori-freestyle-writer': patch
+'@sap-ux/fiori-elements-writer': patch
+---
+
+Move `CapService` and `CapRuntime` types from `@sap-ux/odata-service-inquirer` to `@sap-ux/cap-config-writer` for better relevance; add CAP updates to generate functions of Fiori Elements and Freestyle writers

packages/cap-config-writer/package.json

@@ -39,7 +39,6 @@
         "xml-js": "1.6.11"
     },
     "devDependencies": {
-        "@sap-ux/odata-service-inquirer": "workspace:*",
         "@types/mem-fs": "1.1.2",
         "@types/mem-fs-editor": "7.0.1",
         "@types/semver": "7.5.2"

packages/cap-config-writer/src/cap-config/types.ts

@@ -1,4 +1,4 @@
-import type { CapService } from '@sap-ux/odata-service-inquirer';
+import type { CdsVersionInfo } from '@sap-ux/project-access';
 
 export type CdsUi5PluginInfo = {
     /**
@@ -19,6 +19,40 @@ export type CdsUi5PluginInfo = {
     hasCdsUi5Plugin: boolean;
 };
 
+export type CapRuntime = 'Node.js' | 'Java';
+
+export interface CapService {
+    /**
+     * The path to the CAP project.
+     */
+    projectPath: string;
+    /**
+     * The CDS info for the Cds instance that was used to compile the project when determining the service.
+     */
+    cdsVersionInfo?: CdsVersionInfo;
+    /**
+     * The name of the CAP service as identified by the cds model.
+     */
+    serviceName: string;
+    /**
+     * The URL path to the service, as specfied in the manifest.json of generated apps
+     * This is also provided as `OdataServicePromptAnswers` property `servicePath`
+     */
+    urlPath?: string;
+    /**
+     * The relative path (from the `projectPath`) to the service cds file.
+     */
+    serviceCdsPath?: string;
+    /**
+     * The runtime of the Cds instance that was used to compile the project when determining the service.
+     */
+    capType?: CapRuntime;
+    /**
+     * The relative path (from the `projectPath`) to the app folder
+     */
+    appPath?: string;
+}
+
 export interface CapServiceCdsInfo extends CapService {
     cdsUi5PluginInfo: CdsUi5PluginInfo;
 }

packages/cap-config-writer/src/cap-writer/utils.ts

@@ -1,5 +1,5 @@
 import { t } from '../i18n';
-import type { CapRuntime } from '@sap-ux/odata-service-inquirer';
+import type { CapRuntime } from '../cap-config/types';
 
 /**
  * Returns the url to the specified cap app as served by `cds serve` or `cds watch`.

packages/cap-config-writer/src/index.ts

@@ -1,3 +1,4 @@
 export { checkCdsUi5PluginEnabled, enableCdsUi5Plugin, satisfiesMinCdsVersion } from './cap-config';
+export type { CapService, CapRuntime } from './cap-config/types';
 export type { CdsUi5PluginInfo, CapServiceCdsInfo, CapProjectSettings } from './cap-config/types';
 export * from './cap-writer';

packages/cap-config-writer/test/unit/cap-writer/package-json.test.ts

@@ -1,4 +1,4 @@
-import type { CapRuntime } from '@sap-ux/odata-service-inquirer';
+import type { CapRuntime } from '../../../src/cap-config/types';
 import { satisfiesMinCdsVersion } from '../../../src/cap-config/package-json';
 import memFs from 'mem-fs';
 import { ToolsLogger } from '@sap-ux/logger';

packages/cap-config-writer/tsconfig.json

@@ -16,9 +16,6 @@
     {
       "path": "../logger"
     },
-    {
-      "path": "../odata-service-inquirer"
-    },
     {
       "path": "../project-access"
     },

packages/fiori-elements-writer/package.json

@@ -37,6 +37,7 @@
         "@sap-ux/ui5-config": "workspace:*",
         "@sap-ux/ui5-test-writer": "workspace:*",
         "@sap-ux/fiori-generator-shared": "workspace:*",
+        "@sap-ux/cap-config-writer": "workspace:*",
         "ejs": "3.1.10",
         "i18next": "20.6.1",
         "lodash": "4.17.21",

packages/fiori-elements-writer/src/index.ts

@@ -21,6 +21,7 @@ import semVer from 'semver';
 import { initI18n } from './i18n';
 import { getBootstrapResourceUrls, getPackageScripts } from '@sap-ux/fiori-generator-shared';
 import { generateFpmConfig } from './fpmConfig';
+import { applyCAPUpdates, type CapProjectSettings } from '@sap-ux/cap-config-writer';
 
 export const V2_FE_TYPES_AVAILABLE = '1.108.0';
 /**
@@ -206,6 +207,21 @@ async function generate<T extends {}>(basePath: string, data: FioriElementsApp<T
             fs
         );
     }
+    if (feApp.service.capService) {
+        const hasCdsUi5PluginInfo = !!feApp.service.capService.cdsUi5PluginInfo;
+        const settings: CapProjectSettings = {
+            appRoot: basePath,
+            packageName: feApp.package.name ?? '',
+            appId: feApp.app.id,
+            sapux: feApp.appOptions?.sapux,
+            enableTypescript: feApp.appOptions?.typescript,
+            // Enable CDS UI5 plugin and NPM workspaces if the CDS UI5 plugin info is present
+            enableCdsUi5Plugin: hasCdsUi5PluginInfo,
+            enableNPMWorkspaces: hasCdsUi5PluginInfo
+        };
+        // apply cap updates when service is cap
+        await applyCAPUpdates(fs, feApp.service.capService, settings);
+    }
 
     return fs;
 }

packages/fiori-elements-writer/src/types.ts

@@ -1,5 +1,6 @@
 import type { Ui5App, App, AppOptions } from '@sap-ux/ui5-application-writer';
 import type { OdataService } from '@sap-ux/odata-service-writer';
+import type { CapServiceCdsInfo } from '@sap-ux/cap-config-writer';
 
 export const TemplateType = {
     Worklist: 'worklist',
@@ -109,7 +110,9 @@ export interface FioriApp extends App {
 
 export interface FioriElementsApp<T> extends Ui5App {
     template: Template<T>;
-    service: Omit<OdataService, 'model'>; // Model name will use defaults
+    service: Omit<OdataService, 'model'> & {
+        capService?: CapServiceCdsInfo;
+    };
     app: FioriApp;
     appOptions: Partial<AppOptions> & {
         /**

packages/fiori-elements-writer/test/lrop.test.ts

@@ -2,6 +2,7 @@ import type { FioriElementsApp, LROPSettings } from '../src';
 import { generate, TableType, TemplateType } from '../src';
 import { join } from 'path';
 import { removeSync } from 'fs-extra';
+import { OdataVersion } from '@sap-ux/odata-service-writer';
 import {
     testOutputDir,
     debug,
@@ -17,6 +18,9 @@ import {
 } from './common';
 import { ServiceType } from '@sap-ux/odata-service-writer';
 import { type OdataService } from '@sap-ux/odata-service-writer';
+import { applyCAPUpdates, type CapServiceCdsInfo } from '@sap-ux/cap-config-writer';
+import { create as createStorage } from 'mem-fs';
+import { create } from 'mem-fs-editor';
 
 const TEST_NAME = 'lropTemplates';
 if (debug?.enabled) {
@@ -32,6 +36,11 @@ jest.mock('read-pkg-up', () => ({
     })
 }));
 
+jest.mock('@sap-ux/cap-config-writer', () => ({
+    ...jest.requireActual('@sap-ux/cap-config-writer'),
+    applyCAPUpdates: jest.fn()
+}));
+
 describe(`Fiori Elements template: ${TEST_NAME}`, () => {
     const curTestOutPath = join(testOutputDir, TEST_NAME);
 
@@ -424,4 +433,89 @@ describe(`Fiori Elements template: ${TEST_NAME}`, () => {
         const packageJson = fs.readJSON(packageJsonPath);
         expect((packageJson as any)?.sapuxLayer).toBe('CUSTOMER_BASE');
     });
+
+    describe('CAP updates', () => {
+        const capProjectSettings = {
+            appRoot: curTestOutPath,
+            packageName: 'felrop1',
+            appId: 'felrop1',
+            sapux: true,
+            enableTypescript: undefined
+        };
+
+        const getFioriElementsApp = (capService?: CapServiceCdsInfo) => {
+            return {
+                ...Object.assign(feBaseConfig('felrop1'), {
+                    template: {
+                        type: TemplateType.ListReportObjectPage,
+                        settings: v4TemplateSettings
+                    }
+                }),
+                service: {
+                    version: OdataVersion.v4,
+                    capService
+                },
+                package: {
+                    ...feBaseConfig('felrop1').package,
+                    sapuxLayer: 'CUSTOMER_BASE'
+                }
+            } as FioriElementsApp<LROPSettings>;
+        };
+
+        afterEach(() => {
+            jest.clearAllMocks();
+            jest.resetAllMocks();
+        });
+
+        test('should perform CAP updates when CAP service is available and cds ui5 plugin is enabled', async () => {
+            const capService: CapServiceCdsInfo = {
+                cdsUi5PluginInfo: {
+                    isCdsUi5PluginEnabled: true,
+                    hasMinCdsVersion: true,
+                    isWorkspaceEnabled: true,
+                    hasCdsUi5Plugin: true
+                },
+                projectPath: 'test/path',
+                serviceName: 'test-service',
+                capType: 'Node.js'
+            };
+            const fs = create(createStorage());
+
+            const fioriElementsApp = getFioriElementsApp(capService);
+            await generate(curTestOutPath, fioriElementsApp, fs);
+            expect(applyCAPUpdates).toBeCalledTimes(1);
+
+            expect(applyCAPUpdates).toBeCalledWith(fs, capService, {
+                ...capProjectSettings,
+                enableNPMWorkspaces: true,
+                enableCdsUi5Plugin: true
+            });
+        });
+
+        test('should perform CAP updates when CAP service is available and cds ui5 plugin is disabled', async () => {
+            const fs = create(createStorage());
+            const capServiceWithoutCdsUi5PluginInfo = {
+                projectPath: 'test/path',
+                serviceName: 'test-service',
+                capType: 'Node.js'
+            };
+            const fioriElementsApp = getFioriElementsApp(capServiceWithoutCdsUi5PluginInfo as CapServiceCdsInfo);
+            await generate(curTestOutPath, fioriElementsApp, fs);
+
+            expect(applyCAPUpdates).toBeCalledTimes(1);
+            expect(applyCAPUpdates).toBeCalledWith(fs, capServiceWithoutCdsUi5PluginInfo, {
+                ...capProjectSettings,
+                enableNPMWorkspaces: false,
+                enableCdsUi5Plugin: false
+            });
+        });
+
+        test('should not perform CAP updates, when no cap service provided', async () => {
+            const fs = create(createStorage());
+
+            const fioriElementsApp = getFioriElementsApp();
+            await generate(curTestOutPath, fioriElementsApp, fs);
+            expect(applyCAPUpdates).toBeCalledTimes(0);
+        });
+    });
 });

packages/fiori-elements-writer/tsconfig.json

@@ -10,6 +10,9 @@
     "outDir": "dist"
   },
   "references": [
+    {
+      "path": "../cap-config-writer"
+    },
     {
       "path": "../eslint-plugin-fiori-tools"
     },

packages/fiori-freestyle-writer/package.json

@@ -36,6 +36,7 @@
         "@sap-ux/ui5-application-writer": "workspace:*",
         "@sap-ux/ui5-config": "workspace:*",
         "@sap-ux/fiori-generator-shared": "workspace:*",
+        "@sap-ux/cap-config-writer": "workspace:*",
         "ejs": "3.1.10",
         "i18next": "20.6.1",
         "lodash": "4.17.21",

packages/fiori-freestyle-writer/src/index.ts

@@ -12,6 +12,7 @@ import { UI5Config } from '@sap-ux/ui5-config';
 import { initI18n } from './i18n';
 import { getBootstrapResourceUrls, getPackageScripts } from '@sap-ux/fiori-generator-shared';
 import { getTemplateVersionPath, processDestinationPath } from './utils';
+import { applyCAPUpdates, type CapProjectSettings } from '@sap-ux/cap-config-writer';
 
 /**
  * Generate a UI5 application based on the specified Fiori Freestyle floorplan template.
@@ -166,6 +167,27 @@ async function generate<T>(basePath: string, data: FreestyleApp<T>, fs?: Editor)
         fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
     }
 
+    if (ffApp.service?.capService) {
+        const hasCdsUi5PluginInfo = !!ffApp.service.capService.cdsUi5PluginInfo;
+        const settings: CapProjectSettings = {
+            appRoot: basePath,
+            packageName: ffApp.package.name ?? '',
+            appId: ffApp.app.id,
+            sapux: ffApp.appOptions?.sapux,
+            enableTypescript: ffApp.appOptions?.typescript,
+            // Enable CDS UI5 plugin and NPM workspaces if the CDS UI5 plugin info is present
+            enableCdsUi5Plugin: hasCdsUi5PluginInfo,
+            enableNPMWorkspaces: hasCdsUi5PluginInfo
+        };
+        // Enable CDS UI5 plugin and NPM workspaces if the CDS UI5 plugin info is present
+        if (ffApp.service?.capService.cdsUi5PluginInfo) {
+            settings.enableCdsUi5Plugin = true;
+            settings.enableNPMWorkspaces = true;
+        }
+        // apply cap updates when service is cap
+        await applyCAPUpdates(fs, ffApp.service.capService, settings);
+    }
+
     return fs;
 }
 

packages/fiori-freestyle-writer/src/types.ts

@@ -1,5 +1,6 @@
 import type { Ui5App, App } from '@sap-ux/ui5-application-writer';
 import type { OdataService } from '@sap-ux/odata-service-writer';
+import type { CapServiceCdsInfo } from '@sap-ux/cap-config-writer';
 
 export const TemplateType = {
     Basic: 'basic',
@@ -38,7 +39,9 @@ export interface FioriApp extends App {
 }
 export interface FreestyleApp<T> extends Ui5App {
     template: Template<T>;
-    service?: OdataService;
+    service?: OdataService & {
+        capService?: CapServiceCdsInfo;
+    };
     app: FioriApp;
 }