Implement helpers for storing and finding events (#5738)

mikehaney24 · web-flow · commit 9a0aed81b0bd · 2020-06-03T14:10:08.000-07:00
* Implement helpers for storing and finding events

* Fix missing imports

* Add clarifying comments and remove unneeded nullability

Also remove a test and fix the behavior of searchPathsWithEventSelector

* Added missing docs and properly implemented +reset
diff --git a/GoogleDataTransport/GDTCORLibrary/GDTCORFlatFileStorage.m b/GoogleDataTransport/GDTCORLibrary/GDTCORFlatFileStorage.m
@@ -21,11 +21,18 @@
 #import <GoogleDataTransport/GDTCOREvent.h>
 #import <GoogleDataTransport/GDTCORLifecycle.h>
 #import <GoogleDataTransport/GDTCORPrioritizer.h>
+#import <GoogleDataTransport/GDTCORStorageEventSelector.h>
 
 #import "GDTCORLibrary/Private/GDTCOREvent_Private.h"
 #import "GDTCORLibrary/Private/GDTCORRegistrar_Private.h"
 #import "GDTCORLibrary/Private/GDTCORUploadCoordinator.h"
 
+NSString *const gGDTCORFlatFileStorageEventDataPathKey = @"DataPath";
+
+NSString *const gGDTCORFlatFileStorageMappingIDPathKey = @"MappingIDPath";
+
+NSString *const gGDTCORFlatFileStorageQoSTierPathKey = @"QoSTierPath";
+
 @implementation GDTCORFlatFileStorage
 
 + (void)load {
@@ -51,27 +58,118 @@ + (NSString *)archivePath {
   return archivePath;
 }
 
-+ (NSString *)libraryDataPath {
-  static NSString *libraryDataPath;
++ (NSString *)baseEventStoragePath {
+  static NSString *eventDataPath;
   static dispatch_once_t onceToken;
   dispatch_once(&onceToken, ^{
-    libraryDataPath =
+    eventDataPath =
         [GDTCORRootDirectory() URLByAppendingPathComponent:NSStringFromClass([self class])
                                                isDirectory:YES]
             .path;
-    libraryDataPath = [libraryDataPath stringByAppendingPathComponent:@"gdt_library_data"];
-    if (![[NSFileManager defaultManager] fileExistsAtPath:libraryDataPath isDirectory:NULL]) {
+    eventDataPath = [eventDataPath stringByAppendingPathComponent:@"gdt_event_data"];
+    if (![[NSFileManager defaultManager] fileExistsAtPath:eventDataPath isDirectory:NULL]) {
       NSError *error;
-      [[NSFileManager defaultManager] createDirectoryAtPath:libraryDataPath
+      [[NSFileManager defaultManager] createDirectoryAtPath:eventDataPath
                                 withIntermediateDirectories:YES
                                                  attributes:0
                                                       error:&error];
       GDTCORAssert(error == nil, @"Creating the library data path failed: %@", error);
     }
   });
+  return eventDataPath;
+}
+
++ (NSString *)libraryDataStoragePath {
+  static NSString *libraryDataPath;
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    libraryDataPath =
+        [GDTCORRootDirectory() URLByAppendingPathComponent:NSStringFromClass([self class])
+                                               isDirectory:YES]
+            .path;
+    libraryDataPath = [libraryDataPath stringByAppendingPathComponent:@"gdt_library_data"];
+  });
+  if (![[NSFileManager defaultManager] fileExistsAtPath:libraryDataPath isDirectory:NULL]) {
+    NSError *error;
+    [[NSFileManager defaultManager] createDirectoryAtPath:libraryDataPath
+                              withIntermediateDirectories:YES
+                                               attributes:0
+                                                    error:&error];
+    GDTCORAssert(error == nil, @"Creating the library data path failed: %@", error);
+  }
   return libraryDataPath;
 }
 
++ (NSDictionary<NSString *, NSString *> *)pathsForEvent:(GDTCOREvent *)event {
+  NSString *dataPath =
+      [NSString stringWithFormat:@"%@/%ld/%@", [GDTCORFlatFileStorage baseEventStoragePath],
+                                 (long)event.target, event.eventID];
+  NSString *mappingIDPath =
+      [NSString stringWithFormat:@"%@/%ld/%@/%@", [GDTCORFlatFileStorage baseEventStoragePath],
+                                 (long)event.target, event.mappingID, event.eventID];
+  NSString *qosTierPath =
+      [NSString stringWithFormat:@"%@/%ld/%ld/%@", [GDTCORFlatFileStorage baseEventStoragePath],
+                                 (long)event.target, (long)event.qosTier, event.eventID];
+  return @{
+    gGDTCORFlatFileStorageEventDataPathKey : dataPath,
+    gGDTCORFlatFileStorageMappingIDPathKey : mappingIDPath,
+    gGDTCORFlatFileStorageQoSTierPathKey : qosTierPath
+  };
+}
+
++ (NSString *)pathForTarget:(GDTCORTarget)target
+                    qosTier:(nullable NSNumber *)qosTier
+                  mappingID:(nullable NSString *)mappingID {
+  NSString *baseEventPath = [GDTCORFlatFileStorage baseEventStoragePath];
+  // If only a target was given, return the target path.
+  if (qosTier == nil && mappingID == nil) {
+    return [NSString stringWithFormat:@"%@/%ld", baseEventPath, (long)target];
+  }
+
+  // If only a target and mappingID were given, return the mapping ID path.
+  if (qosTier == nil) {
+    return [NSString stringWithFormat:@"%@/%ld/%@", baseEventPath, (long)target, mappingID];
+  }
+
+  // If only a target and qosTier were given, return the QoS tier path.
+  if (mappingID == nil) {
+    return [NSString stringWithFormat:@"%@/%ld/%@", baseEventPath, (long)target, qosTier];
+  }
+
+  // If a target, mappingID, and qosTier were all given, return a single target/qosTier/mappingID
+  // directory.
+  return
+      [NSString stringWithFormat:@"%@/%ld/%@/%@", baseEventPath, (long)target, qosTier, mappingID];
+}
+
++ (NSArray<NSString *> *)searchPathsWithEventSelector:(GDTCORStorageEventSelector *)eventSelector {
+  NSMutableArray<NSString *> *searchPaths = [[NSMutableArray alloc] init];
+  if (eventSelector.selectedQosTiers && eventSelector.selectedQosTiers.count > 0) {
+    for (NSNumber *qosTier in eventSelector.selectedQosTiers) {
+      NSString *searchPath = [self pathForTarget:eventSelector.selectedTarget
+                                         qosTier:qosTier
+                                       mappingID:eventSelector.selectedMappingID];
+      BOOL isDirectory;
+      if ([[NSFileManager defaultManager] fileExistsAtPath:searchPath isDirectory:&isDirectory]) {
+        if (isDirectory) {
+          [searchPaths addObject:searchPath];
+        }
+      }
+    }
+  } else {
+    NSString *searchPath = [self pathForTarget:eventSelector.selectedTarget
+                                       qosTier:nil
+                                     mappingID:eventSelector.selectedMappingID];
+    BOOL isDirectory;
+    if ([[NSFileManager defaultManager] fileExistsAtPath:searchPath isDirectory:&isDirectory]) {
+      if (isDirectory) {
+        [searchPaths addObject:searchPath];
+      }
+    }
+  }
+  return searchPaths;
+}
+
 + (instancetype)sharedInstance {
   static GDTCORFlatFileStorage *sharedStorage;
   static dispatch_once_t onceToken;
@@ -214,7 +312,7 @@ - (void)libraryDataForKey:(nonnull NSString *)key
                onComplete:
                    (nonnull void (^)(NSData *_Nullable, NSError *_Nullable error))onComplete {
   dispatch_async(_storageQueue, ^{
-    NSString *dataPath = [[[self class] libraryDataPath] stringByAppendingPathComponent:key];
+    NSString *dataPath = [[[self class] libraryDataStoragePath] stringByAppendingPathComponent:key];
     NSError *error;
     NSData *data = [NSData dataWithContentsOfFile:dataPath options:0 error:&error];
     if (onComplete) {
@@ -234,7 +332,7 @@ - (void)storeLibraryData:(NSData *)data
   }
   dispatch_async(_storageQueue, ^{
     NSError *error;
-    NSString *dataPath = [[[self class] libraryDataPath] stringByAppendingPathComponent:key];
+    NSString *dataPath = [[[self class] libraryDataStoragePath] stringByAppendingPathComponent:key];
     [data writeToFile:dataPath options:NSDataWritingAtomic error:&error];
     if (onComplete) {
       onComplete(error);
@@ -246,7 +344,7 @@ - (void)removeLibraryDataForKey:(nonnull NSString *)key
                      onComplete:(nonnull void (^)(NSError *_Nullable error))onComplete {
   dispatch_async(_storageQueue, ^{
     NSError *error;
-    NSString *dataPath = [[[self class] libraryDataPath] stringByAppendingPathComponent:key];
+    NSString *dataPath = [[[self class] libraryDataStoragePath] stringByAppendingPathComponent:key];
     if ([[NSFileManager defaultManager] fileExistsAtPath:dataPath]) {
       [[NSFileManager defaultManager] removeItemAtPath:dataPath error:&error];
       if (onComplete) {
@@ -310,8 +408,8 @@ - (void)appWillForeground:(GDTCORApplication *)app {
 
 - (void)appWillBackground:(GDTCORApplication *)app {
   dispatch_async(_storageQueue, ^{
-    // Immediately request a background task to run until the end of the current queue of work, and
-    // cancel it once the work is done.
+    // Immediately request a background task to run until the end of the current queue of work,
+    // and cancel it once the work is done.
     __block GDTCORBackgroundIdentifier bgID =
         [app beginBackgroundTaskWithName:@"GDTStorage"
                        expirationHandler:^{
diff --git a/GoogleDataTransport/GDTCORLibrary/GDTCORStorageEventSelector.m b/GoogleDataTransport/GDTCORLibrary/GDTCORStorageEventSelector.m
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "GDTCORLibrary/Public/GDTCORStorageEventSelector.h"
+
+@implementation GDTCORStorageEventSelector
+
+- (instancetype)initWithTarget:(GDTCORTarget)target
+                eventIDEqualTo:(nullable NSNumber *)eventID
+              mappingIDEqualTo:(nullable NSString *)mappingID
+                      qosTiers:(nullable NSArray<NSNumber *> *)qosTiers {
+  self = [super init];
+  if (self) {
+    _selectedTarget = target;
+    _selectedEventID = eventID;
+    _selectedMappingID = mappingID;
+    _selectedQosTiers = qosTiers;
+  }
+  return self;
+}
+
+@end
diff --git a/GoogleDataTransport/GDTCORLibrary/Private/GDTCORFlatFileStorage.h b/GoogleDataTransport/GDTCORLibrary/Private/GDTCORFlatFileStorage.h
@@ -17,14 +17,33 @@
 #import <Foundation/Foundation.h>
 
 #import <GoogleDataTransport/GDTCORLifecycle.h>
+#import <GoogleDataTransport/GDTCORStorageEventSelector.h>
 #import <GoogleDataTransport/GDTCORStorageProtocol.h>
 
 @class GDTCOREvent;
 @class GDTCORUploadCoordinator;
 
 NS_ASSUME_NONNULL_BEGIN
 
-/** Manages the storage of events. This class is thread-safe. */
+/** The key of the event data path if a path dictionary is returned. */
+FOUNDATION_EXPORT NSString *const gGDTCORFlatFileStorageEventDataPathKey;
+
+/** The key of the event's mapping ID path if a path dictionary is returned. */
+FOUNDATION_EXPORT NSString *const gGDTCORFlatFileStorageMappingIDPathKey;
+
+/** The key of the event's qos tier path if a path dictionary is returned. */
+FOUNDATION_EXPORT NSString *const gGDTCORFlatFileStorageQoSTierPathKey;
+
+/** Manages the storage of events. This class is thread-safe.
+ *
+ * Event files will be stored as follows:
+ *   <app cache>/gdt_event_data/<target>/<eventID> as a normal file write
+ *   <app cache>/gdt_event_data/<target>/<qosTier>/<eventID> as a symbolic link
+ *   <app cache>/gdt_event_data/<target>/<mappingID>/<eventID> as a symbolic link
+ *
+ * Library data will be stored as follows:
+ *   <app cache>/gdt_library_data/<key of library data>
+ */
 @interface GDTCORFlatFileStorage
     : NSObject <NSSecureCoding, GDTCORStorageProtocol, GDTCORLifecycleProtocol>
 
@@ -54,6 +73,44 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (NSString *)archivePath;
 
+/** Returns the base directory under which all events will be stored.
+ *
+ * @return The base directory under which all events will be stored.
+ */
++ (NSString *)baseEventStoragePath;
+
+/** Returns the base directory under which all library data will be stored.
+ *
+ * @return The base directory under which all library data will be stored.
+ */
++ (NSString *)libraryDataStoragePath;
+
+/** Returns storage paths for the given event, though the paths may not exist.
+ *
+ * @note The keys of this dictionary are declared in this header.
+ * @param event The event to map to storage paths.
+ */
++ (NSDictionary<NSString *, NSString *> *)pathsForEvent:(GDTCOREvent *)event;
+
+/** Returns a storage path to events for the given target, qosTier, and mapping ID. The path may not
+ * exist.
+ *
+ * @param target The target, which is necessary to be given a path.
+ * @param qosTier An optional parameter to get a more specific path.
+ * @param mappingID An optional parameter to get a more specific path.
+ * @return The path representing the combination of the given parameters.
+ */
++ (NSString *)pathForTarget:(GDTCORTarget)target
+                    qosTier:(nullable NSNumber *)qosTier
+                  mappingID:(nullable NSString *)mappingID;
+
+/** Returns a list of paths that will contain events for the given event selector.
+ *
+ * @param eventSelector The event selector to process.
+ * @return A list of paths that exist and could contain events.
+ */
++ (NSArray<NSString *> *)searchPathsWithEventSelector:(GDTCORStorageEventSelector *)eventSelector;
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/GoogleDataTransport/GDTCORLibrary/Public/GDTCORStorageEventSelector.h b/GoogleDataTransport/GDTCORLibrary/Public/GDTCORStorageEventSelector.h
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import <GoogleDataTransport/GDTCORTargets.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/** This class enables the finding of events by matching events with the properties of this class.
+ */
+@interface GDTCORStorageEventSelector : NSObject
+
+/** The target to find events for. Required. */
+@property(readonly, nonatomic) GDTCORTarget selectedTarget;
+
+/** Finds a specific event. */
+@property(nullable, readonly, nonatomic) NSNumber *selectedEventID;
+
+/** Finds all events of a mappingID. */
+@property(nullable, readonly, nonatomic) NSString *selectedMappingID;
+
+/** Finds all events matching the qosTiers in this list. */
+@property(nullable, readonly, nonatomic) NSArray<NSNumber *> *selectedQosTiers;
+
+/** Instantiates an event selector.
+ *
+ * @param target The selected target.
+ * @param eventID Optional param to find an event matching this eventID.
+ * @param mappingID Optional param to find events matching this mappingID.
+ * @param qosTiers Optional param to find events matching the given QoS tiers.
+ * @return An immutable event selector instance.
+ */
+- (instancetype)initWithTarget:(GDTCORTarget)target
+                eventIDEqualTo:(nullable NSNumber *)eventID
+              mappingIDEqualTo:(nullable NSString *)mappingID
+                      qosTiers:(nullable NSArray<NSNumber *> *)qosTiers;
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/GoogleDataTransport/GDTCORTests/Common/Categories/GDTCORFlatFileStorage+Testing.m b/GoogleDataTransport/GDTCORTests/Common/Categories/GDTCORFlatFileStorage+Testing.m
@@ -25,9 +25,11 @@ - (void)reset {
   dispatch_sync(self.storageQueue, ^{
     [self.targetToEventSet removeAllObjects];
     [self.storedEvents removeAllObjects];
-    NSError *error;
-    [[NSFileManager defaultManager] removeItemAtPath:[GDTCORFlatFileStorage archivePath]
-                                               error:&error];
+    [[NSFileManager defaultManager] removeItemAtPath:[GDTCORFlatFileStorage archivePath] error:nil];
+    [[NSFileManager defaultManager] removeItemAtPath:[GDTCORFlatFileStorage baseEventStoragePath]
+                                               error:nil];
+    [[NSFileManager defaultManager] removeItemAtPath:[GDTCORFlatFileStorage libraryDataStoragePath]
+                                               error:nil];
   });
 }
 
diff --git a/GoogleDataTransport/GDTCORTests/Unit/GDTCORFlatFileStorageTest.m b/GoogleDataTransport/GDTCORTests/Unit/GDTCORFlatFileStorageTest.m
