Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The Project data class should have a description property like the Package data class has #9443

Open
wkl3nk opened this issue Nov 15, 2024 · 2 comments · May be fixed by #9511
Open

The Project data class should have a description property like the Package data class has #9443

wkl3nk opened this issue Nov 15, 2024 · 2 comments · May be fixed by #9511
Assignees
@fviernau
Labels
enhancement Issues that are considered to be enhancements good first issue An easy issue for new contributors model About the data model

Comments

@wkl3nk
Copy link
Contributor

wkl3nk commented Nov 15, 2024

What is the existing functionality and how should it be enhanced?

In NPM package manager,
there is the concept of a Project and Package.

But while both data classes share attributes like homepageUrl,
only data class Package has attribute description.

But, at least for the case in NPM, projects also have a description line in package.json, and it is not clear to me why homepage should be handled different than description.

Additional context

I had a case with the following error message

java.lang.IllegalArgumentException: Unable to create the AnalyzerResult as it contains packages and projects with the same ids

Yes, the identifiers were the same, but I was wondering why one result had a description, and the other not.

Please handle with low priority or close.
@wkl3nk wkl3nk added enhancement Issues that are considered to be enhancements to triage Issues that need triaging labels Nov 15, 2024
@sschuberth sschuberth added model About the data model and removed to triage Issues that need triaging labels Nov 15, 2024
@fviernau
Copy link
Member

fviernau commented Nov 19, 2024 •
edited
Loading

Which ORT version has been used for observing this?

Apart from that, is the proposal to

  1. Add a description attribute to ORT's Project class
  2. Adjust node package managers to set the description of projects?

@sschuberth
Copy link
Member

Which ORT version has been used for observing this?

I guess that goes not matter. ORT's Project class never had a description property AFAIR.

@sschuberth sschuberth added the good first issue An easy issue for new contributors label Nov 26, 2024
@sschuberth sschuberth changed the title NPM: "Projects" data structure is lacking the "description" attribute The Project data class should have a description property like the Package data class has Nov 26, 2024
@fviernau fviernau self-assigned this Nov 27, 2024
@fviernau fviernau linked a pull request Nov 27, 2024 that will close this issue
Open
fviernau added a commit that referenced this issue Nov 27, 2024
@fviernau
feat(model): Add the property Project.description
92dc0da 
Use a default value to ensure backwards compatible de-serialization.

Fixes #9443.

Signed-off-by: Frank Viernau <[email protected]>
fviernau added a commit that referenced this issue Nov 27, 2024
@fviernau
feat(model): Add the property Project.description
a0310e3 
Use a default value to ensure backwards compatible de-serialization.

Fixes #9443.

Signed-off-by: Frank Viernau <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fviernau fviernau

Labels
enhancement Issues that are considered to be enhancements good first issue An easy issue for new contributors model About the data model
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Introduce a Project description property and support for it in node oss-review-toolkit/ort
3 participants
@sschuberth @wkl3nk @fviernau