Client-side fixes for delayed NOTIFY receipt.

tglsfdc · tglsfdc · commit ecc59e31a81e · 2018-10-19T22:22:57.000-04:00
PQnotifies() is defined to just process already-read data, not try to read any more from the socket. (This is a debatable decision, perhaps, but I'm hesitant to change longstanding library behavior.) The documentation has long recommended calling PQconsumeInput() before PQnotifies() to ensure that any already-arrived message would get absorbed and processed. However, psql did not get that memo, which explains why it's not very reliable about reporting notifications promptly. Also, most (not quite all) callers called PQconsumeInput() just once before a PQnotifies() loop. Taking this recommendation seriously implies that we should do PQconsumeInput() before each call. This is more important now that we have "payload" strings in notification messages than it was before; that increases the probability of having more than one packet's worth of notify messages. Hence, adjust code as well as documentation examples to do it like that. Back-patch to 9.5 to match related server fixes. In principle we could probably go back further with these changes, but given lack of field complaints I doubt it's worthwhile. Discussion: https://postgr.es/m/CAOYf6ec-TmRYjKBXLLaGaB-jrd=mjG1Hzn1a1wufUAR39PQYhw@mail.gmail.com
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
@@ -5215,7 +5215,7 @@ typedef struct pgNotify
   <para>
    <function>PQnotifies</function> does not actually read data from the
    server; it just returns messages previously absorbed by another
-   <application>libpq</application> function.  In prior releases of
+   <application>libpq</application> function.  In ancient releases of
    <application>libpq</application>, the only way to ensure timely receipt
    of <command>NOTIFY</> messages was to constantly submit commands, even
    empty ones, and then check <function>PQnotifies</function> after each
@@ -8608,6 +8608,7 @@ main(int argc, char **argv)
                     notify->relname, notify->be_pid);
             PQfreemem(notify);
             nnotifies++;
+            PQconsumeInput(conn);
         }
     }
 
diff --git a/src/bin/psql/common.c b/src/bin/psql/common.c
@@ -788,7 +788,8 @@ PrintNotifications(void)
 {
 	PGnotify   *notify;
 
-	while ((notify = PQnotifies(pset.db)))
+	PQconsumeInput(pset.db);
+	while ((notify = PQnotifies(pset.db)) != NULL)
 	{
 		/* for backward compatibility, only show payload if nonempty */
 		if (notify->extra[0])
@@ -799,6 +800,7 @@ PrintNotifications(void)
 					notify->relname, notify->be_pid);
 		fflush(pset.queryFout);
 		PQfreemem(notify);
+		PQconsumeInput(pset.db);
 	}
 }
 
diff --git a/src/interfaces/ecpg/ecpglib/execute.c b/src/interfaces/ecpg/ecpglib/execute.c
@@ -1729,12 +1729,13 @@ ecpg_process_output(struct statement *stmt, bool clear_result)
 	}
 
 	/* check for asynchronous returns */
-	notify = PQnotifies(stmt->connection->connection);
-	if (notify)
+	PQconsumeInput(stmt->connection->connection);
+	while ((notify = PQnotifies(stmt->connection->connection)) != NULL)
 	{
 		ecpg_log("ecpg_process_output on line %d: asynchronous notification of \"%s\" from backend PID %d received\n",
 				 stmt->lineno, notify->relname, notify->be_pid);
 		PQfreemem(notify);
+		PQconsumeInput(stmt->connection->connection);
 	}
 
 	return status;
diff --git a/src/interfaces/libpq/fe-exec.c b/src/interfaces/libpq/fe-exec.c
@@ -2239,6 +2239,9 @@ PQsendDescribe(PGconn *conn, char desc_type, const char *desc_target)
  * no unhandled async notification from the backend
  *
  * the CALLER is responsible for FREE'ing the structure returned
+ *
+ * Note that this function does not read any new data from the socket;
+ * so usually, caller should call PQconsumeInput() first.
  */
 PGnotify *
 PQnotifies(PGconn *conn)
diff --git a/src/test/examples/testlibpq2.c b/src/test/examples/testlibpq2.c
@@ -140,6 +140,7 @@ main(int argc, char **argv)
 					notify->relname, notify->be_pid);
 			PQfreemem(notify);
 			nnotifies++;
+			PQconsumeInput(conn);
 		}
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -788,7 +788,8 @@ PrintNotifications(void)`
`788`	`788`	`{`
`789`	`789`	`PGnotify *notify;`
`790`	`790`
`791`		`- while ((notify = PQnotifies(pset.db)))`
	`791`	`+ PQconsumeInput(pset.db);`
	`792`	`+ while ((notify = PQnotifies(pset.db)) != NULL)`
`792`	`793`	`{`
`793`	`794`	`/* for backward compatibility, only show payload if nonempty */`
`794`	`795`	`if (notify->extra[0])`
`@@ -799,6 +800,7 @@ PrintNotifications(void)`
`799`	`800`	`notify->relname, notify->be_pid);`
`800`	`801`	`fflush(pset.queryFout);`
`801`	`802`	`PQfreemem(notify);`
	`803`	`+ PQconsumeInput(pset.db);`
`802`	`804`	`}`
`803`	`805`	`}`
`804`	`806`
Original file line number	Diff line number	Diff line change
`@@ -1729,12 +1729,13 @@ ecpg_process_output(struct statement *stmt, bool clear_result)`
`1729`	`1729`	`}`
`1730`	`1730`
`1731`	`1731`	`/* check for asynchronous returns */`
`1732`		`- notify = PQnotifies(stmt->connection->connection);`
`1733`		`- if (notify)`
	`1732`	`+ PQconsumeInput(stmt->connection->connection);`
	`1733`	`+ while ((notify = PQnotifies(stmt->connection->connection)) != NULL)`
`1734`	`1734`	`{`
`1735`	`1735`	`ecpg_log("ecpg_process_output on line %d: asynchronous notification of \"%s\" from backend PID %d received\n",`
`1736`	`1736`	`stmt->lineno, notify->relname, notify->be_pid);`
`1737`	`1737`	`PQfreemem(notify);`
	`1738`	`+ PQconsumeInput(stmt->connection->connection);`
`1738`	`1739`	`}`
`1739`	`1740`
`1740`	`1741`	`return status;`
Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,7 @@ main(int argc, char **argv)`
`140`	`140`	`notify->relname, notify->be_pid);`
`141`	`141`	`PQfreemem(notify);`
`142`	`142`	`nnotifies++;`
	`143`	`+ PQconsumeInput(conn);`
`143`	`144`	`}`
`144`	`145`	`}`
`145`	`146`