MapleLeaf 🍁 Posts - Convex Community

MapleLeaf 🍁

Posts Comments

CCConvex Community

•Created by MapleLeaf 🍁 on 1/22/2025 in #show-and-tell

Tale Tapestry, an AI-driven story generator

23 replies

CCConvex Community

•Created by MapleLeaf 🍁 on 11/1/2024 in #support-community

Add clear and explicit way to exclude files from bundle

I found this post but making a new thread specifically because this is a feature request I keep getting the need to exclude bundled files from time to time. In particular, I have a file with testing helpers that fails to compile because convex-test uses crypto:

import { convexTest, type TestConvexForDataModel } from "convex-test"
import type { DataModel, Id } from "../_generated/dataModel"
import schema from "../schema.ts"

export function createConvexTest() {
    return convexTest(schema, import.meta.glob("../**/*.ts"))
}

export async function createConvexTestWithIdentity(
    convex = createConvexTest(),
    { name = `maple_${crypto.randomUUID()}` } = {},
): Promise<TestConvexForDataModel<DataModel>> {
    const userId = await convex.run(async (ctx) => {
        return await ctx.db.insert("users", {})
    })

    return convex.withIdentity({
        name,
        subject: userId as Id<"users">,
    })
}

import { convexTest, type TestConvexForDataModel } from "convex-test"
import type { DataModel, Id } from "../_generated/dataModel"
import schema from "../schema.ts"

export function createConvexTest() {
    return convexTest(schema, import.meta.glob("../**/*.ts"))
}

export async function createConvexTestWithIdentity(
    convex = createConvexTest(),
    { name = `maple_${crypto.randomUUID()}` } = {},
): Promise<TestConvexForDataModel<DataModel>> {
    const userId = await convex.run(async (ctx) => {
        return await ctx.db.insert("users", {})
    })

    return convex.withIdentity({
        name,
        subject: userId as Id<"users">,
    })
}

✘ [ERROR] Could not resolve "crypto"

    node_modules/.pnpm/convex-test@0.0.33_convex@1.16.6_react-dom@19.0.0-rc-1631855f-20241023_react@19.0.0-rc-163185_i2jgw5baye66ar2rtytco6tjiq/node_modules/convex-test/dist/index.js:5:27:
      5 │ import { createHash } from "crypto";
        ╵                            ~~~~~~~~

  The package "crypto" wasn't found on the file system but is built into node. Are you trying to
  bundle for node? You can use "platform: 'node'" to do that, which will remove this error.

✘ [ERROR] Could not resolve "crypto"

    node_modules/.pnpm/convex-test@0.0.33_convex@1.16.6_react-dom@19.0.0-rc-1631855f-20241023_react@19.0.0-rc-163185_i2jgw5baye66ar2rtytco6tjiq/node_modules/convex-test/dist/index.js:5:27:
      5 │ import { createHash } from "crypto";
        ╵                            ~~~~~~~~

  The package "crypto" wasn't found on the file system but is built into node. Are you trying to
  bundle for node? You can use "platform: 'node'" to do that, which will remove this error.

I renamed the file lib/test.nobundle.ts to work around it. While the heuristic of "exclude if multiple dots in path" accounts for a lot, it feels a little... flimsy? or something like that For example, you might want a file that has multiple dots in the path to be included; I tried to name a file something.node.ts as a companion to something.ts which includes the node actions, while the main file just has queries and mutations. I was confused for a hot minute why that wasn't included. I worked around it, but at the time, I didn't realize this rule was the cause. I would prefer one of these alternatives, in order of preference: - "exclude" or "ignore" config in convex.json - a filename convention, like I did here - "use nobundle" or "use exclude" or some other kind of file directive Specifically with the file config, it would have the default of excluding .test. files or whatever else, and maybe you could add a special sigil for that, which I've seen in some config formats:

{ "exclude": ["$DEFAULT_EXCLUDES", "**/*.util.ts"] }

{ "exclude": ["$DEFAULT_EXCLUDES", "**/*.util.ts"] }

13 replies

CCConvex Community

•Created by MapleLeaf 🍁 on 10/24/2024 in #support-community

Set environment variables programmatically

I want to set up a Doppler webhook which updates secrets in Convex. I know of two ways to update secrets: through the dashboard, and through the CLI. CLI seems like the easiest route, but I'm not exactly sure how to do this arbitrarily:

C:\dev
❯ CONVEX_DEPLOY_KEY="dev:fake-project-777|superreallylongstringthathasaconvexkeyinit" pnpx convex env set TEST itworks
✖ Unable to read your package.json: Error: ENOENT: no such file or directory, open 'C:\dev\package.json'. Make sure you're running this command from the root directory of a Convex app that contains the package.json

C:\dev
❯ CONVEX_DEPLOY_KEY="dev:fake-project-777|superreallylongstringthathasaconvexkeyinit" pnpx convex env set TEST itworks
✖ Unable to read your package.json: Error: ENOENT: no such file or directory, open 'C:\dev\package.json'. Make sure you're running this command from the root directory of a Convex app that contains the package.json

And I figure going down this route will run into other issues, since I imagine the CLI wasn't built to do this. Accomplishing this through the dashboard is possible but extremely cursed, and I would prefer not to pull out puppeteer/playwright for this :ultra_joy: Tentatively, I'm thinking a GitHub action triggered by a workflow might work, which would have the source directory and the surrounding dev environment, but that feels like a lot of orchestration. Is there any way to accomplish this right now?

6 replies

CCConvex Community

•Created by MapleLeaf 🍁 on 8/5/2024 in #show-and-tell

convex-effect: An Effect-based wrapper around the Convex API

hi all, just published my first Real™️ package on JSR, an effect wrapper for convex: https://jsr.io/@maple/convex-effect I'm aware confect is (going to be?) a thing, but after a scan over the source, it did a bit more than I was looking for. This is basically a 1:1 drop-in(-ish) replacement, with each method returning an effect instead of a promise.

1 replies

CCConvex Community

•Created by MapleLeaf 🍁 on 12/4/2023 in #support-community

e2e testing with preview deployments

I'm trying to get a setup where I can run e2e tests in Github CI against a preview environment. Here's what I have:

      - name: Build with Convex deploy
        run: pnpm convex deploy
          --cmd "pnpm run build"
          --cmd-url-env-var-name VITE_PUBLIC_CONVEX_URL
          --preview-name "e2e-${{ github.ref_name }}"
        env:
          CONVEX_DEPLOY_KEY: ${{ secrets.CONVEX_DEPLOY_KEY }}

      - name: Run Playwright tests
        run: pnpm run e2e
        env:
          CLERK_PUBLISHABLE_KEY: ${{ secrets.CLERK_PUBLISHABLE_KEY }}
          CLERK_SECRET_KEY: ${{ secrets.CLERK_SECRET_KEY }}

      - name: Build with Convex deploy
        run: pnpm convex deploy
          --cmd "pnpm run build"
          --cmd-url-env-var-name VITE_PUBLIC_CONVEX_URL
          --preview-name "e2e-${{ github.ref_name }}"
        env:
          CONVEX_DEPLOY_KEY: ${{ secrets.CONVEX_DEPLOY_KEY }}

      - name: Run Playwright tests
        run: pnpm run e2e
        env:
          CLERK_PUBLISHABLE_KEY: ${{ secrets.CLERK_PUBLISHABLE_KEY }}
          CLERK_SECRET_KEY: ${{ secrets.CLERK_SECRET_KEY }}

I want my tests to run seed functions before they go, e.g.

test.beforeAll(async ({ page }) => {
    await execa("pnpm", ["convex", "run", "seed:characters"], {
        stdio: "inherit",
    })
})

test("navigating characters", async ({ page }) => {
    // etc
})

test.beforeAll(async ({ page }) => {
    await execa("pnpm", ["convex", "run", "seed:characters"], {
        stdio: "inherit",
    })
})

test("navigating characters", async ({ page }) => {
    // etc
})

this doesn't work in CI because the tests are ran outside the convex deploy context and don't have the CONVEX_DEPLOYMENT environment variable I can --preview-run seed:characters, but I want to be able to run specific functions for specific tests to replicate certain setup scenarios without the test going through the UI to do so so my question is: how can I pass the info from convex deploy such that I can run functions during the tests?

28 replies

CCConvex Community

•Created by MapleLeaf 🍁 on 8/23/2023 in #support-community

Feature request: v.nullish(someValidator)

Equivalent to this:

export const nullish = <T>(validator: Validator<T>) =>
    v.optional(v.union(validator, v.null()))

export const nullish = <T>(validator: Validator<T>) =>
    v.optional(v.union(validator, v.null()))

Because I often CBA whether an input is null or undefined :lul: so many data sources will just decide whether to do one or the other

2 replies

CCConvex Community

•Created by MapleLeaf 🍁 on 8/21/2023 in #support-community

Collection size limit

I have a collection of items that'll get created frequently, and I don't need to store them forever, so I want to delete old entries to preserve space. My current strategy is to delete extra items once the collection size is over some arbitrary max. I'm not that worried about performance since the collection isn't that big, nor is the limit, but I still wonder if there's a more performant/idiomatic way to accomplish this. Here's my code:

const maxRolls = 250

export const roll = mutation({
    args: {
        type: v.optional(v.string()),
        label: v.optional(v.string()),
        characterId: v.optional(v.id("characters")),
        dice: v.array(v.object({ sides: v.number(), count: v.number() })),
    },
    handler: async (ctx, { dice, ...data }) => {
        const user = await requirePlayerUser(ctx)

        // make dice rolls
        const rolls = []
        for (const dieItem of dice) {
            for (let i = 0; i < dieItem.count; i++) {
                rolls.push({
                    sides: dieItem.sides,
                    result: Math.floor(Math.random() * dieItem.sides) + 1,
                })
            }
        }

        // add new dice roll
        await ctx.db.insert("diceRolls", {
            ...data,
            discordUserId: user.discordUserId,
            dice: rolls,
        })

        // remove old dice rolls if there are too many
        const allRolls = await ctx.db.query("diceRolls").collect()
        const excessRolls = allRolls.slice(0, -maxRolls)
        await Promise.all(excessRolls.map((r) => ctx.db.delete(r._id)))
    },
})

const maxRolls = 250

export const roll = mutation({
    args: {
        type: v.optional(v.string()),
        label: v.optional(v.string()),
        characterId: v.optional(v.id("characters")),
        dice: v.array(v.object({ sides: v.number(), count: v.number() })),
    },
    handler: async (ctx, { dice, ...data }) => {
        const user = await requirePlayerUser(ctx)

        // make dice rolls
        const rolls = []
        for (const dieItem of dice) {
            for (let i = 0; i < dieItem.count; i++) {
                rolls.push({
                    sides: dieItem.sides,
                    result: Math.floor(Math.random() * dieItem.sides) + 1,
                })
            }
        }

        // add new dice roll
        await ctx.db.insert("diceRolls", {
            ...data,
            discordUserId: user.discordUserId,
            dice: rolls,
        })

        // remove old dice rolls if there are too many
        const allRolls = await ctx.db.query("diceRolls").collect()
        const excessRolls = allRolls.slice(0, -maxRolls)
        await Promise.all(excessRolls.map((r) => ctx.db.delete(r._id)))
    },
})

4 replies

CCConvex Community

•Created by MapleLeaf 🍁 on 8/20/2023 in #show-and-tell

Use React Suspense with Convex

Polished my suspense implementation a bit to fix some edge cases I found, hope it helps! https://gist.github.com/itsMapleLeaf/d52357f17f674795a86f155f5cf80eb5

1 replies

CCConvex Community

•Created by MapleLeaf 🍁 on 8/18/2023 in #support-community

Feature request: v.record() and v.unknown()

I have a case where I want to store arbitrary data specifically as an object of type Record<string, string | number> but that doesn't seem to be possible with the current validators As a somewhat related aside, v.unknown() would be a much more welcome and safer alternative to v.any()

9 replies