Cannot find module 'next/dist/next-server/server/api-utils.js' from 'node_modules/next-test-api-route-handler/dist/index.js'

[willnix86]

The problem

Using Next 11.0.1 and NTARH 2.0.1, when running tests I receive the following error:

Cannot find module 'next/dist/next-server/server/api-utils.js' from 'node_modules/next-test-api-route-handler/dist/index.js'

If I look in the next node_modules folder, the correct path is 'next/dist/server/api-utils.js'

[Xunnamius]

Ah, yeah, the NextJS devs have the api-utils in four different locations across several versions 😅. This should be accounted for in the latest version of NTARH (v2.2.1). If you are able to update, does the problem go away?

[willnix86]

So if I update, I end up with a bunch of errors saying that ‘undefined’ should be string value or Array Buffer, or something like that. Can’t remember off the top of my head - for now, I just reverted to Next 11.0.1 and everything works fine! Will Nixon Software Developer 310-463-0567 willnixon.dev <https://www.willnixon.dev/> Lemmi - the app that lets you chat <https://www.lemmichat.com/>

…

On Sep 1, 2021, at 4:59 PM, Bernard ***@***.***> wrote: Ah, yeah, the NextJS devs have the api-utils in four different locations across several versions 😅. This should be accounted for in the latest version of NTARH (v2.2.1). If you are able to update, does the problem go away? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#320 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AH7LOCARUIEKGBRUE5UKTPLT7ZEXVANCNFSM5DGUZI2Q>.

[Xunnamius]

Just to be sure: I meant only update NTARH, not NextJS. The latest NTARH should work with the older NextJS v11.0.x (integration tests are passing at least).

[willnix86]

So, updating to 2.2.1 gives me this error:

TypeError [ERR_INVALID_ARG_TYPE]: The "string" argument must be of type string or an instance of Buffer or ArrayBuffer. Received undefined

  at ServerResponse.apiRes.end (node_modules/next/server/api-utils.ts:77:33)
  at onerror (node_modules/next-connect/dist/index.cjs:4:47)
  at node_modules/next-connect/dist/index.cjs:16:16
  at apiResolver (node_modules/next/dist/server/api-utils.js:101:9)

[Xunnamius]

Interesting, this seems like the NextJS resolver function itself might have a problem with your handler, since NTARH doesn't call res.end (only your handler and the resolver do).

First, does your handler code run in NextJS normally without errors?

Second, can you show me the code around your usage of the testApiHandler function and the handler you're testing? Or better yet, if you can spin up a tiny dummy repo that reproduces your error, I can pinpoint the problem 🙂

[willnix86]

Of course! So, here's an example of how i use testApiHandler:

it("should fail if no parameters are passed", async () => {
await testApiHandler({
handler: storeMapHandler,
test: async ({ fetch }) => {
const res = await fetch({ method: "POST", headers, body: null });
expect(res.status).toBe(400);
expect(
((await res.json()) as FailedResponse).error.includes(
"Missing or Empty"
)
).toBe(true);
},
});
});

And here's the code for the handler itself:

import { VarBinary, MAX, PreparedStatement } from "mssql";
import nextConnect from "next-connect";
import { NextApiResponse } from "next";
import sessionMiddleware from "../middlewares/session";
import dbUtils from "../../../utils/db";
import { createBufferFromJSON } from "utils/helpers";
import { SessionedNextApiRequest } from "types/auth.types";

const handler = nextConnect();
handler.use(sessionMiddleware);

handler.post(
async (req: SessionedNextApiRequest, res: NextApiResponse, next) => {
if (req.headers["content-type"] !== "application/json") {
res.status(400).json({
error: Content-Type must be JSON,
});
next(res);
}

const { id, mapProps } = req.body;

interface Body {
  [key: string]: any;
}
const body: Body = {
  user_id: req.user_id,
  map_id: id,
  map_properties: mapProps,
};

const requiredFields = ["user_id", "map_id", "map_properties"];
requiredFields.forEach((field) => {
  if (!body.hasOwnProperty(field) || field === "" || !body[field]) {
    res.status(400).json({ error: `Missing or Empty ${field}` });
    next(res);
  }
});

const { map_id, user_id, map_properties } = body;

try {
  await dbUtils.connect();
  await dbUtils.executePreparedStatementFunction(
    async () =>
      await executeStoreMap(map_id, Number(user_id), map_properties)
  );
  res.status(200).end();
  next(res);
} catch (error) {
  res.status(400).json({ error });
  next(res);
}
next(res);

}
);

// There's no way for us to convert Strings to SQL Blobs ourselves, so have to use a PreparedStatement here.
const executeStoreMap = async (
map_id: string,
user_id: number,
map_properties: string
) => {
const mapProps = createBufferFromJSON(map_properties);
const statement = new PreparedStatement(dbUtils.db);
statement.input("mapProps", VarBinary(MAX));
await statement.prepare(INSERT INTO ${process.env.SHARED_MAPS_TABLE_NAME}(id, user_id, map_properties) VALUES('${map_id}', ${user_id}, @mapProps));
await statement.execute({ mapProps });
await statement.unprepare();
};

export default handler;

[Xunnamius]

Closing this in favor of #378. If this is a different issue and/or this wasn't solved by upgrading to next-test-api-route-handler@2.2.1, let me know and I'll reopen this.