Merge pull request #38 from optimizely/project-js-clear-ls

Project JS localStorage Example

Author: Asa Schachar

Project-JS/README.md

@@ -0,0 +1,3 @@
+# Project JS
+
+Project Javascript is an advanced configuration setting that provides a code field for JS to be executed before the Optimizely snippet's core logic begins executing. To learn more view our [documentation](https://help.optimizely.com/Set_Up_Optimizely/Project_Settings%3A_jQuery_and_Project_JavaScript_settings_in_Optimizely_X#Project_JavaScript). This repo contains a collection of code samples and reference implementations for extending Optimizely functionality via Project JS. 

Project-JS/clear-localstorage/README.md

@@ -0,0 +1,6 @@
+# clear_localstorage.js
+
+Optimizely uses persistent visitor-level [cookies](https://help.optimizely.com/Set_Up_Optimizely/Cookies_and_localStorage_in_the_Optimizely_snippet#Cookies) and [localStorage](https://help.optimizely.com/Set_Up_Optimizely/Cookies_and_localStorage_in_the_Optimizely_snippet#localStorage) to uniquely identify visitors, track their actions, and deliver consistent experiences across page loads. 
+
+If in the course of your Optimizely usage you would like to clear stored values associated with Optimizely from your users' localStorage, for storage size management, compliance or other reasons, this code sample provides an example function that can be called form Project JS or invoked as a window-level function to do so. Specifically the function will iterate through all localStorage keys and clear any key:value pairs with the substring 'optimizely' in the keyname.
+ 

Project-JS/clear-localstorage/clear_localstorage.js

@@ -0,0 +1,14 @@
+/*Exposing a window-level function to clear localStorage values who's key includes the substring 'optimizely' 
+*/
+window.clearOptlyLocalStorage = function(){
+    for (var key in window.localStorage){
+        if(key.indexOf('optimizely') !== -1){
+            window.localStorage.removeItem(key)
+        }
+    }
+}
+//The function can be called from Optimizely Project JS based on an available boolean flag, such as a cookie's value 
+var should_clear = window.customer_storage_flag_boolean;
+if(should_clear){
+    clearOptimizelyLocalStorage();
+}