feat: Allow brownfield iOS apps to handle storage.

tido64 · tido64 · commit 63310d25152b · 2019-03-13T22:19:03.000+01:00
diff --git a/example/ios/AsyncStorageExample.xcodeproj/project.pbxproj b/example/ios/AsyncStorageExample.xcodeproj/project.pbxproj
@@ -21,6 +21,7 @@
 		13B07FBF1A68108700A75B9A /* Images.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 13B07FB51A68108700A75B9A /* Images.xcassets */; };
 		13B07FC11A68108700A75B9A /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 13B07FB71A68108700A75B9A /* main.m */; };
 		146834051AC3E58100842450 /* libReact.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 146834041AC3E56700842450 /* libReact.a */; };
+		1990B97922399119009E5EA1 /* libRNCAsyncStorage.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 3DC5398C220F2C940035D3A3 /* libRNCAsyncStorage.a */; };
 		832341BD1AAA6AB300B99B32 /* libRCTText.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 832341B51AAA6A8300B99B32 /* libRCTText.a */; };
 		ADBDB9381DFEBF1600ED6528 /* libRCTBlob.a in Frameworks */ = {isa = PBXBuildFile; fileRef = ADBDB9271DFEBF0700ED6528 /* libRCTBlob.a */; };
 		ED297163215061F000B7C4FE /* JavaScriptCore.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = ED297162215061F000B7C4FE /* JavaScriptCore.framework */; };
@@ -83,6 +84,13 @@
 			remoteGlobalIDString = 83CBBA2E1A601D0E00E9B192;
 			remoteInfo = React;
 		};
+		1990B95122398FC4009E5EA1 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = 3DC5395A220F2C940035D3A3 /* RNCAsyncStorage.xcodeproj */;
+			proxyType = 1;
+			remoteGlobalIDString = 58B511DA1A9E6C8500147676;
+			remoteInfo = RNCAsyncStorage;
+		};
 		2D16E6711FA4F8DC00B85C8A /* PBXContainerItemProxy */ = {
 			isa = PBXContainerItemProxy;
 			containerPortal = ADBDB91F1DFEBF0600ED6528 /* RCTBlob.xcodeproj */;
@@ -340,6 +348,7 @@
 				832341BD1AAA6AB300B99B32 /* libRCTText.a in Frameworks */,
 				00C302EA1ABCBA2D00DB3ED1 /* libRCTVibration.a in Frameworks */,
 				139FDEF61B0652A700C62182 /* libRCTWebSocket.a in Frameworks */,
+				1990B97922399119009E5EA1 /* libRNCAsyncStorage.a in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -555,6 +564,7 @@
 			buildRules = (
 			);
 			dependencies = (
+				1990B95222398FC4009E5EA1 /* PBXTargetDependency */,
 			);
 			name = AsyncStorageExample;
 			productName = "Hello World";
@@ -936,7 +946,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "export NODE_BINARY=node\n../../node_modules/react-native/scripts/react-native-xcode.sh";
+			shellScript = "export NODE_BINARY=node\n../../node_modules/react-native/scripts/react-native-xcode.sh\n";
 		};
 /* End PBXShellScriptBuildPhase section */
 
@@ -952,6 +962,14 @@
 		};
 /* End PBXSourcesBuildPhase section */
 
+/* Begin PBXTargetDependency section */
+		1990B95222398FC4009E5EA1 /* PBXTargetDependency */ = {
+			isa = PBXTargetDependency;
+			name = RNCAsyncStorage;
+			targetProxy = 1990B95122398FC4009E5EA1 /* PBXContainerItemProxy */;
+		};
+/* End PBXTargetDependency section */
+
 /* Begin PBXVariantGroup section */
 		13B07FB11A68108700A75B9A /* LaunchScreen.xib */ = {
 			isa = PBXVariantGroup;
diff --git a/example/ios/AsyncStorageExample/AppDelegate.h b/example/ios/AsyncStorageExample/AppDelegate.h
@@ -7,7 +7,9 @@
 
 #import <UIKit/UIKit.h>
 
-@interface AppDelegate : UIResponder <UIApplicationDelegate>
+#import <RNCAsyncStorage/RNCAsyncStorageDelegate.h>
+
+@interface AppDelegate : UIResponder <UIApplicationDelegate, RNCAsyncStorageDelegate>
 
 @property (nonatomic, strong) UIWindow *window;
 
diff --git a/example/ios/AsyncStorageExample/AppDelegate.m b/example/ios/AsyncStorageExample/AppDelegate.m
@@ -7,13 +7,22 @@
 
 #import "AppDelegate.h"
 
+#import <RNCAsyncStorage/RNCAsyncStorage.h>
 #import <React/RCTBundleURLProvider.h>
+#import <React/RCTDevMenu.h>
 #import <React/RCTRootView.h>
 
-@implementation AppDelegate
+@implementation AppDelegate {
+  NSMutableDictionary<NSString *, NSString *> *_memoryStorage;
+}
 
 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
 {
+  [[NSNotificationCenter defaultCenter] addObserver:self
+                                           selector:@selector(didLoadJavaScript:)
+                                               name:RCTJavaScriptDidLoadNotification
+                                             object:nil];
+
   NSURL *jsCodeLocation;
 
   jsCodeLocation = [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"example/index" fallbackResource:nil];
@@ -32,4 +41,83 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
   return YES;
 }
 
+- (void)addDevMenuItemsForBridge:(RCTBridge *)bridge
+{
+  _memoryStorage = [NSMutableDictionary dictionary];
+
+  __weak AppDelegate *weakSelf = self;
+  RCTDevMenuItem *delegateToggle = [RCTDevMenuItem
+      buttonItemWithTitleBlock:^NSString * {
+        RNCAsyncStorage *asyncStorage = [bridge moduleForClass:[RNCAsyncStorage class]];
+        return asyncStorage.delegate == nil ? @"Set AsyncStorage Delegate"
+                                            : @"Unset AsyncStorage Delegate";
+      }
+      handler:^{
+        RNCAsyncStorage *asyncStorage = [bridge moduleForClass:[RNCAsyncStorage class]];
+        asyncStorage.delegate = asyncStorage.delegate == nil ? weakSelf : nil;
+      }];
+  [bridge.devMenu addItem:delegateToggle];
+}
+
+- (void)didLoadJavaScript:(NSNotification *)note
+{
+  RCTBridge *bridge = note.userInfo[@"bridge"];
+  if (bridge == nil) {
+    return;
+  }
+
+  [self addDevMenuItemsForBridge:bridge];
+}
+
+#pragma mark - RNCAsyncStorageDelegate
+
+- (void)allKeys:(nonnull RNCAsyncStorageResultCallback)completion
+{
+  completion(_memoryStorage.allKeys);
+}
+
+- (void)mergeValues:(nonnull NSArray<NSString *> *)values
+            forKeys:(nonnull NSArray<NSString *> *)keys
+         completion:(nonnull RNCAsyncStorageResultCallback)block
+{
+}
+
+- (void)removeAllValues:(nonnull RNCAsyncStorageCompletion)completion
+{
+  [_memoryStorage removeAllObjects];
+  completion(nil);
+}
+
+- (void)removeValuesForKeys:(nonnull NSArray<NSString *> *)keys
+                 completion:(nonnull RNCAsyncStorageResultCallback)completion
+{
+  for (NSString *key in keys) {
+    [_memoryStorage removeObjectForKey:key];
+  }
+  completion(@[]);
+}
+
+- (void)setValues:(nonnull NSArray<NSString *> *)values
+          forKeys:(nonnull NSArray<NSString *> *)keys
+       completion:(nonnull RNCAsyncStorageResultCallback)completion
+{
+  for (NSUInteger i = 0; i < values.count; ++i) {
+    NSString *value = values[i];
+    NSString *key = keys[i];
+    [_memoryStorage setObject:value forKey:key];
+  }
+  completion(@[]);
+}
+
+- (void)valuesForKeys:(nonnull NSArray<NSString *> *)keys
+           completion:(nonnull RNCAsyncStorageResultCallback)completion
+{
+  NSMutableArray *values = [NSMutableArray arrayWithCapacity:keys.count];
+  for (NSString *key in keys) {
+    NSString *value = _memoryStorage[key];
+    [values addObject:value == nil ? [NSNull null] : value];
+  }
+  completion(values);
+}
+
 @end
diff --git a/ios/RNCAsyncStorage.h b/ios/RNCAsyncStorage.h
@@ -7,6 +7,7 @@
 
 #import <React/RCTBridgeModule.h>
 #import <React/RCTInvalidating.h>
+#import <RNCAsyncStorage/RNCAsyncStorageDelegate.h>
 
 /**
  * A simple, asynchronous, persistent, key-value storage system designed as a
@@ -21,6 +22,8 @@
  */
 @interface RNCAsyncStorage : NSObject <RCTBridgeModule,RCTInvalidating>
 
+@property (nonatomic, weak, nullable) id<RNCAsyncStorageDelegate> delegate;
+
 @property (nonatomic, assign) BOOL clearOnInvalidate;
 
 @property (nonatomic, readonly, getter=isValid) BOOL valid;
@@ -37,5 +40,4 @@
 // Add multiple key value pairs to the cache.
 - (void)multiSet:(NSArray<NSArray<NSString *> *> *)kvPairs callback:(RCTResponseSenderBlock)callback;
 
-
 @end
diff --git a/ios/RNCAsyncStorage.m b/ios/RNCAsyncStorage.m
@@ -43,6 +43,18 @@ static void RCTAppendError(NSDictionary *error, NSMutableArray<NSDictionary *> *
   }
 }
 
+static NSArray<NSDictionary *> *RCTMakeErrors(NSArray<id<NSObject>> *results) {
+  NSMutableArray<NSDictionary *> *errors;
+  for (id object in results) {
+    if ([object isKindOfClass:[NSError class]]) {
+      NSError *error = (NSError *)object;
+      NSDictionary *keyError = RCTMakeError(error.localizedDescription, error, nil);
+      RCTAppendError(keyError, &errors);
+    }
+  }
+  return errors;
+}
+
 static NSString *RCTReadFile(NSString *filePath, NSString *key, NSDictionary **errorOut)
 {
   if ([[NSFileManager defaultManager] fileExistsAtPath:filePath]) {
@@ -329,30 +341,77 @@ - (NSDictionary *)_writeEntry:(NSArray<NSString *> *)entry changedManifest:(BOOL
   return errorOut;
 }
 
+- (void)_multiGet:(NSArray<NSString *> *)keys
+         callback:(RCTResponseSenderBlock)callback
+           getter:(NSString *(^)(NSUInteger i, NSString *key, NSDictionary **errorOut))getValue
+{
+  NSMutableArray<NSDictionary *> *errors;
+  NSMutableArray<NSArray<NSString *> *> *result = [NSMutableArray arrayWithCapacity:keys.count];
+  for (NSUInteger i = 0; i < keys.count; ++i) {
+    NSString *key = keys[i];
+    id keyError;
+    id value = getValue(i, key, &keyError);
+    [result addObject:@[key, RCTNullIfNil(value)]];
+    RCTAppendError(keyError, &errors);
+  }
+  callback(@[RCTNullIfNil(errors), result]);
+}
+
 #pragma mark - Exported JS Functions
 
 RCT_EXPORT_METHOD(multiGet:(NSArray<NSString *> *)keys
                   callback:(RCTResponseSenderBlock)callback)
 {
+  if (self.delegate != nil) {
+    [self.delegate valuesForKeys:keys completion:^(NSArray<id<NSObject>> *valuesOrErrors) {
+      [self _multiGet:keys
+             callback:callback
+               getter:^NSString *(NSUInteger i, NSString *key, NSDictionary **errorOut) {
+                        id valueOrError = valuesOrErrors[i];
+                        if ([valueOrError isKindOfClass:[NSError class]]) {
+                          NSError *error = (NSError *)valueOrError;
+                          NSDictionary *extraData = @{@"key": RCTNullIfNil(key)};
+                          *errorOut = RCTMakeError(error.localizedDescription, error, extraData);
+                          return nil;
+                        } else {
+                          return [valueOrError isKindOfClass:[NSString class]]
+                            ? (NSString *)valueOrError
+                            : nil;
+                        }
+                      }];
+    }];
+    return;
+  }
+
   NSDictionary *errorOut = [self _ensureSetup];
   if (errorOut) {
     callback(@[@[errorOut], (id)kCFNull]);
     return;
   }
-  NSMutableArray<NSDictionary *> *errors;
-  NSMutableArray<NSArray<NSString *> *> *result = [[NSMutableArray alloc] initWithCapacity:keys.count];
-  for (NSString *key in keys) {
-    id keyError;
-    id value = [self _getValueForKey:key errorOut:&keyError];
-    [result addObject:@[key, RCTNullIfNil(value)]];
-    RCTAppendError(keyError, &errors);
-  }
-  callback(@[RCTNullIfNil(errors), result]);
+  [self _multiGet:keys
+         callback:callback
+           getter:^(NSUInteger i, NSString *key, NSDictionary **errorOut) {
+                    return [self _getValueForKey:key errorOut:errorOut];
+                  }];
 }
 
 RCT_EXPORT_METHOD(multiSet:(NSArray<NSArray<NSString *> *> *)kvPairs
                   callback:(RCTResponseSenderBlock)callback)
 {
+  if (self.delegate != nil) {
+    NSMutableArray<NSString *> *keys = [NSMutableArray arrayWithCapacity:kvPairs.count];
+    NSMutableArray<NSString *> *values = [NSMutableArray arrayWithCapacity:kvPairs.count];
+    for (NSArray<NSString *> *entry in kvPairs) {
+      [keys addObject:entry[0]];
+      [values addObject:entry[1]];
+    }
+    [self.delegate setValues:values forKeys:keys completion:^(NSArray<id<NSObject>> *results) {
+      NSArray<NSDictionary *> *errors = RCTMakeErrors(results);
+      callback(@[RCTNullIfNil(errors)]);
+    }];
+    return;
+  }
+
   NSDictionary *errorOut = [self _ensureSetup];
   if (errorOut) {
     callback(@[@[errorOut]]);
@@ -373,6 +432,20 @@ - (NSDictionary *)_writeEntry:(NSArray<NSString *> *)entry changedManifest:(BOOL
 RCT_EXPORT_METHOD(multiMerge:(NSArray<NSArray<NSString *> *> *)kvPairs
                     callback:(RCTResponseSenderBlock)callback)
 {
+  if (self.delegate != nil) {
+    NSMutableArray<NSString *> *keys = [NSMutableArray arrayWithCapacity:kvPairs.count];
+    NSMutableArray<NSString *> *values = [NSMutableArray arrayWithCapacity:kvPairs.count];
+    for (NSArray<NSString *> *entry in kvPairs) {
+      [keys addObject:entry[0]];
+      [values addObject:entry[1]];
+    }
+    [self.delegate mergeValues:values forKeys:keys completion:^(NSArray<id<NSObject>> *results) {
+      NSArray<NSDictionary *> *errors = RCTMakeErrors(results);
+      callback(@[RCTNullIfNil(errors)]);
+    }];
+    return;
+  }
+
   NSDictionary *errorOut = [self _ensureSetup];
   if (errorOut) {
     callback(@[@[errorOut]]);
@@ -407,8 +480,16 @@ - (NSDictionary *)_writeEntry:(NSArray<NSString *> *)entry changedManifest:(BOOL
 }
 
 RCT_EXPORT_METHOD(multiRemove:(NSArray<NSString *> *)keys
-                  callback:(RCTResponseSenderBlock)callback)
+                     callback:(RCTResponseSenderBlock)callback)
 {
+  if (self.delegate != nil) {
+    [self.delegate removeValuesForKeys:keys completion:^(NSArray<id<NSObject>> *results) {
+      NSArray<NSDictionary *> *errors = RCTMakeErrors(results);
+      callback(@[RCTNullIfNil(errors)]);
+    }];
+    return;
+  }
+
   NSDictionary *errorOut = [self _ensureSetup];
   if (errorOut) {
     callback(@[@[errorOut]]);
@@ -439,6 +520,17 @@ - (NSDictionary *)_writeEntry:(NSArray<NSString *> *)entry changedManifest:(BOOL
 
 RCT_EXPORT_METHOD(clear:(RCTResponseSenderBlock)callback)
 {
+  if (self.delegate != nil) {
+    [self.delegate removeAllValues:^(NSError *error) {
+      NSDictionary *result = nil;
+      if (error != nil) {
+        result = RCTMakeError(error.localizedDescription, error, nil);
+      }
+      callback(@[RCTNullIfNil(result)]);
+    }];
+    return;
+  }
+
   [_manifest removeAllObjects];
   [RCTGetCache() removeAllObjects];
   NSDictionary *error = RCTDeleteStorageDirectory();
@@ -447,6 +539,13 @@ - (NSDictionary *)_writeEntry:(NSArray<NSString *> *)entry changedManifest:(BOOL
 
 RCT_EXPORT_METHOD(getAllKeys:(RCTResponseSenderBlock)callback)
 {
+  if (self.delegate != nil) {
+    [self.delegate allKeys:^(NSArray<id<NSObject>> *keys) {
+      callback(@[(id)kCFNull, keys]);
+    }];
+    return;
+  }
+
   NSDictionary *errorOut = [self _ensureSetup];
   if (errorOut) {
     callback(@[errorOut, (id)kCFNull]);
diff --git a/ios/RNCAsyncStorage.xcodeproj/project.pbxproj b/ios/RNCAsyncStorage.xcodeproj/project.pbxproj
diff --git a/ios/RNCAsyncStorageDelegate.h b/ios/RNCAsyncStorageDelegate.h
