249 - File Page boilerplate #260

MellyGray · 2023-12-13T17:15:11Z

What this PR does / why we need it:

This PR adds the boilerplate of the File Page. A basic page to display the files details. The boilerplate includes these features:

Features:

File page with the File title and a reference to it's dataset
The files in the Dataset page files table should have a link to it's file page
Loading page
Page not found if the file is not found

Which issue(s) this PR closes:

Closes Set up the boilerplate for the File Page #249

Special notes for your reviewer:

This is just the most basic version of the page. We'll add more components to the page in other issues.

I had to refactor the Dataset mode so the DatasetVersion property could be extracted and added to the File model since all of the dataset version data will be needed to implemented the File page

Suggestions on how to test this:

Install the necessary dependencies using npm install.
Build the design system with cd packages/design-system && npm run build.
Navigate back to the root directory with cd ../../.
Start Storybook with npm run storybook.
Visit the File Page in the Storybook

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Mock

Is there a release notes update needed for this change?:

File Page added to the SPA beta

Additional documentation:

coveralls · 2023-12-13T17:21:37Z

coverage: 97.805% (-0.1%) from 97.922%
when pulling 1f28e78 on feature/249-boilerplate-file-page
into baa7faf on develop.

pdurbin · 2023-12-13T20:08:21Z

I took a quick peek at https://646f68aa9beb01b35c599acd-naljpjbrwa.chromatic.com/?path=/story/pages-file--default

…into feature/249-boilerplate-file-page

MellyGray · 2023-12-15T13:52:49Z

I'm putting this back to 'in progress' because I need to refactor the Dataset model to extract some properties and include them in the DatasetVersion to then add this dataset version to the new File model. We'll need some dataset version information to display it on the file page. This refactor will impact all the upcoming file page issues, so I think it's better to do the refactor in this branch, which will serve as the parent for the rest of the file components branches

GPortas · 2023-12-22T10:50:11Z

src/files/domain/models/File.ts

-  get isTabularData(): boolean {
-    return this.tabularData !== undefined
-  }
+export interface File {


It is a bit confusing that the class with the largest number of properties is the "preview", while "File" is only an interface with two properties.

I see your point, but the File model is not finished yet, and when the File Page is finished the File model will contain all the FilePreview properties plus the file versions, plus the file metrics, etc. So at the end the File model will be larger than the File Preview, even though right now it's smaller because we only have the boilerplate properties.

Also, the way I see it is that in the Files Table of the Dataset View we're displaying the file information preview, while in the File View we're seeing the actual file.

Does it make sense to you?

Makes sense. Thanks!

GPortas

Overall it looks good

I left a comment about a naming issue.

On the other hand, storybook looks good for Default and Loading states:

But for File Not Found, I see a reference to "Demo Dataverse" which is not correct. I assume it was introduced by mistake due to a string copied from the demo installation.

MellyGray · 2024-01-08T09:39:30Z

But for File Not Found, I see a reference to "Demo Dataverse" which is not correct. I assume it was introduced by mistake due to a string copied from the demo installation.

I removed the last sentence of the alert to match the message in beta:

GPortas

LGTM

…the-file-page 262 - File labels section of the File page

M27Mangan · 2024-01-13T20:46:50Z

src/stories/dataset/dataset-action-buttons/DatasetActionButtons.stories.tsx

@@ -27,15 +27,14 @@ export const WithPublishPermissions: Story = {
    <DatasetActionButtons
      dataset={DatasetMother.create({
        permissions: DatasetPermissionsMother.createWithAllAllowed(),
-        version: DatasetVersionMother.createDraftAsLatestVersion(),
+        version: DatasetVersionMother.createDraftAsLatestVersionWithSomeVersionHasBeenReleased(),


Can you walk me through what this method does? I would like to try for a shorter name that is still as descriptive.

This method creates a mock of the dataset version, the name tries to describe that this dataset version is a draft and it's the latest version available of the dataset + some version of the dataset has been released

This means that the dataset is published and the retrieved version is a draft which is also the latest version available

M27Mangan · 2024-01-13T20:58:55Z

tests/component/files/domain/models/FilePreviewMother.ts

+      ingest: FileIngestMother.createIngestProblem(reportMessage)
+    })
+  }
+}


Similarly to your previous comments on "CreateDatasetMaster", components using "Mother" as an identifier should be renamed in the interest of adopting inclusive and non-gendered language. Please consider an alternative such as

FilePreviewBase: This name indicates that the file serves as a base or a template for creating FilePreview objects, adhering to the principles of object-oriented programming.

FilePreviewTemplate: This alternative emphasizes that the file acts as a template or a blueprint for FilePreview instances.

FilePreviewFactory: In the context of design patterns, "Factory" suggests that this file is responsible for creating instances of FilePreview, fitting well with the file's content.

FilePreviewGenerator: This name implies that the file's purpose is to generate FilePreview objects, which is descriptive of its functionality.

FilePreviewCreator: Similar to "Generator," "Creator" indicates that the file is involved in the creation process of FilePreview objects.

FilePreviewBuilder: This name suggests that the file's role is to build or construct FilePreview instances, aligning with the builder pattern in software design.

FilePreviewSource: This general term indicates that the file is the source for FilePreview objects.

The same should be done for DatasetMother, but I can open another issue for that.

The 'Mother' portion of the name simply refers to the Object Mother pattern. It's not precisely a Factory or a Builder class, which is why it carries its unique pattern designation.

I understand your concerns regarding the gender implications of the name. However, including other names would alter its meaning.

We could include an explanation about this pattern and its naming in the documentation.

I also asked about "mother" and I do think it would be nice to link to that Martin Fowler article from a comment or other docs. Good idea.

@M27Mangan correct me if I'm wrong but I think you were working on this issue:

[Docs] Dataverse Frontend Guide #26

Should we add the Martin Fowler article to that guide or should I add it to the README?

The problem with linking the article from a comment is that there are several files where the Mother suffix is used so I'm not sure where to place it

Maybe just the README for now? Or in a list of TODOs (to document) in this issue?

[Docs] Dataverse Frontend Guide #26

I updated the issue description to add the list of TODO's

…into feature/249-boilerplate-file-page

GPortas · 2024-01-19T09:21:04Z

I just retested the branch and it looks good, merging.

249 - File Page boilerplate

MellyGray added 4 commits December 13, 2023 16:13

feat(FilePage): add the File Page

c5852c6

feat(FilePage): add loading state

df0a00b

feat(FilePage): add file not found state

4090af5

feat(FilePage): add route to the page

9864ba1

MellyGray added Size: 3 A percentage of a sprint. 2.1 hours. UI Tasks related to the user interface (UI) or frontend development labels Dec 13, 2023

MellyGray linked an issue Dec 13, 2023 that may be closed by this pull request

Set up the boilerplate for the File Page #249

Closed

MellyGray marked this pull request as ready for review December 13, 2023 17:15

This was referenced Dec 14, 2023

Add the FileCitation section to the File Page #261

Closed

Add the FileLabels section to the File Page #262

Closed

Add the FileMetadata section to the File Page #263

Closed

Add the AccessFile button to the File Page #264

Closed

Merge branch 'develop' of https://github.com/IQSS/dataverse-frontend …

9c3a455

…into feature/249-boilerplate-file-page

MellyGray self-assigned this Dec 15, 2023

MellyGray marked this pull request as draft December 15, 2023 13:53

MellyGray added 2 commits December 15, 2023 16:44

refactor: move citation to DatasetVersion

37180ad

refactor: move title to DatasetVersion

62b69b2

M27Mangan self-requested a review December 15, 2023 20:51

refactor: move labels to DatasetVersion

030b794

feat(FilePage): add datasetVersion property to File model

3d4c78a

MellyGray added Size: 10 A percentage of a sprint. 7 hours. and removed Size: 3 A percentage of a sprint. 2.1 hours. labels Dec 19, 2023

refactor: pass datasetVersionNumber as files use cases argument

e1ed09a

MellyGray added 2 commits December 21, 2023 16:12

feat(FileLabels): add DatasetLabels to File Page

3cbbd40

refactor: FileFileAccessRestrictedIcon move to file folder

b7bc8ce

GPortas self-assigned this Dec 22, 2023

GPortas reviewed Dec 22, 2023

View reviewed changes

feat(FileLabels): add Restricted icon to File Labels

9b1c321

GPortas requested changes Jan 2, 2024

View reviewed changes

GPortas assigned MellyGray Jan 2, 2024

GPortas added pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows labels Jan 3, 2024

GPortas removed their assignment Jan 4, 2024

fix: remove demo dataverse reference in page not found message

95fd1a3

fix: e2e test year dependence

4f9728e

MellyGray assigned GPortas and unassigned MellyGray Jan 8, 2024

GPortas approved these changes Jan 8, 2024

View reviewed changes

GPortas removed their assignment Jan 8, 2024

Merge pull request #271 from IQSS/feature/262-file-labels-section-of-…

b5f65e2

…the-file-page 262 - File labels section of the File page

M27Mangan reviewed Jan 13, 2024

View reviewed changes

M27Mangan suggested changes Jan 13, 2024

View reviewed changes

Merge branch 'develop' of https://github.com/IQSS/dataverse-frontend …

1f28e78

…into feature/249-boilerplate-file-page

MellyGray mentioned this pull request Jan 17, 2024

[Docs] Dataverse Frontend Guide #26

Closed

1 task

GPortas self-assigned this Jan 19, 2024

GPortas merged commit 4dba60a into develop Jan 19, 2024
11 of 14 checks passed

GPortas deleted the feature/249-boilerplate-file-page branch January 19, 2024 09:21

jayanthkomarraju pushed a commit to jayanthkomarraju/dataverse-frontend that referenced this pull request May 31, 2024

Merge pull request IQSS#260 from IQSS/feature/249-boilerplate-file-page

9a59b1c

249 - File Page boilerplate

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

249 - File Page boilerplate #260

249 - File Page boilerplate #260

MellyGray commented Dec 13, 2023 •

edited

Loading

coveralls commented Dec 13, 2023 •

edited

Loading

pdurbin commented Dec 13, 2023

MellyGray commented Dec 15, 2023 •

edited

Loading

GPortas Dec 22, 2023

MellyGray Jan 8, 2024

GPortas Jan 8, 2024

GPortas left a comment •

edited

Loading

MellyGray commented Jan 8, 2024

GPortas left a comment

M27Mangan Jan 13, 2024

MellyGray Jan 15, 2024

M27Mangan Jan 13, 2024

MellyGray Jan 15, 2024 •

edited

Loading

pdurbin Jan 16, 2024

MellyGray Jan 16, 2024

pdurbin Jan 16, 2024

MellyGray Jan 17, 2024

GPortas commented Jan 19, 2024

249 - File Page boilerplate #260

249 - File Page boilerplate #260

Conversation

MellyGray commented Dec 13, 2023 • edited Loading

What this PR does / why we need it:

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Mock

Is there a release notes update needed for this change?:

Additional documentation:

coveralls commented Dec 13, 2023 • edited Loading

pdurbin commented Dec 13, 2023

MellyGray commented Dec 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GPortas left a comment • edited Loading

Choose a reason for hiding this comment

MellyGray commented Jan 8, 2024

GPortas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MellyGray Jan 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GPortas commented Jan 19, 2024

MellyGray commented Dec 13, 2023 •

edited

Loading

coveralls commented Dec 13, 2023 •

edited

Loading

MellyGray commented Dec 15, 2023 •

edited

Loading

GPortas left a comment •

edited

Loading

MellyGray Jan 15, 2024 •

edited

Loading