Skip to content

Commit

Permalink
[e] (0) Encourage more detailed debugging aids for EventSource
Browse files Browse the repository at this point in the history 
Fixing https://www.w3.org/Bugs/Public/show_bug.cgi?id=21876
Affected topics: HTML

git-svn-id: http://svn.whatwg.org/webapps@7988 340c8d12-0b0e-0410-8428-c7bf67bfef74
  • Loading branch information
@Hixie
Hixie committed Jun 18, 2013
1 parent 4dbb1d0 commit 8547856
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 17 deletions.
37 changes: 29 additions & 8 deletions complete.html
View file
Expand Up @@ -1090,13 +1090,14 @@ <h2 class="no-num no-toc">Living Standard &mdash; Last Updated 18 June 2013</h2>
<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>
Expand Down Expand Up @@ -81174,7 +81175,7 @@ <h4 id=event-stream-interpretation><span class=secno>10.2.5 </span>Interpreting
</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
Expand Down Expand Up @@ -81307,9 +81308,28 @@ <h4 id=garbage-collection-0><span class=secno>10.2.8 </span>Garbage collection</
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>
Expand Down Expand Up @@ -81398,7 +81418,7 @@ <h5 id=text/event-stream><span class=secno>10.2.9.1 </span><dfn><code>text/event
<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>
Expand Down Expand Up @@ -102270,6 +102290,7 @@ <h2 class=no-num id=references>References</h2><!--REFS-->
Dimitri Glazkov,
Dimitry Golubovsky,
Dirk Pranke,
Dirkjan Ochtman,
Divya Manian,
Dmitry Titov,
dolphinling,
Expand Down
37 changes: 29 additions & 8 deletions index
View file
Expand Up @@ -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>
Expand Down Expand Up @@ -81174,7 +81175,7 @@ data:&nbsp;test
</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
Expand Down Expand Up @@ -81307,9 +81308,28 @@ data:&nbsp;test
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>
Expand Down Expand Up @@ -81398,7 +81418,7 @@ data:&nbsp;test
<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>
Expand Down Expand Up @@ -102270,6 +102290,7 @@ if (s = prompt('What is your name?')) {
Dimitri Glazkov,
Dimitry Golubovsky,
Dirk Pranke,
Dirkjan Ochtman,
Divya Manian,
Dmitry Titov,
dolphinling,
Expand Down
22 changes: 21 additions & 1 deletion source
View file
Expand Up @@ -90455,7 +90455,7 @@ data:&nbsp;test
</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
Expand Down Expand Up @@ -90609,6 +90609,25 @@ data:&nbsp;test
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>
Expand Down Expand Up @@ -114647,6 +114666,7 @@ if (s = prompt('What is your name?')) {
Dimitri Glazkov,
Dimitry Golubovsky,
Dirk Pranke,
Dirkjan Ochtman,
Divya Manian,
Dmitry Titov,
dolphinling,
Expand Down

0 comments on commit 8547856

Please sign in to comment.