✨ [RUM-5001] Enforce localStorage usage telemetry (#238)

* add new property for session storage fallback selection * sample update * update array to string enum * remove 'cookie-fallback-to-local-storage' for now * restore allow_fallback_to_local_storage * rename sessionStorage to sessionPersistence sessionStorage is already a DOM/JS concept, so let's use something else --------- Co-authored-by: Benoît Zugmeyer <benoit.zugmeyer@datadoghq.com>
DataDog · Jan 3, 2025 · adcc82d · adcc82d
1 parent a02c784
commit adcc82d
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 4 deletions.
diff --git a/lib/cjs/generated/telemetry.d.ts b/lib/cjs/generated/telemetry.d.ts
@@ -168,9 +168,13 @@ export declare type TelemetryConfigurationEvent = CommonTelemetryProperties & {
              */
             use_secure_session_cookie?: boolean;
             /**
-             * Whether it is allowed to use LocalStorage when cookies are not available
+             * Whether it is allowed to use LocalStorage when cookies are not available (deprecated in favor of session_persistence)
              */
             allow_fallback_to_local_storage?: boolean;
+            /**
+             * Configure the storage strategy for persisting sessions
+             */
+            session_persistence?: 'local-storage' | 'cookie';
             /**
              * Whether contexts are stored in local storage
              */

diff --git a/lib/esm/generated/telemetry.d.ts b/lib/esm/generated/telemetry.d.ts
@@ -168,9 +168,13 @@ export declare type TelemetryConfigurationEvent = CommonTelemetryProperties & {
              */
             use_secure_session_cookie?: boolean;
             /**
-             * Whether it is allowed to use LocalStorage when cookies are not available
+             * Whether it is allowed to use LocalStorage when cookies are not available (deprecated in favor of session_persistence)
              */
             allow_fallback_to_local_storage?: boolean;
+            /**
+             * Configure the storage strategy for persisting sessions
+             */
+            session_persistence?: 'local-storage' | 'cookie';
             /**
              * Whether contexts are stored in local storage
              */

diff --git a/samples/telemetry-events/configuration.json b/samples/telemetry-events/configuration.json
@@ -41,7 +41,7 @@
       "track_long_task": true,
       "use_cross_site_session_cookie": false,
       "use_secure_session_cookie": true,
-      "allow_fallback_to_local_storage": true,
+      "session_persistence": "cookie",
       "action_name_attribute": "foo",
       "use_allowed_tracing_origins": false,
       "default_privacy_level": "mask",

diff --git a/schemas/telemetry/configuration-schema.json b/schemas/telemetry/configuration-schema.json
@@ -136,7 +136,12 @@
                 },
                 "allow_fallback_to_local_storage": {
                   "type": "boolean",
-                  "description": "Whether it is allowed to use LocalStorage when cookies are not available"
+                  "description": "Whether it is allowed to use LocalStorage when cookies are not available (deprecated in favor of session_persistence)"
+                },
+                "session_persistence": {
+                  "type": "string",
+                  "enum": ["local-storage", "cookie"],
+                  "description": "Configure the storage strategy for persisting sessions"
                 },
                 "store_contexts_across_pages": {
                   "type": "boolean",