Merge pull request #409 from SalesforceLabs/Beryllium-UAT-phase-2

Beryllium uat phase 2

Author: VinceFINET

build/package.readme

@@ -1,43 +1,11 @@
-============================================================
-Push source in a scratch org
-============================================================
-sfdx force:org:create --definitionfile config/project-scratch-def.json --setalias MyScratchOrg --targetdevhubusername vfinet.devhub@salesforce.com --wait 10
-sfdx force:source:push --targetusername MyScratchOrg --forceoverwrite   
-profileName=$(sfdx force:data:soql:query --targetusername MyScratchOrg --query "SELECT Name FROM Profile WHERE UserLicense.MasterLabel = 'Salesforce' AND Name LIKE '%Admin%' AND PermissionsViewAllData = true LIMIT 1" --resultformat=csv | tail -1)      
-sfdx force:user:create --setalias uatuser --definitionfile config/user-uat-def.json "profileName=${profileName}" permsets=OrgCheck_Users --targetusername MyScratchOrg
-
-uatUserId=$(sfdx force:data:soql:query --query "SELECT Id FROM User WHERE Profile.Name = '${profileName}' AND IsActive = true" --resultformat=csv --targetusername MyScratchOrg | tail -1)
-
-## Set French Local/Language
-sfdx force:data:record:update --sobjectid "${uatUserId}" --sobjecttype User --values "LocaleSidKey=fr LanguageLocaleKey=fr" --targetusername MyScratchOrg
-
-## Set English Local/Language
-sfdx force:data:record:update --sobjectid "${uatUserId}" --sobjecttype User --values "LocaleSidKey=en_US LanguageLocaleKey=en_US" --targetusername MyScratchOrg
-
-## Set Japanese Local/Language
-sfdx force:data:record:update --sobjectid "${uatUserId}" --sobjecttype User --values "LocaleSidKey=ja LanguageLocaleKey=ja" --targetusername MyScratchOrg
-
-## In case of persistente language, please close all browsers before launching the next command.
-sfdx force:org:open --targetusername uatuser 
-
-
-sfdx force:user:list --targetusername MyScratchOrg 
-sfdx force:org:open --targetusername MyScratchOrg 
-
-sfdx force:org:delete --targetusername MyScratchOrg 
-
-
 ============================================================
 List of usefull commands for packaging
 ============================================================
-##sfdx force:package:version:list --targetdevhubusername vfinet.devhub@salesforce.com 
-##sfdx force:package:version:create --targetdevhubusername vfinet.devhub@salesforce.com --package OrgCheck --definitionfile config/project-scratch-def.json --installationkeybypass --codecoverage --wait 10
-##sfdx force:package:version:promote --targetdevhubusername vfinet.devhub@salesforce.com --package OrgCheck@2.4.1-0
-
-sfdx package version list --target-hub-org vfinet.devhub@salesforce.com 
-sfdx package version create --target-hub-org vfinet.devhub@salesforce.com --package OrgCheck --definition-file config/project-scratch-def.json --installation-key-bypass --code-coverage --wait 10
-sfdx package version promote --target-hub-org vfinet.devhub@salesforce.com --package OrgCheck@2.5.0-0
 
+sf package version list --target-dev-hub vfinet.devhub@salesforce.com 
+sf package version create --target-dev-hub vfinet.devhub@salesforce.com --package OrgCheck --definition-file config/project-scratch-def.json --installation-key-bypass --code-coverage --wait 10
+sf package version promote --target-dev-hub vfinet.devhub@salesforce.com --package OrgCheck@2.5.0-0
+sf package version delete --target-dev-hub vfinet.devhub@salesforce.com --package OrgCheck@2.5.0-0
 
 
 ============================================================

force-app/main/default/lwc/orgcheckApp/api/core/orgcheck-api-data-dependencies.js

@@ -4,9 +4,9 @@ export class OrgCheckDataDependencies {
     referenced;
     referencedByTypes;
 
-    constructor(data, whatid) {
+    constructor(data, whatId) {
 
-        this.using = data.filter(e => e.id === whatid).map(n => { 
+        this.using = data.filter(e => e.id === whatId).map(n => { 
             return { 
                 id: n.refId, 
                 name: n.refName, 
@@ -15,7 +15,7 @@ export class OrgCheckDataDependencies {
             }; 
         });
         this.referencedByTypes = {};
-        this.referenced = data.filter(e => e.refId === whatid).map(n => {
+        this.referenced = data.filter(e => e.refId === whatId).map(n => {
             if (this.referencedByTypes[n.type] === undefined) {
                 this.referencedByTypes[n.type] = 1;
             } else {

force-app/main/default/lwc/orgcheckApp/api/core/orgcheck-api-data.js

@@ -1,58 +1,17 @@
-import { OrgCheckDataDependencies } from './orgcheck-api-data-dependencies';
-
+/**
+ * This class represents a set of information around a unique instance of a specific artefact (like User, Profile, UserRole, ...) 
+ * Such class are created by a "data factory" (see OrgCheckDataFactory) which also computes its "score" based on specific best practices rules. 
+ */
 export class OrgCheckData {
-
-    badScore;
+    score;
     badFields;
+    badReasonIds;
     dependencies;
-
-    initData(setup) { 
-
-        // Copy properties from setup to object
-        // NB: Please note that ONLY the properties explicitely set in
-        //     the class will be copied from setup to object
-        Object.keys(this).forEach((p) => { this[p] = setup[p]; });
-
-        // If need scoring...
-        if (setup.isScoreNeeded === true) {
-            this.badFields = [];
-        }
-
-        // If dependencies are needed...
-        if (setup.isDependenciesNeeded === true) {
-            if (!setup.allDependencies) {
-                throw new TypeError(`Missing 'allDependencies' information in setup as this data does need dependencies.`);
-            }
-            if (!setup.dependenciesFor) {
-                throw new TypeError(`Missing 'dependenciesFor' information in setup as this data does need dependencies.`);
-            }
-            const id = this[setup.dependenciesFor];
-            if (!id) {
-                throw new TypeError(`The property "${setup.dependenciesFor}" is undefined for this data. Impossible to calculate dependencies.`);
-            }
-            this.dependencies = new OrgCheckDataDependencies(setup.allDependencies, id);
-        }
-
-        Object.seal(this);
-    }
-
-    setBadField(field) {
-        if (!this.badFields) {
-            throw new TypeError('Should not call setBadField() as this data does not need score.');
-        }
-        if (!field) {
-            throw new TypeError('Field is a mandatory when calling setBadField()');
-        }
-        if (this.badFields.includes(field) === false) {
-            this.badFields.push(field);
-            this.badScore = this.badFields.length;
-        }
-    }
-
-    isItReferenced() {
-        if (!this.dependencies) {
-            throw new TypeError('Should not call isItReferenced() as this data does not need dependencies.');
-        }
-        return this.dependencies.referenced.length > 0;
-    }
-}
+}
+
+/**
+ * This class represents a sub set of information included in a, instance of OrgCheckData, but it does not need score and dependencies automation at its level. 
+ * The best example of this is a FlowDefinition and its active FlowVersion. The flowDefinition will be a OrgCheckData, including a reference to a OrgCheckInnerData 
+ * to represent the FlowVersion. All score information and dependencies will be reported to the flowDef instance. 
+ */
+export class OrgCheckInnerData {}

force-app/main/default/lwc/orgcheckApp/api/core/orgcheck-api-datacache.js

@@ -8,10 +8,14 @@ const generateLogicalKey = (key) => {
     return key.startsWith(CACHE_PREFIX) ? key.substring(CACHE_PREFIX.length) : key;
 }
 
+const NB_MILLISEC_IN_ONE_DAY = 1000*60*60*24;
+
 const getEntryFromCache = (key) => {
     const entryFromStorage = localStorage.getItem(key);
     if (!entryFromStorage) return null
-    return JSON.parse(entryFromStorage);
+    const entry = JSON.parse(entryFromStorage);
+    if (Date.now() - entry.created > NB_MILLISEC_IN_ONE_DAY) return null;
+    return entry;
 }
 
 const isItOneOfOurKeys = (key) => {
@@ -20,14 +24,13 @@ const isItOneOfOurKeys = (key) => {
 
 export class OrgCheckDataCacheManager {
     has(key) {
-        return localStorage.getItem(generatePhysicalKey(key)) !== null;
+        return getEntryFromCache(generatePhysicalKey(key)) !== null;
     }
     get(key) {
         const entry = getEntryFromCache(generatePhysicalKey(key));
         if (!entry) return null;
         if (entry.type === 'map') return new Map(entry.data);
         return entry.data;
-
     }
     set(key, value) {
         try {
@@ -40,7 +43,7 @@ export class OrgCheckDataCacheManager {
                         { 
                             type: 'map', 
                             length: value.size,
-                            data: Array.from(value.entries().filter(([k, v]) => k.endsWith('Ref') === false)),
+                            data: Array.from(value.entries().filter(([k]) => k.endsWith('Ref') === false)),
                             created: Date.now()
                         }
                     )