Spectral Linter: Provided ruleset is not an object

[mprinold]

When implementing the Spectral Linter plugin i am finding that it does not want to accept the rulesets, i am using the example rules files you use in your dev examples:

config:

spectralLinter:
  openApiRulesetUrl: 'https://gist.githubusercontent.com/dweber019/a368819668a76363849db6378792e907/raw/backstage-spectral-linter-openapi-ruleset.yaml'

only error message is presented in the ui

[Aaron-Mackay]

Hi, I've also been having this problem, though I've been using "spectral:oas" for that URL. The problem seems to arise from this.ruleset = ruleset instanceof ruleset_1.Ruleset ? ruleset : new ruleset_1.Ruleset(ruleset); in node_modules/@dweber019/backstage-plugin-api-docs-spectral-linter/node_modules/@stoplight/spectral-core/dist/spectral.js, as it seems to return negative when checking the instanceof, and then fail the assertion in the constructor of the Ruleset (I think because it's already gone through the process?)

I can't quite work out why it's returning false, but will keep investigating and post here if I find a solution.

[Aaron-Mackay]

Looks like the reason is because of the origin of the ruleset_1 import, instanceof sees them as different if the classes are from separate places. Not 100% sure on a proper fix (changing the import to const ruleset_1 = require("../../../../../../@stoplight/spectral-core"); works, but doesn't feel quite right).

[dweber019]

Thanks @Aaron-Mackay came to same conclusion as you. Could you create a issue at spotlight for this problem?

[Aaron-Mackay]

Hi @dweber019 , I've been looking at it some more this morning, and found a possible different root.

It appears that normally, under node_modules/@dweber019/backstage-plugin-api-docs-spectral-linter/node_modules/@stoplight, there are only spectral-core and types. If you manually copy in spectral-ruleset-bundler from the root node_modules, everything works fine.

Unfortunately I don't have the expertise to understand why npm doesn't install the bundler locally to the plug-in - is there something that needs to be changed in the plugin's package.json?

[dweber019]

I created a patch / workaround in version @dweber019/backstage-plugin-api-docs-spectral-linter@0.4.10 for the plugin.
This is only a temporary fix until the upstream project has fixed it.

[anchitsingla]

@dweber019 It is not working for me still. Is it fixed ?

[dweber019]

@anchitsingla could you try 0.4.11

[anchitsingla]

@dweber019 I have tried it but still getting the same error

[lambav]

@dweber019 This isn’t working. Any update on this ?

[dweber019]

Yes, working on it. With the latest fix, at least in the Backstage instance I maintain in my company, it works.
Are you able to reproduce the issue with this repo or do you have me some logs, errors.

[dkadirbekovbeeline]

I have same problem with ^0.4.11 version. No logs in browser console. Spectral file is fetched successfully.

[lambav]

@dweber019 Hi David, Can you pls update on it. Do you have any plans sooner ?

Or provide some points so that others can contribute

[dweber019]

@lambav Just released an update of the plugins, for me it's working after the update in our enterprise instance.
Could you try again?

[anchitsingla]

@dweber019 After upgrading the plugin to the latest update, I am still getting the same issue, spectral rule is properly loading and can see in the network tab but still getting Provided ruleset is not an object