Feature/feature toggle (#48)

* feature: FeatureToogle
Funksjonalitet for bruk av feature toggles i Salesforce

Author: torhakon

README.md

@@ -4,10 +4,26 @@ Monorepo for NAVs Salesforce Platform core. Maintained by Team Platforce.
 
 [Platforce Documentation](https://navikt.github.io/platforce-doc/)
 
+## Pakker
+
+For å se avhengigheter mellom pakkene se [sfdx-project.json](sfdx-project.json)
+
+- [platform-datamodel](src/platform-data-model/feature-flag-custom-metadata) - datamodell
+
+### Frameworks
+
+- [feature-toggle](src/frameworks/feature-toggle/README.md) rammeverk for feaure toggling i salesforce
+
+### Platform Utility
+
+- [custom-metadata-dao](src/platform-utility/custom-metadata-dao) - Abstraksjon av custom metadata
+
 ## Komme i gang
 
 Hvordan bygge, teste og kjøre koden viss aktuelt.
 
+For detaljer ang. utvikling eller bruk av en pakke, se pakke beskrivelsen.
+
 ---
 
 ### Henvendelser

sfdx-project.json

@@ -1,6 +1,7 @@
 {
   "sfdcLoginUrl": "https://login.salesforce.com",
-  "sourceApiVersion": "62.0",
+  "sourceApiVersion": "63.0",
+
   "packageDirectories": [
     {
       "path": "src-temp",
@@ -9,19 +10,33 @@
     {
       "path": "src/platform-data-model",
       "package": "platform-data-model",
-      "versionNumber": "0.1.0.NEXT"
+      "versionNumber": "0.1.0.NEXT",
+      "definitionFile": "config/scratch-org-def.json"
     },
     {
       "path": "src/platform-admin",
       "package": "platform-admin",
-      "versionNumber": "0.0.0.NEXT"
+      "versionNumber": "0.0.0.NEXT",
+      "definitionFile": "config/scratch-org-def.json"
     },
     {
       "versionNumber": "0.1.0.NEXT",
       "path": "src/platform-utility/custom-metadata-dao",
       "default": false,
       "package": "custom-metadata-dao",
-      "versionDescription": "Custom Metadata Data Access Object class used to get access to Custom Metadata objects, and at the same time make it easier to test the various paths the code can take based on the values in the Custom Metadata."
+      "definitionFile": "config/scratch-org-def.json"
+    },
+    {
+      "versionNumber": "0.1.0.NEXT",
+      "path": "src/frameworks/feature-toggle",
+      "package": "feature-toggle",
+      "definitionFile": "config/scratch-org-def.json",
+      "dependencies": [
+        {
+          "package": "platform-data-model",
+          "versionNumber": "0.1.0.LATEST"
+        }
+      ]
     },
     {
       "versionNumber": "0.1.0.NEXT",
@@ -33,6 +48,7 @@
   ],
   "packageAliases": {
     "platform-data-model": "0HoKB00000000010AA",
-    "custom-metadata-dao": "0HoKB000000000B0AQ"
+    "custom-metadata-dao": "0HoKB000000000B0AQ",
+    "feature-toggle": "0HoKB000000000V0AQ"
   }
 }

src/frameworks/feature-toggle/README.md

@@ -0,0 +1,84 @@
+# feature-toggle
+
+Denne pakken inneholder et rammeverk for feature toggling som kan brukes som det er eller extendes.
+
+Datamodellen ligger i pakken [platform-data-model](src/platform-data-model/README.md)
+
+|      |     |
+| ---- | --- |
+| Apex | ✅  |
+| LWC  | ❌  |
+| Flow | ✅  |
+
+## Hvordan ta i bruk
+
+Avhengig av behov så kan man enten bruke `FeatureToggleBase` direkte eller extende den for å se om en feature er aktiv eller ikke.
+Denne kan brukes på to nivåer, individuell eller generell.
+
+Feature toggle customMetadata innslag og customPermissions legges i de pakkene hvor de brukes.
+
+**Generell:**
+Det man ønsker å enkelt kunne skru en feature på eller av. Opprett en custom metadata feature toggle og aktiver/deaktiver den ved å benytte `Is_Enabled__c` flagget.
+I koden sjekker man på `isFeatureEnabled(<developername til gitt feature>)`. Dette vil da gjelde for all logikk som kjører koden.
+
+**Individuell:**
+Her kan man velge å bruke enten `customPermission` eller en kombinasjon av `Feature_Flag__mdt` og `customPermission`.
+
+Ved bruk av bare `customPermission` oppretter man en custom permission og legger den til et Permission Set som tildeles den eller de som trenger tilgangen.
+
+Ved bruk av en kompinasjon så opprettes det et custom permission som tildeles via Permission Set slik som over. I tillegg opprettes det et Feature_Flag**mdt record hvor customPermission api navnet legges til i `Required_Custom_Permission**c`. `Is_Enabled\_\_c` flagget benyttes som vanlig til å toggle featuren av og på.
+
+**Eksempel på direkte bruk:**
+
+```java
+public with sharing MyClass {
+    public MyClass() {
+        ...
+    }
+
+    public Decimal getDiscount() {
+        if(new FeatureToggleBase().isFeatureEnabled('improved-discount-calculation')) {
+            return getDiscountBeta();
+        }
+        ...
+        return discount
+    }
+
+    private Decimal getDiscountBeta() {
+        ...
+        return discount;
+    }
+
+    ...
+}
+```
+
+**Eksempel hvor man extender FeatureToggleBase:**
+
+```java
+public with sharing MyClass extends FeatureToggleBase {
+    public MyClass() {
+        ...
+    }
+
+    public Decimal getDiscount() {
+        if(isFeatureEnabled('improved-discount-calculation')) {
+            return getDiscountBeta();
+        }
+        ...
+        return discount
+    }
+
+    private Decimal getDiscountBeta() {
+        ...
+        return discount;
+    }
+
+    ...
+}
+```
+
+## Avhengigheter
+
+- [platform-datamodel](src/platform-data-model/feature-flag-custom-metadata) - datamodell
+- [custom-metadata-dao](src/platform-utility/custom-metadata-dao) - Abstraksjon av custom metadata