iOS Fabric: added support for image instrumentation [2]

Summary: Passing thru image instrumentation activities to the image loader class, which now supports Fabric instrumentation. Changelog: [Internal] Reviewed By: mdvacca, voznesenskym Differential Revision: D19047898 fbshipit-source-id: d12cb5a06a83e85347629a25e593d30cb9020fe6
facebook · Dec 17, 2019 · eb95b2f · eb95b2f
1 parent 55142ef
commit eb95b2f
Show file tree

Hide file tree

Showing 8 changed files with 121 additions and 9 deletions.
diff --git a/Libraries/Image/RCTImageLoader.mm b/Libraries/Image/RCTImageLoader.mm
@@ -507,7 +507,7 @@ - (RCTImageURLLoaderRequest *)_loadImageOrDataWithURLRequest:(NSURLRequest *)req
                                                     completionHandler:^(NSError *error, UIImage *image) {
                                                       completionHandler(error, image, nil);
                                                     }];
-    return [[RCTImageURLLoaderRequest alloc] initWithRequestId:nil cancellationBlock:cb];
+    return [[RCTImageURLLoaderRequest alloc] initWithRequestId:nil imageURL:request.URL cancellationBlock:cb];
   }
 
   // All access to URL cache must be serialized
@@ -574,7 +574,7 @@ - (RCTImageURLLoaderRequest *)_loadImageOrDataWithURLRequest:(NSURLRequest *)req
     }
   });
 
-  return [[RCTImageURLLoaderRequest alloc] initWithRequestId:requestId cancellationBlock:^{
+  return [[RCTImageURLLoaderRequest alloc] initWithRequestId:requestId imageURL:request.URL cancellationBlock:^{
     BOOL alreadyCancelled = atomic_fetch_or(cancelled.get(), 1);
     if (alreadyCancelled) {
       return;
@@ -700,6 +700,8 @@ - (RCTImageLoaderCancellationBlock)_loadURLRequest:(NSURLRequest *)request
   };
 }
 
+#pragma mark - RCTImageLoaderWithAttributionProtocol
+
 - (RCTImageURLLoaderRequest *)loadImageWithURLRequest:(NSURLRequest *)imageURLRequest
                                                  size:(CGSize)size
                                                 scale:(CGFloat)scale
@@ -777,7 +779,42 @@ - (RCTImageURLLoaderRequest *)loadImageWithURLRequest:(NSURLRequest *)imageURLRe
                                                                  partialLoadBlock:partialLoadBlock
                                                                   completionBlock:completionHandler];
   cancelLoad = loaderRequest.cancellationBlock;
-  return [[RCTImageURLLoaderRequest alloc] initWithRequestId:loaderRequest.requestId cancellationBlock:cancellationBlock];
+  return [[RCTImageURLLoaderRequest alloc] initWithRequestId:loaderRequest.requestId imageURL:imageURLRequest.URL cancellationBlock:cancellationBlock];
+}
+
+- (void)trackURLImageContentDidSetForRequest:(RCTImageURLLoaderRequest *)loaderRequest
+{
+  if (!loaderRequest) {
+    return;
+  }
+
+  id<RCTImageURLLoader> loadHandler = [self imageURLLoaderForURL:loaderRequest.imageURL];
+  if ([loadHandler respondsToSelector:@selector(trackURLImageContentDidSetForRequest:)]) {
+    [(id<RCTImageURLLoaderWithAttribution>)loadHandler trackURLImageContentDidSetForRequest:loaderRequest];
+  }
+}
+
+- (void)trackURLImageVisibilityForRequest:(RCTImageURLLoaderRequest *)loaderRequest imageView:(UIView *)imageView
+{
+  if (!loaderRequest || !imageView) {
+    return;
+  }
+
+  id<RCTImageURLLoader> loadHandler = [self imageURLLoaderForURL:loaderRequest.imageURL];
+  if ([loadHandler respondsToSelector:@selector(trackURLImageVisibilityForRequest:imageView:)]) {
+    [(id<RCTImageURLLoaderWithAttribution>)loadHandler trackURLImageVisibilityForRequest:loaderRequest imageView:imageView];
+  }
+}
+
+- (void)trackURLImageDidDestroy:(RCTImageURLLoaderRequest *)loaderRequest
+{
+  if (!loaderRequest) {
+    return;
+  }
+  id<RCTImageURLLoader> loadHandler = [self imageURLLoaderForURL:loaderRequest.imageURL];
+  if ([loadHandler respondsToSelector:@selector(trackURLImageDidDestroy:)]) {
+    [(id<RCTImageURLLoaderWithAttribution>)loadHandler trackURLImageDidDestroy:loaderRequest];
+  }
 }
 
 - (RCTImageLoaderCancellationBlock)decodeImageData:(NSData *)data

diff --git a/Libraries/Image/RCTImageLoaderWithAttributionProtocol.h b/Libraries/Image/RCTImageLoaderWithAttributionProtocol.h
@@ -30,5 +30,19 @@ RCT_EXTERN void RCTEnableImageLoadingPerfInstrumentation(BOOL enabled);
                                         progressBlock:(RCTImageLoaderProgressBlock)progressBlock
                                      partialLoadBlock:(RCTImageLoaderPartialLoadBlock)partialLoadBlock
                                       completionBlock:(RCTImageLoaderCompletionBlock)completionBlock;
+/**
+ * Image instrumentation - notify that the image content (UIImage) has been set on the native view.
+ */
+- (void)trackURLImageContentDidSetForRequest:(RCTImageURLLoaderRequest *)loaderRequest;
+
+/**
+ * Image instrumentation - start tracking the on-screen visibility of the native image view.
+ */
+- (void)trackURLImageVisibilityForRequest:(RCTImageURLLoaderRequest *)loaderRequest imageView:(UIView *)imageView;
+
+/**
+ * Image instrumentation - notify that the native image view was destroyed.
+ */
+- (void)trackURLImageDidDestroy:(RCTImageURLLoaderRequest *)loaderRequest;
 
 @end
diff --git a/Libraries/Image/RCTImageURLLoaderWithAttribution.h b/Libraries/Image/RCTImageURLLoaderWithAttribution.h
@@ -21,9 +21,10 @@ struct ImageURLLoaderAttribution {
 @interface RCTImageURLLoaderRequest : NSObject
 
 @property (nonatomic, strong, readonly) NSString *requestId;
+@property (nonatomic, strong, readonly) NSURL *imageURL;
 @property (nonatomic, copy, readonly) RCTImageLoaderCancellationBlock cancellationBlock;
 
-- (instancetype)initWithRequestId:(NSString *)requestId cancellationBlock:(RCTImageLoaderCancellationBlock)cancellationBlock;
+- (instancetype)initWithRequestId:(NSString *)requestId imageURL:(NSURL *)imageURL cancellationBlock:(RCTImageLoaderCancellationBlock)cancellationBlock;
 - (void)cancel;
 
 @end
@@ -48,4 +49,19 @@ struct ImageURLLoaderAttribution {
                            partialLoadHandler:(RCTImageLoaderPartialLoadBlock)partialLoadHandler
                             completionHandler:(RCTImageLoaderCompletionBlock)completionHandler;
 
+/**
+ * Image instrumentation - notify that the image content (UIImage) has been set on the native view.
+ */
+- (void)trackURLImageContentDidSetForRequest:(RCTImageURLLoaderRequest *)loaderRequest;
+
+/**
+ * Image instrumentation - start tracking the on-screen visibility of the native image view.
+ */
+- (void)trackURLImageVisibilityForRequest:(RCTImageURLLoaderRequest *)loaderRequest imageView:(UIView *)imageView;
+
+/**
+ * Image instrumentation - notify that the native image view was destroyed.
+ */
+- (void)trackURLImageDidDestroy:(RCTImageURLLoaderRequest *)loaderRequest;
+
 @end
diff --git a/Libraries/Image/RCTImageURLLoaderWithAttribution.mm b/Libraries/Image/RCTImageURLLoaderWithAttribution.mm
@@ -9,10 +9,11 @@
 
 @implementation RCTImageURLLoaderRequest
 
-- (instancetype)initWithRequestId:(NSString *)requestId cancellationBlock:(RCTImageLoaderCancellationBlock)cancellationBlock
+- (instancetype)initWithRequestId:(NSString *)requestId imageURL:(NSURL *)imageURL cancellationBlock:(RCTImageLoaderCancellationBlock)cancellationBlock
 {
   if (self = [super init]) {
     _requestId = requestId;
+    _imageURL = imageURL;
     _cancellationBlock = cancellationBlock;
   }
 

diff --git a/ReactCommon/fabric/imagemanager/platform/cxx/ImageRequest.cpp b/ReactCommon/fabric/imagemanager/platform/cxx/ImageRequest.cpp
@@ -38,5 +38,17 @@ const std::shared_ptr<const ImageResponseObserverCoordinator>
   // Not implemented
   abort();
 }
+
+const std::shared_ptr<const ImageInstrumentation>
+    &ImageRequest::getSharedImageInstrumentation() const {
+  // Not implemented
+  abort();
+}
+
+const ImageInstrumentation &ImageRequest::getImageInstrumentation() const {
+  // Not implemented
+  abort();
+}
+
 } // namespace react
 } // namespace facebook
diff --git a/ReactCommon/fabric/imagemanager/platform/ios/RCTImageInstrumentationProxy.h b/ReactCommon/fabric/imagemanager/platform/ios/RCTImageInstrumentationProxy.h
@@ -20,15 +20,18 @@ namespace react {
 class RCTImageInstrumentationProxy final : public ImageInstrumentation {
  public:
   RCTImageInstrumentationProxy(id<RCTImageLoaderWithAttributionProtocol> imageLoader);
+  ~RCTImageInstrumentationProxy();
 
   void didSetImage() const override;
   void didEnterVisibilityRange() const override;
   void didExitVisibilityRange() const override;
 
   void trackNativeImageView(UIView *imageView) const;
+  void setImageURLLoaderRequest(RCTImageURLLoaderRequest *request);
 
  private:
   __weak id<RCTImageLoaderWithAttributionProtocol> imageLoader_;
+  RCTImageURLLoaderRequest *imageURLLoaderRequest_;
 };
 
 } // namespace react

diff --git a/ReactCommon/fabric/imagemanager/platform/ios/RCTImageInstrumentationProxy.mm b/ReactCommon/fabric/imagemanager/platform/ios/RCTImageInstrumentationProxy.mm
@@ -15,15 +15,25 @@
 {
 }
 
+RCTImageInstrumentationProxy::~RCTImageInstrumentationProxy()
+{
+  if (!imageURLLoaderRequest_) {
+    return;
+  }
+  [imageLoader_ trackURLImageDidDestroy:imageURLLoaderRequest_];
+}
+
 void RCTImageInstrumentationProxy::didSetImage() const
 {
   if (!RCTImageLoadingPerfInstrumentationEnabled()) {
     return;
   }
 
-  // TODO (T58941612): Not yet supported.
-  if (imageLoader_) {
+  if (!imageURLLoaderRequest_) {
+    return;
   }
+
+  [imageLoader_ trackURLImageContentDidSetForRequest:imageURLLoaderRequest_];
 }
 
 void RCTImageInstrumentationProxy::didEnterVisibilityRange() const
@@ -33,6 +43,9 @@
   }
 
   // TODO (T58941612): Not yet supported.
+  if (!imageURLLoaderRequest_) {
+    return;
+  }
 }
 
 void RCTImageInstrumentationProxy::didExitVisibilityRange() const
@@ -42,6 +55,9 @@
   }
 
   // TODO (T58941612): Not yet supported.
+  if (!imageURLLoaderRequest_) {
+    return;
+  }
 }
 
 void RCTImageInstrumentationProxy::trackNativeImageView(UIView *imageView) const
@@ -50,7 +66,15 @@
     return;
   }
 
-  // TODO (T58941612): Not yet supported.
+  if (!imageURLLoaderRequest_) {
+    return;
+  }
+  [imageLoader_ trackURLImageVisibilityForRequest:imageURLLoaderRequest_ imageView:imageView];
+}
+
+void RCTImageInstrumentationProxy::setImageURLLoaderRequest(RCTImageURLLoaderRequest *request)
+{
+  imageURLLoaderRequest_ = request;
 }
 
 } // namespace react

diff --git a/ReactCommon/fabric/imagemanager/platform/ios/RCTImageManager.mm b/ReactCommon/fabric/imagemanager/platform/ios/RCTImageManager.mm
@@ -41,7 +41,8 @@ - (ImageRequest)requestImage:(ImageSource)imageSource surfaceId:(SurfaceId)surfa
 {
   SystraceSection s("RCTImageManager::requestImage");
 
-  auto imageRequest = ImageRequest(imageSource, std::make_unique<RCTImageInstrumentationProxy>(_imageLoader));
+  auto imageInstrumentation = std::make_shared<RCTImageInstrumentationProxy>(_imageLoader);
+  auto imageRequest = ImageRequest(imageSource, imageInstrumentation);
   auto weakObserverCoordinator =
       (std::weak_ptr<const ImageResponseObserverCoordinator>)imageRequest.getSharedObserverCoordinator();
 
@@ -97,6 +98,10 @@ - (ImageRequest)requestImage:(ImageSource)imageSource surfaceId:(SurfaceId)surfa
                                     completionBlock:completionBlock];
     RCTImageLoaderCancellationBlock cancelationBlock = loaderRequest.cancellationBlock;
     sharedCancelationFunction.assign([cancelationBlock]() { cancelationBlock(); });
+
+    if (imageInstrumentation) {
+      imageInstrumentation->setImageURLLoaderRequest(loaderRequest);
+    }
   });
 
   return imageRequest;