@cap-js/ord 1.2.0 → 1.3.0

package/lib/ord.js

@@ -1,85 +1,175 @@
-const { ORD_RESOURCE_TYPE } = require('./constants');
+const {
+    BLOCKED_SERVICE_NAME,
+    CDS_ELEMENT_KIND,
+    CONTENT_MERGE_KEY,
+    ENTITY_RELATIONSHIP_ANNOTATION,
+    ORD_ODM_ENTITY_NAME_ANNOTATION,
+} = require("./constants");
 const {
     createAPIResourceTemplate,
     createEntityTypeTemplate,
+    createEntityTypeMappingsItemTemplate,
     createEventResourceTemplate,
-    createGroupsTemplateForService
-} = require('./templates');
-const { extendCustomORDContentIfExists } = require('./extendOrdWithCustom');
-const { getRFC3339Date } = require('./date');
-const { Logger } = require('./logger');
+    createGroupsTemplateForService,
+    _propagateORDVisibility,
+} = require("./templates");
+const { extendCustomORDContentIfExists } = require("./extendOrdWithCustom");
+const { getRFC3339Date } = require("./date");
+const { getAuthConfig } = require("./authentication");
+
+const { Logger } = require("./logger");
 const _ = require("lodash");
 const cds = require("@sap/cds");
 const defaults = require("./defaults");
 const path = require("path");
 
 const initializeAppConfig = (csn) => {
-    let packageJsonPath = path.join(cds.root, 'package.json')
-    let packageJson;
-    if (cds.utils.exists(packageJsonPath)) {
-        packageJson = require(packageJsonPath);
-    } else {
-        throw new Error(`package.json not found in the project root directory`);
-    }
+    const packageJson = _loadPackageJson();
     const packageName = packageJson.name;
-    const appName = packageJson.name.replace(/^[@]/, "").replace(/[@/]/g, "-");
-    const modelKeys = Object.keys(csn.definitions);
-    const events = [];
-    const serviceNames = [];
+    const appName = _formatAppName(packageName);
     const lastUpdate = getRFC3339Date();
-    let odmEntity = [];
 
-    const vendorNamespace = "customer";
-    const ordNamespace = cds.env["ord"]?.namespace || `${vendorNamespace}.${packageName.replace(/[^a-zA-Z0-9]/g, "")}`;
+    const ordNamespace = _getORDNamespace(packageName);
     const eventApplicationNamespace = cds.env?.export?.asyncapi?.applicationNamespace;
 
-    if (eventApplicationNamespace && ordNamespace !== eventApplicationNamespace) {
-        Logger.warn('ORD and AsyncAPI namespaces should be the same.');
-    }
+    _validateNamespaces(ordNamespace, eventApplicationNamespace);
 
-    for (const key of modelKeys) {
-        const keyDefinition = csn.definitions[key];
-        switch (keyDefinition.kind) {
-            case ORD_RESOURCE_TYPE.service:
-                if (!keyDefinition["@cds.external"]) {
-                    serviceNames.push(key);
-                }
-                break;
-            // TODO: should be rewritten
-            case ORD_RESOURCE_TYPE.entity:
-                if (!key.includes(".texts") && keyDefinition["@ODM.entityName"]) {
-                    odmEntity.push(createEntityTypeTemplate(keyDefinition));
-                }
-                break;
-            case ORD_RESOURCE_TYPE.event:
-                events.push(key);
-                break;
-        }
-    }
-
-    odmEntity = _.uniqBy(odmEntity, "ordId");
+    const { serviceNames, apiResourceNames, apiEndpoints, eventNames, entityTypeTargets } = _triageCsnDefinitions(csn);
 
     return {
         env: cds.env["ord"],
         lastUpdate,
         appName,
-        events,
+        apiEndpoints: Array.from(apiEndpoints),
+        eventNames,
         serviceNames,
-        odmEntity,
+        apiResourceNames,
+        entityTypeTargets: _.uniqBy(entityTypeTargets, CONTENT_MERGE_KEY),
         ordNamespace,
         eventApplicationNamespace,
         packageName,
     };
 };
 
-const _getPolicyLevel = (appConfig) =>
-    appConfig.env?.policyLevel || defaults.policyLevel;
+function _loadPackageJson() {
+    const packageJsonPath = path.join(cds.root, "package.json");
+    if (!cds.utils.exists(packageJsonPath)) {
+        throw new Error(`package.json not found in the project root directory`);
+    }
+    return require(packageJsonPath);
+}
+
+function _formatAppName(packageName) {
+    return packageName.replace(/^[@]/, "").replace(/[@/]/g, "-");
+}
+
+function _getORDNamespace(packageName) {
+    const vendorNamespace = "customer";
+    return cds.env["ord"]?.namespace || `${vendorNamespace}.${packageName.replace(/[^a-zA-Z0-9]/g, "")}`;
+}
+
+function _validateNamespaces(ordNamespace, eventApplicationNamespace) {
+    if (eventApplicationNamespace && ordNamespace !== eventApplicationNamespace) {
+        Logger.warn("ORD and AsyncAPI namespaces should be the same.");
+    }
+}
+
+function _triageCsnDefinitions(csn) {
+    const pendingApiResourceNames = [];
+    const apiEndpoints = new Set();
+    const pendingEventNames = [];
+    const entityTypeTargets = [];
+    const pendingServiceNames = [];
+
+    for (const definitionKey of Object.keys(csn.definitions)) {
+        const definitionObj = csn.definitions[definitionKey];
+        if (definitionKey.includes(BLOCKED_SERVICE_NAME.MTXServices)) {
+            Logger.warn(`ORD service name "${definitionKey}" is blocked.`);
+            continue;
+        }
+        switch (definitionObj.kind) {
+            case CDS_ELEMENT_KIND.service: {
+                pendingServiceNames.push(definitionKey);
+                const apiResourceName = _handleApiResource(definitionKey, definitionObj);
+                if (apiResourceName) pendingApiResourceNames.push(apiResourceName);
+                break;
+            }
+            case CDS_ELEMENT_KIND.entity: {
+                const result = _handleEntity(definitionKey, definitionObj);
+                if (result) {
+                    if (result.apiEndpoint) apiEndpoints.add(result.apiEndpoint);
+                    if (result.entityTypeTarget) entityTypeTargets.push(result.entityTypeTarget);
+                }
+                break;
+            }
+            case CDS_ELEMENT_KIND.event: {
+                const event = _handleEvent(definitionKey);
+                if (event) pendingEventNames.push(event);
+                break;
+            }
+            case CDS_ELEMENT_KIND.action:
+            case CDS_ELEMENT_KIND.function: {
+                const apiEndpoint = _handleActionOrFunction(definitionKey);
+                if (apiEndpoint) apiEndpoints.add(apiEndpoint);
+                break;
+            }
+        }
+    }
+
+    return {
+        serviceNames: pendingServiceNames,
+        apiResourceNames: pendingApiResourceNames,
+        apiEndpoints: Array.from(apiEndpoints),
+        eventNames: pendingEventNames,
+        entityTypeTargets,
+    };
+}
+
+function _handleApiResource(apiResourceName, serviceDefinition) {
+    if (_shouldSkipIfServiceOnlyContainsEvents(serviceDefinition) || serviceDefinition["@cds.external"]) {
+        return null;
+    }
+    return apiResourceName;
+}
 
-const _getDescription = (appConfig) =>
-    appConfig.env?.description || defaults.description;
+function _shouldSkipIfServiceOnlyContainsEvents(serviceDefinition) {
+    const isActionsNotContained = !serviceDefinition.actions || Object.keys(serviceDefinition.actions).length === 0;
+    const isFunctionsNotContained =
+        !serviceDefinition.functions || Object.keys(serviceDefinition.functions).length === 0;
+    const isEntitiesNotContained = !serviceDefinition.entities || Object.keys(serviceDefinition.entities).length === 0;
+    const isEventsContained = serviceDefinition.events && Object.keys(serviceDefinition.events).length > 0;
+    if (isActionsNotContained && isFunctionsNotContained && isEntitiesNotContained && isEventsContained) {
+        return true;
+    }
+    return false;
+}
 
-const _getProducts = (appConfig) =>
-    appConfig.env?.products || defaults.products(appConfig.packageName);
+function _handleEntity(key, keyDefinition) {
+    if (!key.includes(".texts")) {
+        const apiEndpoint = key;
+        const entityTypeTarget =
+            keyDefinition[ORD_ODM_ENTITY_NAME_ANNOTATION] || keyDefinition[ENTITY_RELATIONSHIP_ANNOTATION]
+                ? createEntityTypeMappingsItemTemplate(keyDefinition)
+                : null;
+        return { apiEndpoint, entityTypeTarget };
+    }
+    return null;
+}
+
+function _handleEvent(key) {
+    return key;
+}
+
+function _handleActionOrFunction(key) {
+    return key;
+}
+
+const _getPolicyLevels = (appConfig) =>
+    appConfig.env?.policyLevels ||
+    (appConfig.env?.policyLevel && [appConfig.env?.policyLevel]) ||
+    defaults.policyLevels;
+
+const _getDescription = (appConfig) => appConfig.env?.description || defaults.description;
 
 const _getGroups = (csn, appConfig) => {
     return appConfig.serviceNames
@@ -87,23 +177,32 @@ const _getGroups = (csn, appConfig) => {
         .filter((resource) => !!resource);
 };
 
-const _getPackages = (policyLevel, appConfig) =>
-    appConfig.env?.packages || appConfig.events.length
-        ? defaults.packages(appConfig.appName, policyLevel, appConfig.ordNamespace)
-        : defaults
-            .packages(appConfig.appName, policyLevel, appConfig.ordNamespace)
-            .slice(0, 1);
+const _getPackages = (policyLevels, appConfig) => {
+    return defaults.packages(appConfig, policyLevels);
+};
 
-const _getAPIResources = (csn, appConfig, packageIds) => {
-    return appConfig.serviceNames
-        .flatMap((serviceName) => createAPIResourceTemplate(serviceName, csn.definitions[serviceName], appConfig, packageIds))
+const _getEntityTypes = (appConfig, packageIds) => {
+    if (!appConfig.entityTypeTargets?.length) return [];
+
+    return appConfig.entityTypeTargets.map((entity) => createEntityTypeTemplate(appConfig, packageIds, entity));
 };
 
-const _getEventResources = (csn, appConfig, packageIds) => {
-    if (appConfig.events.length === 0) return [];
-    return appConfig.serviceNames
-        .filter((serviceName) => appConfig.events.some((eventName) => eventName.startsWith(serviceName)))
-        .flatMap((serviceName) => createEventResourceTemplate(serviceName, csn.definitions[serviceName], appConfig, packageIds));
+const _getAPIResources = (csn, appConfig, packageIds, accessStrategies) => {
+    return appConfig.apiResourceNames.flatMap((apiResourceName) =>
+        createAPIResourceTemplate(
+            apiResourceName,
+            csn.definitions[apiResourceName],
+            appConfig,
+            packageIds,
+            accessStrategies,
+        ),
+    );
+};
+
+const _getEventResources = (csn, appConfig, packageIds, accessStrategies) => {
+    return appConfig.serviceNames.flatMap((serviceName) =>
+        createEventResourceTemplate(serviceName, csn.definitions[serviceName], appConfig, packageIds, accessStrategies),
+    );
 };
 
 function _getOpenResourceDiscovery(appConfig) {
@@ -114,55 +213,96 @@ function _getConsumptionBundles(appConfig) {
     return appConfig.env?.consumptionBundles || defaults.consumptionBundles(appConfig);
 }
 
-function validateNamespace(appConfig) {
-    const validateSystemNamespace = new RegExp(`^${appConfig.eventApplicationNamespace}\\.[^.]+\\..+$`);
-    if (
-        appConfig.ordNamespace === undefined &&
-        !validateSystemNamespace.test(appConfig.ordNamespace)
-    ) {
-        let error = new Error(
-            `Namespace is not defined in cdsrc.json or it is not in the format of ${appConfig.eventApplicationNamespace}.<appName>.<service>`
-        );
-        Logger.error('Namespace error:', error.message);
-        throw error;
+const _getProducts = (appConfig) => {
+    const productsObj = defaults.products(appConfig.packageName);
+    if (appConfig.env?.products) {
+        const customProducts = appConfig.env.products[0];
+        if (customProducts?.ordId?.toLowerCase().startsWith("sap")) {
+            Logger.error(
+                "Detected sap product ordId, which should not be defined for custom products, use default value instead. Please check ord global registry.",
+            );
+        } else {
+            _.assign(productsObj[0], customProducts);
+        }
     }
-}
+    appConfig.products = productsObj;
+    return productsObj;
+};
 
 function createDefaultORDDocument(linkedCsn, appConfig) {
     let ordDocument = {
-        $schema: "https://sap.github.io/open-resource-discovery/spec-v1/interfaces/Document.schema.json",
+        $schema: "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Document.schema.json",
         openResourceDiscovery: _getOpenResourceDiscovery(appConfig),
-        policyLevel: _getPolicyLevel(appConfig),
+        policyLevels: _getPolicyLevels(appConfig),
         description: _getDescription(appConfig),
-        products: _getProducts(appConfig),
-        groups: _getGroups(linkedCsn, appConfig),
         consumptionBundles: _getConsumptionBundles(appConfig),
     };
 
-    if (_getAPIResources(linkedCsn, appConfig).length && _getEventResources(linkedCsn, appConfig).length) {
-        ordDocument.packages = _getPackages(ordDocument.policyLevel, appConfig);
+    if (appConfig.serviceNames.length) {
+        ordDocument.groups = _getGroups(linkedCsn, appConfig);
+    }
+
+    if (appConfig.env?.existingProductORDId) {
+        appConfig.existingProductORDId = appConfig.env.existingProductORDId;
+    } else {
+        ordDocument.products = [_getProducts(appConfig)[0]];
     }
+
+    ordDocument.packages = _getPackages(ordDocument.policyLevels, appConfig);
+
     return ordDocument;
 }
 
 function extractPackageIds(ordDocument) {
-    const packageIds = [];
-    if (ordDocument.packages) {
-        ordDocument.packages.map((pkg) => packageIds.push(pkg.ordId));
-    }
-    return packageIds;
+    return ordDocument.packages?.map((pkg) => pkg.ordId) || [];
+}
+
+function _filterUnusedPackages(ordDocument) {
+    if (!ordDocument.packages?.length) return [];
+
+    const usedPackageIds = new Set();
+
+    ordDocument.apiResources?.forEach((api) => usedPackageIds?.add(api.partOfPackage));
+    ordDocument.eventResources?.forEach((event) => usedPackageIds?.add(event.partOfPackage));
+    ordDocument.dataProducts?.forEach((dp) => usedPackageIds?.add(dp.partOfPackage));
+    ordDocument.entityTypes?.forEach((et) => {
+        if (et && et.partOfPackage) {
+            usedPackageIds.add(et.partOfPackage);
+        }
+    });
+
+    const filteredPackages = ordDocument.packages.filter((pkg) => usedPackageIds.has(pkg.ordId));
+
+    return filteredPackages;
 }
 
 module.exports = (csn) => {
-    const linkedCsn = cds.linked(csn);
+    const linkedCsn = _propagateORDVisibility(cds.linked(csn));
     const appConfig = initializeAppConfig(linkedCsn);
-    validateNamespace(appConfig);
+    const accessStrategies = getAuthConfig().accessStrategies;
 
     let ordDocument = createDefaultORDDocument(linkedCsn, appConfig);
     const packageIds = extractPackageIds(ordDocument);
-    ordDocument.apiResources = _getAPIResources(linkedCsn, appConfig, packageIds);
-    ordDocument.eventResources = _getEventResources(linkedCsn, appConfig, packageIds);
+    const entityTypes = _getEntityTypes(appConfig, packageIds);
+
+    if (entityTypes.length) {
+        ordDocument.entityTypes = entityTypes;
+    }
+
+    if (appConfig.apiResourceNames.length) {
+        const apiResources = _getAPIResources(linkedCsn, appConfig, packageIds, accessStrategies);
+        if (apiResources.length) {
+            ordDocument.apiResources = apiResources;
+        }
+    }
+    if (appConfig.eventNames.length) {
+        const eventResources = _getEventResources(linkedCsn, appConfig, packageIds, accessStrategies);
+        if (eventResources.length) {
+            ordDocument.eventResources = eventResources;
+        }
+    }
     ordDocument = extendCustomORDContentIfExists(appConfig, ordDocument);
+    ordDocument.packages = _filterUnusedPackages(ordDocument);
 
     return ordDocument;
 };