[EP-351] Add Custom Font API (#292)

Author: a7medev

android/src/main/java/com/instabug/flutter/modules/InstabugApi.java

@@ -314,6 +314,11 @@ public void setCustomBrandingImage(@NonNull String light, @NonNull String dark)
         }
     }
 
+    @Override
+    public void setFont(@NonNull String font) {
+        // iOS Only
+    }
+
     @Override
     public void addFileAttachmentWithURL(@NonNull String filePath, @NonNull String fileName) {
         final File file = new File(filePath);

example/ios/InstabugSampleTests/InstabugApiTests.m

@@ -320,6 +320,18 @@ - (void)testSetCustomBrandingImage {
     OCMVerify([self.mInstabug setCustomBrandingImage:[OCMArg isKindOfClass:[UIImageAsset class]]]);
 }
 
+- (void)testSetFont {
+    NSString* fontName = @"fonts/OpenSans-Regular.ttf";
+    UIFont* font = [UIFont fontWithName:@"Open Sans" size:10.0];
+    FlutterError *error;
+    
+    OCMStub([self.mApi getFontForAsset:fontName error:&error]).andReturn(font);
+
+    [self.api setFontFont:fontName error:&error];
+
+    OCMVerify([self.mInstabug setFont:font]);
+}
+
 - (void)testAddFileAttachmentWithURL {
     NSString *path = @"buggy.txt";
     NSString *name = @"Buggy";

ios/Classes/Modules/InstabugApi.h

@@ -5,5 +5,6 @@ extern void InitInstabugApi(id<FlutterBinaryMessenger> messenger);
 @interface InstabugApi : NSObject <InstabugHostApi>
 
 - (UIImage *)getImageForAsset:(NSString *)assetName;
+- (UIFont *)getFontForAsset:(NSString *)assetName  error:(FlutterError *_Nullable *_Nonnull)error;
 
 @end

ios/Classes/Modules/InstabugApi.m

@@ -1,4 +1,5 @@
 #import <Foundation/Foundation.h>
+#import <CoreText/CoreText.h>
 #import <Flutter/Flutter.h>
 #import "Instabug.h"
 #import "InstabugApi.h"
@@ -196,6 +197,35 @@ - (void)reportScreenChangeScreenName:(NSString *)screenName error:(FlutterError
     }
 }
 
+- (UIFont *)getFontForAsset:(NSString *)assetName  error:(FlutterError *_Nullable *_Nonnull)error {
+    NSString *key = [FlutterDartProject lookupKeyForAsset:assetName];
+    NSString *path = [[NSBundle mainBundle] pathForResource:key ofType:nil];
+    NSData *data = [[NSData alloc] initWithContentsOfFile:path];
+    CFErrorRef fontError;
+    CGDataProviderRef provider = CGDataProviderCreateWithCFData((CFDataRef) data);
+    CGFontRef cgFont = CGFontCreateWithDataProvider(provider);
+    UIFont *font;
+    
+    if(!CTFontManagerRegisterGraphicsFont(cgFont, &fontError)){
+        CFStringRef errorDescription = CFErrorCopyDescription(fontError);
+        *error = [FlutterError errorWithCode:@"IBGFailedToLoadFont" message:(__bridge NSString *)errorDescription details:nil];
+        CFRelease(errorDescription);
+    } else {
+        NSString *fontName = (__bridge NSString *)CGFontCopyFullName(cgFont);
+        font = [UIFont fontWithName:fontName size:10.0];
+    }
+    
+    if (cgFont) CFRelease(cgFont);
+    if (provider) CFRelease(provider);
+    
+    return font;
+}
+
+- (void)setFontFont:(NSString *)fontAsset error:(FlutterError *_Nullable *_Nonnull)error {
+    UIFont *font = [self getFontForAsset:fontAsset error:error];
+    Instabug.font = font;
+}
+
 - (void)addFileAttachmentWithURLFilePath:(NSString *)filePath fileName:(NSString *)fileName error:(FlutterError *_Nullable *_Nonnull)error {
     [Instabug addFileAttachmentWithURL:[NSURL URLWithString:filePath]];
 }

lib/src/modules/instabug.dart

@@ -358,6 +358,14 @@ class Instabug {
     return _host.reportScreenChange(screenName);
   }
 
+  /// Changes the font of Instabug's UI.
+  /// [font] The asset path to the font file (e.g. "fonts/Poppins.ttf").
+  static Future<void> setFont(String font) async {
+    if (IBGBuildInfo.I.isIOS) {
+      return _host.setFont(font);
+    }
+  }
+
   /// Sets the repro steps mode
   /// [mode] repro steps mode
   static Future<void> setReproStepsMode(ReproStepsMode reproStepsMode) async {

pigeons/instabug.api.dart

@@ -45,6 +45,7 @@ abstract class InstabugHostApi {
   void reportScreenChange(String screenName);
 
   void setCustomBrandingImage(String light, String dark);
+  void setFont(String font);
 
   void addFileAttachmentWithURL(String filePath, String fileName);
   void addFileAttachmentWithData(Uint8List data, String fileName);

test/instabug_test.dart

@@ -328,6 +328,17 @@ void main() {
     ).called(1);
   });
 
+  test('[setFont] should call host method', () async {
+    const font = "fonts/OpenSans-Regular.ttf";
+    when(mBuildInfo.isIOS).thenReturn(true);
+
+    await Instabug.setFont(font);
+
+    verify(
+      mHost.setFont(font),
+    ).called(1);
+  });
+
   test('[addFileAttachmentWithURL] should call host method', () async {
     const path = "/opt/android/logs/";
     const name = "log.txt";