Invalid JSON Schema enforcement of additionalProperties #22349

JacobLey · 2024-03-17T04:03:09Z

Current Behavior

A executor schema that allows an object with arbitrary keys so long as the values match.

Typescript equivalent: Record<{ foo: Record<string, number> }>

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "foo": {
      "type": "object",
      "additionalProperties": {
          "type": "number"
      }
    }
  }
}

Running the executor throws with



 NX   Cannot convert undefined or null to object


TypeError: Cannot convert undefined or null to object
    at Function.keys (<anonymous>)
    at /workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:194:24
    at Array.find (<anonymous>)
    at validateObject (/workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:193:27)
    at validateProperty (/workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:346:9)
    at /workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:210:9
    at Array.forEach (<anonymous>)
    at validateObject (/workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:209:23)
    at validateOptsAgainstSchema (/workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:144:5)
    at combineOptionsForExecutor (/workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:432:5)

Expected Behavior

Executor can run successfully. Schema is treated as valid.

GitHub Repo

No response

Steps to Reproduce

Create an executor schema that has a "type": "object" with "additionalProperties" set to anything but true.
Attempt to run the executor

Nx Report

Node   : 20.11.1
OS     : linux-arm64
pnpm   : 8.15.4

nx (global)  : 18.1.1
nx           : 18.1.1
@nx/eslint   : 18.1.1
@nrwl/tao    : 18.1.1

Failure Logs

NX   Cannot convert undefined or null to object


TypeError: Cannot convert undefined or null to object
    at Function.keys (<anonymous>)
    at /workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:194:24
    at Array.find (<anonymous>)
    at validateObject (/workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:193:27)
    at validateProperty (/workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:346:9)
    at /workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:210:9
    at Array.forEach (<anonymous>)
    at validateObject (/workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:209:23)
    at validateOptsAgainstSchema (/workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:144:5)
    at combineOptionsForExecutor (/workspace/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:432:5)

Package Manager Version

pnpm 8.15.4

Operating System

macOS
Linux
Windows
Other (Please specify)

Additional Information

Offending logic is right where the error logs point us: https://github.com/nrwl/nx/blob/master/packages/nx/src/utils/params.ts#L293

If additionalProperties is found, the logic attempts to get the keys of properties. However there is no guarantee that value exists, and Object.keys(undefined) is an error.

The JSONSchema spec does not specify that properties must be set in order to use additionalProperties (as a general rule of thumb, no fields allow/disallow others).

This logic should default properties to {} in the case where it does not exist.

Alternatively, I recommend switching to a battle tested JSON Schema validator, such as AJV

The text was updated successfully, but these errors were encountered:

ivibe · 2024-03-17T08:52:08Z

I believe this affects linting. The library or application with project.json without

"targets": {
  ...
  "lint": {
    "executor": "@nx/eslint:lint"
  },
  ...
}

will trigger this error when nx run lib-name:lint --verbose

NX   Cannot convert undefined or null to object


TypeError: Cannot convert undefined or null to object

robertIsaac · 2024-03-17T11:08:26Z

I believe this affects linting. The library or application with project.json without
"targets": {
  ...
  "lint": {
    "executor": "@nx/eslint:lint"
  },
  ...
}
will trigger this error when nx run lib-name:lint --verbose
NX   Cannot convert undefined or null to object


TypeError: Cannot convert undefined or null to object

yes it fails for me as well
I tried to debug it
the schema is this object

{
  type: 'object',
  description: 'Environment variables that will be made available to the commands. This property has priority over the `.env` files.',
  additionalProperties: { type: 'string' }
}

in this line https://github.com/nrwl/nx/blob/master/packages/nx/src/utils/params.ts#L293
replacing it with
if (Object.keys(schema.additionalProperties).indexOf(p) === -1 &&
make the error go away

nrwl/nx#22349

mattfysh · 2024-03-18T04:35:32Z

This breaks any usage of nx:run-commands where the env option is defined:

https://github.com/nrwl/nx/blob/master/packages/nx/src/executors/run-commands/schema.json#L121-L126

@robertIsaac I tried your workaround, the error no longer appeared but the environment variables were not present for the running command

robinsjovoll · 2024-03-18T12:20:08Z

This also breaks the usage of the new define options for esbuild in Angular 17.2

grumpyoldman-io · 2024-03-18T14:59:13Z

Running in to the same error as @mattfysh, holistically it surprises me that there is an additionalProperties field on the schema and not a properties field. I think the bug creeped in because of that reason (someone assuming a properties field would be present when additionalProperties are).

Reverting to [email protected] unblocked me - bug introduced here: 4b88f48#diff-55a4c7f03251ea53a875e8157a13c738f318af858ce94f22c44895fa36019602R290

c4spar · 2024-03-20T13:00:07Z

Running into the same issue with the headers option from the dev-server.

The issue exists since 18.1.0-beta.1

{
  // ...
  "serve": {
    "executor": "@angular-devkit/build-angular:dev-server",
    "options": {
      // ...
      "headers": {
        "foo": "bar"
      }
    }
  }
}

$ pnpm nx serve <app> --verbose
TypeError: Cannot convert undefined or null to object
    at Function.keys (<anonymous>)
    at node_modules/nx/src/utils/params.js:194:24
    at Array.find (<anonymous>)
    at validateObject (node_modules/nx/src/utils/params.js:193:27)
    at validateProperty (node_modules/nx/src/utils/params.js:346:9)
    at node_modules/nx/src/utils/params.js:210:9
    at Array.forEach (<anonymous>)
    at validateObject (node_modules/nx/src/utils/params.js:209:23)
    at validateOptsAgainstSchema (node_modules/nx/src/utils/params.js:144:5)
    at combineOptionsForExecutor (node_modules/nx/src/utils/params.js:432:5)

noelsoong · 2024-03-21T21:13:57Z

same issue here

TypeError: Cannot convert undefined or null to object
    at Function.keys (<anonymous>)
    at /Users/noelsoong/Workspace/iticket-stack/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:194:24
    at Array.find (<anonymous>)
    at validateObject (/Users/noelsoong/Workspace/iticket-stack/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:193:27)
    at validateProperty (/Users/noelsoong/Workspace/iticket-stack/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:346:9)
    at /Users/noelsoong/Workspace/iticket-stack/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:210:9
    at Array.forEach (<anonymous>)
    at validateObject (/Users/noelsoong/Workspace/iticket-stack/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:209:23)
    at validateOptsAgainstSchema (/Users/noelsoong/Workspace/iticket-stack/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:144:5)
    at combineOptionsForExecutor (/Users/noelsoong/Workspace/iticket-stack/node_modules/.pnpm/[email protected]/node_modules/nx/src/utils/params.js:432:5)

mattfysh · 2024-03-21T23:07:05Z

Anyone who is running into this error, were you able to track down which option was causing it? For me it was the env option of the nx:run-commands executor

If you apply the fix (see #22426 - use patch-package, pnpm patch, or edit the node_modules folder directly), does the error go away? If yes, is the option that triggered the error being applied or ignored?

In the case of env, after applying the fix the error goes away but the option is not applied (ie. environment variables still not accessible in the command/commands)

jbadeau · 2024-03-26T08:24:50Z

Also an issue with our internal plugins. Any ETA?

robertIsaac · 2024-03-26T19:34:39Z

Anyone who is running into this error, were you able to track down which option was causing it? For me it was the env option of the nx:run-commands executor

If you apply the fix (see #22426 - use patch-package, pnpm patch, or edit the node_modules folder directly), does the error go away? If yes, is the option that triggered the error being applied or ignored?

In the case of env, after applying the fix the error goes away but the option is not applied (ie. environment variables still not accessible in the command/commands)

I actually have no configuration at all
that's the only part related to lint in the whole project

  "plugins": [
    {
      "plugin": "@nx/eslint/plugin",
      "options": {
        "targetName": "lint"
      }
    },
   ...

mattfysh · 2024-03-27T01:30:50Z

@robertIsaac in the case of plugins, they are generating configuration for you

you can see this by running nx show project xyz --web to see the configuration that is generated by the plugin

jon9090 · 2024-03-27T09:27:23Z

I wish to include my custom flag (-t example) when executing the nx angular serve command.

However, I encounter an error from nx indicating:

't' is not found in schema

I intend to intercept this flag within proxy.mjs and handle it accordingly.

What steps should I take to pass this argument without encountering an error?

robertIsaac · 2024-03-28T16:49:16Z

@robertIsaac in the case of plugins, they are generating configuration for you

you can see this by running nx show project xyz --web to see the configuration that is generated by the plugin

aha I see

{
  "cwd": "apps/fe",
  "env": {
    "ESLINT_USE_FLAT_CONFIG": "true"
  }
}

so env was the cause

github-actions · 2024-04-28T00:08:36Z

This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.

JacobLey added the type: bug label Mar 17, 2024

hakalb added a commit to codeware-sthlm/nx-plugins that referenced this issue Mar 17, 2024

refactor(nx-payload): workaround for nx run-commands env bug

368d8b3

nrwl/nx#22349

github-merge-queue bot pushed a commit to codeware-sthlm/nx-plugins that referenced this issue Mar 17, 2024

refactor(nx-payload): workaround for nx run-commands env bug

a6a3529

nrwl/nx#22349

joecowton1 mentioned this issue Mar 18, 2024

build(deps-dev): bump the nx group with 6 updates guardian/csnx#1292

Closed

FrozenPandaz added the scope: core core nx functionality label Mar 18, 2024

MaxKless mentioned this issue Mar 21, 2024

fix(core): handle undefined properties in schemas with additionalProperties #22426

Merged

JSPRH mentioned this issue Mar 21, 2024

chore: migrate to nx 18 kordis-leitstelle/kordis#745

Merged

2 tasks

timonmasberg mentioned this issue Mar 21, 2024

Migrating to 18.1.2 and seeing this error: Cannot convert undefined or null to object #22439

Closed

4 tasks

utarwyn mentioned this issue Mar 23, 2024

Your feedback on beta of nx-go 3 nx-go/nx-go#107

Closed

FrozenPandaz closed this as completed in #22426 Mar 27, 2024

github-actions bot added the outdated label Apr 28, 2024

github-actions bot locked as resolved and limited conversation to collaborators Apr 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Invalid JSON Schema enforcement of additionalProperties #22349

Invalid JSON Schema enforcement of additionalProperties #22349

JacobLey commented Mar 17, 2024

ivibe commented Mar 17, 2024

robertIsaac commented Mar 17, 2024 •

edited

Loading

mattfysh commented Mar 18, 2024 •

edited

Loading

robinsjovoll commented Mar 18, 2024

grumpyoldman-io commented Mar 18, 2024 •

edited

Loading

c4spar commented Mar 20, 2024 •

edited

Loading

noelsoong commented Mar 21, 2024

mattfysh commented Mar 21, 2024

jbadeau commented Mar 26, 2024

robertIsaac commented Mar 26, 2024

mattfysh commented Mar 27, 2024

jon9090 commented Mar 27, 2024

robertIsaac commented Mar 28, 2024

github-actions bot commented Apr 28, 2024

Invalid JSON Schema enforcement of additionalProperties #22349

Invalid JSON Schema enforcement of additionalProperties #22349

Comments

JacobLey commented Mar 17, 2024

Current Behavior

Expected Behavior

GitHub Repo

Steps to Reproduce

Nx Report

Failure Logs

Package Manager Version

Operating System

Additional Information

ivibe commented Mar 17, 2024

robertIsaac commented Mar 17, 2024 • edited Loading

mattfysh commented Mar 18, 2024 • edited Loading

robinsjovoll commented Mar 18, 2024

grumpyoldman-io commented Mar 18, 2024 • edited Loading

c4spar commented Mar 20, 2024 • edited Loading

noelsoong commented Mar 21, 2024

mattfysh commented Mar 21, 2024

jbadeau commented Mar 26, 2024

robertIsaac commented Mar 26, 2024

mattfysh commented Mar 27, 2024

jon9090 commented Mar 27, 2024

robertIsaac commented Mar 28, 2024

github-actions bot commented Apr 28, 2024

robertIsaac commented Mar 17, 2024 •

edited

Loading

mattfysh commented Mar 18, 2024 •

edited

Loading

grumpyoldman-io commented Mar 18, 2024 •

edited

Loading

c4spar commented Mar 20, 2024 •

edited

Loading