feat: add option to zip files before sending by email

alois-beto · alois-beto · commit 3b7a529c8747 · 2025-04-18T17:47:43.000+02:00
diff --git a/README.md b/README.md
@@ -50,11 +50,12 @@ Initialize the file-logger with the specified options. As soon as the returned p
 
 Send all log files by email. On iOS, it uses `MFMailComposeViewController` to ensure that the user won't leave the app when sending log files.
 
-| Option    | Description                          |
-| --------- | ------------------------------------ |
-| `to`      | Email address of the recipient       |
-| `subject` | Email subject                        |
-| `body`    | Plain text body message of the email |
+| Option     | Description                                                                                                           |
+| ---------- | --------------------------------------------------------------------------------------------------------------------- |
+| `to`       | Email address of the recipient                                                                                        |
+| `subject`  | Email subject                                                                                                         |
+| `body`     | Plain text body message of the email                                                                                  |
+| `compress` | If `true`, log files will be compressed into a single zip file before being attached to the email, default to `false` |
 
 #### FileLogger.enableConsoleCapture()
 
diff --git a/RNFileLogger.podspec b/RNFileLogger.podspec
@@ -16,7 +16,8 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,mm}"
   s.framework    = "MessageUI"
   
-  s.dependency "CocoaLumberjack"
+  s.dependency "CocoaLumberjack", "~> 3.8.5"
+  s.dependency "SSZipArchive", "~> 2.4.3"
 
   # Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
   # See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.
diff --git a/android/src/main/java/com/betomorrow/rnfilelogger/FileLoggerModule.java b/android/src/main/java/com/betomorrow/rnfilelogger/FileLoggerModule.java
@@ -18,8 +18,11 @@
 
 import java.io.File;
 import java.io.FilenameFilter;
+import java.io.FileOutputStream;
 import java.nio.charset.Charset;
 import java.util.ArrayList;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipOutputStream;
 
 import ch.qos.logback.classic.Level;
 import ch.qos.logback.classic.LoggerContext;
@@ -185,6 +188,7 @@ public void sendLogFilesByEmail(ReadableMap options, Promise promise) {
             ReadableArray to = options.hasKey("to") ? options.getArray("to") : null;
             String subject = options.hasKey("subject") ? options.getString("subject") : null;
             String body = options.hasKey("body") ? options.getString("body") : null;
+            boolean compressFiles = options.hasKey("compressFiles") && options.getBoolean("compressFiles");
 
             Intent intent = new Intent(Intent.ACTION_SEND_MULTIPLE, Uri.parse("mailto:"));
             intent.setType("plain/text");
@@ -200,13 +204,38 @@ public void sendLogFilesByEmail(ReadableMap options, Promise promise) {
             }
 
             ArrayList<Uri> uris = new ArrayList<>();
-            for (File file : getLogFiles()) {
-                Uri fileUri = FileProvider.getUriForFile(
+            File[] logFiles = getLogFiles();
+
+            if (compressFiles && logFiles.length > 0) {
+                // Create a zip file containing all log files
+                File zipFile = new File(logsDirectory, "logs.zip");
+                try (FileOutputStream fos = new FileOutputStream(zipFile);
+                     ZipOutputStream zos = new ZipOutputStream(fos)) {
+                    
+                    for (File logFile : logFiles) {
+                        ZipEntry zipEntry = new ZipEntry(logFile.getName());
+                        zos.putNextEntry(zipEntry);
+                        java.nio.file.Files.copy(logFile.toPath(), zos);
+                        zos.closeEntry();
+                    }
+                }
+
+                Uri zipUri = FileProvider.getUriForFile(
+                    reactContext,
+                    reactContext.getApplicationContext().getPackageName() + ".provider",
+                    zipFile);
+                uris.add(zipUri);
+            } else {
+                // Send individual log files
+                for (File file : logFiles) {
+                    Uri fileUri = FileProvider.getUriForFile(
                         reactContext,
                         reactContext.getApplicationContext().getPackageName() + ".provider",
                         file);
-                uris.add(fileUri);
+                    uris.add(fileUri);
+                }
             }
+
             intent.putParcelableArrayListExtra(Intent.EXTRA_STREAM, uris);
             intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK | Intent.FLAG_GRANT_READ_URI_PERMISSION);
             
diff --git a/example/App.tsx b/example/App.tsx
@@ -5,9 +5,12 @@ import { FileLogger, LogLevel } from "react-native-file-logger";
 export const App = () => {
 	const [logLevel, setLogLevel] = useState(LogLevel.Debug);
 	const [enabled, setEnabled] = useState(true);
+	const [count, setCount] = useState(0);
 
 	useEffect(() => {
-		FileLogger.configure({ logLevel: LogLevel.Debug }).then(() => console.log("File-logger configured"));
+		FileLogger.configure({ logLevel: LogLevel.Debug, maximumFileSize: 1024 }).then(() =>
+			console.log("File-logger configured")
+		);
 	}, []);
 
 	const showLogFilePaths = async () => {
@@ -34,6 +37,7 @@ export const App = () => {
 			to: "john@doe.com",
 			subject: "Log files",
 			body: "Please find attached the log files from your app",
+			compressFiles: true,
 		});
 	};
 
@@ -67,13 +71,31 @@ export const App = () => {
 		<View style={styles.container}>
 			<View style={styles.buttonContainer}>
 				<View style={styles.button}>
-					<Button title="Log info" onPress={() => console.log("Log info", { nested: { data: 123 } })} />
+					<Button
+						title="Log info"
+						onPress={() => {
+							console.log("Log info", { nested: { count } });
+							setCount(c => c + 1);
+						}}
+					/>
 				</View>
 				<View style={styles.button}>
-					<Button title="Log warning" onPress={() => console.warn("Log warning", { nested: { data: 456 } })} />
+					<Button
+						title="Log warning"
+						onPress={() => {
+							console.warn("Log warning", { nested: { count } });
+							setCount(c => c + 1);
+						}}
+					/>
 				</View>
 				<View style={styles.button}>
-					<Button title="Log error" onPress={() => console.error("Log error", { nested: { data: 789 } })} />
+					<Button
+						title="Log error"
+						onPress={() => {
+							console.error("Log error", { nested: { count } });
+							setCount(c => c + 1);
+						}}
+					/>
 				</View>
 				<View style={styles.button}>
 					<Button title="Log large data" onPress={() => massiveLogging()} />
diff --git a/example/package-lock.json b/example/package-lock.json
diff --git a/ios/FileLogger.mm b/ios/FileLogger.mm
@@ -4,6 +4,7 @@
 #import <CocoaLumberjack/CocoaLumberjack.h>
 #import <MessageUI/MessageUI.h>
 #import "FileLoggerFormatter.h"
+#import <SSZipArchive/SSZipArchive.h>
 
 enum LogLevel {
     LOG_LEVEL_DEBUG,
@@ -87,7 +88,8 @@ - (dispatch_queue_t)methodQueue {
     NSArray<NSString*>* to = options[@"to"];
     NSString* subject = options[@"subject"];
     NSString* body = options[@"body"];
-    
+    NSNumber* compressFiles = options[@"compressFiles"];
+
     if (![MFMailComposeViewController canSendMail]) {
         reject(@"CannotSendMail", @"Cannot send emails on this device", nil);
         return;
@@ -106,9 +108,27 @@ - (dispatch_queue_t)methodQueue {
     }
     
     NSArray<NSString*>* logFiles = self.fileLogger.logFileManager.sortedLogFilePaths;
-    for (NSString* logFile in logFiles) {
-        NSData* data = [NSData dataWithContentsOfFile:logFile];
-        [composeViewController addAttachmentData:data mimeType:@"text/plain" fileName:[logFile lastPathComponent]];
+    
+    if ([compressFiles boolValue]) {
+        // Create a temporary directory for the zip file
+        NSString* tempDir = NSTemporaryDirectory();
+        NSString* zipPath = [tempDir stringByAppendingPathComponent:@"logs.zip"];
+        
+        // Create zip file containing all log files
+        [SSZipArchive createZipFileAtPath:zipPath withFilesAtPaths:logFiles];
+        
+        // Add the zip file as attachment
+        NSData* zipData = [NSData dataWithContentsOfFile:zipPath];
+        [composeViewController addAttachmentData:zipData mimeType:@"application/zip" fileName:@"logs.zip"];
+        
+        // Clean up the temporary zip file
+        [[NSFileManager defaultManager] removeItemAtPath:zipPath error:nil];
+    } else {
+        // Add each log file as a separate attachment
+        for (NSString* logFile in logFiles) {
+            NSData* data = [NSData dataWithContentsOfFile:logFile];
+            [composeViewController addAttachmentData:data mimeType:@"text/plain" fileName:[logFile lastPathComponent]];
+        }
     }
     
     UIViewController* presentingViewController = UIApplication.sharedApplication.delegate.window.rootViewController;
@@ -134,28 +154,32 @@ - (void)mailComposeController:(MFMailComposeViewController*)controller didFinish
 
 // Signature only used by the new architecture.
 - (void)configure:(JS::NativeFileLogger::NativeConfigureOptions &)options resolve:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject {
-    NSString* logsDirectory = options.logsDirectory();
     NSMutableDictionary * optionsDict = [NSMutableDictionary dictionary];
+
     [optionsDict setValue:@(options.dailyRolling()) forKey:@"dailyRolling"];
     [optionsDict setValue:@(options.maximumFileSize()) forKey:@"maximumFileSize"];
     [optionsDict setValue:@(options.maximumNumberOfFiles()) forKey:@"maximumNumberOfFiles"];
+    NSString* logsDirectory = options.logsDirectory();
     if (logsDirectory) {
         [optionsDict setValue:logsDirectory forKey:@"logsDirectory"];
     }
+
     [self configure:optionsDict resolver:resolve rejecter:reject];
 }
 
-
+// Signature only used by the new architecture.
 - (void)sendLogFilesByEmail:(JS::NativeFileLogger::SendByEmailOptions &)options resolve:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject {
-    NSDictionary * optionsDict = @{
-            @"subject": options.subject(),
-            @"body": options.body(),
-            @"to": convertToNSArray(options.to())
-        };
+    NSMutableDictionary * optionsDict = [NSMutableDictionary dictionary];
+    
+    [optionsDict setValue:options.subject() forKey:@"subject"];
+    [optionsDict setValue:options.body() forKey:@"body"];
+    [optionsDict setValue:convertToNSArray(options.to()) forKey:@"to"];
+    [optionsDict setValue:@(options.compressFiles()) forKey:@"compressFiles"];
+
     [self sendLogFilesByEmail:optionsDict resolver:resolve rejecter:reject];
 }
 
-
+// Signature only used by the new architecture.
 - (void)write:(double)level msg:(NSString *)msg {
     NSNumber* _Nonnull logLevel = [NSNumber numberWithInt:level];
     [self write:logLevel str:msg];
diff --git a/src/NativeFileLogger.ts b/src/NativeFileLogger.ts
@@ -12,6 +12,7 @@ export type SendByEmailOptions = {
 	to?: string[];
 	subject?: string;
 	body?: string;
+	compressFiles: boolean;
 };
 
 export interface Spec extends TurboModule {
diff --git a/src/index.ts b/src/index.ts
@@ -30,6 +30,7 @@ export interface SendByEmailOptions {
 	to?: string | string[];
 	subject?: string;
 	body?: string;
+	compressFiles?: boolean;
 }
 
 class FileLoggerStatic {
@@ -134,12 +135,13 @@ class FileLoggerStatic {
 	}
 
 	sendLogFilesByEmail(options: SendByEmailOptions = {}): Promise<void> {
-		if (options.to) {
-			const toEmails = Array.isArray(options.to) ? options.to : [options.to];
-			return RNFileLogger.sendLogFilesByEmail({ ...options, to: toEmails });
-		} else {
-			return RNFileLogger.sendLogFilesByEmail({ ...options, to: undefined });
-		}
+		const { to, subject, body, compressFiles = false } = options;
+		return RNFileLogger.sendLogFilesByEmail({
+			to: to ? (Array.isArray(to) ? to : [to]) : undefined,
+			subject,
+			body,
+			compressFiles,
+		});
 	}
 
 	debug(msg: string) {
