chore: add coveralls coverage report (#42)

* chore: set read permission

* chore: add istanbul vitest

* chore: generate coverage lcov report file

* test: add userBrowserNotification test

Author: peppescg

Diff for: .github/workflows/_security-checks.yml

@@ -1,6 +1,8 @@
 name: Security Checks
 on:
   workflow_call:
+permissions:
+  contents: read    
 jobs:
   trivy:
     name: Trivy

Diff for: .github/workflows/_static-checks.yml

@@ -1,6 +1,8 @@
 name: Static Checks
 on:
   workflow_call:
+permissions:
+      contents: read
 jobs:
   lint:
     name: ESLint Check

Diff for: .github/workflows/_unit-tests.yml

@@ -15,3 +15,8 @@ jobs:
 
       - name: Run tests
         run: npm run test:coverage
+      
+      - name: Send coverage to Coveralls
+        uses: coverallsapp/github-action@cfd0633edbd2411b532b808ba7a8b5e04f76d2c8 #v2.3.4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

Diff for: package-lock.json

@@ -52,7 +52,7 @@
     "@types/react": "^19.0.2",
     "@types/react-dom": "^19.0.2",
     "@vitejs/plugin-react-swc": "^3.5.0",
-    "@vitest/coverage-istanbul": "^2.1.4",
+    "@vitest/coverage-istanbul": "^2.1.8",
     "@vitest/expect": "^2.1.4",
     "@vitest/ui": "^2.1.4",
     "autoprefixer": "^10.4.20",

Diff for: package.json

@@ -0,0 +1,57 @@
+import { renderHook } from "@testing-library/react";
+import { vi } from "vitest";
+import { useBrowserNotification } from "../useBrowserNotification";
+
+describe("useBrowserNotification", () => {
+  let mockRequestPermission: (
+    deprecatedCallback?: NotificationPermissionCallback | undefined,
+  ) => Promise<NotificationPermission>;
+  let mockNotification: ReturnType<typeof vi.fn>;
+
+  beforeAll(() => {
+    mockRequestPermission = vi.fn();
+    mockNotification = vi.fn();
+
+    global.Notification = vi.fn(
+      (title: string, options?: NotificationOptions) => {
+        mockNotification(title, options);
+        return {};
+      },
+    ) as unknown as typeof Notification;
+
+    Object.defineProperty(global.Notification, "permission", {
+      value: "default",
+      writable: true,
+    });
+    global.Notification.requestPermission = mockRequestPermission;
+  });
+
+  it("should request the permission for notification", () => {
+    renderHook(() => useBrowserNotification());
+    expect(mockRequestPermission).toHaveBeenCalled();
+  });
+
+  it("should send a notification if permission is granted", () => {
+    Object.defineProperty(global.Notification, "permission", {
+      value: "granted",
+    });
+
+    const { result } = renderHook(() => useBrowserNotification());
+    result.current.sendNotification("title", { body: "body" });
+
+    expect(mockNotification).toHaveBeenCalledWith("title", {
+      body: "body",
+    });
+  });
+
+  it("should not send a notification if permission is denied", () => {
+    Object.defineProperty(global.Notification, "permission", {
+      value: "denied",
+    });
+
+    const { result } = renderHook(() => useBrowserNotification());
+    result.current.sendNotification("title", { body: "body" });
+
+    expect(mockNotification).not.toHaveBeenCalled();
+  });
+});

Diff for: src/hooks/__tests__/useBrowserNotification.test.ts

@@ -17,7 +17,5 @@ export function useBrowserNotification() {
     requestPermission();
   }, []);
 
-
-
   return { sendNotification };
 }

Diff for: src/hooks/useBrowserNotification.ts

@@ -55,7 +55,7 @@ export default defineConfig({
       },
       enabled: false,
       provider: "istanbul",
-      reporter: ["text", "json", "html", "json-summary", "lcov"],
+      reporter: ["text", "lcov"],
     },
   },
 });