Improve memory usage and performance for importing large assets

Author: CodeDoctorDE

api/lib/src/helpers/import.dart

@@ -1,16 +1,37 @@
+import 'dart:typed_data';
+
 import 'package:butterfly_api/butterfly_api.dart';
 
+const kAssetScheme = 'asset';
+
 typedef ImportAssetOptions = (
   NoteData data,
   List<PadElement> elements, {
   void Function(String source)? onInvalidate,
   Map<String, String>? alreadyImported,
+  Map<String, Uint8List>? assets,
 });
 
 (NoteData, List<PadElement>) importAssets(ImportAssetOptions options) {
   final imported = options.alreadyImported ?? {};
   var data = options.$1;
   var elements = options.$2;
+  String importBytes(
+    SourcedElement element,
+    String fileExtension,
+    Uint8List bytes,
+  ) {
+    (NoteData, String) result;
+    if (element is PdfElement) {
+      result = data.importPdf(bytes);
+    } else {
+      result = data.importImage(bytes, fileExtension);
+    }
+    data = result.$1;
+    final path = Uri.file(result.$2, windows: false).toString();
+    return imported[element.source] = path;
+  }
+
   String importAsset(SourcedElement element, String fileExtension) {
     final source = element.source;
     options.onInvalidate?.call(source);
@@ -20,22 +41,19 @@ typedef ImportAssetOptions = (
     final uri = Uri.tryParse(source);
     final uriData = uri?.data;
     if (uriData == null) {
-      if ((uri?.isScheme('file') ?? false) || !(uri?.hasScheme ?? true)) {
-        data = data.undoDelete(uri!.path);
+      if ((uri?.isScheme('file') ?? false)) {
+        imported[source] = uri!.toFilePath(windows: false);
+      }
+      if (uri?.isScheme(kAssetScheme) ?? false) {
+        final bytes = options.assets?[source];
+        if (bytes != null) {
+          return importBytes(element, fileExtension, bytes);
+        }
       }
       return source;
     }
     final bytes = uriData.contentAsBytes();
-    (NoteData, String) result;
-    if (element is PdfElement) {
-      result = data.importPdf(bytes);
-    } else {
-      result = data.importImage(bytes, fileExtension);
-    }
-    data = result.$1;
-    final path = Uri.file(result.$2, windows: false).toString();
-    imported[source] = path;
-    return path;
+    return importBytes(element, fileExtension, bytes);
   }
 
   elements = elements

api/lib/src/models/tool.dart

@@ -1,9 +1,11 @@
 import 'dart:math';
+import 'dart:typed_data';
 
 import 'package:butterfly_api/src/converter/color.dart';
 import 'package:dart_leap/dart_leap.dart';
 import 'package:freezed_annotation/freezed_annotation.dart';
 
+import '../converter/core.dart';
 import 'area.dart';
 import 'colors.dart';
 import 'element.dart';
@@ -72,6 +74,7 @@ sealed class Tool with _$Tool {
     @Default('') String displayIcon,
     required List<PadElement> elements,
     required List<Area> areas,
+    @Uint8ListJsonConverter() @Default({}) Map<String, Uint8List> assets,
   }) = ImportTool;
 
   factory Tool.undo({

api/lib/src/models/tool.freezed.dart

@@ -55,8 +55,10 @@ sealed class DocumentEvent extends ReplayEvent with _$DocumentEvent {
   const factory DocumentEvent.utilitiesChanged(UtilitiesState state) =
       UtilitiesChanged;
 
-  const factory DocumentEvent.elementsCreated(List<PadElement> elements) =
-      ElementsCreated;
+  const factory DocumentEvent.elementsCreated(
+    List<PadElement> elements, {
+    @Uint8ListJsonConverter() @Default({}) Map<String, Uint8List> assets,
+  }) = ElementsCreated;
 
   const factory DocumentEvent.elementsChanged(
     Map<String, List<PadElement>> elements,

api/lib/src/models/tool.g.dart

@@ -20,7 +20,7 @@ class PasteAction extends Action<PasteIntent> {
     if (state is! DocumentLoadSuccess) return;
     final importService = intent.context.read<ImportService>();
     try {
-      importService.importClipboard(state.data);
+      importService.importClipboard(state.data).then((e) => e?.submit());
     } catch (_) {}
   }
 }

api/lib/src/protocol/event.dart

@@ -35,6 +35,7 @@ typedef ImportAssetSyncOptions = (
   List<PadElement> elements, {
   SendPort? onInvalidate,
   Map<String, String>? alreadyImported,
+  Map<String, Uint8List>? assets,
 });
 (NoteData, List<PadElement>) _importAssetsSync(ImportAssetSyncOptions options) {
   return importAssets((
@@ -44,6 +45,7 @@ typedef ImportAssetSyncOptions = (
         ? (source) => options.onInvalidate!.send(source)
         : null,
     alreadyImported: options.alreadyImported,
+    assets: options.assets,
   ));
 }
 
@@ -52,6 +54,7 @@ Future<(NoteData, List<PadElement>)> importAssetsAsync(
   List<PadElement> elements, {
   void Function(String source)? onInvalidate,
   Map<String, String>? alreadyImported,
+  Map<String, Uint8List>? assets,
 }) {
   ReceivePort? port;
   if (onInvalidate != null) {
@@ -67,6 +70,7 @@ Future<(NoteData, List<PadElement>)> importAssetsAsync(
     elements,
     onInvalidate: port?.sendPort,
     alreadyImported: alreadyImported,
+    assets: assets,
   ));
 }
 
@@ -215,6 +219,7 @@ class DocumentBloc extends ReplayBloc<DocumentEvent, DocumentState> {
         current.data,
         event.elements.map((e) => e.copyWith(id: createUniqueId())).toList(),
         onInvalidate: assetService.invalidate,
+        assets: event.assets,
       );
       final renderers = elements
           .map((e) => Renderer.fromInstance(e, current.currentLayer))

api/lib/src/protocol/event.freezed.dart

@@ -42,10 +42,14 @@ ContextMenuBuilder buildElementsContextMenu(
           onPressed: () {
             Navigator.of(context).pop(true);
             try {
-              importService.importClipboard(
-                state.data,
-                position: state.transformCubit.state.localToGlobal(position),
-              );
+              importService
+                  .importClipboard(
+                    state.data,
+                    position: state.transformCubit.state.localToGlobal(
+                      position,
+                    ),
+                  )
+                  .then((e) => e?.submit());
             } catch (_) {}
           },
           icon: const PhosphorIcon(PhosphorIconsLight.clipboard),