Send a tampered response
JSON definition · shared/definitions/relational-storage.v1.json
View on GitHub
{
"title": "Insurance claim",
"elements": [
{
"type": "text",
"name": "q_email",
"valueName": "customer_email",
"dbColumn": "claims.customer_email",
"title": "Email",
"inputType": "email",
"isRequired": true
},
{
"type": "text",
"name": "q_amount",
"valueName": "amount",
"dbColumn": "claims.amount",
"title": "Amount claimed",
"inputType": "number",
"min": 0
},
{
"type": "dropdown",
"name": "incident",
"title": "What happened?",
"choices": [
{
"value": "collision",
"text": "Collision"
},
{
"value": "theft",
"text": "Theft"
},
{
"value": "weather",
"text": "Storm or flood"
}
]
},
{
"type": "comment",
"name": "details",
"title": "Details"
},
{
"type": "boolean",
"name": "priority_handling",
"title": "Priority handling"
}
]
}
Client · shared/client/validate-response.js · sjs:validate-response.request
View on GitHub
// Inspect the submitted payload and the server's validation errors in Requests
async function submit(data) {
const payload = { formId: "claim", data };
const response = await fetch("/api/responses", {
method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify(payload)
});
const report = await response.json();
if (response.status === 400 && Array.isArray(report.errors) && report.errors.length) {
return { rejected: true, errors: report.errors };
}
if (!response.ok) throw new Error(report.error || "Couldn't validate the response. Please try again.");
if (!Number.isInteger(report.id) || report.id < 1) throw new Error("The server didn't confirm a saved response. Please try again.");
setStoredQuery({ id: report.id });
return { id: report.id };
}
Client · shared/client/validate-response.js · sjs:validate-response.client
View on GitHub
// Confirm a save only after the backend accepts the answers and returns a response ID
survey.onComplete.add(async (sender, options) => {
lock(true);
sender.completedHtml = "<h3>Submitting your claim...</h3>";
options.showSaveInProgress();
try {
const result = await submit(sender.data);
if (result.rejected) throw new Error(result.errors.map(describe).join("; "));
sender.completedHtml = `<h3>Your claim has been saved.</h3><p>Response ID: ${result.id}</p>`;
options.showSaveSuccess();
} catch (error) {
sender.completedHtml = "<h3>Your claim hasn't been saved.</h3>";
const message = error instanceof TypeError ? "Couldn't validate the response. Please try again." : error.message;
options.showSaveError(message);
} finally { lock(false); }
});
Server · examples/views/validate_response.py · sjs:validate-response.server
View on GitHub
# POST /api/responses — ask the SurveyJS service to validate, then store as usual
async def save(request: HttpRequest) -> JsonResponse:
# The raw body, not request.POST: the stored answers keep every key, {} and 1.0 (see Save Responses)
body = read_json(request)
if not isinstance(body, dict) or not isinstance(body.get("formId"), str) or not isinstance(body.get("data"), dict):
return JsonResponse({"error": "Expected { formId, data } with an answers object"}, status=400)
if (form := await Form.objects.filter(key=body["formId"]).afirst()) is None:
return JsonResponse({"error": "Unknown form"}, status=404)
surveyjs = SurveyJsService()
check = await surveyjs.post("/response", {"schema": json.loads(form.json), "response": body["data"]}, timeout=10)
answer: Any = None
with suppress(ValueError): # not JSON: fails closed below
answer = json.loads(check.content)
if check.status_code == 422 and isinstance(answer, dict) and "errors" in answer:
if "warnings" in answer: # the stored definition itself has errors
surveyjs.unexpected("/response", check, "The stored definition has errors")
return JsonResponse({"errors": answer["errors"]}, status=400) # the answers don't fit the definition
if check.status_code != 200 or answer != {}: # fail closed: only exactly {} means valid
surveyjs.unexpected("/response", check)
return JsonResponse({"id": await ainsert_response(body["formId"], body["data"])}, status=201) # 1.0 stays 1.0