From 4724b08c65c48b6b7232885de205a44b080313b1 Mon Sep 17 00:00:00 2001
From: Aman Harwara <amanharwara@protonmail.com>
Date: Thu, 5 Oct 2023 11:07:01 +0000
Subject: [PATCH] feat: Added "Private vaults" as a Labs feature. Can be
 enabled from Preferences > General > Labs (#2562)

---
 .../src/Domain/Feature/NativeFeatureIdentifier.ts   |  3 ++-
 .../src/Domain/Lists/ExperimentalFeatures.ts        | 13 ++++++++++++-
 .../src/Domain/Permission/PermissionName.ts         |  1 +
 .../Components/FileContextMenu/FileMenuOptions.tsx  |  2 +-
 .../Components/Footer/VaultSelectionButton.tsx      |  2 +-
 .../Components/NotesOptions/NotesOptions.tsx        |  2 +-
 .../Components/PasswordWizard/PasswordWizard.tsx    |  2 +-
 .../Controller/PreferencesSessionController.ts      |  2 +-
 .../Components/Preferences/Panes/Vaults/Vaults.tsx  | 11 +++++++----
 .../Preferences/Panes/Vaults/Vaults/VaultItem.tsx   |  4 +++-
 .../src/javascripts/Components/Tags/Navigation.tsx  |  2 +-
 .../javascripts/Components/Tags/TagContextMenu.tsx  |  2 +-
 .../Components/Vaults/AddToVaultMenuOption.tsx      |  2 +-
 .../javascripts/Controllers/FeaturesController.ts   |  7 ++++++-
 .../Controllers/LinkingController.spec.ts           |  3 ++-
 .../javascripts/Controllers/LinkingController.tsx   |  2 +-
 packages/web/src/javascripts/FeatureTrunk.ts        |  3 ++-
 .../web/src/javascripts/Hooks/useItemVaultInfo.ts   |  2 +-
 18 files changed, 45 insertions(+), 20 deletions(-)

diff --git a/packages/features/src/Domain/Feature/NativeFeatureIdentifier.ts b/packages/features/src/Domain/Feature/NativeFeatureIdentifier.ts
index b28385901..b9af61e40 100644
--- a/packages/features/src/Domain/Feature/NativeFeatureIdentifier.ts
+++ b/packages/features/src/Domain/Feature/NativeFeatureIdentifier.ts
@@ -41,6 +41,7 @@ export class NativeFeatureIdentifier extends ValueObject<NativeFeatureIdentifier
 
     Clipper: 'org.standardnotes.clipper',
 
+    Vaults: 'org.standardnotes.vaults',
     SharedVaults: 'org.standardnotes.shared-vaults',
 
     DeprecatedMarkdownVisualEditor: 'org.standardnotes.markdown-visual-editor',
@@ -74,4 +75,4 @@ export class NativeFeatureIdentifier extends ValueObject<NativeFeatureIdentifier
 /**
  * Identifier for standalone filesafe instance offered as legacy installable via extensions-server
  */
-export const ExperimentalFeatures = []
+export const ExperimentalFeatures = [NativeFeatureIdentifier.TYPES.Vaults]
diff --git a/packages/features/src/Domain/Lists/ExperimentalFeatures.ts b/packages/features/src/Domain/Lists/ExperimentalFeatures.ts
index 549c970aa..ba523524c 100644
--- a/packages/features/src/Domain/Lists/ExperimentalFeatures.ts
+++ b/packages/features/src/Domain/Lists/ExperimentalFeatures.ts
@@ -1,5 +1,16 @@
+import { RoleName } from '@standardnotes/domain-core'
 import { AnyFeatureDescription } from '../Feature/AnyFeatureDescription'
+import { NativeFeatureIdentifier } from '../Feature/NativeFeatureIdentifier'
+import { PermissionName } from '../Permission/PermissionName'
 
 export function experimentalFeatures(): AnyFeatureDescription[] {
-  return []
+  return [
+    {
+      name: 'Private vaults',
+      description: 'Private vaults allow you to store notes, files and tags into separate, encrypted vaults.',
+      availableInRoles: [RoleName.NAMES.CoreUser, RoleName.NAMES.PlusUser, RoleName.NAMES.ProUser],
+      identifier: NativeFeatureIdentifier.TYPES.Vaults,
+      permission_name: PermissionName.Vaults,
+    },
+  ]
 }
diff --git a/packages/features/src/Domain/Permission/PermissionName.ts b/packages/features/src/Domain/Permission/PermissionName.ts
index 34e71a5ed..b8674f05d 100644
--- a/packages/features/src/Domain/Permission/PermissionName.ts
+++ b/packages/features/src/Domain/Permission/PermissionName.ts
@@ -38,5 +38,6 @@ export enum PermissionName {
   SubscriptionSharing = 'server:subscription-sharing',
   SuperEditor = 'editor:super-editor',
   Clipper = 'app:clipper',
+  Vaults = 'app:vaults',
   SharedVaults = 'server:shared-vaults',
 }
diff --git a/packages/web/src/javascripts/Components/FileContextMenu/FileMenuOptions.tsx b/packages/web/src/javascripts/Components/FileContextMenu/FileMenuOptions.tsx
index 6b97dbc53..edabe6efb 100644
--- a/packages/web/src/javascripts/Components/FileContextMenu/FileMenuOptions.tsx
+++ b/packages/web/src/javascripts/Components/FileContextMenu/FileMenuOptions.tsx
@@ -102,7 +102,7 @@ const FileMenuOptions: FunctionComponent<Props> = ({
           ) : null}
         </>
       )}
-      {application.featuresController.isEntitledToVaults() && (
+      {application.featuresController.isVaultsEnabled() && (
         <AddToVaultMenuOption
           iconClassName={iconClass}
           items={selectedFiles}
diff --git a/packages/web/src/javascripts/Components/Footer/VaultSelectionButton.tsx b/packages/web/src/javascripts/Components/Footer/VaultSelectionButton.tsx
index 1d84c2a45..37e435af2 100644
--- a/packages/web/src/javascripts/Components/Footer/VaultSelectionButton.tsx
+++ b/packages/web/src/javascripts/Components/Footer/VaultSelectionButton.tsx
@@ -16,7 +16,7 @@ const VaultSelectionButton = ({ isMobileNavigation = false }: { isMobileNavigati
   const [isOpen, setIsOpen] = useState(false)
   const toggleMenu = () => setIsOpen(!isOpen)
 
-  if (!application.featuresController.isEntitledToVaults()) {
+  if (!application.featuresController.isVaultsEnabled()) {
     return null
   }
 
diff --git a/packages/web/src/javascripts/Components/NotesOptions/NotesOptions.tsx b/packages/web/src/javascripts/Components/NotesOptions/NotesOptions.tsx
index e21c188df..0bd87b003 100644
--- a/packages/web/src/javascripts/Components/NotesOptions/NotesOptions.tsx
+++ b/packages/web/src/javascripts/Components/NotesOptions/NotesOptions.tsx
@@ -286,7 +286,7 @@ const NotesOptions = ({ notes, closeMenu }: NotesOptionsProps) => {
       )}
       <HorizontalSeparator classes="my-2" />
 
-      {application.featuresController.isEntitledToVaults() && (
+      {application.featuresController.isVaultsEnabled() && (
         <AddToVaultMenuOption iconClassName={iconClass} items={notes} disabled={!hasAdminPermissionForAllSharedNotes} />
       )}
 
diff --git a/packages/web/src/javascripts/Components/PasswordWizard/PasswordWizard.tsx b/packages/web/src/javascripts/Components/PasswordWizard/PasswordWizard.tsx
index 7c84ed1bc..6e0e8328c 100644
--- a/packages/web/src/javascripts/Components/PasswordWizard/PasswordWizard.tsx
+++ b/packages/web/src/javascripts/Components/PasswordWizard/PasswordWizard.tsx
@@ -49,7 +49,7 @@ class PasswordWizard extends AbstractComponent<Props, State> {
       continueTitle: DEFAULT_CONTINUE_TITLE,
     }
 
-    if (props.application.featuresController.isEntitledToVaults()) {
+    if (props.application.featuresController.isVaultsEnabled()) {
       this.state = {
         ...baseState,
         lockContinue: true,
diff --git a/packages/web/src/javascripts/Components/Preferences/Controller/PreferencesSessionController.ts b/packages/web/src/javascripts/Components/Preferences/Controller/PreferencesSessionController.ts
index 3b0f43fc7..722b8502b 100644
--- a/packages/web/src/javascripts/Components/Preferences/Controller/PreferencesSessionController.ts
+++ b/packages/web/src/javascripts/Components/Preferences/Controller/PreferencesSessionController.ts
@@ -26,7 +26,7 @@ export class PreferencesSessionController {
       ? PREFERENCES_MENU_ITEMS.slice()
       : READY_PREFERENCES_MENU_ITEMS.slice()
 
-    if (application.featuresController.isEntitledToVaults()) {
+    if (application.featuresController.isVaultsEnabled()) {
       menuItems.push({ id: 'vaults', label: 'Vaults', icon: 'safe-square', order: 5 })
     }
 
diff --git a/packages/web/src/javascripts/Components/Preferences/Panes/Vaults/Vaults.tsx b/packages/web/src/javascripts/Components/Preferences/Panes/Vaults/Vaults.tsx
index 8d29353a5..a6fd7798c 100644
--- a/packages/web/src/javascripts/Components/Preferences/Panes/Vaults/Vaults.tsx
+++ b/packages/web/src/javascripts/Components/Preferences/Panes/Vaults/Vaults.tsx
@@ -31,6 +31,7 @@ const Vaults = observer(() => {
   const application = useApplication()
 
   const hasAccount = application.hasAccount()
+  const isSharedVaultsEnabled = application.featuresController.isEntitledToSharedVaults()
 
   const [vaults, setVaults] = useState<VaultListingInterface[]>([])
   const [canCreateMoreVaults, setCanCreateMoreVaults] = useState(true)
@@ -163,7 +164,7 @@ const Vaults = observer(() => {
           </PreferencesSegment>
         </PreferencesGroup>
       )}
-      {hasAccount && (
+      {hasAccount && isSharedVaultsEnabled && (
         <PreferencesGroup>
           <PreferencesSegment>
             <Title>Contacts</Title>
@@ -180,7 +181,7 @@ const Vaults = observer(() => {
           </PreferencesSegment>
         </PreferencesGroup>
       )}
-      {hasAccount && (
+      {hasAccount && isSharedVaultsEnabled && (
         <PreferencesGroup>
           <PreferencesSegment>
             <Title>CollaborationID</Title>
@@ -235,13 +236,15 @@ const Vaults = observer(() => {
           {canCreateMoreVaults ? (
             <div className="mt-2.5 flex gap-3">
               <Button label="Create Vault" onClick={createNewVault} />
-              {hasAccount && <Button label="Create Shared Vault" onClick={createNewSharedVault} />}
+              {hasAccount && isSharedVaultsEnabled && (
+                <Button label="Create Shared Vault" onClick={createNewSharedVault} />
+              )}
             </div>
           ) : (
             <div className="mt-3.5">
               <NoProSubscription
                 application={application}
-                text={<span>Please upgrade in order to increase your shared vault limit.</span>}
+                text={<span>Please upgrade in order to increase your vault limit.</span>}
               />
             </div>
           )}
diff --git a/packages/web/src/javascripts/Components/Preferences/Panes/Vaults/Vaults/VaultItem.tsx b/packages/web/src/javascripts/Components/Preferences/Panes/Vaults/Vaults/VaultItem.tsx
index 4e751c456..505ad941b 100644
--- a/packages/web/src/javascripts/Components/Preferences/Panes/Vaults/Vaults/VaultItem.tsx
+++ b/packages/web/src/javascripts/Components/Preferences/Panes/Vaults/Vaults/VaultItem.tsx
@@ -17,6 +17,8 @@ type Props = {
 const VaultItem = ({ vault }: Props) => {
   const application = useApplication()
 
+  const canEnableCollaboration = application.hasAccount() && application.featuresController.isEntitledToSharedVaults()
+
   const [isInviteModalOpen, setIsAddContactModalOpen] = useState(false)
   const closeInviteModal = () => setIsAddContactModalOpen(false)
 
@@ -128,7 +130,7 @@ const VaultItem = ({ vault }: Props) => {
             {isCurrentUserAdmin ? (
               vault.isSharedVaultListing() ? (
                 <Button colorStyle="info" label="Invite Contacts" onClick={openInviteModal} />
-              ) : application.hasAccount() ? (
+              ) : canEnableCollaboration ? (
                 <Button colorStyle="info" label="Enable Collaboration" onClick={convertToSharedVault} />
               ) : null
             ) : null}
diff --git a/packages/web/src/javascripts/Components/Tags/Navigation.tsx b/packages/web/src/javascripts/Components/Tags/Navigation.tsx
index 4819f06bd..c6a6c9fe8 100644
--- a/packages/web/src/javascripts/Components/Tags/Navigation.tsx
+++ b/packages/web/src/javascripts/Components/Tags/Navigation.tsx
@@ -124,7 +124,7 @@ const Navigation = forwardRef<HTMLDivElement, Props>(({ application, className,
         )}
         <PreferencesButton openPreferences={() => application.preferencesController.openPreferences()} />
         <QuickSettingsButton application={application} isMobileNavigation />
-        {application.featuresController.isEntitledToVaults() && <VaultSelectionButton isMobileNavigation />}
+        {application.featuresController.isVaultsEnabled() && <VaultSelectionButton isMobileNavigation />}
       </div>
       {children}
     </div>
diff --git a/packages/web/src/javascripts/Components/Tags/TagContextMenu.tsx b/packages/web/src/javascripts/Components/Tags/TagContextMenu.tsx
index b045aacc7..d36d243fb 100644
--- a/packages/web/src/javascripts/Components/Tags/TagContextMenu.tsx
+++ b/packages/web/src/javascripts/Components/Tags/TagContextMenu.tsx
@@ -81,7 +81,7 @@ const TagContextMenu = ({ navigationController, isEntitledToFolders, selectedTag
           iconGridClassName="max-h-30"
         />
         <HorizontalSeparator classes="my-2" />
-        {application.featuresController.isEntitledToVaults() && (
+        {application.featuresController.isVaultsEnabled() && (
           <AddToVaultMenuOption iconClassName="mr-2 text-neutral" items={[selectedTag]} />
         )}
         <MenuItem className={'justify-between py-1.5'} onClick={onClickStar}>
diff --git a/packages/web/src/javascripts/Components/Vaults/AddToVaultMenuOption.tsx b/packages/web/src/javascripts/Components/Vaults/AddToVaultMenuOption.tsx
index 9cf19c9c8..7982f71aa 100644
--- a/packages/web/src/javascripts/Components/Vaults/AddToVaultMenuOption.tsx
+++ b/packages/web/src/javascripts/Components/Vaults/AddToVaultMenuOption.tsx
@@ -120,7 +120,7 @@ const AddToVaultMenuOption = ({
     setIsSubMenuOpen((isOpen) => !isOpen)
   }, [])
 
-  if (!application.featuresController.isEntitledToVaults()) {
+  if (!application.featuresController.isVaultsEnabled()) {
     return null
   }
 
diff --git a/packages/web/src/javascripts/Controllers/FeaturesController.ts b/packages/web/src/javascripts/Controllers/FeaturesController.ts
index 8b23759b8..2cd286f52 100644
--- a/packages/web/src/javascripts/Controllers/FeaturesController.ts
+++ b/packages/web/src/javascripts/Controllers/FeaturesController.ts
@@ -130,7 +130,12 @@ export class FeaturesController extends AbstractViewController implements Intern
     return status === FeatureStatus.Entitled
   }
 
-  isEntitledToVaults(): boolean {
+  isVaultsEnabled(): boolean {
+    const enabled = this.features.isExperimentalFeatureEnabled(NativeFeatureIdentifier.TYPES.Vaults)
+    return featureTrunkVaultsEnabled() || enabled
+  }
+
+  isEntitledToSharedVaults(): boolean {
     const status = this.features.getFeatureStatus(
       NativeFeatureIdentifier.create(NativeFeatureIdentifier.TYPES.SharedVaults).getValue(),
     )
diff --git a/packages/web/src/javascripts/Controllers/LinkingController.spec.ts b/packages/web/src/javascripts/Controllers/LinkingController.spec.ts
index b377c4c47..e63ef1cd9 100644
--- a/packages/web/src/javascripts/Controllers/LinkingController.spec.ts
+++ b/packages/web/src/javascripts/Controllers/LinkingController.spec.ts
@@ -71,7 +71,8 @@ describe('LinkingController', () => {
     application.getPreference = jest.fn()
     application.addSingleEventObserver = jest.fn()
     application.sync.sync = jest.fn()
-    application.featuresController.isEntitledToVaults = jest.fn().mockReturnValue(true)
+    application.featuresController.isVaultsEnabled = jest.fn().mockReturnValue(true)
+    application.featuresController.isEntitledToSharedVaults = jest.fn().mockReturnValue(true)
 
     Object.defineProperty(application, 'items', { value: {} as jest.Mocked<ItemManagerInterface> })
 
diff --git a/packages/web/src/javascripts/Controllers/LinkingController.tsx b/packages/web/src/javascripts/Controllers/LinkingController.tsx
index 43d067567..b51350b6a 100644
--- a/packages/web/src/javascripts/Controllers/LinkingController.tsx
+++ b/packages/web/src/javascripts/Controllers/LinkingController.tsx
@@ -208,7 +208,7 @@ export class LinkingController extends AbstractViewController implements Interna
     const linkNoteAndFile = async (note: SNNote, file: FileItem) => {
       const updatedFile = await this.mutator.associateFileWithNote(file, note)
 
-      if (this.featuresController.isEntitledToVaults()) {
+      if (this.featuresController.isVaultsEnabled()) {
         if (updatedFile) {
           const noteVault = this.vaults.getItemVault(note)
           const fileVault = this.vaults.getItemVault(updatedFile)
diff --git a/packages/web/src/javascripts/FeatureTrunk.ts b/packages/web/src/javascripts/FeatureTrunk.ts
index 515d29b86..77fc70a8c 100644
--- a/packages/web/src/javascripts/FeatureTrunk.ts
+++ b/packages/web/src/javascripts/FeatureTrunk.ts
@@ -9,7 +9,8 @@ export function featureTrunkEnabled(trunk: FeatureTrunkName): boolean {
 }
 
 export function featureTrunkVaultsEnabled(): boolean {
-  return InternalFeatureService.get().isFeatureEnabled(InternalFeature.Vaults)
+  // return InternalFeatureService.get().isFeatureEnabled(InternalFeature.Vaults)
+  return false
 }
 
 export function featureTrunkHomeServerEnabled(): boolean {
diff --git a/packages/web/src/javascripts/Hooks/useItemVaultInfo.ts b/packages/web/src/javascripts/Hooks/useItemVaultInfo.ts
index dd2839f34..e9a792e4e 100644
--- a/packages/web/src/javascripts/Hooks/useItemVaultInfo.ts
+++ b/packages/web/src/javascripts/Hooks/useItemVaultInfo.ts
@@ -23,7 +23,7 @@ export const useItemVaultInfo = (item: DecryptedItemInterface): ItemVaultInfo =>
   const [sharedByContact, setSharedByContact] = useState<TrustedContactInterface>()
 
   const updateInfo = useCallback(() => {
-    if (!application.featuresController.isEntitledToVaults()) {
+    if (!application.featuresController.isVaultsEnabled()) {
       return
     }