feat: add inline function support for t.query, t.mutation, and t.action #59

devin-ai-integration · 2025-11-28T19:02:12Z

feat: add inline function support for t.query, t.mutation, and t.action

Summary

This PR extends t.query, t.mutation, and t.action to accept either a function reference with args (existing behavior) or an inline async function (ctx) => {...} that runs directly.

Before:

await t.query(api.queries.list);

After (both work):

await t.query(api.queries.list);
await t.query(async (ctx) => {
  return await ctx.db.query("messages").first();
});

The implementation adds shared helper functions (runQueryWithHandler, runActionWithHandler, runInlineMutation) and updates the byType methods to detect inline functions via typeof === "function" check. Type definitions use function overloads to provide proper typing for both signatures.

Important design decision: Inside inline actions, ctx.runQuery, ctx.runMutation, and ctx.runAction only accept function references (not inline functions). This matches real Convex behavior where these methods require registered functions.

Updates since last revision

Added explicit as Value type assertions in asyncSyscallImpl to fix TypeScript build errors
Removed redundant "inline query with first" test
Removed test that used inline functions inside ctx.runMutation (not supported in real Convex)
Refactored to reduce code duplication with shared runQueryWithHandler and runActionWithHandler helpers
Ensured ctx.runQuery/runMutation/runAction inside actions only accept function references via refOnly* helpers

Review & Testing Checklist for Human

Verify the typeof === "function" check correctly distinguishes FunctionReference objects from inline functions in all cases
Confirm inline query context is properly read-only (no write methods like db.insert)
Verify ctx.runQuery/runMutation/runAction inside inline actions correctly rejects inline functions and only accepts function references
Test withIdentity() works correctly with inline functions

Recommended test plan:

Run npm run test:once to verify all 124 tests pass (1 skipped)
Try the example from the request: await t.query(async (ctx) => { return ctx.db.query("messages").first() });
Verify inline action calling a function reference via ctx.runMutation(api.mutations.insert, {...}) works

Notes

Link to Devin run: https://app.devin.ai/sessions/2eaddac1991b41f7b850179cefbd6baf
Requested by: Ian Macartney (ian@convex.dev)

- Allow t.query to accept an inline async function (ctx) => {...} with query context - Allow t.mutation to accept an inline async function (ctx) => {...} with mutation context - Allow t.action to accept an inline async function (ctx) => {...} with action context - Add comprehensive tests for inline function functionality - Update type definitions with function overloads for both function references and inline functions Co-Authored-By: Ian Macartney <ian@convex.dev>

devin-ai-integration · 2025-11-28T19:02:14Z

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

Disable automatic comment and CI monitoring

coderabbitai · 2025-11-28T19:02:18Z

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch devin/1764356372-inline-functions

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

The function overloads for query/mutation/action caused TypeScript to infer 'unknown' return type when the overload resolution was ambiguous. Added explicit 'as Value' type assertions at the call sites in asyncSyscallImpl where results are passed to convexToJson(). Co-Authored-By: Ian Macartney <ian@convex.dev>

pkg-pr-new · 2025-11-28T19:08:03Z

Open in StackBlitz

npm i https://pkg.pr.new/get-convex/convex-test@59

commit: 65f0794

ianmacartney · 2025-11-28T19:44:13Z

convex/inlineFunctions.test.ts

+test("inline query with first", async () => {
+  const t = convexTest(schema);
+  await t.run(async (ctx) => {
+    await ctx.db.insert("messages", { author: "sarah", body: "hello" });
+  });
+  const message = await t.query(async (ctx) => {
+    return await ctx.db.query("messages").first();
+  });
+  expect(message).toMatchObject({ author: "sarah", body: "hello" });
+});
+


Suggested change

test("inline query with first", async () => {

const t = convexTest(schema);

await t.run(async (ctx) => {

await ctx.db.insert("messages", { author: "sarah", body: "hello" });

});

const message = await t.query(async (ctx) => {

return await ctx.db.query("messages").first();

});

expect(message).toMatchObject({ author: "sarah", body: "hello" });

});

I don't think this query adds much value

Removed this test as suggested.

ianmacartney · 2025-11-28T19:45:16Z

convex/inlineFunctions.test.ts

+    await ctx.runMutation(async (mutCtx) => {
+      await mutCtx.db.insert("messages", { author: "action", body: "test" });
+    });


ctx.runMutation does not support an inline function in regular convex, so it doesn't need to work here and we shouldn't document / encourage it. only t.mutation / t.action / t.query please.

Good point - removed this test and updated the implementation so that ctx.runMutation, ctx.runQuery, and ctx.runAction inside actions only accept function references (not inline functions). The inline function support is now limited to the top-level t.query, t.mutation, and t.action methods only.

ianmacartney · 2025-11-28T19:47:40Z

index.ts

+  const runInlineQuery = async <T>(
+    componentPath: string,
+    handler: (ctx: any) => T,
+  ): Promise<T> => {
+    const q = queryGeneric({
+      handler: (ctx: any) => {
+        const testCtx = { ...ctx, auth };
+        return handler(testCtx);
+      },
+    });
+    const transactionManager = getTransactionManager();
+    const functionPath = { componentPath, udfPath: "inline" };
+    await transactionManager.begin(functionPath, false);
+    try {
+      const rawResult = await (
+        q as unknown as { invokeQuery: (args: string) => Promise<string> }
+      ).invokeQuery(JSON.stringify(convexToJson([{}])));
+      return jsonToConvex(JSON.parse(rawResult)) as T;
+    } finally {
+      transactionManager.rollback(false);
+    }
+  };
+
+  const runInlineMutation = async <T>(
+    componentPath: string,
+    handler: (ctx: any) => T,
+  ): Promise<T> => {
+    return await runTransaction(
+      handler,
+      {},
+      {},
+      { componentPath, udfPath: "inline" },
+      false,
+    );
+  };
+
+  const runInlineAction = async <T>(
+    componentPath: string,
+    handler: (ctx: any) => T,
+  ): Promise<T> => {
+    const a = actionGeneric({
+      handler: (ctx: any) => {
+        const testCtx = {
+          ...ctx,
+          runQuery: byType.query,
+          runMutation: byType.mutation,
+          runAction: byType.action,
+          auth,
+        };
+        return handler(testCtx);
+      },
+    });
+    const functionPath = { componentPath, udfPath: "inline" };
+    getTransactionManager().beginAction(functionPath);
+    const requestId = "" + Math.random();
+    const rawResult = await (
+      a as unknown as {
+        invokeAction: (requestId: string, args: string) => Promise<string>;
+      }
+    ).invokeAction(requestId, JSON.stringify(convexToJson([{}])));
+    getTransactionManager().finishAction();
+    return jsonToConvex(JSON.parse(rawResult)) as T;
+  };


this looks duplicative with other code in this file. how might we share more code here?

Refactored to reduce duplication by extracting shared helpers:

runQueryWithHandler - shared query execution logic used by both byTypeWithPath.queryFromPath and inline queries

runActionWithHandler - shared action execution logic used by both byTypeWithPath.actionFromPath and inline actions

Also created refOnlyQuery, refOnlyMutation, and refOnlyAction helpers that only accept function references (no inline support) for use inside action contexts.

- Remove redundant 'inline query with first' test - Remove test that used inline functions inside ctx.runMutation (not supported in real Convex) - Refactor to reduce code duplication with shared runQueryWithHandler and runActionWithHandler helpers - Ensure ctx.runQuery/runMutation/runAction inside actions only accept function references (not inline functions) Co-Authored-By: Ian Macartney <ian@convex.dev>

ianmacartney requested changes Nov 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add inline function support for t.query, t.mutation, and t.action #59

feat: add inline function support for t.query, t.mutation, and t.action #59

Uh oh!

devin-ai-integration bot commented Nov 28, 2025 •

edited

Loading

Uh oh!

devin-ai-integration bot commented Nov 28, 2025

Uh oh!

coderabbitai bot commented Nov 28, 2025

Review skipped

Uh oh!

pkg-pr-new bot commented Nov 28, 2025 •

edited

Loading

Uh oh!

ianmacartney Nov 28, 2025

Uh oh!

devin-ai-integration bot Nov 28, 2025

Uh oh!

ianmacartney Nov 28, 2025

Uh oh!

devin-ai-integration bot Nov 28, 2025

Uh oh!

ianmacartney Nov 28, 2025

Uh oh!

devin-ai-integration bot Nov 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat: add inline function support for t.query, t.mutation, and t.action #59

Are you sure you want to change the base?

feat: add inline function support for t.query, t.mutation, and t.action #59

Uh oh!

Conversation

devin-ai-integration bot commented Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

feat: add inline function support for t.query, t.mutation, and t.action

Summary

Updates since last revision

Review & Testing Checklist for Human

Notes

Uh oh!

devin-ai-integration bot commented Nov 28, 2025

🤖 Devin AI Engineer

Uh oh!

coderabbitai bot commented Nov 28, 2025

Review skipped

Uh oh!

pkg-pr-new bot commented Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ianmacartney Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration bot Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

ianmacartney Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration bot Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

ianmacartney Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration bot Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

devin-ai-integration bot commented Nov 28, 2025 •

edited

Loading

pkg-pr-new bot commented Nov 28, 2025 •

edited

Loading