kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#1892 infinite loop when rendering self-references

Browse Source
This commit is contained in:
Anna Bodnia
2016-01-21 18:36:00 +02:00
parent a9bbf31cc7
commit 9a5925f921
8 changed files with 144 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
dist/css/print.css vendored
View File

@@ -82,7 +82,7 @@
.swagger-section pre .vhdl .attribute,
.swagger-section pre .clojure .attribute,
.swagger-section pre .coffeescript .property {
color: #8888ff;
color: #88F;
}
.swagger-section pre .keyword,
.swagger-section pre .id,

2
dist/css/screen.css vendored
View File

@@ -82,7 +82,7 @@
.swagger-section pre .vhdl .attribute,
.swagger-section pre .clojure .attribute,
.swagger-section pre .coffeescript .property {
color: #8888ff;
color: #88F;
}
.swagger-section pre .keyword,
.swagger-section pre .id,

47
dist/swagger-ui.js vendored
View File

@@ -27015,6 +27015,7 @@ SwaggerUi.partials.signature = (function () {
var createArrayXML = function (descriptor) {
var name = descriptor.name;
var config = descriptor.config;
var definition = descriptor.definition;
var models = descriptor.models;
var value;
@@ -27023,7 +27024,7 @@ SwaggerUi.partials.signature = (function () {
if (!items) { return getErrorMessage(); }
value = createSchemaXML(name, items, models);
value = createSchemaXML(name, items, models, config);
xml = xml || {};
@@ -27082,8 +27083,9 @@ SwaggerUi.partials.signature = (function () {
function createObjectXML (descriptor) {
var name = descriptor.name;
var definition = descriptor.definition;
var config = descriptor.config;
var models = descriptor.models;
var isParam = descriptor.isParam;
var isParam = descriptor.config.isParam;
var serializedProperties;
var attrs = [];
var properties = definition.properties;
@@ -27102,10 +27104,12 @@ SwaggerUi.partials.signature = (function () {
serializedProperties = _.map(properties, function (prop, key) {
var xml, result;
if (isParam && prop.readOnly) { return ''; }
if (isParam && prop.readOnly) {
return '';
}
xml = prop.xml || {};
result = createSchemaXML(key, prop, models);
result = createSchemaXML(key, prop, models, config);
if (xml.attribute) {
attrs.push(result);
@@ -27122,14 +27126,18 @@ SwaggerUi.partials.signature = (function () {
return wrapTag(name, serializedProperties, attrs);
}
function getInfiniteLoopMessage (name) {
return '<!-- Infinite loop to model ' + name + ' -->';
}
function getErrorMessage () {
return '<!-- invalid XML -->';
}
function createSchemaXML (name, definition, models, isParam) {
function createSchemaXML (name, definition, models, config) {
var $ref = definition.$ref;
var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models)
: getDescriptor(name, definition, models, isParam);
var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models, config)
: getDescriptor(name, definition, models, config);
if (!descriptor) {
return getErrorMessage();
@@ -27140,37 +27148,48 @@ SwaggerUi.partials.signature = (function () {
return createArrayXML(descriptor);
case 'object':
return createObjectXML(descriptor);
case 'loop':
return getInfiniteLoopMessage(descriptor.name);
default:
return createPrimitiveXML(descriptor);
}
}
function Descriptor (name, type, definition, models, isParam) {
function Descriptor (name, type, definition, models, config) {
if (arguments.length < 4) {
throw new Error();
}
this.config = config || {};
this.config.modelsToIgnore = this.config.modelsToIgnore || [];
this.name = name;
this.definition = definition;
this.models = models;
this.type = type;
this.isParam = isParam;
}
function getDescriptorByRef($ref, models) {
function getDescriptorByRef($ref, models, config) {
var modelType = simpleRef($ref);
var model = models[modelType] || {};
var name = model.name || modelType;
var type = model.type || 'object';
config = config || {};
config.modelsToIgnore = config.modelsToIgnore || [];
if (config.modelsToIgnore.indexOf(name) > -1) {
type = 'loop';
} else {
config.modelsToIgnore.push(modelType);
}
if (!model.definition) {
return null;
}
return new Descriptor (name, type, model.definition, models);
return new Descriptor(name, type, model.definition, models, config);
}
function getDescriptor (name, definition, models, isParam){
function getDescriptor (name, definition, models, config){
var type = definition.type || 'object';
var xml = definition.xml || {};
@@ -27180,13 +27199,13 @@ SwaggerUi.partials.signature = (function () {
name = getName(name, xml);
return new Descriptor(name, type, definition, models,isParam);
return new Descriptor(name, type, definition, models, config);
}
function createXMLSample (definition, models, isParam) {
var prolog = '<?xml version="1.0"?>';
return formatXml(prolog + createSchemaXML('', definition, models, isParam));
return formatXml(prolog + createSchemaXML('', definition, models, { isParam: isParam } ));
}
return {

6
dist/swagger-ui.min.js vendored
View File

File diff suppressed because one or more lines are too long

2
src/main/html/css/print.css
View File

@@ -82,7 +82,7 @@
.swagger-section pre .vhdl .attribute,
.swagger-section pre .clojure .attribute,
.swagger-section pre .coffeescript .property {
color: #8888ff;
color: #88F;
}
.swagger-section pre .keyword,
.swagger-section pre .id,

2
src/main/html/css/screen.css
View File

@@ -82,7 +82,7 @@
.swagger-section pre .vhdl .attribute,
.swagger-section pre .clojure .attribute,
.swagger-section pre .coffeescript .property {
color: #8888ff;
color: #88F;
}
.swagger-section pre .keyword,
.swagger-section pre .id,

47
src/main/javascript/view/partials/signature.js
View File

@@ -712,6 +712,7 @@ SwaggerUi.partials.signature = (function () {
var createArrayXML = function (descriptor) {
var name = descriptor.name;
var config = descriptor.config;
var definition = descriptor.definition;
var models = descriptor.models;
var value;
@@ -720,7 +721,7 @@ SwaggerUi.partials.signature = (function () {
if (!items) { return getErrorMessage(); }
value = createSchemaXML(name, items, models);
value = createSchemaXML(name, items, models, config);
xml = xml || {};
@@ -779,8 +780,9 @@ SwaggerUi.partials.signature = (function () {
function createObjectXML (descriptor) {
var name = descriptor.name;
var definition = descriptor.definition;
var config = descriptor.config;
var models = descriptor.models;
var isParam = descriptor.isParam;
var isParam = descriptor.config.isParam;
var serializedProperties;
var attrs = [];
var properties = definition.properties;
@@ -799,10 +801,12 @@ SwaggerUi.partials.signature = (function () {
serializedProperties = _.map(properties, function (prop, key) {
var xml, result;
if (isParam && prop.readOnly) { return ''; }
if (isParam && prop.readOnly) {
return '';
}
xml = prop.xml || {};
result = createSchemaXML(key, prop, models);
result = createSchemaXML(key, prop, models, config);
if (xml.attribute) {
attrs.push(result);
@@ -819,14 +823,18 @@ SwaggerUi.partials.signature = (function () {
return wrapTag(name, serializedProperties, attrs);
}
function getInfiniteLoopMessage (name) {
return '<!-- Infinite loop to model ' + name + ' -->';
}
function getErrorMessage () {
return '<!-- invalid XML -->';
}
function createSchemaXML (name, definition, models, isParam) {
function createSchemaXML (name, definition, models, config) {
var $ref = definition.$ref;
var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models)
: getDescriptor(name, definition, models, isParam);
var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models, config)
: getDescriptor(name, definition, models, config);
if (!descriptor) {
return getErrorMessage();
@@ -837,37 +845,48 @@ SwaggerUi.partials.signature = (function () {
return createArrayXML(descriptor);
case 'object':
return createObjectXML(descriptor);
case 'loop':
return getInfiniteLoopMessage(descriptor.name);
default:
return createPrimitiveXML(descriptor);
}
}
function Descriptor (name, type, definition, models, isParam) {
function Descriptor (name, type, definition, models, config) {
if (arguments.length < 4) {
throw new Error();
}
this.config = config || {};
this.config.modelsToIgnore = this.config.modelsToIgnore || [];
this.name = name;
this.definition = definition;
this.models = models;
this.type = type;
this.isParam = isParam;
}
function getDescriptorByRef($ref, models) {
function getDescriptorByRef($ref, models, config) {
var modelType = simpleRef($ref);
var model = models[modelType] || {};
var name = model.name || modelType;
var type = model.type || 'object';
config = config || {};
config.modelsToIgnore = config.modelsToIgnore || [];
if (config.modelsToIgnore.indexOf(name) > -1) {
type = 'loop';
} else {
config.modelsToIgnore.push(modelType);
}
if (!model.definition) {
return null;
}
return new Descriptor (name, type, model.definition, models);
return new Descriptor(name, type, model.definition, models, config);
}
function getDescriptor (name, definition, models, isParam){
function getDescriptor (name, definition, models, config){
var type = definition.type || 'object';
var xml = definition.xml || {};
@@ -877,13 +896,13 @@ SwaggerUi.partials.signature = (function () {
name = getName(name, xml);
return new Descriptor(name, type, definition, models,isParam);
return new Descriptor(name, type, definition, models, config);
}
function createXMLSample (definition, models, isParam) {
var prolog = '<?xml version="1.0"?>';
return formatXml(prolog + createSchemaXML('', definition, models, isParam));
return formatXml(prolog + createSchemaXML('', definition, models, { isParam: isParam } ));
}
return {

72
test/unit/view/partials/signatureSpec.js
View File

@@ -61,6 +61,44 @@ describe('SwaggerUi.partials.signature tests', function () {
'xml': { 'name': 'Tag' }
},
'name': 'Tag'
},
'Loop1': {
'definition': {
'type': 'object',
'properties': {
'id': { 'type': 'integer'},
'loop2': {
'$ref': '#/definitions/Loop2'
}
},
'xml': { 'name': 'Loop1' }
},
'name': 'Loop1'
},
'Loop2': {
'definition': {
'type': 'object',
'properties': {
'id': { 'type': 'integer'},
'loop1': {
'$ref': '#/definitions/Loop1'
}
},
'xml': { 'name': 'Loop2' }
},
'name': 'Loop2'
},
'Loop3': {
'definition': {
'type': 'object',
'properties' : {
'loop1': {
'$ref': '#/definitions/Loop1'
}
},
'xml': { 'name': 'Loop3' }
},
'name': 'Loop3'
}
};
@@ -438,7 +476,7 @@ describe('SwaggerUi.partials.signature tests', function () {
}
};
expect(sut.createSchemaXML(name, definition, models, true)).to.equal(expected);
expect(sut.createSchemaXML(name, definition, models, { isParam: true })).to.equal(expected);
});
it('returns object with passed parameter as attribute', function () {
@@ -510,6 +548,38 @@ describe('SwaggerUi.partials.signature tests', function () {
expect(sut.createSchemaXML('', schema, models)).to.equal(expected);
});
it('infinite loop Loop1 => Loop2, Loop2 => Loop1', function () {
var expected = '<Loop1>' +
'<id>1</id>' +
'<Loop2>' +
'<id>1</id>' +
'<!-- Infinite loop to model Loop1 -->' +
'</Loop2>' +
'</Loop1>';
var schema = {
$ref: '#/definitions/Loop1'
};
expect(sut.createSchemaXML('', schema, models)).to.equal(expected);
});
it('infinite loop Loop3 => Loop1, Loop1 => Loop2, Loop2 => Loop1', function () {
var expected = '<Loop3>' +
'<Loop1>' +
'<id>1</id>' +
'<Loop2>' +
'<id>1</id>' +
'<!-- Infinite loop to model Loop1 -->' +
'</Loop2>' +
'</Loop1>' +
'</Loop3>';
var schema = {
$ref: '#/definitions/Loop3'
};
expect(sut.createSchemaXML('', schema, models)).to.equal(expected);
});
});
});
});