MapleLeaf 🍁•4mo ago

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"] }

10 Replies

Convex Bot•4mo ago

Thanks for posting in <#1088161997662724167>. Reminder: If you have a Convex Pro account, use the Convex Dashboard to file support tickets. - Provide context: What are you trying to achieve, what is the end-user interaction, what are you seeing? (full error message, command output, etc.) - Use search.convex.dev to search Docs, Stack, and Discord all at once. - Additionally, you can post your questions in the Convex Community's <#1228095053885476985> channel to receive a response from AI. - Avoid tagging staff unless specifically instructed. Thank you!

ballingt•4mo ago

Totally, I think we should have one or boht of - some standard convention like a directory or a file extension or a directive that works with no configuration (what two dots is today, but that one is flimsy) - a configurable pattern, configured via convex.json convex.json is where bundling configuration is going to go so that's a natural spot, e.g. custom esbuild plugins

Omar•4mo ago

@Tom Can we exclude when there's two dots in the filename? Just worked for my usecase.

ballingt•4mo ago

Yeah two dots are already excluded

Omar•4mo ago

Sweet

justiceroyale1•2mo ago

@Tom is there a way to resolve the issue where convex fails to compile because convex-test uses crypto ?

erquhart•2mo ago

Tom may follow on with a better solution, but if you're blocked, you can change the name of the file(s) using convex-test to have multiple dots as MapleLeaf did above, eg., myFile.nobundle.ts (or as I do, myFile.test.ts).

ballingt•2mo ago

Adding .test is what I'd do, you don't want to deploy these files as backend endpoints.

justiceroyale1•2mo ago

@Tom I already do what you said but I still get the crypto error message.

ballingt•2mo ago

It looks like you're importing convex-test from a file that isn't a .test.ts file

Add clear and explicit way to exclude files from bundle

Did you find this page helpful?