Use SplunkRumNative.getNativeSessionId when present (#263)

signalfx · Oct 1, 2021 · d12ddba · d12ddba
1 parent f7fc9bd
commit d12ddba
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 0 deletions.
diff --git a/integration-tests/tests/native/native.ejs b/integration-tests/tests/native/native.ejs
@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+       <meta charset="UTF-8">
+       <title>Native</title>
+       <script>
+               window.SplunkRumNative = {
+                       getNativeSessionId: function() {
+                               return '12341234123412341234123412341234';
+                       }
+               };
+       </script>
+
+       <%- renderAgent({debug: true}) %>
+
+       <style>
+               #container {
+                       height: 200px;
+                       width: 400px;
+               }
+       </style>
+</head>
+<body>
+       <h1>Native</h1>
+</body>
+</html>
diff --git a/integration-tests/tests/native/native.spec.js b/integration-tests/tests/native/native.spec.js
@@ -0,0 +1,29 @@
+/*
+Copyright 2020 Splunk Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+module.exports = {
+  'native session id integration': async function(browser) {
+    const url = browser.globals.getUrl('/native/native.ejs');
+    await browser.url(url);
+
+    const anySpan = await browser.globals.findSpan(span => span.tags['splunk.rumSessionId'] !== undefined);
+
+    await browser.assert.ok(anySpan);
+
+    await browser.assert.strictEqual(anySpan.tags['splunk.rumSessionId'], '12341234123412341234123412341234');
+    await browser.globals.assertNoErrorSpans();
+  }
+};
diff --git a/src/session.ts b/src/session.ts
@@ -31,6 +31,9 @@ import { findCookieValue, generateId, isIframe } from './utils';
     Future work can add more fields though note that the fact that the value doesn't change
     once created makes this very robust when used in multiple tabs/windows - tabs don't compete/
     race to do anything but set the max-age.
+
+    Finally, if SplunkRumNative exists, use its session ID exclusively and don't bother
+    with setting cookies, checking for inactivity, etc.
 */
 
 
@@ -127,11 +130,23 @@ export function updateSessionStatus(): void {
   recentActivity = false;
 }
 
+function hasNativeSessionId(): boolean {
+  return window['SplunkRumNative'] && window['SplunkRumNative'].getNativeSessionId;
+}
+
 export function initSessionTracking(
   instanceId: SessionIdType,
   newEventTarget: InternalEventTarget,
   domain?: string,
 ): { deinit: () => void; } {
+  if (hasNativeSessionId()) {
+    // short-circuit and bail out - don't create cookie, watch for inactivity, or anything
+    return {
+      deinit: () => {
+        rumSessionId = undefined;
+      }
+    };
+  }
   if (domain) {
     cookieDomain = domain;
   }
@@ -160,5 +175,8 @@ export function initSessionTracking(
 }
 
 export function getRumSessionId(): SessionIdType {
+  if (hasNativeSessionId()) {
+    return window['SplunkRumNative'].getNativeSessionId();
+  }
   return rumSessionId;
 }