Make the WebSocket fail messages meaningful

Source/modules/websockets/MainThreadWebSocketChannel.cpp

 /*
  * Copyright (C) 2011, 2012 Google Inc.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 28 matching lines @@
 #include "FileError.h"
 #include "FileReaderLoader.h"
 #include "Frame.h"
 #include "FrameLoader.h"
 #include "FrameLoaderClient.h"
 #include "InspectorInstrumentation.h"
 #include "Logging.h"
 #include "Page.h"
 #include "ProgressTracker.h"
 #include "ScriptCallStack.h"
+#include "ScriptCallStackFactory.h"
 #include "ScriptExecutionContext.h"
 #include "Settings.h"
 #include "SocketStreamError.h"
 #include "SocketStreamHandle.h"
 #include "WebSocketChannel.h"
 #include "WebSocketChannelClient.h"
 #include "WebSocketHandshake.h"
 
 #include <wtf/ArrayBuffer.h>
 #include <wtf/Deque.h>
@@ skipping 20 matching lines @@
     , m_receivedClosingHandshake(false)
     , m_closingTimer(this, &MainThreadWebSocketChannel::closingTimerFired)
     , m_closed(false)
     , m_shouldDiscardReceivedData(false)
     , m_unhandledBufferedAmount(0)
     , m_identifier(0)
     , m_hasContinuousFrame(false)
     , m_closeEventCode(CloseEventCodeAbnormalClosure)
     , m_outgoingFrameQueueStatus(OutgoingFrameQueueOpen)
     , m_blobLoaderStatus(BlobLoaderNotStarted)
+    , m_callFrameAtConnection("", "", 0)
 {
     if (Page* page = m_document->page())
         m_identifier = page->progress()->createUniqueIdentifier();
 }
 
 MainThreadWebSocketChannel::~MainThreadWebSocketChannel()
 {
 }
 
 void MainThreadWebSocketChannel::connect(const KURL& url, const String& protocol)
 {
     LOG(Network, "MainThreadWebSocketChannel %p connect()", this);
     ASSERT(!m_handle);
     ASSERT(!m_suspended);
     m_handshake = adoptPtr(new WebSocketHandshake(url, protocol, m_document));
     m_handshake->reset();
     if (m_deflateFramer.canDeflate())
         m_handshake->addExtensionProcessor(m_deflateFramer.createExtensionProcessor());
     if (m_identifier)
         InspectorInstrumentation::didCreateWebSocket(m_document, m_identifier, url, m_document->url(), protocol);
     ref();
     m_handle = SocketStreamHandle::create(m_handshake->url(), this);
+    RefPtr<ScriptCallStack> callstack = createScriptCallStackForConsole(1);
+    m_callFrameAtConnection = callstack && callstack->size() > 0 ? callstack->at(0) : ScriptCallFrame("", m_handshake->clientOrigin(), 0);
 }
 
 String MainThreadWebSocketChannel::subprotocol()
 {
     LOG(Network, "MainThreadWebSocketChannel %p subprotocol()", this);
     if (!m_handshake || m_handshake->mode() != WebSocketHandshake::Connected)
         return "";
     String serverProtocol = m_handshake->serverWebSocketProtocol();
     if (serverProtocol.isNull())
         return "";
@@ skipping 68 matching lines @@
     if (m_closing && !m_closingTimer.isActive())
         m_closingTimer.startOneShot(2 * TCPMaximumSegmentLifetime);
 }
 
 void MainThreadWebSocketChannel::fail(const String& reason)
 {
     LOG(Network, "MainThreadWebSocketChannel %p fail() reason='%s'", this, reason.utf8().data());
     ASSERT(!m_suspended);
     if (m_document) {
         InspectorInstrumentation::didReceiveWebSocketFrameError(m_document, m_identifier, reason);
-        m_document->addConsoleMessage(NetworkMessageSource, ErrorMessageLevel, "WebSocket connection to '" + m_handshake->url().elidedString() + "' failed: " + reason);
+        const String message = "WebSocket connection to '" + m_handshake->url().elidedString() + "' failed: " + reason;
+        RefPtr<ScriptCallStack> callstack = createScriptCallStackForConsole(1);
+        if (callstack && callstack->size() > 0) {
+            // We are in a JS callstack.
+            // So, the addConsoleMessage method will show the stack appropriately.
+            m_document->addConsoleMessage(JSMessageSource, ErrorMessageLevel, message);
+        } else {
+            // We are not in a JS callstack.
+            // Then show the source file and the line number at the connection initiation.
+            const String& url = m_callFrameAtConnection.sourceURL();
+            unsigned lineNumber = m_callFrameAtConnection.lineNumber();
+            static_cast<ScriptExecutionContext*>(m_document)->addConsoleMessage(JSMessageSource, ErrorMessageLevel, message, url, lineNumber, 0, 0);

[tyoshino (SeeGerritForStatus), 2013/04/22 05:47:18]

How about continue not showing lineno here in case it failed to get call frame
on construction?

[yhirano, 2013/04/22 07:33:38]

Fixed around the line 113 for this problem.

+        }
     }
 
     // Hybi-10 specification explicitly states we must not continue to handle incoming data
     // once the WebSocket connection is failed (section 7.1.7).
     RefPtr<MainThreadWebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
     m_shouldDiscardReceivedData = true;
     if (!m_buffer.isEmpty())
         skipBuffer(m_buffer.size()); // Save memory.
     m_deflateFramer.didFail();
     m_hasContinuousFrame = false;
@@ skipping 581 matching lines @@
         return false;
     }
 
     Vector<char> frameData;
     frame.makeFrameData(frameData);
 
     return m_handle->send(frameData.data(), frameData.size());
 }
 
 } // namespace WebCore