feat: adding redis APL

.changeset/ninety-otters-clap.md

@@ -0,0 +1,5 @@
+---
+"@saleor/app-sdk": minor
+---
+
+Adding REDIS as APL provider

package.json

@@ -25,7 +25,8 @@
     "graphql": ">=16.6.0",
     "next": ">=12",
     "react": ">=17",
-    "react-dom": ">=17"
+    "react-dom": ">=17",
+    "redis": ">=4"
   },
   "dependencies": {
     "@opentelemetry/api": "^1.7.0",
@@ -70,6 +71,7 @@
     "prettier": "2.7.1",
     "react": "^18.2.0",
     "react-dom": "18.2.0",
+    "redis": "^4.7.0",
     "tsm": "^2.2.2",
     "tsup": "^6.2.3",
     "typescript": "4.9.5",
@@ -80,6 +82,9 @@
   "peerDependenciesMeta": {
     "@vercel/kv": {
       "optional": true
+    },
+    "redis": {
+      "optional": true
     }
   },
   "lint-staged": {
@@ -98,6 +103,11 @@
       "import": "./APL/index.mjs",
       "require": "./APL/index.js"
     },
+    "./APL/redis": {
+      "types": "./APL/redis/index.d.ts",
+      "import": "./APL/redis/index.mjs",
+      "require": "./APL/redis/index.js"
+    },
     "./APL/vercel-kv": {
       "types": "./APL/vercel-kv/index.d.ts",
       "import": "./APL/vercel-kv/index.mjs",

src/APL/redis/index.ts

@@ -0,0 +1,3 @@
+import { RedisAPL } from "./redis-apl";
+
+export { RedisAPL };

src/APL/redis/redis-apl.test.ts

@@ -0,0 +1,197 @@
+import { createClient } from "redis";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+import { AuthData } from "../apl";
+import { RedisAPL } from "./redis-apl";
+
+// Create a variable to control the connection state
+let isRedisOpen = false;
+
+// Create properly typed mock functions
+const mockHGet = vi.fn().mockResolvedValue(undefined);
+const mockHSet = vi.fn().mockResolvedValue(1);
+const mockHDel = vi.fn().mockResolvedValue(1);
+const mockHGetAll = vi.fn().mockResolvedValue({});
+const mockPing = vi.fn().mockResolvedValue("PONG");
+const mockConnect = vi.fn().mockImplementation(async () => {
+  isRedisOpen = true;
+});
+const mockDisconnect = vi.fn().mockImplementation(async () => {
+  isRedisOpen = false;
+});
+
+const mockRedisClient = {
+  connect: mockConnect,
+  ping: mockPing,
+  hGet: mockHGet,
+  hSet: mockHSet,
+  hDel: mockHDel,
+  hGetAll: mockHGetAll,
+  get isOpen() {
+    return isRedisOpen;
+  },
+  disconnect: mockDisconnect,
+  isReady: false,
+};
+
+vi.mock("redis", () => ({
+  createClient: vi.fn(() => mockRedisClient),
+}));
+
+describe("RedisAPL", () => {
+  const mockHashKey = "test_hash_key";
+  const mockAuthData: AuthData = {
+    token: "test-token",
+    saleorApiUrl: "https://test-store.saleor.cloud/graphql/",
+    appId: "test-app-id",
+  };
+
+  let apl: RedisAPL;
+
+  beforeEach(() => {
+    apl = new RedisAPL({
+      client: mockRedisClient,
+      hashCollectionKey: mockHashKey,
+    });
+    vi.clearAllMocks();
+    isRedisOpen = false;
+  });
+
+  afterEach(async () => {
+    if (mockRedisClient.isOpen) {
+      await mockRedisClient.disconnect();
+    }
+    vi.clearAllMocks();
+  });
+
+  describe("constructor", () => {
+    it("uses provided hash key", async () => {
+      const customHashKey = "custom_hash";
+      const customApl = new RedisAPL({
+        client: mockRedisClient,
+        hashCollectionKey: customHashKey,
+      });
+
+      await customApl.get(mockAuthData.saleorApiUrl);
+      expect(mockRedisClient.hGet).toHaveBeenCalledWith(customHashKey, mockAuthData.saleorApiUrl);
+    });
+
+    it("uses default hash key when not provided", async () => {
+      const defaultApl = new RedisAPL({
+        client: mockRedisClient,
+      });
+
+      await defaultApl.get(mockAuthData.saleorApiUrl);
+      expect(mockRedisClient.hGet).toHaveBeenCalledWith(
+        "saleor_app_auth",
+        mockAuthData.saleorApiUrl
+      );
+    });
+  });
+
+  describe("get", () => {
+    it("returns undefined when no data found", async () => {
+      mockHGet.mockResolvedValueOnce(null);
+      const result = await apl.get(mockAuthData.saleorApiUrl);
+      expect(result).toBeUndefined();
+      expect(mockConnect).toHaveBeenCalled();
+    });
+
+    it("returns parsed auth data when found", async () => {
+      mockHGet.mockResolvedValueOnce(JSON.stringify(mockAuthData));
+      const result = await apl.get(mockAuthData.saleorApiUrl);
+      expect(result).toEqual(mockAuthData);
+      expect(mockHGet).toHaveBeenCalledWith(mockHashKey, mockAuthData.saleorApiUrl);
+    });
+
+    it("throws error when Redis operation fails", async () => {
+      mockHGet.mockRejectedValueOnce(new Error("Redis error"));
+      await expect(apl.get(mockAuthData.saleorApiUrl)).rejects.toThrow("Redis error");
+    });
+  });
+
+  describe("set", () => {
+    it("successfully sets auth data", async () => {
+      mockHSet.mockResolvedValueOnce(1);
+      await apl.set(mockAuthData);
+      expect(mockHSet).toHaveBeenCalledWith(
+        mockHashKey,
+        mockAuthData.saleorApiUrl,
+        JSON.stringify(mockAuthData)
+      );
+    });
+
+    it("throws error when Redis operation fails", async () => {
+      mockHSet.mockRejectedValueOnce(new Error("Redis error"));
+      await expect(apl.set(mockAuthData)).rejects.toThrow("Redis error");
+    });
+  });
+
+  describe("delete", () => {
+    it("successfully deletes auth data", async () => {
+      mockHDel.mockResolvedValueOnce(1);
+      await apl.delete(mockAuthData.saleorApiUrl);
+      expect(mockHDel).toHaveBeenCalledWith(mockHashKey, mockAuthData.saleorApiUrl);
+    });
+
+    it("throws error when Redis operation fails", async () => {
+      mockHDel.mockRejectedValueOnce(new Error("Redis error"));
+      await expect(apl.delete(mockAuthData.saleorApiUrl)).rejects.toThrow("Redis error");
+    });
+  });
+
+  describe("getAll", () => {
+    it("returns all auth data", async () => {
+      const mockAllData = {
+        [mockAuthData.saleorApiUrl]: JSON.stringify(mockAuthData),
+      };
+      mockHGetAll.mockResolvedValueOnce(mockAllData);
+      const result = await apl.getAll();
+      expect(result).toEqual([mockAuthData]);
+    });
+
+    it("throws error when Redis operation fails", async () => {
+      mockHGetAll.mockRejectedValueOnce(new Error("Redis error"));
+      await expect(apl.getAll()).rejects.toThrow("Redis error");
+    });
+  });
+
+  describe("isReady", () => {
+    it("returns ready true when Redis is connected", async () => {
+      mockPing.mockResolvedValueOnce("PONG");
+      const result = await apl.isReady();
+      expect(result).toEqual({ ready: true });
+    });
+
+    it("returns ready false with error when Redis is not connected", async () => {
+      mockPing.mockRejectedValueOnce(new Error("Connection failed"));
+      const result = await apl.isReady();
+      expect(result).toEqual({ ready: false, error: new Error("Connection failed") });
+    });
+  });
+
+  describe("isConfigured", () => {
+    it("returns configured true when Redis is connected", async () => {
+      mockPing.mockResolvedValueOnce("PONG");
+      const result = await apl.isConfigured();
+      expect(result).toEqual({ configured: true });
+    });
+
+    it("returns configured false with error when Redis is not connected", async () => {
+      mockPing.mockRejectedValueOnce(new Error("Connection failed"));
+      const result = await apl.isConfigured();
+      expect(result).toEqual({ configured: false, error: new Error("Connection failed") });
+    });
+  });
+
+  /**
+   * Type compatibility test with real Redis client
+   */
+  describe("RedisAPL type compatibility", () => {
+    it("should accept Redis client type", () => {
+      const client = createClient();
+      // This test is just for TypeScript to verify the types
+      expect(() => new RedisAPL({ client, hashCollectionKey: "test" })).not.toThrow();
+    });
+  });
+});