Adding Configurable "Entities" to DSpace 7 (Part 1: Search/Browse, Display) #372

tdonohue · 2019-03-15T19:57:39Z

Overview

This PR is the first phase of work from the DSpace 7 Entities Working Group.

It creates the Angular UI features corresponding to the Entities REST API/Backend PR: DSpace/DSpace#2376

Additional details on the design, use cases and screenshots of these user interface screens are available in a Google Document.

This PR provides the following features to the Angular UI:

Search / Browse interfaces for Entities
View (Item View) interfaces for Entities

This PR does not provide the following (these will be provided in a future PR):

Creation of new Entities (via upcoming DSpace 7 submission & workflow functionality). (See "Testing" section below for recommendations for how to test this PR without being able to create content.)
Importing of Entities

Reviewing

As you can see in the commits, nearly all code written in this PR was written by Atmire. However, the DSpace 7 Entities Working Group used the same code review processes established by the DSpace 7 Working Group.

All code in this PR has been reviewed/approved by (at least) two other developers (at separate institutions)
Reviewers verified that all code has appropriate TypeDocs / inline comments
Reviewers verified that all code has required Specs/Tests
Reviewers tested all code

Obviously, other code reviews are always welcome. But, because of the large size of this PR, you are also welcome to provide a detailed review of the following (which together provide a deeper understanding of the feature this PR adds):

The Google Doc (detailed description)
By testing this PR (see "Testing" section below)

Additionally, if you would like to see/review all the past reviews, each of the smaller PRs that make up this larger PR are available in GitHub via this search: https://github.com/DSpace/dspace-angular/pulls?utf8=%E2%9C%93&q=is%3Apr+base%3Aconfigurable_entities+is%3Amerged

Testing

This PR can be built and tested locally. However, as you will be unable to create new Entities, there are a few options available for testing.

Option #1: By default, if you download & build this PR following the PR testing procedure in our README, then you will find your environment.default.js is updated to point at our Entities REST API Demo site (https://dspace7-entities.atmire.com/rest/#/rest/api). This demo site provides the backend (and test data) provided in the corresponding REST API PR DSpace/DSpace#2376

Option #2: If you would rather install the backend (and test data) yourself locally, follow the recommended Testing notes in the corresponding REST API PR DSpace/DSpace#2376 (In this PR, we've provided a test data set to use for local testing)

Acknowledgments

This PR was the collaboration of many individuals (over the span of several PRs to the configurable_entities branch), including @artlowel (developer), @Atmire-Kristof (developer), @LotteHofstede (developer), @benbosman (developer), @antoine-atmire (developer), @paulo-graca (reviewer), and @tdonohue (reviewer). Many others were also involved in the conception/design/discussion in various DSpace 7 Entities Working Group meetings.

A full list of the smaller PRs that make up this PR is available at: https://github.com/DSpace/dspace-angular/pulls?utf8=%E2%9C%93&q=is%3Apr+base%3Aconfigurable_entities+is%3Amerged

…type/viewmode combination

W2p 52212 item display relations See merge request contributions/dspace-angular!1

…n' into 'entities-or2018' 52425: Publication - JournalIssue relation See merge request contributions/dspace-angular!2

artlowel · 2019-04-11T12:53:41Z

I tested it again. Everything looks fine

atarix83

I've made a first review, I can't login using the entities REST demo server so I can't test entire application.

Generally I tested the UI and most of it works well, I didn't found any issue.

I've added a few inline comments in this review.

atarix83 · 2019-04-19T08:03:44Z

src/app/+item-page/simple/item-page.component.ts

+  /**
+   * The view-mode we're currently on
+   */
+  viewMode = VIEW_MODE_FULL;


It should be better to use an enum instead of a constant, to easily group all view mode available

atarix83 · 2019-04-19T08:12:42Z

src/app/+item-page/simple/item-types/shared/item.component.ts

+        )
+      )
+    );
+


there are a lot of exported functions, maybe I would move them to an utils file

thanks for creating utils file. there is a reason why relationsToRepresentations was not moved to item-relationships-utils.ts ?

Likely @Atmire-Kristof didn't move it because it wasn't used anywhere else.

I've moved it now, as part of #390

atarix83 · 2019-04-19T08:50:07Z

src/app/+search-page/filtered-search-page.guard.ts

+import { Observable } from 'rxjs';
+
+@Injectable()
+


Please add typedoc comments for this class

atarix83 · 2019-04-19T09:03:05Z

src/app/+search-page/search-filters/search-filter/search-filter.service.ts

+   * @param defaults    Default search options
+   * @returns {Observable<SearchOptions>}
+   */
+  getSearchOptions(defaults: any = {}): Observable<SearchOptions> {


This method seems it is not used. if is not necessary I'd remove it with all related methods

atarix83 · 2019-04-19T09:03:18Z

src/app/+search-page/search-filters/search-filter/search-filter.service.ts

+   * @param defaults    Default paginated search options
+   * @returns {Observable<PaginatedSearchOptions>}
+   */
+  getPaginatedSearchOptions(defaults: any = {}): Observable<PaginatedSearchOptions> {


This method seems it is not used. if is not necessary I'd remove it with all related methods

atarix83 · 2019-04-19T09:06:11Z

src/app/+search-page/search-results/search-results.component.ts

@@ -30,11 +31,23 @@ export class SearchResultsComponent {
   * The current configuration of the search
   */
  @Input() searchConfig: SearchOptions;
+  @Input() sortConfig: SortOptions;


Please add typedoc comment

atarix83 · 2019-04-19T09:06:17Z

src/app/+search-page/search-results/search-results.component.ts

@@ -30,11 +31,23 @@ export class SearchResultsComponent {
   * The current configuration of the search
   */
  @Input() searchConfig: SearchOptions;
+  @Input() sortConfig: SortOptions;
+  @Input() viewMode: SetViewMode;


Please add typedoc comment

atarix83 · 2019-04-19T09:06:23Z

src/app/+search-page/search-results/search-results.component.ts

@@ -30,11 +31,23 @@ export class SearchResultsComponent {
   * The current configuration of the search
   */
  @Input() searchConfig: SearchOptions;
+  @Input() sortConfig: SortOptions;
+  @Input() viewMode: SetViewMode;
+  @Input() fixedFilter: string;


Please add typedoc comment

atarix83 · 2019-04-19T09:06:46Z

src/app/+search-page/search-results/search-results.component.ts

+  @Input() sortConfig: SortOptions;
+  @Input() viewMode: SetViewMode;
+  @Input() fixedFilter: string;
+  @Input() disableHeader = false;


Please add typedoc comment

atarix83 · 2019-04-19T09:09:14Z

src/app/+search-page/search-service/search-configuration.service.ts

@@ -75,6 +76,7 @@ export class SearchConfigurationService implements OnDestroy {
   * @param {ActivatedRoute} route
   */
  constructor(private routeService: RouteService,
+              private fixedFilterService: SearchFixedFilterService,


Parameter fixedFilterService is not described in typedoc, please add it

artlowel · 2019-04-19T12:16:12Z

@atarix83 I agree with all of your feedback. It has been processed in a separate pr: #387

Once that is merged, it will show up here

61947: atarix83 feedback changes 19-04-2019

tdonohue

I've re-reviewed and re-tested this (against the demo site) myself. It looks good to me.

I also verified that all of @atarix83's prior requests have been implemented (at least from what I saw). So, @atarix83, if you can give this one last look/test, I think it's looking ready to merge!

…ype from the item

atarix83

I reviewed again this PR.
it's good to me, I only added an inline comment, after it's been resolved this PR can be merged for me

tdonohue · 2019-05-10T17:03:06Z

@artlowel : As was my worry, merging #384 created a number of merge conflicts in this PR :( Hopefully this is something someone one your team can get fixed on Monday.

[Configurable Entities] new data tweaks

Conflicts: config/environment.default.js resources/i18n/en.json src/app/+search-page/paginated-search-options.model.ts src/app/+search-page/search-filters/search-filter/search-filter.service.spec.ts src/app/+search-page/search-options.model.ts src/app/+search-page/search-page.component.spec.ts src/app/+search-page/search-page.component.ts src/app/+search-page/search-page.module.ts src/app/+search-page/search-service/search-configuration.service.ts src/app/core/cache/response.models.ts src/app/shared/object-list/search-result-list-element/item-search-result/item-search-result-list-element.component.spec.ts src/app/shared/object-list/search-result-list-element/search-result-list-element.component.ts src/app/shared/object-list/wrapper-list-element/wrapper-list-element.component.ts src/app/shared/services/route.service.ts

[Configurable Entities] final master merge

tdonohue · 2019-05-13T17:06:35Z

As this is already at +2, and merge conflicts (with MyDSpace PR) have now been resolved, I'm merging this immediately.

Art Lowel and others added 30 commits May 28, 2018 17:22

added custom item page fields for Projects, OrgUnits and People

06d2ac7

Throw an error when there are multiple components to render the same …

26098c6

…type/viewmode combination

refactoring

7db32b2

Merge branch 'pr/271' into entities-w2p-51847

5fba750

Merge branch 'pr/271' into entities-w2p-51847

e582f56

Merge branch 'pr/271' into entities-w2p-51847

4ca8e84

first version of relationships - too resource intensive

5149c48

optimized and refactored

82977ce

refactor

f1b3557

w2p 51849 - display entities as list results

e5fc17d

w2p 51851 - finished relation display on entity pages

8423261

52213: Item lists: displayed metadata journal-types

f50e0ed

52211: Item display regular metadata journal-types

c99d05c

52212: Item display relations journal-types

34dbc24

Merge branch 'w2p-52212_Item-display-relations' into 'entities-or2018'

1749194

W2p 52212 item display relations See merge request contributions/dspace-angular!1

fix for entity page changes when going back/forth using browser

733ca64

52425: Publication - JournalIssue relation

691b466

fixed with subject instead of changedetection hack

9012688

Merge branch 'entity-page-change-fix' into entities-or2018

1805c76

Merge branch 'w2p-52425_Item-display-publication-journalIssue-relatio…

01ab627

…n' into 'entities-or2018' 52425: Publication - JournalIssue relation See merge request contributions/dspace-angular!2

item page reload fix

8ab6eb6

Merge branch 'entity-page-change-fix' into entities-or2018

971cf0e

clean up after fix

f1a8517

Merge branch 'entity-page-change-fix' into entities-or2018

e084344

52935: entity filter messages

8ea8f11

Fixed typo that broke AoT build

d4c00db

Merge branch 'entities-w2p-51851-add-relationships' into entities-or2018

bbd64c9

fixed another typo to fix AoT build..

a5d6e63

Merge branch 'entities-w2p-51851-add-relationships' into entities-or2018

9154076

53029: start of filtered discovery pages

b06629c

atarix83 self-requested a review April 19, 2019 07:45

atarix83 requested changes Apr 19, 2019

View reviewed changes

61947: atarix83 feedback changes 19-04-2019

85101b5

Atmire-Kristof mentioned this pull request Apr 19, 2019

61947: atarix83 feedback changes 19-04-2019 #387

Merged

Merge pull request #387 from atmire/configurable_entities_feedback_2

093a8e9

61947: atarix83 feedback changes 19-04-2019

tdonohue commented Apr 26, 2019

View reviewed changes

artlowel added 5 commits April 30, 2019 11:22

fix issue where ItemMetadataRepresentations didn't get their entity t…

21953a0

…ype from the item

show entity time on item pages and in search results

fd26f19

show additional metadata fields for projects

fea07fe

replace placeholder images with more consistent, scalable ones

396f02b

add translate module to fix test

dcaeb71

atarix83 approved these changes May 2, 2019

View reviewed changes

artlowel added 4 commits May 6, 2019 15:30

move relationsToRepresentations to util file

1763690

change 'of' to 'observableOf'

bcf6f6a

turn contributors on project pages in to metadatarepresentations

0d8291a

Merge branch 'master' into entities_new_data_tweaks

81e8c23

tdonohue mentioned this pull request May 10, 2019

Mydspace #384

Merged

tdonohue and others added 5 commits May 10, 2019 12:10

Merge pull request #390 from atmire/entities_new_data_tweaks

7727d4a

[Configurable Entities] new data tweaks

62372: Post-merge test fixes

b0f9ce9

62372: ItemTypeSwitcher bugfix

5c4691b

Merge pull request #396 from atmire/entities-final-master-merge

badfb1f

[Configurable Entities] final master merge

tdonohue merged commit 8865d6e into master May 13, 2019

tdonohue mentioned this pull request May 13, 2019

Miscellaneous fixes #392

Merged

tdonohue deleted the configurable_entities branch May 14, 2019 13:49

tdonohue added this to the 7.0preview milestone Jan 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding Configurable "Entities" to DSpace 7 (Part 1: Search/Browse, Display) #372

Adding Configurable "Entities" to DSpace 7 (Part 1: Search/Browse, Display) #372

tdonohue commented Mar 15, 2019

artlowel commented Apr 11, 2019

atarix83 left a comment

atarix83 Apr 19, 2019

artlowel Apr 25, 2019

atarix83 Apr 19, 2019

artlowel Apr 25, 2019

atarix83 May 2, 2019

artlowel May 6, 2019 •

edited

Loading

atarix83 Apr 19, 2019

artlowel Apr 25, 2019

atarix83 Apr 19, 2019

artlowel Apr 25, 2019

atarix83 Apr 19, 2019

artlowel Apr 25, 2019

atarix83 Apr 19, 2019

artlowel Apr 25, 2019

atarix83 Apr 19, 2019

artlowel Apr 25, 2019

atarix83 Apr 19, 2019

artlowel Apr 25, 2019

atarix83 Apr 19, 2019

artlowel Apr 25, 2019

atarix83 Apr 19, 2019

artlowel Apr 25, 2019

artlowel commented Apr 19, 2019

tdonohue left a comment

atarix83 left a comment

tdonohue commented May 10, 2019

tdonohue commented May 13, 2019

Adding Configurable "Entities" to DSpace 7 (Part 1: Search/Browse, Display) #372

Adding Configurable "Entities" to DSpace 7 (Part 1: Search/Browse, Display) #372

Conversation

tdonohue commented Mar 15, 2019

Overview

Reviewing

Testing

Acknowledgments

artlowel commented Apr 11, 2019

atarix83 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

artlowel May 6, 2019 • 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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

artlowel commented Apr 19, 2019

tdonohue left a comment

Choose a reason for hiding this comment

atarix83 left a comment

Choose a reason for hiding this comment

tdonohue commented May 10, 2019

tdonohue commented May 13, 2019

artlowel May 6, 2019 •

edited

Loading