[html5] r7988 - [e] (0) Encourage more detailed debugging aids for EventSource Fixing https://ww [...]

whatwg at whatwg.org whatwg at whatwg.org
Tue Jun 18 16:27:49 PDT 2013


Author: ianh
Date: 2013-06-18 16:27:48 -0700 (Tue, 18 Jun 2013)
New Revision: 7988

Modified:
   complete.html
   index
   source
Log:
[e] (0) Encourage more detailed debugging aids for EventSource
Fixing https://www.w3.org/Bugs/Public/show_bug.cgi?id=21876
Affected topics: HTML

Modified: complete.html
===================================================================
--- complete.html	2013-06-18 22:37:17 UTC (rev 7987)
+++ complete.html	2013-06-18 23:27:48 UTC (rev 7988)
@@ -1090,13 +1090,14 @@
      <li><a href=#processing-model-7><span class=secno>10.2.3 </span>Processing model</a></li>
      <li><a href=#parsing-an-event-stream><span class=secno>10.2.4 </span>Parsing an event stream</a></li>
      <li><a href=#event-stream-interpretation><span class=secno>10.2.5 </span>Interpreting an event stream</a></li>
-     <li><a href=#notes><span class=secno>10.2.6 </span>Notes</a></li>
+     <li><a href=#authoring-notes><span class=secno>10.2.6 </span>Authoring notes</a></li>
      <li><a href=#eventsource-push><span class=secno>10.2.7 </span>Connectionless push and other features</a></li>
      <li><a href=#garbage-collection-0><span class=secno>10.2.8 </span>Garbage collection</a></li>
-     <li><a href=#iana-considerations><span class=secno>10.2.9 </span>IANA considerations</a>
+     <li><a href=#implementation-advice><span class=secno>10.2.9 </span>Implementation advice</a></li>
+     <li><a href=#iana-considerations><span class=secno>10.2.10 </span>IANA considerations</a>
       <ol>
-       <li><a href=#text/event-stream><span class=secno>10.2.9.1 </span><code>text/event-stream</code></a></li>
-       <li><a href=#last-event-id><span class=secno>10.2.9.2 </span><code>Last-Event-ID</code></a></ol></ol></li>
+       <li><a href=#text/event-stream><span class=secno>10.2.10.1 </span><code>text/event-stream</code></a></li>
+       <li><a href=#last-event-id><span class=secno>10.2.10.2 </span><code>Last-Event-ID</code></a></ol></ol></li>
    <li><a href=#network><span class=secno>10.3 </span>Web sockets</a>
     <ol>
      <li><a href=#network-intro><span class=secno>10.3.1 </span>Introduction</a></li>
@@ -81174,7 +81175,7 @@
   </div>
 
 
-  <h4 id=notes><span class=secno>10.2.6 </span>Notes</h4>
+  <h4 id=authoring-notes><span class=secno>10.2.6 </span>Authoring notes</h4>
 
   <p>Legacy proxy servers are known to, in certain cases, drop HTTP
   connections after a short timeout. To protect against such proxy
@@ -81307,10 +81308,29 @@
   actual underlying download.</p>
 
 
-  <h4 id=iana-considerations><span class=secno>10.2.9 </span>IANA considerations</h4>
+  <h4 id=implementation-advice><span class=secno>10.2.9 </span>Implementation advice</h4>
 
-  <h5 id=text/event-stream><span class=secno>10.2.9.1 </span><dfn><code>text/event-stream</code></dfn></h5>
+  <p><i>This section is non-normative.</i></p>
 
+  <p>User agents are strongly urged to provide detailed diagnostic information about
+  <code><a href=#eventsource>EventSource</a></code> objects and their related network connections in their development
+  consoles, to aid authors in debugging code using this API.</p>
+
+  <p>For example, a user agent could have a panel displaying all the <code><a href=#eventsource>EventSource</a></code>
+  objects a page has created, each listing the constructor's arguments, whether there was a network
+  error, what the CORS status of the connection is and what headers were sent by the client and
+  received from the server to lead to that status, the messages that were received and how they were
+  parsed, and so forth.</p>
+
+  <p>Implementations are especially encouraged to report detailed information to their development
+  consoles whenever an <code title=event-error>error</code> event is fired, since little to no
+  information can be made available in the events themselves.</p>
+
+
+  <h4 id=iana-considerations><span class=secno>10.2.10 </span>IANA considerations</h4>
+
+  <h5 id=text/event-stream><span class=secno>10.2.10.1 </span><dfn><code>text/event-stream</code></dfn></h5>
+
   <p>This registration is for community review and will be submitted
   to the IESG for review, approval, and registration with IANA.</p>
 
@@ -81398,7 +81418,7 @@
   <code><a href=#text/event-stream>text/event-stream</a></code> resources.</p>
 
 
-  <h5 id=last-event-id><span class=secno>10.2.9.2 </span><dfn title=http-last-event-id><code>Last-Event-ID</code></dfn></h5>
+  <h5 id=last-event-id><span class=secno>10.2.10.2 </span><dfn title=http-last-event-id><code>Last-Event-ID</code></dfn></h5>
 
   <p>This section describes a header field for registration in the
   Permanent Message Header Field Registry.  <a href=#refsRFC3864>[RFC3864]</a></p>
@@ -102270,6 +102290,7 @@
   Dimitri Glazkov,
   Dimitry Golubovsky,
   Dirk Pranke,
+  Dirkjan Ochtman,
   Divya Manian,
   Dmitry Titov,
   dolphinling,

Modified: index
===================================================================
--- index	2013-06-18 22:37:17 UTC (rev 7987)
+++ index	2013-06-18 23:27:48 UTC (rev 7988)
@@ -1090,13 +1090,14 @@
      <li><a href=#processing-model-7><span class=secno>10.2.3 </span>Processing model</a></li>
      <li><a href=#parsing-an-event-stream><span class=secno>10.2.4 </span>Parsing an event stream</a></li>
      <li><a href=#event-stream-interpretation><span class=secno>10.2.5 </span>Interpreting an event stream</a></li>
-     <li><a href=#notes><span class=secno>10.2.6 </span>Notes</a></li>
+     <li><a href=#authoring-notes><span class=secno>10.2.6 </span>Authoring notes</a></li>
      <li><a href=#eventsource-push><span class=secno>10.2.7 </span>Connectionless push and other features</a></li>
      <li><a href=#garbage-collection-0><span class=secno>10.2.8 </span>Garbage collection</a></li>
-     <li><a href=#iana-considerations><span class=secno>10.2.9 </span>IANA considerations</a>
+     <li><a href=#implementation-advice><span class=secno>10.2.9 </span>Implementation advice</a></li>
+     <li><a href=#iana-considerations><span class=secno>10.2.10 </span>IANA considerations</a>
       <ol>
-       <li><a href=#text/event-stream><span class=secno>10.2.9.1 </span><code>text/event-stream</code></a></li>
-       <li><a href=#last-event-id><span class=secno>10.2.9.2 </span><code>Last-Event-ID</code></a></ol></ol></li>
+       <li><a href=#text/event-stream><span class=secno>10.2.10.1 </span><code>text/event-stream</code></a></li>
+       <li><a href=#last-event-id><span class=secno>10.2.10.2 </span><code>Last-Event-ID</code></a></ol></ol></li>
    <li><a href=#network><span class=secno>10.3 </span>Web sockets</a>
     <ol>
      <li><a href=#network-intro><span class=secno>10.3.1 </span>Introduction</a></li>
@@ -81174,7 +81175,7 @@
   </div>
 
 
-  <h4 id=notes><span class=secno>10.2.6 </span>Notes</h4>
+  <h4 id=authoring-notes><span class=secno>10.2.6 </span>Authoring notes</h4>
 
   <p>Legacy proxy servers are known to, in certain cases, drop HTTP
   connections after a short timeout. To protect against such proxy
@@ -81307,10 +81308,29 @@
   actual underlying download.</p>
 
 
-  <h4 id=iana-considerations><span class=secno>10.2.9 </span>IANA considerations</h4>
+  <h4 id=implementation-advice><span class=secno>10.2.9 </span>Implementation advice</h4>
 
-  <h5 id=text/event-stream><span class=secno>10.2.9.1 </span><dfn><code>text/event-stream</code></dfn></h5>
+  <p><i>This section is non-normative.</i></p>
 
+  <p>User agents are strongly urged to provide detailed diagnostic information about
+  <code><a href=#eventsource>EventSource</a></code> objects and their related network connections in their development
+  consoles, to aid authors in debugging code using this API.</p>
+
+  <p>For example, a user agent could have a panel displaying all the <code><a href=#eventsource>EventSource</a></code>
+  objects a page has created, each listing the constructor's arguments, whether there was a network
+  error, what the CORS status of the connection is and what headers were sent by the client and
+  received from the server to lead to that status, the messages that were received and how they were
+  parsed, and so forth.</p>
+
+  <p>Implementations are especially encouraged to report detailed information to their development
+  consoles whenever an <code title=event-error>error</code> event is fired, since little to no
+  information can be made available in the events themselves.</p>
+
+
+  <h4 id=iana-considerations><span class=secno>10.2.10 </span>IANA considerations</h4>
+
+  <h5 id=text/event-stream><span class=secno>10.2.10.1 </span><dfn><code>text/event-stream</code></dfn></h5>
+
   <p>This registration is for community review and will be submitted
   to the IESG for review, approval, and registration with IANA.</p>
 
@@ -81398,7 +81418,7 @@
   <code><a href=#text/event-stream>text/event-stream</a></code> resources.</p>
 
 
-  <h5 id=last-event-id><span class=secno>10.2.9.2 </span><dfn title=http-last-event-id><code>Last-Event-ID</code></dfn></h5>
+  <h5 id=last-event-id><span class=secno>10.2.10.2 </span><dfn title=http-last-event-id><code>Last-Event-ID</code></dfn></h5>
 
   <p>This section describes a header field for registration in the
   Permanent Message Header Field Registry.  <a href=#refsRFC3864>[RFC3864]</a></p>
@@ -102270,6 +102290,7 @@
   Dimitri Glazkov,
   Dimitry Golubovsky,
   Dirk Pranke,
+  Dirkjan Ochtman,
   Divya Manian,
   Dmitry Titov,
   dolphinling,

Modified: source
===================================================================
--- source	2013-06-18 22:37:17 UTC (rev 7987)
+++ source	2013-06-18 23:27:48 UTC (rev 7988)
@@ -90455,7 +90455,7 @@
   </div>
 
 
-  <h4>Notes</h4>
+  <H4>Authoring notes</h4>
 
   <p>Legacy proxy servers are known to, in certain cases, drop HTTP
   connections after a short timeout. To protect against such proxy
@@ -90609,6 +90609,25 @@
   actual underlying download.</p>
 
 
+  <h4>Implementation advice</h4>
+
+  <!--END dev-html--><p><i>This section is non-normative.</i></p><!--START dev-html-->
+
+  <p>User agents are strongly urged to provide detailed diagnostic information about
+  <code>EventSource</code> objects and their related network connections in their development
+  consoles, to aid authors in debugging code using this API.</p>
+
+  <p>For example, a user agent could have a panel displaying all the <code>EventSource</code>
+  objects a page has created, each listing the constructor's arguments, whether there was a network
+  error, what the CORS status of the connection is and what headers were sent by the client and
+  received from the server to lead to that status, the messages that were received and how they were
+  parsed, and so forth.</p>
+
+  <p>Implementations are especially encouraged to report detailed information to their development
+  consoles whenever an <code title="event-error">error</code> event is fired, since little to no
+  information can be made available in the events themselves.</p>
+
+
   <h4>IANA considerations</h4>
 
   <h5><dfn><code>text/event-stream</code></dfn></h5>
@@ -114647,6 +114666,7 @@
   Dimitri Glazkov,
   Dimitry Golubovsky,
   Dirk Pranke,
+  Dirkjan Ochtman,
   Divya Manian,
   Dmitry Titov,
   dolphinling,




More information about the Commit-Watchers mailing list