DevTools: Support async call stacks for FileSystem API (part 1).

Source/modules/filesystem/FileSystemCallbacks.cpp

 /*
  * Copyright (C) 2010 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 17 matching lines @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "config.h"
 #include "modules/filesystem/FileSystemCallbacks.h"
 
 #include "core/dom/ExecutionContext.h"
 #include "core/fileapi/File.h"
 #include "core/fileapi/FileError.h"
 #include "core/html/VoidCallback.h"
+#include "core/inspector/InspectorInstrumentation.h"
 #include "modules/filesystem/DOMFilePath.h"
 #include "modules/filesystem/DOMFileSystem.h"
 #include "modules/filesystem/DOMFileSystemBase.h"
 #include "modules/filesystem/DirectoryEntry.h"
 #include "modules/filesystem/DirectoryReader.h"
 #include "modules/filesystem/Entry.h"
 #include "modules/filesystem/EntryCallback.h"
 #include "modules/filesystem/ErrorCallback.h"
 #include "modules/filesystem/FileCallback.h"
 #include "modules/filesystem/FileEntry.h"
 #include "modules/filesystem/FileSystemCallback.h"
 #include "modules/filesystem/FileWriterBase.h"
 #include "modules/filesystem/FileWriterBaseCallback.h"
 #include "modules/filesystem/Metadata.h"
 #include "modules/filesystem/MetadataCallback.h"
 #include "platform/FileMetadata.h"
 #include "public/platform/WebFileWriter.h"
 
 namespace WebCore {
 
+namespace {
+
+class HandleCallbackScope FINAL {
+    WTF_MAKE_NONCOPYABLE(HandleCallbackScope);
+public:
+    HandleCallbackScope(PassRefPtrWillBeRawPtr<ExecutionContext> executionContext, FileSystemCallbacksBase* callback, bool reschedule = false, bool hasMore = false)
+        : m_executionContext(executionContext)
+        , m_callback(callback)
+        , m_reschedule(reschedule)
+    {
+        if (m_executionContext)
+            InspectorInstrumentation::willHandleAsyncFileSystemCallback(m_executionContext.get(), m_callback, m_reschedule, hasMore);

[yurys, 2014/07/14 14:55:54]

Consider inlining these instrumentation calls. We don't use scoped objects for
instrumentation calls in other places.

+    }
+
+    ~HandleCallbackScope()
+    {
+        if (m_executionContext)
+            InspectorInstrumentation::didHandleAsyncFileSystemCallback(m_executionContext.get(), m_callback, m_reschedule);
+    }
+
+private:
+    RefPtrWillBePersistent<ExecutionContext> m_executionContext;
+    FileSystemCallbacksBase* m_callback;
+    bool m_reschedule;
+};
+
+} // namespace
+
 FileSystemCallbacksBase::FileSystemCallbacksBase(PassOwnPtr<ErrorCallback> errorCallback, DOMFileSystemBase* fileSystem, ExecutionContext* context)
     : m_errorCallback(errorCallback)
     , m_fileSystem(fileSystem)
     , m_executionContext(context)
 {
     if (m_fileSystem)
         m_fileSystem->addPendingCallbacks();
+    if (m_executionContext)
+        InspectorInstrumentation::didEnqueueAsyncFileSystemCallback(m_executionContext.get(), this);
 }
 
 FileSystemCallbacksBase::~FileSystemCallbacksBase()
 {
+    if (m_executionContext)
+        InspectorInstrumentation::didRemoveAsyncFileSystemCallback(m_executionContext.get(), this);
     if (m_fileSystem)
         m_fileSystem->removePendingCallbacks();
 }
 
 void FileSystemCallbacksBase::didFail(int code)
 {
     if (m_errorCallback)
         handleEventOrScheduleCallback(m_errorCallback.release(), FileError::create(static_cast<FileError::ErrorCode>(code)));
 }
 
 bool FileSystemCallbacksBase::shouldScheduleCallback() const
 {
     return !shouldBlockUntilCompletion() && m_executionContext && m_executionContext->activeDOMObjectsAreSuspended();
 }
 
 template <typename CB, typename CBArg>
 void FileSystemCallbacksBase::handleEventOrScheduleCallback(PassOwnPtr<CB> callback, CBArg* arg)
 {
     ASSERT(callback.get());
-    if (shouldScheduleCallback())
+    if (shouldScheduleCallback()) {
+        HandleCallbackScope scope(m_executionContext, this, true /* reschedule */);
         DOMFileSystem::scheduleCallback(m_executionContext.get(), callback, arg);
-    else if (callback)
-        callback->handleEvent(arg);
+    } else {
+        HandleCallbackScope scope(m_executionContext, this);
+        if (callback)
+            callback->handleEvent(arg);
+    }
     m_executionContext.clear();
 }
 
 template <typename CB, typename CBArg>
 void FileSystemCallbacksBase::handleEventOrScheduleCallback(PassOwnPtr<CB> callback, PassRefPtrWillBeRawPtr<CBArg> arg)
 {
     ASSERT(callback.get());
-    if (shouldScheduleCallback())
+    if (shouldScheduleCallback()) {
+        HandleCallbackScope scope(m_executionContext, this, true /* reschedule */);
         DOMFileSystem::scheduleCallback(m_executionContext.get(), callback, arg);
-    else if (callback)
-        callback->handleEvent(arg.get());
+    } else {
+        HandleCallbackScope scope(m_executionContext, this);
+        if (callback)
+            callback->handleEvent(arg.get());
+    }
     m_executionContext.clear();
 }
 
 template <typename CB>
 void FileSystemCallbacksBase::handleEventOrScheduleCallback(PassOwnPtr<CB> callback)
 {
     ASSERT(callback.get());
-    if (shouldScheduleCallback())
+    if (shouldScheduleCallback()) {
+        HandleCallbackScope scope(m_executionContext, this, true /* reschedule */);
         DOMFileSystem::scheduleCallback(m_executionContext.get(), callback);
-    else if (callback)
-        callback->handleEvent();
+    } else {
+        HandleCallbackScope scope(m_executionContext, this);
+        if (callback)
+            callback->handleEvent();
+    }
     m_executionContext.clear();
 }
 
 // EntryCallbacks -------------------------------------------------------------
 
 PassOwnPtr<AsyncFileSystemCallbacks> EntryCallbacks::create(PassOwnPtr<EntryCallback> successCallback, PassOwnPtr<ErrorCallback> errorCallback, ExecutionContext* context, DOMFileSystemBase* fileSystem, const String& expectedPath, bool isDirectory)
 {
     return adoptPtr(new EntryCallbacks(successCallback, errorCallback, context, fileSystem, expectedPath, isDirectory));
 }
 
@@ skipping 38 matching lines @@
     else
         m_entries.append(FileEntry::create(m_directoryReader->filesystem(), DOMFilePath::append(m_basePath, name)));
 }
 
 void EntriesCallbacks::didReadDirectoryEntries(bool hasMore)
 {
     m_directoryReader->setHasMoreEntries(hasMore);
     EntryHeapVector entries;
     entries.swap(m_entries);
     // FIXME: delay the callback iff shouldScheduleCallback() is true.
+    HandleCallbackScope scope(m_executionContext, this, false /* reschedule */, hasMore);
     if (m_successCallback)
         m_successCallback->handleEvent(entries);
 }
 
 // FileSystemCallbacks --------------------------------------------------------
 
 PassOwnPtr<AsyncFileSystemCallbacks> FileSystemCallbacks::create(PassOwnPtr<FileSystemCallback> successCallback, PassOwnPtr<ErrorCallback> errorCallback, ExecutionContext* context, FileSystemType type)
 {
     return adoptPtr(new FileSystemCallbacks(successCallback, errorCallback, context, type));
 }
@@ skipping 134 matching lines @@
 {
 }
 
 void VoidCallbacks::didSucceed()
 {
     if (m_successCallback)
         handleEventOrScheduleCallback(m_successCallback.release());
 }
 
 } // namespace