Add simple version stamp to flex to use in persisted state, so redux …

…in localStorage is invalidated on upgrade / rollback

.github/actions/main-action/action.yml

@@ -84,6 +84,15 @@ runs:
           TWILIO_ACCOUNT_SID: ${{ inputs.account-sid }}
         with:
           filename: ./plugin-hrm-form/public/appConfig.js
+            # Get latest tag for this version
+      - name: Get latest tag
+        uses: oprypin/find-latest-tag@v1
+        with:
+          repository: ${{ inputs.repository }}
+          # releases-only: false
+          regex: "^v\d+\.\d+\.\d+.*$"
+        id: latest_matching_tag
+        continue-on-error: true
       - name: Create secret.js
         run: |
           touch ./src/private/secret.js
@@ -95,6 +104,8 @@ runs:
           export const datadogAccessToken = '$DATADOG_ACCESS_TOKEN';
           export const datadogApplicationID = '$DATADOG_APP_ID';
           export const fullStoryId = '$FULLSTORY_ID';
+          export const versionId = '${{ steps.latest_matching_tag.outputs.tag }}'
+          export const githubSha = '{{ github.sha }}';
           EOT
         working-directory: ./plugin-hrm-form
         shell: bash

plugin-hrm-form/src/hrmConfig.ts

@@ -20,6 +20,7 @@ import { buildFormDefinitionsBaseUrlGetter, inferConfiguredFormDefinitionsBaseUr
 import { ConfigFlags, FeatureFlags } from './types/types';
 import type { RootState } from './states';
 import { namespace } from './states/storeNamespaces';
+import { githubSha, versionId } from './private/secret';
 
 const featureFlagEnvVarPrefix = 'REACT_APP_FF_';
 type ContactSaveFrequency = 'onTabChange' | 'onFinalSaveAndTransfer';
@@ -167,3 +168,5 @@ export const getAseloFeatureFlags = (): FeatureFlags => cachedConfig.featureFlag
 export const getDefinitionVersions = () => {
   return (Flex.Manager.getInstance().store.getState() as RootState)[namespace].configuration;
 };
+
+export const pluginVersionDescription = `${versionId}${githubSha ? `#${githubSha}` : ''}`;

plugin-hrm-form/src/states/persistState.ts

@@ -19,7 +19,7 @@ import _ from 'lodash';
 
 import { RootState } from '.';
 import { namespace } from './storeNamespaces';
-import { getAseloFeatureFlags } from '../hrmConfig';
+import { getAseloFeatureFlags, pluginVersionDescription } from '../hrmConfig';
 
 // Quick & dirty module to persist redux state to localStorage via subscriptions since we can't add middleware like redux-persist to do it for us
 export const activateStatePersistence = () => {
@@ -29,17 +29,21 @@ export const activateStatePersistence = () => {
       const {
         [namespace]: { configuration, ...persistableState },
       } = Manager.getInstance().store.getState() as RootState;
-      localStorage.setItem('redux-state/plugin-hrm-form', JSON.stringify(persistableState));
+      localStorage.setItem(
+        'redux-state/plugin-hrm-form',
+        JSON.stringify({ [pluginVersionDescription]: persistableState }),
+      );
     }, 1000);
     Manager.getInstance().store.subscribe(debouncedWrite);
   }
 };
 
 export const readPersistedState = (): RootState[typeof namespace] | null => {
   if (getAseloFeatureFlags().enable_local_redux_persist) {
-    const persistedState = localStorage.getItem('redux-state/plugin-hrm-form');
-    if (persistedState) {
-      return JSON.parse(persistedState);
+    const persistedStateJson = localStorage.getItem('redux-state/plugin-hrm-form');
+    if (persistedStateJson) {
+      const persistedState = JSON.parse(persistedStateJson);
+      return persistedState[pluginVersionDescription];
     }
   }
   return undefined;