lens/src/common/utils/with-orphan-promise/with-orphan-promise.test.ts

/**
 * Copyright (c) OpenLens Authors. All rights reserved.
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */
import type { AsyncFnMock } from "@async-fn/jest";
import asyncFn from "@async-fn/jest";
import { getDiForUnitTesting } from "../../../main/getDiForUnitTesting";
import loggerInjectable from "../../logger.injectable";
import type { Logger } from "../../logger";
import withOrphanPromiseInjectable from "./with-orphan-promise";

describe("with orphan promise, when called", () => {
  let toBeDecorated: AsyncFnMock<(arg1: string, arg2: string) => Promise<string>>;
  let actual: void;
  let loggerStub: Logger;

  beforeEach(() => {
    const di = getDiForUnitTesting({ doGeneralOverrides: true });

    di.register(withOrphanPromiseInjectable);

    loggerStub = { error: jest.fn() } as unknown as Logger;

    di.override(loggerInjectable, () => loggerStub);

    const withOrphanPromise = di.inject(withOrphanPromiseInjectable);

    toBeDecorated = asyncFn();

    const decorated = withOrphanPromise(toBeDecorated);

    actual = decorated("some-argument", "some-other-argument");
  });

  it("calls decorated with arguments", () => {
    expect(toBeDecorated).toHaveBeenCalledWith("some-argument", "some-other-argument");
  });

  it("given promise returned by decorated has not been fulfilled yet, already returns nothing", () => {
    expect(actual).toBeUndefined();
  });

  it("when decorated function resolves, nothing happens", async () => {
    await toBeDecorated.resolve("irrelevant");
    // Note: there is no expect, test is here only for documentation.
  });

  describe("when decorated function rejects", () => {
    beforeEach(async () => {
      await toBeDecorated.reject("some-error");
    });

    it("logs the rejection", () => {
      expect(loggerStub.error).toHaveBeenCalledWith("Orphan promise rejection encountered", "some-error");
    });

    it("nothing else happens", () => {
      // Note: there is no expect, test is here only for documentation.
    });
  });
});