Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prevent setUserId nil log #343

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
+34 −13
Open

Prevent setUserId nil log #343

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68166ad
Prevent setUserId nil log
cdillard-NewRelic Jan 30, 2025
0a30ba8
Merge branch 'develop' of github.com:newrelic/newrelic-ios-agent into…
cdillard-NewRelic Jan 31, 2025
26bbdce
NR-364665: setUserId tweaks
cdillard-NewRelic Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Agent/Analytics/NRMAAnalytics.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -605,7 +605,13 @@ - (BOOL) setSessionAttribute:(NSString*)name value:(id)value persistent:(BOOL)is
[](bool) { return true;});
return _analyticsController->addNRAttribute(attribute);
} else {
NRLOG_AGENT_ERROR(@"Session attribute \'value\' must be either an NSString* or NSNumber*");
if (name == kNRMA_Attrib_userId && !value ) {
NRLOG_AGENT_VERBOSE(@"Successfully set userId to nil");
return YES;

}else {
NRLOG_AGENT_ERROR(@"Session attribute \'value\' must be either an NSString* or NSNumber*");
}
return NO;
}
} catch (std::exception& error) {
Expand Down
4 changes: 4 additions & 0 deletions Agent/Analytics/NRMASAM.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@ - (BOOL) checkAttribute:(NSString*)name value:(id)value {
BOOL validAttribute = [attributeValidator nameValidator:name];
BOOL validValue = [attributeValidator valueValidator:value];

if (name == kNRMA_Attrib_userId && !value ) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want this to continue being an actual nil value, or do we want to put a placeholder value in for when it gets parsed on the backend?

Copy link
Member Author

@cdillard-NewRelic cdillard-NewRelic Jan 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good question. It appears to me that userId is not a real "reserved" NR session attribute. Essentially an additional layer was added on the user attribute named "userId"

In our current impl we set the userId with

    BOOL success = [[NewRelicAgentInternal sharedInstance].analyticsController setSessionAttribute:kNRMA_Attrib_userId
                                                                                             value:userId
                                                                                        persistent:YES];

and if setting to nil we also call to remove

    // If passed userId == NULL , remove UserId attribute.
    if (userId == NULL) {
        success = [[NewRelicAgentInternal sharedInstance].analyticsController removeSessionAttributeNamed:kNRMA_Attrib_userId];
    }

+ (BOOL) setUserId:(NSString* _Nullable)userId {
    NSString *previousUserId = [[NewRelicAgentInternal sharedInstance] getUserId];
    BOOL newSession = false;
    // If the client passes a new userId that is non NULL.
    if (userId != NULL) {
        // A new userId has been set where the previously set one (during this app session (since app launch)) was not NULL or the previous set one was NULL, we start a new session.
        newSession = true;
    }
    // If the client passes a new NULL userId.
    else {
        if (previousUserId != NULL) {
            // end session and harvest.
            newSession = true;
        }
        // Do nothing if passed userId is null and saved userId (for this app session (since app launch)) is null.
    }

    // Update in memory userId.
    [NewRelicAgentInternal sharedInstance].userId = userId;

    if (newSession) {
        [[[NewRelicAgentInternal sharedInstance] analyticsController] newSession];

        // Perform harvest
        [self harvestNow];

        [[NewRelicAgentInternal sharedInstance] sessionStartInitialization];
    }

    BOOL success = [[NewRelicAgentInternal sharedInstance].analyticsController setSessionAttribute:kNRMA_Attrib_userId
                                                                                             value:userId
                                                                                        persistent:YES];
    // If passed userId == NULL , remove UserId attribute.
    if (userId == NULL) {
        success = [[NewRelicAgentInternal sharedInstance].analyticsController removeSessionAttributeNamed:kNRMA_Attrib_userId];
    }

    return success;
}

NRLOG_AGENT_VERBOSE(@"Successfully set userId to nil");
return YES;
}
if (!(validAttribute && validValue)) {
NRLOG_AGENT_VERBOSE(@"Failed to create attribute named %@", name);
return NO;
Expand Down
Loading