feat: 🎸 Add maxAge option to saved items (expiration)

Author: Ondřej Baše

Diff for: packages/plugin-session-storage/src/__tests__/indexSpec.js

@@ -38,10 +38,13 @@ describe('Session Storage plugin', () => {
     if ('sessionStorage' in widget.$dependencies) {
       widget.$dependencies.sessionStorage = sessionStorage;
     }
+
+    jest.useFakeTimers();
   });
 
   afterEach(() => {
     sessionStorage.clear();
+    jest.useRealTimers();
   });
 
   it('should create empty widget', async () => {
@@ -128,7 +131,7 @@ describe('Session Storage plugin', () => {
     expect(session.get('item5')).toStrictEqual(arr);
   });
 
-  it('should should have (not) an item', () => {
+  it('should have (not) an item', () => {
     expect(session.get('item1')).toBeUndefined();
 
     session.set('item1', 1);
@@ -186,4 +189,35 @@ describe('Session Storage plugin', () => {
     expect(returnValue).toBeFalsy();
     expect(console.error).toHaveBeenCalledTimes(1);
   });
+
+  it('should delete an item after maxAge', () => {
+    const maxAge = 60;
+    const value = 1;
+    session.set('item1', value, { maxAge });
+
+    jest.advanceTimersByTime(maxAge * 1000);
+    expect(session.get('item1')).toBe(value);
+
+    jest.advanceTimersByTime(1);
+    expect(session.get('item1')).toBeUndefined();
+  });
+
+  it.each([-1, 0])('should not not set an item when maxAge is %p', (maxAge) => {
+    expect(session.get('item1')).toBeUndefined();
+
+    session.set('item1', 1, { maxAge });
+
+    expect(session.get('item1')).toBeUndefined();
+  });
+
+  it.each([-1, 0])('should delete an item when maxAge is %p', (maxAge) => {
+    const value = 1;
+    session.set('item1', value);
+
+    expect(session.get('item1')).toBe(value);
+
+    session.set('item1', value, { maxAge });
+
+    expect(session.get('item1')).toBeUndefined();
+  });
 });

Diff for: packages/plugin-session-storage/src/index.js

@@ -53,6 +53,12 @@ function sessionStorageAPI() {
         try {
           const item = JSON.parse(sessionStorage.getItem(keyPrefix + key));
 
+          if (shouldDeleteItem(item)) {
+            widget.sessionStorage.delete(key);
+
+            return undefined;
+          }
+
           return item && typeof item === 'object' ? item.value : undefined;
         } catch (error) {
           throw new Error(
@@ -68,10 +74,13 @@ function sessionStorageAPI() {
        * @param {object} widget A widget object.
        * @param {string} key A key
        * @param {*} value A value
+       * @param {object} [options] An options object.
+       * @param {number} [options.maxAge] Number of seconds after which the
+       *        value should be removed.
        * @return {boolean} It's `true` when the operation was successful,
        *         otherwise `false`.
        */
-      set(widget, key, value) {
+      set(widget, key, value, options) {
         const {
           $dependencies: { sessionStorage },
           $in: {
@@ -83,14 +92,23 @@ function sessionStorageAPI() {
           return false;
         }
 
+        const item = {
+          created: Date.now(),
+          value,
+        };
+
+        if (Number.isFinite(Number.parseInt(options?.maxAge))) {
+          item.maxAge = Number.parseInt(options.maxAge);
+        }
+
+        if (shouldDeleteItem(item)) {
+          widget.sessionStorage.delete(key);
+
+          return true;
+        }
+
         try {
-          sessionStorage.setItem(
-            keyPrefix + key,
-            JSON.stringify({
-              created: Date.now(),
-              value,
-            }),
-          );
+          sessionStorage.setItem(keyPrefix + key, JSON.stringify(item));
         } catch (error) {
           console.error(error);
 
@@ -123,3 +141,18 @@ function sessionStorageAPI() {
 function getNativeSessionStorage() {
   return typeof window === 'undefined' ? undefined : window.sessionStorage;
 }
+
+function shouldDeleteItem(item) {
+  if (!item || !('maxAge' in item) || !item.created) {
+    return false;
+  }
+
+  if (item.maxAge <= 0) {
+    return true;
+  }
+
+  const now = Date.now();
+  const age = now - item.created;
+
+  return age > item.maxAge * 1000;
+}