WIP: Autosave drafts

Closes #4419

Author: paw-hub

packages/tutanota-utils/lib/DateUtils.ts

@@ -3,9 +3,42 @@
  * As functions here do not use Luxon it cannot be used for calculating things in different time zones, they
  * are dependent on the system time zone.
  */
-export const DAY_IN_MILLIS = 1000 * 60 * 60 * 24
 
-export const YEAR_IN_MILLIS = DAY_IN_MILLIS * 365
+/**
+ * Convert the number of seconds to milliseconds.
+ * @param seconds seconds to convert
+ */
+export function secondsToMillis(seconds: number): number {
+	return seconds * 1000
+}
+
+/**
+ * Convert the number of minutes to milliseconds.
+ * @param minutes minutes to convert
+ */
+export function minutesToMillis(minutes: number): number {
+	return secondsToMillis(minutes * 60)
+}
+
+/**
+ * Convert the number of minutes to milliseconds.
+ * @param hours minutes to convert
+ */
+export function hoursToMillis(hours: number): number {
+	return minutesToMillis(hours * 60)
+}
+
+/**
+ * Convert the number of minutes to milliseconds.
+ * @param days minutes to convert
+ */
+export function daysToMillis(days: number): number {
+	return hoursToMillis(days * 24)
+}
+
+export const DAY_IN_MILLIS = daysToMillis(1)
+
+export const YEAR_IN_MILLIS = daysToMillis(365)
 
 /**
  * dates from before 1970 have negative timestamps and are currently considered edge cases
@@ -135,7 +168,3 @@ export function isValidDate(date: Date): boolean {
 export function millisToDays(millis: number): number {
 	return millis / DAY_IN_MILLIS
 }
-
-export function daysToMillis(days: number): number {
-	return days * DAY_IN_MILLIS
-}

packages/tutanota-utils/lib/index.ts

@@ -82,6 +82,9 @@ export {
 	isValidDate,
 	millisToDays,
 	daysToMillis,
+	secondsToMillis,
+	minutesToMillis,
+	hoursToMillis,
 	TIMESTAMP_ZERO_YEAR,
 } from "./DateUtils.js"
 export {

src/calendar-app/calendarLocator.ts

@@ -336,6 +336,7 @@ class CalendarLocator implements CommonLocator {
 				recipientsModel,
 				dateProvider,
 				mailboxProperties,
+				this.configFacade,
 				async (mail: Mail) => {
 					return false
 				},

src/common/api/main/SyncTracker.ts

@@ -1,5 +1,5 @@
 import stream from "mithril/stream"
-import { identity } from "@tutao/tutanota-utils"
+import { defer, DeferredObject, identity } from "@tutao/tutanota-utils"
 import Stream from "mithril/stream"
 
 /**
@@ -9,6 +9,7 @@ import Stream from "mithril/stream"
  */
 export class SyncTracker {
 	private readonly _isSyncDone: Stream<boolean>
+	private readonly syncDone: DeferredObject<unknown> = defer()
 
 	constructor() {
 		this._isSyncDone = stream(false)
@@ -21,5 +22,10 @@ export class SyncTracker {
 	markSyncAsDone(): void {
 		console.log("Initial sync done")
 		this._isSyncDone(true)
+		this.syncDone.resolve(null)
+	}
+
+	async waitSync(): Promise<void> {
+		await this.syncDone.promise
 	}
 }

src/common/api/worker/facades/lazy/ConfigurationDatabase.ts

@@ -6,6 +6,7 @@ import {
 	Aes128Key,
 	Aes256Key,
 	aes256RandomKey,
+	aesDecrypt,
 	aesEncrypt,
 	AesKey,
 	decryptKey,
@@ -14,14 +15,15 @@ import {
 	unauthenticatedAesDecrypt,
 } from "@tutao/tutanota-crypto"
 import { UserFacade } from "../UserFacade.js"
-import { EncryptedDbKeyBaseMetaData, EncryptedIndexerMetaData, Metadata, ObjectStoreName } from "../../search/IndexTables.js"
+import { EncryptedDbKeyBaseMetaData, EncryptedIndexerMetaData, LocalDraftDataOS, Metadata, ObjectStoreName } from "../../search/IndexTables.js"
 import { DbError } from "../../../common/error/DbError.js"
 import { checkKeyVersionConstraints, KeyLoaderFacade } from "../KeyLoaderFacade.js"
-import type { QueuedBatch } from "../../EventQueue.js"
 import { _encryptKeyWithVersionedKey, VersionedKey } from "../../crypto/CryptoWrapper.js"
 import { EntityUpdateData, isUpdateForTypeRef } from "../../../common/utils/EntityUpdateUtils"
+import * as cborg from "cborg"
+import { customTypeDecoders, customTypeEncoders } from "../../offline/OfflineStorage"
 
-const VERSION: number = 2
+const VERSION: number = 3
 const DB_KEY_PREFIX: string = "ConfigStorage"
 const ExternalImageListOS: ObjectStoreName = "ExternalAllowListOS"
 export const ConfigurationMetaDataOS: ObjectStoreName = "MetaDataOS"
@@ -43,6 +45,32 @@ export async function decryptLegacyItem(encryptedAddress: Uint8Array, key: Aes25
 	return utf8Uint8ArrayToString(unauthenticatedAesDecrypt(key, concat(iv, encryptedAddress)))
 }
 
+const LOCAL_DRAFT_VERSION: number = 1
+export type LocalDraftAddress = {
+	name: string
+	address: string
+}
+export type LocalAutosavedDraftData = {
+	version: number
+
+	saveTime: number
+	mailId: IdTuple | null
+	mailGroupId: Id
+
+	subject: string
+	body: string
+	bodyOnServer: string | null
+	confidential: boolean
+
+	senderAddress: string
+	to: LocalDraftAddress[]
+	cc: LocalDraftAddress[]
+	bcc: LocalDraftAddress[]
+}
+
+// We only support one draft maximum, destroying any previous draft if one is currently stored.
+const LOCAL_DRAFT_KEY = "current"
+
 /**
  * A local configuration database that can be used as an alternative to DeviceConfig:
  * Ideal for cases where the configuration values should be stored encrypted,
@@ -65,6 +93,78 @@ export class ConfigurationDatabase {
 		})
 	}
 
+	/**
+	 * Save the draft data to the database, overwriting one if there is one there.
+	 * @param draftUpdateDataWithoutVersion data to write
+	 */
+	async setAutosavedDraftData(draftUpdateDataWithoutVersion: Omit<LocalAutosavedDraftData, "version">): Promise<void> {
+		const { db, metaData } = await this.db.getAsync()
+		if (!db.indexingSupported) return
+
+		const draftUpdateData: LocalAutosavedDraftData = Object.assign({}, draftUpdateDataWithoutVersion, { version: LOCAL_DRAFT_VERSION })
+
+		try {
+			const transaction = await db.createTransaction(false, [LocalDraftDataOS])
+			const encoded = cborg.encode(draftUpdateData, { typeEncoders: customTypeEncoders })
+			const encryptedData = aesEncrypt(metaData.key, encoded, metaData.iv)
+			await transaction.put(LocalDraftDataOS, LOCAL_DRAFT_KEY, encryptedData)
+		} catch (e) {
+			if (e instanceof DbError) {
+				console.error("failed to save draft:", e.message)
+				return
+			}
+			throw e
+		}
+	}
+
+	/**
+	 * @return the locally stored draft data, if any, or null
+	 */
+	async getAutosavedDraftData(): Promise<LocalAutosavedDraftData | null> {
+		const { db, metaData } = await this.db.getAsync()
+		if (!db.indexingSupported) {
+			return null
+		}
+
+		try {
+			const transaction = await db.createTransaction(false, [LocalDraftDataOS])
+			const data = await transaction.get<Uint8Array>(LocalDraftDataOS, LOCAL_DRAFT_KEY)
+			if (data == null) {
+				return null
+			}
+
+			const decryptedData = aesDecrypt(metaData.key, data)
+			const decoded = cborg.decode(decryptedData, { tags: customTypeDecoders })
+
+			return decoded as LocalAutosavedDraftData
+		} catch (e) {
+			if (e instanceof DbError) {
+				console.error("failed to load draft:", e.message)
+				return null
+			}
+			throw e
+		}
+	}
+
+	/**
+	 * Deletes any locally saved draft data, if any
+	 */
+	async clearAutosavedDraftData(): Promise<void> {
+		const { db } = await this.db.getAsync()
+		if (!db.indexingSupported) return
+
+		try {
+			const transaction = await db.createTransaction(false, [LocalDraftDataOS])
+			await transaction.delete(LocalDraftDataOS, LOCAL_DRAFT_KEY)
+		} catch (e) {
+			if (e instanceof DbError) {
+				console.error("failed to load draft:", e.message)
+				return
+			}
+			throw e
+		}
+	}
+
 	async addExternalImageRule(address: string, rule: ExternalImageRule): Promise<void> {
 		const { db, metaData } = await this.db.getAsync()
 		if (!db.indexingSupported) return
@@ -101,6 +201,7 @@ export class ConfigurationDatabase {
 				db.createObjectStore(ExternalImageListOS, {
 					keyPath: "address",
 				})
+				db.createObjectStore(LocalDraftDataOS)
 			}
 			const metaData =
 				(await loadEncryptionMetadata(dbFacade, id, keyLoaderFacade, ConfigurationMetaDataOS)) ||
@@ -118,7 +219,12 @@ export class ConfigurationDatabase {
 					await deleteTransaction.delete(ExternalImageListOS, entry.key)
 				}
 			}
+
+			if (event.oldVersion < 3) {
+				db.createObjectStore(LocalDraftDataOS)
+			}
 		})
+
 		const metaData =
 			(await loadEncryptionMetadata(db, id, keyLoaderFacade, ConfigurationMetaDataOS)) ||
 			(await initializeDb(db, id, keyLoaderFacade, ConfigurationMetaDataOS))

src/common/api/worker/search/IndexTables.ts

@@ -10,6 +10,7 @@ export const MetaDataOS: ObjectStoreName = "MetaData"
 export const GroupDataOS: ObjectStoreName = "GroupMetaData"
 export const SearchTermSuggestionsOS: ObjectStoreName = "SearchTermSuggestions"
 export const SearchIndexWordsIndex: IndexName = "SearchIndexWords"
+export const LocalDraftDataOS: ObjectStoreName = "LocalDraftData"
 
 export const Metadata = Object.freeze({
 	userEncDbKey: "userEncDbKey",