NR-317126 New Event System session attribute can't contain a reserved…

…AttributeNames (#318) * NR-317126 Added the prefix list to use in the new event system attribute validator * Fixed or added test for prefixes
newrelic · Oct 9, 2024 · e66a6dd · e66a6dd
1 parent f083abf
commit e66a6dd
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 5 deletions.
diff --git a/Agent/Analytics/NRMAAnalytics.h b/Agent/Analytics/NRMAAnalytics.h
@@ -75,5 +75,6 @@
 
 + (int64_t) currentTimeMillis;
 + (NSArray<NSString*>*) reservedKeywords;
++ (NSArray<NSString*>*) reservedPrefixes;
 
 @end
diff --git a/Agent/Analytics/NRMAAnalytics.mm b/Agent/Analytics/NRMAAnalytics.mm
@@ -131,11 +131,14 @@ - (id) initWithSessionStartTimeMS:(long long) sessionStartTime {
                         NRLOG_AGENT_ERROR(@"invalid attribute: name prefix disallowed");
                         return false;
                     }
+                }
+                for (NSString* key in [NRMAAnalytics reservedPrefixes]) {
                     if ([name hasPrefix:key])  {
                         NRLOG_AGENT_ERROR(@"invalid attribute: name prefix disallowed");
                         return false;
                     }
                 }
+
                 // check if attribute name exceeds max length.
                 if ([name length] > kNRMA_Attrib_Max_Name_Length) {
                     NRLOG_AGENT_ERROR(@"invalid attribute: name length exceeds limit");
@@ -1269,4 +1272,11 @@ + (int64_t) currentTimeMillis {
         ,nil];
 }
 
++ (NSArray<NSString*>*) reservedPrefixes {
+    return [NSArray arrayWithObjects:
+            kNRMA_RP_newRelic,
+            kNRMA_RP_nr,
+            nil];
+}
+
 @end
diff --git a/Tests/Unit-Tests/NewRelicAgentTests/Analytics-Tests/NRMASAMTest.mm b/Tests/Unit-Tests/NewRelicAgentTests/Analytics-Tests/NRMASAMTest.mm
@@ -42,12 +42,14 @@ - (NRMASAM*) samTest {
         // check if attribute name is reserved or attribute name matches reserved prefix.
         for (NSString* key in [NRMAAnalytics reservedKeywords]) {
             if ([key isEqualToString:name]) {
-                NRLOG_AGENT_ERROR(@"invalid attribute: name prefix disallowed");
+                NRLOG_AGENT_ERROR(@"invalid attribute: name disallowed");
                 return NO;
             }
-            if ([key hasPrefix:name])  {
+        }
+        for (NSString* key in [NRMAAnalytics reservedPrefixes]) {
+            if ([name hasPrefix:key])  {
                 NRLOG_AGENT_ERROR(@"invalid attribute: name prefix disallowed");
-                return NO;
+                return false;
             }
         }
         // check if attribute name exceeds max length.
@@ -91,6 +93,19 @@ - (void) testSetSessionAttribute {
     XCTAssertTrue([decode[@"blarg"] isEqualToString:@"blurg"]);
 }
 
+- (void) testSetSessionAttributeFail {
+    XCTAssertFalse([manager setSessionAttribute:@"platform" value:@"blurg"], @"Failed to successfully find reserved key for session attribute");
+
+    XCTAssertFalse([manager setSessionAttribute:@"nr.test" value:@"blurg"], @"Failed to successfully find reserved prefix key for session attribute");
+
+    NSString* attributes = [manager sessionAttributeJSONString];
+
+    NSDictionary* decode = [NSJSONSerialization JSONObjectWithData:[attributes dataUsingEncoding:NSUTF8StringEncoding]
+                                                           options:0
+                                                             error:nil];
+    XCTAssertNil(decode[@"platform"]);
+}
+
 - (void) testSetNRSessionAttribute {
     XCTAssertTrue([manager setNRSessionAttribute:@"blarg" value:@"blurg"], @"Failed to successfully set session attribute");
 
@@ -280,8 +295,8 @@ -(void) testSetSessionAttributeNameFailed {
     XCTAssertFalse([manager setSessionAttribute:@"  x" value:@"blurg"], @"Failed to successfully fail when setting invalid name for session attribute");
     XCTAssertFalse([manager setSessionAttribute:@"  " value:@"blurg"], @"Failed to successfully fail when setting invalid name for session attribute");
 
-    XCTAssertFalse([manager setSessionAttribute:@"even" value:@"blurg"], @"Failed to successfully fail when setting invalid name for session attribute");
-    XCTAssertFalse([manager setSessionAttribute:@"event" value:@"blurg"], @"Failed to successfully fail when setting invalid name for session attribute");
+    XCTAssertFalse([manager setSessionAttribute:@"newRelictest" value:@"blurg"], @"Failed to successfully fail when setting invalid name for session attribute");
+    XCTAssertFalse([manager setSessionAttribute:@"nr.test" value:@"blurg"], @"Failed to successfully fail when setting invalid name for session attribute");
 
     // Test Max Attribute Length
     NSString *validAttributeName =  [@"" stringByPaddingToLength:kNRMA_Attrib_Max_Name_Length withString:@"x" startingAtIndex:0];