RI-6508: add custom logic for handling keytar encryption issue

Author: KrumTy

src/webviews/src/utils/comparisons/compareConsents.ts

@@ -1,6 +1,18 @@
 import { has } from 'lodash'
 import { isVersionHigher } from 'uiSrc/utils/comparisons/compareVersions'
 
+// There was an issue that caused users to have encryption setting populated as false by default
+// This is a custom check to address that issue for existing users. The commit should be reverted after some time.
+const shouldTriggerKeytarEncryptionSpec = (spec: any, applied: any): boolean => true
+  // local settings are from v1.0.6
+  && applied?.version === '1.0.6'
+  // has locally stored false value
+  && applied.encryption === false
+  // keytar is enabled
+  && spec?.encryption?.disabled === false
+  // target current version of config
+  && spec.encryption.since === '1.0.2'
+
 // returns true if has different consents
 export const isDifferentConsentsExists = (specs: any, applied: any) =>
   !!compareConsents(specs, applied).length
@@ -19,6 +31,7 @@ export const compareConsents = (
         (isReturnAllNonRequired && !specs[consent]?.required)
         || applied === null
         || !has(applied, consent)
+        || (consent === 'encryption' && shouldTriggerKeytarEncryptionSpec(specs, applied))
         || isVersionHigher(specs[consent]?.since, applied.version),
     )
     .map((consent) => ({ ...specs[consent], agreementName: consent }))

src/webviews/src/utils/comparisons/tests/compareConsents.spec.ts

@@ -60,3 +60,62 @@ describe('isDifferentConsentsExists', () => {
     expect(isDifferentConsentsExists(spec.agreements, agreements3)).toBeTruthy()
   })
 })
+
+describe('compareConsents: custom keytar encryption conditions', () => {
+  const agreementsSpec = {
+    eula: spec.agreements.eula,
+    encryption: {
+      defaultValue: true,
+      displayInSetting: false,
+      required: false,
+      editable: true,
+      disabled: false,
+      category: 'privacy',
+      since: '1.0.2',
+      title: 'Encryption',
+      label: 'Encrypt sensitive information',
+      description:
+        'Select to encrypt sensitive information using system keychain. Otherwise, this information is stored locally in plain text, which may incur security risk.',
+    },
+  }
+
+  const agreements1 = {
+    eula: true,
+    encryption: false,
+    version: '1.0.6',
+  }
+
+  const agreements2 = {
+    eula: true,
+    encryption: false,
+    version: '1.0.7',
+  }
+
+  const agreements3 = {
+    eula: true,
+    encryption: true,
+    version: '1.0.6',
+  }
+
+  const agreements4 = {
+    eula: true,
+    encryption: true,
+    version: '1.0.7',
+  }
+
+  it('should prompt users with encryption set to false and v1.0.6 to set encryption again', () => {
+    expect(compareConsents(agreementsSpec, agreements1)).toHaveLength(1)
+  })
+
+  it('should NOT prompt users with encryption set to false and v1.0.7 to set encryption again', () => {
+    expect(compareConsents(agreementsSpec, agreements2)).toHaveLength(0)
+  })
+
+  it('should NOT prompt users with encryption set to true and v1.0.6 to set encryption again', () => {
+    expect(compareConsents(agreementsSpec, agreements3)).toHaveLength(0)
+  })
+
+  it('should NOT prompt users with encryption set to true and v1.0.7 to set encryption again', () => {
+    expect(compareConsents(agreementsSpec, agreements4)).toHaveLength(0)
+  })
+})