Add pluggable image processing system

2026-03-26 07:04:05 +08:00 · 2015-09-02 08:25:10 -07:00
parent eb9a9395ac
commit 36444a65c7
22 changed files with 985 additions and 395 deletions
--- a/Examples/UIExplorer/UIExplorer.xcodeproj/project.pbxproj
+++ b/Examples/UIExplorer/UIExplorer.xcodeproj/project.pbxproj
@@ -54,6 +54,8 @@
 		3578590A1B28D2CF00341EDB /* libRCTLinking.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 357859011B28D2C500341EDB /* libRCTLinking.a */; };
 		834C36EC1AF8DED70019C93C /* libRCTSettings.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 834C36D21AF8DA610019C93C /* libRCTSettings.a */; };
 		83636F8F1B53F22C009F943E /* RCTUIManagerScenarioTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 83636F8E1B53F22C009F943E /* RCTUIManagerScenarioTests.m */; };
+		8385CEF51B873B5C00C6273E /* RCTImageLoaderTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 8385CEF41B873B5C00C6273E /* RCTImageLoaderTests.m */; };
+		8385CF041B87479200C6273E /* RCTImageLoaderHelpers.m in Sources */ = {isa = PBXBuildFile; fileRef = 8385CF031B87479200C6273E /* RCTImageLoaderHelpers.m */; };
 		83A936C81B7E0F08005B9C36 /* RCTConvert_UIColorTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 83A936C71B7E0F08005B9C36 /* RCTConvert_UIColorTests.m */; };
 		D85B829E1AB6D5D7003F4FE2 /* libRCTVibration.a in Frameworks */ = {isa = PBXBuildFile; fileRef = D85B829C1AB6D5CE003F4FE2 /* libRCTVibration.a */; };
 /* End PBXBuildFile section */
@@ -217,6 +219,9 @@
 		357858F81B28D2C400341EDB /* RCTLinking.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = RCTLinking.xcodeproj; path = ../../Libraries/LinkingIOS/RCTLinking.xcodeproj; sourceTree = "<group>"; };
 		58005BE41ABA80530062E044 /* RCTTest.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = RCTTest.xcodeproj; path = ../../Libraries/RCTTest/RCTTest.xcodeproj; sourceTree = "<group>"; };
 		83636F8E1B53F22C009F943E /* RCTUIManagerScenarioTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTUIManagerScenarioTests.m; sourceTree = "<group>"; };
+		8385CEF41B873B5C00C6273E /* RCTImageLoaderTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTImageLoaderTests.m; sourceTree = "<group>"; };
+		8385CF031B87479200C6273E /* RCTImageLoaderHelpers.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTImageLoaderHelpers.m; sourceTree = "<group>"; };
+		8385CF051B8747A000C6273E /* RCTImageLoaderHelpers.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = RCTImageLoaderHelpers.h; sourceTree = "<group>"; };
 		83A936C71B7E0F08005B9C36 /* RCTConvert_UIColorTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTConvert_UIColorTests.m; sourceTree = "<group>"; };
 		D85B82911AB6D5CE003F4FE2 /* RCTVibration.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = RCTVibration.xcodeproj; path = ../../Libraries/Vibration/RCTVibration.xcodeproj; sourceTree = "<group>"; };
 /* End PBXFileReference section */
@@ -365,6 +370,9 @@
 				1497CFA81B21F5E400C1F8F2 /* RCTConvert_UIFontTests.m */,
 				1497CFA91B21F5E400C1F8F2 /* RCTEventDispatcherTests.m */,
 				1300627E1B59179B0043FE5A /* RCTGzipTests.m */,
+				8385CF051B8747A000C6273E /* RCTImageLoaderHelpers.h */,
+				8385CF031B87479200C6273E /* RCTImageLoaderHelpers.m */,
+				8385CEF41B873B5C00C6273E /* RCTImageLoaderTests.m */,
 				144D21231B2204C5006DB32B /* RCTImageUtilTests.m */,
 				13DB03471B5D2ED500C27245 /* RCTJSONTests.m */,
 				13DF61B51B67A45000EDB188 /* RCTMethodArgumentTests.m */,
@@ -811,6 +819,8 @@
 				83A936C81B7E0F08005B9C36 /* RCTConvert_UIColorTests.m in Sources */,
 				13DF61B61B67A45000EDB188 /* RCTMethodArgumentTests.m in Sources */,
 				138D6A181B53CD440074A87E /* RCTShadowViewTests.m in Sources */,
+				8385CF041B87479200C6273E /* RCTImageLoaderHelpers.m in Sources */,
+				8385CEF51B873B5C00C6273E /* RCTImageLoaderTests.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
--- a/Examples/UIExplorer/UIExplorerUnitTests/RCTImageLoaderHelpers.h
+++ b/Examples/UIExplorer/UIExplorerUnitTests/RCTImageLoaderHelpers.h
@@ -0,0 +1,47 @@
+/**
+ * The examples provided by Facebook are for non-commercial testing and
+ * evaluation purposes only.
+ *
+ * Facebook reserves all rights not expressly granted.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL
+ * FACEBOOK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+ * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#import "RCTImageLoader.h"
+
+typedef BOOL (^RCTImageURLLoaderCanLoadImageURLHandler)(NSURL *requestURL);
+typedef RCTImageLoaderCancellationBlock (^RCTImageURLLoaderLoadImageURLHandler)(NSURL *imageURL, CGSize size, CGFloat scale, UIViewContentMode resizeMode, RCTImageLoaderProgressBlock progressHandler, RCTImageLoaderCompletionBlock completionHandler);
+
+@interface RCTConcreteImageURLLoader : NSObject <RCTImageURLLoader>
+
+- (instancetype)initWithPriority:(float)priority
+          canLoadImageURLHandler:(RCTImageURLLoaderCanLoadImageURLHandler)canLoadImageURLHandler
+             loadImageURLHandler:(RCTImageURLLoaderLoadImageURLHandler)loadImageURLHandler;
+
+@end
+
+typedef BOOL (^RCTImageDecoderCanDecodeImageDataHandler)(NSData *imageData);
+typedef RCTImageLoaderCancellationBlock (^RCTImageDecoderDecodeImageDataHandler)(NSData *imageData, CGSize size, CGFloat scale, UIViewContentMode resizeMode, RCTImageLoaderCompletionBlock completionHandler);
+
+@interface RCTConcreteImageDecoder : NSObject <RCTImageDecoder>
+
+- (instancetype)initWithPriority:(float)priority
+       canDecodeImageDataHandler:(RCTImageDecoderCanDecodeImageDataHandler)canDecodeImageDataHandler
+          decodeImageDataHandler:(RCTImageDecoderDecodeImageDataHandler)decodeImageDataHandler;
+
+@end
+
+#define _RCTDefineImageHandler(SUPERCLASS, CLASS_NAME) \
+@interface CLASS_NAME : SUPERCLASS @end \
+@implementation CLASS_NAME RCT_EXPORT_MODULE() @end
+
+#define RCTDefineImageURLLoader(CLASS_NAME) \
+_RCTDefineImageHandler(RCTConcreteImageURLLoader, CLASS_NAME)
+
+#define RCTDefineImageDecoder(CLASS_NAME) \
+_RCTDefineImageHandler(RCTConcreteImageDecoder, CLASS_NAME)
--- a/Examples/UIExplorer/UIExplorerUnitTests/RCTImageLoaderHelpers.m
+++ b/Examples/UIExplorer/UIExplorerUnitTests/RCTImageLoaderHelpers.m
@@ -0,0 +1,105 @@
+/**
+ * The examples provided by Facebook are for non-commercial testing and
+ * evaluation purposes only.
+ *
+ * Facebook reserves all rights not expressly granted.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL
+ * FACEBOOK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+ * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#import "RCTImageLoaderHelpers.h"
+
+@implementation RCTConcreteImageURLLoader
+{
+  RCTImageURLLoaderCanLoadImageURLHandler _canLoadImageURLHandler;
+  RCTImageURLLoaderLoadImageURLHandler _loadImageURLHandler;
+  float _priority;
+}
+
+ (NSString *)moduleName
+{
+  return nil;
+}
+
+- (instancetype)init
+{
+  return nil;
+}
+
+- (instancetype)initWithPriority:(float)priority canLoadImageURLHandler:(RCTImageURLLoaderCanLoadImageURLHandler)canLoadImageURLHandler loadImageURLHandler:(RCTImageURLLoaderLoadImageURLHandler)loadImageURLHandler
+{
+  if ((self = [super init])) {
+    _canLoadImageURLHandler = [canLoadImageURLHandler copy];
+    _loadImageURLHandler = [loadImageURLHandler copy];
+    _priority = priority;
+  }
+
+  return self;
+}
+
+- (BOOL)canLoadImageURL:(NSURL *)requestURL
+{
+  return _canLoadImageURLHandler(requestURL);
+}
+
+- (RCTImageLoaderCancellationBlock)loadImageForURL:(NSURL *)imageURL size:(CGSize)size scale:(CGFloat)scale resizeMode:(UIViewContentMode)resizeMode progressHandler:(RCTImageLoaderProgressBlock)progressHandler completionHandler:(RCTImageLoaderCompletionBlock)completionHandler
+{
+  return _loadImageURLHandler(imageURL, size, scale, resizeMode, progressHandler, completionHandler);
+}
+
+- (float)imageLoaderPriority
+{
+  return _priority;
+}
+
+@end
+
+@implementation RCTConcreteImageDecoder
+{
+  RCTImageDecoderCanDecodeImageDataHandler _canDecodeImageDataHandler;
+  RCTImageDecoderDecodeImageDataHandler _decodeImageDataHandler;
+  float _priority;
+}
+
+ (NSString *)moduleName
+{
+  return nil;
+}
+
+- (instancetype)init
+{
+  return nil;
+}
+
+- (instancetype)initWithPriority:(float)priority canDecodeImageDataHandler:(RCTImageDecoderCanDecodeImageDataHandler)canDecodeImageDataHandler decodeImageDataHandler:(RCTImageDecoderDecodeImageDataHandler)decodeImageDataHandler
+{
+  if ((self = [super init])) {
+    _canDecodeImageDataHandler = [canDecodeImageDataHandler copy];
+    _decodeImageDataHandler = [decodeImageDataHandler copy];
+    _priority = priority;
+  }
+
+  return self;
+}
+
+- (BOOL)canDecodeImageData:(NSData *)imageData
+{
+  return _canDecodeImageDataHandler(imageData);
+}
+
+- (RCTImageLoaderCancellationBlock)decodeImageData:(NSData *)imageData size:(CGSize)size scale:(CGFloat)scale resizeMode:(UIViewContentMode)resizeMode completionHandler:(RCTImageLoaderCompletionBlock)completionHandler
+{
+  return _decodeImageDataHandler(imageData, size, scale, resizeMode, completionHandler);
+}
+
+- (float)imageDecoderPriority
+{
+  return _priority;
+}
+
+@end
--- a/Examples/UIExplorer/UIExplorerUnitTests/RCTImageLoaderTests.m
+++ b/Examples/UIExplorer/UIExplorerUnitTests/RCTImageLoaderTests.m
@@ -0,0 +1,148 @@
+/**
+ * The examples provided by Facebook are for non-commercial testing and
+ * evaluation purposes only.
+ *
+ * Facebook reserves all rights not expressly granted.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL
+ * FACEBOOK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+ * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#import <XCTest/XCTest.h>
+
+#import "RCTBridge.h"
+#import "RCTImageLoader.h"
+#import "RCTImageLoaderHelpers.h"
+
+unsigned char blackGIF[] = {
+  0x47, 0x49, 0x46, 0x38, 0x39, 0x61, 0x01, 0x00, 0x01, 0x00, 0x80, 0x00,
+  0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0x2c, 0x00, 0x00, 0x00, 0x00,
+  0x01, 0x00, 0x01, 0x00, 0x00, 0x02, 0x02, 0x44, 0x01, 0x00, 0x3b
+};
+
+RCTDefineImageURLLoader(RCTImageLoaderTestsURLLoader1)
+RCTDefineImageURLLoader(RCTImageLoaderTestsURLLoader2)
+RCTDefineImageDecoder(RCTImageLoaderTestsDecoder1)
+RCTDefineImageDecoder(RCTImageLoaderTestsDecoder2)
+
+@interface RCTImageLoaderTests : XCTestCase
+
+@end
+
+@implementation RCTImageLoaderTests
+
+- (void)testImageLoading
+{
+  UIImage *image = [UIImage new];
+
+  id<RCTImageURLLoader> loader = [[RCTImageLoaderTestsURLLoader1 alloc] initWithPriority:1.0 canLoadImageURLHandler:^BOOL(__unused NSURL *requestURL) {
+    return YES;
+  } loadImageURLHandler:^RCTImageLoaderCancellationBlock(__unused NSURL *imageURL, __unused CGSize size, __unused CGFloat scale, __unused UIViewContentMode resizeMode, RCTImageLoaderProgressBlock progressHandler, RCTImageLoaderCompletionBlock completionHandler) {
+    progressHandler(1, 1);
+    completionHandler(nil, image);
+    return nil;
+  }];
+
+  RCTImageLoader *imageLoader = [RCTImageLoader new];
+  NS_VALID_UNTIL_END_OF_SCOPE RCTBridge *bridge = [[RCTBridge alloc] initWithBundleURL:nil moduleProvider:^{ return @[loader, imageLoader]; } launchOptions:nil];
+
+  RCTImageLoaderCancellationBlock cancelBlock = [imageLoader loadImageWithTag:@"http://facebook.github.io/react/img/logo_og.png" size:CGSizeMake(100, 100) scale:1.0 resizeMode:UIViewContentModeScaleAspectFit progressBlock:^(int64_t progress, int64_t total) {
+    XCTAssertEqual(progress, 1);
+    XCTAssertEqual(total, 1);
+  } completionBlock:^(NSError *loadError, id loadedImage) {
+    XCTAssertEqualObjects(loadedImage, image);
+    XCTAssertNil(loadError);
+  }];
+  XCTAssertNil(cancelBlock);
+}
+
+- (void)testImageLoaderUsesImageURLLoaderWithHighestPriority
+{
+  UIImage *image = [UIImage new];
+
+  id<RCTImageURLLoader> loader1 = [[RCTImageLoaderTestsURLLoader1 alloc] initWithPriority:1.0 canLoadImageURLHandler:^BOOL(__unused NSURL *requestURL) {
+    return YES;
+  } loadImageURLHandler:^RCTImageLoaderCancellationBlock(__unused NSURL *imageURL, __unused CGSize size, __unused CGFloat scale, __unused UIViewContentMode resizeMode, RCTImageLoaderProgressBlock progressHandler, RCTImageLoaderCompletionBlock completionHandler) {
+    progressHandler(1, 1);
+    completionHandler(nil, image);
+    return nil;
+  }];
+
+  id<RCTImageURLLoader> loader2 = [[RCTImageLoaderTestsURLLoader2 alloc] initWithPriority:0.5 canLoadImageURLHandler:^BOOL(__unused NSURL *requestURL) {
+    return YES;
+  } loadImageURLHandler:^RCTImageLoaderCancellationBlock(__unused NSURL *imageURL, __unused CGSize size, __unused CGFloat scale, __unused UIViewContentMode resizeMode, __unused RCTImageLoaderProgressBlock progressHandler, __unused RCTImageLoaderCompletionBlock completionHandler) {
+    XCTFail(@"Should not have used loader2");
+    return nil;
+  }];
+
+  RCTImageLoader *imageLoader = [RCTImageLoader new];
+  NS_VALID_UNTIL_END_OF_SCOPE RCTBridge *bridge = [[RCTBridge alloc] initWithBundleURL:nil moduleProvider:^{ return @[loader1, loader2, imageLoader]; } launchOptions:nil];
+
+  RCTImageLoaderCancellationBlock cancelBlock = [imageLoader loadImageWithTag:@"http://facebook.github.io/react/img/logo_og.png" size:CGSizeMake(100, 100) scale:1.0 resizeMode:UIViewContentModeScaleAspectFit progressBlock:^(int64_t progress, int64_t total) {
+    XCTAssertEqual(progress, 1);
+    XCTAssertEqual(total, 1);
+  } completionBlock:^(NSError *loadError, id loadedImage) {
+    XCTAssertEqualObjects(loadedImage, image);
+    XCTAssertNil(loadError);
+  }];
+  XCTAssertNil(cancelBlock);
+}
+
+- (void)testImageDecoding
+{
+  NSData *data = [NSData dataWithBytesNoCopy:blackGIF length:sizeof(blackGIF) freeWhenDone:NO];
+  UIImage *image = [[UIImage alloc] initWithData:data];
+
+  id<RCTImageDecoder> decoder = [[RCTImageLoaderTestsDecoder1 alloc] initWithPriority:1.0 canDecodeImageDataHandler:^BOOL(__unused NSData *imageData) {
+    return YES;
+  } decodeImageDataHandler:^RCTImageLoaderCancellationBlock(NSData *imageData, __unused CGSize size, __unused CGFloat scale, __unused UIViewContentMode resizeMode, RCTImageLoaderCompletionBlock completionHandler) {
+    XCTAssertEqualObjects(imageData, data);
+    completionHandler(nil, image);
+    return nil;
+  }];
+
+  RCTImageLoader *imageLoader = [RCTImageLoader new];
+  NS_VALID_UNTIL_END_OF_SCOPE RCTBridge *bridge = [[RCTBridge alloc] initWithBundleURL:nil moduleProvider:^{ return @[decoder, imageLoader]; } launchOptions:nil];
+
+  RCTImageLoaderCancellationBlock cancelBlock = [imageLoader decodeImageData:data size:CGSizeMake(1, 1) scale:1.0 resizeMode:UIViewContentModeScaleToFill completionBlock:^(NSError *decodeError, id decodedImage) {
+    XCTAssertEqualObjects(decodedImage, image);
+    XCTAssertNil(decodeError);
+  }];
+  XCTAssertNil(cancelBlock);
+}
+
+- (void)testImageLoaderUsesImageDecoderWithHighestPriority
+{
+  NSData *data = [NSData dataWithBytesNoCopy:blackGIF length:sizeof(blackGIF) freeWhenDone:NO];
+  UIImage *image = [[UIImage alloc] initWithData:data];
+
+  id<RCTImageDecoder> decoder1 = [[RCTImageLoaderTestsDecoder1 alloc] initWithPriority:1.0 canDecodeImageDataHandler:^BOOL(__unused NSData *imageData) {
+    return YES;
+  } decodeImageDataHandler:^RCTImageLoaderCancellationBlock(NSData *imageData, __unused CGSize size, __unused CGFloat scale, __unused UIViewContentMode resizeMode, RCTImageLoaderCompletionBlock completionHandler) {
+    XCTAssertEqualObjects(imageData, data);
+    completionHandler(nil, image);
+    return nil;
+  }];
+
+  id<RCTImageDecoder> decoder2 = [[RCTImageLoaderTestsDecoder2 alloc] initWithPriority:0.5 canDecodeImageDataHandler:^BOOL(__unused NSData *imageData) {
+    return YES;
+  } decodeImageDataHandler:^RCTImageLoaderCancellationBlock(__unused NSData *imageData, __unused CGSize size, __unused CGFloat scale, __unused UIViewContentMode resizeMode, __unused RCTImageLoaderCompletionBlock completionHandler) {
+    XCTFail(@"Should not have used decoder2");
+    return nil;
+  }];
+
+  RCTImageLoader *imageLoader = [RCTImageLoader new];
+  NS_VALID_UNTIL_END_OF_SCOPE RCTBridge *bridge = [[RCTBridge alloc] initWithBundleURL:nil moduleProvider:^{ return @[decoder1, decoder2, imageLoader]; } launchOptions:nil];
+
+  RCTImageLoaderCancellationBlock cancelBlock = [imageLoader decodeImageData:data size:CGSizeMake(1, 1) scale:1.0 resizeMode:UIViewContentModeScaleToFill completionBlock:^(NSError *decodeError, id decodedImage) {
+    XCTAssertEqualObjects(decodedImage, image);
+    XCTAssertNil(decodeError);
+  }];
+  XCTAssertNil(cancelBlock);
+}
+
+@end