Generate JSON Survey Schema - Bugs found #6227

BinoDino · 2023-05-19T12:00:38Z

Generate JSON Survey Schema - Bugs found

Hi,
I am currently working with the surveyjs form library. I used the Survey.Serializer.generateSchema() method in order to create the JSON schema for the survey. That is when I encountered some bugs in the schema + got error message "schema is invalid" using Ajv library.

Would be great if you could take a look at it 🙂 Sorry for the long message and thank you!

current schema

property `visible`

{
  "properties": {
     "visible": {
         "type": "string"
      }
   }
}

properties `title` and `description`

{
  "properties": {
     "title": {
         "type": "string"
      },
     "description": {
         "type": "string"
      }
   }
}

empty `enum` properties in schema

{
  "properties": {
    "questionTitlePattern": {
          "type": "string",
          "enum": []
      }
   },
  "definitions": {
    "question": {
       "properties": {
         "page": {
             "type": "string",
             "enum": []
         }
       }
     },
    "panel": {
     "allOf": [
        {},
        {
         "properties": {
            "page": {
             "type": "string",
             "enum": []
            }
          }
        }
     ]
   }
  }
}

properties `questions` (and others)

{
  "properties": {
     "questions": {
         "type": "array",
         "items": [ { }, { }, { } ]
      }
   }
}

references

$id:

{
   "htmlconditionitem": {
        "$id": "#htmlconditionitem"
   }
}

in properties:

{
  "properties": {
     "completedHtmlOnCondition": {
          "type": "array",
          "items": {
              "$ref": "#htmlconditionitem"
          }
      }
   }
}

in definitions:

{
  "definitions": {
     "htmlconditionitem": {
          "type": "object",
          "$id": "#htmlconditionitem",
          "allOf": [
              {
                  "$ref": "#expressionitem"
              },
              {
                  "properties": {
                      "html": {
                          "type": "string"
                      }
                  }
              }
          ]
      }
}

missing schemas

in definitions/selectbase/allOf/{1}/properties/choicesByUrl:

"choicesByUrl": {
    "type": "array",
    "items": {
        "$ref": "#ChoicesRestful"
    }
}

in definitions/text/allOf/{1}/properties/dataList:

"dataList": {
    "type": "array",
    "items": {
        "$ref": "#string"
    }
}

expected schema

property `visible`

visible is of type boolean.

{
  "properties": {
     "visible": {
         "type": "boolean"
      }
   }
}

properties `title` and `description`

title and description (and others?) are either a string or a translation object.

{
  "properties": {
     "title": {
         "oneOf": [
              { "type": "string"},
              { "$ref": "path/to/some/translation/object"}
          ]
      },
     "description": {
          "oneOf": [
              { "type": "string"},
              { "$ref": "path/to/some/translation/object"}
          ]
      }
   }
}

empty `enum` properties in schema

empty enum properties are not allowed

properties `questions` (and others)

Syntax error. Must be anyOf:

{
  "properties": {
     "questions": {
         "type": "array",
         "items": {
            "anyOf": [ { }, { }, { } ]
      }
   }
}

Also affected:

triggers
defintions/panelbase/properties/elements
defintions/question/properties/validators
defintions/matrixdropdowncolumn/properties/validators
defintions/multipletextitem/properties/validators
definitions/nonvalue/allOf/{1}/properties/validators
definitions/paneldynamic/allOf/{1}/properties/templateElements

references

$id - no hash symbol #

{
   "htmlconditionitem": {
        "$id": "htmlconditionitem"
   }
}

in properties - path is #/definitions/id:

{
  "properties": {
     "completedHtmlOnCondition": {
          "type": "array",
          "items": {
              "$ref": "#/definitions/htmlconditionitem"
          }
      }
   }
}

in definitions - hash symbol # after id name:

{
  "definitions": {
     "htmlconditionitem": {
          "type": "object",
          "$id": "#htmlconditionitem",
          "allOf": [
              {
                  "$ref": "expressionitem#"
              },
              {
                  "properties": {
                      "html": {
                          "type": "string"
                      }
                  }
              }
          ]
      }
}

missing schemas

provide missing schemas choicesRestful and string

Specifications

surveyjs platform (angular or react or jquery or knockout or vue): Angular
surveyjs version:
- survey-angular-ui: 1.9.86
- survey-core: 1.9.86

The text was updated successfully, but these errors were encountered:

andrewtelnov · 2023-05-21T08:40:20Z

@BinoDino I believe I have fixed everything, except localization string class.
I could not figure out how to define it.
It is an object that can have limited number of pairs: { {locName1: locValue1}, {locName2: locValue2} }.
Where locName is an enum ["default", "en", "fr", ...] and locValue is a string.

Thank you,
Andrew

BinoDino · 2023-05-22T06:27:26Z

@andrewtelnov Thank you very much for your fast feedback. I really appreciate that.

I think the only way to define the localization string class would be like this:

{
  "definitions": {
     "localization": {
        "type": "object",
         "$id": "localization",
         "properties": {
             "default": {
               "type": "string"
              },
              "ca": {
               "type": "string"
              },
              "cy": {
                "type": "string"
              },
              "da": {
                "type": "string"
              },
              "de": {
                 "type": "string"
              },
             (and so on)
         }
      }
   }
}

and then reference it like this (properties and definitions):

{
  "properties": {
     "title": {
          "oneOf": [
              { "type": "string"},
              { "$ref": "#/definitions/localization"}
          ]
      }
   },
 "definitions": {
    "itemvalue": {
        "type": "object",
        "properties": {
          "text": {
            "oneOf": [
              { "type": "string" },
              { "$ref": "localization#" }
            ]
          }
      }
    }
  }
}

BinoDino · 2023-05-22T12:12:30Z

@andrewtelnov sorry to write again, but I have found more bugs on the JSON schema.

The issues are the following:

1. Wrong data types

showCommentArea, isRequired, readOnly should be of type boolean

{
  "description":{
     "question": {
         "properties": {
           "showCommentArea": {
              "type": "string"
           },
           "isRequired": {
              "type": "string"
           },
           "readOnly": {
               "type": "string"
          }
       }
     }
  }
}

See also in definitions/panel/allOf/{1}/properties/isRequired

2. Double listing of properties

Example 1 (showCommentArea already listed in question):

{
   "definitions": {
       "selectbase": {
          "allOf": [
              {"$ref": "question#"},
              { "properties": {
                  "showCommentArea": {
                    "type": "string"
                   }
                }
             }
          ]
      }
   }
}

See also in

defintions/nonvalue/allOf/{1}/properties/isRequired
defintions/nonvalue/allOf/{1}/properties/readOnly
defintions/nonvalue/allOf/{1}/properties/showCommentArea
defintions/panel/allOf/{1}/properties/isRequired
defintions/panel/allOf/{1}/properties/readOnly
defintions/file/allOf/{1}/properties/showCommentArea
defintions/rating/allOf/{1}/properties/showCommentArea
defintions/boolean/allOf/{1}/properties/showCommentArea
defintions/panelDynamic/allOf/{1}/properties/showCommentArea
defintions/nonvalue/propertiesin general

3. Double listing and wrong data type on second listing

Initially separateSpecialChoices is boolean

{
   "definitions": {
       "selectbase": {
          "allOf": [
              {"$ref": "question#"},
              { "properties": {
                  "separateSpecialChoices": {
                      "type": "boolean"
                    }
                }
             }
          ]
      },
    "checkboxbase": {
          "type": "object",
          "$id": "checkboxbase",
          "allOf": [
            {
              "$ref": "selectbase#"
            }
         ]
     }
   }
}

Here it is a string now:

{
   "definitions": {
      "radiogroup": {
          "allOf": [
            {
              "$ref": "checkboxbase#"
            },
            {
              "properties": {
                "separateSpecialChoices": {
                  "type": "string"
                }
              }
            }
          ]
        },
      "checkbox": {
          "allOf": [
            {
              "$ref": "checkboxbase#"
            },
            {
              "properties": {
                "separateSpecialChoices": {
                  "type": "string"
                }
              }
            }
          ]
        }
    }
}

andrewtelnov · 2023-05-22T13:00:04Z

@BinoDino I beleived I have fixed issues. You can check this PR.
Hopefully it will be merged before we relase next version tomorrow/after tomorrow.

Thank you,
Andrew

BinoDino · 2023-05-22T13:09:44Z

@andrewtelnov Thank you very much for your efforts! 🙂 Will notify you if I come across anything else.

BinoDino · 2023-05-22T13:49:56Z

@andrewtelnov Sorry, I have something else - it's rather a question (or maybe a bug?):

I noticed that in the JSON schema there is no property type for the elements/questions. But when I use the Survey Creator a type property is even required (to identify the question type for rendering I suppose).

Moreover, I noticed that there are no required Schema fields at all. But isn't it for example like this:

a page requires a name as unique identifier
a question requires a name as unique identifier and a type to define what kind of question it is

andrewtelnov · 2023-05-22T15:16:02Z

@BinoDino I have added "type" property into "#question" and "#panel". It supports "required" array attribute as well.

Thank you,
Andrew

BinoDino · 2023-05-25T13:45:25Z

@andrewtelnov Thank you very much for the latest version of the surveyjs schema. I really appreciate your fast reply and fixes. I tested it today. Unfortunately I found two issues that were not fixed yet.

The issues are the following

1. Error message: `invalid schema: data/properties/questions/items must be object,boolean`

current schema

items attribute is an array

{
  "properties": {
     "questions": {
         "type": "array",
         "items": [...]
      }
   }
}

expected schema

items attribute is an object with anyOf, which is an array

{
  "properties": {
     "questions": {
         "type": "array",
         "items": {
            "anyOf": [...]
      }
   }
}

Affected:

properties/questions/items
properties/triggers/items
definitions/panelbase/properties/elements/items
definitions/question/properties/validators/items
definitions/matrixdropdowncolumn/properties/validators/items
definitions/multipletextitem/properties/validators/items
definitions/paneldynamic/allOf/{1}/properties/templateElements/items

2. Error message: `invalid schema: data/definitions/expressionitem/$id must match pattern "^[^#]*#?$"`

current schema

Every attribute $id starts with "#".

{
   "htmlconditionitem": {
        "$id": "#htmlconditionitem"
   }
}

expected schema

Remove "#" from $id, else it's invalid.

{
   "htmlconditionitem": {
        "$id": "htmlconditionitem"
   }
}

andrewtelnov · 2023-05-25T13:54:25Z

@BinoDino Regarding the second issue. Do you mean that all "$id" for all defintions should not have "#" symbol?

Thank you,
Andrew

BinoDino · 2023-05-26T05:56:08Z

@andrewtelnov To your question: yes, that is correct.

andrewtelnov · 2023-05-26T10:52:19Z

@BinoDino Please review my commits in this PR.

Thank you,
Andrew

* Fix $id property, remove # symbol #6227 * Fix items with baseClassName => items.anyOf[] #6227

BinoDino · 2023-05-30T08:00:08Z

@andrewtelnov sorry for my late answer. Your commits look good as far as I can evaluate 👍 Thank you so so much!

andrewtelnov · 2023-05-30T08:02:49Z

@BinoDino Super, we are going to release v1.9.90 today.

Thank you,
Andrw

andrewtelnov self-assigned this May 19, 2023

andrewtelnov added bug user issue An issue or bug reported by users labels May 19, 2023

andrewtelnov added a commit that referenced this issue May 21, 2023

Generate JSON Survey Schema - Bugs found #6227

357f60d

andrewtelnov added a commit that referenced this issue May 22, 2023

Add locString object into definition #6227

725e7b0

andrewtelnov added a commit that referenced this issue May 22, 2023

Do not add a property into class if it was defined before fix #6227

a23e06b

andrewtelnov added a commit that referenced this issue May 22, 2023

Add type property and required attribuite #6227

616fb49

tsv2013 closed this as completed in f12d5b3 May 23, 2023

OlgaLarina added this to the v1.9.89 milestone May 23, 2023

andrewtelnov reopened this May 25, 2023

andrewtelnov modified the milestones: v1.9.89, v1.9.90 May 25, 2023

andrewtelnov added a commit that referenced this issue May 26, 2023

Fix $id property, remove # symbol #6227

cf9c358

andrewtelnov added a commit that referenced this issue May 26, 2023

Fix items with baseClassName => items.anyOf[] #6227

b80dd68

tsv2013 pushed a commit that referenced this issue May 29, 2023

Bug/6227 correct json schema (#6254)

0fc960c

* Fix $id property, remove # symbol #6227 * Fix items with baseClassName => items.anyOf[] #6227

andrewtelnov closed this as completed Jun 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate JSON Survey Schema - Bugs found #6227

Generate JSON Survey Schema - Bugs found #6227

BinoDino commented May 19, 2023

andrewtelnov commented May 21, 2023

BinoDino commented May 22, 2023 •

edited

BinoDino commented May 22, 2023 •

edited

andrewtelnov commented May 22, 2023

BinoDino commented May 22, 2023

BinoDino commented May 22, 2023

andrewtelnov commented May 22, 2023

BinoDino commented May 25, 2023

andrewtelnov commented May 25, 2023

BinoDino commented May 26, 2023

andrewtelnov commented May 26, 2023

BinoDino commented May 30, 2023

andrewtelnov commented May 30, 2023

Generate JSON Survey Schema - Bugs found #6227

Generate JSON Survey Schema - Bugs found #6227

Comments

BinoDino commented May 19, 2023

Generate JSON Survey Schema - Bugs found

current schema

property visible

properties title and description

empty enum properties in schema

properties questions (and others)

references

missing schemas

expected schema

property visible

properties title and description

empty enum properties in schema

properties questions (and others)

references

missing schemas

Specifications

andrewtelnov commented May 21, 2023

BinoDino commented May 22, 2023 • edited

BinoDino commented May 22, 2023 • edited

The issues are the following:

andrewtelnov commented May 22, 2023

BinoDino commented May 22, 2023

BinoDino commented May 22, 2023

andrewtelnov commented May 22, 2023

BinoDino commented May 25, 2023

The issues are the following

1. Error message: invalid schema: data/properties/questions/items must be object,boolean

current schema

expected schema

2. Error message: invalid schema: data/definitions/expressionitem/$id must match pattern "^[^#]*#?$"

current schema

expected schema

andrewtelnov commented May 25, 2023

BinoDino commented May 26, 2023

andrewtelnov commented May 26, 2023

BinoDino commented May 30, 2023

andrewtelnov commented May 30, 2023

property `visible`

properties `title` and `description`

empty `enum` properties in schema

properties `questions` (and others)

property `visible`

properties `title` and `description`

empty `enum` properties in schema

properties `questions` (and others)

BinoDino commented May 22, 2023 •

edited

BinoDino commented May 22, 2023 •

edited

1. Error message: `invalid schema: data/properties/questions/items must be object,boolean`

2. Error message: `invalid schema: data/definitions/expressionitem/$id must match pattern "^[^#]*#?$"`