convex-helpers-guide

Convex Helpers ガイド

convex-helpers を使うと、よくあるパターンやユーティリティを Convex バックエンドに追加でき、同じものを一から作る手間を省けます。

convex-helpers とは？

convex-helpers は、Convex を補完するユーティリティの公式コレクションです。バックエンドでよく必要になる、十分に実績のあるパターンを提供します。

インストール：

npm install convex-helpers

利用可能なヘルパー

1. リレーションシップヘルパー

テーブル間のリレーションシップを、読みやすく型安全な方法でたどります。

使用する場面：

• テーブル間の関連データを読み込むとき
• 外部キーのリレーションシップをたどるとき
• ネストされたデータ構造を構築するとき

例：

import { getOneFrom, getManyFrom } from "convex-helpers/server/relationships";

export const getTaskWithUser = query({
  args: { taskId: v.id("tasks") },
  handler: async (ctx, args) => {
    const task = await ctx.db.get(args.taskId);
    if (!task) return null;

    // Get related user
    const user = await getOneFrom(
      ctx.db,
      "users",
      "by_id",
      task.userId,
      "_id"
    );

    // Get related comments
    const comments = await getManyFrom(
      ctx.db,
      "comments",
      "by_task",
      task._id,
      "taskId"
    );

    return { ...task, user, comments };
  },
});

主な関数：

• getOneFrom - 関連ドキュメントを 1 件取得します
• getManyFrom - 関連ドキュメントを複数取得します
• getManyVia - 中間テーブルを介して多対多のリレーションシップを取得します

2. カスタム関数（データ保護） - 最重要

これは Convex における行レベルセキュリティ（RLS）の代替手段です。 データベースレベルのポリシーの代わりに、カスタム関数ラッパーを使用して、すべてのクエリとミューテーションに認証とアクセス制御を自動的に追加します。

クエリ／ミューテーション／アクションを、カスタム動作を備えたラップ済みバージョンとして作成します。

使用する場面：

• データ保護とアクセス制御（主な用途）
• すべての関数に認証ロジックを追加したいとき
• マルチテナントアプリケーション
• ロールベースアクセス制御（RBAC）
• ctx に共通データを注入する必要があるとき
• 内部専用関数を構築するとき
• すべての関数にロギング／モニタリングを追加するとき

RLS ではなくこれを使う理由：

• SQL ポリシーではなく TypeScript を使います
• 完全な型安全性があります
• テストとデバッグが簡単です
• データベースポリシーより柔軟です
• バックエンド全体で機能します

例：認証を自動適用するカスタムクエリ

// convex/lib/customFunctions.ts
import { customQuery } from "convex-helpers/server/customFunctions";
import { query } from "../_generated/server";

export const authenticatedQuery = customQuery(
  query,
  {
    args: {}, // No additional args required
    input: async (ctx, args) => {
      const identity = await ctx.auth.getUserIdentity();
      if (!identity) {
        throw new Error("Not authenticated");
      }

      const user = await ctx.db
        .query("users")
        .withIndex("by_token", q =>
          q.eq("tokenIdentifier", identity.tokenIdentifier)
        )
        .unique();

      if (!user) throw new Error("User not found");

      // Add user to context
      return { ctx: { ...ctx, user }, args };
    },
  }
);

// Usage in your functions
export const getMyTasks = authenticatedQuery({
  handler: async (ctx) => {
    // ctx.user is automatically available!
    return await ctx.db
      .query("tasks")
      .withIndex("by_user", q => q.eq("userId", ctx.user._id))
      .collect();
  },
});

例：マルチテナントのデータ保護

import { customQuery } from "convex-helpers/server/customFunctions";
import { query } from "../_generated/server";

// Organization-scoped query - automatic access control
export const orgQuery = customQuery(query, {
  args: { orgId: v.id("organizations") },
  input: async (ctx, args) => {
    const user = await getCurrentUser(ctx);

    // Verify user is a member of this organization
    const member = await ctx.db
      .query("organizationMembers")
      .withIndex("by_org_and_user", q =>
        q.eq("orgId", args.orgId).eq("userId", user._id)
      )
      .unique();

    if (!member) {
      throw new Error("Not authorized for this organization");
    }

    // Inject org context
    return {
      ctx: {
        ...ctx,
        user,
        orgId: args.orgId,
        role: member.role
      },
      args
    };
  },
});

// Usage - data automatically scoped to organization
export const getOrgProjects = orgQuery({
  args: { orgId: v.id("organizations") },
  handler: async (ctx) => {
    // ctx.user and ctx.orgId automatically available and verified!
    return await ctx.db
      .query("projects")
      .withIndex("by_org", q => q.eq("orgId", ctx.orgId))
      .collect();
  },
});

例：ロールベースアクセス制御

import { customMutation } from "convex-helpers/server/customFunctions";
import { mutation } from "../_generated/server";

export const adminMutation = customMutation(mutation, {
  args: {},
  input: async (ctx, args) => {
    const user = await getCurrentUser(ctx);

    if (user.role !== "admin") {
      throw new Error("Admin access required");
    }

    return { ctx: { ...ctx, user }, args };
  },
});

// Usage - only admins can call this
export const deleteUser = adminMutation({
  args: { userId: v.id("users") },
  handler: async (ctx, args) => {
    // Only admins reach this code
    await ctx.db.delete(args.userId);
  },
});

3. フィルターヘルパー

複雑な TypeScript フィルターをデータベースクエリに適用します。

使用する場面：

• 計算値でフィルタリングする必要があるとき
• フィルタリングロジックが複雑すぎてインデックスで対応できないとき
• 小さな結果セットを扱うとき

例：

import { filter } from "convex-helpers/server/filter";

export const getActiveTasks = query({
  handler: async (ctx) => {
    const now = Date.now();
    const threeDaysAgo = now - 3 * 24 * 60 * 60 * 1000;

    return await filter(
      ctx.db.query("tasks"),
      (task) =>
        !task.completed &&
        task.createdAt > threeDaysAgo &&
        task.priority === "high"
    ).collect();
  },
});

注意： 可能な場合は、引き続きインデックスを優先してください。インデックス化できない複雑なロジックにはフィルターを使用します。

4. セッション

ログインしていない場合でも、リクエストをまたいでユーザーを追跡します。

使用する場面：

• 匿名ユーザーを追跡する必要があるとき
• ゲスト向けショッピングカートを構築するとき
• サインアップ前のユーザー行動を追跡するとき
• 認証なしで A/B テストを行うとき

セットアップ：

// convex/sessions.ts
import { SessionIdArg } from "convex-helpers/server/sessions";
import { query } from "./_generated/server";

export const trackView = query({
  args: {
    ...SessionIdArg, // Adds sessionId: v.string()
    pageUrl: v.string(),
  },
  handler: async (ctx, args) => {
    await ctx.db.insert("pageViews", {
      sessionId: args.sessionId,
      pageUrl: args.pageUrl,
      timestamp: Date.now(),
    });
  },
});

クライアント（React）：

import { useSessionId } from "convex-helpers/react/sessions";
import { useQuery } from "convex/react";
import { api } from "../convex/_generated/api";

function MyComponent() {
  const sessionId = useSessionId();

  // Automatically includes sessionId in all requests
  useQuery(api.sessions.trackView, {
    sessionId,
    pageUrl: window.location.href,
  });
}

5. Zod バリデーション

Convex バリデーターの代わりに Zod スキーマを使用します。

使用する場面：

• プロジェクトですでに Zod を使用しているとき
• より複雑なバリデーションロジックが必要なとき
• カスタムエラーメッセージが必要なとき

例：

import { zCustomQuery } from "convex-helpers/server/zod";
import { z } from "zod";
import { query } from "./_generated/server";

const argsSchema = z.object({
  email: z.string().email(),
  age: z.number().min(18).max(120),
});

export const createUser = zCustomQuery(query, {
  args: argsSchema,
  handler: async (ctx, args) => {
    // args is typed from Zod schema
    return await ctx.db.insert("users", args);
  },
});

6. 代替手段：行レベルセキュリティヘルパー

注意： Convex では、主なデータ保護パターンとしてカスタム関数（上記の #2 を参照）を推奨しています。この RLS ヘルパーは、従来の RLS を模倣する代替アプローチです。

ただし、通常はカスタム関数のほうが優れています。理由は次のとおりです。

• コンパイル時に型安全性が確保されます（RLS は実行時に評価されます）
• より明示的で、どの認証が適用されるかを簡単に確認できます
• エラーメッセージがよりわかりやすくなります
• テストが簡単です

7. マイグレーション

データマイグレーションを安全に実行します。

使用する場面：

• 新しいフィールドを埋め戻すとき
• 既存データを変換するとき
• スキーマのバージョン間を移行するとき

例：

import { makeMigration } from "convex-helpers/server/migrations";

export const addDefaultPriority = makeMigration({
  table: "tasks",
  migrateOne: async (ctx, doc) => {
    if (doc.priority === undefined) {
      await ctx.db.patch(doc._id, { priority: "medium" });
    }
  },
});

// Run: npx convex run migrations:addDefaultPriority

8. トリガー

データが変更されたときにコードを自動実行します。

使用する場面：

• データ変更時に通知を送信するとき
• 関連レコードを更新するとき
• 変更を記録するとき
• 計算フィールドを維持するとき

例：

import { Triggers } from "convex-helpers/server/triggers";

const triggers = new Triggers();

triggers.register("tasks", "insert", async (ctx, task) => {
  // Send notification when task is created
  await ctx.db.insert("notifications", {
    userId: task.userId,
    type: "task_created",
    taskId: task._id,
  });
});

よくあるパターン

パターン 1：ユーザーコンテキストを使った認証済みクエリ

import { customQuery } from "convex-helpers/server/customFunctions";

export const authedQuery = customQuery(query, {
  args: {},
  input: async (ctx, args) => {
    const user = await getCurrentUser(ctx);
    return { ctx: { ...ctx, user }, args };
  },
});

// Now all queries automatically have user in context
export const getMyData = authedQuery({
  handler: async (ctx) => {
    // ctx.user is typed and available!
    return await ctx.db
      .query("data")
      .withIndex("by_user", q => q.eq("userId", ctx.user._id))
      .collect();
  },
});

パターン 2：関連データの読み込み

import { getOneFrom, getManyFrom } from "convex-helpers/server/relationships";

export const getPostWithDetails = query({
  args: { postId: v.id("posts") },
  handler: async (ctx, args) => {
    const post = await ctx.db.get(args.postId);
    if (!post) return null;

    const author = await getOneFrom(ctx.db, "users", "by_id", post.authorId, "_id");
    const comments = await getManyFrom(ctx.db, "comments", "by_post", post._id, "postId");

    const tagLinks = await getManyFrom(ctx.db, "postTags", "by_post", post._id, "postId");
    const tags = await Promise.all(
      tagLinks.map(link =>
        getOneFrom(ctx.db, "tags", "by_id", link.tagId, "_id")
      )
    );

    return { ...post, author, comments, tags };
  },
});

パターン 3：エラー処理を伴う一括操作

import { asyncMap } from "convex-helpers";

export const batchUpdateTasks = mutation({
  args: {
    taskIds: v.array(v.id("tasks")),
    status: v.string(),
  },
  handler: async (ctx, args) => {
    const results = await asyncMap(args.taskIds, async (taskId) => {
      try {
        const task = await ctx.db.get(taskId);
        if (task) {
          await ctx.db.patch(taskId, { status: args.status });
          return { success: true, taskId };
        }
        return { success: false, taskId, error: "Not found" };
      } catch (error) {
        return { success: false, taskId, error: error.message };
      }
    });

    return results;
  },
});

用途に応じた選択

目的	使用するもの	インポート元
関連データを読み込む	getOneFrom, getManyFrom	convex-helpers/server/relationships
すべての関数で認証する	customQuery	convex-helpers/server/customFunctions
複雑なフィルター	filter	convex-helpers/server/filter
匿名ユーザー	useSessionId	convex-helpers/react/sessions
Zod による検証	zCustomQuery	convex-helpers/server/zod
データ移行	makeMigration	convex-helpers/server/migrations
トリガー	Triggers	convex-helpers/server/triggers

チェックリスト

• convex-helpers をインストール済み：npm install convex-helpers
• 関連データにはリレーションシップヘルパーを使用している
• 共通の認証パターン用にカスタム関数を作成している
• 匿名ユーザーの追跡にセッションを使用している（必要な場合）
• 可能な場合は filter よりインデックスを優先する
• 新しいユーティリティについて convex-helpers のドキュメントを確認する