Export To Har

CHANGELOG.md

@@ -11,7 +11,7 @@ Please add your entries according to this format.
 * Brotli compression support
 * Added ability to export list of transactions as .har file.
 * Added ability to save single transaction as .har file.
-* Added ability to export transactions to a file programmatically.
+* Added ability to export transactions to a file programmatically, LOG or HAR.
 * GraphlQL OperationName header to transaction title [#69], [#116]
 
 ### Fixed

library-no-op/api/library-no-op.api

@@ -17,7 +17,7 @@ public final class com/chuckerteam/chucker/api/ChuckerCollector {
 	public synthetic fun <init> (Landroid/content/Context;ZLcom/chuckerteam/chucker/api/RetentionManager$Period;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun getShowNotification ()Z
 	public final fun setShowNotification (Z)V
-	public final fun writeTransactions (Landroid/content/Context;Ljava/lang/Long;)Landroid/net/Uri;
+	public final fun writeTransactions (Landroid/content/Context;Ljava/lang/Long;Lcom/chuckerteam/chucker/api/ExportFormat;)Landroid/net/Uri;
 }
 
 public final class com/chuckerteam/chucker/api/ChuckerInterceptor : okhttp3/Interceptor {
@@ -39,6 +39,13 @@ public final class com/chuckerteam/chucker/api/ChuckerInterceptor$Builder {
 	public final fun redactHeaders ([Ljava/lang/String;)Lcom/chuckerteam/chucker/api/ChuckerInterceptor$Builder;
 }
 
+public final class com/chuckerteam/chucker/api/ExportFormat : java/lang/Enum {
+	public static final field HAR Lcom/chuckerteam/chucker/api/ExportFormat;
+	public static final field LOG Lcom/chuckerteam/chucker/api/ExportFormat;
+	public static fun valueOf (Ljava/lang/String;)Lcom/chuckerteam/chucker/api/ExportFormat;
+	public static fun values ()[Lcom/chuckerteam/chucker/api/ExportFormat;
+}
+
 public final class com/chuckerteam/chucker/api/RetentionManager {
 	public fun <init> (Landroid/content/Context;)V
 	public fun <init> (Landroid/content/Context;Ljava/lang/Object;)V

library-no-op/src/main/kotlin/com/chuckerteam/chucker/api/ChuckerCollector.kt

@@ -16,5 +16,6 @@ public class ChuckerCollector @JvmOverloads constructor(
     public fun writeTransactions(
         context: Context,
         startTimestamp: Long?,
+        exportFormat: ExportFormat
     ): Uri? = null
 }

library-no-op/src/main/kotlin/com/chuckerteam/chucker/api/ExportFormat.kt

@@ -0,0 +1,6 @@
+package com.chuckerteam.chucker.api
+
+public enum class ExportFormat {
+    LOG,
+    HAR
+}

library/api/library.api

@@ -17,7 +17,8 @@ public final class com/chuckerteam/chucker/api/ChuckerCollector {
 	public synthetic fun <init> (Landroid/content/Context;ZLcom/chuckerteam/chucker/api/RetentionManager$Period;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun getShowNotification ()Z
 	public final fun setShowNotification (Z)V
-	public final fun writeTransactions (Landroid/content/Context;Ljava/lang/Long;)Landroid/net/Uri;
+	public final fun writeTransactions (Landroid/content/Context;Ljava/lang/Long;Lcom/chuckerteam/chucker/api/ExportFormat;)Landroid/net/Uri;
+	public static synthetic fun writeTransactions$default (Lcom/chuckerteam/chucker/api/ChuckerCollector;Landroid/content/Context;Ljava/lang/Long;Lcom/chuckerteam/chucker/api/ExportFormat;ILjava/lang/Object;)Landroid/net/Uri;
 }
 
 public final class com/chuckerteam/chucker/api/ChuckerInterceptor : okhttp3/Interceptor {
@@ -39,6 +40,13 @@ public final class com/chuckerteam/chucker/api/ChuckerInterceptor$Builder {
 	public final fun redactHeaders ([Ljava/lang/String;)Lcom/chuckerteam/chucker/api/ChuckerInterceptor$Builder;
 }
 
+public final class com/chuckerteam/chucker/api/ExportFormat : java/lang/Enum {
+	public static final field HAR Lcom/chuckerteam/chucker/api/ExportFormat;
+	public static final field LOG Lcom/chuckerteam/chucker/api/ExportFormat;
+	public static fun valueOf (Ljava/lang/String;)Lcom/chuckerteam/chucker/api/ExportFormat;
+	public static fun values ()[Lcom/chuckerteam/chucker/api/ExportFormat;
+}
+
 public final class com/chuckerteam/chucker/api/RetentionManager {
 	public fun <init> (Landroid/content/Context;)V
 	public fun <init> (Landroid/content/Context;Lcom/chuckerteam/chucker/api/RetentionManager$Period;)V

library/src/main/kotlin/com/chuckerteam/chucker/api/ChuckerCollector.kt

@@ -2,9 +2,14 @@ package com.chuckerteam.chucker.api
 
 import android.content.Context
 import android.net.Uri
+import com.chuckerteam.chucker.R
 import com.chuckerteam.chucker.internal.data.entity.HttpTransaction
+import com.chuckerteam.chucker.internal.data.har.log.Creator
 import com.chuckerteam.chucker.internal.data.repository.RepositoryProvider
+import com.chuckerteam.chucker.internal.support.HarUtils
+import com.chuckerteam.chucker.internal.support.JsonConverter
 import com.chuckerteam.chucker.internal.support.NotificationHelper
+import com.chuckerteam.chucker.internal.support.TransactionDetailsHarSharable
 import com.chuckerteam.chucker.internal.support.TransactionListDetailsSharable
 import com.chuckerteam.chucker.internal.support.writeToFile
 import kotlinx.coroutines.Dispatchers
@@ -74,22 +79,41 @@ public class ChuckerCollector @JvmOverloads constructor(
      * @param context Application context
      * @param startTimestamp The timestamp to read transactions from. Passing null means
      * transactions will not be limited by timestamp
+     * @param exportFormat The export format: LOG or HAR
      * @return The content uri of a file with the transactions in or null if the export failed.
      */
     public fun writeTransactions(
         context: Context,
         startTimestamp: Long?,
+        exportFormat: ExportFormat = ExportFormat.LOG
     ): Uri? {
         val transactions =
             RepositoryProvider.transaction().getTransactionsInTimeRange(startTimestamp)
         if (transactions.isEmpty()) {
             return null
         }
 
-        val sharableTransactions = TransactionListDetailsSharable(transactions, encodeUrls = false)
+        val (sharableTransactions, extension) =  when (exportFormat) {
+            ExportFormat.LOG -> {
+                TransactionListDetailsSharable(transactions, encodeUrls = false) to "txt"
+            }
+            ExportFormat.HAR -> {
+                TransactionDetailsHarSharable(
+                    JsonConverter.nonNullSerializerInstance
+                        .toJson(
+                            HarUtils.fromHttpTransactions(
+                                transactions, Creator(
+                                    context.getString(R.string.chucker_name),
+                                    context.getString(R.string.chucker_version),
+                                )
+                            )
+                        )
+                ) to "har"
+            }
+        }
         return sharableTransactions.writeToFile(
             context = context,
-            fileName = "api_transactions.txt",
+            fileName = "api_transactions.$extension",
         )
     }
 

library/src/main/kotlin/com/chuckerteam/chucker/api/ExportFormat.kt

@@ -0,0 +1,6 @@
+package com.chuckerteam.chucker.api
+
+public enum class ExportFormat {
+    LOG,
+    HAR
+}

library/src/main/kotlin/com/chuckerteam/chucker/internal/support/HarUtils.kt

@@ -1,6 +1,5 @@
 package com.chuckerteam.chucker.internal.support
 
-import androidx.annotation.VisibleForTesting
 import com.chuckerteam.chucker.internal.data.entity.HttpTransaction
 import com.chuckerteam.chucker.internal.data.har.Har
 import com.chuckerteam.chucker.internal.data.har.log.Creator
@@ -19,8 +18,7 @@ internal object HarUtils {
             .toJson(fromHttpTransactions(transactions, Creator(name, version)))
     }
 
-    @VisibleForTesting
-    fun fromHttpTransactions(transactions: List<HttpTransaction>, creator: Creator): Har {
+    internal fun fromHttpTransactions(transactions: List<HttpTransaction>, creator: Creator): Har {
         return Har(transactions, creator)
     }
 }