convex 1.42.0 → 1.42.2-alpha.0

package/src/react/client.ts

@@ -287,7 +287,22 @@ export interface MutationOptions<Args extends Record<string, Value>> {
  *
  * @public
  */
-export interface ConvexReactClientOptions extends BaseConvexClientOptions {}
+export interface ConvexReactClientOptions extends BaseConvexClientOptions {
+  /**
+   * An already-constructed {@link BaseConvexClient} to use instead of
+   * constructing one internally. When provided, this client (and its
+   * derived {@link PaginatedQueryClient}) is used for all operations.
+   *
+   * @internal
+   */
+  baseClient?: BaseConvexClient;
+
+  // FIXME: Ideally we define `ConvexReactClientOptions` as
+  // `type ConvexReactClientOptions = BaseConvexClientOptions | { baseClient: BaseConvexClient }`
+  // so that callers won’t try to set `BaseConvexClientOptions` attributes that are ineffective.
+  // But since `baseClient` is internal at the moment, I don’t think we can do that.
+  // We can fix this if we ever make `baseClient` public.
+}
 
 /**
  * A Convex client for use within React.
@@ -367,11 +382,13 @@ export class ConvexReactClient {
       return this.cachedSync;
     }
     // BaseConvexClient and paginated query client are always created together.
-    this.cachedSync = new BaseConvexClient(
-      this.address,
-      () => {}, // Use the PaginatedQueryClient's transition instead.
-      this.options,
-    );
+    this.cachedSync =
+      this.options.baseClient ??
+      new BaseConvexClient(
+        this.address,
+        () => {}, // Use the PaginatedQueryClient's transition instead.
+        this.options,
+      );
     if (this.adminAuth) {
       this.cachedSync.setAdminAuth(this.adminAuth, this.fakeUserIdentity);
     }

package/src/react/client_provided_base_client.test.tsx

@@ -0,0 +1,56 @@
+import { test, expect, describe, vi } from "vitest";
+import ws from "ws";
+
+import { ConvexReactClient } from "./client.js";
+import { anyApi } from "../server/api.js";
+import { BaseConvexClient } from "../browser/index.js";
+
+const address = "https://127.0.0.1:3001";
+
+// A minimal subclass of `BaseConvexClient` used to prove that a
+// caller-provided `BaseConvexClient` (of any subclass) can be plugged into a
+// `ConvexReactClient` via the `client` option.
+class MinimalBaseConvexClient extends BaseConvexClient {}
+
+const testBaseConvexClient = () =>
+  new MinimalBaseConvexClient(address, () => {}, {
+    webSocketConstructor: ws as unknown as typeof WebSocket,
+  });
+
+describe("ConvexReactClient with a provided BaseConvexClient", () => {
+  test("uses the provided client as its `sync` client", () => {
+    const baseClient = testBaseConvexClient();
+    const client = new ConvexReactClient(address, { baseClient });
+    expect(client.sync).toBe(baseClient);
+  });
+
+  test("applies setAdminAuth called before the client is lazily instantiated", () => {
+    const baseClient = testBaseConvexClient();
+    const setAdminAuthSpy = vi.spyOn(baseClient, "setAdminAuth");
+    const client = new ConvexReactClient(address, { baseClient });
+    client.setAdminAuth("admin-token");
+    expect(setAdminAuthSpy).not.toHaveBeenCalled();
+
+    // Accessing `sync` lazily instantiates the client, applying admin auth.
+    expect(client.sync).toBe(baseClient);
+    expect(setAdminAuthSpy).toHaveBeenCalledWith("admin-token", undefined);
+  });
+
+  test("queries and mutations work through the provided client", async () => {
+    const baseClient = testBaseConvexClient();
+    const client = new ConvexReactClient(address, { baseClient });
+
+    void client.mutation(
+      anyApi.myMutation.default,
+      {},
+      {
+        optimisticUpdate: (localStore) => {
+          localStore.setQuery(anyApi.myQuery.default, {}, "queryResult");
+        },
+      },
+    );
+
+    const queryResult = client.query(anyApi.myQuery.default, {});
+    expect(await queryResult).toStrictEqual("queryResult");
+  });
+});

package/src/react-clerk/ConvexProviderWithClerk.tsx

@@ -22,6 +22,7 @@ type UseAuth = () => {
   // We don't use these properties but they should trigger a new token fetch.
   orgId: string | undefined | null;
   orgRole: string | undefined | null;
+  sessionId: string | undefined | null;
   sessionClaims: Record<string, unknown> | undefined | null;
 };
 
@@ -66,6 +67,7 @@ function useUseAuthFromClerk(useAuth: UseAuth) {
           getToken,
           orgId,
           orgRole,
+          sessionId,
           sessionClaims,
         } = useAuth();
         const fetchAccessToken = useCallback(
@@ -91,7 +93,7 @@ function useUseAuthFromClerk(useAuth: UseAuth) {
           // Anything else from the JWT Clerk wants to be reactive goes here too.
           // Clerk's Expo useAuth hook is not memoized so we don't include getToken.
           // eslint-disable-next-line react-hooks/exhaustive-deps
-          [orgId, orgRole],
+          [orgId, orgRole, sessionId],
         );
         return useMemo(
           () => ({

package/src/server/database.ts

@@ -140,8 +140,9 @@ export interface BaseTableReader<
  * @see https://docs.convex.dev/database/reading-data
  * @public
  */
-export interface GenericDatabaseReader<DataModel extends GenericDataModel>
-  extends BaseDatabaseReader<DataModel> {
+export interface GenericDatabaseReader<
+  DataModel extends GenericDataModel,
+> extends BaseDatabaseReader<DataModel> {
   /**
    * An interface to read from the system tables within Convex query functions.
    *
@@ -216,8 +217,9 @@ export interface GenericDatabaseReaderWithTable<
  * @see https://docs.convex.dev/database/writing-data
  * @public
  */
-export interface GenericDatabaseWriter<DataModel extends GenericDataModel>
-  extends GenericDatabaseReader<DataModel> {
+export interface GenericDatabaseWriter<
+  DataModel extends GenericDataModel,
+> extends GenericDatabaseReader<DataModel> {
   /**
    * Insert a new document into a table.
    *

package/src/server/impl/meta_impl.ts

@@ -54,9 +54,9 @@ async function getDeploymentMetadata(): Promise<DeploymentMetadata> {
 }
 
 async function getRequestMetadata(): Promise<RequestMetadata> {
-  const { ip, userAgent, requestId, scheduledFunctionId } =
+  const { ip, userAgent, requestId, scheduledFunctionId, authToken } =
     await performAsyncSyscall("1.0/getRequestMetadata", {});
-  return { ip, userAgent, requestId, scheduledFunctionId };
+  return { ip, userAgent, requestId, scheduledFunctionId, authToken };
 }
 
 export function setupQueryMeta(

package/src/server/impl/query_impl.ts

@@ -41,9 +41,7 @@ type SerializedQuery = {
   operators: Array<QueryOperator>;
 };
 
-export class QueryInitializerImpl
-  implements QueryInitializer<GenericTableInfo>
-{
+export class QueryInitializerImpl implements QueryInitializer<GenericTableInfo> {
   private tableName: string;
 
   constructor(tableName: string) {

package/src/server/impl/registration_impl.ts

@@ -500,7 +500,6 @@ export const internalQueryGeneric: QueryBuilder<any, "internal"> = ((
 async function invokeAction<
   F extends (ctx: GenericActionCtx<GenericDataModel>, ...args: any) => any,
 >(func: F, requestId: string, argsStr: string, visibility: FunctionVisibility) {
-  (globalThis as any).Convex?.setupPerformance?.();
   const args = jsonToConvex(JSON.parse(argsStr));
   const calls = setupActionCalls(requestId);
   const ctx = {
@@ -682,7 +681,6 @@ export const internalActionGeneric: ActionBuilder<any, "internal"> = ((
 async function invokeHttpAction<
   F extends (ctx: GenericActionCtx<GenericDataModel>, request: Request) => any,
 >(func: F, request: Request) {
-  (globalThis as any).Convex?.setupPerformance?.();
   // TODO(presley): Change the function signature and propagate the requestId from Rust.
   // Ok, to mock it out for now, since http endpoints are only running in V8.
   const requestId = "";

package/src/server/meta.ts

@@ -114,6 +114,16 @@ export type RequestMetadata = {
    * `null` when the function was not scheduled.
    */
   scheduledFunctionId: string | null;
+  /**
+   * The raw auth token (a JWT) the request was authenticated with, or `null`
+   * when the request was unauthenticated or authenticated with an admin key.
+   *
+   * This is the same token that `ctx.auth.getUserIdentity()` derives its
+   * attributes from.
+   *
+   * @internal
+   */
+  authToken: string | null;
 };
 
 /**

package/src/server/query.ts

@@ -26,8 +26,9 @@ import { SearchFilter, SearchFilterBuilder } from "./search_filter_builder.js";
  *
  * @public
  */
-export interface QueryInitializer<TableInfo extends GenericTableInfo>
-  extends Query<TableInfo> {
+export interface QueryInitializer<
+  TableInfo extends GenericTableInfo,
+> extends Query<TableInfo> {
   /**
    * Query by reading all of the values out of this table.
    *
@@ -163,8 +164,9 @@ export interface QueryInitializer<TableInfo extends GenericTableInfo>
  *
  * @public
  */
-export interface Query<TableInfo extends GenericTableInfo>
-  extends OrderedQuery<TableInfo> {
+export interface Query<
+  TableInfo extends GenericTableInfo,
+> extends OrderedQuery<TableInfo> {
   /**
    * Define the order of the query output.
    *
@@ -179,8 +181,9 @@ export interface Query<TableInfo extends GenericTableInfo>
  *
  * @public
  */
-export interface OrderedQuery<TableInfo extends GenericTableInfo>
-  extends AsyncIterable<DocumentByInfo<TableInfo>> {
+export interface OrderedQuery<
+  TableInfo extends GenericTableInfo,
+> extends AsyncIterable<DocumentByInfo<TableInfo>> {
   /**
    * Filter the query output, returning only the values for which `predicate` evaluates to true.
    *

package/src/server/registration.ts

@@ -763,8 +763,8 @@ export type MutationBuilder<
       | Validator<any, "required", any>
       | void,
     ReturnValue extends ReturnValueForOptionalValidator<ReturnsValidator> = any,
-    OneOrZeroArgs extends
-      ArgsArrayForOptionalValidator<ArgsValidator> = DefaultArgsForOptionalValidator<ArgsValidator>,
+    OneOrZeroArgs extends ArgsArrayForOptionalValidator<ArgsValidator> =
+      DefaultArgsForOptionalValidator<ArgsValidator>,
   >(
     mutation:
       | {
@@ -856,8 +856,8 @@ export type MutationBuilderWithTable<
       | Validator<any, "required", any>
       | void,
     ReturnValue extends ReturnValueForOptionalValidator<ReturnsValidator> = any,
-    OneOrZeroArgs extends
-      ArgsArrayForOptionalValidator<ArgsValidator> = DefaultArgsForOptionalValidator<ArgsValidator>,
+    OneOrZeroArgs extends ArgsArrayForOptionalValidator<ArgsValidator> =
+      DefaultArgsForOptionalValidator<ArgsValidator>,
   >(
     mutation:
       | {
@@ -949,8 +949,8 @@ export type QueryBuilder<
       | Validator<any, "required", any>
       | void,
     ReturnValue extends ReturnValueForOptionalValidator<ReturnsValidator> = any,
-    OneOrZeroArgs extends
-      ArgsArrayForOptionalValidator<ArgsValidator> = DefaultArgsForOptionalValidator<ArgsValidator>,
+    OneOrZeroArgs extends ArgsArrayForOptionalValidator<ArgsValidator> =
+      DefaultArgsForOptionalValidator<ArgsValidator>,
   >(
     query:
       | {
@@ -1038,8 +1038,8 @@ export type QueryBuilderWithTable<
       | Validator<any, "required", any>
       | void,
     ReturnValue extends ReturnValueForOptionalValidator<ReturnsValidator> = any,
-    OneOrZeroArgs extends
-      ArgsArrayForOptionalValidator<ArgsValidator> = DefaultArgsForOptionalValidator<ArgsValidator>,
+    OneOrZeroArgs extends ArgsArrayForOptionalValidator<ArgsValidator> =
+      DefaultArgsForOptionalValidator<ArgsValidator>,
   >(
     query:
       | {
@@ -1127,8 +1127,8 @@ export type ActionBuilder<
       | Validator<any, "required", any>
       | void,
     ReturnValue extends ReturnValueForOptionalValidator<ReturnsValidator> = any,
-    OneOrZeroArgs extends
-      ArgsArrayForOptionalValidator<ArgsValidator> = DefaultArgsForOptionalValidator<ArgsValidator>,
+    OneOrZeroArgs extends ArgsArrayForOptionalValidator<ArgsValidator> =
+      DefaultArgsForOptionalValidator<ArgsValidator>,
   >(
     func:
       | {

package/src/server/schema.ts

@@ -899,7 +899,8 @@ const _systemSchema = defineSchema({
   }),
 });
 
-export interface SystemDataModel
-  extends DataModelFromSchemaDefinition<typeof _systemSchema> {}
+export interface SystemDataModel extends DataModelFromSchemaDefinition<
+  typeof _systemSchema
+> {}
 
 export type SystemTableNames = TableNamesInDataModel<SystemDataModel>;