Adding retrack destination function exammple

Author: awiejacha-ww

Readme.md

@@ -35,7 +35,8 @@ this repo as the set of examples.
 - [Slack](./destinations/slack) - Adds a Gravatar icon to events with an email and sends messages to Slack
 - [Zendesk](./destinations/zendesk) - Create new Zendesk tickets triggered by events that you send
 - [Datadog](./destinations/datadog) - Sends a metric to datadog with high level message/event type as tags
-- [Optimizely](./destinations/optimizely) - Sends conversion metrix to optimizely.
+- [Optimizely](./destinations/optimizely) - Sends conversion metrix to optimizely
+- [Retrack](./destinations/retrack) - Intercepts track event, updates user identity and enriches said event
 
 ## Development
 

destinations/retrack/Readme.md

@@ -0,0 +1,11 @@
+# Re-track Custom Destination Function
+
+Example of destination function which:
+* Intercepts track event from Segment source attached to it,
+* modifies userId and posts [alias](https://segment.com/docs/connections/spec/alias/) request, so Segment will know anticipated identity,
+* enriches event properties and posts [track](https://segment.com/docs/connections/spec/track/) request, so Segment will know enriched event,
+* all requests are being forwarded to another [Segment HTTP Tracking API Source](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/), given `apiKey` from function settings.
+
+## Settings
+
+- `apiKey` {String} ([write key of Segment HTTP Tracking API Source](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/))

destinations/retrack/handler.js

@@ -0,0 +1,93 @@
+/**
+ * @typedef {Object} SegmentTrackEvent
+ * @see {@link https://segment.com/docs/connections/spec/track/}  for full track event spec
+ * @see {@link https://segment.com/docs/connections/spec/common/} for full common fields spec
+ * @property {String} event             Track event name
+ * @property {String} messageId         Original API message identifier
+ * @property {String} userId            Tracked user id that we want to modify and re-track
+ * @property {String} timestamp         Timestamp of event in ISO 8601 format
+ * @property {Object} properties        Track event arbitrary properties, we want to add 3 own
+ */
+
+/**
+ * @typedef {Object} FunctionSettings
+ * @property {String} apiKey            Write key of source we forward new user identifier and enriched track event to
+ */
+
+/**
+ * Call Segment V1 API, using HTTP API Segment Source by api (write) key
+ * @see {@link https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/} for source doc
+ * @internal
+ * @param {String} apiKey
+ * @param {String<'alias'|'track'>} route
+ * @param {Object} body
+ * @return {Promise<void>}
+ */
+async function callSegmentAPI(apiKey, route, body) {
+  let response;
+
+  try {
+    response = await fetch(`https://api.segment.io/v1/${route}`, {
+      method: 'POST',
+      headers: {
+        Authorization: `Basic ${btoa(`${apiKey}:`)}`,
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(body),
+    });
+  } catch (error) {
+    // Retry on connection error
+    throw new RetryError(error.message);
+  }
+
+  if (response.status >= 500 || response.status === 429) {
+    // Retry on 5xx (server errors) and 429s (rate limits)
+    throw new RetryError(`Failed with ${response.status}`);
+  }
+}
+
+/**
+ * Handle track event
+ * @param {SegmentTrackEvent} event
+ * @param {FunctionSettings} settings
+ * @return {Promise<void>}
+ */
+async function onTrack(event, settings) {
+  const { apiKey } = settings;
+
+  if (!apiKey) {
+    // Settings not configured properly
+    throw new ValidationError('Forward source write key is required');
+  }
+
+  // Build anticipated user id, as MD5 hash of previous user id
+  const anticipatedId = crypto.createHash('md5').update(event.userId).digest('hex');
+
+  // Update user identity from track event with anticipated one
+  await callSegmentAPI(apiKey, 'alias', {
+    previousId: event.userId,
+    userId: anticipatedId,
+    timestamp: event.timestamp,
+  });
+
+  // Split previous event user id into 3 slugs that will enrich new event
+  const [firstUserIdSlug, secondUserIdSlug, thirdUserIdSlug] = event.userId.split('-');
+
+  // Clone previous event into new, with anticipated user id and enriched properties
+  const newEvent = {
+    ...event,
+    userId: anticipatedId,
+    properties: {
+      ...event.properties,
+      firstUserIdSlug,
+      secondUserIdSlug,
+      thirdUserIdSlug,
+    },
+  };
+
+  // Delete previous event's messageId from clone, so it can be reposted
+  delete newEvent.messageId;
+
+  // Repost event with enriched properties for the new anticipated identity
+  await callSegmentAPI(apiKey, 'track', newEvent);
+}