logflare-transport-core - npm Package Compare versions

Comparing version 0.3.0-3f3ffeaf to 0.3.0-4c8220fd

package.json

 {
   "name": "logflare-transport-core",
-  "version": "0.3.0-3f3ffeaf",
+  "version": "0.3.0-4c8220fd",
   "description": "A common core for Logflare javascript transports.",
@@ -5,0 +5,0 @@ "keywords": [

src/http_client.ts

@@ -12,2 +12,10 @@ interface IngestTransformsI {
     fromBrowser?: boolean
+    onError?:
+        | ((
+              payload: {
+                  batch: object[]
+              },
+              err: Error
+          ) => void)
+        | undefined
 }
@@ -38,2 +46,13 @@
     protected readonly apiBaseUrl: string
+    /**
+     * onError takes in an optional callback function to handle any errors returned by logflare
+     */
+    protected readonly onError?:
+        | ((
+              payload: {
+                  batch: object[]
+              },
+              err: Error
+          ) => void)
+        | undefined
 
@@ -54,2 +73,3 @@ public constructor(options: LogflareUserOptionsI) {
         this.apiBaseUrl = options.apiBaseUrl || defaultOptions.apiBaseUrl
+        this.onError = options.onError
     }
@@ -96,3 +116,3 @@
         } catch (e) {
-            if (e) {
+            if (e && e instanceof Error) {
                 if (e instanceof NetworkError && e.response) {
@@ -104,5 +124,6 @@ console.error(
                     )
-                } else if (e instanceof Error) {
+                } else {
                     console.error(e.message)
                 }
+                this.onError?.(payload, e)
             }
@@ -109,0 +130,0 @@

src/main.test.js

@@ -10,6 +10,14 @@ import {LogflareHttpClient} from "./main"
     let httpClient
+    let httpClientOnError
     let nativeFetch
+    let consoleErrorData = []
+    const storeLog = (inputs) => consoleErrorData.push(inputs)
+    const onErrorCallback = jest.fn((payload, err) => {
+        console.error(payload)
+        console.error(err)
+    })
 
     beforeAll(() => {
         nativeFetch = global.fetch
+        console["error"] = jest.fn(storeLog)
     })
@@ -23,2 +31,8 @@
         })
+        httpClientOnError = new LogflareHttpClient({
+            apiKey: testApiKey,
+            sourceToken: testSourceToken,
+            apiBaseUrl: "http://non-existing.domain",
+            onError: onErrorCallback,
+        })
     })
@@ -28,2 +42,3 @@
         global.fetch.mockClear()
+        consoleErrorData = []
     })
@@ -61,8 +76,5 @@
 
-    let consoleLogData = ""
-    const storeLog = (inputs) => (consoleLogData += inputs)
     it("prints to console on error", async () => {
         const errorResponse = {message: "Schema validation error"}
 
-        console["error"] = jest.fn(storeLog)
         global.fetch = jest.fn(() =>
@@ -79,3 +91,3 @@ Promise.resolve({
         await httpClient.addLogEvent(le)
-        expect(consoleLogData).toBe(
+        expect(consoleErrorData[0]).toBe(
             `Logflare API request failed with 406 status: ${JSON.stringify(
@@ -86,2 +98,30 @@ errorResponse
     })
+
+    it("invoke onError callback on error", async () => {
+        const errorResponse = {message: "Schema validation error"}
+
+        global.fetch = jest.fn(() =>
+            Promise.resolve({
+                json: () => Promise.resolve(errorResponse),
+                ok: false,
+                status: 406,
+            })
+        )
+
+        const le = {message: "info log msg", metadata: {p1: "v1"}}
+
+        await httpClientOnError.addLogEvent(le)
+        const [message, payload, err] = consoleErrorData
+        expect(message).toBe(
+            `Logflare API request failed with 406 status: ${JSON.stringify(
+                errorResponse
+            )}`
+        )
+        expect(onErrorCallback).toHaveBeenCalledTimes(1)
+        expect(payload).toStrictEqual({
+            batch: [le],
+        })
+        expect(err.message).toMatch(/Network response was not ok for/)
+        expect(err.data).toBe(errorResponse)
+    })
 })

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Number of medium quality alerts

0

decreased by-100%

Number of lines in readme file

10

increased byInfinity%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

17138

decreased by-35.35%

Number of package files

11

decreased by-21.43%

Lines of code

327

decreased by-29.83%

No dependency changes