feat: New one-click Home Server, now in Labs. Launch your own self-hosted server instance with just 1 click from the Preferences window. (#2341)

packages/snjs/lib/Application/Application.ts

@@ -70,7 +70,12 @@ import {
   RevisionManager,
   ApiServiceEvent,
 } from '@standardnotes/services'
-import { BackupServiceInterface, FilesClientInterface } from '@standardnotes/files'
+import {
+  BackupServiceInterface,
+  DirectoryManagerInterface,
+  FileBackupsDevice,
+  FilesClientInterface,
+} from '@standardnotes/files'
 import { ComputePrivateUsername } from '@standardnotes/encryption'
 import { useBoolean } from '@standardnotes/utils'
 import {
@@ -133,14 +138,14 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
    */
   private deprecatedHttpService!: InternalServices.DeprecatedHttpService
   private declare httpService: HttpServiceInterface
-  private payloadManager!: InternalServices.PayloadManager
+  public payloadManager!: InternalServices.PayloadManager
   public protocolService!: EncryptionService
   private diskStorageService!: InternalServices.DiskStorageService
   private inMemoryStore!: ExternalServices.KeyValueStoreInterface<string>
   /**
    * @deprecated will be fully replaced by @standardnotes/api services
    */
-  private apiService!: InternalServices.SNApiService
+  public apiService!: InternalServices.SNApiService
   private declare userApiService: UserApiServiceInterface
   private declare userServer: UserServerInterface
   private declare userRequestServer: UserRequestServerInterface
@@ -152,7 +157,7 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
 
   private sessionManager!: InternalServices.SNSessionManager
   private syncService!: InternalServices.SNSyncService
-  private challengeService!: InternalServices.ChallengeService
+  public challengeService!: InternalServices.ChallengeService
   public singletonManager!: InternalServices.SNSingletonManager
   public componentManagerService!: InternalServices.SNComponentManager
   public protectionService!: InternalServices.SNProtectionService
@@ -184,6 +189,7 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
   private declare authenticatorManager: AuthenticatorClientInterface
   private declare authManager: AuthClientInterface
   private declare revisionManager: RevisionClientInterface
+  private homeServerService?: ExternalServices.HomeServerService
 
   private declare _signInWithRecoveryCodes: SignInWithRecoveryCodes
   private declare _getRecoveryCodes: GetRecoveryCodes
@@ -200,7 +206,7 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
 
   private eventHandlers: ApplicationObserver[] = []
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  private services: ExternalServices.ServiceInterface<any, any>[] = []
+  private services: ExternalServices.ApplicationServiceInterface<any, any>[] = []
   private streamRemovers: ObserverRemover[] = []
   private serviceObservers: ObserverRemover[] = []
   private managedSubscribers: ObserverRemover[] = []
@@ -381,6 +387,10 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
     return this.challengeService
   }
 
+  get homeServer(): ExternalServices.HomeServerServiceInterface | undefined {
+    return this.homeServerService
+  }
+
   public get vaults(): ExternalServices.VaultServiceInterface {
     return this.vaultService
   }
@@ -712,7 +722,7 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
     await this.apiService.setHost(host)
   }
 
-  public getHost(): string | undefined {
+  public getHost(): string {
     return this.apiService.getHost()
   }
 
@@ -1221,6 +1231,14 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
     return this.apiService.isThirdPartyHostUsed()
   }
 
+  async isUsingHomeServer(): Promise<boolean> {
+    if (!this.homeServerService) {
+      return false
+    }
+
+    return this.getHost() === (await this.homeServerService.getHomeServerUrl())
+  }
+
   private constructServices() {
     this.createMappers()
     this.createPayloadManager()
@@ -1264,6 +1282,7 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
     this.createStatusService()
     if (isDesktopDevice(this.deviceInterface)) {
       this.createFilesBackupService(this.deviceInterface)
+      this.createHomeServerService(this.deviceInterface)
     }
     this.createMigrationService()
     this.createFileService()
@@ -1328,6 +1347,7 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
     ;(this.authenticatorManager as unknown) = undefined
     ;(this.authManager as unknown) = undefined
     ;(this.revisionManager as unknown) = undefined
+    ;(this.homeServerService as unknown) = undefined
     ;(this._signInWithRecoveryCodes as unknown) = undefined
     ;(this._getRecoveryCodes as unknown) = undefined
     ;(this._addAuthenticator as unknown) = undefined
@@ -1689,6 +1709,12 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
     this.services.push(this.diskStorageService)
   }
 
+  private createHomeServerService(device: ExternalServices.DesktopDeviceInterface) {
+    this.homeServerService = new ExternalServices.HomeServerService(device, this.internalEventBus)
+
+    this.services.push(this.homeServerService)
+  }
+
   private createInMemoryStorageManager() {
     this.inMemoryStore = new ExternalServices.InMemoryStore()
   }
@@ -1928,13 +1954,14 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
       this.itemManager,
       this.apiService,
       this.protocolService,
-      device,
+      device as FileBackupsDevice,
       this.statusService,
       this.options.crypto,
       this.storage,
       this.sessions,
       this.payloadManager,
       this.historyManager,
+      device as DirectoryManagerInterface,
       this.internalEventBus,
     )
     this.services.push(this.filesBackupService)

packages/snjs/lib/Logging.ts

@@ -5,11 +5,13 @@ export const isDev = true
 export enum LoggingDomain {
   DatabaseLoad,
   Sync,
+  AccountMigration,
 }
 
 const LoggingStatus: Record<LoggingDomain, boolean> = {
   [LoggingDomain.DatabaseLoad]: false,
   [LoggingDomain.Sync]: false,
+  [LoggingDomain.AccountMigration]: true,
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages/snjs/lib/Services/Challenge/ChallengeService.ts

@@ -254,6 +254,7 @@ export class ChallengeService extends AbstractService implements ChallengeServic
 
   private deleteChallengeOperation(operation: ChallengeOperation) {
     const challenge = operation.challenge
+    challenge.customHandler = undefined
     operation.deinit()
 
     delete this.challengeOperations[challenge.id]

packages/snjs/lib/Services/Settings/SettingsList.ts

@@ -1,7 +1,6 @@
 import { SettingData } from '@standardnotes/responses'
 import {
   MuteSignInEmailsOption,
-  MuteFailedCloudBackupsEmailsOption,
   MuteFailedBackupsEmailsOption,
   EmailBackupFrequency,
   ListedAuthorSecretsData,
@@ -15,7 +14,6 @@ type SettingType =
   | ListedAuthorSecretsData
   | LogSessionUserAgentOption
   | MuteFailedBackupsEmailsOption
-  | MuteFailedCloudBackupsEmailsOption
   | MuteSignInEmailsOption
   | MuteMarketingEmailsOption
 

packages/snjs/lib/Services/Storage/DiskStorageService.ts

@@ -75,7 +75,9 @@ export class DiskStorageService extends Services.AbstractService implements Serv
     this.persistencePolicy = persistencePolicy
 
     if (this.persistencePolicy === Services.StoragePersistencePolicies.Ephemeral) {
-      await this.deviceInterface.removeAllRawStorageValues()
+      await this.deviceInterface.clearNamespacedKeychainValue(this.identifier)
+      await this.deviceInterface.removeAllDatabaseEntries(this.identifier)
+      await this.deviceInterface.removeRawStorageValuesForIdentifier(this.identifier)
       await this.clearAllPayloads()
     }
   }

packages/snjs/lib/Services/Sync/SyncClientInterface.ts

@@ -1,16 +1,14 @@
 import { SyncOpStatus } from './SyncOpStatus'
-import { SyncOptions } from '@standardnotes/services'
+import { AbstractService, SyncEvent, SyncOptions } from '@standardnotes/services'
 
-export interface SyncClientInterface {
+export interface SyncClientInterface extends AbstractService<SyncEvent> {
   setLaunchPriorityUuids(launchPriorityUuids: string[]): void
-
   sync(options?: Partial<SyncOptions>): Promise<unknown>
-
   isOutOfSync(): boolean
-
   getLastSyncDate(): Date | undefined
-
   getSyncStatus(): SyncOpStatus
+  lockSyncing(): void
+  unlockSyncing(): void
 
   completedOnlineDownloadFirstSync: boolean
 }

packages/snjs/mocha/lib/web_device_interface.js

@@ -172,6 +172,11 @@ export default class WebDeviceInterface {
     localStorage.removeItem(KEYCHAIN_STORAGE_KEY)
   }
 
+  async removeRawStorageValuesForIdentifier(identifier) {
+    await this.removeRawStorageValue(namespacedKey(identifier, RawStorageKey.SnjsVersion))
+    await this.removeRawStorageValue(namespacedKey(identifier, RawStorageKey.StorageObject))
+  }
+
   performSoftReset() {}
 
   performHardReset() {}

packages/snjs/mocha/storage.test.js

@@ -89,7 +89,10 @@ describe('storage manager', function () {
     const key = 'foo'
     const value = 'bar'
     await this.application.diskStorageService.setValueAndAwaitPersist(key, value)
-    expect(Object.keys(localStorage).length).to.equal(0)
+
+    const expectedKeys = ['keychain']
+    expect(Object.keys(localStorage).length).to.equal(expectedKeys.length)
+
     const retrievedValue = await this.application.diskStorageService.getValue(key)
     expect(retrievedValue).to.equal(value)
   })