Add delayed autosave, closes #883

Author: CodeDoctorDE

app/lib/bloc/document_bloc.dart

@@ -1296,10 +1296,10 @@ class DocumentBloc extends ReplayBloc<DocumentEvent, DocumentState> {
     state.assetService?.dispose();
   }
 
-  Future<void> save() {
+  Future<void> save({AssetLocation? location, bool force = false}) {
     final current = state;
     if (current is! DocumentLoadSuccess) return Future.value();
-    return current.save();
+    return current.save(location: location, force: force);
   }
 
   bool isInBounds(Offset globalPosition) {

app/lib/bloc/document_state.dart

@@ -255,8 +255,16 @@ class DocumentLoadSuccess extends DocumentLoaded {
                           ?.hasDocumentCached(location.path) ??
                       false))));
 
-  Future<AssetLocation> save({AssetLocation? location, bool force = false}) =>
-      currentIndexCubit.save(this, location: location, force: force);
+  Future<AssetLocation> save({
+    AssetLocation? location,
+    bool force = false,
+    bool isAutosave = false,
+  }) => currentIndexCubit.save(
+    this,
+    location: location,
+    force: force,
+    isAutosave: isAutosave,
+  );
 
   ExternalStorage? getRemoteStorage() => currentIndexCubit.getRemoteStorage();
 

app/lib/cubits/current_index.dart

@@ -33,7 +33,7 @@ import '../view_painter.dart';
 
 part 'current_index.freezed.dart';
 
-enum SaveState { saved, saving, unsaved, absoluteRead }
+enum SaveState { saved, saving, unsaved, delay, absoluteRead }
 
 enum HideState { visible, keyboard, touch }
 
@@ -1514,18 +1514,31 @@ class CurrentIndexCubit extends Cubit<CurrentIndex> {
     DocumentState blocState, {
     AssetLocation? location,
     bool force = false,
+    bool isAutosave = false,
   }) async {
     if (!force && state.saved == SaveState.saved) {
       return state.location;
     }
     if (state.networkingService.isClient) {
       return AssetLocation.empty;
     }
+    if (state.saved == SaveState.delay && isAutosave) {
+      return state.location;
+    }
     final storage = getRemoteStorage();
     final fileSystem = blocState.fileSystem.buildDocumentSystem(storage);
     while (_currentlySaving) {
       await Future.delayed(const Duration(milliseconds: 100));
     }
+    final isDelayed = state.settingsCubit.state.delayedAutosave;
+    if (isDelayed && isAutosave && state.saved == SaveState.unsaved) {
+      final seconds = max(0, state.settingsCubit.state.autosaveDelaySeconds);
+      emit(state.copyWith(saved: SaveState.delay));
+      await Future.delayed(Duration(seconds: seconds));
+      if (state.saved != SaveState.delay) {
+        return state.location;
+      }
+    }
     _currentlySaving = true;
     emit(
       state.copyWith(
@@ -1639,7 +1652,7 @@ class CurrentIndexCubit extends Cubit<CurrentIndex> {
     }
     AssetLocation? path = current.location;
     if (current.hasAutosave()) {
-      path = await current.save(location: path);
+      path = await current.save(location: path, isAutosave: true);
     }
   }
 

app/lib/cubits/settings.dart

@@ -276,6 +276,8 @@ class SRGBConverter extends JsonConverter<SRGBColor, int> {
   int toJson(SRGBColor object) => object.value;
 }
 
+enum SaveMethod { manual, autosave, delayedAutosave }
+
 @freezed
 sealed class ButterflySettings with _$ButterflySettings, LeapSettings {
   const ButterflySettings._();
@@ -326,6 +328,8 @@ sealed class ButterflySettings with _$ButterflySettings, LeapSettings {
     @Default(true) bool autosave,
     @Default(true) bool showSaveButton,
     @Default(1) int toolbarRows,
+    @Default(true) bool delayedAutosave,
+    @Default(3) int autosaveDelaySeconds,
     @Default(false) bool hideCursorWhileDrawing,
     @Default(UtilitiesState()) UtilitiesState utilities,
     @Default(StartupBehavior.openHomeScreen) StartupBehavior onStartup,
@@ -424,6 +428,8 @@ sealed class ButterflySettings with _$ButterflySettings, LeapSettings {
       highContrast: prefs.getBool('high_contrast') ?? false,
       gridView: prefs.getBool('grid_view') ?? false,
       autosave: prefs.getBool('autosave') ?? true,
+      delayedAutosave: prefs.getBool('delayed_autosave') ?? false,
+      autosaveDelaySeconds: prefs.getInt('autosave_delay_seconds') ?? 5,
       toolbarSize: prefs.containsKey('toolbar_size')
           ? ToolbarSize.values.byName(prefs.getString('toolbar_size')!)
           : ToolbarSize.normal,
@@ -536,6 +542,8 @@ sealed class ButterflySettings with _$ButterflySettings, LeapSettings {
     await prefs.setBool('high_contrast', highContrast);
     await prefs.setBool('grid_view', gridView);
     await prefs.setBool('autosave', autosave);
+    await prefs.setBool('delayed_autosave', delayedAutosave);
+    await prefs.setInt('autosave_delay_seconds', autosaveDelaySeconds);
     await prefs.setString('toolbar_size', toolbarSize.name);
     await prefs.setInt('toolbar_rows', toolbarRows);
     await prefs.setBool('hide_cursor_while_drawing', hideCursorWhileDrawing);
@@ -1039,13 +1047,23 @@ class SettingsCubit extends Cubit<ButterflySettings>
 
   Future<void> toggleGridView() => changeGridView(!state.gridView);
 
-  Future<void> changeAutosave(bool? value) {
+  Future<void> changeAutosave(bool? value, {bool delayed = false}) {
     emit(
-      state.copyWith(autosave: value ?? true, showSaveButton: value == null),
+      state.copyWith(
+        autosave: value ?? true,
+        showSaveButton: value == null,
+        delayedAutosave: delayed,
+      ),
     );
     return save();
   }
 
+  Future<void> changeAutosaveDelaySeconds(int seconds) {
+    final normalized = seconds.clamp(1, 3600);
+    emit(state.copyWith(autosaveDelaySeconds: normalized));
+    return save();
+  }
+
   Future<void> changeToolbarRows(int value) {
     emit(state.copyWith(toolbarRows: value));
     return save();

app/lib/cubits/settings.freezed.dart

@@ -706,5 +706,11 @@
   "ignorePressure": "Ignore pressure",
   "ignoreFirstPressureDescription": "On some devices, the first pressure value is not accurate. This setting will ignore the first pressure value and use the pressure of the second event instead.",
   "temporary": "Temporary",
-  "simpleToolbarVisibility": "Simple toolbar visibility"
+  "simpleToolbarVisibility": "Simple toolbar visibility",
+  "autosaveDelay": "Autosave delay",
+  "saved": "Saved",
+  "saving": "Saving...",
+  "readOnly": "Read only",
+  "saveDelayed": "Save delayed",
+  "unsaved": "Unsaved"
 }

app/lib/cubits/settings.g.dart

@@ -67,7 +67,9 @@ class BehaviorsSettingsPage extends StatelessWidget {
                         ),
                         subtitle: Text(
                           state.autosave
-                              ? state.showSaveButton
+                              ? state.delayedAutosave
+                                    ? AppLocalizations.of(context).delay
+                                    : state.showSaveButton
                                     ? AppLocalizations.of(
                                         context,
                                       ).yesButShowButtons
@@ -76,6 +78,21 @@ class BehaviorsSettingsPage extends StatelessWidget {
                         ),
                         onTap: () => _openAutosaveModal(context),
                       ),
+                      if (state.autosave && state.delayedAutosave)
+                        ExactSlider(
+                          leading: const PhosphorIcon(PhosphorIconsLight.clock),
+                          header: Text(
+                            AppLocalizations.of(context).autosaveDelay,
+                          ),
+                          value: state.autosaveDelaySeconds.toDouble(),
+                          min: 1,
+                          max: 10,
+                          defaultValue: 5,
+                          fractionDigits: 0,
+                          onChangeEnd: (value) => context
+                              .read<SettingsCubit>()
+                              .changeAutosaveDelaySeconds(value.toInt()),
+                        ),
                       ListTile(
                         title: Text(AppLocalizations.of(context).onStartup),
                         subtitle: Text(
@@ -228,27 +245,34 @@ class BehaviorsSettingsPage extends StatelessWidget {
     final cubit = context.read<SettingsCubit>();
     final autosave = cubit.state.autosave;
     final showSaveButton = cubit.state.showSaveButton;
+    final delayed = cubit.state.delayedAutosave;
 
     showLeapBottomSheet(
       context: context,
       titleBuilder: (context) => Text(AppLocalizations.of(context).autosave),
       childrenBuilder: (context) {
-        void changeAutosave(bool? autosave) {
-          cubit.changeAutosave(autosave);
+        void changeAutosave(bool? autosave, {bool delayed = false}) {
+          cubit.changeAutosave(autosave, delayed: delayed);
           Navigator.of(context).pop();
         }
 
         return [
           ListTile(
             title: Text(AppLocalizations.of(context).yes),
             leading: Icon(PhosphorIconsLight.check),
-            selected: autosave && showSaveButton == false,
+            selected: autosave && !showSaveButton && !delayed,
             onTap: () => changeAutosave(true),
           ),
+          ListTile(
+            title: Text(AppLocalizations.of(context).delay),
+            leading: Icon(PhosphorIconsLight.clock),
+            selected: autosave && delayed,
+            onTap: () => changeAutosave(null, delayed: true),
+          ),
           ListTile(
             title: Text(AppLocalizations.of(context).yesButShowButtons),
             leading: Icon(PhosphorIconsLight.question),
-            selected: autosave && showSaveButton,
+            selected: autosave && showSaveButton && !delayed,
             onTap: () => changeAutosave(null),
           ),
           ListTile(

app/lib/l10n/app_en.arb

@@ -351,10 +351,20 @@ class _AppBarTitleState extends State<_AppBarTitle> {
                   SaveState.unsaved ||
                   SaveState.absoluteRead => PhosphorIconsLight.floppyDisk,
                   SaveState.saving => PhosphorIconsLight.download,
+                  SaveState.delay => PhosphorIconsLight.clock,
                 });
+                String tooltip = switch (currentIndex.saved) {
+                  SaveState.saved => AppLocalizations.of(context).saved,
+                  SaveState.unsaved => AppLocalizations.of(context).unsaved,
+                  SaveState.absoluteRead => AppLocalizations.of(
+                    context,
+                  ).readOnly,
+                  SaveState.saving => AppLocalizations.of(context).saving,
+                  SaveState.delay => AppLocalizations.of(context).saveDelayed,
+                };
                 return IconButton(
                   icon: icon,
-                  tooltip: AppLocalizations.of(context).save,
+                  tooltip: tooltip,
                   onPressed: () {
                     Actions.maybeInvoke<SaveIntent>(
                       context,

app/lib/settings/behaviors.dart

@@ -1683,4 +1683,4 @@ packages:
     version: "3.1.3"
 sdks:
   dart: ">=3.9.0 <4.0.0"
-  flutter: ">=3.35.6"
+  flutter: ">=3.35.5"