Track performance of toBlob and its complete timeout delay

third_party/WebKit/Source/core/html/canvas/CanvasAsyncBlobCreator.h

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "core/CoreExport.h"
 #include "core/dom/DOMTypedArray.h"
 #include "core/fileapi/BlobCallback.h"
 #include "platform/geometry/IntSize.h"
 #include "platform/heap/Handle.h"
 #include "wtf/Vector.h"
 #include "wtf/text/WTFString.h"
 #include <memory>
 
 namespace blink {
 
 class PNGImageEncoderState;
 class JPEGImageEncoderState;
 
 class CORE_EXPORT CanvasAsyncBlobCreator : public GarbageCollectedFinalized<CanvasAsyncBlobCreator> {
 public:
-    static CanvasAsyncBlobCreator* create(DOMUint8ClampedArray* unpremultipliedRGBAImageData, const String& mimeType, const IntSize&, BlobCallback*);
+    static CanvasAsyncBlobCreator* create(DOMUint8ClampedArray* unpremultipliedRGBAImageData, const String& mimeType, const IntSize&, BlobCallback*, double);
     void scheduleAsyncBlobCreation(bool canUseIdlePeriodScheduling, const double& quality = 0.0);
     virtual ~CanvasAsyncBlobCreator();
     enum MimeType {
         MimeTypePng,
         MimeTypeJpeg,
         MimeTypeWebp,
         NumberOfMimeTypeSupported
     };
+    // enum used in histogram

[Ilya Sherman, 2016/06/29 22:01:02]

nit: Suggested phrasing: "This enum is used to back an UMA histogram, and should
therefore be treated as append-only."

[xidachen, 2016/06/30 01:53:38]

Done.

     enum IdleTaskStatus {
         IdleTaskNotStarted,
         IdleTaskStarted,
         IdleTaskCompleted,
         IdleTaskFailed,
         IdleTaskSwitchedToMainThreadTask,
-        IdleTaskNotSupported // Idle tasks are not implemented for some image types
+        IdleTaskNotSupported, // Idle tasks are not implemented for some image types
+        IdleTaskNotUsed, // Should not be seen in production

[Ilya Sherman, 2016/06/29 22:01:02]

nit: I'd name this "IdleTaskCount", which more clearly indicates that it should
remain the last element in the enum.

[xidachen, 2016/06/30 01:53:38]

Done.

     };
     // Methods are virtual for mocking in unit tests
     virtual void signalTaskSwitchInStartTimeoutEventForTesting() { }
     virtual void signalTaskSwitchInCompleteTimeoutEventForTesting() { }
 
     DEFINE_INLINE_VIRTUAL_TRACE()
     {
         visitor->trace(m_data);
         visitor->trace(m_callback);
     }
 
 protected:
-    CanvasAsyncBlobCreator(DOMUint8ClampedArray* data, MimeType, const IntSize&, BlobCallback*);
+    CanvasAsyncBlobCreator(DOMUint8ClampedArray* data, MimeType, const IntSize&, BlobCallback*, double);
     // Methods are virtual for unit testing
     virtual void scheduleInitiatePngEncoding();
     virtual void scheduleInitiateJpegEncoding(const double&);
     virtual void idleEncodeRowsPng(double deadlineSeconds);
     virtual void idleEncodeRowsJpeg(double deadlineSeconds);
     virtual void postDelayedTaskToMainThread(const WebTraceLocation&, std::unique_ptr<SameThreadClosure>, double delayMs);
     virtual void signalAlternativeCodePathFinishedForTesting() { }
     virtual void createBlobAndInvokeCallback();
     virtual void createNullAndInvokeCallback();
 
     void initiatePngEncoding(double deadlineSeconds);
     void initiateJpegEncoding(const double& quality, double deadlineSeconds);
     IdleTaskStatus m_idleTaskStatus;
 
 private:
     friend class CanvasAsyncBlobCreatorTest;
 
     void dispose();
 
     std::unique_ptr<PNGImageEncoderState> m_pngEncoderState;
     std::unique_ptr<JPEGImageEncoderState> m_jpegEncoderState;
     Member<DOMUint8ClampedArray> m_data;
     std::unique_ptr<Vector<unsigned char>> m_encodedImage;
     int m_numRowsCompleted;
 
     const IntSize m_size;
     size_t m_pixelRowStride;
     const MimeType m_mimeType;
     Member<BlobCallback> m_callback;
+    double m_startTime;
+    double m_scheduleInitiateStartTime;
+    double m_elapsedTime;
 
     // PNG
     bool initializePngStruct();
     void encodeRowsPngOnMainThread(); // Similar to idleEncodeRowsPng without deadline
 
     // JPEG
     bool initializeJpegStruct(double quality);
     void encodeRowsJpegOnMainThread(); // Similar to idleEncodeRowsJpeg without deadline
 
     // WEBP
     void encodeImageOnEncoderThread(double quality);
 
     void idleTaskStartTimeoutEvent(double quality);
     void idleTaskCompleteTimeoutEvent();
+    void recordIdleTaskStatusHistogram();
 };
 
 } // namespace blink