Fix embed/web loading errors, closes #1167

CodeDoctorDE · CodeDoctorDE · commit 55c604bbbd2f · 2026-07-15T09:06:56.000+02:00
diff --git a/app/lib/api/file_system.dart b/app/lib/api/file_system.dart
@@ -208,32 +208,38 @@ class ButterflyFileSystem {
 
   static const _database = 'butterfly.db';
   static const _databaseVersion = 5;
-
   static Future<void> _upgradeDatabase(VersionChangeEvent event) async {
     final db = event.database;
     if (event.oldVersion < 1) {
       db.createObjectStore('documents');
     }
+    if (event.oldVersion < 3) {
+      db.createObjectStore('templates');
+    }
+    if (event.oldVersion < 4) {
+      db.createObjectStore('packs');
+      db.createObjectStore('documents-data');
+    }
+    if (event.oldVersion < 5) {
+      db.createObjectStore('documentstates');
+      db.createObjectStore('documentstates-data');
+    }
     if (event.oldVersion < 2) {
-      var txn = event.transaction;
-      var store = txn.objectStore('documents');
-      var cursor = store.openCursor();
+      final txn = event.transaction;
+      final store = txn.objectStore('documents');
+      final cursor = store.openCursor();
+
       await Future.wait(
         await cursor.map<Future<dynamic>>((cursor) async {
-          // Add type to each document
-          var doc = cursor.value as Map<dynamic, dynamic>;
+          final doc = cursor.value as Map<dynamic, dynamic>;
           doc['type'] = 'document';
           await store.put(doc);
         }).toList(),
       );
     }
-    if (event.oldVersion < 3) {
-      db.createObjectStore('templates');
-    }
+
     if (event.oldVersion < 4) {
-      db.createObjectStore('packs');
-      db.createObjectStore('documents-data');
-      var txn = event.transaction;
+      final txn = event.transaction;
       var store = txn.objectStore('templates');
       var cursor = store.openCursor();
       await Future.wait(
@@ -261,10 +267,6 @@ class ButterflyFileSystem {
       );
       await txn.completed;
     }
-    if (event.oldVersion < 5) {
-      db.createObjectStore('documentstates');
-      db.createObjectStore('documentstates-data');
-    }
   }
 
   String _cacheKey(ExternalStorage? storage) => storage?.identifier ?? 'local';
diff --git a/app/lib/repositories/document_state.dart b/app/lib/repositories/document_state.dart
@@ -24,28 +24,36 @@ class DocumentStateRepository {
     String? contentHash,
     String? pathKey,
     bool allowContentHash = true,
-  }) => _lock.synchronized(() async {
-    final settings = _settings;
-    if (!settings.enabled) return null;
-    try {
-      await fileSystem.initialize();
-      if (pathKey != null) {
-        final byPath = await _getFileOrNull(pathKey);
-        if (byPath != null) return _applySettings(byPath, settings);
-      }
-      if (allowContentHash && contentHash != null) {
-        final byContent = await _getFileOrNull(
-          documentStateContentKey(contentHash),
-        );
-        if (byContent != null) return _applySettings(byContent, settings);
-      }
-    } on NetworkException catch (e, stackTrace) {
-      // Document state is optional. A cached remote document must still open
-      // when its separate state record is unavailable offline.
-      talker.warning('Failed to load document state', e, stackTrace);
+  }) {
+    final canLoadByPath = pathKey != null;
+    final canLoadByContent = allowContentHash && contentHash != null;
+
+    if (!canLoadByPath && !canLoadByContent) {
+      return Future.value(null);
     }
-    return null;
-  });
+    return _lock.synchronized(() async {
+      final settings = _settings;
+      if (!settings.enabled) return null;
+      try {
+        await fileSystem.initialize();
+        if (pathKey != null) {
+          final byPath = await _getFileOrNull(pathKey);
+          if (byPath != null) return _applySettings(byPath, settings);
+        }
+        if (allowContentHash && contentHash != null) {
+          final byContent = await _getFileOrNull(
+            documentStateContentKey(contentHash),
+          );
+          if (byContent != null) return _applySettings(byContent, settings);
+        }
+      } on NetworkException catch (e, stackTrace) {
+        // Document state is optional. A cached remote document must still open
+        // when its separate state record is unavailable offline.
+        talker.warning('Failed to load document state', e, stackTrace);
+      }
+      return null;
+    });
+  }
 
   Future<void> save(
     PersistedDocumentState state, {
@@ -54,17 +62,33 @@ class DocumentStateRepository {
     String? previousContentKey,
     String? previousPathKey,
     required bool persistentChanged,
-  }) => _lock.synchronized(() async {
-    final settings = _settings;
-    if (!settings.enabled) return;
-    await fileSystem.initialize();
-    await _updateFile(previousPathKey, pathKey, state, persistentChanged);
-    await _updateFile(previousContentKey, contentKey, state, persistentChanged);
-    _scheduleCleanupAfterSave(
-      contentHash: state.contentHash,
-      pathKey: state.pathKey,
-    );
-  });
+  }) {
+    final hasAnyKey =
+        contentKey != null ||
+        pathKey != null ||
+        previousContentKey != null ||
+        previousPathKey != null;
+
+    if (!hasAnyKey) {
+      return Future.value();
+    }
+    return _lock.synchronized(() async {
+      final settings = _settings;
+      if (!settings.enabled) return;
+      await fileSystem.initialize();
+      await _updateFile(previousPathKey, pathKey, state, persistentChanged);
+      await _updateFile(
+        previousContentKey,
+        contentKey,
+        state,
+        persistentChanged,
+      );
+      _scheduleCleanupAfterSave(
+        contentHash: state.contentHash,
+        pathKey: state.pathKey,
+      );
+    });
+  }
 
   Future<int> cleanup({String? contentHash, String? pathKey, DateTime? now}) =>
       _lock.synchronized(() async {
diff --git a/app/lib/views/main.dart b/app/lib/views/main.dart
@@ -343,8 +343,11 @@ class _ProjectPageState extends State<ProjectPage> {
         path: widget.location?.path ?? '',
         remote: remote?.identifier ?? '',
       );
-      final pathKey = documentStatePathKeyOrNull(location);
-      final contentHash = loadedDocumentBytes == null
+      final persistDocumentState = embedding == null;
+      final pathKey = persistDocumentState
+          ? documentStatePathKeyOrNull(location)
+          : null;
+      final contentHash = !persistDocumentState || loadedDocumentBytes == null
           ? null
           : documentStateContentHash(loadedDocumentBytes);
       final documentStateRepository = DocumentStateRepository(
diff --git a/app/test/views/project_page_lifecycle_test.dart b/app/test/views/project_page_lifecycle_test.dart
@@ -3,7 +3,9 @@ import 'package:butterfly/api/open.dart';
 import 'package:butterfly/bloc/document_bloc.dart';
 import 'package:butterfly/cubits/editor_controller.dart';
 import 'package:butterfly/cubits/settings.dart';
+import 'package:butterfly/embed/embedding.dart';
 import 'package:butterfly/models/defaults.dart';
+import 'package:butterfly/models/persisted_document_state.dart';
 import 'package:butterfly/services/font.dart';
 import 'package:butterfly/src/generated/i18n/app_localizations.dart';
 import 'package:butterfly/views/main.dart';
@@ -95,11 +97,13 @@ void main() {
     );
   }
 
-  Widget buildApp() {
-    final document = DocumentDefaults.createDocument(
-      name: 'Lifecycle test',
-      page: const DocumentPage(backgrounds: []),
-    );
+  Widget buildApp({NoteData? embedDocument}) {
+    final document =
+        embedDocument ??
+        DocumentDefaults.createDocument(
+          name: 'Lifecycle test',
+          page: const DocumentPage(backgrounds: []),
+        );
     fileSystem.buildTemplateSystem().updateFile('default', document);
     router = GoRouter(
       initialLocation: '/',
@@ -136,6 +140,13 @@ void main() {
               path: 'import',
               builder: (context, state) => ProjectPage(data: document),
             ),
+            GoRoute(
+              path: 'embed',
+              builder: (context, state) => ProjectPage(
+                data: document.toFile(),
+                embedding: Embedding(internal: true),
+              ),
+            ),
           ],
         ),
       ],
@@ -222,13 +233,59 @@ void main() {
       'imported document close',
     );
   });
+
+  testWidgets('embed does not load or save persistent document state', (
+    tester,
+  ) async {
+    final document = DocumentDefaults.createDocument(
+      name: 'Embed lifecycle test',
+      page: const DocumentPage(backgrounds: []),
+    );
+    final contentKey = documentStateContentKey(
+      documentStateContentHash(document.exportAsBytes()),
+    );
+    final documentStateSystem = fileSystem.buildDocumentStateSystem();
+    await documentStateSystem.initialize();
+    await documentStateSystem.createFile(
+      contentKey,
+      const PersistedDocumentState(
+        camera: PersistedCameraState(positionX: 100, positionY: 200, zoom: 3),
+      ),
+    );
+    await tester.pumpWidget(buildApp(embedDocument: document));
+
+    router.go('/embed');
+    await pumpUntil(
+      tester,
+      () => observer.lastDocumentBloc?.state is DocumentLoadSuccess,
+      'embedded document open',
+    );
+
+    final editorController = observer.lastDocumentBloc!.editorController;
+    expect(editorController.transformCubit.state.position, Offset.zero);
+    expect(editorController.transformCubit.state.size, 1);
+    editorController.transformCubit.teleport(const Offset(10, 20), 2);
+
+    router.go('/');
+    await pumpUntil(
+      tester,
+      () => observer.documentBlocCloses == 1,
+      'embedded document close',
+    );
+
+    final stored = await documentStateSystem.getFile(contentKey);
+    expect(stored?.camera.positionX, 100);
+    expect(stored?.camera.positionY, 200);
+    expect(stored?.camera.zoom, 3);
+  });
 }
 
 class _LifecycleObserver extends BlocObserver {
   int documentBlocCreates = 0;
   int documentBlocCloses = 0;
   int saveCubitCreates = 0;
   int saveCubitCloses = 0;
+  DocumentBloc? lastDocumentBloc;
   DocumentSaveCubit? lastSaveCubit;
   final events = <String>[];
 
@@ -237,6 +294,7 @@ class _LifecycleObserver extends BlocObserver {
     super.onCreate(bloc);
     if (bloc is DocumentBloc) {
       documentBlocCreates++;
+      lastDocumentBloc = bloc;
     } else if (bloc is DocumentSaveCubit) {
       saveCubitCreates++;
       lastSaveCubit = bloc;
diff --git a/metadata/en-US/changelogs/188.txt b/metadata/en-US/changelogs/188.txt
@@ -9,6 +9,7 @@
 * Fix crash with android saf on folders with many files
 * Fix blur resetting on color change
 * Fix polygon collision aabb tests if closed ([#1162](https://github.com/LinwoodDev/Butterfly/pull/1162)) 
+* Fix embed/web loading errors ([#1167](https://github.com/LinwoodDev/Butterfly/issues/1167))
 * Upgrade to agb 9
 
 Read more here: https://linwood.dev/butterfly/2.6.0-beta.2
