BUG #16171: Potential malformed JSON in explain output
The Post Office <noreply@postgresql.org>
From: PG Bug reporting form <noreply@postgresql.org>
To: pgsql-bugs@lists.postgresql.org
Cc: mahadevan@rapidloop.com
Date: 2019-12-18T10:28:43Z
Lists: pgsql-bugs, pgsql-hackers
The following bug has been logged on the website:
Bug reference: 16171
Logged by: Mahadevan Ramachandran
Email address: mahadevan@rapidloop.com
PostgreSQL version: 12.1
Operating system: any
Description:
Refer src/backend/commands/explain.c, version 12.1.
When a plan node has children, the function ExplainNode starts a JSON array
with the key "Plans" (line 1955), like so:
"Plans": [
with the intention of creating an array of "Plan" objects, one for each
child:
"Plans": [
{ .. a child plan goes here ..},
{ .. a child plan goes here ..}
]
However, if the node (the current, parent one) is of a certain type (see
switch at line 1975), then ExplainMemberNodes is called, which does this
(lines 3335-6):
if (nsubnodes < nplans)
ExplainPropertyInteger("Subplans Removed", NULL, nplans - nsubnodes,
es);
This can potentially cause a malformed JSON output like this:
"Plans": [
{ .. a child plan goes here ..},
"Subplans Removed": 5,
{ .. a child plan goes here ..}
]
I don't have a sample explain output that exhibits this error, this was
found while reviewing the code.
Commits
-
Fix handling of "Subplans Removed" field in EXPLAIN output.
- 9a85860e12aa 12.2 landed
- 842a23efa92a 11.7 landed
- 7d91b604d9b5 13.0 landed
-
Doc: Fix list of storage parameters available for ALTER TABLE
- c4c76d198e3d 12.2 cited