Missing null guard causes "Cannot read properties of null (reading 'enum')"

[anderaus]

I believe a bug was introduced in #2934, see link below

Was the @ && null guard removed on purpose? I believe I'm seeing crashes when nimma hits a null node.

Originally posted by @anderaus in #2934

Bug can be reproduced using this input:

{
  "openapi": "3.0.2",
  "info": { "title": "Test", "version": "1.0" },
  "paths": {},
  "components": {
    "examples": {
      "test": {
        "value": {
          "foo": null
        }
      }
    }
  }
}

[DougEdey-Slice]

I think this was an oversight in the original rule, enums do support null values for OAS3.0 and 3.1, so I pushed a PR up to fix it

[nmbrcolin]

I'm seeing the same thing as of a7822fa

  Found 56 rules (45 enabled)
  Linting .../openapi.json
  Error running Spectral!
  Error #1: Cannot read properties of null (reading 'enum')
            at name === 'Array')]  ../../../../../usr/local/lib/node_modules/@stoplight/spectral-cli/node_modules/nimma/dist/legacy/cjs/core/index.js:66        _rollupPluginBabelHelpers.classPrivateFieldSet(this, _compiledFn, Function(globals,
  ...(_rollupPluginBabelHelpers.classPrivateFieldGet(this, _fallback) === null ? [] : Array.from(_rollupPluginBabelHelpers.classPrivateFieldGet(this, _fallback).runtimeDeps.keys())), code)(index$1,
  ...(_rollupPluginBabelHelpers.classPrivateFieldGet(this, _fallback) === null ? [] : Array.from(_rollupPluginBabelHelpers.classPrivateFieldGet(this, _fallback).runtimeDeps.values()))));
            at eval                ../../../../../usr/local/lib/node_modules/@stoplight/spectral-cli/node_modules/nimma/dist/legacy/cjs/core/index.js:66        _rollupPluginBabelHelpers.classPrivateFieldSet(this, _compiledFn, Function(globals,
  ...(_rollupPluginBabelHelpers.classPrivateFieldGet(this, _fallback) === null ? [] : Array.from(_rollupPluginBabelHelpers.classPrivateFieldGet(this, _fallback).runtimeDeps.keys())), code)(index$1,
  ...(_rollupPluginBabelHelpers.classPrivateFieldGet(this, _fallback) === null ? [] : Array.from(_rollupPluginBabelHelpers.classPrivateFieldGet(this, _fallback).runtimeDeps.values()))));
            at _traverseBody       ../../../../../usr/local/lib/node_modules/@stoplight/spectral-cli/node_modules/nimma/dist/legacy/cjs/runtime/traverse.js:13  cb(scope);


            at _traverse           ../../../../../usr/local/lib/node_modules/@stoplight/spectral-cli/node_modules/nimma/dist/legacy/cjs/runtime/traverse.js:41  _traverseBody(key, curObj, scope, cb, deps);


            at _traverseBody       ../../../../../usr/local/lib/node_modules/@stoplight/spectral-cli/node_modules/nimma/dist/legacy/cjs/runtime/traverse.js:17  _traverse(value, scope, cb, deps);

[amany9000]

Hello, I'm seeing the same issue while Linting with spectral-cli@6.16.0:

Error running Spectral!
Error #1: Cannot read properties of null (reading 'enum')
          at name === 'Array')]  …js/core/index.js:66  _rollupPluginBabelH…
          at eval                …js/core/index.js:66  _rollupPluginBabelH…
          at _traverseBody       …time/traverse.js:13  cb(scope);          
          at _traverse           …time/traverse.js:41  _traverseBody(key, …
          at _traverseBody       …time/traverse.js:17  _traverse(value, sc…

[slegarraga]

Thanks for the clear repro — this traces to the JSONPath filter change in #2934 (my PR): dropping the @ && null guard means nimma evaluates @.enum on null nodes (e.g. foo: null in example values) and throws.

#2960 restores a null check (@ != null) while keeping the array filter from #2934. I’ve approved #2960; once merged this should fix the crash for the reproducer above.

Sorry for the regression — I’ll add an explicit regression test for the example-value case in a follow-up if #2960 doesn’t include it.

[slegarraga]

Opened #2963 as a focused follow-up to #2934 with the exact reproducer test case. Overlaps #2960 — maintainers can land either; both restore the null guard.

[emmaLP]

Seeing this behaviour in 6.15.0 as of today when the OopenAPi yaml file has not changed.

Tried the following versions and getting the issue still:

1. 6.16.0
2. 6.14.0

any update on when this will be resolved

[slegarraga]

@emmaLP No fixed release date yet — fix is in flight via #2960 or #2963 (null guard on `duplicated-entry-in-enum` JSONPath, regression from a recent ruleset change). Workaround until merge: temporarily disable that rule in your ruleset if linting is blocked.

Will post here when a release including the fix ships.

[DougEdey-Slice]

@emmaLP If you don't want to disable the rule you can install the older ruleset with -p @stoplight/spectral-rulesets@1.22.2 (if you're using a similar invocation to us: npx --yes -p @stoplight/spectral-cli@v6.16.0 -p @stoplight/spectral-rulesets@1.22.3 spectral lint openapi.json --verbose

[emmaLP]

@DougEdey-Slice that's a great workaround, thank you!

[slegarraga]

For anyone still blocked: fix landed in open PRs #2960 / #2963 (null guard on the duplicated-entry-in-enum JSONPath). Workaround until release: pin @stoplight/spectral-rulesets@1.22.2 or disable that rule in your ruleset.