Incorrect StatusCode causing monitoring to flag

[iDVB]

We're seeing a ton of error alerts in this function. At closer inspection we see that its simply when a url is referenced without a required querystring parameter. Eg. "url" or "w". Currently the resulting statusCode is "500" which is why our Monitoring is flagging it.

Shouldn't this be a 4xx series error code? Likely 400 Bad Request ?

The HTTP 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing).

Examples

• StatusCode: 500 "url" parameter is required
• StatusCode: 500 "w" parameter (width) is required

NextJs correctly marks these as "400" errors (not 500)

While OpenNext, marks them as 500

[khuezy]

Ya that makes sense to do. Can you open a PR to address around https://github.com/opennextjs/opennextjs-aws/blob/main/packages/open-next/src/adapters/image-optimization-adapter.ts#L184

I'm not sure if we need to just return the status code from the response, or need to do some logic to decide what error code to return.

[iDVB]

Hey @khuezy I'm not sure I know enough about the inner workings of OpenNext to confidently make a change like this.
Happy to try though. It's just that in some ways I'd be guessing. Looking at those lines, it does appear to me that it should just return the status code its given.

Currently its setup to choose between being a failure or success.... when perhaps it should simply return the same error that Next gives it. At the very least, it should maybe buildSuccessResponse for anything <500 errors and buildFailureResponse for anything >500?

[khuezy]

Yes that sounds good. There's a section in the readme how to run it locally: https://github.com/opennextjs/opennextjs-aws?tab=readme-ov-file#contribute

Give that a shot to see if it works.

Edit: there might be a caveat of the stream handler there. I don't know you can just return the response directly.

[iDVB]

Ya, saw that and was thinking to leave that the same... but take the statusCode from the original event object.

@khuezy Reading the contrib notes. Once the updated code is built.... and we use it to build our nextjs app.
How does one quickly test that part? Seems like you would still need to push that up to AWS to test?

[khuezy]

I thought there was some work to allow you to run ON locally but I haven't done it myself. @conico974 would know but it might be quicker just to deploy a test app until he responds.

[conico974]

@iDVB https://opennext.js.org/aws/contribute/local_run. Be aware there is some issues with monorepo for dev overrides, just don't test on a monorepo.
You want to modify the status code both here

opennextjs-aws/packages/open-next/src/adapters/image-optimization-adapter.ts

Line 205 in 199a26f

statusCode: 500,

and here

opennextjs-aws/packages/open-next/src/adapters/image-optimization-adapter.ts

Line 195 in 199a26f

response.writeHead(500, {

BTW i think we'll need to infer the status code from the error itself (and return 500 by default)

[iDVB]

Ah! perfect! Glad you mentioned Monorepo @conico974 ... as thats us.
I'll just fire up a quick CRA locally to test with.

Not able to get it building locally though:

$user opennextjs-aws % cd packages/open-next 
$user open-next %  node ../opennextjs-aws/packages/open-next/dist/index.js build
node:internal/errors:496
    ErrorCaptureStackTrace(err);
    ^

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'config' imported from /Users/user/Projects/opennextjs-aws/packages/open-next/dist/build/createAssets.js
    at new NodeError (node:internal/errors:405:5)
    at packageResolve (node:internal/modules/esm/resolve:916:9)
    at moduleResolve (node:internal/modules/esm/resolve:973:20)
    at defaultResolve (node:internal/modules/esm/resolve:1206:11)
    at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:404:12)
    at ModuleLoader.resolve (node:internal/modules/esm/loader:373:25)
    at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:250:38)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:76:39)
    at link (node:internal/modules/esm/module_job:75:36) {
  code: 'ERR_MODULE_NOT_FOUND'
}
zsh: parse error near `}'

[conico974]

Looks like your build is incorrect. You called the build script from package.json right ?

[sommeeeer]

I dont think you will get a status code from Next. Only the errorMessage. However, we could probably return a 400 bad req here, or pass a statusCode to use in buildFailureResponse:

opennextjs-aws/packages/open-next/src/adapters/image-optimization-adapter.ts

Line 128 in 195b67d

throw new Error(imageParams.errorMessage);

[iDVB]

@conico974 yes. Ran all the steps to get the dev watch up and running for opennext.... then went to my nextjs site root folder and run the script which is..

  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject",
    "opennext": "node ../opennextjs-aws/packages/open-next/dist/index.js build --config-path open-next.local.config.ts"
  },

[sommeeeer]

@iDVB you need to use node ../opennextjs-aws....

[iDVB]

@sommeeeer sorry that was a typo .... still the same issue.

[sommeeeer]

Upload your testing repo to Github so we can see whats going on here. You are able to build the open-next package right? The problem is when you are trying to do an OpenNext build with that local open-next build?

[iDVB]

The testing repo is just me running

#clone opennext repo
git clone git@github.com:opennextjs/opennextjs-aws.git

# installing / building
cd opennextjs-aws
pnpm install
pnpm build

# running dev
pnpm dev

# install next site
cd ..
npx create-react-app my-app
cd my-app

# putting the open-next.local.confg.ts (from docs) in the root
# putting "opennext": "node ../opennextjs-aws/packages/open-next/dist/index.js build --config-path open-next.local.config.ts" into the package.json scripts

pnpm opennext

> my-app@0.1.0 opennext /Users/user/Projects/my-app
> node ../opennextjs-aws/packages/open-next/dist/index.js build --config-path open-next.local.config.ts

node:internal/errors:496
    ErrorCaptureStackTrace(err);
    ^

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'config' imported from /Users/user/Projects/opennextjs-aws/packages/open-next/dist/build/createAssets.js
    at new NodeError (node:internal/errors:405:5)
    at packageResolve (node:internal/modules/esm/resolve:916:9)
    at moduleResolve (node:internal/modules/esm/resolve:973:20)
    at defaultResolve (node:internal/modules/esm/resolve:1206:11)
    at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:404:12)
    at ModuleLoader.resolve (node:internal/modules/esm/loader:373:25)
    at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:250:38)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:76:39)
    at link (node:internal/modules/esm/module_job:75:36) {
  code: 'ERR_MODULE_NOT_FOUND'
}

Node.js v18.20.5
 ELIFECYCLE  Command failed with exit code 1.

[iDVB]

Sorry everyone. I would love to dive in to fix this as its a PINA for our monitoring right now. However, I don't really have the time atm to troubshoot the contrib dev environment.
If anyone else feels like they have time, we appreciate it. Otherwise completely understand.