Merge pull request #730 from ayaan-md-blr/har_importer

Har importer

Author: ashitaprasad

README.md

@@ -105,7 +105,7 @@ API Dash can be downloaded from the links below:
 | Insomnia | ✅ | 
 | OpenAPI | https://github.com/foss42/apidash/issues/121 |
 | hurl | https://github.com/foss42/apidash/issues/123 |
-| HAR | https://github.com/foss42/apidash/issues/122 |
+| HAR | ✅ |
 
 
 **↗️ Create & Customize API Requests**

lib/consts.dart

@@ -144,7 +144,8 @@ enum CodegenLanguage {
 enum ImportFormat {
   curl("cURL"),
   postman("Postman Collection v2.1"),
-  insomnia("Insomnia v4");
+  insomnia("Insomnia v4"),
+  har("Har v1.2");
 
   const ImportFormat(this.label);
   final String label;

lib/importer/importer.dart

@@ -13,6 +13,7 @@ class Importer {
           .toList(),
       ImportFormat.postman => PostmanIO().getHttpRequestModelList(content),
       ImportFormat.insomnia => InsomniaIO().getHttpRequestModelList(content),
+      ImportFormat.har => HarParserIO().getHttpRequestModelList(content),
     };
   }
 }

packages/apidash_core/lib/import_export/har_io.dart

@@ -0,0 +1,135 @@
+import 'package:har/har.dart' as har;
+import 'package:seed/seed.dart';
+import '../consts.dart';
+import '../models/models.dart';
+import '../utils/utils.dart';
+
+class HarParserIO {
+  List<(String?, HttpRequestModel)>? getHttpRequestModelList(String content) {
+    content = content.trim();
+    try {
+      final hl = har.harLogFromJsonStr(content);
+      final requests = har.getRequestsFromHarLog(hl);
+      return requests
+          .map((req) => (req.$2.url, harRequestToHttpRequestModel(req.$2)))
+          .toList();
+    } catch (e) {
+      return null;
+    }
+  }
+
+  HttpRequestModel harRequestToHttpRequestModel(har.Request request) {
+    HTTPVerb method;
+
+    try {
+      method = HTTPVerb.values.byName((request.method ?? "").toLowerCase());
+    } catch (e) {
+      method = kDefaultHttpMethod;
+    }
+    String url = stripUrlParams(request.url ?? "");
+    List<NameValueModel> headers = [];
+    List<bool> isHeaderEnabledList = [];
+
+    List<NameValueModel> params = [];
+    List<bool> isParamEnabledList = [];
+
+    for (var header in request.headers ?? <har.Header>[]) {
+      var name = header.name ?? "";
+      var value = header.value;
+      var activeHeader = header.disabled ?? false;
+      headers.add(NameValueModel(name: name, value: value));
+      isHeaderEnabledList.add(!activeHeader);
+    }
+
+    for (var query in request.queryString ?? <har.Query>[]) {
+      var name = query.name ?? "";
+      var value = query.value;
+      var activeQuery = query.disabled ?? false;
+      params.add(NameValueModel(name: name, value: value));
+      isParamEnabledList.add(!activeQuery);
+    }
+
+    ContentType bodyContentType = kDefaultContentType;
+    String? body;
+    List<FormDataModel>? formData = [];
+
+    if (request.postData?.mimeType == "application/json") {
+      bodyContentType = ContentType.json;
+      body = request.postData?.text;
+    }
+    FormDataType formDataType = FormDataType.text;
+    if (request.postData?.mimeType == "application/x-www-form-urlencoded") {
+      bodyContentType = ContentType.formdata;
+      var formDataStr = request.postData?.text;
+      Map<String, String> parsedData = parseFormData(formDataStr);
+      parsedData.forEach((key, value) {
+        formDataType = FormDataType.text;
+        var name = key;
+        var val = value;
+        formData.add(FormDataModel(
+          name: name,
+          value: val,
+          type: formDataType,
+        ));
+      });
+    }
+
+    if (request.postData?.mimeType == "multipart/form-data") {
+      bodyContentType = ContentType.formdata;
+      String? name, val;
+      for (var fd in request.postData?.params ?? <har.Param>[]) {
+        name = fd.name;
+        if (fd.contentType == "text/plain") {
+          formDataType = FormDataType.text;
+          val = fd.value;
+        } else {
+          formDataType = FormDataType.file;
+          val = fd.fileName;
+        }
+        formData.add(FormDataModel(
+          name: name ?? "",
+          value: val ?? "",
+          type: formDataType,
+        ));
+      }
+    }
+
+    return HttpRequestModel(
+        method: method,
+        url: url,
+        headers: headers,
+        params: params,
+        isHeaderEnabledList: isHeaderEnabledList,
+        isParamEnabledList: isParamEnabledList,
+        body: body,
+        bodyContentType: bodyContentType,
+        formData: formData);
+  }
+
+  Map<String, String> parseFormData(String? data) {
+    // Return an empty map if the input is null or empty
+    if (data == null || data.isEmpty) {
+      return {};
+    }
+    // Split the input string into individual key-value pairs
+    var pairs = data.split('&');
+
+    // Create a Map to store key-value pairs
+    Map<String, String> result = {};
+
+    // Loop through the pairs and split them into keys and values
+    for (var pair in pairs) {
+      var keyValue = pair.split('=');
+
+      // Ensure the pair contains both key and value
+      if (keyValue.length == 2) {
+        var key = Uri.decodeComponent(keyValue[0]);
+        var value = Uri.decodeComponent(keyValue[1]);
+
+        result[key] = value;
+      }
+    }
+
+    return result;
+  }
+}

packages/apidash_core/lib/import_export/import_export.dart

@@ -1,3 +1,4 @@
 export 'curl_io.dart';
 export 'postman_io.dart';
 export 'insomnia_io.dart';
+export 'har_io.dart';

packages/apidash_core/pubspec.yaml

@@ -22,6 +22,8 @@ dependencies:
   json5: ^0.8.2
   postman:
     path: ../postman
+  har:
+    path: ../har
   seed: ^0.0.3
   xml: ^6.3.0
 

packages/apidash_core/pubspec_overrides.yaml

@@ -1,7 +1,9 @@
-# melos_managed_dependency_overrides: curl_parser,insomnia_collection,postman,seed
+# melos_managed_dependency_overrides: curl_parser,insomnia_collection,postman,seed,har
 dependency_overrides:
   curl_parser:
     path: ../curl_parser
+  har:
+    path: ../har
   insomnia_collection:
     path: ../insomnia_collection
   postman:

packages/har/.gitignore

@@ -0,0 +1,31 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+build/

packages/har/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+* TODO: Describe initial release.