@cap-js/ord 1.0.3 → 1.2.0

package/lib/ord.js

@@ -1,202 +1,168 @@
-const path = require("path");
-const cds = require("@sap/cds");
-const { exists } = cds.utils;
-const defaults = require("./defaults");
+const { ORD_RESOURCE_TYPE } = require('./constants');
 const {
-    fCreateAPIResourceTemplate,
-    fCreateEventResourceTemplate,
-    fCreateGroupsTemplateForService,
-    fCreateGroupsTemplateForEvent,
-    fCreateEntityTypeTemplate
+    createAPIResourceTemplate,
+    createEntityTypeTemplate,
+    createEventResourceTemplate,
+    createGroupsTemplateForService
 } = require('./templates');
+const { extendCustomORDContentIfExists } = require('./extendOrdWithCustom');
+const { getRFC3339Date } = require('./date');
+const { Logger } = require('./logger');
+const _ = require("lodash");
+const cds = require("@sap/cds");
+const defaults = require("./defaults");
+const path = require("path");
 
-/**
- * Initializes global object based on package.json and CSN object.
- * @param {Object} csn object
- * @returns {Object} An object containing global variables.
- */
-const fInitializeGlobal = (csn) => {
-    let packagejsonPath = path.join(cds.root,'package.json')
+const initializeAppConfig = (csn) => {
+    let packageJsonPath = path.join(cds.root, 'package.json')
     let packageJson;
-    if (exists(packagejsonPath)) {
-        packageJson = require(packagejsonPath);
+    if (cds.utils.exists(packageJsonPath)) {
+        packageJson = require(packageJsonPath);
     } else {
         throw new Error(`package.json not found in the project root directory`);
     }
+    const packageName = packageJson.name;
     const appName = packageJson.name.replace(/^[@]/, "").replace(/[@/]/g, "-");
-    const aModelKeys = Object.keys(csn.definitions);
-    const aEvents = [];
-    const aServices = [];
-    const aODMEntity = [];
-    
-    const capNamespace = csn.namespace;
-     // namespace variable value if present in cdsrc.json take it there or else from package.json
-    //if cdsrc.json does not have applicationNamespace, then use just the namespace
-    const namespace = cds.env["ord"]?.namespace || `customer.${appName}`;
-    const applicationNamespace = cds.env?.export?.asyncapi?.applicationNamespace;
-    
-    if (applicationNamespace && fGetNamespaceComponents(namespace) !== fGetNamespaceComponents(applicationNamespace)) {
-        console.warn('ORD and AsyncAPI namespaces should be the same.');
-    }
-
-    const fEventFilter = (keyDefinition) => keyDefinition.kind === "event";
-    const fServicesFilter = (keyDefinition) => keyDefinition.kind === "service" && !keyDefinition['@cds.external'];
-    const fODMEntityFilter = (key, keyDefinition) => {
-        return keyDefinition.kind === "entity"
-            && key.includes(capNamespace)
-            && !key.includes(".texts")
-            && keyDefinition["@ODM.entityName"];
+    const modelKeys = Object.keys(csn.definitions);
+    const events = [];
+    const serviceNames = [];
+    const lastUpdate = getRFC3339Date();
+    let odmEntity = [];
+
+    const vendorNamespace = "customer";
+    const ordNamespace = cds.env["ord"]?.namespace || `${vendorNamespace}.${packageName.replace(/[^a-zA-Z0-9]/g, "")}`;
+    const eventApplicationNamespace = cds.env?.export?.asyncapi?.applicationNamespace;
+
+    if (eventApplicationNamespace && ordNamespace !== eventApplicationNamespace) {
+        Logger.warn('ORD and AsyncAPI namespaces should be the same.');
     }
 
-    aModelKeys.forEach((key) => {
+    for (const key of modelKeys) {
         const keyDefinition = csn.definitions[key];
-        if(fServicesFilter(keyDefinition)){
-            aServices.push(key);
-        } else if(fODMEntityFilter(key, keyDefinition)) {
-            aODMEntity.push(fCreateEntityTypeTemplate(keyDefinition));
-        } else if(fEventFilter(keyDefinition)){
-            aEvents.push(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");
 
     return {
         env: cds.env["ord"],
-        capNamespace,
+        lastUpdate,
         appName,
-        aEvents,
-        aServices,
-        aODMEntity,
-        namespace,
-        applicationNamespace
-    }
-}
+        events,
+        serviceNames,
+        odmEntity,
+        ordNamespace,
+        eventApplicationNamespace,
+        packageName,
+    };
+};
+
+const _getPolicyLevel = (appConfig) =>
+    appConfig.env?.policyLevel || defaults.policyLevel;
 
-/**
- * Retrieves first two components of the namespace.
- * @param {string} namespace
- * @returns {string} The first two components of the namespace.
- */
-const fGetNamespaceComponents = (namespace) => namespace.split('.').slice(0, 2).join('.');
-
-/**
- * Retrieves the policy level.
- * Hierarchy to check data: cdsrc.json > defaults
- * @returns {string} The policy level.
- */
-const fGetPolicyLevel = (global) => global.env?.policyLevel || defaults.policyLevel;
-
-/**
- * Retrieves the root level ORD document description.
- * Hierarchy to check data: cdsrc.json > defaults
- * @returns {string} The ORD document description.
- */
-const fGetDescription = (global) => global.env?.description || defaults.description;
-
-/**
- * Retrieves the products.
- * Hierarchy to check data: cdsrc.json > defaults
- * @returns {Array<object>} The products array.
- * if global.namespace is defined in cdsrc.json, then use it, else use the appName from package.json
- */
-const fGetProducts = (global) => global.env?.products || defaults.products(global.namespace);
-
-/**
- * Retrieves the groups that services belongs to.
- * Gets list of groups from CDS runtime object.
- * @param {Object} csn object 
- * @returns {Array<object>} The groups array.
- */
-const fGetGroups = (csn, global) => {
-    // storing the group ids in a set to avoid duplicates
-    let groupIds = new Set();
-
-    let serviceGroups = global.aServices
-            .map((srv) => fCreateGroupsTemplateForService(srv, csn.definitions[srv], groupIds))
-            .filter((resource) => resource !== null && resource !== undefined);
-    let eventGroups = global.aEvents
-            .map((event) => fCreateGroupsTemplateForEvent(event, csn.definitions[event], groupIds))
-            .filter((resource) => resource !== null && resource !== undefined);
-
-    return [...serviceGroups, ...eventGroups];
+const _getDescription = (appConfig) =>
+    appConfig.env?.description || defaults.description;
+
+const _getProducts = (appConfig) =>
+    appConfig.env?.products || defaults.products(appConfig.packageName);
+
+const _getGroups = (csn, appConfig) => {
+    return appConfig.serviceNames
+        .flatMap((serviceName) => createGroupsTemplateForService(serviceName, csn.definitions[serviceName], appConfig))
+        .filter((resource) => !!resource);
 };
 
-/**
- * Retrieves the packages.
- * Hierarchy to check data: cdsrc.json > defaults
- * @returns {Array<object>} The packages array.
- */
-const fGetPackages = (policyLevel,global) => global.env?.packages || (global.aEvents.length) ? defaults.packages(global.namespace,policyLevel,global.capNamespace) : defaults.packages(global.namespace,policyLevel,global.capNamespace).slice(0, 1)
-
-/**
- * Retrieves the consumption bundles.
- * Hierarchy to check data: cdsrc.json > defaults
- * @returns {Array<object>} The consumption bundles array.
- */
-const fGetConsumptionBundles = (global) => global.env?.consumptionBundles || (global.aEvents.length) ? defaults.consumptionBundles(global.capNamespace) : defaults.consumptionBundles(global.capNamespace).slice(0,1)
-
-/**
- * Retrieves the API Resources
- * Gets list of services from CSN object
- * @param {Object} csn object
- * @returns {Array<object>} The API Resources array.
- */
-const fGetAPIResources = (csn, global,packageIds) => {
-  const apiResources = [];
-  global.aServices.forEach((srv) => {
-    fCreateAPIResourceTemplate(srv, csn.definitions[srv], global,packageIds)?.forEach(
-      (resource) => {
-        if (resource !== null && resource !== undefined) {
-          apiResources.push(resource);
-        }
-      }
-    );
-  });
-  return apiResources;
+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 _getAPIResources = (csn, appConfig, packageIds) => {
+    return appConfig.serviceNames
+        .flatMap((serviceName) => createAPIResourceTemplate(serviceName, csn.definitions[serviceName], appConfig, packageIds))
 };
 
-/**
- * Retrieves the Event Resources
- * Gets list of event from CSN object
- * @param {Object} csn object
- * @returns {Array<object>} The Event Resources array.
- */
-const fGetEventResources = (csn, global,packageIds) => global.aEvents.map((srv) => fCreateEventResourceTemplate(srv, csn.definitions[srv], global, packageIds)).filter((resource) => resource !== null && resource !== undefined);
+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));
+};
 
-module.exports = (csn) => {
-    const linkedCsn = cds.linked(csn);
-    Object.assign(global, fInitializeGlobal(linkedCsn));
-    const validateSystemNamespace = new RegExp(`^${global.applicationNamespace}\\.[^.]+\\..+$`);
-    if (global.namespace === undefined && !validateSystemNamespace.test(global.namespace)) {
-        let error = new Error(`Namespace is not defined in cdsrc.json or it is not in the format of ${global.applicationNamespace}.<appName>.<service>`);
-        console.error('Namespace error:', error.message);
+function _getOpenResourceDiscovery(appConfig) {
+    return appConfig.env?.openResourceDiscovery || defaults.openResourceDiscovery;
+}
+
+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;
     }
+}
 
-    let oReturn = {openResourceDiscovery: "1.9",
-        policyLevel: fGetPolicyLevel(global),
-        description: fGetDescription(global),
-        products: fGetProducts(global),
-        groups: fGetGroups(linkedCsn, global),
+function createDefaultORDDocument(linkedCsn, appConfig) {
+    let ordDocument = {
+        $schema: "https://sap.github.io/open-resource-discovery/spec-v1/interfaces/Document.schema.json",
+        openResourceDiscovery: _getOpenResourceDiscovery(appConfig),
+        policyLevel: _getPolicyLevel(appConfig),
+        description: _getDescription(appConfig),
+        products: _getProducts(appConfig),
+        groups: _getGroups(linkedCsn, appConfig),
+        consumptionBundles: _getConsumptionBundles(appConfig),
     };
-    if(fGetAPIResources(linkedCsn, global).length > 0 && (fGetEventResources(linkedCsn, global).length>0)){
-        oReturn.packages = fGetPackages(oReturn.policyLevel, global);
-    }
 
-    // check if oReturn.packages is defined and extract the ordId from the packages and store in a set
-    let packageIds = new Set();
-    if(oReturn.packages){
-        oReturn.packages.forEach((pkg) => {
-            packageIds.add(pkg.ordId);
-        });
+    if (_getAPIResources(linkedCsn, appConfig).length && _getEventResources(linkedCsn, appConfig).length) {
+        ordDocument.packages = _getPackages(ordDocument.policyLevel, appConfig);
     }
-    oReturn = {
-        ...oReturn,
-        consumptionBundles: fGetConsumptionBundles(global),
-        apiResources: fGetAPIResources(linkedCsn, global,packageIds),
-    };
-    if(fGetEventResources(linkedCsn, global,packageIds).length > 0) {
-        oReturn.eventResources= fGetEventResources(linkedCsn, global,packageIds);
+    return ordDocument;
+}
+
+function extractPackageIds(ordDocument) {
+    const packageIds = [];
+    if (ordDocument.packages) {
+        ordDocument.packages.map((pkg) => packageIds.push(pkg.ordId));
     }
-    return oReturn;
+    return packageIds;
 }
+
+module.exports = (csn) => {
+    const linkedCsn = cds.linked(csn);
+    const appConfig = initializeAppConfig(linkedCsn);
+    validateNamespace(appConfig);
+
+    let ordDocument = createDefaultORDDocument(linkedCsn, appConfig);
+    const packageIds = extractPackageIds(ordDocument);
+    ordDocument.apiResources = _getAPIResources(linkedCsn, appConfig, packageIds);
+    ordDocument.eventResources = _getEventResources(linkedCsn, appConfig, packageIds);
+    ordDocument = extendCustomORDContentIfExists(appConfig, ordDocument);
+
+    return ordDocument;
+};

package/lib/plugin.js

@@ -1,5 +1,7 @@
-const { ord, getMetadata, defaults } = require("./");
 const cds = require("@sap/cds");
+const { Logger } = require("./logger");
+const { ord, getMetadata, defaults } = require("./");
+
 
 cds.on("bootstrap", (app) => {
   app.use("/.well-known/open-resource-discovery", async (req, res) => {
@@ -10,8 +12,7 @@ cds.on("bootstrap", (app) => {
         const { contentType, response } = await getMetadata(req.url);
         res.status(200).contentType(contentType).send(response);
       } catch (error) {
-        console.log(error);
-        console.log('Error while generating metadata');
+        Logger.error(error, 'Error while generating metadata');
         res.status(500).send(error.message);
       }
     }
@@ -23,8 +24,7 @@ cds.on("bootstrap", (app) => {
       const data = ord(csn);
       return res.status(200).send(data);
     } catch (error) {
-      console.log(error);
-      console.log('Error while creating ORD document');
+      Logger.error(error, 'Error while creating ORD document');
       return res.status(500).send(error.message);
     }
   });