Fixed various known type errors related issues

Author: VShingala

lib/schemaUtils.js

@@ -1513,7 +1513,7 @@ module.exports = {
     var example,
       exampleKey;
 
-    if (typeof exampleObj !== 'object') {
+    if (!exampleObj || typeof exampleObj !== 'object') {
       return '';
     }
 
@@ -1720,7 +1720,7 @@ module.exports = {
 
     Object.keys(deepObject).forEach((key) => {
       let value = deepObject[key];
-      if (typeof value === 'object') {
+      if (value && typeof value === 'object') {
         extractedParams = _.concat(extractedParams, this.extractDeepObjectParams(value, objectKey + '[' + key + ']'));
       }
       else {
@@ -2640,7 +2640,7 @@ module.exports = {
     // App / Collection transformer fail with the object syntax
     if (item.request.url.variables.members && item.request.url.variables.members.length > 0) {
       item.request.url.variables.members = _.map(item.request.url.variables.members, (m) => {
-        if (typeof m.description === 'object' && m.description.content) {
+        if (m.description && typeof m.description === 'object' && m.description.content) {
           m.description = m.description.content;
         }
         return m;

libV2/schemaUtils.js

@@ -401,7 +401,7 @@ let QUERYPARAM = 'query',
     let example = {},
       exampleKey;
 
-    if (typeof exampleObj !== 'object') {
+    if (!exampleObj || typeof exampleObj !== 'object') {
       return '';
     }
 
@@ -545,6 +545,11 @@ let QUERYPARAM = 'query',
         { includeDeprecated } = context.computedOptions;
 
       _.forOwn(schema.properties, (property, propertyName) => {
+        // Skip property resolution if it's not schema object
+        if (!_.isObject(property)) {
+          return;
+        }
+
         if (
           property.format === 'decimal' ||
           property.format === 'byte' ||
@@ -875,7 +880,7 @@ let QUERYPARAM = 'query',
 
     Object.keys(deepObject).forEach((key) => {
       let value = deepObject[key];
-      if (typeof value === 'object') {
+      if (value && typeof value === 'object') {
         extractedParams = _.concat(extractedParams, extractDeepObjectParams(value, objectKey + '[' + key + ']'));
       }
       else {
@@ -1720,8 +1725,9 @@ let QUERYPARAM = 'query',
     let responses = [],
       requestAcceptHeader;
 
-    _.forOwn(operationItem.responses, (responseSchema, code) => {
+    _.forOwn(operationItem.responses, (responseObj, code) => {
       let response,
+        responseSchema = _.has(responseObj, '$ref') ? resolveSchema(context, responseObj) : responseObj,
         { includeAuthInfoInExample } = context.computedOptions,
         responseAuthHelper,
         auth = request.auth,

libV2/validationUtils.js

@@ -885,7 +885,7 @@ function extractDeepObjectParams (deepObject, objectKey) {
 
   Object.keys(deepObject).forEach((key) => {
     let value = deepObject[key];
-    if (typeof value === 'object') {
+    if (value && typeof value === 'object') {
       extractedParams = _.concat(extractedParams, extractDeepObjectParams(value, objectKey + '[' + key + ']'));
     }
     else {

test/data/valid_openapi/specWithResponseRef.yaml

@@ -0,0 +1,72 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          $ref: "#/components/responses/defaultRes"
+components:
+  responses:
+    defaultRes:
+      description: unexpected error
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"
+      headers:
+        x-trace-id:
+          schema:
+            type: string
+          example: 12345-6789
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Pets:
+      type: array
+      items:
+        $ref: "#/components/schemas/Pet"
+    Error:
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string
+        nullProp: null

test/unit/convertV2.test.js

@@ -81,7 +81,9 @@ const expect = require('chai').expect,
   xmlRequestAndResponseBodyArrayTypeWrapped =
     path.join(__dirname, VALID_OPENAPI_PATH, '/xmlRequestAndResponseBodyArrayTypeWrapped.json'),
   schemaWithAdditionalProperties =
-    path.join(__dirname, VALID_OPENAPI_PATH, '/schemaWithAdditionalProperties.yaml');
+    path.join(__dirname, VALID_OPENAPI_PATH, '/schemaWithAdditionalProperties.yaml'),
+  specWithResponseRef =
+    path.join(__dirname, VALID_OPENAPI_PATH, '/specWithResponseRef.yaml');
 
 
 describe('The convert v2 Function', function() {
@@ -2073,4 +2075,33 @@ describe('The convert v2 Function', function() {
         done();
       });
   });
+
+  it('Should convert a collection with response $ref correctly', function(done) {
+    var openapi = fs.readFileSync(specWithResponseRef, 'utf8');
+    Converter.convertV2({ type: 'string', data: openapi }, { parametersResolution: 'Example' },
+      (err, conversionResult) => {
+        expect(err).to.be.null;
+        expect(conversionResult.result).to.equal(true);
+        expect(conversionResult.output.length).to.equal(1);
+        expect(conversionResult.output[0].type).to.equal('collection');
+        expect(conversionResult.output[0].data).to.have.property('info');
+        expect(conversionResult.output[0].data).to.have.property('item');
+        expect(conversionResult.output[0].data.item.length).to.equal(1);
+
+        const item = conversionResult.output[0].data.item[0].item[0].item[0];
+
+        expect(item.response[1].name).to.eql('unexpected error');
+        expect(item.response[1].header.length).to.eql(2);
+        expect(item.response[1].header[0].key).to.eql('Content-Type');
+        expect(item.response[1].header[0].value).to.eql('application/json');
+        expect(item.response[1].header[1].key).to.eql('x-trace-id');
+        expect(item.response[1].header[1].value).to.eql('12345-6789');
+        expect(JSON.parse(item.response[1].body)).to.have.property('code');
+        expect(JSON.parse(item.response[1].body)).to.have.property('message');
+
+        // Incorrectly defined properties will be skipped
+        expect(JSON.parse(item.response[1].body)).to.not.have.property('nullProp');
+        done();
+      });
+  });
 });

test/unit/schemaUtils.test.js

@@ -1,4 +1,9 @@
-const { getParametersForPathItem, verifyDeprecatedProperties } = require('../../lib/schemaUtils'),
+const {
+    getParametersForPathItem,
+    verifyDeprecatedProperties,
+    getExampleData,
+    extractDeepObjectParams
+  } = require('../../lib/schemaUtils'),
   expect = require('chai').expect;
 
 
@@ -261,3 +266,22 @@ describe('verifyDeprecatedProperties function', function () {
     expect(schema.properties.b.properties.d).to.not.be.undefined;
   });
 });
+
+describe('getExampleData function', function () {
+  it('should correctly provide result with null example object', function () {
+    const result = getExampleData(null, {}, {});
+
+    expect(result).to.equal('');
+  });
+});
+
+describe('extractDeepObjectParams function', function () {
+  it('should correctly provide result with nested object containing null values', function () {
+    const result = extractDeepObjectParams({ id: null }, 'user');
+
+    expect(result).to.eql([{
+      key: 'user[id]',
+      value: null
+    }]);
+  });
+});