- Fix: Add error handling capability to GiphyMediaView.

re #25
Giphy · Aug 14, 2024 · 3cdee1e · 3cdee1e
1 parent 4adb703
commit 3cdee1e
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 13 deletions.
diff --git a/android/src/main/kotlin/com/giphy/giphy_flutter_sdk/GiphyFlutterMediaView.kt b/android/src/main/kotlin/com/giphy/giphy_flutter_sdk/GiphyFlutterMediaView.kt
@@ -6,6 +6,7 @@ import android.util.Log
 import android.view.View
 import com.facebook.drawee.drawable.ScalingUtils
 import com.giphy.giphy_flutter_sdk.dto.GiphyFlutterResizeMode
+import com.giphy.giphy_flutter_sdk.dto.GiphyApiException
 import com.giphy.giphy_flutter_sdk.dto.toMedia
 import com.giphy.giphy_flutter_sdk.dto.toRenditionType
 import com.giphy.giphy_flutter_sdk.utils.require
@@ -97,7 +98,13 @@ internal class GiphyFlutterMediaView(
             loadedMedia = result?.data
             syncMedia()
             e?.let {
-                Log.d("Error while fetching GIF: %s", e.localizedMessage)
+                val exception = GiphyApiException(it)
+                val errorMessage = exception.errorMessage
+                channel.invokeMethod(
+                    "onError", mapOf(
+                        "error" to exception.errorMessage
+                    )
+                )
             }
         }
     }

diff --git a/android/src/main/kotlin/com/giphy/giphy_flutter_sdk/dto/GiphyApiException.kt b/android/src/main/kotlin/com/giphy/giphy_flutter_sdk/dto/GiphyApiException.kt
@@ -0,0 +1,19 @@
+package com.giphy.giphy_flutter_sdk.dto
+
+import com.giphy.sdk.core.network.response.ErrorResponse
+
+class GiphyApiException(private val original: Throwable) : Exception(original) {
+
+    val errorResponse: ErrorResponse? by lazy {
+        try {
+            val errorResponseField = original::class.java.getDeclaredField("errorResponse")
+            errorResponseField.isAccessible = true
+            errorResponseField.get(original) as? ErrorResponse
+        } catch (e: Exception) {
+            null
+        }
+    }
+
+    val errorMessage: String
+        get() = errorResponse?.message ?: (errorResponse?.meta?.msg ?: "Unknown Error")
+}
diff --git a/example/lib/main_screen.dart b/example/lib/main_screen.dart
@@ -188,9 +188,15 @@ class _MainScreenState extends State<MainScreen>
                             _mediaList[index].images.original!.gifUrl!),
                       )
                     : GiphyMediaView(
-                        media: _mediaList[index],
+                        mediaId: _mediaList[index].id,
                         autoPlay: true,
                         renditionType: GiphyRendition.fixedWidth,
+                        onError: (error) {
+                          setState(() {
+                            // Display a crying emoji in case of an error
+                            _mediaList[index] = GiphyMedia.fromJson({"id": "tEuZQV7AGrrv035n3c", "images": {}});
+                          });
+                        },
                       ),
           ),
         );

diff --git a/ios/Classes/GiphyFlutterMediaView.swift b/ios/Classes/GiphyFlutterMediaView.swift
@@ -70,7 +70,13 @@ public class GiphyFlutterMediaView: NSObject, FlutterPlatformView {
             guard let self = self else {
                 return
             }
-            self.media = response?.data
+            if let error = error {
+                channel?.invokeMethod("onError", arguments: [
+                    "error": error.localizedDescription
+                ])
+            } else {
+                self.media = response?.data
+            }
         }
     }
 

diff --git a/lib/giphy_media_view.dart b/lib/giphy_media_view.dart
@@ -35,17 +35,20 @@ class GiphyMediaView extends StatefulWidget {
   /// Enable/disable the checkered background for stickers and text media type.
   final bool showCheckeredBackground;
 
+  /// A callback function that will be called when an error occurs whilst attempting to render media.
+  final Function(String description)? onError;
+
   /// Constructs a GiphyMediaView.
-  const GiphyMediaView({
-    super.key,
-    this.controller,
-    this.mediaId,
-    this.media,
-    this.autoPlay = true,
-    this.renditionType = GiphyRendition.fixedWidth,
-    this.resizeMode = GiphyResizeMode.cover,
-    this.showCheckeredBackground = true,
-  });
+  const GiphyMediaView(
+      {super.key,
+      this.controller,
+      this.mediaId,
+      this.media,
+      this.autoPlay = true,
+      this.renditionType = GiphyRendition.fixedWidth,
+      this.resizeMode = GiphyResizeMode.cover,
+      this.showCheckeredBackground = true,
+      this.onError});
 
   @override
   State<GiphyMediaView> createState() => _GiphyMediaViewState();
@@ -125,10 +128,24 @@ class _GiphyMediaViewState extends State<GiphyMediaView> {
   /// Sets up the method channel for communication with the native platform.
   void _onPlatformViewCreated(int viewId) {
     _channel = MethodChannel('com.giphyfluttersdk/mediaView$viewId');
+    _channel.setMethodCallHandler(_handleMethodCall);
     _isPlatformViewCreated = true;
     _updatePlatformView();
   }
 
+  /// Handles method calls from the native platform.
+  ///
+  /// This method processes callbacks for errors.
+  Future<dynamic> _handleMethodCall(MethodCall call) async {
+    switch (call.method) {
+      case 'onError':
+        if (widget.onError != null) {
+          widget.onError!(call.arguments['error'] ?? "unknown");
+        }
+        break;
+    }
+  }
+
   /// Updates the platform view with the current widget properties.
   Future<void> _updatePlatformView() async {
     if (widget.mediaId != null) {