[feature] convex support

[brrock]

Description

Simple and easy convex support would be appreciated

Proposed Solution

No response

[suncyn]

or at least some document on how to adopt in convex runtime would be great

[winstonpurnomo]

Found a way to adopt it:

convex-helpers package supports returning custom onSuccess and onError hooks:

import {
  customAction,
  customMutation,
  customQuery,
  type Customization,
} from "convex-helpers/server/customFunctions";
import type { GenericDataModel, GenericQueryCtx } from "convex/server";
import { v } from "convex/values";
import { createLogger } from "evlog";

import { api } from "./_generated/api";
import { action, mutation, query } from "./_generated/server";

const createLoggedInput =
  <Ctx extends CtxWithRunQuery>(
    method: "GET" | "POST"
  ): Customization<
    Ctx,
    typeof loggedArgs,
    LoggedContext,
    Record<string, never>
  >["input"] =>
  async (ctx, args) => {
    const logger = createLogger({
      method,
      path: args._path,
    });
    return {
      ctx: {
        logger,
      },
      args: {},
      onSuccess: () => {
        logger.set({
          status: 200,
        });
        logger.emit();
      },
      onError: (err: unknown) => {
        logger.set({ status: 500, error: err });
        logger.emit();
      },
    };
  };


export const loggedMutation = customMutation(mutation, {
  args: loggedArgs,
  input: createLoggedInput("POST"),
});

export const loggedQuery = customQuery(query, {
  args: loggedArgs,
  input: createLoggedInput("GET"),
});

export const loggedAction = customAction(action, {
  args: loggedArgs,
  input: createLoggedInput("POST"),
});

now all your convex functions defined with loggedQuery/Mutation/Action take in a _path param. You can use getFunctionName(api.module.function) to get the equivalent of a path in Convex, so

// Could probably write a helper to do this automatically
const data = useQuery(convexQuery(api.module.function, { _path: getFunctionName(api.module.function) })