convex/src/browser/sync/client.test.ts

Client for the Convex Cloud

/**
 * @vitest-environment custom-vitest-environment.ts
 */

import { test, expect } from "vitest";

import { BaseConvexClient, BaseConvexClientInterface } from "./client.js";
import { anyApi } from "../../server/api.js";

// Compile-time assertion that `BaseConvexClient` satisfies
// `BaseConvexClientInterface`. We can't use an `implements` clause on the class
// because `BaseConvexClientInterface` is `@internal`: that would leak the
// interface name into the public `.d.ts` where it has been stripped.
const _assertBaseConvexClientImplementsInterface: BaseConvexClientInterface =
  undefined as unknown as BaseConvexClient;

test("localQueryResult reflects optimistic results", async () => {
  const client = new BaseConvexClient("http://127.0.0.1:8000", () => {
    // ignore updates.
  });

  expect(client.localQueryResult("myUdf", {})).toBeUndefined();

  // don't wait for mutation to complete
  void client.mutation(
    "myUdf",
    {},
    {
      optimisticUpdate: (localQueryStore) => {
        localQueryStore.setQuery(anyApi.myUdf.default, {}, true);
      },
    },
  );
  expect(client.localQueryResult("myUdf", {})).toBe(true);
});

test("Client warns when old clientConfig format is used", async () => {
  expect(() => {
    new BaseConvexClient(
      { address: "http://127.0.0.1:8000" } as any,
      () => null,
    );
  }).toThrow("no longer supported");
});