update test config

Author: ianmacartney

example/convex/_generated/api.d.ts

@@ -16,25 +16,33 @@ import type {
   FunctionReference,
 } from "convex/server";
 
+declare const fullApi: ApiFromModules<{
+  example: typeof example;
+}>;
+
 /**
- * A utility for referencing Convex functions in your app's API.
+ * A utility for referencing Convex functions in your app's public API.
  *
  * Usage:
  * ```js
  * const myFunctionReference = api.myModule.myFunction;
  * ```
  */
-declare const fullApi: ApiFromModules<{
-  example: typeof example;
-}>;
-declare const fullApiWithMounts: typeof fullApi;
-
 export declare const api: FilterApi<
-  typeof fullApiWithMounts,
+  typeof fullApi,
   FunctionReference<any, "public">
 >;
+
+/**
+ * A utility for referencing Convex functions in your app's internal API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = internal.myModule.myFunction;
+ * ```
+ */
 export declare const internal: FilterApi<
-  typeof fullApiWithMounts,
+  typeof fullApi,
   FunctionReference<any, "internal">
 >;
 
@@ -45,7 +53,7 @@ export declare const components: {
         "mutation",
         "internal",
         { logLevel: "DEBUG" | "INFO" | "WARN" | "ERROR"; userId: string },
-        any
+        null
       >;
       getNotification: FunctionReference<
         "query",

example/convex/schema.ts

@@ -5,7 +5,7 @@ export default defineSchema({
   users: defineTable(
     v.object({
       name: v.string(),
-    })
+    }),
   ).index("by_name", ["name"]),
   // Any tables used by the example app go here.
 });

example/convex/setup.test.ts

@@ -0,0 +1,16 @@
+/// <reference types="vite/client" />
+import { test } from "vitest";
+import { convexTest } from "convex-test";
+import schema from "./schema.js";
+import component from "@convex-dev/expo-push-notifications/test";
+
+const modules = import.meta.glob("./**/*.*s");
+// When users want to write tests that use your component, they need to
+// explicitly register it with its schema and modules.
+export function initConvexTest() {
+  const t = convexTest(schema, modules);
+  component.register(t);
+  return t;
+}
+
+test("setup", () => {});

example/convex/tsconfig.json

@@ -1,19 +1,5 @@
 {
-  "compilerOptions": {
-    "allowJs": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "target": "ESNext",
-    "lib": ["ES2021", "dom", "DOM.Iterable", "ESNext.Array"],
-    "forceConsistentCasingInFileNames": true,
-    "allowSyntheticDefaultImports": true,
-    "verbatimModuleSyntax": true,
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "isolatedModules": true,
-    "noEmit": true,
-    "jsx": "react-jsx"
-  },
-  "include": [".*"],
-  "exclude": ["./_generated"]
+  "extends": "../tsconfig.json",
+  "include": ["."],
+  "exclude": ["_generated"]
 }

example/vite.config.ts

@@ -3,8 +3,6 @@ import react from "@vitejs/plugin-react";
 
 // https://vitejs.dev/config/
 export default defineConfig({
+  envDir: "../",
   plugins: [react()],
-  resolve: {
-    conditions: ["@convex-dev/component-source"],
-  },
 });

src/client/index.ts

@@ -28,7 +28,7 @@ export class PushNotifications<UserType extends string = GenericId<"users">> {
     public component: ComponentApi,
     config?: {
       logLevel?: LogLevel;
-    }
+    },
   ) {
     this.component = component;
     this.config = {
@@ -44,7 +44,7 @@ export class PushNotifications<UserType extends string = GenericId<"users">> {
    */
   recordToken(
     ctx: RunMutationCtx,
-    args: { userId: UserType; pushToken: string }
+    args: { userId: UserType; pushToken: string },
   ): Promise<null> {
     return ctx.runMutation(this.component.public.recordPushNotificationToken, {
       ...args,
@@ -94,7 +94,7 @@ export class PushNotifications<UserType extends string = GenericId<"users">> {
       userId: UserType;
       notification: NotificationFields;
       allowUnregisteredTokens?: boolean;
-    }
+    },
   ) {
     return ctx.runMutation(this.component.public.sendPushNotification, {
       ...args,
@@ -117,7 +117,7 @@ export class PushNotifications<UserType extends string = GenericId<"users">> {
         notification: NotificationFields;
       }>;
       allowUnregisteredTokens?: boolean;
-    }
+    },
   ) {
     return ctx.runMutation(this.component.public.sendPushNotificationBatch, {
       ...args,
@@ -141,7 +141,7 @@ export class PushNotifications<UserType extends string = GenericId<"users">> {
    */
   getNotificationsForUser(
     ctx: RunQueryCtx,
-    args: { userId: UserType; limit?: number }
+    args: { userId: UserType; limit?: number },
   ) {
     return ctx.runQuery(this.component.public.getNotificationsForUser, {
       ...args,

src/component/helpers.ts

@@ -19,16 +19,16 @@ export async function ensureCoordinator(ctx: MutationCtx) {
   }
   if (activeCoordinators.length === 1) {
     ctx.logger.debug(
-      `Found existing coordinator with ID ${activeCoordinators[0]._id}`
+      `Found existing coordinator with ID ${activeCoordinators[0]._id}`,
     );
     return;
   }
   if (activeCoordinators.length > 1) {
     ctx.logger.error(
-      `Unexpected state: Too many coordinators ${activeCoordinators.length}`
+      `Unexpected state: Too many coordinators ${activeCoordinators.length}`,
     );
     throw new Error(
-      `Unexpected state: Too many coordinators ${activeCoordinators.length}`
+      `Unexpected state: Too many coordinators ${activeCoordinators.length}`,
     );
   }
   const config = await ctx.db.query("config").unique();
@@ -41,7 +41,7 @@ export async function ensureCoordinator(ctx: MutationCtx) {
     internal.internal.coordinateSendingPushNotifications,
     {
       logLevel: ctx.logger.level,
-    }
+    },
   );
   const coordinatorId = await ctx.db.insert("senderCoordinator", {
     jobId: coordinatorJobId,
@@ -88,7 +88,7 @@ export const shutdownGracefully = async (ctx: MutationCtx) => {
         const _typeCheck: never = job.state;
         ctx.logger.error(
           // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          `Unknown job state ${(job.state as any).kind} for sender ${sender._id}. Cleaning it up. `
+          `Unknown job state ${(job.state as any).kind} for sender ${sender._id}. Cleaning it up. `,
         );
         await ctx.db.delete(sender._id);
         break;

src/component/internal.ts

@@ -13,9 +13,9 @@ export const markNotificationState = internalMutation({
         state: v.union(
           v.literal("delivered"),
           v.literal("failed"),
-          v.literal("maybe_delivered")
+          v.literal("maybe_delivered"),
         ),
-      })
+      }),
     ),
     checkJobId: v.id("_scheduled_functions"),
   },
@@ -71,7 +71,7 @@ export const coordinateSendingPushNotifications = internalMutation({
       .withIndex("state", (q) => q.eq("state", "awaiting_delivery"))
       .take(MAX_NOTIFICATIONS_PER_SEND - retryNotifications.length);
     ctx.logger.debug(
-      `Found ${retryNotifications.length} retry notifications and ${unsentNotifications.length} unsent notifications`
+      `Found ${retryNotifications.length} retry notifications and ${unsentNotifications.length} unsent notifications`,
     );
     const notificationsToProcess = [
       ...retryNotifications,
@@ -101,18 +101,18 @@ export const coordinateSendingPushNotifications = internalMutation({
     if (numActiveSenders >= MAX_SENDERS) {
       // Don't add another sender yet
       ctx.logger.debug(
-        `Not starting another sender: already ${numActiveSenders}`
+        `Not starting another sender: already ${numActiveSenders}`,
       );
       ctx.logger.debug(
-        `When one sender finishes, or fails, we'll coordinate sending these notifications.`
+        `When one sender finishes, or fails, we'll coordinate sending these notifications.`,
       );
       return;
     }
     const notificationsToSend = notificationsToProcess.filter(
-      (n) => n.numPreviousFailures < MAX_RETRY_ATTEMPTS
+      (n) => n.numPreviousFailures < MAX_RETRY_ATTEMPTS,
     );
     const notificationsToMarkAsUnableToDeliver = notificationsToProcess.filter(
-      (n) => n.numPreviousFailures >= MAX_RETRY_ATTEMPTS
+      (n) => n.numPreviousFailures >= MAX_RETRY_ATTEMPTS,
     );
 
     for (const notification of notificationsToMarkAsUnableToDeliver) {
@@ -134,7 +134,7 @@ export const coordinateSendingPushNotifications = internalMutation({
       {
         notificationIds: notificationsToSend.map((n) => n._id),
         logLevel: ctx.logger.level,
-      }
+      },
     );
 
     const senderJobId = await ctx.scheduler.runAfter(
@@ -165,14 +165,14 @@ export const coordinateSendingPushNotifications = internalMutation({
           };
         }),
         logLevel: ctx.logger.level,
-      }
+      },
     );
     await ctx.db.insert("senders", {
       jobId: senderJobId,
       checkJobId,
     });
     ctx.logger.debug(
-      `Started a new sender ${senderJobId} with job ${senderJobId} and check job ${checkJobId}`
+      `Started a new sender ${senderJobId} with job ${senderJobId} and check job ${checkJobId}`,
     );
   },
 });
@@ -184,7 +184,7 @@ export const checkForFailedAction = internalMutation({
   handler: async (ctx, { notificationIds }) => {
     console.warn(
       `Could not determine delivery status for ${notificationIds.length} notifications:`,
-      notificationIds
+      notificationIds,
     );
     for (const notificationId of notificationIds) {
       // We don't really know what happened to these notifications,
@@ -204,18 +204,18 @@ export const action_sendPushNotifications = internalAction({
       v.object({
         message: v.object({
           to: v.string(),
-          ...notificationFields
+          ...notificationFields,
         }),
         _id: v.id("notifications"),
-      })
+      }),
     ),
   },
   handler: async (ctx, args) => {
     ctx.logger.debug(
-      `Sending ${args.notifications.length} push notifications via Expo's API`
+      `Sending ${args.notifications.length} push notifications via Expo's API`,
     );
     ctx.logger.debug(
-      `Notification IDs: ${JSON.stringify(args.notifications.map((n) => n._id))}`
+      `Notification IDs: ${JSON.stringify(args.notifications.map((n) => n._id))}`,
     );
     let response: Response;
     try {
@@ -232,10 +232,10 @@ export const action_sendPushNotifications = internalAction({
     } catch (_e) {
       ctx.logger.error(
         "Failed during during fetch for sending push notifications:",
-        _e
+        _e,
       );
       ctx.logger.debug(
-        `Marking ${args.notifications.length} notifications as failed so they can be retried`
+        `Marking ${args.notifications.length} notifications as failed so they can be retried`,
       );
       await ctx.runMutation(internal.internal.markNotificationState, {
         notifications: args.notifications.map((n) => {
@@ -253,10 +253,10 @@ export const action_sendPushNotifications = internalAction({
     }
     if (!response.ok) {
       ctx.logger.warn(
-        `Push notification failed with status ${response.status} and body ${await response.text()}`
+        `Push notification failed with status ${response.status} and body ${await response.text()}`,
       );
       ctx.logger.debug(
-        `Marking ${args.notifications.length} notifications as maybe delivered. They won't be retried.`
+        `Marking ${args.notifications.length} notifications as maybe delivered. They won't be retried.`,
       );
       await ctx.runMutation(internal.internal.markNotificationState, {
         notifications: args.notifications.map((n) => {
@@ -279,7 +279,7 @@ export const action_sendPushNotifications = internalAction({
       >;
     } = await response.json();
     ctx.logger.debug(
-      `Response from Expo's API: ${JSON.stringify(responseBody)}`
+      `Response from Expo's API: ${JSON.stringify(responseBody)}`,
     );
 
     const notificationStates: Array<{
@@ -302,7 +302,7 @@ export const action_sendPushNotifications = internalAction({
       }
     }
     ctx.logger.debug(
-      `Successfully parsed response from Expo, and recording state`
+      `Successfully parsed response from Expo, and recording state`,
     );
     await ctx.runMutation(internal.internal.markNotificationState, {
       notifications: notificationStates,