forked from 4Science/dspace-angular
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'github/main' into coar-notify-7-part-two
- Loading branch information
Showing
29 changed files
with
968 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
src/app/core/submission/models/workspaceitem-section-duplicates.model.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| /* | ||
| * Object model for the data returned by the REST API to present potential duplicates in a submission section | ||
| */ | ||
| import { Duplicate } from '../../../shared/object-list/duplicate-data/duplicate.model'; | ||
|
|
||
| export interface WorkspaceitemSectionDuplicatesObject { | ||
| potentialDuplicates?: Duplicate[] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
src/app/core/submission/submission-duplicate-data.service.spec.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| import { SubmissionDuplicateDataService } from './submission-duplicate-data.service'; | ||
| import { FindListOptions } from '../data/find-list-options.model'; | ||
| import { RequestParam } from '../cache/models/request-param.model'; | ||
|
|
||
| /** | ||
| * Basic tests for the submission-duplicate-data.service.ts service | ||
| */ | ||
| describe('SubmissionDuplicateDataService', () => { | ||
| const duplicateDataService = new SubmissionDuplicateDataService(null, null, null, null); | ||
|
|
||
| // Test the findDuplicates method to make sure that a call results in an expected | ||
| // call to searchBy, using the 'findByItem' search method | ||
| describe('findDuplicates', () => { | ||
| beforeEach(() => { | ||
| spyOn(duplicateDataService, 'searchBy'); | ||
| }); | ||
|
|
||
| it('should call searchBy with the correct arguments', () => { | ||
| // Set up expected search parameters and find options | ||
| const searchParams = []; | ||
| searchParams.push(new RequestParam('uuid', 'test')); | ||
| let findListOptions = new FindListOptions(); | ||
| findListOptions.searchParams = searchParams; | ||
| // Perform test search using uuid 'test' using the findDuplicates method | ||
| const result = duplicateDataService.findDuplicates('test', new FindListOptions(), true, true); | ||
| // Expect searchBy('findByItem'...) to have been used as SearchData impl with the expected options (uuid=test) | ||
| expect(duplicateDataService.searchBy).toHaveBeenCalledWith('findByItem', findListOptions, true, true); | ||
| }); | ||
| }); | ||
| }); |
139 changes: 139 additions & 0 deletions
139
src/app/core/submission/submission-duplicate-data.service.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| /* eslint-disable max-classes-per-file */ | ||
| import { Observable } from 'rxjs'; | ||
| import { Injectable } from '@angular/core'; | ||
| import { FollowLinkConfig } from '../../shared/utils/follow-link-config.model'; | ||
| import { ResponseParsingService } from '../data/parsing.service'; | ||
| import { RemoteData } from '../data/remote-data'; | ||
| import { GetRequest } from '../data/request.models'; | ||
| import { RequestService } from '../data/request.service'; | ||
| import { GenericConstructor } from '../shared/generic-constructor'; | ||
| import { HALEndpointService } from '../shared/hal-endpoint.service'; | ||
| import { SearchResponseParsingService } from '../data/search-response-parsing.service'; | ||
| import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service'; | ||
| import { RestRequest } from '../data/rest-request.model'; | ||
| import { BaseDataService } from '../data/base/base-data.service'; | ||
| import { FindListOptions } from '../data/find-list-options.model'; | ||
| import { Duplicate } from '../../shared/object-list/duplicate-data/duplicate.model'; | ||
| import { PaginatedList } from '../data/paginated-list.model'; | ||
| import { RequestParam } from '../cache/models/request-param.model'; | ||
| import { ObjectCacheService } from '../cache/object-cache.service'; | ||
| import { SearchData, SearchDataImpl } from '../data/base/search-data'; | ||
| import { DUPLICATE } from '../../shared/object-list/duplicate-data/duplicate.resource-type'; | ||
| import { dataService } from '../data/base/data-service.decorator'; | ||
|
|
||
|
|
||
| /** | ||
| * Service that handles search requests for potential duplicate items. | ||
| * This uses the /api/submission/duplicates endpoint to look for other archived or in-progress items (if user | ||
| * has READ permission) that match the item (for the given uuid). | ||
| * Matching is configured in the backend in dspace/config/modulesduplicate-detection.cfg | ||
| * The returned results are small preview 'stubs' of items, and displayed in either a submission section | ||
| * or the workflow pooled/claimed task page. | ||
| * | ||
| */ | ||
| @Injectable() | ||
| @dataService(DUPLICATE) | ||
| export class SubmissionDuplicateDataService extends BaseDataService<Duplicate> implements SearchData<Duplicate> { | ||
|
|
||
| /** | ||
| * The ResponseParsingService constructor name | ||
| */ | ||
| private parser: GenericConstructor<ResponseParsingService> = SearchResponseParsingService; | ||
|
|
||
| /** | ||
| * The RestRequest constructor name | ||
| */ | ||
| private request: GenericConstructor<RestRequest> = GetRequest; | ||
|
|
||
| /** | ||
| * SearchData interface to implement | ||
| * @private | ||
| */ | ||
| private searchData: SearchData<Duplicate>; | ||
|
|
||
| /** | ||
| * Subscription to unsubscribe from | ||
| */ | ||
| private sub; | ||
|
|
||
| constructor( | ||
| protected requestService: RequestService, | ||
| protected rdbService: RemoteDataBuildService, | ||
| protected objectCache: ObjectCacheService, | ||
| protected halService: HALEndpointService, | ||
| ) { | ||
| super('duplicates', requestService, rdbService, objectCache, halService); | ||
| this.searchData = new SearchDataImpl(this.linkPath, requestService, rdbService, objectCache, halService, this.responseMsToLive); | ||
| } | ||
|
|
||
| /** | ||
| * Implement the searchBy method to return paginated lists of Duplicate resources | ||
| * | ||
| * @param searchMethod the search method name | ||
| * @param options find list options | ||
| * @param useCachedVersionIfAvailable whether to use cached version if available | ||
| * @param reRequestOnStale whether to rerequest results on stale | ||
| * @param linksToFollow links to follow in results | ||
| */ | ||
| searchBy(searchMethod: string, options?: FindListOptions, useCachedVersionIfAvailable?: boolean, reRequestOnStale?: boolean, ...linksToFollow: FollowLinkConfig<Duplicate>[]): Observable<RemoteData<PaginatedList<Duplicate>>> { | ||
| return this.searchData.searchBy(searchMethod, options, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow); | ||
| } | ||
|
|
||
| /** | ||
| * Helper method to get the duplicates endpoint | ||
| * @protected | ||
| */ | ||
| protected getEndpoint(): Observable<string> { | ||
| return this.halService.getEndpoint(this.linkPath); | ||
| } | ||
|
|
||
| /** | ||
| * Method to set service options | ||
| * @param {GenericConstructor<ResponseParsingService>} parser The ResponseParsingService constructor name | ||
| * @param {boolean} request The RestRequest constructor name | ||
| */ | ||
| setServiceOptions(parser: GenericConstructor<ResponseParsingService>, request: GenericConstructor<RestRequest>) { | ||
| if (parser) { | ||
| this.parser = parser; | ||
| } | ||
| if (request) { | ||
| this.request = request; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Find duplicates for a given item UUID. Locates and returns results from the /api/submission/duplicates/search/findByItem | ||
| * SearchRestMethod, which is why this implements SearchData<Duplicate> and searchBy | ||
| * | ||
| * @param uuid the item UUID | ||
| * @param options any find list options e.g. paging | ||
| * @param useCachedVersionIfAvailable whether to use cached version if available | ||
| * @param reRequestOnStale whether to rerequest results on stale | ||
| * @param linksToFollow links to follow in results | ||
| */ | ||
| public findDuplicates(uuid: string, options?: FindListOptions, useCachedVersionIfAvailable = true, reRequestOnStale = true, ...linksToFollow: FollowLinkConfig<Duplicate>[]): Observable<RemoteData<PaginatedList<Duplicate>>> { | ||
| const searchParams = [new RequestParam('uuid', uuid)]; | ||
| let findListOptions = new FindListOptions(); | ||
| if (options) { | ||
| findListOptions = Object.assign(new FindListOptions(), options); | ||
| } | ||
| if (findListOptions.searchParams) { | ||
| findListOptions.searchParams = [...findListOptions.searchParams, ...searchParams]; | ||
| } else { | ||
| findListOptions.searchParams = searchParams; | ||
| } | ||
|
|
||
| // Return actual search/findByItem results | ||
| return this.searchBy('findByItem', findListOptions, useCachedVersionIfAvailable, reRequestOnStale, ...linksToFollow); | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Unsubscribe from the subscription | ||
| */ | ||
| ngOnDestroy(): void { | ||
| if (this.sub !== undefined) { | ||
| this.sub.unsubscribe(); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
src/app/shared/object-list/duplicate-data/duplicate.model.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import {autoserialize, deserialize} from 'cerialize'; | ||
| import { MetadataMap } from '../../../core/shared/metadata.models'; | ||
| import { HALLink} from '../../../core/shared/hal-link.model'; | ||
| import { CacheableObject } from '../../../core/cache/cacheable-object.model'; | ||
| import { DUPLICATE } from './duplicate.resource-type'; | ||
| import { ResourceType } from '../../../core/shared/resource-type'; | ||
|
|
||
| /** | ||
| * This implements the model of a duplicate preview stub, to be displayed to submitters or reviewers | ||
| * if duplicate detection is enabled. The metadata map is configurable in the backend at duplicate-detection.cfg | ||
| */ | ||
| export class Duplicate implements CacheableObject { | ||
|
|
||
| static type = DUPLICATE; | ||
|
|
||
| /** | ||
| * The item title | ||
| */ | ||
| @autoserialize | ||
| title: string; | ||
| /** | ||
| * The item uuid | ||
| */ | ||
| @autoserialize | ||
| uuid: string; | ||
| /** | ||
| * The workfow item ID, if any | ||
| */ | ||
| @autoserialize | ||
| workflowItemId: number; | ||
| /** | ||
| * The workspace item ID, if any | ||
| */ | ||
| @autoserialize | ||
| workspaceItemId: number; | ||
| /** | ||
| * The owning collection of the item | ||
| */ | ||
| @autoserialize | ||
| owningCollection: string; | ||
| /** | ||
| * Metadata for the preview item (e.g. dc.title) | ||
| */ | ||
| @autoserialize | ||
| metadata: MetadataMap; | ||
|
|
||
| @autoserialize | ||
| type: ResourceType; | ||
|
|
||
| /** | ||
| * The {@link HALLink}s for the URL that generated this item (in context of search results) | ||
| */ | ||
| @deserialize | ||
| _links: { | ||
| self: HALLink; | ||
| }; | ||
| } |
9 changes: 9 additions & 0 deletions
9
src/app/shared/object-list/duplicate-data/duplicate.resource-type.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import { ResourceType } from 'src/app/core/shared/resource-type'; | ||
|
|
||
| /** | ||
| * The resource type for Duplicate preview stubs | ||
| * | ||
| * Needs to be in a separate file to prevent circular | ||
| * dependencies in webpack. | ||
| */ | ||
| export const DUPLICATE = new ResourceType('duplicate'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.