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

Add methods to add new context on Message #490

Closed
wants to merge 4 commits into from
Closed

Add methods to add new context on Message #490

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5722dfe
Add methods to add new context on Message
edsonjab Aug 14, 2024
a79799c
Merge branch 'master' into feature/add_new_context
nd4p90x Sep 25, 2024
39cb820
Merge branch 'master' into feature/add_new_context
edsonjab Oct 23, 2024
78e7749
Merge branch 'master' into feature/add_new_context
nd4p90x Oct 23, 2024
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
29 changes: 29 additions & 0 deletions analytics/src/main/java/com/segment/analytics/Analytics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;
Expand Down Expand Up @@ -45,6 +47,7 @@ public class Analytics {
private final List<MessageTransformer> messageTransformers;
private final List<MessageInterceptor> messageInterceptors;
private final Log log;
private Map<String, Object> externalContext;

Analytics(
AnalyticsClient client,
Expand All @@ -55,6 +58,7 @@ public class Analytics {
this.messageTransformers = messageTransformers;
this.messageInterceptors = messageInterceptors;
this.log = log;
this.externalContext = null;
Copy link

Choose a reason for hiding this comment

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

context needs to be added in a MessageTransformer as it needs to be added when the message is being built. If we are in a server side app dropping segment tracking events, it would need to have picked up the context for that individual request which is traditionally ThreadLocalContext. Its not on the Analytics object itself.

}

/**
Expand Down Expand Up @@ -114,7 +118,11 @@ private Message buildMessage(MessageBuilder builder) {
return null;
}
}

Map<String, Object> newContext = this.existExternalContext(builder.build());
builder.context(newContext);
Message message = builder.build();

for (MessageInterceptor messageInterceptor : messageInterceptors) {
message = messageInterceptor.intercept(message);
if (message == null) {
Expand All @@ -125,6 +133,27 @@ private Message buildMessage(MessageBuilder builder) {
return message;
}

private void addExternalContext(String contextKey, Object contextValue) {
this.externalContext = new HashMap<>();
Copy link

Choose a reason for hiding this comment

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

this is a private method - and I can't see aanything calling it? Also it replaces the external context every time so it would only ever have 1 key?

this.externalContext.put(contextKey, contextValue);
}

private Map<String, Object> existExternalContext(Message message) {

// Retrieve the existing context if it exists
Map<String, ?> existingContext = message.context();
if (existingContext == null) {
existingContext = new HashMap<>();
}

// Augment the existing context with new context
Map<String, Object> newContext = new HashMap<>(existingContext);
if (this.externalContext != null) {
newContext.putAll(this.externalContext);
}
return newContext;
}

/** Fluent API for creating {@link Analytics} instances. */
public static class Builder {
private static final String DEFAULT_ENDPOINT = "https://api.segment.io";
Expand Down
Loading