GSoC`22 - Refactored workbench to react+typescript v4.0 & schema updates for latest version

[OmkarPh]

Signed-off-by: Omkar Phansopkar [email protected]

[OmkarPh]

Try out - https://github.com/OmkarPh/scancode-workbench/releases/tag/v4.0.0_beta4

[AyanSinhaMahapatra]

This looks great, thanks! We should merge and cut a release after reviewing.

@pombredanne could you try out and approve?

[steven-esser]

Thanks for the hard work @OmkarPh, this is great.

I will leave it to @pombredanne and the nexB team to determine how/when they want to merge this in and release a new version.

[pombredanne]

We need an ABOUT file for this.

[OmkarPh]

hey, @pombredanne
can you share an example or basic Outline for this ABOUT file
@AyanSinhaMahapatra , maybe you've some inputs on this

[AyanSinhaMahapatra]

@OmkarPh sorry I missed this,

• for a package this might look like: https://github.com/nexB/thirdparty-packages/blob/main/pypi/Babel-2.10.1.tar.gz.ABOUT
• for a file: it could be like: https://github.com/nexB/scancode-toolkit/blob/develop/src/scancode/pool.py.ABOUT

Basically a download_url with license/copyright information and any other info you can find for giving credits/attribution. You might also need to add a copy of the license file if applicable, like the second example above in some cases depending on the license.

[OmkarPh]

I've created about file for the image asset https://github.com/OmkarPh/scancode-workbench/blob/v4.0-react-typescript/assets.ABOUT
I also added it in attribution window

Rest, I couldn't find any piece of code that I've directly copied from the internet
except for the official docs

[AyanSinhaMahapatra]

Use license instead of usage_terms, and the about file should be just beside the file which you are describing, and the filename would be: addFiles.png.ABOUT.

The terms and conditions in https://storyset.com/terms looks good to me, since it says The authorization to use the Storyset Content shall be free provided that any use of the Storyset Content by the User is credited to the Company/Website as stated by the Company from time to time. but this needs to also be reviewed by @pombredanne .

Thanks!

[mjherzog]

The TOS are significantly more complex than the "Authorization to use...." sentence so we need to look at the whole TOS. I do not see a problem, but we need to review in more detail.

[OmkarPh]

updated: https://github.com/OmkarPh/scancode-workbench/blob/v4.0-react-typescript/src/assets/images/Addfiles.png.ABOUT

[martin-langhoff]

Testing your PR

• branch builds on my Mac OS 12.6.1 with Node from Brew (whereas develop is broken on node-gyp)
• tested with an input report.json built with latest 'develop' commit in scancode-toolkit, the test run was over the git source code repo
• Import worked well
• In dashboard, Copyright Holders looks a bit odd (screencap below)
• License info dashboard had no data, this is incorrect (JSON file has license data)

[martin-langhoff]

Also, npm install had all sorts of complaints about versions being stale and in conflict. So the good news is npm-gyp behaved. But npm thinks deps are stale and the developer should run npm audit to figure out what deps have critical updates.

[OmkarPh]

Thanks for your review. @martin-langhoff

• branch builds on my Mac OS 12.6.1 with Node from Brew (whereas develop is broken on node-gyp)

yeah, 'develop' is the legacy code, so we don't expect wonders from it ;)

tested with an input report.json built with latest 'develop' commit in scancode-toolkit, the test run was over the git source code repo

the schema in workbench needs some minor updates to support the latest scancode-toolkit scans, that's our next goal

• In dashboard, Copyright Holders looks a bit odd (screencap below)

we've to look for a better charts library, that handles such responsive issues

License info dashboard had no data, this is incorrect (JSON file has license data)

it's again because of non-updated schema ;)

PS: In case you want to use the workbench for usage, other than testing
You can use this for now https://github.com/OmkarPh/scancode-workbench/releases/tag/v4.0.0_beta4

[OmkarPh]

hi @pombredanne
any update on this :)

[AyanSinhaMahapatra]

@OmkarPh Thanks a lot for the amazing work! This is fantastic. I've tested out the linux build locally and works great. So please go ahead and merge this as is and we'll track more improvements separately. Thank you for the quick fixes on the JSONStreams dependency issue and other open issues opened by @mjherzog too.

A few nits: we need to update the sample scans and readme to be consistent with our workbench supported versions on scancode-toolkit and also document this well enough so there's no confusion, but I'll open a separate issue for that.

Thanks ++ again