Show canonical dataset in MetadataView #2546

robyngit · 2024-10-03T21:43:56Z

This PR introduces a feature that a visually identifies a dataset as essentially a duplicate of another in the MetadataView. It does this by adding and modifying some components of the view.

New `CanonicalDatasetHandlerView`

Added a new view, CanonicalDatasetHandlerView that handles identifying and displaying the canonical dataset within a Metadata view.

This new view is a "scoped subview", a self-contained view that is responsible for managing a specific part of UI within a larger parent view. In this case, the CanonicalDatasetHandlerView handles inspecting and modifying specific parts of the already-rendered DOM within the MetadataView. Creating a new view for this purpose avoids adding more complexity to the already very large MetadataView.

The CanonicalDatasetHandlerView is responsible for the following tasks:

Inspects the annotations in the MetadataView to identify a canonical dataset.
- When annotations include both schema.org:sameAs and prov:derivedFrom annotations that have the value, this is assumed to be a reference the DOI of the canonical dataset.
Modifies the MetadataView when a canonical dataset is detected, by:
- Hiding the annotation views that identify the canonical dataset
- Adding a "info icon" that indicates the dataset is essential a duplicate of another dataset. (An info icon is like the "private" or "archived" icons near the title).
- Adds a second citation to the citation modal
- Adds a blue alert box at the top of the page, under the title, that includes the citation to the original dataset

New `CrossRef` model

Introduced a new model to handle querying the CrossRef API for metadata about a DOI, including methods for caching responses and clearing the cache.

Changes to other components

Citation Model

Added properties for issue and methods to extract volume and issue from the source model. Updated getJournalFromSourceModel and getPidFromSourceModel to handle getting these values from a CrossRefModel.

Citation View

Updated the template to include issue and adjust the formatting of the journal, volume, and page information.

Metadata View

Deprecated the metadataInfoIcons template in favour of rendering icons directly in the MetadataView methods. This allows us to reuse the logic for adding a "duplicate" icon in the MetadataView along side the private and archived icons.
Added checks to avoid re-rendering issue
Insert and render the CanonicalDatasetHandlerView

src/js/views/AnnotationView.js

src/js/views/MetadataView.js

- Add a new view, CanonicalDatasetHandlerView, to handle identifying and displaying the canonical dataset for a given dataset - The view removes the annotations that identify the canonical dataset from the metadata view and adds a field to display the canonical dataset url - The view has shell methods to fill in that will make further modifications to the metadata view Issue #2541

- Deprecate the template that rendered the icons previously - Add new methods to MetadataView to render the icons - Call new methods to render the duplicate icon with the CanonicalDatasetHandlerView Issue #2541

The metadata view re-renders when a users' logged in status changes. Depending on the timing of this change, re-rendering may occur in the middle of a previous render. This causes elements of the view to break, especially the new CanonicalDatasetHandlerView. This commit fixes the issue by adding a check to see if the view is already rendering before re-rendering. Issue #2541

Issue #2541

And show the citation modal when the "duplicate" info icon is clicked. Issue #2541

Issue #2541

and add rendering of issue & volume for journal articles in the citation APA template Issue #2541

src/js/models/CitationModel.js

using the new CrossRef model Issue #2541

Handle datasets that have multiple annotations with the sameAs and/or derivedFrom property. Issue #2541

In Metadata view, show the full citation for the canonical dataset in the "Canonical Dataset" section in the general metadata view. Issue #2541

Issue #2541

robyngit · 2024-10-17T18:18:22Z

Changes to do based on feedback from @mbjones:

Move the canonical citation above the "this version" citation in the citation modal
Make the canonical citation on the landing page more prominent, and somewhere near/at the top of the page

Canonical dataset citation is now before the "this version" citation in the citation modal on dataset landing pages. Issue #2541

src/js/views/citations/CitationModalView.js

robyngit · 2024-10-17T19:07:03Z

Also fix a problem found in testing:

datasets that are private but that the logged in user has authorization to view are sometimes shown as private anyways.

In the MetadataView. This ensures that if the logged in status changes, the view will re-render to show the correct information. Issue #2541

Remove the Canonical Dataset field in the General section of dataset landing pages, and instead show a more prominent blue info box at the top of the page with the citation. Issue #2541

Even if we can't fetch DOI info Issue #2541

…source-dataset

github-actions · 2024-12-02T18:43:13Z

src/js/models/CitationModel.js

       * @returns {string} Returns the main identifier for the citation or an
       * empty string.
       * @since 2.23.0
       */
      getID() {
-        const idSources = ["pid", "seriesId", "source_url"];
+        const idSources = ["pid", "seriesId", "source_url", "doi", "DOI"];
        for (let i = 0; i < idSources.length; i++) {


🚫 [eslint] <no-plusplus> _{reported by reviewdog 🐶}
Unary operator '++' used.

rushirajnenuji

Hi @robyngit, this looks great! 🎉

It is great to have the functionality to query Crossref! Tested this on demo ADC and the new elements show up for datasets with source information.

I ran into some unit tests failing, but @robyngit has already added a fix for the same here - #2557

robyngit changed the title ~~Add view to show source dataset in MetadataView~~ Show canonical dataset in MetadataView Oct 3, 2024

github-actions bot reviewed Oct 3, 2024

View reviewed changes

src/js/views/AnnotationView.js Outdated Show resolved Hide resolved

github-actions bot reviewed Oct 3, 2024

View reviewed changes

src/js/views/AnnotationView.js Outdated Show resolved Hide resolved

github-actions bot reviewed Oct 3, 2024

View reviewed changes

src/js/views/MetadataView.js Show resolved Hide resolved

robyngit added 2 commits October 3, 2024 19:12

Move rendering of info icons to MetadataView

6741949

- Deprecate the template that rendered the icons previously - Add new methods to MetadataView to render the icons - Call new methods to render the duplicate icon with the CanonicalDatasetHandlerView Issue #2541

robyngit force-pushed the feature-2541-show-source-dataset branch from 922c13b to 6741949 Compare October 3, 2024 23:12

robyngit added 5 commits October 10, 2024 14:07

Ensure that CanonicalData view works on rerender

aa0dd4e

Issue #2541

Show the source dataset in citation modal

81210d6

And show the citation modal when the "duplicate" info icon is clicked. Issue #2541

Add a model for querying CrossRef

b5359d2

Issue #2541

Allow CrossRef as source dataset for CitationModel

cd22959

and add rendering of issue & volume for journal articles in the citation APA template Issue #2541

github-actions bot reviewed Oct 14, 2024

View reviewed changes

src/js/models/CitationModel.js Show resolved Hide resolved

src/js/models/CitationModel.js Show resolved Hide resolved

Fetch citation info for canonical datasets

5c124bd

using the new CrossRef model Issue #2541

robyngit force-pushed the feature-2541-show-source-dataset branch from 63195fd to 5c124bd Compare October 14, 2024 19:23

robyngit added 2 commits October 14, 2024 16:36

Find canonical dataset w/ 2+ sameAs/derivedFrom

06737f1

Handle datasets that have multiple annotations with the sameAs and/or derivedFrom property. Issue #2541

Show full citation for canonical dataset

a8c111d

In Metadata view, show the full citation for the canonical dataset in the "Canonical Dataset" section in the general metadata view. Issue #2541

robyngit linked an issue Oct 14, 2024 that may be closed by this pull request

Prominently indicate when a data package is essentially a duplicate of an external version #2541

Open

Add a screenshot for the CanonicalDatasetHandler

ce860dd

Issue #2541

robyngit requested a review from rushirajnenuji October 14, 2024 23:02

robyngit assigned rushirajnenuji Oct 14, 2024

robyngit marked this pull request as ready for review October 14, 2024 23:02

Move canon'al dataset to the top of citation modal

270324e

Canonical dataset citation is now before the "this version" citation in the citation modal on dataset landing pages. Issue #2541

github-actions bot reviewed Oct 17, 2024

View reviewed changes

src/js/views/citations/CitationModalView.js Show resolved Hide resolved

src/js/views/citations/CitationModalView.js Show resolved Hide resolved

github-actions bot reviewed Oct 17, 2024

View reviewed changes

src/js/views/citations/CitationModalView.js Show resolved Hide resolved

github-actions bot reviewed Oct 17, 2024

View reviewed changes

src/js/views/citations/CitationModalView.js Show resolved Hide resolved

Trigger "renderComplete" on showIsPrivate

ded5b86

In the MetadataView. This ensures that if the logged in status changes, the view will re-render to show the correct information. Issue #2541

robyngit force-pushed the feature-2541-show-source-dataset branch from 029f128 to ded5b86 Compare October 17, 2024 19:11

Show alert box on duplicate dataset on landing pg

0587969

Remove the Canonical Dataset field in the General section of dataset landing pages, and instead show a more prominent blue info box at the top of the page with the citation. Issue #2541

robyngit mentioned this pull request Oct 21, 2024

Dataset is freezing on "Checking Authorization" #2527

Open

Always show URL for canonical dataset citation

fb532b4

Even if we can't fetch DOI info Issue #2541

robyngit requested review from justinkadi and maggieklope November 4, 2024 21:19

Merge remote-tracking branch 'origin/develop' into feature-2541-show-…

aa2e841

…source-dataset

github-actions bot reviewed Dec 2, 2024

View reviewed changes

rushirajnenuji approved these changes Dec 2, 2024

View reviewed changes

rushirajnenuji merged commit 6e26e2a into develop Dec 2, 2024
1 check failed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show canonical dataset in MetadataView #2546

Show canonical dataset in MetadataView #2546

robyngit commented Oct 3, 2024 •

edited

Loading

robyngit commented Oct 17, 2024 •

edited

Loading

robyngit commented Oct 17, 2024 •

edited

Loading

github-actions bot Dec 2, 2024

rushirajnenuji left a comment

Show canonical dataset in MetadataView #2546

Show canonical dataset in MetadataView #2546

Conversation

robyngit commented Oct 3, 2024 • edited Loading

New CanonicalDatasetHandlerView

New CrossRef model

Changes to other components

Citation Model

Citation View

Metadata View

robyngit commented Oct 17, 2024 • edited Loading

robyngit commented Oct 17, 2024 • edited Loading

github-actions bot Dec 2, 2024

Choose a reason for hiding this comment

rushirajnenuji left a comment

Choose a reason for hiding this comment

robyngit commented Oct 3, 2024 •

edited

Loading

New `CanonicalDatasetHandlerView`

New `CrossRef` model

robyngit commented Oct 17, 2024 •

edited

Loading

robyngit commented Oct 17, 2024 •

edited

Loading