Merge pull request #1 from stoplightio/graceful-handling

Handle malformed schemas more gracefully

Author: Phil Sturgeon

lib/converters/schema.js

@@ -1,3 +1,4 @@
+var isObject = require('../utils/isObject').isObject;
 var InvalidTypeError = require('../errors/invalid-type-error');
 
 module.exports = convertFromSchema;
@@ -24,14 +25,22 @@ function convertSchema(schema, options) {
 
 		if (Array.isArray(schema[struct])) {
 			for (j; j < schema[struct].length; j++) {
+				if (!isObject(schema[struct][j])) {
+					schema[struct].splice(j, 1);
+					j--;
+					continue;
+				}
+
 				schema[struct][j] = convertSchema(schema[struct][j], options);
 			}
+		} else if (schema[struct] === null) {
+			delete schema[struct];
 		} else if (typeof schema[struct] === 'object') {
 			schema[struct] = convertSchema(schema[struct], options);
 		}
 	}
 
-	if (typeof schema.properties === 'object') {
+	if ('properties' in schema) {
 		schema.properties = convertProperties(schema.properties, options);
 
 		if (Array.isArray(schema.required)) {
@@ -44,15 +53,13 @@ function convertSchema(schema, options) {
 		if (Object.keys(schema.properties).length === 0) {
 			delete schema.properties;
 		}
-
 	}
 
 	validateType(schema.type);
 	schema = convertTypes(schema);
 	schema = convertFormat(schema, options);
 
-	if (typeof schema['x-patternProperties'] === 'object'
-			&& options.supportPatternProperties) {
+	if ('x-patternProperties' in schema && options.supportPatternProperties) {
 		schema = convertPatternProperties(schema, options.patternPropertiesHandler);
 	}
 
@@ -78,10 +85,18 @@ function convertProperties(properties, options) {
 		, removeProp
 	;
 
+	if (!isObject(properties)) {
+		return props;
+	}
+
 	for (key in properties) {
 		removeProp = false;
 		property = properties[key];
 
+		if (!isObject(property)) {
+			continue;
+		}
+
 		options._removeProps.forEach(function(prop) {
 			if (property[prop] === true) {
 				removeProp = true;
@@ -189,7 +204,10 @@ function convertFormatByte (schema, settings) {
 }
 
 function convertPatternProperties(schema, handler) {
-	schema.patternProperties = schema['x-patternProperties'];
+	if (isObject(schema['x-patternProperties'])) {
+		schema.patternProperties = schema['x-patternProperties'];
+	}
+
 	delete schema['x-patternProperties'];
 
 	return handler(schema);

lib/utils/isObject.js

@@ -0,0 +1,3 @@
+exports.isObject = function (maybeObj) {
+	return maybeObj !== null && typeof maybeObj === 'object';
+};

test/combiners.test.js

@@ -0,0 +1,67 @@
+var test = require('tape')
+	, convert = require('../')
+;
+
+test('allOf is null', function(assert) {
+	var schema
+		, result
+		, expected
+  ;
+
+	assert.plan(1);
+
+	schema = {
+		allOf: null,
+	};
+
+	result = convert(schema);
+
+	expected = {
+		$schema: 'http://json-schema.org/draft-04/schema#',
+	};
+
+	assert.deepEqual(result, expected, 'allOf is removed');
+});
+
+test('anyOf is null', function(assert) {
+	var schema
+		, result
+		, expected
+  ;
+
+	assert.plan(1);
+
+	schema = {
+		anyOf: null,
+	};
+
+	result = convert(schema);
+
+	expected = {
+		$schema: 'http://json-schema.org/draft-04/schema#',
+	};
+
+	assert.deepEqual(result, expected, 'anyOf is removed');
+});
+
+
+test('oneOf is null', function(assert) {
+	var schema
+		, result
+		, expected
+  ;
+
+	assert.plan(1);
+
+	schema = {
+		oneOf: null,
+	};
+
+	result = convert(schema);
+
+	expected = {
+		$schema: 'http://json-schema.org/draft-04/schema#',
+	};
+
+	assert.deepEqual(result, expected, 'oneOf is removed');
+});

test/items.test.js

@@ -30,3 +30,50 @@ test('items', function(assert) {
 
 	assert.deepEqual(result, expected, 'converted');
 });
+
+test('handles items with invalid values', function(assert) {
+	var schema
+		, result
+		, expected
+  ;
+
+	assert.plan(1);
+
+	schema = {
+		type: 'array',
+		items: [
+			{
+				type: 'string'
+			},
+			2,
+			null,
+			{
+				type: 'number'
+			},
+			'foo',
+			{
+				type: 'array'
+			},
+		]
+	};
+
+	result = convert(schema);
+
+	expected = {
+		$schema: 'http://json-schema.org/draft-04/schema#',
+		type: 'array',
+		items: [
+			{
+				type: 'string'
+			},
+			{
+				type: 'number'
+			},
+			{
+				type: 'array'
+			},
+		]
+	};
+
+	assert.deepEqual(result, expected, 'converted');
+});

test/pattern_properties.test.js

@@ -173,6 +173,46 @@ test('handling additionalProperties with matching objects', function(assert) {
 	assert.deepEqual(result, expected, 'additionalProperties set to false');
 });
 
+test('handling null x-patternProperties', function(assert) {
+	var schema
+		, result
+		, expected
+  ;
+
+	assert.plan(2);
+
+	schema = {
+		type: 'object',
+		additionalProperties: {
+			type: 'object',
+			properties: {
+				test: {
+					type: 'string'
+				}
+			}
+		},
+		'x-patternProperties': null,
+	};
+
+	result = convert(schema, {supportPatternProperties: true});
+
+	expected = {
+		$schema: 'http://json-schema.org/draft-04/schema#',
+		type: 'object',
+		additionalProperties: {
+			type: 'object',
+			properties: {
+				test: {
+					type: 'string'
+				}
+			}
+		},
+	};
+
+	assert.deepEqual(result['x-patternProperties'], void 0, 'x-patternProperties to be gone');
+	assert.deepEqual(result, expected, 'additionalProperties to be preserved');
+});
+
 test('handling additionalProperties with non-matching objects', function(assert) {
 	var schema
 		, result

test/properties.test.js

@@ -44,6 +44,73 @@ test('properties', function(assert) {
 	assert.deepEqual(result, expected, 'converted');
 });
 
+test('properties value is null', function(assert) {
+	var schema
+		, result
+		, expected
+  ;
+
+	assert.plan(1);
+
+	schema = {
+		type: 'object',
+		properties: null,
+	};
+
+	result = convert(schema);
+
+	expected = {
+		$schema: 'http://json-schema.org/draft-04/schema#',
+		type: 'object',
+	};
+
+	assert.deepEqual(result, expected, 'successfully converted');
+});
+
+test('strips malformed properties children', function(assert) {
+	var schema
+		, result
+		, expected
+  ;
+
+	assert.plan(1);
+
+	schema = {
+		type: 'object',
+		required: ['bar'],
+		properties: {
+			foo: {
+				type: 'string',
+				example: '2017-01-01T12:34:56Z'
+			},
+			foobar: 2,
+			bar: {
+				type: 'string',
+				nullable: true
+			},
+			baz: null,
+		}
+	};
+
+	result = convert(schema);
+
+	expected = {
+		$schema: 'http://json-schema.org/draft-04/schema#',
+		type: 'object',
+		required: ['bar'],
+		properties: {
+			foo: {
+				type: 'string',
+			},
+			bar: {
+				type: ['string', 'null']
+			}
+		}
+	};
+
+	assert.deepEqual(result, expected, 'successfully converted');
+});
+
 test('additionalProperties is false', function(assert) {
 	var schema
 		, result