Merge branch 'main' into dependabot/pip/packages/python/django-5.1.4

readmeio · Dec 11, 2024 · 9e2ebef · 9e2ebef
2 parents e059f14 + 4cf4e84
commit 9e2ebef
Show file tree

Hide file tree

Showing 11 changed files with 159 additions and 212 deletions.
diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -39,7 +39,6 @@ jobs:
           - windows-latest
         python-version:
           # https://endoflife.date/python
-          - 3.8 # EOL: October 14th, 2024
           - 3.9 # EOL: October 5rd, 2025
           - '3.10' # EOL: October 4rd, 2026
           - '3.11' # EOL: October 24th, 2027

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/dotnet/ReadMe/ConfigValues.cs b/packages/dotnet/ReadMe/ConfigValues.cs
@@ -27,5 +27,7 @@ public class Options
     public int bufferLength { get; set; } = 1;
 
     public string baseLogUrl { get; set; } = "https://example.readme.com";
+
+    public bool fireAndForget { get; set; } = true;
   }
 }
diff --git a/packages/dotnet/ReadMe/HarJsonTranslationLogics/HarJsonBuilder.cs b/packages/dotnet/ReadMe/HarJsonTranslationLogics/HarJsonBuilder.cs
@@ -5,7 +5,6 @@
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Configuration;
-using Newtonsoft.Json;
 using ReadMe.HarJsonObjectModels;
 
 namespace ReadMe.HarJsonTranslationLogics
@@ -28,7 +27,7 @@ public HarJsonBuilder(RequestDelegate next, HttpContext context, IConfiguration
       this.configValues = configValues;
     }
 
-    public async Task<string> BuildHar()
+    internal async Task<Root> BuildHar()
     {
       Root harObj = new Root();
       harObj._id = Guid.NewGuid().ToString();
@@ -37,8 +36,7 @@ public async Task<string> BuildHar()
       harObj.clientIPAddress = this.context.Connection.RemoteIpAddress.ToString();
       harObj.group = this.BuildGroup();
       harObj.request = new RequestMain(await this.BuildLog());
-      string harJsonObj = JsonConvert.SerializeObject(new List<Root>() { harObj });
-      return harJsonObj;
+      return harObj;
     }
 
     private Group BuildGroup()

diff --git a/packages/dotnet/ReadMe/HarJsonTranslationLogics/ReadmeApiCaller.cs b/packages/dotnet/ReadMe/HarJsonTranslationLogics/ReadmeApiCaller.cs
@@ -7,16 +7,16 @@ namespace ReadMe.HarJsonTranslationLogics
 {
   class ReadMeApiCaller
   {
-    private readonly string harJsonObject;
+    private readonly string harJsonObjects;
     private readonly string apiKey;
 
-    public ReadMeApiCaller(string harJsonObject, string apiKey)
+    public ReadMeApiCaller(string harJsonObjects, string apiKey)
     {
-      this.harJsonObject = harJsonObject;
+      this.harJsonObjects = harJsonObjects;
       this.apiKey = apiKey;
     }
 
-    public void SendHarObjToReadMeApi()
+    public void SendHarObjToReadMeApi(bool fireAndForget)
     {
       try
       {
@@ -25,8 +25,15 @@ public void SendHarObjToReadMeApi()
         request.AddHeader("Content-Type", "application/json");
         string apiKey = "Basic " + Convert.ToBase64String(Encoding.UTF8.GetBytes(this.apiKey + ":"));
         request.AddHeader("Authorization", apiKey);
-        request.AddParameter("application/json", this.harJsonObject, ParameterType.RequestBody);
-        client.ExecuteAsync(request);
+        request.AddParameter("application/json", this.harJsonObjects, ParameterType.RequestBody);
+        if (fireAndForget)
+        {
+          client.ExecuteAsync(request);
+        }
+        else
+        {
+          client.Execute(request);
+        }
       }
       catch (Exception)
       {

diff --git a/packages/dotnet/ReadMe/Metrics.cs b/packages/dotnet/ReadMe/Metrics.cs
@@ -2,6 +2,7 @@
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Configuration;
+using Newtonsoft.Json;
 using ReadMe.HarJsonObjectModels;
 using ReadMe.HarJsonTranslationLogics;
 
@@ -11,12 +12,14 @@ public class Metrics
   {
     private readonly RequestDelegate next;
     private readonly IConfiguration configuration;
+    private readonly List<Root> harQueue;
     private Group group;
 
     public Metrics(RequestDelegate next, IConfiguration configuration)
     {
       this.next = next;
       this.configuration = configuration;
+      this.harQueue = new List<Root>();
     }
 
     public async Task InvokeAsync(HttpContext context)
@@ -44,9 +47,18 @@ public async Task InvokeAsync(HttpContext context)
             context.Request.EnableBuffering();
             HarJsonBuilder harJsonBuilder = new HarJsonBuilder(this.next, context, this.configuration, configValues);
 
-            string harJsonObj = await harJsonBuilder.BuildHar();
-            ReadMeApiCaller readmeApiCaller = new ReadMeApiCaller(harJsonObj, configValues.apiKey);
-            readmeApiCaller.SendHarObjToReadMeApi();
+            var harObj = await harJsonBuilder.BuildHar();
+            lock (this.harQueue)
+            {
+              this.harQueue.Add(harObj);
+              if (this.harQueue.Count >= configValues.options.bufferLength)
+              {
+                string serializaedHars = JsonConvert.SerializeObject(this.harQueue);
+                ReadMeApiCaller readmeApiCaller = new ReadMeApiCaller(serializaedHars, configValues.apiKey);
+                readmeApiCaller.SendHarObjToReadMeApi(configValues.options.fireAndForget);
+                this.harQueue.Clear();
+              }
+            }
           }
           else
           {
@@ -114,6 +126,11 @@ private ConfigValues GetConfigValues()
         optionsObj.baseLogUrl = options.GetSection("baseLogUrl").Value;
       }
 
+      if (options.GetSection("fireAndForget").Value != null)
+      {
+        optionsObj.fireAndForget = bool.Parse(options.GetSection("fireAndForget").Value);
+      }
+
       configValues.options = optionsObj;
       return configValues;
     }

diff --git a/packages/node/package.json b/packages/node/package.json
@@ -71,6 +71,6 @@
   "prettier": "@readme/eslint-config/prettier",
   "optionalDependencies": {
     "pino": "^9.3.2",
-    "pino-pretty": "^11.2.2"
+    "pino-pretty": "^13.0.0"
   }
 }