#99 - Allow any entity scoring (Breaking changes)

[T0RAT0RA]

This PR enable any entity to be scored.

the URL to fetch json files is updated to be: {jsonDataUrl}/{entityRef.namespace}/{entityRef.kind}/{entityRef.name}.json

Key changes:

• systemScore* variables renamed entityScore*
• Deprecated interfaces: SystemScore, SystemScoreArea, SystemScoreEntry, SystemScoreExtended
• New interfaces: EntityScore, EntityScoreArea, EntityScoreEntry, EntityScoreExtended
• BREAKING: EntityScore has a mandatory key entityRef: CompoundEntityRef (replacement of SystemEntityName)

Scoring an API

// http://localhost:8090/plugins/score-card/sample-data/default/api/api.foo.json
{
  "entityRef": {
    "kind": "api",
    "name": "api.foo"
  },
  "generatedDateTimeUtc": "2021-07-22 10:00",
  "scorePercent": 57,
  ...
}

✔️ Checklist

• Added tests for new functionality and regression tests for bug fixes
• Added changeset (run yarn changeset in the root)
• Screenshots of before and after attached (for UI changes)
• Added or updated documentation (if applicable)

[jvilimek]

Thanks a lot for your tremendous work! And sorry for the delay with the review, I was not feeling well over the weekend. I will also try to check on the test case locally (later this wee).
Another big question is whenever we really need the backwards compatibility, as this makes the code pretty messy and complex.. how about to bump to 0.6 version with a breaking changes?

[T0RAT0RA]

how about to bump to 0.6 version with a breaking changes

Yes, if you're OK with breaking changes, it will greatly simplify the refactor.
I'll update the PR and it will answer a lot of your comments.

[T0RAT0RA]

I cleaned up the code and remove the deprecated types to make the code cleaner.
Next I'll look at the failing test and wrap up the documentation.

Thanks for your feedback!

[jvilimek]

Nice! I have reviewed the last changes and it's OK.
Few last things: would you be please so kind and run also yarn changeset increasing the minor version and describing the breaking changes? Not sure, how this needs to be announced / added to the changeset ... I will take care about the backstage integration and also the SharePoint PowerShell integration.

Also WDYT about the current Readme? I guess we shall change the wording from system to entity...or I can do this in some follow-up PR.

[T0RAT0RA]

I'll do the changeset tomorrow.

increasing the minor version

any particular reason why it's not a major version bump? Since it's a breaking change.

I'll also have another look at the README.

[jvilimek]

I'll do the changeset tomorrow.

Thanks!

any particular reason why it's not a major version bump? Since it's a breaking change.

We follow https://semver.org/ and since the package is still under development, the version starts with zero, it's 0.x.x. Thus increasing minor version is the only option here I believe.

I'll also have another look at the README.

Great, thanks!

[T0RAT0RA]

increasing minor version is the only option here I believe.

Yes you're right, TIL!

I've made the changes to the README and added a changeset.
Let me know if you need more changes.

[jvilimek]

Great work, thanks!