finished tests and docs

This commit is contained in:
lotte
2018-11-05 12:01:51 +01:00
parent 6f31551395
commit dd24958f61
28 changed files with 341 additions and 115 deletions

View File

@@ -27,7 +27,7 @@ export class AuthResponseParsingService extends BaseResponseParsingService imple
parse(request: RestRequest, data: DSpaceRESTV2Response): RestResponse { parse(request: RestRequest, data: DSpaceRESTV2Response): RestResponse {
if (isNotEmpty(data.payload) && isNotEmpty(data.payload._links) && (data.statusCode === '200' || data.statusCode === 'OK')) { if (isNotEmpty(data.payload) && isNotEmpty(data.payload._links) && (data.statusCode === '200' || data.statusCode === 'OK')) {
const response = this.process<NormalizedAuthStatus, AuthType>(data.payload, request.href); const response = this.process<NormalizedAuthStatus, AuthType>(data.payload, request.uuid);
return new AuthStatusResponse(response, data.statusCode); return new AuthStatusResponse(response, data.statusCode);
} else { } else {
return new AuthStatusResponse(data.payload as AuthStatus, data.statusCode); return new AuthStatusResponse(data.payload as AuthStatus, data.statusCode);

View File

@@ -116,7 +116,6 @@ export class AuthService {
options.headers = headers; options.headers = headers;
return this.authRequestService.postToEndpoint('login', body, options).pipe( return this.authRequestService.postToEndpoint('login', body, options).pipe(
map((status: AuthStatus) => { map((status: AuthStatus) => {
console.log('yey response');
if (status.authenticated) { if (status.authenticated) {
return status; return status;
} else { } else {

View File

@@ -41,7 +41,6 @@ export class ServerAuthService extends AuthService {
// TODO this should be cleaned up, AuthStatus could be parsed by the RemoteDataService as a whole... // TODO this should be cleaned up, AuthStatus could be parsed by the RemoteDataService as a whole...
const person$ = this.rdbService.buildSingle<NormalizedEPerson, EPerson>(status.eperson.toString()); const person$ = this.rdbService.buildSingle<NormalizedEPerson, EPerson>(status.eperson.toString());
// person$.subscribe(() => console.log('test'));
return person$.pipe( return person$.pipe(
map((eperson) => eperson.payload) map((eperson) => eperson.payload)
); );

View File

@@ -28,8 +28,7 @@ import {
configureRequest, configureRequest,
filterSuccessfulResponses, filterSuccessfulResponses,
getBrowseDefinitionLinks, getBrowseDefinitionLinks,
getRemoteDataPayload, getRemoteDataPayload, getRequestFromRequestHref
getRequestFromSelflink
} from '../shared/operators'; } from '../shared/operators';
import { URLCombiner } from '../url-combiner/url-combiner'; import { URLCombiner } from '../url-combiner/url-combiner';
import { Item } from '../shared/item.model'; import { Item } from '../shared/item.model';
@@ -68,7 +67,7 @@ export class BrowseService {
); );
const href$ = request$.pipe(map((request: RestRequest) => request.href)); const href$ = request$.pipe(map((request: RestRequest) => request.href));
const requestEntry$ = href$.pipe(getRequestFromSelflink(this.requestService)); const requestEntry$ = href$.pipe(getRequestFromRequestHref(this.requestService));
const payload$ = requestEntry$.pipe( const payload$ = requestEntry$.pipe(
filterSuccessfulResponses(), filterSuccessfulResponses(),
map((response: GenericSuccessResponse<BrowseDefinition[]>) => response.payload), map((response: GenericSuccessResponse<BrowseDefinition[]>) => response.payload),
@@ -111,7 +110,7 @@ export class BrowseService {
const href$ = request$.pipe(map((request: RestRequest) => request.href)); const href$ = request$.pipe(map((request: RestRequest) => request.href));
const requestEntry$ = href$.pipe(getRequestFromSelflink(this.requestService)); const requestEntry$ = href$.pipe(getRequestFromRequestHref(this.requestService));
const payload$ = requestEntry$.pipe( const payload$ = requestEntry$.pipe(
filterSuccessfulResponses(), filterSuccessfulResponses(),
@@ -166,7 +165,7 @@ export class BrowseService {
const href$ = request$.pipe(map((request: RestRequest) => request.href)); const href$ = request$.pipe(map((request: RestRequest) => request.href));
const requestEntry$ = href$.pipe(getRequestFromSelflink(this.requestService)); const requestEntry$ = href$.pipe(getRequestFromRequestHref(this.requestService));
const payload$ = requestEntry$.pipe( const payload$ = requestEntry$.pipe(
filterSuccessfulResponses(), filterSuccessfulResponses(),

View File

@@ -32,7 +32,7 @@ describe('RemoteDataBuildService', () => {
let service: RemoteDataBuildService; let service: RemoteDataBuildService;
beforeEach(() => { beforeEach(() => {
service = new RemoteDataBuildService(undefined, undefined, undefined); service = new RemoteDataBuildService(undefined, undefined);
}); });
describe('when toPaginatedList is called', () => { describe('when toPaginatedList is called', () => {

View File

@@ -5,15 +5,7 @@ import {
race as observableRace race as observableRace
} from 'rxjs'; } from 'rxjs';
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { import { distinctUntilChanged, first, flatMap, map, startWith, switchMap } from 'rxjs/operators';
distinctUntilChanged,
first,
flatMap,
map,
startWith,
switchMap,
takeUntil, tap
} from 'rxjs/operators';
import { hasValue, hasValueOperator, isEmpty, isNotEmpty } from '../../../shared/empty.util'; import { hasValue, hasValueOperator, isEmpty, isNotEmpty } from '../../../shared/empty.util';
import { PaginatedList } from '../../data/paginated-list'; import { PaginatedList } from '../../data/paginated-list';
import { RemoteData } from '../../data/remote-data'; import { RemoteData } from '../../data/remote-data';
@@ -29,7 +21,7 @@ import { getMapsTo, getRelationMetadata, getRelationships } from './build-decora
import { PageInfo } from '../../shared/page-info.model'; import { PageInfo } from '../../shared/page-info.model';
import { import {
filterSuccessfulResponses, filterSuccessfulResponses,
getRequestFromSelflink, getRequestFromRequestHref, getRequestFromRequestUUID,
getResourceLinksFromResponse getResourceLinksFromResponse
} from '../../shared/operators'; } from '../../shared/operators';
@@ -43,14 +35,14 @@ export class RemoteDataBuildService {
if (typeof href$ === 'string') { if (typeof href$ === 'string') {
href$ = observableOf(href$); href$ = observableOf(href$);
} }
const requestHref$ = href$.pipe( const requestUUID$ = href$.pipe(
switchMap((href: string) => switchMap((href: string) =>
this.objectCache.getRequestHrefBySelfLink(href)), this.objectCache.getRequestUUIDBySelfLink(href)),
); );
const requestEntry$ = observableRace( const requestEntry$ = observableRace(
href$.pipe(getRequestFromSelflink(this.requestService)), href$.pipe(getRequestFromRequestHref(this.requestService)),
requestHref$.pipe(getRequestFromSelflink(this.requestService)), requestUUID$.pipe(getRequestFromRequestUUID(this.requestService)),
).pipe( ).pipe(
first() first()
); );
@@ -121,7 +113,7 @@ export class RemoteDataBuildService {
href$ = observableOf(href$); href$ = observableOf(href$);
} }
const requestEntry$ = href$.pipe(getRequestFromSelflink(this.requestService)); const requestEntry$ = href$.pipe(getRequestFromRequestHref(this.requestService));
const tDomainList$ = requestEntry$.pipe( const tDomainList$ = requestEntry$.pipe(
getResourceLinksFromResponse(), getResourceLinksFromResponse(),
flatMap((resourceUUIDs: string[]) => { flatMap((resourceUUIDs: string[]) => {

View File

@@ -25,7 +25,7 @@ export class AddToObjectCacheAction implements Action {
objectToCache: CacheableObject; objectToCache: CacheableObject;
timeAdded: number; timeAdded: number;
msToLive: number; msToLive: number;
requestHref: string; requestUUID: string;
}; };
/** /**
@@ -42,8 +42,8 @@ export class AddToObjectCacheAction implements Action {
* This isn't necessarily the same as the object's self * This isn't necessarily the same as the object's self
* link, it could have been part of a list for example * link, it could have been part of a list for example
*/ */
constructor(objectToCache: CacheableObject, timeAdded: number, msToLive: number, requestHref: string) { constructor(objectToCache: CacheableObject, timeAdded: number, msToLive: number, requestUUID: string) {
this.payload = { objectToCache, timeAdded, msToLive, requestHref }; this.payload = { objectToCache, timeAdded, msToLive, requestUUID };
} }
} }

View File

@@ -20,6 +20,8 @@ class NullAction extends RemoveFromObjectCacheAction {
} }
describe('objectCacheReducer', () => { describe('objectCacheReducer', () => {
const requestUUID1 = '8646169a-a8fc-4b31-a368-384c07867eb1';
const requestUUID2 = 'bd36820b-4bf7-4d58-bd80-b832058b7279';
const selfLink1 = 'https://localhost:8080/api/core/items/1698f1d3-be98-4c51-9fd8-6bfedcbd59b7'; const selfLink1 = 'https://localhost:8080/api/core/items/1698f1d3-be98-4c51-9fd8-6bfedcbd59b7';
const selfLink2 = 'https://localhost:8080/api/core/items/28b04544-1766-4e82-9728-c4e93544ecd3'; const selfLink2 = 'https://localhost:8080/api/core/items/28b04544-1766-4e82-9728-c4e93544ecd3';
const newName = 'new different name'; const newName = 'new different name';
@@ -31,18 +33,18 @@ describe('objectCacheReducer', () => {
}, },
timeAdded: new Date().getTime(), timeAdded: new Date().getTime(),
msToLive: 900000, msToLive: 900000,
requestHref: selfLink1, requestUUID: requestUUID1,
patches: [], patches: [],
isDirty: false isDirty: false
}, },
[selfLink2]: { [selfLink2]: {
data: { data: {
self: selfLink2, self: requestUUID2,
foo: 'baz' foo: 'baz'
}, },
timeAdded: new Date().getTime(), timeAdded: new Date().getTime(),
msToLive: 900000, msToLive: 900000,
requestHref: selfLink2, requestUUID: selfLink2,
patches: [], patches: [],
isDirty: false isDirty: false
} }
@@ -68,8 +70,8 @@ describe('objectCacheReducer', () => {
const objectToCache = { self: selfLink1 }; const objectToCache = { self: selfLink1 };
const timeAdded = new Date().getTime(); const timeAdded = new Date().getTime();
const msToLive = 900000; const msToLive = 900000;
const requestHref = 'https://rest.api/endpoint/selfLink1'; const requestUUID = requestUUID1;
const action = new AddToObjectCacheAction(objectToCache, timeAdded, msToLive, requestHref); const action = new AddToObjectCacheAction(objectToCache, timeAdded, msToLive, requestUUID);
const newState = objectCacheReducer(state, action); const newState = objectCacheReducer(state, action);
expect(newState[selfLink1].data).toEqual(objectToCache); expect(newState[selfLink1].data).toEqual(objectToCache);
@@ -81,8 +83,8 @@ describe('objectCacheReducer', () => {
const objectToCache = { self: selfLink1, foo: 'baz', somethingElse: true }; const objectToCache = { self: selfLink1, foo: 'baz', somethingElse: true };
const timeAdded = new Date().getTime(); const timeAdded = new Date().getTime();
const msToLive = 900000; const msToLive = 900000;
const requestHref = 'https://rest.api/endpoint/selfLink1'; const requestUUID = requestUUID1;
const action = new AddToObjectCacheAction(objectToCache, timeAdded, msToLive, requestHref); const action = new AddToObjectCacheAction(objectToCache, timeAdded, msToLive, requestUUID);
const newState = objectCacheReducer(testState, action); const newState = objectCacheReducer(testState, action);
/* tslint:disable:no-string-literal */ /* tslint:disable:no-string-literal */
@@ -96,8 +98,8 @@ describe('objectCacheReducer', () => {
const objectToCache = { self: selfLink1 }; const objectToCache = { self: selfLink1 };
const timeAdded = new Date().getTime(); const timeAdded = new Date().getTime();
const msToLive = 900000; const msToLive = 900000;
const requestHref = 'https://rest.api/endpoint/selfLink1'; const requestUUID = requestUUID1;
const action = new AddToObjectCacheAction(objectToCache, timeAdded, msToLive, requestHref); const action = new AddToObjectCacheAction(objectToCache, timeAdded, msToLive, requestUUID);
deepFreeze(state); deepFreeze(state);
objectCacheReducer(state, action); objectCacheReducer(state, action);

View File

@@ -45,7 +45,7 @@ export class ObjectCacheEntry implements CacheEntry {
data: CacheableObject; data: CacheableObject;
timeAdded: number; timeAdded: number;
msToLive: number; msToLive: number;
requestHref: string; requestUUID: string;
patches: Patch[] = []; patches: Patch[] = [];
isDirty: boolean; isDirty: boolean;
} }
@@ -119,7 +119,7 @@ function addToObjectCache(state: ObjectCacheState, action: AddToObjectCacheActio
data: action.payload.objectToCache, data: action.payload.objectToCache,
timeAdded: action.payload.timeAdded, timeAdded: action.payload.timeAdded,
msToLive: action.payload.msToLive, msToLive: action.payload.msToLive,
requestHref: action.payload.requestHref, requestUUID: action.payload.requestUUID,
isDirty: (hasValue(existing) ? isNotEmpty(existing.patches) : false), isDirty: (hasValue(existing) ? isNotEmpty(existing.patches) : false),
patches: (hasValue(existing) ? existing.patches : []) patches: (hasValue(existing) ? existing.patches : [])
} }

View File

@@ -22,6 +22,7 @@ describe('ObjectCacheService', () => {
let store: Store<CoreState>; let store: Store<CoreState>;
const selfLink = 'https://rest.api/endpoint/1698f1d3-be98-4c51-9fd8-6bfedcbd59b7'; const selfLink = 'https://rest.api/endpoint/1698f1d3-be98-4c51-9fd8-6bfedcbd59b7';
const requestUUID = '4d3a4ce8-a375-4b98-859b-39f0a014d736';
const timestamp = new Date().getTime(); const timestamp = new Date().getTime();
const msToLive = 900000; const msToLive = 900000;
let objectToCache = { let objectToCache = {
@@ -58,8 +59,8 @@ describe('ObjectCacheService', () => {
describe('add', () => { describe('add', () => {
it('should dispatch an ADD action with the object to add, the time to live, and the current timestamp', () => { it('should dispatch an ADD action with the object to add, the time to live, and the current timestamp', () => {
service.add(objectToCache, msToLive, selfLink); service.add(objectToCache, msToLive, requestUUID);
expect(store.dispatch).toHaveBeenCalledWith(new AddToObjectCacheAction(objectToCache, timestamp, msToLive, selfLink)); expect(store.dispatch).toHaveBeenCalledWith(new AddToObjectCacheAction(objectToCache, timestamp, msToLive, requestUUID));
}); });
}); });

View File

@@ -45,13 +45,11 @@ export class ObjectCacheService {
* The object to add * The object to add
* @param msToLive * @param msToLive
* The number of milliseconds it should be cached for * The number of milliseconds it should be cached for
* @param requestHref * @param requestUUID
* The selfLink of the request that resulted in this object * The UUID of the request that resulted in this object
* This isn't necessarily the same as the object's self
* link, it could have been part of a list for example
*/ */
add(objectToCache: CacheableObject, msToLive: number, requestHref: string): void { add(objectToCache: CacheableObject, msToLive: number, requestUUID: string): void {
this.store.dispatch(new AddToObjectCacheAction(objectToCache, new Date().getTime(), msToLive, requestHref)); this.store.dispatch(new AddToObjectCacheAction(objectToCache, new Date().getTime(), msToLive, requestUUID));
} }
/** /**
@@ -115,16 +113,16 @@ export class ObjectCacheService {
); );
} }
getRequestHrefBySelfLink(selfLink: string): Observable<string> { getRequestUUIDBySelfLink(selfLink: string): Observable<string> {
return this.getEntry(selfLink).pipe( return this.getEntry(selfLink).pipe(
map((entry: ObjectCacheEntry) => entry.requestHref), map((entry: ObjectCacheEntry) => entry.requestUUID),
distinctUntilChanged()); distinctUntilChanged());
} }
getRequestHrefByUUID(uuid: string): Observable<string> { getRequestUUIDByObjectUUID(uuid: string): Observable<string> {
return this.store.pipe( return this.store.pipe(
select(selfLinkFromUuidSelector(uuid)), select(selfLinkFromUuidSelector(uuid)),
mergeMap((selfLink: string) => this.getRequestHrefBySelfLink(selfLink)) mergeMap((selfLink: string) => this.getRequestUUIDBySelfLink(selfLink))
); );
} }

View File

@@ -15,7 +15,7 @@ export const ServerSyncBufferActionTypes = {
/* tslint:disable:max-classes-per-file */ /* tslint:disable:max-classes-per-file */
/** /**
* An ngrx action to add a new cached object to the server's sync buffer * An ngrx action to add a new cached object to the server sync buffer
*/ */
export class AddToSSBAction implements Action { export class AddToSSBAction implements Action {
type = ServerSyncBufferActionTypes.ADD; type = ServerSyncBufferActionTypes.ADD;

View File

@@ -1,13 +1,5 @@
import * as deepFreeze from 'deep-freeze'; import * as deepFreeze from 'deep-freeze';
import { RemoveFromObjectCacheAction } from './object-cache.actions';
import { objectCacheReducer } from './object-cache.reducer';
import {
AddPatchObjectCacheAction,
AddToObjectCacheAction, ApplyPatchObjectCacheAction,
RemoveFromObjectCacheAction,
ResetObjectCacheTimestampsAction
} from './object-cache.actions';
import { Operation } from '../../../../node_modules/fast-json-patch';
import { serverSyncBufferReducer } from './server-sync-buffer.reducer'; import { serverSyncBufferReducer } from './server-sync-buffer.reducer';
import { RestRequestMethod } from '../data/rest-request-method'; import { RestRequestMethod } from '../data/rest-request-method';
import { AddToSSBAction, EmptySSBAction } from './server-sync-buffer.actions'; import { AddToSSBAction, EmptySSBAction } from './server-sync-buffer.actions';

View File

@@ -25,14 +25,14 @@ export abstract class BaseResponseParsingService {
protected abstract objectFactory: any; protected abstract objectFactory: any;
protected abstract toCache: boolean; protected abstract toCache: boolean;
protected process<ObjectDomain, ObjectType>(data: any, requestHref: string): any { protected process<ObjectDomain, ObjectType>(data: any, requestUUID: string): any {
if (isNotEmpty(data)) { if (isNotEmpty(data)) {
if (hasNoValue(data) || (typeof data !== 'object')) { if (hasNoValue(data) || (typeof data !== 'object')) {
return data; return data;
} else if (isPaginatedResponse(data)) { } else if (isPaginatedResponse(data)) {
return this.processPaginatedList(data, requestHref); return this.processPaginatedList(data, requestUUID);
} else if (Array.isArray(data)) { } else if (Array.isArray(data)) {
return this.processArray(data, requestHref); return this.processArray(data, requestUUID);
} else if (isObjectLevel(data)) { } else if (isObjectLevel(data)) {
data = this.fixBadEPersonRestResponse(data); data = this.fixBadEPersonRestResponse(data);
const object = this.deserialize(data); const object = this.deserialize(data);
@@ -41,7 +41,7 @@ export abstract class BaseResponseParsingService {
.keys(data._embedded) .keys(data._embedded)
.filter((property) => data._embedded.hasOwnProperty(property)) .filter((property) => data._embedded.hasOwnProperty(property))
.forEach((property) => { .forEach((property) => {
const parsedObj = this.process<ObjectDomain, ObjectType>(data._embedded[property], requestHref); const parsedObj = this.process<ObjectDomain, ObjectType>(data._embedded[property], requestUUID);
if (isNotEmpty(parsedObj)) { if (isNotEmpty(parsedObj)) {
if (isPaginatedResponse(data._embedded[property])) { if (isPaginatedResponse(data._embedded[property])) {
object[property] = parsedObj; object[property] = parsedObj;
@@ -55,7 +55,7 @@ export abstract class BaseResponseParsingService {
}); });
} }
this.cache(object, requestHref); this.cache(object, requestUUID);
return object; return object;
} }
const result = {}; const result = {};
@@ -63,7 +63,7 @@ export abstract class BaseResponseParsingService {
.filter((property) => data.hasOwnProperty(property)) .filter((property) => data.hasOwnProperty(property))
.filter((property) => hasValue(data[property])) .filter((property) => hasValue(data[property]))
.forEach((property) => { .forEach((property) => {
const obj = this.process(data[property], requestHref); const obj = this.process(data[property], requestUUID);
result[property] = obj; result[property] = obj;
}); });
return result; return result;
@@ -71,7 +71,7 @@ export abstract class BaseResponseParsingService {
} }
} }
protected processPaginatedList<ObjectDomain, ObjectType>(data: any, requestHref: string): PaginatedList<ObjectDomain> { protected processPaginatedList<ObjectDomain, ObjectType>(data: any, requestUUID: string): PaginatedList<ObjectDomain> {
const pageInfo: PageInfo = this.processPageInfo(data); const pageInfo: PageInfo = this.processPageInfo(data);
let list = data._embedded; let list = data._embedded;
@@ -79,14 +79,14 @@ export abstract class BaseResponseParsingService {
if (!Array.isArray(list)) { if (!Array.isArray(list)) {
list = this.flattenSingleKeyObject(list); list = this.flattenSingleKeyObject(list);
} }
const page: ObjectDomain[] = this.processArray(list, requestHref); const page: ObjectDomain[] = this.processArray(list, requestUUID);
return new PaginatedList<ObjectDomain>(pageInfo, page); return new PaginatedList<ObjectDomain>(pageInfo, page);
} }
protected processArray<ObjectDomain, ObjectType>(data: any, requestHref: string): ObjectDomain[] { protected processArray<ObjectDomain, ObjectType>(data: any, requestUUID: string): ObjectDomain[] {
let array: ObjectDomain[] = []; let array: ObjectDomain[] = [];
data.forEach((datum) => { data.forEach((datum) => {
array = [...array, this.process(datum, requestHref)]; array = [...array, this.process(datum, requestUUID)];
} }
); );
return array; return array;
@@ -114,17 +114,17 @@ export abstract class BaseResponseParsingService {
} }
} }
protected cache<ObjectDomain, ObjectType>(obj, requestHref) { protected cache<ObjectDomain, ObjectType>(obj, requestUUID) {
if (this.toCache) { if (this.toCache) {
this.addToObjectCache(obj, requestHref); this.addToObjectCache(obj, requestUUID);
} }
} }
protected addToObjectCache(co: CacheableObject, requestHref: string): void { protected addToObjectCache(co: CacheableObject, requestUUID: string): void {
if (hasNoValue(co) || hasNoValue(co.self)) { if (hasNoValue(co) || hasNoValue(co.self)) {
throw new Error('The server returned an invalid object'); throw new Error('The server returned an invalid object');
} }
this.objectCache.add(co, this.EnvConfig.cache.msToLive.default, requestHref); this.objectCache.add(co, this.EnvConfig.cache.msToLive.default, requestUUID);
} }
processPageInfo(payload: any): PageInfo { processPageInfo(payload: any): PageInfo {

View File

@@ -28,7 +28,7 @@ export class ConfigResponseParsingService extends BaseResponseParsingService imp
parse(request: RestRequest, data: DSpaceRESTV2Response): RestResponse { parse(request: RestRequest, data: DSpaceRESTV2Response): RestResponse {
if (isNotEmpty(data.payload) && isNotEmpty(data.payload._links) && (data.statusCode === '201' || data.statusCode === '200' || data.statusCode === 'OK')) { if (isNotEmpty(data.payload) && isNotEmpty(data.payload._links) && (data.statusCode === '201' || data.statusCode === '200' || data.statusCode === 'OK')) {
const configDefinition = this.process<ConfigObject,ConfigType>(data.payload, request.href); const configDefinition = this.process<ConfigObject,ConfigType>(data.payload, request.uuid);
return new ConfigSuccessResponse(configDefinition, data.statusCode, this.processPageInfo(data.payload)); return new ConfigSuccessResponse(configDefinition, data.statusCode, this.processPageInfo(data.payload));
} else { } else {
return new ErrorResponse( return new ErrorResponse(

View File

@@ -28,7 +28,7 @@ export class DSOResponseParsingService extends BaseResponseParsingService implem
} }
parse(request: RestRequest, data: DSpaceRESTV2Response): RestResponse { parse(request: RestRequest, data: DSpaceRESTV2Response): RestResponse {
const processRequestDTO = this.process<NormalizedObject, ResourceType>(data.payload, request.href); const processRequestDTO = this.process<NormalizedObject, ResourceType>(data.payload, request.uuid);
let objectList = processRequestDTO; let objectList = processRequestDTO;
if (hasNoValue(processRequestDTO)) { if (hasNoValue(processRequestDTO)) {

View File

@@ -9,8 +9,6 @@ import { ResponseParsingService } from './parsing.service';
import { RestRequest } from './request.models'; import { RestRequest } from './request.models';
import { DSpaceRESTV2Response } from '../dspace-rest-v2/dspace-rest-v2-response.model'; import { DSpaceRESTV2Response } from '../dspace-rest-v2/dspace-rest-v2-response.model';
import { DSpaceRESTv2Serializer } from '../dspace-rest-v2/dspace-rest-v2.serializer'; import { DSpaceRESTv2Serializer } from '../dspace-rest-v2/dspace-rest-v2.serializer';
import { PageInfo } from '../shared/page-info.model';
import { isNotEmpty } from '../../shared/empty.util';
import { FacetValue } from '../../+search-page/search-service/facet-value.model'; import { FacetValue } from '../../+search-page/search-service/facet-value.model';
import { BaseResponseParsingService } from './base-response-parsing.service'; import { BaseResponseParsingService } from './base-response-parsing.service';
import { ObjectCacheService } from '../cache/object-cache.service'; import { ObjectCacheService } from '../cache/object-cache.service';

View File

@@ -1,16 +1,9 @@
import { Inject, Injectable } from '@angular/core'; import { Inject, Injectable } from '@angular/core';
import { import { FacetValueSuccessResponse, RestResponse } from '../cache/response.models';
FacetValueMap,
FacetValueMapSuccessResponse,
FacetValueSuccessResponse,
RestResponse
} from '../cache/response.models';
import { ResponseParsingService } from './parsing.service'; import { ResponseParsingService } from './parsing.service';
import { RestRequest } from './request.models'; import { RestRequest } from './request.models';
import { DSpaceRESTV2Response } from '../dspace-rest-v2/dspace-rest-v2-response.model'; import { DSpaceRESTV2Response } from '../dspace-rest-v2/dspace-rest-v2-response.model';
import { DSpaceRESTv2Serializer } from '../dspace-rest-v2/dspace-rest-v2.serializer'; import { DSpaceRESTv2Serializer } from '../dspace-rest-v2/dspace-rest-v2.serializer';
import { PageInfo } from '../shared/page-info.model';
import { isNotEmpty } from '../../shared/empty.util';
import { FacetValue } from '../../+search-page/search-service/facet-value.model'; import { FacetValue } from '../../+search-page/search-service/facet-value.model';
import { BaseResponseParsingService } from './base-response-parsing.service'; import { BaseResponseParsingService } from './base-response-parsing.service';
import { ObjectCacheService } from '../cache/object-cache.service'; import { ObjectCacheService } from '../cache/object-cache.service';

View File

@@ -42,7 +42,6 @@ export class RequestEffects {
}), }),
filter((entry: RequestEntry) => hasValue(entry)), filter((entry: RequestEntry) => hasValue(entry)),
map((entry: RequestEntry) => entry.request), map((entry: RequestEntry) => entry.request),
tap((entry: RequestEntry) => console.log(entry)),
flatMap((request: RestRequest) => { flatMap((request: RestRequest) => {
let body; let body;
if (isNotEmpty(request.body)) { if (isNotEmpty(request.body)) {

View File

@@ -458,4 +458,105 @@ describe('RequestService', () => {
}); });
}); });
}); });
describe('isReusable', () => {
describe('when the given UUID is has no value', () => {
let reusable;
beforeEach(() => {
const uuid = undefined;
reusable = serviceAsAny.isReusable(uuid);
});
it('return an observable emitting false', () => {
reusable.subscribe((isReusable) => expect(isReusable).toBe(false));
})
});
describe('when the given UUID has a value, but no cached entry is found', () => {
let reusable;
beforeEach(() => {
spyOn(service, 'getByUUID').and.returnValue(observableOf(undefined));
const uuid = 'a45bb291-1adb-40d9-b2fc-7ad9080607be';
reusable = serviceAsAny.isReusable(uuid);
});
it('return an observable emitting false', () => {
reusable.subscribe((isReusable) => expect(isReusable).toBe(false));
})
});
describe('when the given UUID has a value, a cached entry is found, but it has no response', () => {
let reusable;
beforeEach(() => {
spyOn(service, 'getByUUID').and.returnValue(observableOf({ response: undefined }));
const uuid = '53c9b814-ad8b-4567-9bc1-d9bb6cfba6c8';
reusable = serviceAsAny.isReusable(uuid);
});
it('return an observable emitting false', () => {
reusable.subscribe((isReusable) => expect(isReusable).toBe(false));
})
});
describe('when the given UUID has a value, a cached entry is found, but its response was not successful', () => {
let reusable;
beforeEach(() => {
spyOn(service, 'getByUUID').and.returnValue(observableOf({ response: { isSuccessful: false } }));
const uuid = '694c9b32-7b2e-4788-835b-ef3fc2252e6c';
reusable = serviceAsAny.isReusable(uuid);
});
it('return an observable emitting false', () => {
reusable.subscribe((isReusable) => expect(isReusable).toBe(false));
})
});
describe('when the given UUID has a value, a cached entry is found, its response was successful, but the response is outdated', () => {
let reusable;
const now = 100000;
const timeAdded = 99899;
const msToLive = 100;
beforeEach(() => {
spyOn(Date.prototype, 'getTime').and.returnValue(now);
spyOn(service, 'getByUUID').and.returnValue(observableOf({
response: {
isSuccessful: true,
timeAdded: timeAdded
},
request: {
responseMsToLive: msToLive
}
}));
const uuid = 'f9b85788-881c-4994-86b6-bae8dad024d2';
reusable = serviceAsAny.isReusable(uuid);
});
it('return an observable emitting false', () => {
reusable.subscribe((isReusable) => expect(isReusable).toBe(false));
})
});
describe('when the given UUID has a value, a cached entry is found, its response was successful, and the response is not outdated', () => {
let reusable;
const now = 100000;
const timeAdded = 99999;
const msToLive = 100;
beforeEach(() => {
spyOn(Date.prototype, 'getTime').and.returnValue(now);
spyOn(service, 'getByUUID').and.returnValue(observableOf({
response: {
isSuccessful: true,
timeAdded: timeAdded
},
request: {
responseMsToLive: msToLive
}
}));
const uuid = 'f9b85788-881c-4994-86b6-bae8dad024d2';
reusable = serviceAsAny.isReusable(uuid);
});
it('return an observable emitting true', () => {
reusable.subscribe((isReusable) => expect(isReusable).toBe(true));
})
})
})
}); });

View File

@@ -94,6 +94,12 @@ export class RequestService {
); );
} }
/**
* Configure a certain request
* Used to make sure a request is in the cache
* @param {RestRequest} request The request to send out
* @param {boolean} forceBypassCache When true, a new request is always dispatched
*/
// TODO to review "overrideRequest" param when https://github.com/DSpace/dspace-angular/issues/217 will be fixed // TODO to review "overrideRequest" param when https://github.com/DSpace/dspace-angular/issues/217 will be fixed
configure<T extends CacheableObject>(request: RestRequest, forceBypassCache: boolean = false): void { configure<T extends CacheableObject>(request: RestRequest, forceBypassCache: boolean = false): void {
const isGetRequest = request.method === RestRequestMethod.GET; const isGetRequest = request.method === RestRequestMethod.GET;
@@ -113,6 +119,11 @@ export class RequestService {
} }
} }
/**
* Check if a request is in the cache or if it's still pending
* @param {GetRequest} request The request to check
* @returns {boolean} True if the request is cached or still pending
*/
private isCachedOrPending(request: GetRequest) { private isCachedOrPending(request: GetRequest) {
let isCached = this.objectCache.hasBySelfLink(request.href); let isCached = this.objectCache.hasBySelfLink(request.href);
if (isCached) { if (isCached) {
@@ -142,6 +153,10 @@ export class RequestService {
return isCached || isPending; return isCached || isPending;
} }
/**
* Configure and execute the request
* @param {RestRequest} request to dispatch
*/
private dispatchRequest(request: RestRequest) { private dispatchRequest(request: RestRequest) {
this.store.dispatch(new RequestConfigureAction(request)); this.store.dispatch(new RequestConfigureAction(request));
this.store.dispatch(new RequestExecuteAction(request.uuid)); this.store.dispatch(new RequestExecuteAction(request.uuid));
@@ -164,6 +179,10 @@ export class RequestService {
}); });
} }
/**
* Dispatch commit action to send all changes (for a certain method) to the server (buffer)
* @param {RestRequestMethod} method RestRequestMethod for which the changes should be committed
*/
commit(method?: RestRequestMethod) { commit(method?: RestRequestMethod) {
this.store.dispatch(new CommitSSBAction(method)) this.store.dispatch(new CommitSSBAction(method))
} }
@@ -171,11 +190,11 @@ export class RequestService {
/** /**
* Check whether a Response should still be cached * Check whether a Response should still be cached
* *
* @param entry * @param uuid
* the entry to check * the uuid of the entry to check
* @return boolean * @return boolean
* false if the entry is null, undefined, or its time to * false if the uuid has no value, no entry could be found, the response was nog successful or its time to
* live has been exceeded, true otherwise * live has exceeded, true otherwise
*/ */
private isReusable(uuid: string): Observable<boolean> { private isReusable(uuid: string): Observable<boolean> {
if (hasNoValue(uuid)) { if (hasNoValue(uuid)) {
@@ -194,7 +213,6 @@ export class RequestService {
} }
}) })
); );
return observableOf(false);
} }
} }
} }

View File

@@ -32,7 +32,7 @@ export class IntegrationResponseParsingService extends BaseResponseParsingServic
parse(request: RestRequest, data: DSpaceRESTV2Response): RestResponse { parse(request: RestRequest, data: DSpaceRESTV2Response): RestResponse {
if (isNotEmpty(data.payload) && isNotEmpty(data.payload._links)) { if (isNotEmpty(data.payload) && isNotEmpty(data.payload._links)) {
const dataDefinition = this.process<IntegrationModel,IntegrationType>(data.payload, request.href); const dataDefinition = this.process<IntegrationModel,IntegrationType>(data.payload, request.uuid);
return new IntegrationSuccessResponse(dataDefinition, data.statusCode, this.processPageInfo(data.payload.page)); return new IntegrationSuccessResponse(dataDefinition, data.statusCode, this.processPageInfo(data.payload.page));
} else { } else {
return new ErrorResponse( return new ErrorResponse(

View File

@@ -263,13 +263,17 @@ export class MetadataService {
.pipe( .pipe(
first((files) => isNotEmpty(files)), first((files) => isNotEmpty(files)),
catchError((error) => { catchError((error) => {
console.debug(error); console.debug(error.message);
return [] return []
})) }))
.subscribe((bitstreams: Bitstream[]) => { .subscribe((bitstreams: Bitstream[]) => {
for (const bitstream of bitstreams) { for (const bitstream of bitstreams) {
bitstream.format.pipe( bitstream.format.pipe(
first(), first(),
catchError((error: Error) => {
console.debug(error.message);
return []
}),
map((rd: RemoteData<BitstreamFormat>) => rd.payload), map((rd: RemoteData<BitstreamFormat>) => rd.payload),
filter((format: BitstreamFormat) => hasValue(format))) filter((format: BitstreamFormat) => hasValue(format)))
.subscribe((format: BitstreamFormat) => { .subscribe((format: BitstreamFormat) => {

View File

@@ -15,6 +15,28 @@ describe('HALEndpointService', () => {
const endpointMap = { const endpointMap = {
test: 'https://rest.api/test', test: 'https://rest.api/test',
foo: 'https://rest.api/foo',
bar: 'https://rest.api/bar',
endpoint: 'https://rest.api/endpoint',
link: 'https://rest.api/link',
another: 'https://rest.api/another',
};
const start = 'http://start.com';
const one = 'http://one.com';
const two = 'http://two.com';
const endpointMaps = {
[start]: {
one: one,
two: 'empty',
endpoint: 'https://rest.api/endpoint',
link: 'https://rest.api/link',
another: 'https://rest.api/another',
},
[one]: {
one: 'empty',
two: two,
bar: 'https://rest.api/bar',
}
}; };
const linkPath = 'test'; const linkPath = 'test';
@@ -80,6 +102,50 @@ describe('HALEndpointService', () => {
}); });
}); });
describe('getEndpointAt', () => {
it('should throw an error when the list of hal endpoint names is empty', () => {
const endpointAtWithoutEndpointNames = () => {
(service as any).getEndpointAt('')
};
expect(endpointAtWithoutEndpointNames).toThrow();
});
it('should be at least called as many times as the length of halNames', () => {
spyOn(service as any, 'getEndpointMapAt').and.returnValue(observableOf(endpointMap));
spyOn((service as any), 'getEndpointAt').and.callThrough();
(service as any).getEndpointAt('', 'endpoint').subscribe();
expect((service as any).getEndpointAt.calls.count()).toEqual(1);
(service as any).getEndpointAt.calls.reset();
(service as any).getEndpointAt('', 'endpoint', 'another').subscribe();
expect((service as any).getEndpointAt.calls.count()).toBeGreaterThanOrEqual(2);
(service as any).getEndpointAt.calls.reset();
(service as any).getEndpointAt('', 'endpoint', 'another', 'foo', 'bar', 'test').subscribe();
expect((service as any).getEndpointAt.calls.count()).toBeGreaterThanOrEqual(5);
});
it('should return the correct endpoint', () => {
spyOn(service as any, 'getEndpointMapAt').and.callFake((param) => {
return observableOf(endpointMaps[param]);
});
(service as any).getEndpointAt(start, 'one').subscribe((endpoint) => {
expect(endpoint).toEqual(one);
});
(service as any).getEndpointAt(start, 'one', 'two').subscribe((endpoint) => {
expect(endpoint).toEqual(two);
});
});
});
describe('isEnabledOnRestApi', () => { describe('isEnabledOnRestApi', () => {
beforeEach(() => { beforeEach(() => {
service = new HALEndpointService( service = new HALEndpointService(

View File

@@ -47,6 +47,12 @@ export class HALEndpointService {
return this.getEndpointAt(this.getRootHref(), ...linkPath.split('/')); return this.getEndpointAt(this.getRootHref(), ...linkPath.split('/'));
} }
/**
* Resolve the actual hal url based on a list of hal names
* @param {string} href The root url to start from
* @param {string} halNames List of hal names for which a url should be resolved
* @returns {Observable<string>} Observable that emits the found hal url
*/
private getEndpointAt(href: string, ...halNames: string[]): Observable<string> { private getEndpointAt(href: string, ...halNames: string[]): Observable<string> {
if (isEmpty(halNames)) { if (isEmpty(halNames)) {
throw new Error('cant\'t fetch the URL without the HAL link names') throw new Error('cant\'t fetch the URL without the HAL link names')

View File

@@ -7,22 +7,24 @@ import { RequestService } from '../data/request.service';
import { import {
configureRequest, configureRequest,
filterSuccessfulResponses, filterSuccessfulResponses,
getRemoteDataPayload, getRemoteDataPayload, getRequestFromRequestHref, getRequestFromRequestUUID,
getRequestFromSelflink, getResourceLinksFromResponse, getResponseFromEntry,
getResourceLinksFromResponse,
} from './operators'; } from './operators';
describe('Core Module - RxJS Operators', () => { describe('Core Module - RxJS Operators', () => {
let scheduler: TestScheduler; let scheduler: TestScheduler;
let requestService: RequestService; let requestService: RequestService;
const testSelfLink = 'https://rest.api/'; const testRequestHref = 'https://rest.api/';
const testRequestUUID = 'https://rest.api/';
const testRCEs = { const testRCEs = {
a: { response: { isSuccessful: true, resourceSelfLinks: ['a', 'b', 'c', 'd'] } }, a: { response: { isSuccessful: true, resourceSelfLinks: ['a', 'b', 'c', 'd'] } },
b: { response: { isSuccessful: false, resourceSelfLinks: ['e', 'f'] } }, b: { response: { isSuccessful: false, resourceSelfLinks: ['e', 'f'] } },
c: { response: { isSuccessful: undefined, resourceSelfLinks: ['g', 'h', 'i'] } }, c: { response: { isSuccessful: undefined, resourceSelfLinks: ['g', 'h', 'i'] } },
d: { response: { isSuccessful: true, resourceSelfLinks: ['j', 'k', 'l', 'm', 'n'] } }, d: { response: { isSuccessful: true, resourceSelfLinks: ['j', 'k', 'l', 'm', 'n'] } },
e: { response: { isSuccessful: 1, resourceSelfLinks: [] } } e: { response: { isSuccessful: 1, resourceSelfLinks: [] } },
f: { response: undefined },
g: undefined
}; };
const testResponses = { const testResponses = {
@@ -37,13 +39,13 @@ describe('Core Module - RxJS Operators', () => {
scheduler = getTestScheduler(); scheduler = getTestScheduler();
}); });
describe('getRequestFromSelflink', () => { describe('getRequestFromRequestHref', () => {
it('should return the RequestEntry corresponding to the self link in the source', () => { it('should return the RequestEntry corresponding to the self link in the source', () => {
requestService = getMockRequestService(); requestService = getMockRequestService();
const source = hot('a', { a: testSelfLink }); const source = hot('a', { a: testRequestHref });
const result = source.pipe(getRequestFromSelflink(requestService)); const result = source.pipe(getRequestFromRequestHref(requestService));
const expected = cold('a', { a: new RequestEntry() }); const expected = cold('a', { a: new RequestEntry() });
expect(result).toBeObservable(expected) expect(result).toBeObservable(expected)
@@ -52,18 +54,51 @@ describe('Core Module - RxJS Operators', () => {
it('should use the requestService to fetch the request by its self link', () => { it('should use the requestService to fetch the request by its self link', () => {
requestService = getMockRequestService(); requestService = getMockRequestService();
const source = hot('a', { a: testSelfLink }); const source = hot('a', { a: testRequestHref });
scheduler.schedule(() => source.pipe(getRequestFromSelflink(requestService)).subscribe()); scheduler.schedule(() => source.pipe(getRequestFromRequestHref(requestService)).subscribe());
scheduler.flush(); scheduler.flush();
expect(requestService.getByHref).toHaveBeenCalledWith(testSelfLink) expect(requestService.getByHref).toHaveBeenCalledWith(testRequestHref)
}); });
it('shouldn\'t return anything if there is no request matching the self link', () => { it('shouldn\'t return anything if there is no request matching the self link', () => {
requestService = getMockRequestService(cold('a', { a: undefined })); requestService = getMockRequestService(cold('a', { a: undefined }));
const source = hot('a', { a: testSelfLink }); const source = hot('a', { a: testRequestUUID });
const result = source.pipe(getRequestFromSelflink(requestService)); const result = source.pipe(getRequestFromRequestHref(requestService));
const expected = cold('-');
expect(result).toBeObservable(expected)
});
});
describe('getRequestFromRequestUUID', () => {
it('should return the RequestEntry corresponding to the request uuid in the source', () => {
requestService = getMockRequestService();
const source = hot('a', { a: testRequestUUID });
const result = source.pipe(getRequestFromRequestUUID(requestService));
const expected = cold('a', { a: new RequestEntry() });
expect(result).toBeObservable(expected)
});
it('should use the requestService to fetch the request by its request uuid', () => {
requestService = getMockRequestService();
const source = hot('a', { a: testRequestUUID });
scheduler.schedule(() => source.pipe(getRequestFromRequestUUID(requestService)).subscribe());
scheduler.flush();
expect(requestService.getByUUID).toHaveBeenCalledWith(testRequestUUID)
});
it('shouldn\'t return anything if there is no request matching the request uuid', () => {
requestService = getMockRequestService(cold('a', { a: undefined }));
const source = hot('a', { a: testRequestUUID });
const result = source.pipe(getRequestFromRequestUUID(requestService));
const expected = cold('-'); const expected = cold('-');
expect(result).toBeObservable(expected) expect(result).toBeObservable(expected)
@@ -96,7 +131,7 @@ describe('Core Module - RxJS Operators', () => {
describe('configureRequest', () => { describe('configureRequest', () => {
it('should call requestService.configure with the source request', () => { it('should call requestService.configure with the source request', () => {
requestService = getMockRequestService(); requestService = getMockRequestService();
const testRequest = new GetRequest('6b789e31-f026-4ff8-8993-4eb3b730c841', testSelfLink); const testRequest = new GetRequest('6b789e31-f026-4ff8-8993-4eb3b730c841', testRequestHref);
const source = hot('a', { a: testRequest }); const source = hot('a', { a: testRequest });
scheduler.schedule(() => source.pipe(configureRequest(requestService)).subscribe()); scheduler.schedule(() => source.pipe(configureRequest(requestService)).subscribe());
scheduler.flush(); scheduler.flush();
@@ -117,4 +152,20 @@ describe('Core Module - RxJS Operators', () => {
expect(result).toBeObservable(expected) expect(result).toBeObservable(expected)
}); });
}); });
describe('getResponseFromEntry', () => {
it('should return the response for all not empty request entries, when they have a value', () => {
const source = hot('abcdefg', testRCEs);
const result = source.pipe(getResponseFromEntry());
const expected = cold('abcde--', {
a: testRCEs.a.response,
b: testRCEs.b.response,
c: testRCEs.c.response,
d: testRCEs.d.response,
e: testRCEs.e.response
});
expect(result).toBeObservable(expected)
});
});
}); });

View File

@@ -15,13 +15,20 @@ import { SearchResult } from '../../+search-page/search-result.model';
* This file contains custom RxJS operators that can be used in multiple places * This file contains custom RxJS operators that can be used in multiple places
*/ */
export const getRequestFromSelflink = (requestService: RequestService) => export const getRequestFromRequestHref = (requestService: RequestService) =>
(source: Observable<string>): Observable<RequestEntry> => (source: Observable<string>): Observable<RequestEntry> =>
source.pipe( source.pipe(
flatMap((href: string) => requestService.getByHref(href)), flatMap((href: string) => requestService.getByHref(href)),
hasValueOperator() hasValueOperator()
); );
export const getRequestFromRequestUUID = (requestService: RequestService) =>
(source: Observable<string>): Observable<RequestEntry> =>
source.pipe(
flatMap((uuid: string) => requestService.getByUUID(uuid)),
hasValueOperator()
);
export const filterSuccessfulResponses = () => export const filterSuccessfulResponses = () =>
(source: Observable<RequestEntry>): Observable<RestResponse> => (source: Observable<RequestEntry>): Observable<RestResponse> =>
source.pipe( source.pipe(

View File

@@ -2,10 +2,11 @@ import {of as observableOf, Observable } from 'rxjs';
import { RequestService } from '../../core/data/request.service'; import { RequestService } from '../../core/data/request.service';
import { RequestEntry } from '../../core/data/request.reducer'; import { RequestEntry } from '../../core/data/request.reducer';
export function getMockRequestService(getByHref$: Observable<RequestEntry> = observableOf(new RequestEntry())): RequestService { export function getMockRequestService(requestEntry$: Observable<RequestEntry> = observableOf(new RequestEntry())): RequestService {
return jasmine.createSpyObj('requestService', { return jasmine.createSpyObj('requestService', {
configure: false, configure: false,
generateRequestId: 'clients/b186e8ce-e99c-4183-bc9a-42b4821bdb78', generateRequestId: 'clients/b186e8ce-e99c-4183-bc9a-42b4821bdb78',
getByHref: getByHref$ getByHref: requestEntry$,
getByUUID: requestEntry$
}); });
} }