Fix bool enums by Kosta-Github · Pull Request #1080 · redhat-developer/yaml-language-server

Kosta-Github · 2025-06-05T08:03:13Z

What does this PR do?

schema validation is failing for boolean enum values:

schema:

type: object
properties:
  test_value:
    enum: [true, false]

test:

test_value: true # fails validation

What issues does this PR fix or reference?

fix for: #1078

this is the same fix as applied to const values here: e6165e4

Is it tested? How?

The first commit in this PR just introduces a failing unit test show casing the issue.

The test is failing with:

[
  {
    "code": 1,
    "data": {
      "schemaUri": [ "file:///default_schema_id.yaml" ],
      "values": [ true, false ]
    },
    "message": "Value is not accepted. Valid values: true, false.",
    "range": {
      "end": { "character": 15, "line": 0 },
      "start": { "character": 11, "line": 0 }
    },
    "severity": 1,
    "source": "yaml-schema: file:///default_schema_id.yaml"
  }
]

The second commit is fixing the issue and all tests are passing.

coveralls · 2025-06-05T08:07:17Z

coverage: 83.921% (+0.03%) from 83.89%
when pulling db7ffd2 on Kosta-Github:fix-bool-enums
into 2086df4 on redhat-developer:main.

msivasubramaniaan

The fix is not works. When I try to test it my local, still it fails

msivasubramaniaan · 2025-06-12T12:24:41Z

#1083 will fix this one. I will close this PR

Kosta-Github · 2025-06-12T13:56:53Z

not sure, why the fix is not working for you locally?

it was working for me as well as for the CI builds:

datho7561 · 2025-06-12T15:03:08Z

@msivasubramaniaan this fix is working for me on Linux and doesn't cause any regressions. I think it's worth considering. I'll try it again on Windows to make sure it's not a platform dependent bug.

datho7561 · 2025-06-12T15:21:22Z

It's also working on Windows

datho7561

Code looks good and works well. Thanks, Kosta!

The const test case is passing even without the fix,; that's because Muthu fixed it here already: e6165e4 . I think it's okay to leave the test case in.

failing with: ``` [ { code: 1, data: { schemaUri: [ 'file:///default_schema_id.yaml' ], values: [ true, false ] }, message: 'Value is not accepted. Valid values: true, false.', range: { end: { character: 15, line: 0 }, start: { character: 11, line: 0 } }, severity: 1, source: 'yaml-schema: file:///default_schema_id.yaml' } ] ```

this is the same fix for `enum` that has been applied a while back for `const` values here: redhat-developer@e6165e4 fixes issue: redhat-developer#1078

Kosta-Github · 2025-06-12T15:31:01Z

The const test case is passing even without the fix

Exactly, I was looking into the issue already before the const fix came in. I would keep both tests in order to avoid regressions later on...

datho7561 · 2025-06-12T15:33:31Z

@msivasubramaniaan when you have time can you try it again and approve it if it's working?

Dismissing based on David's request. Muthu, if there are still issues, feel free to comment.

datho7561 · 2025-06-12T15:41:34Z

I feel it's worth merging this now, since it fixes the bug, so I'm going to go ahead and do that.

msivasubramaniaan

Sorry for the confusion. I was forgot to restart my YAML LS. Though it didn't take the latest code.

Kosta-Github · 2025-07-04T13:47:28Z

@msivasubramaniaan

is there an idea about when to release the next version of this extension?

I am desperately waiting for this fix to arrive in an update of this extension...

* checked const value for the boolean type * test case added * added positive test case as well * Fix corner case for 'flow sequence forbidden' quickfix - Do not include any trailing spaces in the error range - This is a change in behaviour; it seems this behaviour was intentional based on the test cases, but I don't agree with it, since the error range should only cover the erroneous code. - Fix a bug where `]` or `}` are not included in the error range if they're the last character in the document Fixes redhat-developer#1060 Signed-off-by: David Thompson <davthomp@redhat.com> * added dockercompose and github actions in setting handler Signed-off-by: msivasubramaniaan <msivasub@redhat.com> * Fix YAML JSON Schema files starting with %YAML 1.x Fix a bug where YAML files containing a JSON Schema that start with %YAML 1.x or a comment that contains a number would fail to to be parsed. This is caused by the fact that the JSON Schema parser would contain the number, e.g. 1.2 as the value of `unresolvedJsonSchema.schema` and so the test for `=== undefined` would fail. This would cause the error from the JSON parser to be returned instead of trying to parse the file as a YAML file. To work around this, also check if `unresolvedJsonSchema.schema` is a number. It if is, it clearly was not a JSON Schema and so we can safely try to parse the file as a YAML file. Fixes: redhat-developer#922 Signed-off-by: David Lechner <dlechner@baylibre.com> * show the matching value on top * fix eslint issue * removed enumMarkdown entries * Fix bool enums (redhat-developer#1080) * add (failing) test case for boolean enum and const values failing with: ``` [ { code: 1, data: { schemaUri: [ 'file:///default_schema_id.yaml' ], values: [ true, false ] }, message: 'Value is not accepted. Valid values: true, false.', range: { end: { character: 15, line: 0 }, start: { character: 11, line: 0 } }, severity: 1, source: 'yaml-schema: file:///default_schema_id.yaml' } ] ``` * fix the issue for `boolean` values in `enum` this is the same fix for `enum` that has been applied a while back for `const` values here: redhat-developer@e6165e4 fixes issue: redhat-developer#1078 --------- Co-authored-by: xxx <xxx> * Support draft-04 schemas (redhat-developer#1065) This helps to support the schema for openapi 3.0.0, among others, that use an older draft of JSON schema that has some type differences that make it incompatible with JSON schema draft 07. See redhat-developer#1006 , I think the root cause for the issues that PR caused is that we were trying to download and cache the metaschema from the "URL" instead of using the copy that's bundled with `ajv`. Fixes redhat-developer#780, Fixes redhat-developer#752 (and many, many duplicates we'll have to find and clean up) Signed-off-by: David Thompson <davthomp@redhat.com> * Fix recursion bug in ast-conversion (redhat-developer#1076) * Ensure recursion works as expected * fix test safety for when parse fails * use a cache to keep track of resolved aliases * Added l10n bundle for various language and translate the local strings (redhat-developer#1086) * added l10n bundle for various language and translate the local strings * upstream node * upstream node * update to node 18 * Changed NodeJS.Timeout as per node 18 * upstream to node 20 * updated coversall script * fixed test case * override json service translation * fixed test cases * fix/improve enum value descriptions for merged enum lists (redhat-developer#1085) This is a follow-up submission for redhat-developer#1028, which removes duplicate enum values in merged enum lists. This fix/improvement ensures that the first **non-empty** enum description is used for the corresponding enum value. Before this fix: if the first non-unique enum value was not providing a description but the second one was, it was not picked up and the enum value description stayed empty. Co-authored-by: xxx <xxx> Co-authored-by: Muthurajan Sivasubramanian <93245779+msivasubramaniaan@users.noreply.github.com> * added test cases for bundle and configuration through testhelper class * Fix array of const completion * Fix ignoreScalar in value completion * apply patch * Updated changelog for the release 1.19.0 (redhat-developer#1094) * Updated changelog for the release 1.19.0 * updated chhangelog.md * addressed review comments * @vscode/l10n is a runtime dependency (redhat-developer#1096) * check NODE_AUTH_TOKEN is available or not (redhat-developer#1098) Signed-off-by: msivasubramaniaan <msivasub@redhat.com> * Fix auth on npm publish (redhat-developer#1099) * check NODE_AUTH_TOKEN is available or not Signed-off-by: msivasubramaniaan <msivasub@redhat.com> * set NODE_AUTH_TOKEN --------- Signed-off-by: msivasubramaniaan <msivasub@redhat.com> * Fix auth on npm publish (redhat-developer#1100) * check NODE_AUTH_TOKEN is available or not Signed-off-by: msivasubramaniaan <msivasub@redhat.com> * set NODE_AUTH_TOKEN * set npmAuthToken $NODE_AUTH_TOKEN * set npmAuthToken $NODE_AUTH_TOKEN --------- Signed-off-by: msivasubramaniaan <msivasub@redhat.com> * Update CI.yaml (redhat-developer#1101) just set token to 123 and check what error occur * Revert "Update CI.yaml (redhat-developer#1101)" (redhat-developer#1102) This reverts commit 8c4c22f. * Fix auth on npm publish (redhat-developer#1103) * check NODE_AUTH_TOKEN is available or not Signed-off-by: msivasubramaniaan <msivasub@redhat.com> * set NODE_AUTH_TOKEN * set npmAuthToken $NODE_AUTH_TOKEN * set npmAuthToken $NODE_AUTH_TOKEN * all the required parameters are set --------- Signed-off-by: msivasubramaniaan <msivasub@redhat.com> * Fix the fallback path to the l10n folder (redhat-developer#1104) If the language server client doesn't specify the location of the l10n folder, then the language server falls back to a path relative to the complied file. This path was wrong; `server.js` is in `./out/server/src/server.js`, so the relative path of the `l10n` folder is `../../../l10n` instead of `../l10n`. Signed-off-by: David Thompson <davthomp@redhat.com> * Fix the fallback path to the l10n folder (redhat-developer#1104) (redhat-developer#1105) If the language server client doesn't specify the location of the l10n folder, then the language server falls back to a path relative to the complied file. This path was wrong; `server.js` is in `./out/server/src/server.js`, so the relative path of the `l10n` folder is `../../../l10n` instead of `../l10n`. Signed-off-by: David Thompson <davthomp@redhat.com> Co-authored-by: David Thompson <davidethompson@me.com> * Fix NPM broken (redhat-developer#1095) * set always-auth true * added registry url and release ci on main push for testing * removed main push * renamed to NPM_TOKEN * used YARN_NPM_AUTH_TOKEN * used npm_token * used YARN_NPM_AUTH_TOKEN * added registry-url * tried NODE_AUTH_TOKEN * created .npmrc file * removed .npmrc * check NODE_AUTH_TOKEN available or not * moved the check code on top * checked NPM_TOKEN * tried with NODE_AUTH_TOKEN * Try with NPM instead of YARN * switch to npm * removed install command * fix build issue * fix build issue * done pkg fix * Completely moved to npm from yarn * review comments addressed * Bump serialize-javascript and mocha Bumps [serialize-javascript](https://github.com/yahoo/serialize-javascript) to 6.0.2 and updates ancestor dependency [mocha](https://github.com/mochajs/mocha). These dependencies need to be updated together. Updates `serialize-javascript` from 6.0.0 to 6.0.2 - [Release notes](https://github.com/yahoo/serialize-javascript/releases) - [Commits](yahoo/serialize-javascript@v6.0.0...v6.0.2) Updates `mocha` from 9.2.2 to 11.7.1 - [Release notes](https://github.com/mochajs/mocha/releases) - [Changelog](https://github.com/mochajs/mocha/blob/main/CHANGELOG.md) - [Commits](mochajs/mocha@v9.2.2...v11.7.1) --- updated-dependencies: - dependency-name: serialize-javascript dependency-version: 6.0.2 dependency-type: indirect - dependency-name: mocha dependency-version: 11.7.1 dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> * Remove coveralls dependency (redhat-developer#1107) From my understanding, I think we just need the GitHub Action in order for things to work. Signed-off-by: David Thompson <davthomp@redhat.com> * set .npmrc (redhat-developer#1109) * add encoding dependency * upstream @vsode/l10n dependency * updated changelog.md (redhat-developer#1111) * Fixed broken link to JSON schema website * Fix release GitHub Action - setup-node@v5 creates a .npmrc if you provide a registry, so there should be no need to do that separately - after setup-node@v5 is run, `npm publish` expects the token to be accessible from the environment variable `NODE_AUTH_TOKEN` - also fix coveralls, because that's getting annoying (root cause is that it tried to publish the results for each platform instead of just once) See https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-npm Signed-off-by: David Thompson <davthomp@redhat.com> * Fix prerelease publishing The options that were being used in `npm publish` to modify the version to include the git hash at the end are intended to be used with the `npm version` command beforehand instead. I think this got messed up somewhere along the way while rewriting the GitHub Action. Fixes redhat-developer#1128 Signed-off-by: David Thompson <davthomp@redhat.com> * Upversion to 1.19.1 We burned the 1.19.0 release by publishing a prerelease version labelled 1.19.0. In order to release, we'll need to use a different version number. Signed-off-by: David Thompson <davthomp@redhat.com> * Upversion to 1.20.0 * remove \n in README (redhat-developer#1068) fix typo Signed-off-by: roc <roc@imroc.cc> Co-authored-by: David Lechner <david@lechnology.com> * Wrapping code action title with string (redhat-developer#1117) * Wrapping code action title with string * adding textedit value field wrapped as string * README.md: Mention kate as a Client The `kate` editor has `yaml-language-server` as its default for the YAML format built-in (no plugins or manual configuration needed). * Support `yaml-textmate` and `yaml-tmlanguage` languages * redhat-developer/vscode-yaml#1093 * fix: cast cleanupInterval to any before clearing interval * fix: remove max-warnings option from lint scripts for better flexibility * Remove @microsoft/eslint-formatter-sarif from devDependencies in package.json --------- Signed-off-by: David Thompson <davthomp@redhat.com> Signed-off-by: msivasubramaniaan <msivasub@redhat.com> Signed-off-by: David Lechner <dlechner@baylibre.com> Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: roc <roc@imroc.cc> Co-authored-by: msivasubramaniaan <msivasub@redhat.com> Co-authored-by: David Thompson <davthomp@redhat.com> Co-authored-by: David Lechner <dlechner@baylibre.com> Co-authored-by: Kosta <2526664+Kosta-Github@users.noreply.github.com> Co-authored-by: David Thompson <davidethompson@me.com> Co-authored-by: pjsk-stripe <55514208+pjsk-stripe@users.noreply.github.com> Co-authored-by: Muthurajan Sivasubramanian <93245779+msivasubramaniaan@users.noreply.github.com> Co-authored-by: ShadiestGoat <48590492+ShadiestGoat@users.noreply.github.com> Co-authored-by: Daniel M. Capella <polyzen@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: debbie <148627186+webdevred@users.noreply.github.com> Co-authored-by: roc <roc@imroc.cc> Co-authored-by: David Lechner <david@lechnology.com> Co-authored-by: Arunvenmany <arun.kumar.v.n@ibm.com> Co-authored-by: Niels Thykier <niels@thykier.net> Co-authored-by: RedCMD <33529441+RedCMD@users.noreply.github.com>

Kosta-Github requested a review from msivasubramaniaan as a code owner June 5, 2025 08:03

msivasubramaniaan previously requested changes Jun 12, 2025

View reviewed changes

msivasubramaniaan closed this Jun 12, 2025

Kosta-Github mentioned this pull request Jun 12, 2025

fixed Enum issue on schema.enum value #1083

Closed

datho7561 self-requested a review June 12, 2025 14:51

datho7561 reopened this Jun 12, 2025

datho7561 approved these changes Jun 12, 2025

View reviewed changes

xxx added 2 commits June 12, 2025 11:28

fix the issue for boolean values in enum

db7ffd2

this is the same fix for `enum` that has been applied a while back for `const` values here: redhat-developer@e6165e4 fixes issue: redhat-developer#1078

datho7561 force-pushed the fix-bool-enums branch from cbf0f3b to db7ffd2 Compare June 12, 2025 15:28

datho7561 requested a review from msivasubramaniaan June 12, 2025 15:32

datho7561 merged commit 4370b5c into redhat-developer:main Jun 12, 2025
4 checks passed

msivasubramaniaan reviewed Jun 12, 2025

View reviewed changes

Kosta-Github deleted the fix-bool-enums branch June 12, 2025 16:03

Kosta-Github mentioned this pull request Jul 4, 2025

yaml-schema provides an error when required: true in path- parameters #1088

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix bool enums#1080

Fix bool enums#1080
datho7561 merged 2 commits intoredhat-developer:mainfrom
Kosta-Github:fix-bool-enums

Kosta-Github commented Jun 5, 2025 •

edited

Loading

Uh oh!

coveralls commented Jun 5, 2025 •

edited

Loading

Uh oh!

msivasubramaniaan left a comment

Uh oh!

msivasubramaniaan commented Jun 12, 2025

Uh oh!

Kosta-Github commented Jun 12, 2025

Uh oh!

datho7561 commented Jun 12, 2025

Uh oh!

datho7561 commented Jun 12, 2025

Uh oh!

datho7561 left a comment

Uh oh!

Kosta-Github commented Jun 12, 2025

Uh oh!

datho7561 commented Jun 12, 2025

Uh oh!

datho7561 commented Jun 12, 2025

Uh oh!

Uh oh!

msivasubramaniaan left a comment

Uh oh!

Kosta-Github commented Jul 4, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

Kosta-Github commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

What issues does this PR fix or reference?

Is it tested? How?

Uh oh!

coveralls commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

msivasubramaniaan left a comment

Choose a reason for hiding this comment

Uh oh!

msivasubramaniaan commented Jun 12, 2025

Uh oh!

Kosta-Github commented Jun 12, 2025

Uh oh!

datho7561 commented Jun 12, 2025

Uh oh!

datho7561 commented Jun 12, 2025

Uh oh!

datho7561 left a comment

Choose a reason for hiding this comment

Uh oh!

Kosta-Github commented Jun 12, 2025

Uh oh!

datho7561 commented Jun 12, 2025

Uh oh!

datho7561 commented Jun 12, 2025

Uh oh!

Uh oh!

msivasubramaniaan left a comment

Choose a reason for hiding this comment

Uh oh!

Kosta-Github commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Kosta-Github commented Jun 5, 2025 •

edited

Loading

coveralls commented Jun 5, 2025 •

edited

Loading

Kosta-Github commented Jul 4, 2025 •

edited

Loading