feat: add register dynamic generalProps block

growingio · Apr 17, 2024 · 76e66ea · 76e66ea
1 parent 3ce88fc
commit 76e66ea
Show file tree

Hide file tree

Showing 8 changed files with 71 additions and 1 deletion.
diff --git a/Example/GrowingAnalyticsTests/A0GrowingAnalyticsTest.m b/Example/GrowingAnalyticsTests/A0GrowingAnalyticsTest.m
@@ -1011,6 +1011,25 @@ - (void)test22SetGeneralProps {
         XCTAssertEqualObjects(event.eventName, @"eventName");
         XCTAssertEqual(event.attributes.count, 0);
     }
+
+    {
+        // set dynamic generalProps
+        [MockEventQueue.sharedQueue cleanQueue];
+
+        [[GrowingAutotracker sharedInstance] setGeneralProps:@{@"key" : @"value", @"key2" : @"value2"}];
+        [[GrowingAutotracker sharedInstance] registerDynamicGeneralPropsBlock:^NSDictionary<NSString *,NSString *> * _Nonnull{
+            return @{@"key": @"valueChange", @"key3": @(1)};
+        }];
+        [[GrowingAutotracker sharedInstance] trackCustomEvent:@"eventName"];
+        NSArray<GrowingBaseEvent *> *events = [MockEventQueue.sharedQueue eventsFor:GrowingEventTypeCustom];
+        XCTAssertEqual(events.count, 1);
+
+        GrowingCustomEvent *event = (GrowingCustomEvent *)events.lastObject;
+        XCTAssertEqualObjects(event.eventName, @"eventName");
+        XCTAssertEqualObjects(event.attributes[@"key"], @"valueChange");
+        XCTAssertEqualObjects(event.attributes[@"key2"], @"value2");
+        XCTAssertEqualObjects(event.attributes[@"key3"], @"1");
+    }
 }
 
 @end

diff --git a/GrowingAutotracker/GrowingAutotracker.h b/GrowingAutotracker/GrowingAutotracker.h
@@ -128,6 +128,10 @@ NS_ASSUME_NONNULL_BEGIN
 /// @param props 事件通用属性，相同字段的新值将覆盖旧值
 - (void)setGeneralProps:(NSDictionary<NSString *, NSString *> *)props;
 
+/// 设置埋点动态通用属性
+/// @param dynamicGeneralPropsBlock 动态通用属性，其优先级大于通用属性
+- (void)registerDynamicGeneralPropsBlock:(NSDictionary<NSString *, NSString *> *(^_Nullable)(void))dynamicGeneralPropsBlock;
+
 /// 清除指定字段的埋点通用属性
 /// @param keys 通用属性指定字段
 - (void)removeGeneralProps:(NSArray<NSString *> *)keys;

diff --git a/GrowingTracker/GrowingTracker.h b/GrowingTracker/GrowingTracker.h
@@ -121,6 +121,10 @@ NS_ASSUME_NONNULL_BEGIN
 /// @param props 事件通用属性，相同字段的新值将覆盖旧值
 - (void)setGeneralProps:(NSDictionary<NSString *, NSString *> *)props;
 
+/// 设置埋点动态通用属性
+/// @param dynamicGeneralPropsBlock 动态通用属性，其优先级大于通用属性
+- (void)registerDynamicGeneralPropsBlock:(NSDictionary<NSString *, NSString *> *(^_Nullable)(void))dynamicGeneralPropsBlock;
+
 /// 清除指定字段的埋点通用属性
 /// @param keys 通用属性指定字段
 - (void)removeGeneralProps:(NSArray<NSString *> *)keys;

diff --git a/GrowingTrackerCore/Event/GrowingEventManager.h b/GrowingTrackerCore/Event/GrowingEventManager.h
@@ -86,6 +86,7 @@
 
 - (NSDictionary<NSString *, NSString *> *_Nonnull)generalProps;
 - (void)setGeneralProps:(NSDictionary<NSString *, NSString *> *_Nonnull)props;
+- (void)registerDynamicGeneralPropsBlock:(NSDictionary<NSString *, NSString *> *_Nonnull(^_Nullable)(void))dynamicGeneralPropsBlock;
 - (void)removeGeneralProps:(NSArray<NSString *> *_Nonnull)keys;
 - (void)clearGeneralProps;
 

diff --git a/GrowingTrackerCore/Event/GrowingEventManager.m b/GrowingTrackerCore/Event/GrowingEventManager.m
@@ -173,6 +173,10 @@ - (void)setGeneralProps:(NSDictionary<NSString *, NSString *> *)props {
     [self.gProps setGeneralProps:props];
 }
 
+- (void)registerDynamicGeneralPropsBlock:(NSDictionary<NSString *, NSString *> *(^_Nullable)(void))dynamicGeneralPropsBlock {
+    [self.gProps registerDynamicGeneralPropsBlock:dynamicGeneralPropsBlock];
+}
+
 - (void)removeGeneralProps:(NSArray<NSString *> *)keys {
     [self.gProps removeGeneralProps:keys];
 }

diff --git a/GrowingTrackerCore/Event/GrowingGeneralProps.h b/GrowingTrackerCore/Event/GrowingGeneralProps.h
@@ -27,6 +27,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (void)setGeneralProps:(NSDictionary<NSString *, NSString *> *)props;
 
+- (void)registerDynamicGeneralPropsBlock:(NSDictionary<NSString *, NSString *> *(^_Nullable)(void))dynamicGeneralPropsBlock;
+
 - (void)removeGeneralProps:(NSArray<NSString *> *)keys;
 
 - (void)clearGeneralProps;

diff --git a/GrowingTrackerCore/Event/GrowingGeneralProps.m b/GrowingTrackerCore/Event/GrowingGeneralProps.m
@@ -22,6 +22,7 @@
 @interface GrowingGeneralProps ()
 
 @property (nonatomic, strong) NSMutableDictionary<NSString *, NSString *> *internalProps;
+@property (nonatomic, copy) NSDictionary<NSString *, NSString *> *(^dynamicPropsBlock)(void);
 
 @end
 
@@ -31,6 +32,10 @@ - (void)setGeneralProps:(NSDictionary<NSString *, NSString *> *)props {
     [self.internalProps addEntriesFromDictionary:props];
 }
 
+- (void)registerDynamicGeneralPropsBlock:(NSDictionary<NSString *, NSString *> *(^_Nullable)(void))dynamicGeneralPropsBlock {
+    self.dynamicPropsBlock = dynamicGeneralPropsBlock;
+}
+
 - (void)removeGeneralProps:(NSArray<NSString *> *)keys {
     [self.internalProps removeObjectsForKeys:keys];
 }
@@ -39,10 +44,35 @@ - (void)clearGeneralProps {
     [self.internalProps removeAllObjects];
 }
 
+- (NSDictionary<NSString *, NSString *> *)validProperties:(NSDictionary *)properties {
+    if (![properties isKindOfClass:[NSDictionary class]]) {
+        return nil;
+    }
+
+    NSMutableDictionary *result = [NSMutableDictionary dictionary];
+    for (NSString *key in properties.allKeys) {
+        id value = properties[key];
+        if ([value isKindOfClass:[NSString class]]) {
+            result[key] = value;
+        } else if ([value isKindOfClass:[NSNumber class]]) {
+            result[key] = ((NSNumber *)value).stringValue;
+        }
+    }
+    return [result copy];
+}
+
 #pragma mark - Setter && Getter
 
 - (NSDictionary<NSString *, NSString *> *)props {
-    return self.internalProps.copy;
+    // dynamic general properties > general properties
+    NSMutableDictionary *finalProps = self.internalProps.mutableCopy;
+    if (self.dynamicPropsBlock) {
+        NSDictionary *dynamicProps = self.dynamicPropsBlock();
+        if (dynamicProps && [dynamicProps isKindOfClass:[NSDictionary class]]) {
+            [finalProps addEntriesFromDictionary:dynamicProps];
+        }
+    }
+    return [self validProperties:finalProps];
 }
 
 - (NSMutableDictionary<NSString *, NSString *> *)internalProps {

diff --git a/GrowingTrackerCore/GrowingRealTracker.m b/GrowingTrackerCore/GrowingRealTracker.m
@@ -222,6 +222,12 @@ - (void)setGeneralProps:(NSDictionary<NSString *, NSString *> *)props {
     }];
 }
 
+- (void)registerDynamicGeneralPropsBlock:(NSDictionary<NSString *, NSString *> *(^_Nullable)(void))dynamicGeneralPropsBlock {
+    [GrowingDispatchManager dispatchInGrowingThread:^{
+        [[GrowingEventManager sharedInstance] registerDynamicGeneralPropsBlock:dynamicGeneralPropsBlock];
+    }];
+}
+
 - (void)removeGeneralProps:(NSArray<NSString *> *)keys {
     if ([GrowingArgumentChecker isIllegalKeys:keys]) {
         return;