OpenAPI: Replace Console warnings to cds debug (#69)

* Add debug logs instead of console warn

* Add debug logs instead of console warn

* First commit

Author: Geethika-Pula

lib/compile/csdl2openapi.js

@@ -1,8 +1,10 @@
 /**
  * Converts OData CSDL JSON to OpenAPI 3.0.2
 */
-
+const cds = require('@sap/cds');
 var pluralize = require('pluralize')
+const DEBUG = cds.debug('openapi');  // Initialize cds.debug with the 'openapi' 
+
 
 //TODO
 // - Core.Example for complex types
@@ -325,7 +327,7 @@ module.exports.csdl2openapi = function (
                     );
                 }
                 if (!element) {
-                    console.warn(`Invalid annotation target '${target}'`);
+                    DEBUG?.(`Invalid annotation target '${target}'`);
                 } else if (Array.isArray(element)) {
                     //TODO: action or function:
                     //- loop over all overloads
@@ -348,12 +350,12 @@ module.exports.csdl2openapi = function (
                                 if (element[segments[1]]) {
                                     Object.assign(element[segments[1]], annotations);
                                 } else {
-                                    // console.warn(`Invalid annotation target '${target}'`)
+                                    // DEBUG?.(`Invalid annotation target '${target}'`)
                                 }
                             }
                             break;
                         default:
-                            console.warn('More than two annotation target path segments');
+                            DEBUG?.('More than two annotation target path segments');
                     }
                 }
             });
@@ -655,7 +657,7 @@ module.exports.csdl2openapi = function (
             } else if (child.$Function) {
                 pathItemFunctionImport(paths, name, child);
             } else {
-                console.warn('Unrecognized entity container child: ' + name);
+                DEBUG?.('Unrecognized entity container child: ' + name);
             }
         })
         if (resources.length > 0) pathItemBatch(paths, container);
@@ -1148,7 +1150,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
         const elementType = modelElement(element.$Type);
 
         if (!elementType) {
-            console.warn(`Unknown type for element: ${JSON.stringify(element)}`);
+            DEBUG?.(`Unknown type for element: ${JSON.stringify(element)}`);
             return paths;
         }
 
@@ -1160,7 +1162,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
             .filter(entry => !modelElement(entry[1].$Type));
 
         // Keep old logging
-        ignore.forEach(entry => console.warn(`Unknown type for element: ${JSON.stringify(entry)}`));
+        ignore.forEach(entry => DEBUG?.(`Unknown type for element: ${JSON.stringify(entry)}`));
 
         const properties = Object.entries(propsOfType)
             .filter(entry => entry[1].$Kind !== 'NavigationProperty')
@@ -1178,7 +1180,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
 
             // Allow full cycle to be shown (0) times
             if (property.typeRefChain.filter(_type => _type === typeRefChainTail).length > 1) {
-                console.warn(`Cycle detected ${property.typeRefChain.join('->')}`);
+                DEBUG?.(`Cycle detected ${property.typeRefChain.join('->')}`);
                 continue;
             }
 
@@ -2394,7 +2396,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
                 break;
             default:
                 if (element.$Type.startsWith('Edm.')) {
-                    console.warn('Unknown type: ' + element.$Type);
+                    DEBUG?.('Unknown type: ' + element.$Type);
                 } else {
                     let type = modelElement(element.$Type);
                     let isStructured = type && ['ComplexType', 'EntityType'].includes(type.$Kind);
@@ -2597,7 +2599,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
                     break;
                 default:
                     unknown = true
-                    console.warn('Unknown Authorization type ' + qualifiedType);
+                    DEBUG?.('Unknown Authorization type ' + qualifiedType);
             }
             if (!unknown) schemes[auth.Name] = scheme;
         });
@@ -2619,7 +2621,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
         const securitySchemes = entityContainer && entityContainer[voc.Authorization.SecuritySchemes] ? entityContainer[voc.Authorization.SecuritySchemes] : [];
         // check if securitySchemas exist if it does not exist then throw a warning
         if (securitySchemes.length === 0) {
-            console.warn('No security schemes defined in the entity container');
+            DEBUG?.('No security schemes defined in the entity container');
         }
         if (securitySchemes.length > 0) openapi.security = [];
         securitySchemes.forEach(scheme => {
@@ -2661,5 +2663,5 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
     function isIdentifier(name) {
         return !name.startsWith('$') && !name.includes('@');
     }
-
+    
 };

lib/compile/index.js

@@ -1,6 +1,7 @@
 const csdl2openapi = require('./csdl2openapi')
 const cds = require('@sap/cds/lib');
 const fs = require("fs");
+const DEBUG = cds.debug('openapi');
 
 module.exports = function processor(csn, options = {}) {
   const edmOptions = Object.assign({
@@ -157,7 +158,7 @@ function _getProtocols(csdl, csn, odataVersion) {
         if (protocol === "rest" || protocol === "odata" || protocol === "odata-v4") {
           protocols.push(protocol);
         } else {
-          console.warn(`"${protocol}" protocol is not supported`);
+          DEBUG?.(`"${protocol}" protocol is not supported`);
         }
       });
     }

test/lib/compile/csdl2openapi.test.js

@@ -1678,6 +1678,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
         assert.deepStrictEqual(actual.paths['/Categories'].get, expected.paths['/Categories'].get, 'GET Categories');
     })
 
+
     it('FilterRestrictions, NavigationRestrictions, SearchRestrictions, and SortRestrictions', function () {
         const csdl = {
             $Version: '4.01',
@@ -2289,7 +2290,6 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
             "MaxLength"
         );
     });
-
 })
 
 it("AllowedValues on various Edm types", function () {
@@ -2380,6 +2380,14 @@ it("AllowedValues on various Edm types", function () {
     assert.deepStrictEqual(messages, [], "messages");
 })
 
+it('Error Logging when name and title are missing', function () {
+    const csdl = {name:undefined,title:undefined};
+    const actual = lib.csdl2openapi(csdl, {}); 
+
+    assert.ok(actual, 'Function should execute without errors');
+    console.log('Error handling executed successfully');
+});  
+
 describe('CAP / CS01', function () {
 
     it('FilterRestrictions, NavigationRestrictions, and SortRestrictions', function () {
@@ -2541,6 +2549,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
         assert.deepStrictEqual(operations(actual), operations(expected), 'Operations');
         assert.deepStrictEqual(actual.paths['/things'].get, expected.paths['/things'].get, 'GET things');
     })
+    
 
 })
 
@@ -2566,4 +2575,4 @@ function schemas(openapi) {
     return Object.keys(openapi.components.schemas)
         .sort()
         .filter((s) => s.includes("."));
-}
+}