Custom required property is not validated

[danlevison]

Can you help me understand why adding a required property to the 'survey' class does not get picked up by the jsonErrors array when it is missing.

See demo - https://codesandbox.io/p/devbox/recursing-danilo-v66p9l?workspaceId=ws_UBrjJL1E93iKDqX3Nj8Spq

I've added a property 'version' to the 'survey' class and set 'isRequired': true. However, when I load json with the 'version' property missing, it does not get picked up by the survey.fromJSON(json, { validatePropertyValues: true });

Originally posted by @danlevison in #10741 (comment)

[JaneSjs]

[Updated]

It appears that survey JSON validation doesn't validate required errors attached to a survey instance. We'll research this issue.

[danlevison]

Hi @JaneSjs,

I'm slightly confused by this because if I change the Serializer class in which I attach my required custom property to, then it does work as I expect and pushes an error in the jsonErrors array.

See example here - https://codesandbox.io/p/sandbox/morning-hill-752rds

Only thing I changed from my original demo was this line (I put my custom property on the question class):

Serializer.addProperty("question", { name: "version", isRequired: true });

You can see from the console log there is a jsonError because my custom 'version' property is missing.

If I use this line and put my custom property on the survey class then it does not include the jsonError and the console log just logs null:

Serializer.addProperty("survey", { name: "version", isRequired: true });

[andrewtelnov]

Here's a refined version of your reply:

---

@danlevison It seems your CodeSandbox example might be private. You can find a working Plunker property here: working plunker property.

Please note that we have the survey.sjsVersion property. If you want to store the SurveyJS version to track which version your survey was created with, please use the following code provided by Jane:

creator.storeSjsVersion = true; 

If your scenario is not related to SurveyJS versions, feel free to use my example.

Thank you,
Andrew

[danlevison]

@andrewtelnov Apologies the codesandbox example is now public. My issue is related to the Form Library rather than the Creator. Please see the example here - https://codesandbox.io/p/sandbox/morning-hill-752rds in comparison to https://codesandbox.io/p/devbox/recursing-danilo-v66p9l?workspaceId=ws_UBrjJL1E93iKDqX3Nj8Spq

a custom required property that is added to question class is flagged when missing in the json but a custom required property added to the survey class is not

[JaneSjs]

Hi @danlevison,
Thank you for the clarification. We'll research this issue and update you as soon as we get any news to share. Please stay tuned.

---

In the following demo, a custom "version" property is registered for "survey" and "question".
View in CodeSandbox

Survey JSON definition:

{
  elements: [
    {
      type: "text",
      name: "name",
      title: "Enter your name:",
    },
  ],
}

When loading the above JSON using survey.fromJSON(json, { validatePropertyValues: true }), the jsonErrors array contains JsonRequiredPropertyError related to the version property missing in a Text question: "The property 'version' is required in class 'text'." However, the jsonErrors doesn't contain information that the "version" property is missing in the "survey" object.

[andrewtelnov]

@danlevison It is fixed by the PR above. Thank you for reporting it.

Thank you,
Andrew