Static API route with wildcard causes file-system conflicts

[fuma-nama]

when there's an empty path in staticPaths, the error can be reproduced.

// _api/llms.mdx/docs/[...slugs].ts
import { ApiContext } from 'waku/router';
import { unstable_notFound } from 'waku/router/server';

export async function GET(_: Request, { params }: ApiContext<'/llms.mdx/docs/[...slugs]'>) {
  const slugs = params.slugs;
  console.log(slugs);
  return new Response('hello world', {
    headers: {
      'Content-Type': 'text/markdown',
    },
  });
}

export async function getConfig() {
  return {
    render: 'static' as const,
    staticPaths: [[], ['test']],
  } as const;
}

[dai-shi]

@tylersayshi ? (not sure if it's router specific issue.)

[fuma-nama]

Also when the empty path is removed, I noticed that params is always empty:

(last line is from console.log(params))

[tylersayshi]

My understanding is that this error is thrown correctly. It leads to a collision with /llms.mdx/docs which I'm assuming you've defined as it's own api route too. Is that right?

What's your expected behavior with the empty path?

[fuma-nama]

No, only this route handler is defined at this path, and same setup works on all other major frameworks.

[tylersayshi]

@dai-shi from the error log - I suspect the problem is in build-static-files.ts. It is calling mkdir but should be mkdir -p?

To me it looks like it's only erroring because it's attempting to create the folder twice.

[dai-shi]

I suspect the problem is in build-static-files.ts. It is calling mkdir but should be mkdir -p?

Do you mean this?

waku/packages/waku/src/lib/vite-plugins/build-static-files.ts

Line 46 in f0471c7

await mkdir(joinPath(destFile, '..'), { recursive: true });

It has { recursive: true }.

So, do you think it's a bug outside of the router? I can take a closer look then.

[tylersayshi]

It was a router issue afterall - sorry for my initial confusion

[fuma-nama]

thanks for looking into it, I have also realized the behaviour of Next.js differs depending on export, and on static export it is indeed impossible. On other modes, Next.js with generateStaticParams() still support it (they probably re-routed empty segments from server). So my initial description was probably wrong.

But the real problem is that params will always be an empty object, even after appending index.mdx to all static paths (which solved the path duplication problem).

[tylersayshi]

after appending index.mdx to all static paths (which solved the path duplication problem).

Do y'all think using index.mdx as the route instead of supporting [] as a route is the cleaner way to solve this?

We could error on submission of [] as a staticPath and suggest using index.foo instead?

But the real problem is that params will always be an empty object

noted - this stands on it own as a bug

[fuma-nama]

We could error on submission of [] as a staticPath and suggest using index.foo instead?

Yeah I think so, would be a better DX to have an error message. /[...slugs].ts cannot have empty path but /[...slug]/index.mdx.ts works with empty path.