propro-utils 1.4.25 → 1.4.26

package/utils/redis.test.js

@@ -0,0 +1,117 @@
+const { getOrSetCache } = require('./redis');
+
+let client;
+
+jest.mock('redis', () => {
+  return {
+    createClient: jest.fn().mockReturnValue({
+      connect: jest.fn().mockResolvedValue(),
+      get: jest.fn(),
+      setex: jest.fn(),
+      quit: jest.fn().mockResolvedValue(),
+    }),
+  };
+});
+
+const mockGet = jest.fn();
+const mockSetEx = jest.fn();
+const redisClient = {
+  get: mockGet,
+  setEx: mockSetEx,
+};
+
+describe('getOrSetCache', () => {
+  beforeEach(() => {
+    mockGet.mockReset();
+    mockSetEx.mockReset();
+  });
+
+  it('should return cached value if available (cache hit)', async () => {
+    const key = 'testKey';
+    const cachedValue = { foo: 'bar' };
+    mockGet.mockResolvedValue(JSON.stringify(cachedValue));
+
+    const service = jest.fn();
+
+    const result = await getOrSetCache(redisClient, key, service);
+
+    expect(mockGet).toHaveBeenCalledWith(key);
+    expect(service).not.toHaveBeenCalled();
+    expect(result).toEqual(cachedValue);
+  });
+
+  it('should fetch and cache value if not available in cache (cache miss)', async () => {
+    const key = 'testKey';
+    const valueToCache = { foo: 'bar' };
+    mockGet.mockResolvedValue(null);
+    mockSetEx.mockResolvedValue('OK');
+
+    const service = jest.fn().mockResolvedValue(valueToCache);
+
+    const result = await getOrSetCache(redisClient, key, service);
+
+    expect(mockGet).toHaveBeenCalledWith(key);
+    expect(service).toHaveBeenCalled();
+    expect(mockSetEx).toHaveBeenCalledWith(
+      key,
+      1800,
+      JSON.stringify(valueToCache)
+    );
+    expect(result).toEqual(valueToCache);
+  });
+
+  it('should throw an error if the service function throws', async () => {
+    const key = 'testKey';
+    const error = new Error('Service error');
+    mockGet.mockResolvedValue(null);
+
+    const service = jest.fn().mockRejectedValue(error);
+
+    await expect(getOrSetCache(redisClient, key, service)).rejects.toThrow(
+      'Service error'
+    );
+
+    expect(mockGet).toHaveBeenCalledWith(key);
+    expect(service).toHaveBeenCalled();
+    expect(mockSetEx).not.toHaveBeenCalled();
+  });
+
+  it('should throw an error if Redis get operation throws', async () => {
+    const key = 'testKey';
+    const error = new Error('Redis get error');
+    mockGet.mockRejectedValue(error);
+
+    const service = jest.fn();
+
+    await expect(getOrSetCache(redisClient, key, service)).rejects.toThrow(
+      'Redis get error'
+    );
+
+    expect(mockGet).toHaveBeenCalledWith(key);
+    expect(service).not.toHaveBeenCalled();
+    expect(mockSetEx).not.toHaveBeenCalled();
+  });
+
+  it('should throw an error if Redis setEx operation throws', async () => {
+    const key = 'testKey';
+    const valueToCache = { foo: 'bar' };
+    const error = new Error('Redis setEx error');
+    mockGet.mockResolvedValue(null);
+    mockSetEx.mockRejectedValue(error);
+
+    const service = jest.fn().mockResolvedValue(valueToCache);
+
+    await expect(getOrSetCache(redisClient, key, service)).rejects.toThrow(
+      'Redis setEx error'
+    );
+
+    expect(mockGet).toHaveBeenCalledWith(key);
+
+    expect(service).toHaveBeenCalled();
+    expect(mockSetEx).toHaveBeenCalledWith(
+      key,
+      1800,
+      JSON.stringify(valueToCache)
+    );
+  });
+});

package/utils/testUtils.js

@@ -0,0 +1,29 @@
+/**
+ * Creates a mock Express context for testing purposes.
+ *
+ * @param {string} path - The path for the mock request.
+ * @param {object} options - Additional options for the mock request.
+ * @param {object} options.cookies - The cookies for the mock request.
+ * @param {object} options.query - The query parameters for the mock request.
+ * @returns {object} - The mock Express context containing the request, response, and next objects.
+ */
+function createMockExpressContext(path, options = {}) {
+  const req = {
+    path,
+    cookies: options.cookies || {},
+    query: options.query || {},
+  };
+  const res = {
+    status: jest.fn().mockReturnThis(),
+    json: jest.fn().mockReturnThis(),
+    cookie: jest.fn().mockReturnThis(),
+    redirect: jest.fn().mockReturnThis(),
+  };
+  const next = jest.fn();
+
+  return { req, res, next };
+}
+
+module.exports = {
+  createMockExpressContext,
+};

package/.github/workflows/.deploy

@@ -1,31 +0,0 @@
-name: Publish to npm
-
-on:
-  push:
-    tags:
-      - "*"
-  pull_request:
-    branches:
-      - "*"
-
-jobs:
-  publish-npm:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js 18.x
-        uses: actions/setup-node@v1
-        with:
-          node-version: 18
-          registry-url: "https://registry.npmjs.org"
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Run tests
-        run: npm run test
-
-      - name: Publish to npm
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}