@khanacademy/wonder-blocks-data 13.0.11 → 14.0.0

package/src/util/__tests__/request-api.test.ts

@@ -1,176 +0,0 @@
-// eslint-disable-next-line import/no-unassigned-import
-import "jest-extended";
-import {jest as wsJest} from "@khanacademy/wonder-stuff-testing";
-import {Server} from "@khanacademy/wonder-blocks-core";
-import {RequestFulfillment} from "../request-fulfillment";
-import {RequestTracker} from "../request-tracking";
-
-import {
-    abortInflightRequests,
-    fetchTrackedRequests,
-    hasTrackedRequestsToBeFetched,
-} from "../request-api";
-
-describe("#fetchTrackedRequests", () => {
-    describe("when server-side", () => {
-        beforeEach(() => {
-            jest.spyOn(Server, "isServerSide").mockReturnValue(true);
-        });
-
-        it("should call RequestTracker.Default.fulfillTrackedRequests", () => {
-            // Arrange
-            const fulfillTrackedRequestsSpy = jest.spyOn(
-                RequestTracker.Default,
-                "fulfillTrackedRequests",
-            );
-
-            // Act
-            fetchTrackedRequests();
-
-            // Assert
-            expect(fulfillTrackedRequestsSpy).toHaveBeenCalled();
-        });
-
-        it("should return the response cache", async () => {
-            // Arrange
-            const responseCache: Record<string, any> = {};
-            jest.spyOn(
-                RequestTracker.Default,
-                "fulfillTrackedRequests",
-            ).mockResolvedValue(responseCache);
-
-            // Act
-            const result = await fetchTrackedRequests();
-
-            // Assert
-            expect(result).toBe(responseCache);
-        });
-    });
-
-    describe("when client-side", () => {
-        beforeEach(() => {
-            jest.spyOn(Server, "isServerSide").mockReturnValue(false);
-        });
-
-        wsJest.afterEachRestoreEnv("NODE_ENV");
-
-        describe("in production", () => {
-            it("should reject with error", async () => {
-                // Arrange
-                process.env.NODE_ENV = "production";
-
-                // Act
-                const result = fetchTrackedRequests();
-
-                // Assert
-                await expect(result).rejects.toThrowErrorMatchingInlineSnapshot(
-                    `"No CSR tracking"`,
-                );
-            });
-        });
-
-        describe("not in production", () => {
-            it("should reject with error", async () => {
-                // Arrange
-                process.env.NODE_ENV = "test";
-
-                // Act
-                const result = fetchTrackedRequests();
-
-                // Assert
-                await expect(result).rejects.toThrowErrorMatchingInlineSnapshot(
-                    `"Data requests are not tracked for fulfillment when when client-side"`,
-                );
-            });
-        });
-    });
-});
-
-describe("#hasTrackedRequestsToBeFetched", () => {
-    describe("when server-side", () => {
-        beforeEach(() => {
-            jest.spyOn(Server, "isServerSide").mockReturnValue(true);
-        });
-
-        it("should call RequestTracker.Default.hasUnfulfilledRequests", () => {
-            // Arrange
-            const hasUnfulfilledRequestsSpy = jest.spyOn(
-                RequestTracker.Default,
-                "hasUnfulfilledRequests",
-                "get",
-            );
-
-            // Act
-            hasTrackedRequestsToBeFetched();
-
-            // Assert
-            expect(hasUnfulfilledRequestsSpy).toHaveBeenCalled();
-        });
-
-        it("should return the boolean value from RequestTracker.Default.hasUnfulfilledRequests", () => {
-            // Arrange
-            jest.spyOn(
-                RequestTracker.Default,
-                "hasUnfulfilledRequests",
-                "get",
-            ).mockReturnValue(true);
-
-            // Act
-            const result = hasTrackedRequestsToBeFetched();
-
-            // Assert
-            expect(result).toBeTrue();
-        });
-    });
-
-    describe("when client-side", () => {
-        beforeEach(() => {
-            jest.spyOn(Server, "isServerSide").mockReturnValue(false);
-        });
-
-        wsJest.afterEachRestoreEnv("NODE_ENV");
-
-        describe("in production", () => {
-            it("should reject with error", () => {
-                // Arrange
-                process.env.NODE_ENV = "production";
-
-                // Act
-                const underTest = () => hasTrackedRequestsToBeFetched();
-
-                // Assert
-                expect(underTest).toThrowErrorMatchingInlineSnapshot(
-                    `"No CSR tracking"`,
-                );
-            });
-        });
-
-        describe("not in production", () => {
-            it("should reject with error", () => {
-                // Arrange
-                process.env.NODE_ENV = "test";
-
-                // Act
-                const underTest = () => hasTrackedRequestsToBeFetched();
-
-                // Assert
-                expect(underTest).toThrowErrorMatchingInlineSnapshot(
-                    `"Data requests are not tracked for fulfillment when when client-side"`,
-                );
-            });
-        });
-    });
-});
-
-describe("#abortInflightRequests", () => {
-    it("should call RequestFulfillment.Default.abortAll", () => {
-        // Arrange
-        const abortAllSpy = jest.spyOn(RequestFulfillment.Default, "abortAll");
-
-        // Act
-        abortInflightRequests();
-
-        // Assert
-        expect(abortAllSpy).toHaveBeenCalled();
-    });
-});

package/src/util/__tests__/request-fulfillment.test.ts

@@ -1,146 +0,0 @@
-import {RequestFulfillment} from "../request-fulfillment";
-import {DataError} from "../data-error";
-
-describe("RequestFulfillment", () => {
-    it("should provide static default instance", () => {
-        // Arrange
-
-        // Act
-        const defaultInstance = RequestFulfillment.Default;
-
-        // Assert
-        expect(defaultInstance).toBe(RequestFulfillment.Default);
-        expect(defaultInstance).toBeInstanceOf(RequestFulfillment);
-    });
-
-    describe("#fulfill", () => {
-        it("should resolve to an error result", async () => {
-            // Arrange
-            const requestFulfillment = new RequestFulfillment();
-            const fakeBadRequestHandler = () => Promise.reject("OH NO!");
-
-            // Act
-            const result = await requestFulfillment.fulfill("ID", {
-                handler: fakeBadRequestHandler,
-            });
-
-            // Assert
-            expect(result).toStrictEqual({
-                status: "error",
-                error: expect.any(DataError),
-            });
-        });
-
-        it("should resolve to an aborted result", async () => {
-            // Arrange
-            const requestFulfillment = new RequestFulfillment();
-            const abortError = new Error("abort abort abort, awoooga");
-            abortError.name = "AbortError";
-            const fakeBadRequestHandler = () => Promise.reject(abortError);
-
-            // Act
-            const result = await requestFulfillment.fulfill("ID", {
-                handler: fakeBadRequestHandler,
-            });
-
-            // Assert
-            expect(result).toStrictEqual({
-                status: "aborted",
-            });
-        });
-
-        it("should resolve to a data result", async () => {
-            // Arrange
-            const requestFulfillment = new RequestFulfillment();
-            const fakeRequestHandler = () => Promise.resolve("DATA!");
-
-            // Act
-            const result = await requestFulfillment.fulfill("ID", {
-                handler: fakeRequestHandler,
-            });
-
-            // Assert
-            expect(result).toStrictEqual({
-                status: "success",
-                data: "DATA!",
-            });
-        });
-
-        it("should reuse inflight requests", () => {
-            // Arrange
-            const requestFulfillment = new RequestFulfillment();
-            const fakeRequestHandler = () => Promise.resolve("DATA!");
-
-            // Act
-            const promise = requestFulfillment.fulfill("ID", {
-                handler: fakeRequestHandler,
-            });
-            const result = requestFulfillment.fulfill("ID", {
-                handler: fakeRequestHandler,
-            });
-
-            // Assert
-            expect(result).toBe(promise);
-        });
-
-        it("should remove inflight requests upon completion", async () => {
-            // Arrange
-            const requestFulfillment = new RequestFulfillment();
-            const fakeRequestHandler = () => Promise.resolve("DATA!");
-
-            // Act
-            const promise = requestFulfillment.fulfill("ID", {
-                handler: fakeRequestHandler,
-            });
-            await promise;
-            const result = requestFulfillment.fulfill("ID", {
-                handler: fakeRequestHandler,
-            });
-
-            // Assert
-            expect(result).not.toBe(promise);
-        });
-    });
-
-    describe("#abort", () => {
-        it("should delete the given request from the inflight requests", () => {
-            // Arrange
-            const requestFulfillment = new RequestFulfillment();
-            const fakeRequestHandler = () => Promise.resolve("DATA!");
-            const promise = requestFulfillment.fulfill("ID", {
-                handler: fakeRequestHandler,
-            });
-
-            // Act
-            requestFulfillment.abort("ID");
-            const result = requestFulfillment.fulfill("ID", {
-                handler: fakeRequestHandler,
-            });
-
-            // Assert
-            expect(result).not.toBe(promise);
-        });
-    });
-
-    describe("#abortAll", () => {
-        it("should abort all inflight requests", () => {
-            // Arrange
-            const requestFulfillment = new RequestFulfillment();
-            const abortSpy = jest.spyOn(requestFulfillment, "abort");
-            const fakeRequestHandler = () => Promise.resolve("DATA!");
-            requestFulfillment.fulfill("ID1", {
-                handler: fakeRequestHandler,
-            });
-            requestFulfillment.fulfill("ID2", {
-                handler: fakeRequestHandler,
-            });
-
-            // Act
-            requestFulfillment.abortAll();
-
-            // Assert
-            expect(abortSpy).toHaveBeenCalledWith("ID1");
-            expect(abortSpy).toHaveBeenCalledWith("ID2");
-        });
-    });
-});

package/src/util/__tests__/request-tracking.test.tsx

@@ -1,321 +0,0 @@
-import * as React from "react";
-import {render} from "@testing-library/react";
-
-import {Server} from "@khanacademy/wonder-blocks-core";
-import {RequestTracker, TrackerContext} from "../request-tracking";
-import {SsrCache} from "../ssr-cache";
-
-describe("../request-tracking.js", () => {
-    describe("TrackerContext", () => {
-        it("should default to null", async () => {
-            // Arrange
-
-            // Act
-            const result = await new Promise((resolve: any, reject: any) => {
-                render(
-                    <TrackerContext.Consumer>
-                        {(fn: any) => resolve(fn)}
-                    </TrackerContext.Consumer>,
-                );
-            });
-
-            // Assert
-            expect(result).toBeNull();
-        });
-    });
-
-    describe("RequestTracker", () => {
-        beforeEach(() => {
-            jest.spyOn(Server, "isServerSide").mockReturnValue(true);
-        });
-
-        const createRequestTracker = () =>
-            /**
-             * We pass our own response cache instance so that the test cases
-             * are not sharing the same default instance.
-             */
-            new RequestTracker(new SsrCache());
-
-        describe("@Default", () => {
-            it("should return an instance of RequestTracker", () => {
-                // Arrange
-
-                // Act
-                const result = RequestTracker.Default;
-
-                // Assert
-                expect(result).toBeInstanceOf(RequestTracker);
-            });
-
-            it("should return the same instance on each call", () => {
-                // Arrange
-
-                // Act
-                const result1 = RequestTracker.Default;
-                const result2 = RequestTracker.Default;
-
-                // Assert
-                expect(result1).toBe(result2);
-            });
-        });
-
-        describe("#trackDataRequest", () => {
-            it("should track a request", async () => {
-                // Arrange
-                const requestTracker = new RequestTracker();
-                const fakeHandler = jest.fn();
-
-                // Act
-                requestTracker.trackDataRequest("ID", fakeHandler, false);
-                await requestTracker.fulfillTrackedRequests();
-
-                // Assert
-                expect(fakeHandler).toHaveBeenCalledTimes(1);
-            });
-
-            it("should track each matching request once", async () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-                const fakeHandler = jest.fn().mockResolvedValue("DATA");
-
-                // Act
-                requestTracker.trackDataRequest("ID", fakeHandler, true);
-                requestTracker.trackDataRequest("ID", fakeHandler, true);
-                await requestTracker.fulfillTrackedRequests();
-
-                // Assert
-                expect(fakeHandler).toHaveBeenCalledTimes(1);
-            });
-        });
-
-        describe("#hasUnfulfilledRequests", () => {
-            it("should return false if no requests have been tracked", () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-
-                // Act
-                const result = requestTracker.hasUnfulfilledRequests;
-
-                // Assert
-                expect(result).toBe(false);
-            });
-
-            it("should return true if there are requests waiting to be fulfilled", () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-                const fakeHandler = jest.fn();
-                requestTracker.trackDataRequest("ID", fakeHandler, true);
-
-                // Act
-                const result = requestTracker.hasUnfulfilledRequests;
-
-                // Assert
-                expect(result).toBe(true);
-            });
-
-            it("should return false if all tracked requests have been fulfilled", () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-                const fakeHandler = jest.fn().mockResolvedValue(5);
-                requestTracker.trackDataRequest("ID", fakeHandler, false);
-                requestTracker.fulfillTrackedRequests();
-
-                // Act
-                const result = requestTracker.hasUnfulfilledRequests;
-
-                // Assert
-                expect(result).toBe(false);
-            });
-        });
-
-        describe("#fulfillTrackedRequests", () => {
-            it("should return an empty cache if no requests tracked", async () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-
-                // Act
-                const result = await requestTracker.fulfillTrackedRequests();
-
-                // Assert
-                expect(result).toStrictEqual({});
-            });
-
-            it("should cache errors caused directly by handlers", async () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-                const fakeBadHandler = () => {
-                    throw new Error("OH NO!");
-                };
-                requestTracker.trackDataRequest("ID", fakeBadHandler, true);
-
-                // Act
-                const result = await requestTracker.fulfillTrackedRequests();
-
-                // Assert
-                expect(result).toStrictEqual({
-                    ID: {
-                        error: "OH NO!",
-                    },
-                });
-            });
-
-            it("should cache errors occurring in promises", async () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-                const fakeBadRequestHandler = (): Promise<any> =>
-                    new Promise((resolve: any, reject: any) =>
-                        reject("OH NO!"),
-                    );
-                requestTracker.trackDataRequest(
-                    "ID",
-                    fakeBadRequestHandler,
-                    true,
-                );
-                // Act
-                const result = await requestTracker.fulfillTrackedRequests();
-
-                // Assert
-                expect(result).toStrictEqual({
-                    ID: {
-                        error: "Request failed",
-                    },
-                });
-            });
-
-            it("should cache data and errors for all requests", async () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-                /**
-                 * We're going to check a few things here:
-                 * - Handlers that crash when making the request
-                 * - Handlers that reject the promise
-                 * - Handlers that resolve
-                 */
-                const fakeBadRequestHandler = (): Promise<any> =>
-                    new Promise((resolve: any, reject: any) =>
-                        reject("OH NO!"),
-                    );
-                const fakeBadHandler = (): Promise<any> => {
-                    throw new Error("OH NO!");
-                };
-                const fakeValidHandler = ((): (() => Promise<any>) => {
-                    let counter = 0;
-                    return () => {
-                        counter++;
-                        return Promise.resolve(`DATA:${counter}`);
-                    };
-                })();
-                requestTracker.trackDataRequest(
-                    "BAD_REQUEST",
-                    fakeBadRequestHandler,
-                    true,
-                );
-                requestTracker.trackDataRequest(
-                    "BAD_HANDLER",
-                    fakeBadHandler,
-                    true,
-                );
-                requestTracker.trackDataRequest(
-                    "VALID_HANDLER1",
-                    fakeValidHandler,
-                    true,
-                );
-                requestTracker.trackDataRequest(
-                    "VALID_HANDLER2",
-                    fakeValidHandler,
-                    true,
-                );
-
-                // Act
-                const result = await requestTracker.fulfillTrackedRequests();
-
-                // Assert
-                expect(result).toStrictEqual({
-                    BAD_REQUEST: {
-                        error: "Request failed",
-                    },
-                    BAD_HANDLER: {
-                        error: "OH NO!",
-                    },
-                    VALID_HANDLER1: {
-                        data: "DATA:1",
-                    },
-                    VALID_HANDLER2: {
-                        data: "DATA:2",
-                    },
-                });
-            });
-
-            it("should ignore loading results", async () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-                jest.spyOn(
-                    requestTracker._requestFulfillment,
-                    "fulfill",
-                ).mockResolvedValue({status: "loading"});
-                const fakeValidHandler = () =>
-                    Promise.reject(new Error("Not called for this test case"));
-                requestTracker.trackDataRequest("ID", fakeValidHandler, true);
-
-                // Act
-                const result = await requestTracker.fulfillTrackedRequests();
-
-                // Assert
-                expect(result).toStrictEqual({});
-            });
-
-            it("should ignore aborted results", async () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-                jest.spyOn(
-                    requestTracker._requestFulfillment,
-                    "fulfill",
-                ).mockResolvedValue({status: "aborted"});
-                const fakeValidHandler = () =>
-                    Promise.reject(new Error("Not called for this test case"));
-                requestTracker.trackDataRequest("ID", fakeValidHandler, false);
-
-                // Act
-                const result = await requestTracker.fulfillTrackedRequests();
-
-                // Assert
-                expect(result).toStrictEqual({});
-            });
-
-            it("should clear the tracked requests", async () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-                const fakeStaticHandler = jest.fn(() =>
-                    Promise.resolve("DATA"),
-                );
-                requestTracker.trackDataRequest("1", fakeStaticHandler, true);
-                requestTracker.trackDataRequest("2", fakeStaticHandler, true);
-                requestTracker.trackDataRequest("3", fakeStaticHandler, true);
-
-                // Act
-                await requestTracker.fulfillTrackedRequests();
-                fakeStaticHandler.mockClear();
-                await requestTracker.fulfillTrackedRequests();
-
-                // Assert
-                expect(fakeStaticHandler).not.toHaveBeenCalled();
-            });
-        });
-
-        describe("#reset", () => {
-            it("should clear the tracked data requests", async () => {
-                // Arrange
-                const requestTracker = createRequestTracker();
-                const fakeHandler = jest.fn().mockResolvedValue("DATA");
-                requestTracker.trackDataRequest("ID", fakeHandler, true);
-
-                // Act
-                requestTracker.reset();
-                await requestTracker.fulfillTrackedRequests();
-
-                // Assert
-                expect(fakeHandler).not.toHaveBeenCalled();
-            });
-        });
-    });
-});