+
= new BehaviorSubject(true);
sidebarVisible: Observable;
slideSidebarOver: Observable;
collapsedSidebarWidth: Observable;
@@ -131,12 +131,12 @@ export class AppComponent implements OnInit, AfterViewInit {
delay(0)
).subscribe((event) => {
if (event instanceof NavigationStart) {
- this.isLoading = true;
+ this.isLoading$.next(true);
} else if (
event instanceof NavigationEnd ||
event instanceof NavigationCancel
) {
- this.isLoading = false;
+ this.isLoading$.next(false);
}
});
}
diff --git a/src/app/app.metareducers.ts b/src/app/app.metareducers.ts
index 4d94c899d7..131d240b79 100644
--- a/src/app/app.metareducers.ts
+++ b/src/app/app.metareducers.ts
@@ -1,4 +1,3 @@
-import { isNotEmpty } from './shared/empty.util';
import { StoreActionTypes } from './store.actions';
// fallback ngrx debugger
diff --git a/src/app/app.module.ts b/src/app/app.module.ts
index 4b803608f3..aaad66adf6 100755
--- a/src/app/app.module.ts
+++ b/src/app/app.module.ts
@@ -3,17 +3,14 @@ import { HttpClientModule } from '@angular/common/http';
import { NgModule } from '@angular/core';
import { NgbModule } from '@ng-bootstrap/ng-bootstrap';
-
import { EffectsModule } from '@ngrx/effects';
import { RouterStateSerializer, StoreRouterConnectingModule } from '@ngrx/router-store';
-import { META_REDUCERS, MetaReducer, StoreModule } from '@ngrx/store';
+import { MetaReducer, StoreModule, USER_PROVIDED_META_REDUCERS } from '@ngrx/store';
import { StoreDevtoolsModule } from '@ngrx/store-devtools';
-
+import { DYNAMIC_MATCHER_PROVIDERS } from '@ng-dynamic-forms/core';
import { TranslateModule } from '@ngx-translate/core';
import { ScrollToModule } from '@nicky-lenaers/ngx-scroll-to';
-import { storeFreeze } from 'ngrx-store-freeze';
-
import { ENV_CONFIG, GLOBAL_CONFIG, GlobalConfig } from '../config';
import { AdminSidebarSectionComponent } from './+admin/admin-sidebar/admin-sidebar-section/admin-sidebar-section.component';
import { AdminSidebarComponent } from './+admin/admin-sidebar/admin-sidebar.component';
@@ -41,6 +38,7 @@ import { DSpaceRouterStateSerializer } from './shared/ngrx/dspace-router-state-s
import { NotificationComponent } from './shared/notifications/notification/notification.component';
import { NotificationsBoardComponent } from './shared/notifications/notifications-board/notifications-board.component';
import { SharedModule } from './shared/shared.module';
+import { BreadcrumbsComponent } from './breadcrumbs/breadcrumbs.component';
export function getConfig() {
return ENV_CONFIG;
@@ -51,8 +49,7 @@ export function getBase() {
}
export function getMetaReducers(config: GlobalConfig): Array> {
- const metaReducers: Array> = config.production ? appMetaReducers : [...appMetaReducers, storeFreeze];
- return config.debug ? [...metaReducers, ...debugMetaReducers] : metaReducers;
+ return config.debug ? [...appMetaReducers, ...debugMetaReducers] : appMetaReducers;
}
const IMPORTS = [
@@ -63,11 +60,11 @@ const IMPORTS = [
AppRoutingModule,
CoreModule.forRoot(),
ScrollToModule.forRoot(),
- NgbModule.forRoot(),
+ NgbModule,
TranslateModule.forRoot(),
EffectsModule.forRoot(appEffects),
StoreModule.forRoot(appReducers),
- StoreRouterConnectingModule,
+ StoreRouterConnectingModule.forRoot(),
];
const ENTITY_IMPORTS = [
@@ -92,7 +89,7 @@ const PROVIDERS = [
useFactory: (getBase)
},
{
- provide: META_REDUCERS,
+ provide: USER_PROVIDED_META_REDUCERS,
useFactory: getMetaReducers,
deps: [GLOBAL_CONFIG]
},
@@ -100,7 +97,8 @@ const PROVIDERS = [
provide: RouterStateSerializer,
useClass: DSpaceRouterStateSerializer
},
- ClientCookieService
+ ClientCookieService,
+ ...DYNAMIC_MATCHER_PROVIDERS,
];
const DECLARATIONS = [
@@ -131,6 +129,7 @@ const EXPORTS = [
],
declarations: [
...DECLARATIONS,
+ BreadcrumbsComponent,
],
exports: [
...EXPORTS
diff --git a/src/app/breadcrumbs/breadcrumb/breadcrumb-config.model.ts b/src/app/breadcrumbs/breadcrumb/breadcrumb-config.model.ts
new file mode 100644
index 0000000000..0ff8fc5033
--- /dev/null
+++ b/src/app/breadcrumbs/breadcrumb/breadcrumb-config.model.ts
@@ -0,0 +1,21 @@
+import { BreadcrumbsService } from '../../core/breadcrumbs/breadcrumbs.service';
+
+/**
+ * Interface for breadcrumb configuration objects
+ */
+export interface BreadcrumbConfig {
+ /**
+ * The service used to calculate the breadcrumb object
+ */
+ provider: BreadcrumbsService;
+
+ /**
+ * The key that is used to calculate the breadcrumb display value
+ */
+ key: T;
+
+ /**
+ * The url of the breadcrumb
+ */
+ url?: string;
+}
diff --git a/src/app/breadcrumbs/breadcrumb/breadcrumb.model.ts b/src/app/breadcrumbs/breadcrumb/breadcrumb.model.ts
new file mode 100644
index 0000000000..c6ab8491b4
--- /dev/null
+++ b/src/app/breadcrumbs/breadcrumb/breadcrumb.model.ts
@@ -0,0 +1,15 @@
+/**
+ * Class representing a single breadcrumb
+ */
+export class Breadcrumb {
+ constructor(
+ /**
+ * The display value of the breadcrumb
+ */
+ public text: string,
+ /**
+ * The optional url of the breadcrumb
+ */
+ public url?: string) {
+ }
+}
diff --git a/src/app/breadcrumbs/breadcrumbs.component.html b/src/app/breadcrumbs/breadcrumbs.component.html
new file mode 100644
index 0000000000..b773964d1e
--- /dev/null
+++ b/src/app/breadcrumbs/breadcrumbs.component.html
@@ -0,0 +1,17 @@
+
+
+
+ {{text | translate}}
+
+
+
+ {{text | translate}}
+
+
diff --git a/src/app/breadcrumbs/breadcrumbs.component.scss b/src/app/breadcrumbs/breadcrumbs.component.scss
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/src/app/breadcrumbs/breadcrumbs.component.spec.ts b/src/app/breadcrumbs/breadcrumbs.component.spec.ts
new file mode 100644
index 0000000000..0ab1fed208
--- /dev/null
+++ b/src/app/breadcrumbs/breadcrumbs.component.spec.ts
@@ -0,0 +1,111 @@
+import { async, ComponentFixture, TestBed } from '@angular/core/testing';
+
+import { BreadcrumbsComponent } from './breadcrumbs.component';
+import { ActivatedRoute, NavigationEnd, Router } from '@angular/router';
+import { Observable, of as observableOf } from 'rxjs';
+import { RouterTestingModule } from '@angular/router/testing';
+import { TranslateLoader, TranslateModule } from '@ngx-translate/core';
+import { MockTranslateLoader } from '../shared/testing/mock-translate-loader';
+import { BreadcrumbConfig } from './breadcrumb/breadcrumb-config.model';
+import { BreadcrumbsService } from '../core/breadcrumbs/breadcrumbs.service';
+import { Breadcrumb } from './breadcrumb/breadcrumb.model';
+import { getTestScheduler } from 'jasmine-marbles';
+
+class TestBreadcrumbsService implements BreadcrumbsService {
+ getBreadcrumbs(key: string, url: string): Observable {
+ return observableOf([new Breadcrumb(key, url)]);
+ }
+}
+
+describe('BreadcrumbsComponent', () => {
+ let component: BreadcrumbsComponent;
+ let fixture: ComponentFixture;
+ let router: any;
+ let route: any;
+ let breadcrumbProvider;
+ let breadcrumbConfigA: BreadcrumbConfig;
+ let breadcrumbConfigB: BreadcrumbConfig;
+ let expectedBreadcrumbs;
+
+ function init() {
+ breadcrumbProvider = new TestBreadcrumbsService();
+
+ breadcrumbConfigA = { provider: breadcrumbProvider, key: 'example.path', url: 'example.com' };
+ breadcrumbConfigB = { provider: breadcrumbProvider, key: 'another.path', url: 'another.com' };
+
+ route = {
+ root: {
+ snapshot: {
+ data: { breadcrumb: breadcrumbConfigA },
+ routeConfig: { resolve: { breadcrumb: {} } }
+ },
+ firstChild: {
+ snapshot: {
+ // Example without resolver should be ignored
+ data: { breadcrumb: breadcrumbConfigA },
+ },
+ firstChild: {
+ snapshot: {
+ data: { breadcrumb: breadcrumbConfigB },
+ routeConfig: { resolve: { breadcrumb: {} } }
+ }
+ }
+ }
+ }
+ };
+
+ expectedBreadcrumbs = [
+ new Breadcrumb(breadcrumbConfigA.key, breadcrumbConfigA.url),
+ new Breadcrumb(breadcrumbConfigB.key, breadcrumbConfigB.url)
+ ]
+
+ }
+
+ beforeEach(async(() => {
+ init();
+ TestBed.configureTestingModule({
+ declarations: [BreadcrumbsComponent],
+ imports: [RouterTestingModule.withRoutes([]), TranslateModule.forRoot({
+ loader: {
+ provide: TranslateLoader,
+ useClass: MockTranslateLoader
+ }
+ })],
+ providers: [
+ { provide: ActivatedRoute, useValue: route }
+
+ ]
+ })
+ .compileComponents();
+ }));
+
+ beforeEach(() => {
+ fixture = TestBed.createComponent(BreadcrumbsComponent);
+ component = fixture.componentInstance;
+ router = TestBed.get(Router);
+ fixture.detectChanges();
+ });
+
+ it('should create', () => {
+ expect(component).toBeTruthy();
+ });
+
+ describe('ngOnInit', () => {
+ beforeEach(() => {
+ spyOn(component, 'resolveBreadcrumbs').and.returnValue(observableOf([]))
+ });
+
+ it('should call resolveBreadcrumb on init', () => {
+ router.events = observableOf(new NavigationEnd(0, '', ''));
+ component.ngOnInit();
+ expect(component.resolveBreadcrumbs).toHaveBeenCalledWith(route.root);
+ })
+ });
+
+ describe('resolveBreadcrumbs', () => {
+ it('should return the correct breadcrumbs', () => {
+ const breadcrumbs = component.resolveBreadcrumbs(route.root);
+ getTestScheduler().expectObservable(breadcrumbs).toBe('(a|)', { a: expectedBreadcrumbs })
+ })
+ })
+});
diff --git a/src/app/breadcrumbs/breadcrumbs.component.ts b/src/app/breadcrumbs/breadcrumbs.component.ts
new file mode 100644
index 0000000000..2bba3c76b6
--- /dev/null
+++ b/src/app/breadcrumbs/breadcrumbs.component.ts
@@ -0,0 +1,100 @@
+import { Component, OnDestroy, OnInit } from '@angular/core';
+import { ActivatedRoute, NavigationEnd, Router } from '@angular/router';
+import { Breadcrumb } from './breadcrumb/breadcrumb.model';
+import { hasNoValue, hasValue, isNotUndefined, isUndefined } from '../shared/empty.util';
+import { filter, map, switchMap, tap } from 'rxjs/operators';
+import { combineLatest, Observable, Subscription, of as observableOf } from 'rxjs';
+
+/**
+ * Component representing the breadcrumbs of a page
+ */
+@Component({
+ selector: 'ds-breadcrumbs',
+ templateUrl: './breadcrumbs.component.html',
+ styleUrls: ['./breadcrumbs.component.scss']
+})
+export class BreadcrumbsComponent implements OnInit, OnDestroy {
+ /**
+ * List of breadcrumbs for this page
+ */
+ breadcrumbs: Breadcrumb[];
+
+ /**
+ * Whether or not to show breadcrumbs on this page
+ */
+ showBreadcrumbs: boolean;
+
+ /**
+ * Subscription to unsubscribe from on destroy
+ */
+ subscription: Subscription;
+
+ constructor(
+ private route: ActivatedRoute,
+ private router: Router
+ ) {
+ }
+
+ /**
+ * Sets the breadcrumbs on init for this page
+ */
+ ngOnInit(): void {
+ this.subscription = this.router.events.pipe(
+ filter((e): e is NavigationEnd => e instanceof NavigationEnd),
+ tap(() => this.reset()),
+ switchMap(() => this.resolveBreadcrumbs(this.route.root))
+ ).subscribe((breadcrumbs) => {
+ this.breadcrumbs = breadcrumbs;
+ }
+ )
+ }
+
+ /**
+ * Method that recursively resolves breadcrumbs
+ * @param route The route to get the breadcrumb from
+ */
+ resolveBreadcrumbs(route: ActivatedRoute): Observable {
+ const data = route.snapshot.data;
+ const routeConfig = route.snapshot.routeConfig;
+
+ const last: boolean = hasNoValue(route.firstChild);
+ if (last) {
+ if (hasValue(data.showBreadcrumbs)) {
+ this.showBreadcrumbs = data.showBreadcrumbs;
+ } else if (isUndefined(data.breadcrumb)) {
+ this.showBreadcrumbs = false;
+ }
+ }
+
+ if (
+ hasValue(data) && hasValue(data.breadcrumb) &&
+ hasValue(routeConfig) && hasValue(routeConfig.resolve) && hasValue(routeConfig.resolve.breadcrumb)
+ ) {
+ const { provider, key, url } = data.breadcrumb;
+ if (!last) {
+ return combineLatest(provider.getBreadcrumbs(key, url), this.resolveBreadcrumbs(route.firstChild))
+ .pipe(map((crumbs) => [].concat.apply([], crumbs)));
+ } else {
+ return provider.getBreadcrumbs(key, url);
+ }
+ }
+ return !last ? this.resolveBreadcrumbs(route.firstChild) : observableOf([]);
+ }
+
+ /**
+ * Unsubscribe from subscription
+ */
+ ngOnDestroy(): void {
+ if (hasValue(this.subscription)) {
+ this.subscription.unsubscribe();
+ }
+ }
+
+ /**
+ * Resets the state of the breadcrumbs
+ */
+ reset() {
+ this.breadcrumbs = [];
+ this.showBreadcrumbs = true;
+ }
+}
diff --git a/src/app/community-list-page/community-list-service.spec.ts b/src/app/community-list-page/community-list-service.spec.ts
index a150277d20..c3cfef35a0 100644
--- a/src/app/community-list-page/community-list-service.spec.ts
+++ b/src/app/community-list-page/community-list-service.spec.ts
@@ -190,8 +190,6 @@ describe('CommunityListService', () => {
service = new CommunityListService(communityDataServiceStub, collectionDataServiceStub, store);
}));
- afterAll(() => service = new CommunityListService(communityDataServiceStub, collectionDataServiceStub, store));
-
it('should create', inject([CommunityListService], (serviceIn: CommunityListService) => {
expect(serviceIn).toBeTruthy();
}));
diff --git a/src/app/core/auth/auth-response-parsing.service.spec.ts b/src/app/core/auth/auth-response-parsing.service.spec.ts
index 112d60b8d2..3b18d925bf 100644
--- a/src/app/core/auth/auth-response-parsing.service.spec.ts
+++ b/src/app/core/auth/auth-response-parsing.service.spec.ts
@@ -3,15 +3,16 @@ import { async, TestBed } from '@angular/core/testing';
import { Store, StoreModule } from '@ngrx/store';
import { GlobalConfig } from '../../../config/global-config.interface';
-import { AuthStatusResponse } from '../cache/response.models';
-import { ObjectCacheService } from '../cache/object-cache.service';
-import { AuthStatus } from './models/auth-status.model';
-import { AuthResponseParsingService } from './auth-response-parsing.service';
-import { AuthGetRequest, AuthPostRequest } from '../data/request.models';
import { MockStore } from '../../shared/testing/mock-store';
+import { ObjectCacheService } from '../cache/object-cache.service';
+import { AuthStatusResponse } from '../cache/response.models';
+import { AuthGetRequest, AuthPostRequest } from '../data/request.models';
+import { AuthResponseParsingService } from './auth-response-parsing.service';
+import { AuthStatus } from './models/auth-status.model';
describe('AuthResponseParsingService', () => {
let service: AuthResponseParsingService;
+ let linkServiceStub: any;
const EnvConfig: GlobalConfig = { cache: { msToLive: 1000 } } as any;
let store: any;
@@ -30,7 +31,10 @@ describe('AuthResponseParsingService', () => {
beforeEach(() => {
store = TestBed.get(Store);
- objectCacheService = new ObjectCacheService(store as any);
+ linkServiceStub = jasmine.createSpyObj({
+ removeResolvedLinks: {}
+ });
+ objectCacheService = new ObjectCacheService(store as any, linkServiceStub);
service = new AuthResponseParsingService(EnvConfig, objectCacheService);
});
@@ -141,6 +145,7 @@ describe('AuthResponseParsingService', () => {
it('should return a AuthStatusResponse if data contains a valid endpoint response', () => {
const response = service.parse(validRequest2, validResponse2);
expect(response.constructor).toBe(AuthStatusResponse);
+ expect(linkServiceStub.removeResolvedLinks).toHaveBeenCalled();
});
it('should return a AuthStatusResponse if data contains an empty 404 endpoint response', () => {
diff --git a/src/app/core/auth/auth-response-parsing.service.ts b/src/app/core/auth/auth-response-parsing.service.ts
index 8137734c49..9ef523ca14 100644
--- a/src/app/core/auth/auth-response-parsing.service.ts
+++ b/src/app/core/auth/auth-response-parsing.service.ts
@@ -10,8 +10,6 @@ import { ObjectCacheService } from '../cache/object-cache.service';
import { ResponseParsingService } from '../data/parsing.service';
import { RestRequest } from '../data/request.models';
import { AuthStatus } from './models/auth-status.model';
-import { NormalizedAuthStatus } from './models/normalized-auth-status.model';
-import { NormalizedObject } from '../cache/models/normalized-object.model';
@Injectable()
export class AuthResponseParsingService extends BaseResponseParsingService implements ResponseParsingService {
@@ -25,10 +23,10 @@ export class AuthResponseParsingService extends BaseResponseParsingService imple
parse(request: RestRequest, data: DSpaceRESTV2Response): RestResponse {
if (isNotEmpty(data.payload) && isNotEmpty(data.payload._links) && (data.statusCode === 200)) {
- const response = this.process>(data.payload, request);
+ const response = this.process(data.payload, request);
return new AuthStatusResponse(response, data.statusCode, data.statusText);
} else {
- return new AuthStatusResponse(data.payload as NormalizedAuthStatus, data.statusCode, data.statusText);
+ return new AuthStatusResponse(data.payload as AuthStatus, data.statusCode, data.statusText);
}
}
}
diff --git a/src/app/core/auth/auth.actions.ts b/src/app/core/auth/auth.actions.ts
index d0969d38d4..2681ed39a2 100644
--- a/src/app/core/auth/auth.actions.ts
+++ b/src/app/core/auth/auth.actions.ts
@@ -1,9 +1,7 @@
// import @ngrx
import { Action } from '@ngrx/store';
-
// import type function
import { type } from '../../shared/ngrx/type';
-
// import models
import { EPerson } from '../eperson/models/eperson.model';
import { AuthTokenInfo } from './models/auth-token-info.model';
@@ -31,6 +29,9 @@ export const AuthActionTypes = {
REGISTRATION_ERROR: type('dspace/auth/REGISTRATION_ERROR'),
REGISTRATION_SUCCESS: type('dspace/auth/REGISTRATION_SUCCESS'),
SET_REDIRECT_URL: type('dspace/auth/SET_REDIRECT_URL'),
+ RETRIEVE_AUTHENTICATED_EPERSON: type('dspace/auth/RETRIEVE_AUTHENTICATED_EPERSON'),
+ RETRIEVE_AUTHENTICATED_EPERSON_SUCCESS: type('dspace/auth/RETRIEVE_AUTHENTICATED_EPERSON_SUCCESS'),
+ RETRIEVE_AUTHENTICATED_EPERSON_ERROR: type('dspace/auth/RETRIEVE_AUTHENTICATED_EPERSON_ERROR'),
};
/* tslint:disable:max-classes-per-file */
@@ -76,11 +77,11 @@ export class AuthenticatedSuccessAction implements Action {
payload: {
authenticated: boolean;
authToken: AuthTokenInfo;
- user: EPerson
+ userHref: string
};
- constructor(authenticated: boolean, authToken: AuthTokenInfo, user: EPerson) {
- this.payload = { authenticated, authToken, user };
+ constructor(authenticated: boolean, authToken: AuthTokenInfo, userHref: string) {
+ this.payload = { authenticated, authToken, userHref };
}
}
@@ -322,6 +323,47 @@ export class SetRedirectUrlAction implements Action {
}
}
+/**
+ * Retrieve the authenticated eperson.
+ * @class RetrieveAuthenticatedEpersonAction
+ * @implements {Action}
+ */
+export class RetrieveAuthenticatedEpersonAction implements Action {
+ public type: string = AuthActionTypes.RETRIEVE_AUTHENTICATED_EPERSON;
+ payload: string;
+
+ constructor(user: string) {
+ this.payload = user ;
+ }
+}
+
+/**
+ * Set the authenticated eperson in the state.
+ * @class RetrieveAuthenticatedEpersonSuccessAction
+ * @implements {Action}
+ */
+export class RetrieveAuthenticatedEpersonSuccessAction implements Action {
+ public type: string = AuthActionTypes.RETRIEVE_AUTHENTICATED_EPERSON_SUCCESS;
+ payload: EPerson;
+
+ constructor(user: EPerson) {
+ this.payload = user ;
+ }
+}
+
+/**
+ * Set the authenticated eperson in the state.
+ * @class RetrieveAuthenticatedEpersonSuccessAction
+ * @implements {Action}
+ */
+export class RetrieveAuthenticatedEpersonErrorAction implements Action {
+ public type: string = AuthActionTypes.RETRIEVE_AUTHENTICATED_EPERSON_ERROR;
+ payload: Error;
+
+ constructor(payload: Error) {
+ this.payload = payload ;
+ }
+}
/* tslint:enable:max-classes-per-file */
/**
@@ -343,4 +385,8 @@ export type AuthActions
| RegistrationErrorAction
| RegistrationSuccessAction
| AddAuthenticationMessageAction
- | ResetAuthenticationMessagesAction;
+ | ResetAuthenticationMessagesAction
+ | RetrieveAuthenticatedEpersonAction
+ | RetrieveAuthenticatedEpersonErrorAction
+ | RetrieveAuthenticatedEpersonSuccessAction
+ | SetRedirectUrlAction;
diff --git a/src/app/core/auth/auth.effects.spec.ts b/src/app/core/auth/auth.effects.spec.ts
index 8c2b4026e0..34b900fe7e 100644
--- a/src/app/core/auth/auth.effects.spec.ts
+++ b/src/app/core/auth/auth.effects.spec.ts
@@ -18,12 +18,14 @@ import {
LogOutErrorAction,
LogOutSuccessAction,
RefreshTokenErrorAction,
- RefreshTokenSuccessAction
+ RefreshTokenSuccessAction,
+ RetrieveAuthenticatedEpersonAction,
+ RetrieveAuthenticatedEpersonErrorAction,
+ RetrieveAuthenticatedEpersonSuccessAction
} from './auth.actions';
import { AuthServiceStub } from '../../shared/testing/auth-service-stub';
import { AuthService } from './auth.service';
import { AuthState } from './auth.reducer';
-
import { EPersonMock } from '../../shared/testing/eperson-mock';
describe('AuthEffects', () => {
@@ -42,13 +44,14 @@ describe('AuthEffects', () => {
authServiceStub = new AuthServiceStub();
token = authServiceStub.getToken();
}
+
beforeEach(() => {
init();
TestBed.configureTestingModule({
providers: [
AuthEffects,
- {provide: AuthService, useValue: authServiceStub},
- {provide: Store, useValue: store},
+ { provide: AuthService, useValue: authServiceStub },
+ { provide: Store, useValue: store },
provideMockActions(() => actions),
// other providers
],
@@ -63,11 +66,11 @@ describe('AuthEffects', () => {
actions = hot('--a-', {
a: {
type: AuthActionTypes.AUTHENTICATE,
- payload: {email: 'user', password: 'password'}
+ payload: { email: 'user', password: 'password' }
}
});
- const expected = cold('--b-', {b: new AuthenticationSuccessAction(token)});
+ const expected = cold('--b-', { b: new AuthenticationSuccessAction(token) });
expect(authEffects.authenticate$).toBeObservable(expected);
});
@@ -80,11 +83,11 @@ describe('AuthEffects', () => {
actions = hot('--a-', {
a: {
type: AuthActionTypes.AUTHENTICATE,
- payload: {email: 'user', password: 'wrongpassword'}
+ payload: { email: 'user', password: 'wrongpassword' }
}
});
- const expected = cold('--b-', {b: new AuthenticationErrorAction(new Error('Message Error test'))});
+ const expected = cold('--b-', { b: new AuthenticationErrorAction(new Error('Message Error test')) });
expect(authEffects.authenticate$).toBeObservable(expected);
});
@@ -94,9 +97,9 @@ describe('AuthEffects', () => {
describe('authenticateSuccess$', () => {
it('should return a AUTHENTICATED action in response to a AUTHENTICATE_SUCCESS action', () => {
- actions = hot('--a-', {a: {type: AuthActionTypes.AUTHENTICATE_SUCCESS, payload: token}});
+ actions = hot('--a-', { a: { type: AuthActionTypes.AUTHENTICATE_SUCCESS, payload: token } });
- const expected = cold('--b-', {b: new AuthenticatedAction(token)});
+ const expected = cold('--b-', { b: new AuthenticatedAction(token) });
expect(authEffects.authenticateSuccess$).toBeObservable(expected);
});
@@ -106,9 +109,9 @@ describe('AuthEffects', () => {
describe('when token is valid', () => {
it('should return a AUTHENTICATED_SUCCESS action in response to a AUTHENTICATED action', () => {
- actions = hot('--a-', {a: {type: AuthActionTypes.AUTHENTICATED, payload: token}});
+ actions = hot('--a-', { a: { type: AuthActionTypes.AUTHENTICATED, payload: token } });
- const expected = cold('--b-', {b: new AuthenticatedSuccessAction(true, token, EPersonMock)});
+ const expected = cold('--b-', { b: new AuthenticatedSuccessAction(true, token, EPersonMock._links.self.href) });
expect(authEffects.authenticated$).toBeObservable(expected);
});
@@ -118,23 +121,42 @@ describe('AuthEffects', () => {
it('should return a AUTHENTICATED_ERROR action in response to a AUTHENTICATED action', () => {
spyOn((authEffects as any).authService, 'authenticatedUser').and.returnValue(observableThrow(new Error('Message Error test')));
- actions = hot('--a-', {a: {type: AuthActionTypes.AUTHENTICATED, payload: token}});
+ actions = hot('--a-', { a: { type: AuthActionTypes.AUTHENTICATED, payload: token } });
- const expected = cold('--b-', {b: new AuthenticatedErrorAction(new Error('Message Error test'))});
+ const expected = cold('--b-', { b: new AuthenticatedErrorAction(new Error('Message Error test')) });
expect(authEffects.authenticated$).toBeObservable(expected);
});
});
});
+ describe('authenticatedSuccess$', () => {
+
+ it('should return a RETRIEVE_AUTHENTICATED_EPERSON action in response to a AUTHENTICATED_SUCCESS action', () => {
+ actions = hot('--a-', {
+ a: {
+ type: AuthActionTypes.AUTHENTICATED_SUCCESS, payload: {
+ authenticated: true,
+ authToken: token,
+ userHref: EPersonMock._links.self.href
+ }
+ }
+ });
+
+ const expected = cold('--b-', { b: new RetrieveAuthenticatedEpersonAction(EPersonMock._links.self.href) });
+
+ expect(authEffects.authenticatedSuccess$).toBeObservable(expected);
+ });
+ });
+
describe('checkToken$', () => {
describe('when check token succeeded', () => {
it('should return a AUTHENTICATED action in response to a CHECK_AUTHENTICATION_TOKEN action', () => {
- actions = hot('--a-', {a: {type: AuthActionTypes.CHECK_AUTHENTICATION_TOKEN}});
+ actions = hot('--a-', { a: { type: AuthActionTypes.CHECK_AUTHENTICATION_TOKEN } });
- const expected = cold('--b-', {b: new AuthenticatedAction(token)});
+ const expected = cold('--b-', { b: new AuthenticatedAction(token) });
expect(authEffects.checkToken$).toBeObservable(expected);
});
@@ -144,23 +166,53 @@ describe('AuthEffects', () => {
it('should return a CHECK_AUTHENTICATION_TOKEN_ERROR action in response to a CHECK_AUTHENTICATION_TOKEN action', () => {
spyOn((authEffects as any).authService, 'hasValidAuthenticationToken').and.returnValue(observableThrow(''));
- actions = hot('--a-', {a: {type: AuthActionTypes.CHECK_AUTHENTICATION_TOKEN, payload: token}});
+ actions = hot('--a-', { a: { type: AuthActionTypes.CHECK_AUTHENTICATION_TOKEN, payload: token } });
- const expected = cold('--b-', {b: new CheckAuthenticationTokenErrorAction()});
+ const expected = cold('--b-', { b: new CheckAuthenticationTokenErrorAction() });
expect(authEffects.checkToken$).toBeObservable(expected);
});
})
});
+ describe('retrieveAuthenticatedEperson$', () => {
+
+ describe('when request is successful', () => {
+ it('should return a RETRIEVE_AUTHENTICATED_EPERSON_SUCCESS action in response to a RETRIEVE_AUTHENTICATED_EPERSON action', () => {
+ actions = hot('--a-', {
+ a: {
+ type: AuthActionTypes.RETRIEVE_AUTHENTICATED_EPERSON,
+ payload: EPersonMock._links.self.href
+ }
+ });
+
+ const expected = cold('--b-', { b: new RetrieveAuthenticatedEpersonSuccessAction(EPersonMock) });
+
+ expect(authEffects.retrieveAuthenticatedEperson$).toBeObservable(expected);
+ });
+ });
+
+ describe('when request is not successful', () => {
+ it('should return a RETRIEVE_AUTHENTICATED_EPERSON_ERROR action in response to a RETRIEVE_AUTHENTICATED_EPERSON action', () => {
+ spyOn((authEffects as any).authService, 'retrieveAuthenticatedUserByHref').and.returnValue(observableThrow(new Error('Message Error test')));
+
+ actions = hot('--a-', { a: { type: AuthActionTypes.RETRIEVE_AUTHENTICATED_EPERSON, payload: token } });
+
+ const expected = cold('--b-', { b: new RetrieveAuthenticatedEpersonErrorAction(new Error('Message Error test')) });
+
+ expect(authEffects.retrieveAuthenticatedEperson$).toBeObservable(expected);
+ });
+ });
+ });
+
describe('refreshToken$', () => {
describe('when refresh token succeeded', () => {
it('should return a REFRESH_TOKEN_SUCCESS action in response to a REFRESH_TOKEN action', () => {
- actions = hot('--a-', {a: {type: AuthActionTypes.REFRESH_TOKEN}});
+ actions = hot('--a-', { a: { type: AuthActionTypes.REFRESH_TOKEN } });
- const expected = cold('--b-', {b: new RefreshTokenSuccessAction(token)});
+ const expected = cold('--b-', { b: new RefreshTokenSuccessAction(token) });
expect(authEffects.refreshToken$).toBeObservable(expected);
});
@@ -170,9 +222,9 @@ describe('AuthEffects', () => {
it('should return a REFRESH_TOKEN_ERROR action in response to a REFRESH_TOKEN action', () => {
spyOn((authEffects as any).authService, 'refreshAuthenticationToken').and.returnValue(observableThrow(''));
- actions = hot('--a-', {a: {type: AuthActionTypes.REFRESH_TOKEN, payload: token}});
+ actions = hot('--a-', { a: { type: AuthActionTypes.REFRESH_TOKEN, payload: token } });
- const expected = cold('--b-', {b: new RefreshTokenErrorAction()});
+ const expected = cold('--b-', { b: new RefreshTokenErrorAction() });
expect(authEffects.refreshToken$).toBeObservable(expected);
});
@@ -184,9 +236,9 @@ describe('AuthEffects', () => {
describe('when refresh token succeeded', () => {
it('should return a LOG_OUT_SUCCESS action in response to a LOG_OUT action', () => {
- actions = hot('--a-', {a: {type: AuthActionTypes.LOG_OUT}});
+ actions = hot('--a-', { a: { type: AuthActionTypes.LOG_OUT } });
- const expected = cold('--b-', {b: new LogOutSuccessAction()});
+ const expected = cold('--b-', { b: new LogOutSuccessAction() });
expect(authEffects.logOut$).toBeObservable(expected);
});
@@ -196,9 +248,9 @@ describe('AuthEffects', () => {
it('should return a REFRESH_TOKEN_ERROR action in response to a LOG_OUT action', () => {
spyOn((authEffects as any).authService, 'logout').and.returnValue(observableThrow(new Error('Message Error test')));
- actions = hot('--a-', {a: {type: AuthActionTypes.LOG_OUT, payload: token}});
+ actions = hot('--a-', { a: { type: AuthActionTypes.LOG_OUT, payload: token } });
- const expected = cold('--b-', {b: new LogOutErrorAction(new Error('Message Error test'))});
+ const expected = cold('--b-', { b: new LogOutErrorAction(new Error('Message Error test')) });
expect(authEffects.logOut$).toBeObservable(expected);
});
diff --git a/src/app/core/auth/auth.effects.ts b/src/app/core/auth/auth.effects.ts
index 1e68802af8..5ee63ccd92 100644
--- a/src/app/core/auth/auth.effects.ts
+++ b/src/app/core/auth/auth.effects.ts
@@ -26,7 +26,10 @@ import {
RefreshTokenSuccessAction,
RegistrationAction,
RegistrationErrorAction,
- RegistrationSuccessAction
+ RegistrationSuccessAction,
+ RetrieveAuthenticatedEpersonAction,
+ RetrieveAuthenticatedEpersonErrorAction,
+ RetrieveAuthenticatedEpersonSuccessAction
} from './auth.actions';
import { EPerson } from '../eperson/models/eperson.model';
import { AuthStatus } from './models/auth-status.model';
@@ -66,11 +69,17 @@ export class AuthEffects {
ofType(AuthActionTypes.AUTHENTICATED),
switchMap((action: AuthenticatedAction) => {
return this.authService.authenticatedUser(action.payload).pipe(
- map((user: EPerson) => new AuthenticatedSuccessAction((user !== null), action.payload, user)),
+ map((userHref: string) => new AuthenticatedSuccessAction((userHref !== null), action.payload, userHref)),
catchError((error) => observableOf(new AuthenticatedErrorAction(error))),);
})
);
+ @Effect()
+ public authenticatedSuccess$: Observable = this.actions$.pipe(
+ ofType(AuthActionTypes.AUTHENTICATED_SUCCESS),
+ map((action: AuthenticatedSuccessAction) => new RetrieveAuthenticatedEpersonAction(action.payload.userHref))
+ );
+
// It means "reacts to this action but don't send another"
@Effect({ dispatch: false })
public authenticatedError$: Observable = this.actions$.pipe(
@@ -78,6 +87,16 @@ export class AuthEffects {
tap((action: LogOutSuccessAction) => this.authService.removeToken())
);
+ @Effect()
+ public retrieveAuthenticatedEperson$: Observable = this.actions$.pipe(
+ ofType(AuthActionTypes.RETRIEVE_AUTHENTICATED_EPERSON),
+ switchMap((action: RetrieveAuthenticatedEpersonAction) => {
+ return this.authService.retrieveAuthenticatedUserByHref(action.payload).pipe(
+ map((user: EPerson) => new RetrieveAuthenticatedEpersonSuccessAction(user)),
+ catchError((error) => observableOf(new RetrieveAuthenticatedEpersonErrorAction(error))));
+ })
+ );
+
@Effect()
public checkToken$: Observable = this.actions$.pipe(ofType(AuthActionTypes.CHECK_AUTHENTICATION_TOKEN),
switchMap(() => {
diff --git a/src/app/core/auth/auth.reducer.spec.ts b/src/app/core/auth/auth.reducer.spec.ts
index ca2ba00036..f299696007 100644
--- a/src/app/core/auth/auth.reducer.spec.ts
+++ b/src/app/core/auth/auth.reducer.spec.ts
@@ -17,7 +17,7 @@ import {
RefreshTokenAction,
RefreshTokenErrorAction,
RefreshTokenSuccessAction,
- ResetAuthenticationMessagesAction,
+ ResetAuthenticationMessagesAction, RetrieveAuthenticatedEpersonErrorAction, RetrieveAuthenticatedEpersonSuccessAction,
SetRedirectUrlAction
} from './auth.actions';
import { AuthTokenInfo } from './models/auth-token-info.model';
@@ -107,16 +107,15 @@ describe('authReducer', () => {
loading: true,
info: undefined
};
- const action = new AuthenticatedSuccessAction(true, mockTokenInfo, EPersonMock);
+ const action = new AuthenticatedSuccessAction(true, mockTokenInfo, EPersonMock._links.self.href);
const newState = authReducer(initialState, action);
state = {
authenticated: true,
authToken: mockTokenInfo,
- loaded: true,
+ loaded: false,
error: undefined,
- loading: false,
- info: undefined,
- user: EPersonMock
+ loading: true,
+ info: undefined
};
expect(newState).toEqual(state);
});
@@ -242,6 +241,50 @@ describe('authReducer', () => {
expect(newState).toEqual(state);
});
+ it('should properly set the state, in response to a RETRIEVE_AUTHENTICATED_EPERSON_SUCCESS action', () => {
+ initialState = {
+ authenticated: true,
+ authToken: mockTokenInfo,
+ loaded: false,
+ error: undefined,
+ loading: true,
+ info: undefined
+ };
+ const action = new RetrieveAuthenticatedEpersonSuccessAction(EPersonMock);
+ const newState = authReducer(initialState, action);
+ state = {
+ authenticated: true,
+ authToken: mockTokenInfo,
+ loaded: true,
+ error: undefined,
+ loading: false,
+ info: undefined,
+ user: EPersonMock
+ };
+ expect(newState).toEqual(state);
+ });
+
+ it('should properly set the state, in response to a RETRIEVE_AUTHENTICATED_EPERSON_ERROR action', () => {
+ initialState = {
+ authenticated: false,
+ loaded: false,
+ error: undefined,
+ loading: true,
+ info: undefined
+ };
+ const action = new RetrieveAuthenticatedEpersonErrorAction(mockError);
+ const newState = authReducer(initialState, action);
+ state = {
+ authenticated: false,
+ authToken: undefined,
+ error: 'Test error message',
+ loaded: true,
+ loading: false,
+ info: undefined
+ };
+ expect(newState).toEqual(state);
+ });
+
it('should properly set the state, in response to a REFRESH_TOKEN action', () => {
initialState = {
authenticated: true,
diff --git a/src/app/core/auth/auth.reducer.ts b/src/app/core/auth/auth.reducer.ts
index 98827d842e..7d5e50c432 100644
--- a/src/app/core/auth/auth.reducer.ts
+++ b/src/app/core/auth/auth.reducer.ts
@@ -8,7 +8,7 @@ import {
LogOutErrorAction,
RedirectWhenAuthenticationIsRequiredAction,
RedirectWhenTokenExpiredAction,
- RefreshTokenSuccessAction,
+ RefreshTokenSuccessAction, RetrieveAuthenticatedEpersonSuccessAction,
SetRedirectUrlAction
} from './auth.actions';
// import models
@@ -80,6 +80,7 @@ export function authReducer(state: any = initialState, action: AuthActions): Aut
});
case AuthActionTypes.AUTHENTICATED_ERROR:
+ case AuthActionTypes.RETRIEVE_AUTHENTICATED_EPERSON_ERROR:
return Object.assign({}, state, {
authenticated: false,
authToken: undefined,
@@ -91,12 +92,16 @@ export function authReducer(state: any = initialState, action: AuthActions): Aut
case AuthActionTypes.AUTHENTICATED_SUCCESS:
return Object.assign({}, state, {
authenticated: true,
- authToken: (action as AuthenticatedSuccessAction).payload.authToken,
+ authToken: (action as AuthenticatedSuccessAction).payload.authToken
+ });
+
+ case AuthActionTypes.RETRIEVE_AUTHENTICATED_EPERSON_SUCCESS:
+ return Object.assign({}, state, {
loaded: true,
error: undefined,
loading: false,
info: undefined,
- user: (action as AuthenticatedSuccessAction).payload.user
+ user: (action as RetrieveAuthenticatedEpersonSuccessAction).payload
});
case AuthActionTypes.AUTHENTICATE_ERROR:
diff --git a/src/app/core/auth/auth.service.spec.ts b/src/app/core/auth/auth.service.spec.ts
index 86794f257b..31649abe32 100644
--- a/src/app/core/auth/auth.service.spec.ts
+++ b/src/app/core/auth/auth.service.spec.ts
@@ -11,7 +11,6 @@ import { NativeWindowRef, NativeWindowService } from '../services/window.service
import { AuthService } from './auth.service';
import { RouterStub } from '../../shared/testing/router-stub';
import { ActivatedRouteStub } from '../../shared/testing/active-router-stub';
-
import { CookieService } from '../services/cookie.service';
import { AuthRequestServiceStub } from '../../shared/testing/auth-request-service-stub';
import { AuthRequestService } from './auth-request.service';
@@ -22,12 +21,21 @@ import { EPersonMock } from '../../shared/testing/eperson-mock';
import { AppState } from '../../app.reducer';
import { ClientCookieService } from '../services/client-cookie.service';
import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
-import { getMockRemoteDataBuildService } from '../../shared/mocks/mock-remote-data-build.service';
import { routeServiceStub } from '../../shared/testing/route-service-stub';
import { RouteService } from '../services/route.service';
+import { Observable } from 'rxjs/internal/Observable';
+import { RemoteData } from '../data/remote-data';
+import { createSuccessfulRemoteDataObject$ } from '../../shared/testing/utils';
+import { EPersonDataService } from '../eperson/eperson-data.service';
describe('AuthService test', () => {
+ const mockEpersonDataService: any = {
+ findByHref(href: string): Observable> {
+ return createSuccessfulRemoteDataObject$(EPersonMock);
+ }
+ };
+
let mockStore: Store;
let authService: AuthService;
let routeServiceMock: RouteService;
@@ -38,7 +46,7 @@ describe('AuthService test', () => {
let storage: CookieService;
let token: AuthTokenInfo;
let authenticatedState;
- let rdbService;
+ let linkService;
function init() {
mockStore = jasmine.createSpyObj('store', {
@@ -58,8 +66,10 @@ describe('AuthService test', () => {
};
authRequest = new AuthRequestServiceStub();
routeStub = new ActivatedRouteStub();
- rdbService = getMockRemoteDataBuildService();
- spyOn(rdbService, 'build').and.returnValue({authenticated: true, eperson: observableOf({payload: {}})});
+ linkService = {
+ resolveLinks: {}
+ };
+ spyOn(linkService, 'resolveLinks').and.returnValue({ authenticated: true, eperson: observableOf({ payload: {} }) });
}
@@ -80,7 +90,7 @@ describe('AuthService test', () => {
{ provide: RouteService, useValue: routeServiceStub },
{ provide: ActivatedRoute, useValue: routeStub },
{ provide: Store, useValue: mockStore },
- { provide: RemoteDataBuildService, useValue: rdbService },
+ { provide: EPersonDataService, useValue: mockEpersonDataService },
CookieService,
AuthService
],
@@ -98,8 +108,14 @@ describe('AuthService test', () => {
expect(authService.authenticate.bind(null, 'user', 'passwordwrong')).toThrow();
});
- it('should return the authenticated user object when user token is valid', () => {
- authService.authenticatedUser(new AuthTokenInfo('test_token')).subscribe((user: EPerson) => {
+ it('should return the authenticated user href when user token is valid', () => {
+ authService.authenticatedUser(new AuthTokenInfo('test_token')).subscribe((userHref: string) => {
+ expect(userHref).toBeDefined();
+ });
+ });
+
+ it('should return the authenticated user', () => {
+ authService.retrieveAuthenticatedUserByHref(EPersonMock._links.self.href).subscribe((user: EPerson) => {
expect(user).toBeDefined();
});
});
@@ -143,7 +159,7 @@ describe('AuthService test', () => {
{ provide: REQUEST, useValue: {} },
{ provide: Router, useValue: routerStub },
{ provide: RouteService, useValue: routeServiceStub },
- { provide: RemoteDataBuildService, useValue: rdbService },
+ { provide: RemoteDataBuildService, useValue: linkService },
CookieService,
AuthService
]
@@ -156,7 +172,7 @@ describe('AuthService test', () => {
(state as any).core = Object.create({});
(state as any).core.auth = authenticatedState;
});
- authService = new AuthService({}, window, undefined, authReqService, router, routeService, cookieService, store, rdbService);
+ authService = new AuthService({}, window, undefined, authReqService, mockEpersonDataService, router, routeService, cookieService, store);
}));
it('should return true when user is logged in', () => {
@@ -195,7 +211,7 @@ describe('AuthService test', () => {
{ provide: REQUEST, useValue: {} },
{ provide: Router, useValue: routerStub },
{ provide: RouteService, useValue: routeServiceStub },
- { provide: RemoteDataBuildService, useValue: rdbService },
+ { provide: RemoteDataBuildService, useValue: linkService },
ClientCookieService,
CookieService,
AuthService
@@ -218,7 +234,7 @@ describe('AuthService test', () => {
(state as any).core = Object.create({});
(state as any).core.auth = authenticatedState;
});
- authService = new AuthService({}, window, undefined, authReqService, router, routeService, cookieService, store, rdbService);
+ authService = new AuthService({}, window, undefined, authReqService, mockEpersonDataService, router, routeService, cookieService, store);
storage = (authService as any).storage;
routeServiceMock = TestBed.get(RouteService);
routerStub = TestBed.get(Router);
@@ -247,7 +263,7 @@ describe('AuthService test', () => {
expect(storage.remove).toHaveBeenCalled();
});
- it ('should set redirect url to previous page', () => {
+ it('should set redirect url to previous page', () => {
spyOn(routeServiceMock, 'getHistory').and.callThrough();
spyOn(routerStub, 'navigateByUrl');
authService.redirectAfterLoginSuccess(true);
@@ -255,7 +271,7 @@ describe('AuthService test', () => {
expect(routerStub.navigateByUrl).toHaveBeenCalledWith('/collection/123');
});
- it ('should set redirect url to current page', () => {
+ it('should set redirect url to current page', () => {
spyOn(routeServiceMock, 'getHistory').and.callThrough();
spyOn(routerStub, 'navigateByUrl');
authService.redirectAfterLoginSuccess(false);
@@ -263,7 +279,7 @@ describe('AuthService test', () => {
expect(routerStub.navigateByUrl).toHaveBeenCalledWith('/home');
});
- it ('should redirect to / and not to /login', () => {
+ it('should redirect to / and not to /login', () => {
spyOn(routeServiceMock, 'getHistory').and.returnValue(observableOf(['/login', '/login']));
spyOn(routerStub, 'navigateByUrl');
authService.redirectAfterLoginSuccess(true);
@@ -271,7 +287,7 @@ describe('AuthService test', () => {
expect(routerStub.navigateByUrl).toHaveBeenCalledWith('/');
});
- it ('should redirect to / when no redirect url is found', () => {
+ it('should redirect to / when no redirect url is found', () => {
spyOn(routeServiceMock, 'getHistory').and.returnValue(observableOf(['']));
spyOn(routerStub, 'navigateByUrl');
authService.redirectAfterLoginSuccess(true);
diff --git a/src/app/core/auth/auth.service.ts b/src/app/core/auth/auth.service.ts
index a536313521..fd5c98f789 100644
--- a/src/app/core/auth/auth.service.ts
+++ b/src/app/core/auth/auth.service.ts
@@ -4,7 +4,7 @@ import { HttpHeaders } from '@angular/common/http';
import { REQUEST, RESPONSE } from '@nguniversal/express-engine/tokens';
import { Observable, of as observableOf } from 'rxjs';
-import { distinctUntilChanged, filter, map, startWith, switchMap, take, withLatestFrom } from 'rxjs/operators';
+import { distinctUntilChanged, filter, map, startWith, take, withLatestFrom } from 'rxjs/operators';
import { RouterReducerState } from '@ngrx/router-store';
import { select, Store } from '@ngrx/store';
import { CookieAttributes } from 'js-cookie';
@@ -21,8 +21,9 @@ import { AppState, routerStateSelector } from '../../app.reducer';
import { ResetAuthenticationMessagesAction, SetRedirectUrlAction } from './auth.actions';
import { NativeWindowRef, NativeWindowService } from '../services/window.service';
import { Base64EncodeUrl } from '../../shared/utils/encode-decode.util';
-import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
-import {RouteService} from '../services/route.service';
+import { RouteService } from '../services/route.service';
+import { EPersonDataService } from '../eperson/eperson-data.service';
+import { getFirstSucceededRemoteDataPayload } from '../shared/operators';
export const LOGIN_ROUTE = '/login';
export const LOGOUT_ROUTE = '/logout';
@@ -43,13 +44,13 @@ export class AuthService {
constructor(@Inject(REQUEST) protected req: any,
@Inject(NativeWindowService) protected _window: NativeWindowRef,
- protected authRequestService: AuthRequestService,
@Optional() @Inject(RESPONSE) private response: any,
+ protected authRequestService: AuthRequestService,
+ protected epersonService: EPersonDataService,
protected router: Router,
protected routeService: RouteService,
protected storage: CookieService,
- protected store: Store,
- protected rdbService: RemoteDataBuildService
+ protected store: Store
) {
this.store.pipe(
select(isAuthenticated),
@@ -122,10 +123,10 @@ export class AuthService {
}
/**
- * Returns the authenticated user
- * @returns {User}
+ * Returns the href link to authenticated user
+ * @returns {string}
*/
- public authenticatedUser(token: AuthTokenInfo): Observable {
+ public authenticatedUser(token: AuthTokenInfo): Observable {
// Determine if the user has an existing auth session on the server
const options: HttpOptions = Object.create({});
let headers = new HttpHeaders();
@@ -133,16 +134,25 @@ export class AuthService {
headers = headers.append('Authorization', `Bearer ${token.accessToken}`);
options.headers = headers;
return this.authRequestService.getRequest('status', options).pipe(
- map((status) => this.rdbService.build(status)),
- switchMap((status: AuthStatus) => {
+ map((status: AuthStatus) => {
if (status.authenticated) {
- return status.eperson.pipe(map((eperson) => eperson.payload));
+ return status._links.eperson.href;
} else {
throw(new Error('Not authenticated'));
}
}))
}
+ /**
+ * Returns the authenticated user
+ * @returns {User}
+ */
+ public retrieveAuthenticatedUserByHref(userHref: string): Observable {
+ return this.epersonService.findByHref(userHref).pipe(
+ getFirstSucceededRemoteDataPayload()
+ )
+ }
+
/**
* Checks if token is present into browser storage and is valid. (NB Check is done only on SSR)
*/
diff --git a/src/app/core/auth/models/auth-status.model.ts b/src/app/core/auth/models/auth-status.model.ts
index e0d568397a..edad46a7bc 100644
--- a/src/app/core/auth/models/auth-status.model.ts
+++ b/src/app/core/auth/models/auth-status.model.ts
@@ -1,54 +1,83 @@
-import { AuthError } from './auth-error.model';
-import { AuthTokenInfo } from './auth-token-info.model';
-import { EPerson } from '../../eperson/models/eperson.model';
-import { RemoteData } from '../../data/remote-data';
+import { autoserialize, deserialize, deserializeAs } from 'cerialize';
import { Observable } from 'rxjs';
+import { link, typedObject } from '../../cache/builders/build-decorators';
+import { IDToUUIDSerializer } from '../../cache/id-to-uuid-serializer';
import { CacheableObject } from '../../cache/object-cache.reducer';
+import { RemoteData } from '../../data/remote-data';
+import { EPerson } from '../../eperson/models/eperson.model';
+import { EPERSON } from '../../eperson/models/eperson.resource-type';
+import { HALLink } from '../../shared/hal-link.model';
import { ResourceType } from '../../shared/resource-type';
+import { excludeFromEquals } from '../../utilities/equals.decorators';
+import { AuthError } from './auth-error.model';
+import { AUTH_STATUS } from './auth-status.resource-type';
+import { AuthTokenInfo } from './auth-token-info.model';
/**
* Object that represents the authenticated status of a user
*/
+@typedObject
export class AuthStatus implements CacheableObject {
- static type = new ResourceType('status');
+ static type = AUTH_STATUS;
/**
* The unique identifier of this auth status
*/
+ @autoserialize
id: string;
/**
- * The unique uuid of this auth status
+ * The type for this AuthStatus
*/
+ @excludeFromEquals
+ @autoserialize
+ type: ResourceType;
+
+ /**
+ * The UUID of this auth status
+ * This UUID is generated client-side and isn't used by the backend.
+ * It is based on the ID, so it will be the same for each refresh.
+ */
+ @deserializeAs(new IDToUUIDSerializer('auth-status'), 'id')
uuid: string;
/**
* True if REST API is up and running, should never return false
*/
+ @autoserialize
okay: boolean;
/**
* If the auth status represents an authenticated state
*/
+ @autoserialize
authenticated: boolean;
/**
- * Authentication error if there was one for this status
+ * The {@link HALLink}s for this AuthStatus
*/
- error?: AuthError;
+ @deserialize
+ _links: {
+ self: HALLink;
+ eperson: HALLink;
+ };
/**
- * The eperson of this auth status
+ * The EPerson of this auth status
+ * Will be undefined unless the eperson {@link HALLink} has been resolved.
*/
- eperson: Observable>;
+ @link(EPERSON)
+ eperson?: Observable>;
/**
* True if the token is valid, false if there was no token or the token wasn't valid
*/
+ @autoserialize
token?: AuthTokenInfo;
/**
- * The self link of this auth status' REST object
+ * Authentication error if there was one for this status
*/
- self: string;
+ // TODO should be refactored to use the RemoteData error
+ error?: AuthError;
}
diff --git a/src/app/core/auth/models/auth-status.resource-type.ts b/src/app/core/auth/models/auth-status.resource-type.ts
new file mode 100644
index 0000000000..2b7c7252fc
--- /dev/null
+++ b/src/app/core/auth/models/auth-status.resource-type.ts
@@ -0,0 +1,9 @@
+import { ResourceType } from '../../shared/resource-type';
+
+/**
+ * The resource type for AuthStatus
+ *
+ * Needs to be in a separate file to prevent circular
+ * dependencies in webpack.
+ */
+export const AUTH_STATUS = new ResourceType('status');
diff --git a/src/app/core/auth/models/normalized-auth-status.model.ts b/src/app/core/auth/models/normalized-auth-status.model.ts
deleted file mode 100644
index 3892bee408..0000000000
--- a/src/app/core/auth/models/normalized-auth-status.model.ts
+++ /dev/null
@@ -1,41 +0,0 @@
-import { AuthStatus } from './auth-status.model';
-import { autoserialize, autoserializeAs, inheritSerialization } from 'cerialize';
-import { mapsTo, relationship } from '../../cache/builders/build-decorators';
-import { NormalizedObject } from '../../cache/models/normalized-object.model';
-import { IDToUUIDSerializer } from '../../cache/id-to-uuid-serializer';
-import { EPerson } from '../../eperson/models/eperson.model';
-
-@mapsTo(AuthStatus)
-@inheritSerialization(NormalizedObject)
-export class NormalizedAuthStatus extends NormalizedObject {
- /**
- * The unique identifier of this auth status
- */
- @autoserialize
- id: string;
-
- /**
- * The unique generated uuid of this auth status
- */
- @autoserializeAs(new IDToUUIDSerializer('auth-status'), 'id')
- uuid: string;
-
- /**
- * True if REST API is up and running, should never return false
- */
- @autoserialize
- okay: boolean;
-
- /**
- * True if the token is valid, false if there was no token or the token wasn't valid
- */
- @autoserialize
- authenticated: boolean;
-
- /**
- * The self link to the eperson of this auth status
- */
- @relationship(EPerson, false)
- @autoserialize
- eperson: string;
-}
diff --git a/src/app/core/auth/server-auth.service.ts b/src/app/core/auth/server-auth.service.ts
index cf4d4a658e..c8cba0206b 100644
--- a/src/app/core/auth/server-auth.service.ts
+++ b/src/app/core/auth/server-auth.service.ts
@@ -1,15 +1,14 @@
-import { filter, map, switchMap, take } from 'rxjs/operators';
+import { HttpHeaders } from '@angular/common/http';
import { Injectable } from '@angular/core';
import { Observable } from 'rxjs';
-import { HttpHeaders } from '@angular/common/http';
+import { filter, map, take } from 'rxjs/operators';
+import { isNotEmpty } from '../../shared/empty.util';
import { HttpOptions } from '../dspace-rest-v2/dspace-rest-v2.service';
-import { AuthStatus } from './models/auth-status.model';
-import { isEmpty, isNotEmpty } from '../../shared/empty.util';
-import { AuthService, LOGIN_ROUTE } from './auth.service';
-import { AuthTokenInfo } from './models/auth-token-info.model';
import { CheckAuthenticationTokenAction } from './auth.actions';
-import { EPerson } from '../eperson/models/eperson.model';
+import { AuthService } from './auth.service';
+import { AuthStatus } from './models/auth-status.model';
+import { AuthTokenInfo } from './models/auth-token-info.model';
/**
* The auth service.
@@ -21,7 +20,7 @@ export class ServerAuthService extends AuthService {
* Returns the authenticated user
* @returns {User}
*/
- public authenticatedUser(token: AuthTokenInfo): Observable {
+ public authenticatedUser(token: AuthTokenInfo): Observable {
// Determine if the user has an existing auth session on the server
const options: HttpOptions = Object.create({});
let headers = new HttpHeaders();
@@ -34,10 +33,9 @@ export class ServerAuthService extends AuthService {
options.headers = headers;
return this.authRequestService.getRequest('status', options).pipe(
- map((status) => this.rdbService.build(status)),
- switchMap((status: AuthStatus) => {
+ map((status: AuthStatus) => {
if (status.authenticated) {
- return status.eperson.pipe(map((eperson) => eperson.payload));
+ return status._links.eperson.href;
} else {
throw(new Error('Not authenticated'));
}
diff --git a/src/app/core/breadcrumbs/breadcrumbs.service.ts b/src/app/core/breadcrumbs/breadcrumbs.service.ts
new file mode 100644
index 0000000000..f274485d5d
--- /dev/null
+++ b/src/app/core/breadcrumbs/breadcrumbs.service.ts
@@ -0,0 +1,15 @@
+import { Breadcrumb } from '../../breadcrumbs/breadcrumb/breadcrumb.model';
+import { Observable } from 'rxjs';
+
+/**
+ * Service to calculate breadcrumbs for a single part of the route
+ */
+export interface BreadcrumbsService {
+
+ /**
+ * Method to calculate the breadcrumbs for a part of the route
+ * @param key The key used to resolve the breadcrumb
+ * @param url The url to use as a link for this breadcrumb
+ */
+ getBreadcrumbs(key: T, url: string): Observable;
+}
diff --git a/src/app/core/breadcrumbs/collection-breadcrumb.resolver.ts b/src/app/core/breadcrumbs/collection-breadcrumb.resolver.ts
new file mode 100644
index 0000000000..d9df7cd767
--- /dev/null
+++ b/src/app/core/breadcrumbs/collection-breadcrumb.resolver.ts
@@ -0,0 +1,29 @@
+import { Injectable } from '@angular/core';
+import { DSOBreadcrumbsService } from './dso-breadcrumbs.service';
+import { DSOBreadcrumbResolver } from './dso-breadcrumb.resolver';
+import { Collection } from '../shared/collection.model';
+import { CollectionDataService } from '../data/collection-data.service';
+import { followLink, FollowLinkConfig } from '../../shared/utils/follow-link-config.model';
+
+/**
+ * The class that resolves the BreadcrumbConfig object for a Collection
+ */
+@Injectable()
+export class CollectionBreadcrumbResolver extends DSOBreadcrumbResolver {
+ constructor(protected breadcrumbService: DSOBreadcrumbsService, protected dataService: CollectionDataService) {
+ super(breadcrumbService, dataService);
+ }
+
+ /**
+ * Method that returns the follow links to already resolve
+ * The self links defined in this list are expected to be requested somewhere in the near future
+ * Requesting them as embeds will limit the number of requests
+ */
+ get followLinks(): Array> {
+ return [
+ followLink('parentCommunity', undefined,
+ followLink('parentCommunity')
+ )
+ ];
+ }
+}
diff --git a/src/app/core/breadcrumbs/community-breadcrumb.resolver.ts b/src/app/core/breadcrumbs/community-breadcrumb.resolver.ts
new file mode 100644
index 0000000000..d1f21455f2
--- /dev/null
+++ b/src/app/core/breadcrumbs/community-breadcrumb.resolver.ts
@@ -0,0 +1,27 @@
+import { Injectable } from '@angular/core';
+import { DSOBreadcrumbsService } from './dso-breadcrumbs.service';
+import { DSOBreadcrumbResolver } from './dso-breadcrumb.resolver';
+import { CommunityDataService } from '../data/community-data.service';
+import { Community } from '../shared/community.model';
+import { followLink, FollowLinkConfig } from '../../shared/utils/follow-link-config.model';
+
+/**
+ * The class that resolves the BreadcrumbConfig object for a Community
+ */
+@Injectable()
+export class CommunityBreadcrumbResolver extends DSOBreadcrumbResolver {
+ constructor(protected breadcrumbService: DSOBreadcrumbsService, protected dataService: CommunityDataService) {
+ super(breadcrumbService, dataService);
+ }
+
+ /**
+ * Method that returns the follow links to already resolve
+ * The self links defined in this list are expected to be requested somewhere in the near future
+ * Requesting them as embeds will limit the number of requests
+ */
+ get followLinks(): Array> {
+ return [
+ followLink('parentCommunity')
+ ];
+ }
+}
diff --git a/src/app/core/breadcrumbs/dso-breadcrumb.resolver.spec.ts b/src/app/core/breadcrumbs/dso-breadcrumb.resolver.spec.ts
new file mode 100644
index 0000000000..2a0005f548
--- /dev/null
+++ b/src/app/core/breadcrumbs/dso-breadcrumb.resolver.spec.ts
@@ -0,0 +1,35 @@
+import { DSOBreadcrumbResolver } from './dso-breadcrumb.resolver';
+import { Collection } from '../shared/collection.model';
+import { createSuccessfulRemoteDataObject$ } from '../../shared/testing/utils';
+import { getTestScheduler } from 'jasmine-marbles';
+import { CollectionBreadcrumbResolver } from './collection-breadcrumb.resolver';
+
+describe('DSOBreadcrumbResolver', () => {
+ describe('resolve', () => {
+ let resolver: DSOBreadcrumbResolver;
+ let collectionService: any;
+ let dsoBreadcrumbService: any;
+ let testCollection: Collection;
+ let uuid;
+ let breadcrumbUrl;
+ let currentUrl;
+
+ beforeEach(() => {
+ uuid = '1234-65487-12354-1235';
+ breadcrumbUrl = '/collections/' + uuid;
+ currentUrl = breadcrumbUrl + '/edit';
+ testCollection = Object.assign(new Collection(), { uuid });
+ dsoBreadcrumbService = {};
+ collectionService = {
+ findById: (id: string) => createSuccessfulRemoteDataObject$(testCollection)
+ };
+ resolver = new CollectionBreadcrumbResolver(dsoBreadcrumbService, collectionService);
+ });
+
+ it('should resolve a breadcrumb config for the correct DSO', () => {
+ const resolvedConfig = resolver.resolve({ params: { id: uuid } } as any, { url: currentUrl } as any);
+ const expectedConfig = { provider: dsoBreadcrumbService, key: testCollection, url: breadcrumbUrl };
+ getTestScheduler().expectObservable(resolvedConfig).toBe('(a|)', { a: expectedConfig})
+ });
+ });
+});
diff --git a/src/app/core/breadcrumbs/dso-breadcrumb.resolver.ts b/src/app/core/breadcrumbs/dso-breadcrumb.resolver.ts
new file mode 100644
index 0000000000..80e68a16f5
--- /dev/null
+++ b/src/app/core/breadcrumbs/dso-breadcrumb.resolver.ts
@@ -0,0 +1,46 @@
+import { BreadcrumbConfig } from '../../breadcrumbs/breadcrumb/breadcrumb-config.model';
+import { Injectable } from '@angular/core';
+import { ActivatedRouteSnapshot, Resolve, RouterStateSnapshot } from '@angular/router';
+import { DSOBreadcrumbsService } from './dso-breadcrumbs.service';
+import { DataService } from '../data/data.service';
+import { getRemoteDataPayload, getSucceededRemoteData } from '../shared/operators';
+import { map } from 'rxjs/operators';
+import { Observable } from 'rxjs';
+import { DSpaceObject } from '../shared/dspace-object.model';
+import { ChildHALResource } from '../shared/child-hal-resource.model';
+import { FollowLinkConfig } from '../../shared/utils/follow-link-config.model';
+
+/**
+ * The class that resolves the BreadcrumbConfig object for a DSpaceObject
+ */
+@Injectable()
+export abstract class DSOBreadcrumbResolver implements Resolve> {
+ constructor(protected breadcrumbService: DSOBreadcrumbsService, protected dataService: DataService) {
+ }
+
+ /**
+ * Method for resolving a breadcrumb config object
+ * @param {ActivatedRouteSnapshot} route The current ActivatedRouteSnapshot
+ * @param {RouterStateSnapshot} state The current RouterStateSnapshot
+ * @returns BreadcrumbConfig object
+ */
+ resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable> {
+ const uuid = route.params.id;
+ return this.dataService.findById(uuid, ...this.followLinks).pipe(
+ getSucceededRemoteData(),
+ getRemoteDataPayload(),
+ map((object: T) => {
+ const fullPath = state.url;
+ const url = fullPath.substr(0, fullPath.indexOf(uuid)) + uuid;
+ return { provider: this.breadcrumbService, key: object, url: url };
+ })
+ );
+ }
+
+ /**
+ * Method that returns the follow links to already resolve
+ * The self links defined in this list are expected to be requested somewhere in the near future
+ * Requesting them as embeds will limit the number of requests
+ */
+ abstract get followLinks(): Array>;
+}
diff --git a/src/app/core/breadcrumbs/dso-breadcrumbs.service.spec.ts b/src/app/core/breadcrumbs/dso-breadcrumbs.service.spec.ts
new file mode 100644
index 0000000000..101545cb14
--- /dev/null
+++ b/src/app/core/breadcrumbs/dso-breadcrumbs.service.spec.ts
@@ -0,0 +1,122 @@
+import { async, TestBed } from '@angular/core/testing';
+import { DSOBreadcrumbsService } from './dso-breadcrumbs.service';
+import { getMockLinkService } from '../../shared/mocks/mock-link-service';
+import { LinkService } from '../cache/builders/link.service';
+import { Item } from '../shared/item.model';
+import { createSuccessfulRemoteDataObject, createSuccessfulRemoteDataObject$ } from '../../shared/testing/utils';
+import { DSpaceObject } from '../shared/dspace-object.model';
+import { of as observableOf } from 'rxjs';
+import { Community } from '../shared/community.model';
+import { Collection } from '../shared/collection.model';
+import { Breadcrumb } from '../../breadcrumbs/breadcrumb/breadcrumb.model';
+import { getTestScheduler } from 'jasmine-marbles';
+import { getDSOPath } from '../../app-routing.module';
+import { DSONameService } from './dso-name.service';
+
+describe('DSOBreadcrumbsService', () => {
+ let service: DSOBreadcrumbsService;
+ let linkService: any;
+ let testItem;
+ let testCollection;
+ let testCommunity;
+
+ let itemPath;
+ let collectionPath;
+ let communityPath;
+
+ let itemUUID;
+ let collectionUUID;
+ let communityUUID;
+
+ let dsoNameService;
+
+ function init() {
+ itemPath = '/items/';
+ collectionPath = '/collection/';
+ communityPath = '/community/';
+
+ itemUUID = '04dd18fc-03f9-4b9a-9304-ed7c313686d3';
+ collectionUUID = '91dfa5b5-5440-4fb4-b869-02610342f886';
+ communityUUID = '6c0bfa6b-ce82-4bf4-a2a8-fd7682c567e8';
+
+ testCommunity = Object.assign(new Community(),
+ {
+ type: 'community',
+ metadata: {
+ 'dc.title': [{value: 'community'}]
+ },
+ uuid: communityUUID,
+ parentCommunity: observableOf(Object.assign(createSuccessfulRemoteDataObject(undefined), { statusCode: 204 })),
+
+ _links: {
+ parentCommunity: 'site',
+ self: communityPath + communityUUID
+ }
+ }
+ );
+
+ testCollection = Object.assign(new Collection(),
+ {
+ type: 'collection',
+ metadata: {
+ 'dc.title': [{value: 'collection'}]
+ },
+ uuid: collectionUUID,
+ parentCommunity: createSuccessfulRemoteDataObject$(testCommunity),
+ _links: {
+ parentCommunity: communityPath + communityUUID,
+ self: communityPath + collectionUUID
+ }
+ }
+ );
+
+ testItem = Object.assign(new Item(),
+ {
+ type: 'item',
+ metadata: {
+ 'dc.title': [{value: 'item'}]
+ },
+ uuid: itemUUID,
+ owningCollection: createSuccessfulRemoteDataObject$(testCollection),
+ _links: {
+ owningCollection: collectionPath + collectionUUID,
+ self: itemPath + itemUUID
+ }
+ }
+ );
+
+ dsoNameService = { getName: (dso) => getName(dso) }
+ }
+
+ beforeEach(async(() => {
+ init();
+ TestBed.configureTestingModule({
+ providers: [
+ { provide: LinkService, useValue: getMockLinkService() },
+ { provide: DSONameService, useValue: dsoNameService }
+ ]
+ }).compileComponents();
+ }));
+
+ beforeEach(() => {
+ linkService = TestBed.get(LinkService);
+ linkService.resolveLink.and.callFake((object, link) => object);
+ service = new DSOBreadcrumbsService(linkService, dsoNameService);
+ });
+
+ describe('getBreadcrumbs', () => {
+ it('should return the breadcrumbs based on an Item', () => {
+ const breadcrumbs = service.getBreadcrumbs(testItem, testItem._links.self);
+ const expectedCrumbs = [
+ new Breadcrumb(getName(testCommunity), getDSOPath(testCommunity)),
+ new Breadcrumb(getName(testCollection), getDSOPath(testCollection)),
+ new Breadcrumb(getName(testItem), getDSOPath(testItem)),
+ ];
+ getTestScheduler().expectObservable(breadcrumbs).toBe('(a|)', { a: expectedCrumbs });
+ })
+ });
+
+ function getName(dso: DSpaceObject): string {
+ return dso.metadata['dc.title'][0].value
+ }
+});
diff --git a/src/app/core/breadcrumbs/dso-breadcrumbs.service.ts b/src/app/core/breadcrumbs/dso-breadcrumbs.service.ts
new file mode 100644
index 0000000000..3cb73be876
--- /dev/null
+++ b/src/app/core/breadcrumbs/dso-breadcrumbs.service.ts
@@ -0,0 +1,50 @@
+import { Breadcrumb } from '../../breadcrumbs/breadcrumb/breadcrumb.model';
+import { BreadcrumbsService } from './breadcrumbs.service';
+import { DSONameService } from './dso-name.service';
+import { Observable, of as observableOf } from 'rxjs';
+import { ChildHALResource } from '../shared/child-hal-resource.model';
+import { LinkService } from '../cache/builders/link.service';
+import { DSpaceObject } from '../shared/dspace-object.model';
+import { followLink } from '../../shared/utils/follow-link-config.model';
+import { find, map, switchMap } from 'rxjs/operators';
+import { getDSOPath } from '../../app-routing.module';
+import { RemoteData } from '../data/remote-data';
+import { hasValue } from '../../shared/empty.util';
+import { Injectable } from '@angular/core';
+
+/**
+ * Service to calculate DSpaceObject breadcrumbs for a single part of the route
+ */
+@Injectable()
+export class DSOBreadcrumbsService implements BreadcrumbsService {
+ constructor(
+ private linkService: LinkService,
+ private dsoNameService: DSONameService
+ ) {
+
+ }
+
+ /**
+ * Method to recursively calculate the breadcrumbs
+ * This method returns the name and url of the key and all its parent DSO's recursively, top down
+ * @param key The key (a DSpaceObject) used to resolve the breadcrumb
+ * @param url The url to use as a link for this breadcrumb
+ */
+ getBreadcrumbs(key: ChildHALResource & DSpaceObject, url: string): Observable {
+ const label = this.dsoNameService.getName(key);
+ const crumb = new Breadcrumb(label, url);
+ const propertyName = key.getParentLinkKey();
+ return this.linkService.resolveLink(key, followLink(propertyName))[propertyName].pipe(
+ find((parentRD: RemoteData) => parentRD.hasSucceeded || parentRD.statusCode === 204),
+ switchMap((parentRD: RemoteData) => {
+ if (hasValue(parentRD.payload)) {
+ const parent = parentRD.payload;
+ return this.getBreadcrumbs(parent, getDSOPath(parent))
+ }
+ return observableOf([]);
+
+ }),
+ map((breadcrumbs: Breadcrumb[]) => [...breadcrumbs, crumb])
+ );
+ }
+}
diff --git a/src/app/core/breadcrumbs/dso-name.service.spec.ts b/src/app/core/breadcrumbs/dso-name.service.spec.ts
new file mode 100644
index 0000000000..aa06116ed5
--- /dev/null
+++ b/src/app/core/breadcrumbs/dso-name.service.spec.ts
@@ -0,0 +1,116 @@
+import { ListableObject } from '../../shared/object-collection/shared/listable-object.model';
+import { DSpaceObject } from '../shared/dspace-object.model';
+import { GenericConstructor } from '../shared/generic-constructor';
+import { Item } from '../shared/item.model';
+import { MetadataValueFilter } from '../shared/metadata.models';
+import { DSONameService } from './dso-name.service';
+
+describe(`DSONameService`, () => {
+ let service: DSONameService;
+ let mockPersonName: string;
+ let mockPerson: DSpaceObject;
+ let mockOrgUnitName: string;
+ let mockOrgUnit: DSpaceObject;
+ let mockDSOName: string;
+ let mockDSO: DSpaceObject;
+
+ beforeEach(() => {
+ mockPersonName = 'Doe, John';
+ mockPerson = Object.assign(new DSpaceObject(), {
+ firstMetadataValue(keyOrKeys: string | string[], valueFilter?: MetadataValueFilter): string {
+ return mockPersonName
+ },
+ getRenderTypes(): Array> {
+ return ['Person', Item, DSpaceObject];
+ }
+ });
+
+ mockOrgUnitName = 'Molecular Spectroscopy';
+ mockOrgUnit = Object.assign(new DSpaceObject(), {
+ firstMetadataValue(keyOrKeys: string | string[], valueFilter?: MetadataValueFilter): string {
+ return mockOrgUnitName
+ },
+ getRenderTypes(): Array> {
+ return ['OrgUnit', Item, DSpaceObject];
+ }
+ });
+
+ mockDSOName = 'Lorem Ipsum';
+ mockDSO = Object.assign(new DSpaceObject(), {
+ firstMetadataValue(keyOrKeys: string | string[], valueFilter?: MetadataValueFilter): string {
+ return mockDSOName
+ },
+ getRenderTypes(): Array> {
+ return [DSpaceObject];
+ }
+ });
+
+ service = new DSONameService();
+ });
+
+ describe(`getName`, () => {
+ it(`should use the Person factory for Person entities`, () => {
+ spyOn((service as any).factories, 'Person').and.returnValue('Bingo!');
+
+ const result = service.getName(mockPerson);
+
+ expect((service as any).factories.Person).toHaveBeenCalledWith(mockPerson);
+ expect(result).toBe('Bingo!');
+ });
+
+ it(`should use the OrgUnit factory for OrgUnit entities`, () => {
+ spyOn((service as any).factories, 'OrgUnit').and.returnValue('Bingo!');
+
+ const result = service.getName(mockOrgUnit);
+
+ expect((service as any).factories.OrgUnit).toHaveBeenCalledWith(mockOrgUnit);
+ expect(result).toBe('Bingo!');
+ });
+
+ it(`should use the Default factory for regular DSpaceObjects`, () => {
+ spyOn((service as any).factories, 'Default').and.returnValue('Bingo!');
+
+ const result = service.getName(mockDSO);
+
+ expect((service as any).factories.Default).toHaveBeenCalledWith(mockDSO);
+ expect(result).toBe('Bingo!');
+ });
+ });
+
+ describe(`factories.Person`, () => {
+ beforeEach(() => {
+ spyOn(mockPerson, 'firstMetadataValue').and.returnValues(...mockPersonName.split(', '));
+ });
+
+ it(`should return 'person.familyName, person.givenName'`, () => {
+ const result = (service as any).factories.Person(mockPerson);
+ expect(result).toBe(mockPersonName);
+ expect(mockPerson.firstMetadataValue).toHaveBeenCalledWith('person.familyName');
+ expect(mockPerson.firstMetadataValue).toHaveBeenCalledWith('person.givenName');
+ });
+ });
+
+ describe(`factories.OrgUnit`, () => {
+ beforeEach(() => {
+ spyOn(mockOrgUnit, 'firstMetadataValue').and.callThrough();
+ });
+
+ it(`should return 'organization.legalName'`, () => {
+ const result = (service as any).factories.OrgUnit(mockOrgUnit);
+ expect(result).toBe(mockOrgUnitName);
+ expect(mockOrgUnit.firstMetadataValue).toHaveBeenCalledWith('organization.legalName');
+ });
+ });
+
+ describe(`factories.Default`, () => {
+ beforeEach(() => {
+ spyOn(mockDSO, 'firstMetadataValue').and.callThrough();
+ });
+
+ it(`should return 'dc.title'`, () => {
+ const result = (service as any).factories.Default(mockDSO);
+ expect(result).toBe(mockDSOName);
+ expect(mockDSO.firstMetadataValue).toHaveBeenCalledWith('dc.title');
+ });
+ });
+});
diff --git a/src/app/core/breadcrumbs/dso-name.service.ts b/src/app/core/breadcrumbs/dso-name.service.ts
new file mode 100644
index 0000000000..161c4f7254
--- /dev/null
+++ b/src/app/core/breadcrumbs/dso-name.service.ts
@@ -0,0 +1,53 @@
+import { Injectable } from '@angular/core';
+import { hasValue } from '../../shared/empty.util';
+import { DSpaceObject } from '../shared/dspace-object.model';
+
+/**
+ * Returns a name for a {@link DSpaceObject} based
+ * on its render types.
+ */
+@Injectable({
+ providedIn: 'root'
+})
+export class DSONameService {
+
+ /**
+ * Functions to generate the specific names.
+ *
+ * If this list ever expands it will probably be worth it to
+ * refactor this using decorators for specific entity types,
+ * or perhaps by using a dedicated model for each entity type
+ *
+ * With only two exceptions those solutions seem overkill for now.
+ */
+ private factories = {
+ Person: (dso: DSpaceObject): string => {
+ return `${dso.firstMetadataValue('person.familyName')}, ${dso.firstMetadataValue('person.givenName')}`;
+ },
+ OrgUnit: (dso: DSpaceObject): string => {
+ return dso.firstMetadataValue('organization.legalName');
+ },
+ Default: (dso: DSpaceObject): string => {
+ return dso.firstMetadataValue('dc.title');
+ }
+ };
+
+ /**
+ * Get the name for the given {@link DSpaceObject}
+ *
+ * @param dso The {@link DSpaceObject} you want a name for
+ */
+ getName(dso: DSpaceObject): string {
+ const types = dso.getRenderTypes();
+ const match = types
+ .filter((type) => typeof type === 'string')
+ .find((type: string) => Object.keys(this.factories).includes(type)) as string;
+
+ if (hasValue(match)) {
+ return this.factories[match](dso);
+ } else {
+ return this.factories.Default(dso);
+ }
+ }
+
+}
diff --git a/src/app/core/breadcrumbs/i18n-breadcrumb.resolver.spec.ts b/src/app/core/breadcrumbs/i18n-breadcrumb.resolver.spec.ts
new file mode 100644
index 0000000000..d34d6d8a9b
--- /dev/null
+++ b/src/app/core/breadcrumbs/i18n-breadcrumb.resolver.spec.ts
@@ -0,0 +1,28 @@
+import { I18nBreadcrumbResolver } from './i18n-breadcrumb.resolver';
+
+describe('I18nBreadcrumbResolver', () => {
+ describe('resolve', () => {
+ let resolver: I18nBreadcrumbResolver;
+ let i18nBreadcrumbService: any;
+ let i18nKey: string;
+ let path: string;
+ beforeEach(() => {
+ i18nKey = 'example.key';
+ path = 'rest.com/path/to/breadcrumb';
+ i18nBreadcrumbService = {};
+ resolver = new I18nBreadcrumbResolver(i18nBreadcrumbService);
+ });
+
+ it('should resolve the breadcrumb config', () => {
+ const resolvedConfig = resolver.resolve({ data: { breadcrumbKey: i18nKey }, url: [path] } as any, {} as any);
+ const expectedConfig = { provider: i18nBreadcrumbService, key: i18nKey, url: path };
+ expect(resolvedConfig).toEqual(expectedConfig);
+ });
+
+ it('should resolve throw an error when no breadcrumbKey is defined', () => {
+ expect(() => {
+ resolver.resolve({ data: {} } as any, undefined)
+ }).toThrow();
+ });
+ });
+});
diff --git a/src/app/core/breadcrumbs/i18n-breadcrumb.resolver.ts b/src/app/core/breadcrumbs/i18n-breadcrumb.resolver.ts
new file mode 100644
index 0000000000..de7d061a3f
--- /dev/null
+++ b/src/app/core/breadcrumbs/i18n-breadcrumb.resolver.ts
@@ -0,0 +1,29 @@
+import { BreadcrumbConfig } from '../../breadcrumbs/breadcrumb/breadcrumb-config.model';
+import { Injectable } from '@angular/core';
+import { ActivatedRouteSnapshot, Resolve, RouterStateSnapshot } from '@angular/router';
+import { I18nBreadcrumbsService } from './i18n-breadcrumbs.service';
+import { hasNoValue } from '../../shared/empty.util';
+
+/**
+ * The class that resolves a BreadcrumbConfig object with an i18n key string for a route
+ */
+@Injectable()
+export class I18nBreadcrumbResolver implements Resolve> {
+ constructor(protected breadcrumbService: I18nBreadcrumbsService) {
+ }
+
+ /**
+ * Method for resolving an I18n breadcrumb configuration object
+ * @param {ActivatedRouteSnapshot} route The current ActivatedRouteSnapshot
+ * @param {RouterStateSnapshot} state The current RouterStateSnapshot
+ * @returns BreadcrumbConfig object
+ */
+ resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): BreadcrumbConfig {
+ const key = route.data.breadcrumbKey;
+ if (hasNoValue(key)) {
+ throw new Error('You provided an i18nBreadcrumbResolver for url \"' + route.url + '\" but no breadcrumbKey in the route\'s data')
+ }
+ const fullPath = route.url.join('');
+ return { provider: this.breadcrumbService, key: key, url: fullPath };
+ }
+}
diff --git a/src/app/core/breadcrumbs/i18n-breadcrumbs.service.spec.ts b/src/app/core/breadcrumbs/i18n-breadcrumbs.service.spec.ts
new file mode 100644
index 0000000000..274389db3b
--- /dev/null
+++ b/src/app/core/breadcrumbs/i18n-breadcrumbs.service.spec.ts
@@ -0,0 +1,31 @@
+import { async, TestBed } from '@angular/core/testing';
+import { Breadcrumb } from '../../breadcrumbs/breadcrumb/breadcrumb.model';
+import { getTestScheduler } from 'jasmine-marbles';
+import { BREADCRUMB_MESSAGE_POSTFIX, I18nBreadcrumbsService } from './i18n-breadcrumbs.service';
+
+describe('I18nBreadcrumbsService', () => {
+ let service: I18nBreadcrumbsService;
+ let exampleString;
+ let exampleURL;
+
+ function init() {
+ exampleString = 'example.string';
+ exampleURL = 'example.com';
+ }
+
+ beforeEach(async(() => {
+ init();
+ TestBed.configureTestingModule({}).compileComponents();
+ }));
+
+ beforeEach(() => {
+ service = new I18nBreadcrumbsService();
+ });
+
+ describe('getBreadcrumbs', () => {
+ it('should return a breadcrumb based on a string by adding the postfix', () => {
+ const breadcrumbs = service.getBreadcrumbs(exampleString, exampleURL);
+ getTestScheduler().expectObservable(breadcrumbs).toBe('(a|)', { a: [new Breadcrumb(exampleString + BREADCRUMB_MESSAGE_POSTFIX, exampleURL)] });
+ })
+ });
+});
diff --git a/src/app/core/breadcrumbs/i18n-breadcrumbs.service.ts b/src/app/core/breadcrumbs/i18n-breadcrumbs.service.ts
new file mode 100644
index 0000000000..e07d9ed541
--- /dev/null
+++ b/src/app/core/breadcrumbs/i18n-breadcrumbs.service.ts
@@ -0,0 +1,25 @@
+import { Breadcrumb } from '../../breadcrumbs/breadcrumb/breadcrumb.model';
+import { BreadcrumbsService } from './breadcrumbs.service';
+import { Observable, of as observableOf } from 'rxjs';
+import { Injectable } from '@angular/core';
+
+/**
+ * The postfix for i18n breadcrumbs
+ */
+export const BREADCRUMB_MESSAGE_POSTFIX = '.breadcrumbs';
+
+/**
+ * Service to calculate i18n breadcrumbs for a single part of the route
+ */
+@Injectable()
+export class I18nBreadcrumbsService implements BreadcrumbsService {
+
+ /**
+ * Method to calculate the breadcrumbs
+ * @param key The key used to resolve the breadcrumb
+ * @param url The url to use as a link for this breadcrumb
+ */
+ getBreadcrumbs(key: string, url: string): Observable {
+ return observableOf([new Breadcrumb(key + BREADCRUMB_MESSAGE_POSTFIX, url)]);
+ }
+}
diff --git a/src/app/core/breadcrumbs/item-breadcrumb.resolver.ts b/src/app/core/breadcrumbs/item-breadcrumb.resolver.ts
new file mode 100644
index 0000000000..8390c0e001
--- /dev/null
+++ b/src/app/core/breadcrumbs/item-breadcrumb.resolver.ts
@@ -0,0 +1,32 @@
+import { Injectable } from '@angular/core';
+import { DSOBreadcrumbsService } from './dso-breadcrumbs.service';
+import { ItemDataService } from '../data/item-data.service';
+import { Item } from '../shared/item.model';
+import { DSOBreadcrumbResolver } from './dso-breadcrumb.resolver';
+import { followLink, FollowLinkConfig } from '../../shared/utils/follow-link-config.model';
+
+/**
+ * The class that resolves the BreadcrumbConfig object for an Item
+ */
+@Injectable()
+export class ItemBreadcrumbResolver extends DSOBreadcrumbResolver- {
+ constructor(protected breadcrumbService: DSOBreadcrumbsService, protected dataService: ItemDataService) {
+ super(breadcrumbService, dataService);
+ }
+
+ /**
+ * Method that returns the follow links to already resolve
+ * The self links defined in this list are expected to be requested somewhere in the near future
+ * Requesting them as embeds will limit the number of requests
+ */
+ get followLinks(): Array
> {
+ return [
+ followLink('owningCollection', undefined,
+ followLink('parentCommunity', undefined,
+ followLink('parentCommunity'))
+ ),
+ followLink('bundles'),
+ followLink('relationships')
+ ];
+ }
+}
diff --git a/src/app/core/browse/browse.service.spec.ts b/src/app/core/browse/browse.service.spec.ts
index 55ff7a090e..6dafa4cf0a 100644
--- a/src/app/core/browse/browse.service.spec.ts
+++ b/src/app/core/browse/browse.service.spec.ts
@@ -1,16 +1,16 @@
import { cold, getTestScheduler, hot } from 'jasmine-marbles';
+import { of as observableOf } from 'rxjs';
import { TestScheduler } from 'rxjs/testing';
import { getMockRemoteDataBuildService } from '../../shared/mocks/mock-remote-data-build.service';
import { getMockRequestService } from '../../shared/mocks/mock-request.service';
import { HALEndpointServiceStub } from '../../shared/testing/hal-endpoint-service-stub';
import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
import { BrowseEndpointRequest, BrowseEntriesRequest, BrowseItemsRequest } from '../data/request.models';
+import { RequestEntry } from '../data/request.reducer';
import { RequestService } from '../data/request.service';
import { BrowseDefinition } from '../shared/browse-definition.model';
-import { BrowseService } from './browse.service';
import { BrowseEntrySearchOptions } from './browse-entry-search-options.model';
-import { RequestEntry } from '../data/request.reducer';
-import { of as observableOf } from 'rxjs';
+import { BrowseService } from './browse.service';
describe('BrowseService', () => {
let scheduler: TestScheduler;
@@ -44,8 +44,8 @@ describe('BrowseService', () => {
'dc.date.issued'
],
_links: {
- self: 'https://rest.api/discover/browses/dateissued',
- items: 'https://rest.api/discover/browses/dateissued/items'
+ self: { href: 'https://rest.api/discover/browses/dateissued' },
+ items: { href: 'https://rest.api/discover/browses/dateissued/items' }
}
}),
Object.assign(new BrowseDefinition(), {
@@ -72,9 +72,9 @@ describe('BrowseService', () => {
'dc.creator'
],
_links: {
- self: 'https://rest.api/discover/browses/author',
- entries: 'https://rest.api/discover/browses/author/entries',
- items: 'https://rest.api/discover/browses/author/items'
+ self: { href: 'https://rest.api/discover/browses/author' },
+ entries: { href: 'https://rest.api/discover/browses/author/entries' },
+ items: { href: 'https://rest.api/discover/browses/author/items' }
}
})
];
@@ -125,9 +125,11 @@ describe('BrowseService', () => {
});
it('should return a RemoteData object containing the correct BrowseDefinition[]', () => {
- const expected = cold('--a-', { a: {
- payload: browseDefinitions
- }});
+ const expected = cold('--a-', {
+ a: {
+ payload: browseDefinitions
+ }
+ });
expect(service.getBrowseDefinitions()).toBeObservable(expected);
});
@@ -142,15 +144,17 @@ describe('BrowseService', () => {
rdbService = getMockRemoteDataBuildService();
service = initTestService();
spyOn(service, 'getBrowseDefinitions').and
- .returnValue(hot('--a-', { a: {
+ .returnValue(hot('--a-', {
+ a: {
payload: browseDefinitions
- }}));
+ }
+ }));
spyOn(rdbService, 'toRemoteDataObservable').and.callThrough();
});
describe('when getBrowseEntriesFor is called with a valid browse definition id', () => {
it('should configure a new BrowseEntriesRequest', () => {
- const expected = new BrowseEntriesRequest(requestService.generateRequestId(), browseDefinitions[1]._links.entries);
+ const expected = new BrowseEntriesRequest(requestService.generateRequestId(), browseDefinitions[1]._links.entries.href);
scheduler.schedule(() => service.getBrowseEntriesFor(new BrowseEntrySearchOptions(browseDefinitions[1].id)).subscribe());
scheduler.flush();
@@ -169,7 +173,7 @@ describe('BrowseService', () => {
describe('when getBrowseItemsFor is called with a valid browse definition id', () => {
it('should configure a new BrowseItemsRequest', () => {
- const expected = new BrowseItemsRequest(requestService.generateRequestId(), browseDefinitions[1]._links.items + '?filterValue=' + mockAuthorName);
+ const expected = new BrowseItemsRequest(requestService.generateRequestId(), browseDefinitions[1]._links.items.href + '?filterValue=' + mockAuthorName);
scheduler.schedule(() => service.getBrowseItemsFor(mockAuthorName, new BrowseEntrySearchOptions(browseDefinitions[1].id)).subscribe());
scheduler.flush();
@@ -215,9 +219,11 @@ describe('BrowseService', () => {
rdbService = getMockRemoteDataBuildService();
service = initTestService();
spyOn(service, 'getBrowseDefinitions').and
- .returnValue(hot('--a-', { a: {
+ .returnValue(hot('--a-', {
+ a: {
payload: browseDefinitions
- }}));
+ }
+ }));
});
it('should return the URL for the given metadataKey and linkPath', () => {
@@ -288,14 +294,16 @@ describe('BrowseService', () => {
rdbService = getMockRemoteDataBuildService();
service = initTestService();
spyOn(service, 'getBrowseDefinitions').and
- .returnValue(hot('--a-', { a: {
+ .returnValue(hot('--a-', {
+ a: {
payload: browseDefinitions
- }}));
+ }
+ }));
spyOn(rdbService, 'toRemoteDataObservable').and.callThrough();
});
describe('when getFirstItemFor is called with a valid browse definition id', () => {
- const expectedURL = browseDefinitions[1]._links.items + '?page=0&size=1';
+ const expectedURL = browseDefinitions[1]._links.items.href + '?page=0&size=1';
it('should configure a new BrowseItemsRequest', () => {
const expected = new BrowseItemsRequest(requestService.generateRequestId(), expectedURL);
diff --git a/src/app/core/browse/browse.service.ts b/src/app/core/browse/browse.service.ts
index eb494d7bdb..78e63e8540 100644
--- a/src/app/core/browse/browse.service.ts
+++ b/src/app/core/browse/browse.service.ts
@@ -10,18 +10,16 @@ import {
isNotEmptyOperator
} from '../../shared/empty.util';
import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
+import { GenericSuccessResponse } from '../cache/response.models';
import { PaginatedList } from '../data/paginated-list';
import { RemoteData } from '../data/remote-data';
-import {
- BrowseEndpointRequest,
- BrowseEntriesRequest,
- BrowseItemsRequest,
- RestRequest
-} from '../data/request.models';
+import { BrowseEndpointRequest, BrowseEntriesRequest, BrowseItemsRequest, RestRequest } from '../data/request.models';
import { RequestService } from '../data/request.service';
import { BrowseDefinition } from '../shared/browse-definition.model';
import { BrowseEntry } from '../shared/browse-entry.model';
+import { DSpaceObject } from '../shared/dspace-object.model';
import { HALEndpointService } from '../shared/hal-endpoint.service';
+import { Item } from '../shared/item.model';
import {
configureRequest,
filterSuccessfulResponses,
@@ -31,10 +29,7 @@ import {
getRequestFromRequestHref
} from '../shared/operators';
import { URLCombiner } from '../url-combiner/url-combiner';
-import { Item } from '../shared/item.model';
-import { DSpaceObject } from '../shared/dspace-object.model';
import { BrowseEntrySearchOptions } from './browse-entry-search-options.model';
-import { GenericSuccessResponse } from '../cache/response.models';
/**
* The service handling all browse requests
@@ -81,10 +76,11 @@ export class BrowseService {
map((response: GenericSuccessResponse) => response.payload),
ensureArrayHasValue(),
map((definitions: BrowseDefinition[]) => definitions
- .map((definition: BrowseDefinition) => Object.assign(new BrowseDefinition(), definition))),
- distinctUntilChanged()
+ .map((definition: BrowseDefinition) => {
+ return Object.assign(new BrowseDefinition(), definition)
+ })),
+ distinctUntilChanged(),
);
-
return this.rdb.toRemoteDataObservable(requestEntry$, payload$);
}
@@ -96,7 +92,10 @@ export class BrowseService {
return this.getBrowseDefinitions().pipe(
getBrowseDefinitionLinks(options.metadataDefinition),
hasValueOperator(),
- map((_links: any) => _links.entries),
+ map((_links: any) => {
+ const entriesLink = _links.entries.href || _links.entries;
+ return entriesLink;
+ }),
hasValueOperator(),
map((href: string) => {
// TODO nearly identical to PaginatedSearchOptions => refactor
@@ -133,7 +132,10 @@ export class BrowseService {
return this.getBrowseDefinitions().pipe(
getBrowseDefinitionLinks(options.metadataDefinition),
hasValueOperator(),
- map((_links: any) => _links.items),
+ map((_links: any) => {
+ const itemsLink = _links.items.href || _links.items;
+ return itemsLink;
+ }),
hasValueOperator(),
map((href: string) => {
const args = [];
@@ -171,7 +173,10 @@ export class BrowseService {
return this.getBrowseDefinitions().pipe(
getBrowseDefinitionLinks(definition),
hasValueOperator(),
- map((_links: any) => _links.items),
+ map((_links: any) => {
+ const itemsLink = _links.items.href || _links.items;
+ return itemsLink;
+ }),
hasValueOperator(),
map((href: string) => {
const args = [];
@@ -249,7 +254,7 @@ export class BrowseService {
if (isEmpty(def) || isEmpty(def._links) || isEmpty(def._links[linkPath])) {
throw new Error(`A browse endpoint for ${linkPath} on ${metadataKey} isn't configured`);
} else {
- return def._links[linkPath];
+ return def._links[linkPath] || def._links[linkPath].href;
}
}),
startWith(undefined),
diff --git a/src/app/core/cache/builders/build-decorators.spec.ts b/src/app/core/cache/builders/build-decorators.spec.ts
new file mode 100644
index 0000000000..e47cf1a80a
--- /dev/null
+++ b/src/app/core/cache/builders/build-decorators.spec.ts
@@ -0,0 +1,83 @@
+import { HALLink } from '../../shared/hal-link.model';
+import { HALResource } from '../../shared/hal-resource.model';
+import { ResourceType } from '../../shared/resource-type';
+import {
+ dataService,
+ getDataServiceFor,
+ getLinkDefinition,
+ link,
+} from './build-decorators';
+
+/* tslint:disable:max-classes-per-file */
+class TestService {}
+class AnotherTestService {}
+class TestHALResource implements HALResource {
+ _links: {
+ self: HALLink;
+ foo: HALLink;
+ };
+
+ bar?: any
+}
+let testType;
+
+describe('build decorators', () => {
+ beforeEach(() => {
+ testType = new ResourceType('testType-' + new Date().getTime());
+ });
+ describe('@dataService/getDataServiceFor', () => {
+
+ it('should register a resourcetype for a dataservice', () => {
+ dataService(testType)(TestService);
+ expect(getDataServiceFor(testType)).toBe(TestService);
+ });
+
+ describe(`when the resource type isn't specified`, () => {
+ it(`should throw an error`, () => {
+ expect(() => {
+ dataService(undefined)(TestService);
+ }).toThrow();
+ });
+ });
+
+ describe(`when there already is a registered dataservice for a resourcetype`, () => {
+ it(`should throw an error`, () => {
+ dataService(testType)(TestService);
+ expect(() => {
+ dataService(testType)(AnotherTestService);
+ }).toThrow();
+ });
+ });
+
+ });
+
+ describe(`@link/getLinkDefinitions`, () => {
+ it(`should register a link`, () => {
+ const target = new TestHALResource();
+ link(testType, true, 'foo')(target, 'bar');
+ const result = getLinkDefinition(TestHALResource, 'foo');
+ expect(result.resourceType).toBe(testType);
+ expect(result.isList).toBe(true);
+ expect(result.linkName).toBe('foo');
+ expect(result.propertyName).toBe('bar');
+ });
+
+ describe(`when the linkname isn't specified`, () => {
+ it(`should use the propertyname`, () => {
+ const target = new TestHALResource();
+ link(testType)(target, 'foo');
+ const result = getLinkDefinition(TestHALResource, 'foo');
+ expect(result.linkName).toBe('foo');
+ expect(result.propertyName).toBe('foo');
+ });
+ });
+
+ describe(`when there's no @link`, () => {
+ it(`should return undefined`, () => {
+ const result = getLinkDefinition(TestHALResource, 'self');
+ expect(result).toBeUndefined();
+ });
+ });
+ });
+});
+/* tslint:enable:max-classes-per-file */
diff --git a/src/app/core/cache/builders/build-decorators.ts b/src/app/core/cache/builders/build-decorators.ts
index 0bfb5f0321..4ba04bfa55 100644
--- a/src/app/core/cache/builders/build-decorators.ts
+++ b/src/app/core/cache/builders/build-decorators.ts
@@ -1,80 +1,161 @@
import 'reflect-metadata';
+import { hasNoValue, hasValue } from '../../../shared/empty.util';
+import { DataService } from '../../data/data.service';
import { GenericConstructor } from '../../shared/generic-constructor';
-import { CacheableObject, TypedObject } from '../object-cache.reducer';
+import { HALResource } from '../../shared/hal-resource.model';
import { ResourceType } from '../../shared/resource-type';
+import { CacheableObject, TypedObject } from '../object-cache.reducer';
-const mapsToMetadataKey = Symbol('mapsTo');
-const relationshipKey = Symbol('relationship');
+const resolvedLinkKey = Symbol('resolvedLink');
-const relationshipMap = new Map();
+const resolvedLinkMap = new Map();
const typeMap = new Map();
+const dataServiceMap = new Map();
+const linkMap = new Map();
/**
- * Decorator function to map a normalized class to it's not-normalized counter part class
- * It will also maps a type to the matching class
- * @param value The not-normalized class to map to
+ * Decorator function to map a ResourceType to its class
+ * @param target The contructor of the typed class to map
*/
-export function mapsTo(value: GenericConstructor) {
- return function decorator(objectConstructor: GenericConstructor) {
- Reflect.defineMetadata(mapsToMetadataKey, value, objectConstructor);
- mapsToType((value as any).type, objectConstructor);
- }
-}
-
-/**
- * Maps a type to the matching class
- * @param value The resourse type
- * @param objectConstructor The class to map to
- */
-function mapsToType(value: ResourceType, objectConstructor: GenericConstructor) {
- if (!objectConstructor || !value) {
- return;
- }
- typeMap.set(value.value, objectConstructor);
-}
-
-/**
- * Returns the mapped class for the given normalized class
- * @param target The normalized class
- */
-export function getMapsTo(target: any) {
- return Reflect.getOwnMetadata(mapsToMetadataKey, target);
+export function typedObject(target: typeof TypedObject) {
+ typeMap.set(target.type.value, target);
}
/**
* Returns the mapped class for the given type
* @param type The resource type
*/
-export function getMapsToType(type: string | ResourceType) {
+export function getClassForType(type: string | ResourceType) {
if (typeof(type) === 'object') {
type = (type as ResourceType).value;
}
return typeMap.get(type);
}
-export function relationship(value: GenericConstructor, isList: boolean = false): any {
- return function r(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
- if (!target || !propertyKey) {
- return;
+/**
+ * A class decorator to indicate that this class is a dataservice
+ * for a given resource type.
+ *
+ * "dataservice" in this context means that it has findByHref and
+ * findAllByHref methods.
+ *
+ * @param resourceType the resource type the class is a dataservice for
+ */
+export function dataService(resourceType: ResourceType): any {
+ return (target: any) => {
+ if (hasNoValue(resourceType)) {
+ throw new Error(`Invalid @dataService annotation on ${target}, resourceType needs to be defined`);
+ }
+ const existingDataservice = dataServiceMap.get(resourceType.value);
+
+ if (hasValue(existingDataservice)) {
+ throw new Error(`Multiple dataservices for ${resourceType.value}: ${existingDataservice} and ${target}`);
}
- const metaDataList: string[] = relationshipMap.get(target.constructor) || [];
- if (metaDataList.indexOf(propertyKey) === -1) {
- metaDataList.push(propertyKey);
- }
- relationshipMap.set(target.constructor, metaDataList);
- return Reflect.metadata(relationshipKey, {
- resourceType: (value as any).type.value,
- isList
- }).apply(this, arguments);
+ dataServiceMap.set(resourceType.value, target);
};
}
-export function getRelationMetadata(target: any, propertyKey: string) {
- return Reflect.getMetadata(relationshipKey, target, propertyKey);
+/**
+ * Return the dataservice matching the given resource type
+ *
+ * @param resourceType the resource type you want the matching dataservice for
+ */
+export function getDataServiceFor(resourceType: ResourceType) {
+ return dataServiceMap.get(resourceType.value);
}
-export function getRelationships(target: any) {
- return relationshipMap.get(target);
+/**
+ * A class to represent the data that can be set by the @link decorator
+ */
+export class LinkDefinition {
+ resourceType: ResourceType;
+ isList = false;
+ linkName: keyof T['_links'];
+ propertyName: keyof T;
+}
+
+/**
+ * A property decorator to indicate that a certain property is the placeholder
+ * where the contents of a resolved link should be stored.
+ *
+ * e.g. if an Item has an hal link for bundles, and an item.bundles property
+ * this decorator should decorate that item.bundles property.
+ *
+ * @param resourceType the resource type of the object(s) the link retrieves
+ * @param isList an optional boolean indicating whether or not it concerns a list,
+ * defaults to false
+ * @param linkName an optional string in case the {@link HALLink} name differs from the
+ * property name
+ */
+export const link = (
+ resourceType: ResourceType,
+ isList = false,
+ linkName?: keyof T['_links'],
+ ) => {
+ return (target: T, propertyName: string) => {
+ let targetMap = linkMap.get(target.constructor);
+
+ if (hasNoValue(targetMap)) {
+ targetMap = new Map>();
+ }
+
+ if (hasNoValue(linkName)) {
+ linkName = propertyName as any;
+ }
+
+ targetMap.set(linkName, {
+ resourceType,
+ isList,
+ linkName,
+ propertyName
+ });
+
+ linkMap.set(target.constructor, targetMap);
+ }
+};
+
+/**
+ * Returns all LinkDefinitions for a model class
+ * @param source
+ */
+export const getLinkDefinitions = (source: GenericConstructor): Map> => {
+ return linkMap.get(source);
+};
+
+/**
+ * Returns a specific LinkDefinition for a model class
+ *
+ * @param source the model class
+ * @param linkName the name of the link
+ */
+export const getLinkDefinition = (source: GenericConstructor, linkName: keyof T['_links']): LinkDefinition => {
+ const sourceMap = linkMap.get(source);
+ if (hasValue(sourceMap)) {
+ return sourceMap.get(linkName);
+ } else {
+ return undefined;
+ }
+};
+
+/**
+ * A class level decorator to indicate you want to inherit @link annotations
+ * from a parent class.
+ *
+ * @param parent the parent class to inherit @link annotations from
+ */
+export function inheritLinkAnnotations(parent: any): any {
+ return (child: any) => {
+ const parentMap: Map> = linkMap.get(parent) || new Map();
+ const childMap: Map> = linkMap.get(child) || new Map();
+
+ parentMap.forEach((value, key) => {
+ if (!childMap.has(key)) {
+ childMap.set(key, value);
+ }
+ });
+
+ linkMap.set(child, childMap);
+ }
}
diff --git a/src/app/core/cache/builders/link.service.spec.ts b/src/app/core/cache/builders/link.service.spec.ts
new file mode 100644
index 0000000000..dbd65eefb5
--- /dev/null
+++ b/src/app/core/cache/builders/link.service.spec.ts
@@ -0,0 +1,269 @@
+import { Injectable } from '@angular/core';
+import { TestBed } from '@angular/core/testing';
+import { followLink, FollowLinkConfig } from '../../../shared/utils/follow-link-config.model';
+import { FindListOptions } from '../../data/request.models';
+import { HALLink } from '../../shared/hal-link.model';
+import { HALResource } from '../../shared/hal-resource.model';
+import { ResourceType } from '../../shared/resource-type';
+import * as decorators from './build-decorators';
+import { getDataServiceFor } from './build-decorators';
+import { LinkService } from './link.service';
+
+const spyOnFunction = (obj: T, func: keyof T) => {
+ const spy = jasmine.createSpy(func as string);
+ spyOnProperty(obj, func, 'get').and.returnValue(spy);
+
+ return spy;
+};
+
+const TEST_MODEL = new ResourceType('testmodel');
+let result: any;
+
+/* tslint:disable:max-classes-per-file */
+class TestModel implements HALResource {
+ static type = TEST_MODEL;
+
+ type = TEST_MODEL;
+
+ value: string;
+
+ _links: {
+ self: HALLink;
+ predecessor: HALLink;
+ successor: HALLink;
+ };
+
+ predecessor?: TestModel;
+ successor?: TestModel;
+}
+
+@Injectable()
+class TestDataService {
+ findAllByHref(href: string, findListOptions: FindListOptions = {}, ...linksToFollow: Array>) {
+ return 'findAllByHref'
+ }
+ findByHref(href: string, ...linksToFollow: Array>) {
+ return 'findByHref'
+ }
+}
+
+let testDataService: TestDataService;
+
+let testModel: TestModel;
+
+describe('LinkService', () => {
+ let service: LinkService;
+
+ beforeEach(() => {
+ testModel = Object.assign(new TestModel(), {
+ value: 'a test value',
+ _links: {
+ self: {
+ href: 'http://self.link'
+ },
+ predecessor: {
+ href: 'http://predecessor.link'
+ },
+ successor: {
+ href: 'http://successor.link'
+ },
+ }
+ });
+ testDataService = new TestDataService();
+ spyOn(testDataService, 'findAllByHref').and.callThrough();
+ spyOn(testDataService, 'findByHref').and.callThrough();
+ TestBed.configureTestingModule({
+ providers: [LinkService, {
+ provide: TestDataService,
+ useValue: testDataService
+ }]
+ });
+ service = TestBed.get(LinkService);
+ });
+
+ describe('resolveLink', () => {
+ describe(`when the linkdefinition concerns a single object`, () => {
+ beforeEach(() => {
+ spyOnFunction(decorators, 'getLinkDefinition').and.returnValue({
+ resourceType: TEST_MODEL,
+ linkName: 'predecessor',
+ propertyName: 'predecessor'
+ });
+ spyOnFunction(decorators, 'getDataServiceFor').and.returnValue(TestDataService);
+ service.resolveLink(testModel, followLink('predecessor', {}, followLink('successor')))
+ });
+ it('should call dataservice.findByHref with the correct href and nested links', () => {
+ expect(testDataService.findByHref).toHaveBeenCalledWith(testModel._links.predecessor.href, followLink('successor'));
+ });
+ });
+ describe(`when the linkdefinition concerns a list`, () => {
+ beforeEach(() => {
+ spyOnFunction(decorators, 'getLinkDefinition').and.returnValue({
+ resourceType: TEST_MODEL,
+ linkName: 'predecessor',
+ propertyName: 'predecessor',
+ isList: true
+ });
+ spyOnFunction(decorators, 'getDataServiceFor').and.returnValue(TestDataService);
+ service.resolveLink(testModel, followLink('predecessor', { some: 'options '} as any, followLink('successor')))
+ });
+ it('should call dataservice.findAllByHref with the correct href, findListOptions, and nested links', () => {
+ expect(testDataService.findAllByHref).toHaveBeenCalledWith(testModel._links.predecessor.href, { some: 'options '} as any, followLink('successor'));
+ });
+ });
+ describe('either way', () => {
+ beforeEach(() => {
+ spyOnFunction(decorators, 'getLinkDefinition').and.returnValue({
+ resourceType: TEST_MODEL,
+ linkName: 'predecessor',
+ propertyName: 'predecessor'
+ });
+ spyOnFunction(decorators, 'getDataServiceFor').and.returnValue(TestDataService);
+ result = service.resolveLink(testModel, followLink('predecessor', {}, followLink('successor')))
+ });
+
+ it('should call getLinkDefinition with the correct model and link', () => {
+ expect(decorators.getLinkDefinition).toHaveBeenCalledWith(testModel.constructor as any, 'predecessor');
+ });
+
+ it('should call getDataServiceFor with the correct resource type', () => {
+ expect(decorators.getDataServiceFor).toHaveBeenCalledWith(TEST_MODEL);
+ });
+
+ it('should return the model with the resolved link', () => {
+ expect(result.type).toBe(TEST_MODEL);
+ expect(result.value).toBe('a test value');
+ expect(result._links.self.href).toBe('http://self.link');
+ expect(result.predecessor).toBe('findByHref');
+ });
+ });
+
+ describe(`when the specified link doesn't exist on the model's class`, () => {
+ beforeEach(() => {
+ spyOnFunction(decorators, 'getLinkDefinition').and.returnValue(undefined);
+ });
+ it('should throw an error', () => {
+ expect(() => {
+ service.resolveLink(testModel, followLink('predecessor', {}, followLink('successor')))
+ }).toThrow();
+ });
+ });
+
+ describe(`when there is no dataservice for the resourcetype in the link`, () => {
+ beforeEach(() => {
+ spyOnFunction(decorators, 'getLinkDefinition').and.returnValue({
+ resourceType: TEST_MODEL,
+ linkName: 'predecessor',
+ propertyName: 'predecessor'
+ });
+ spyOnFunction(decorators, 'getDataServiceFor').and.returnValue(undefined);
+ });
+ it('should throw an error', () => {
+ expect(() => {
+ service.resolveLink(testModel, followLink('predecessor', {}, followLink('successor')))
+ }).toThrow();
+ });
+ });
+ });
+
+ describe('resolveLinks', () => {
+ beforeEach(() => {
+ spyOn(service, 'resolveLink');
+ service.resolveLinks(testModel, followLink('predecessor'), followLink('successor'))
+ });
+
+ it('should call resolveLink with the model for each of the provided links', () => {
+ expect(service.resolveLink).toHaveBeenCalledWith(testModel, followLink('predecessor'));
+ expect(service.resolveLink).toHaveBeenCalledWith(testModel, followLink('successor'));
+ });
+
+ it('should return the model', () => {
+ expect(result.type).toBe(TEST_MODEL);
+ expect(result.value).toBe('a test value');
+ expect(result._links.self.href).toBe('http://self.link');
+ });
+ });
+
+ describe('removeResolvedLinks', () => {
+ beforeEach(() => {
+ testModel.predecessor = 'predecessor value' as any;
+ testModel.successor = 'successor value' as any;
+ spyOnFunction(decorators, 'getLinkDefinitions').and.returnValue([
+ {
+ resourceType: TEST_MODEL,
+ linkName: 'predecessor',
+ propertyName: 'predecessor',
+ },
+ {
+ resourceType: TEST_MODEL,
+ linkName: 'successor',
+ propertyName: 'successor',
+ }
+ ])
+ });
+
+ it('should return a new version of the object without any resolved links', () => {
+ result = service.removeResolvedLinks(testModel);
+ expect(result.value).toBe(testModel.value);
+ expect(result.type).toBe(testModel.type);
+ expect(result._links).toBe(testModel._links);
+ expect(result.predecessor).toBeUndefined();
+ expect(result.successor).toBeUndefined();
+ });
+
+ it('should leave the original object untouched', () => {
+ service.removeResolvedLinks(testModel);
+ expect(testModel.predecessor as any).toBe('predecessor value');
+ expect(testModel.successor as any).toBe('successor value');
+ });
+ });
+
+ describe('when a link is missing', () => {
+ beforeEach(() => {
+ testModel = Object.assign(new TestModel(), {
+ value: 'a test value',
+ _links: {
+ self: {
+ href: 'http://self.link'
+ },
+ predecessor: {
+ href: 'http://predecessor.link'
+ }
+ }
+ });
+ spyOnFunction(decorators, 'getDataServiceFor').and.returnValue(TestDataService);
+ });
+
+ describe('resolving the available link', () => {
+ beforeEach(() => {
+ spyOnFunction(decorators, 'getLinkDefinition').and.returnValue({
+ resourceType: TEST_MODEL,
+ linkName: 'predecessor',
+ propertyName: 'predecessor'
+ });
+ result = service.resolveLinks(testModel, followLink('predecessor'));
+ });
+
+ it('should return the model with the resolved link', () => {
+ expect(result.predecessor).toBe('findByHref');
+ });
+ });
+
+ describe('resolving the missing link', () => {
+ beforeEach(() => {
+ spyOnFunction(decorators, 'getLinkDefinition').and.returnValue({
+ resourceType: TEST_MODEL,
+ linkName: 'successor',
+ propertyName: 'successor'
+ });
+ result = service.resolveLinks(testModel, followLink('successor'));
+ });
+
+ it('should return the model with no resolved link', () => {
+ expect(result.successor).toBeUndefined();
+ });
+ });
+ });
+
+});
+/* tslint:enable:max-classes-per-file */
diff --git a/src/app/core/cache/builders/link.service.ts b/src/app/core/cache/builders/link.service.ts
new file mode 100644
index 0000000000..dc65eab68f
--- /dev/null
+++ b/src/app/core/cache/builders/link.service.ts
@@ -0,0 +1,93 @@
+import { Injectable, Injector } from '@angular/core';
+import { hasNoValue, hasValue, isNotEmpty } from '../../../shared/empty.util';
+import { FollowLinkConfig } from '../../../shared/utils/follow-link-config.model';
+import { GenericConstructor } from '../../shared/generic-constructor';
+import { HALResource } from '../../shared/hal-resource.model';
+import { getDataServiceFor, getLinkDefinition, getLinkDefinitions, LinkDefinition } from './build-decorators';
+
+/**
+ * A Service to handle the resolving and removing
+ * of resolved {@link HALLink}s on HALResources
+ */
+@Injectable({
+ providedIn: 'root'
+})
+export class LinkService {
+
+ constructor(
+ protected parentInjector: Injector,
+ ) {
+ }
+
+ /**
+ * Resolve the given {@link FollowLinkConfig}s for the given model
+ *
+ * @param model the {@link HALResource} to resolve the links for
+ * @param linksToFollow the {@link FollowLinkConfig}s to resolve
+ */
+ public resolveLinks(model: T, ...linksToFollow: Array>): T {
+ linksToFollow.forEach((linkToFollow: FollowLinkConfig) => {
+ this.resolveLink(model, linkToFollow);
+ });
+ return model;
+ }
+
+ /**
+ * Resolve the given {@link FollowLinkConfig} for the given model
+ *
+ * @param model the {@link HALResource} to resolve the link for
+ * @param linkToFollow the {@link FollowLinkConfig} to resolve
+ */
+ public resolveLink(model, linkToFollow: FollowLinkConfig): T {
+ const matchingLinkDef = getLinkDefinition(model.constructor, linkToFollow.name);
+
+ if (hasNoValue(matchingLinkDef)) {
+ throw new Error(`followLink('${linkToFollow.name}') was used for a ${model.constructor.name}, but there is no property on ${model.constructor.name} models with an @link() for ${linkToFollow.name}`);
+ } else {
+ const provider = getDataServiceFor(matchingLinkDef.resourceType);
+
+ if (hasNoValue(provider)) {
+ throw new Error(`The @link() for ${linkToFollow.name} on ${model.constructor.name} models uses the resource type ${matchingLinkDef.resourceType.value.toUpperCase()}, but there is no service with an @dataService(${matchingLinkDef.resourceType.value.toUpperCase()}) annotation in order to retrieve it`);
+ }
+
+ const service = Injector.create({
+ providers: [],
+ parent: this.parentInjector
+ }).get(provider);
+
+ const link = model._links[matchingLinkDef.linkName];
+ if (hasValue(link)) {
+ const href = link.href;
+
+ try {
+ if (matchingLinkDef.isList) {
+ model[linkToFollow.name] = service.findAllByHref(href, linkToFollow.findListOptions, ...linkToFollow.linksToFollow);
+ } else {
+ model[linkToFollow.name] = service.findByHref(href, ...linkToFollow.linksToFollow);
+ }
+ } catch (e) {
+ throw new Error(`Something went wrong when using @dataService(${matchingLinkDef.resourceType.value}) ${hasValue(service) ? '' : '(undefined) '}to resolve link ${linkToFollow.name} from ${href}`);
+ }
+ }
+ }
+ return model;
+ }
+
+ /**
+ * Remove any resolved links that the model may have.
+ *
+ * @param model the {@link HALResource} to remove the links from
+ * @returns a copy of the given model, without resolved links.
+ */
+ public removeResolvedLinks(model: T): T {
+ const result = Object.assign(new (model.constructor as GenericConstructor)(), model);
+ const linkDefs = getLinkDefinitions(model.constructor as GenericConstructor);
+ if (isNotEmpty(linkDefs)) {
+ linkDefs.forEach((linkDef: LinkDefinition) => {
+ result[linkDef.propertyName] = undefined;
+ });
+ }
+ return result;
+ }
+
+}
diff --git a/src/app/core/cache/builders/normalized-object-build.service.ts b/src/app/core/cache/builders/normalized-object-build.service.ts
deleted file mode 100644
index 69d7454d2d..0000000000
--- a/src/app/core/cache/builders/normalized-object-build.service.ts
+++ /dev/null
@@ -1,48 +0,0 @@
-import { Injectable } from '@angular/core';
-import { NormalizedObject } from '../models/normalized-object.model';
-import { getMapsToType, getRelationships } from './build-decorators';
-import { hasValue, isNotEmpty } from '../../../shared/empty.util';
-import { CacheableObject, TypedObject } from '../object-cache.reducer';
-
-/**
- * Return true if halObj has a value for `_links.self`
- *
- * @param {any} halObj The object to test
- */
-export function isRestDataObject(halObj: any): boolean {
- return isNotEmpty(halObj._links) && hasValue(halObj._links.self);
-}
-
-/**
- * Return true if halObj has a value for `page` and `_embedded`
- *
- * @param {any} halObj The object to test
- */
-export function isRestPaginatedList(halObj: any): boolean {
- return hasValue(halObj.page) && hasValue(halObj._embedded);
-}
-
-/**
- * A service to turn domain models in to their normalized
- * counterparts.
- */
-@Injectable()
-export class NormalizedObjectBuildService {
-
- /**
- * Returns the normalized model that corresponds to the given domain model
- *
- * @param {TDomain} domainModel a domain model
- */
- normalize(domainModel: T): NormalizedObject {
- const normalizedConstructor = getMapsToType((domainModel as any).type);
- const relationships = getRelationships(normalizedConstructor) || [];
- const normalizedModel = Object.assign({}, domainModel) as any;
- relationships.forEach((key: string) => {
- if (hasValue(normalizedModel[key])) {
- normalizedModel[key] = normalizedModel._links[key];
- }
- });
- return normalizedModel;
- }
-}
diff --git a/src/app/core/cache/builders/remote-data-build.service.spec.ts b/src/app/core/cache/builders/remote-data-build.service.spec.ts
index 2f0e024521..85267d7f4c 100644
--- a/src/app/core/cache/builders/remote-data-build.service.spec.ts
+++ b/src/app/core/cache/builders/remote-data-build.service.spec.ts
@@ -1,10 +1,10 @@
-import { RemoteDataBuildService } from './remote-data-build.service';
-import { Item } from '../../shared/item.model';
-import { PaginatedList } from '../../data/paginated-list';
-import { PageInfo } from '../../shared/page-info.model';
-import { RemoteData } from '../../data/remote-data';
import { of as observableOf } from 'rxjs';
import { createSuccessfulRemoteDataObject } from '../../../shared/testing/utils';
+import { PaginatedList } from '../../data/paginated-list';
+import { RemoteData } from '../../data/remote-data';
+import { Item } from '../../shared/item.model';
+import { PageInfo } from '../../shared/page-info.model';
+import { RemoteDataBuildService } from './remote-data-build.service';
const pageInfo = new PageInfo();
const array = [
@@ -37,7 +37,7 @@ describe('RemoteDataBuildService', () => {
let service: RemoteDataBuildService;
beforeEach(() => {
- service = new RemoteDataBuildService(undefined, undefined);
+ service = new RemoteDataBuildService(undefined, undefined, undefined);
});
describe('when toPaginatedList is called', () => {
diff --git a/src/app/core/cache/builders/remote-data-build.service.ts b/src/app/core/cache/builders/remote-data-build.service.ts
index 403a0273bc..df895e11a2 100644
--- a/src/app/core/cache/builders/remote-data-build.service.ts
+++ b/src/app/core/cache/builders/remote-data-build.service.ts
@@ -1,36 +1,46 @@
import { Injectable } from '@angular/core';
-
import { combineLatest as observableCombineLatest, Observable, of as observableOf, race as observableRace } from 'rxjs';
-import { distinctUntilChanged, flatMap, map, startWith, switchMap, tap } from 'rxjs/operators';
-
-import { hasValue, hasValueOperator, isEmpty, isNotEmpty, isNotUndefined } from '../../../shared/empty.util';
+import { distinctUntilChanged, map, startWith, switchMap } from 'rxjs/operators';
+import {
+ hasValue,
+ hasValueOperator,
+ isEmpty,
+ isNotEmpty,
+ isNotUndefined
+} from '../../../shared/empty.util';
+import { createSuccessfulRemoteDataObject$ } from '../../../shared/testing/utils';
+import { FollowLinkConfig } from '../../../shared/utils/follow-link-config.model';
import { PaginatedList } from '../../data/paginated-list';
import { RemoteData } from '../../data/remote-data';
import { RemoteDataError } from '../../data/remote-data-error';
-import { GetRequest } from '../../data/request.models';
import { RequestEntry } from '../../data/request.reducer';
import { RequestService } from '../../data/request.service';
-import { NormalizedObject } from '../models/normalized-object.model';
-import { ObjectCacheService } from '../object-cache.service';
-import { DSOSuccessResponse, ErrorResponse } from '../response.models';
-import { getMapsTo, getRelationMetadata, getRelationships } from './build-decorators';
-import { PageInfo } from '../../shared/page-info.model';
import {
filterSuccessfulResponses,
getRequestFromRequestHref,
getRequestFromRequestUUID,
getResourceLinksFromResponse
} from '../../shared/operators';
-import { CacheableObject, TypedObject } from '../object-cache.reducer';
-import { createSuccessfulRemoteDataObject$ } from '../../../shared/testing/utils';
+import { PageInfo } from '../../shared/page-info.model';
+import { CacheableObject } from '../object-cache.reducer';
+import { ObjectCacheService } from '../object-cache.service';
+import { DSOSuccessResponse, ErrorResponse } from '../response.models';
+import { LinkService } from './link.service';
@Injectable()
export class RemoteDataBuildService {
constructor(protected objectCache: ObjectCacheService,
+ protected linkService: LinkService,
protected requestService: RequestService) {
}
- buildSingle(href$: string | Observable): Observable> {
+ /**
+ * Creates a single {@link RemoteData} object based on the response of a request to the REST server, with a list of
+ * {@link FollowLinkConfig} that indicate which embedded info should be added to the object
+ * @param href$ Observable href of object we want to retrieve
+ * @param linksToFollow List of {@link FollowLinkConfig} that indicate which {@link HALLink}s should be automatically resolved
+ */
+ buildSingle(href$: string | Observable, ...linksToFollow: Array>): Observable> {
if (typeof href$ === 'string') {
href$ = observableOf(href$);
}
@@ -70,9 +80,9 @@ export class RemoteDataBuildService {
}
}),
hasValueOperator(),
- map((normalized: NormalizedObject) => {
- return this.build(normalized);
- }),
+ map((obj: T) =>
+ this.linkService.resolveLinks(obj, ...linksToFollow)
+ ),
startWith(undefined),
distinctUntilChanged()
);
@@ -86,13 +96,14 @@ export class RemoteDataBuildService {
const responsePending = hasValue(reqEntry) && hasValue(reqEntry.responsePending) ? reqEntry.responsePending : false;
let isSuccessful: boolean;
let error: RemoteDataError;
- if (hasValue(reqEntry) && hasValue(reqEntry.response)) {
- isSuccessful = reqEntry.response.isSuccessful;
- const errorMessage = isSuccessful === false ? (reqEntry.response as ErrorResponse).errorMessage : undefined;
+ const response = reqEntry ? reqEntry.response : undefined;
+ if (hasValue(response)) {
+ isSuccessful = response.isSuccessful;
+ const errorMessage = isSuccessful === false ? (response as ErrorResponse).errorMessage : undefined;
if (hasValue(errorMessage)) {
error = new RemoteDataError(
- (reqEntry.response as ErrorResponse).statusCode,
- (reqEntry.response as ErrorResponse).statusText,
+ response.statusCode,
+ response.statusText,
errorMessage
);
}
@@ -102,13 +113,21 @@ export class RemoteDataBuildService {
responsePending,
isSuccessful,
error,
- payload
+ payload,
+ hasValue(response) ? response.statusCode : undefined
+
);
})
);
}
- buildList(href$: string | Observable): Observable>> {
+ /**
+ * Creates a list of {@link RemoteData} objects based on the response of a request to the REST server, with a list of
+ * {@link FollowLinkConfig} that indicate which embedded info should be added to the objects
+ * @param href$ Observable href of objects we want to retrieve
+ * @param linksToFollow List of {@link FollowLinkConfig} that indicate which {@link HALLink}s should be automatically resolved
+ */
+ buildList(href$: string | Observable, ...linksToFollow: Array>): Observable>> {
if (typeof href$ === 'string') {
href$ = observableOf(href$);
}
@@ -118,10 +137,10 @@ export class RemoteDataBuildService {
getResourceLinksFromResponse(),
switchMap((resourceUUIDs: string[]) => {
return this.objectCache.getList(resourceUUIDs).pipe(
- map((normList: Array>) => {
- return normList.map((normalized: NormalizedObject) => {
- return this.build(normalized);
- });
+ map((objs: T[]) => {
+ return objs.map((obj: T) =>
+ this.linkService.resolveLinks(obj, ...linksToFollow)
+ );
}));
}),
startWith([]),
@@ -150,60 +169,6 @@ export class RemoteDataBuildService {
return this.toRemoteDataObservable(requestEntry$, payload$);
}
- build(normalized: NormalizedObject): T {
- const links: any = {};
- const relationships = getRelationships(normalized.constructor) || [];
-
- relationships.forEach((relationship: string) => {
- let result;
- if (hasValue(normalized[relationship])) {
- const { resourceType, isList } = getRelationMetadata(normalized, relationship);
- const objectList = normalized[relationship].page || normalized[relationship];
- if (typeof objectList !== 'string') {
- objectList.forEach((href: string) => {
- const request = new GetRequest(this.requestService.generateRequestId(), href);
- if (!this.requestService.isCachedOrPending(request)) {
- this.requestService.configure(request)
- }
- });
-
- const rdArr = [];
- objectList.forEach((href: string) => {
- rdArr.push(this.buildSingle(href));
- });
-
- if (isList) {
- result = this.aggregate(rdArr);
- } else if (rdArr.length === 1) {
- result = rdArr[0];
- }
- } else {
- const request = new GetRequest(this.requestService.generateRequestId(), objectList);
- if (!this.requestService.isCachedOrPending(request)) {
- this.requestService.configure(request)
- }
-
- // The rest API can return a single URL to represent a list of resources (e.g. /items/:id/bitstreams)
- // in that case only 1 href will be stored in the normalized obj (so the isArray above fails),
- // but it should still be built as a list
- if (isList) {
- result = this.buildList(objectList);
- } else {
- result = this.buildSingle(objectList);
- }
- }
-
- if (hasValue(normalized[relationship].page)) {
- links[relationship] = this.toPaginatedList(result, normalized[relationship].pageInfo);
- } else {
- links[relationship] = result;
- }
- }
- });
- const domainModel = getMapsTo(normalized.constructor);
- return Object.assign(new domainModel(), normalized, links);
- }
-
aggregate(input: Array>>): Observable> {
if (isEmpty(input)) {
diff --git a/src/app/core/cache/models/items/normalized-item-type.model.ts b/src/app/core/cache/models/items/normalized-item-type.model.ts
deleted file mode 100644
index fdb3b9e455..0000000000
--- a/src/app/core/cache/models/items/normalized-item-type.model.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-import { autoserialize, autoserializeAs, inheritSerialization } from 'cerialize';
-import { ItemType } from '../../../shared/item-relationships/item-type.model';
-import { mapsTo } from '../../builders/build-decorators';
-import { NormalizedObject } from '../normalized-object.model';
-import { IDToUUIDSerializer } from '../../id-to-uuid-serializer';
-
-/**
- * Normalized model class for a DSpace ItemType
- */
-@mapsTo(ItemType)
-@inheritSerialization(NormalizedObject)
-export class NormalizedItemType extends NormalizedObject {
- /**
- * The label that describes the ResourceType of the Item
- */
- @autoserialize
- label: string;
-
- /**
- * The identifier of this ItemType
- */
- @autoserialize
- id: string;
-
- /**
- * The universally unique identifier of this ItemType
- */
- @autoserializeAs(new IDToUUIDSerializer(ItemType.type.value), 'id')
- uuid: string;
-}
diff --git a/src/app/core/cache/models/items/normalized-relationship-type.model.ts b/src/app/core/cache/models/items/normalized-relationship-type.model.ts
deleted file mode 100644
index 23c3333a9b..0000000000
--- a/src/app/core/cache/models/items/normalized-relationship-type.model.ts
+++ /dev/null
@@ -1,77 +0,0 @@
-import { autoserialize, autoserializeAs, inheritSerialization } from 'cerialize';
-import { RelationshipType } from '../../../shared/item-relationships/relationship-type.model';
-import { ResourceType } from '../../../shared/resource-type';
-import { mapsTo, relationship } from '../../builders/build-decorators';
-import { NormalizedDSpaceObject } from '../normalized-dspace-object.model';
-import { NormalizedObject } from '../normalized-object.model';
-import { IDToUUIDSerializer } from '../../id-to-uuid-serializer';
-import { ItemType } from '../../../shared/item-relationships/item-type.model';
-
-/**
- * Normalized model class for a DSpace RelationshipType
- */
-@mapsTo(RelationshipType)
-@inheritSerialization(NormalizedDSpaceObject)
-export class NormalizedRelationshipType extends NormalizedObject {
- /**
- * The identifier of this RelationshipType
- */
- @autoserialize
- id: string;
-
- /**
- * The label that describes the Relation to the left of this RelationshipType
- */
- @autoserialize
- leftwardType: string;
-
- /**
- * The maximum amount of Relationships allowed to the left of this RelationshipType
- */
- @autoserialize
- leftMaxCardinality: number;
-
- /**
- * The minimum amount of Relationships allowed to the left of this RelationshipType
- */
- @autoserialize
- leftMinCardinality: number;
-
- /**
- * The label that describes the Relation to the right of this RelationshipType
- */
- @autoserialize
- rightwardType: string;
-
- /**
- * The maximum amount of Relationships allowed to the right of this RelationshipType
- */
- @autoserialize
- rightMaxCardinality: number;
-
- /**
- * The minimum amount of Relationships allowed to the right of this RelationshipType
- */
- @autoserialize
- rightMinCardinality: number;
-
- /**
- * The type of Item found to the left of this RelationshipType
- */
- @autoserialize
- @relationship(ItemType, false)
- leftType: string;
-
- /**
- * The type of Item found to the right of this RelationshipType
- */
- @autoserialize
- @relationship(ItemType, false)
- rightType: string;
-
- /**
- * The universally unique identifier of this RelationshipType
- */
- @autoserializeAs(new IDToUUIDSerializer(RelationshipType.type.value), 'id')
- uuid: string;
-}
diff --git a/src/app/core/cache/models/items/normalized-relationship.model.ts b/src/app/core/cache/models/items/normalized-relationship.model.ts
deleted file mode 100644
index 1c1dcf8d5b..0000000000
--- a/src/app/core/cache/models/items/normalized-relationship.model.ts
+++ /dev/null
@@ -1,72 +0,0 @@
-import { autoserialize, deserialize, deserializeAs, inheritSerialization } from 'cerialize';
-import { Relationship } from '../../../shared/item-relationships/relationship.model';
-import { mapsTo, relationship } from '../../builders/build-decorators';
-import { NormalizedObject } from '../normalized-object.model';
-import { IDToUUIDSerializer } from '../../id-to-uuid-serializer';
-import { RelationshipType } from '../../../shared/item-relationships/relationship-type.model';
-import { Item } from '../../../shared/item.model';
-
-/**
- * Normalized model class for a DSpace Relationship
- */
-@mapsTo(Relationship)
-@inheritSerialization(NormalizedObject)
-export class NormalizedRelationship extends NormalizedObject {
-
- /**
- * The identifier of this Relationship
- */
- @deserialize
- id: string;
-
- /**
- * The item to the left of this relationship
- */
- @deserialize
- @relationship(Item, false)
- leftItem: string;
-
- /**
- * The item to the right of this relationship
- */
- @deserialize
- @relationship(Item, false)
- rightItem: string;
-
- /**
- * The place of the Item to the left side of this Relationship
- */
- @autoserialize
- leftPlace: number;
-
- /**
- * The place of the Item to the right side of this Relationship
- */
- @autoserialize
- rightPlace: number;
-
- /**
- * The name variant of the Item to the left side of this Relationship
- */
- @autoserialize
- leftwardValue: string;
-
- /**
- * The name variant of the Item to the right side of this Relationship
- */
- @autoserialize
- rightwardValue: string;
-
- /**
- * The type of Relationship
- */
- @deserialize
- @relationship(RelationshipType, false)
- relationshipType: string;
-
- /**
- * The universally unique identifier of this Relationship
- */
- @deserializeAs(new IDToUUIDSerializer(Relationship.type.value), 'id')
- uuid: string;
-}
diff --git a/src/app/core/cache/models/normalized-bitstream-format.model.ts b/src/app/core/cache/models/normalized-bitstream-format.model.ts
deleted file mode 100644
index 2283ecb368..0000000000
--- a/src/app/core/cache/models/normalized-bitstream-format.model.ts
+++ /dev/null
@@ -1,65 +0,0 @@
-import { autoserialize, autoserializeAs, inheritSerialization } from 'cerialize';
-import { BitstreamFormat } from '../../shared/bitstream-format.model';
-
-import { mapsTo } from '../builders/build-decorators';
-import { IDToUUIDSerializer } from '../id-to-uuid-serializer';
-import { NormalizedObject } from './normalized-object.model';
-import { BitstreamFormatSupportLevel } from '../../shared/bitstream-format-support-level';
-
-/**
- * Normalized model class for a Bitstream Format
- */
-@mapsTo(BitstreamFormat)
-@inheritSerialization(NormalizedObject)
-export class NormalizedBitstreamFormat extends NormalizedObject {
- /**
- * Short description of this Bitstream Format
- */
- @autoserialize
- shortDescription: string;
-
- /**
- * Description of this Bitstream Format
- */
- @autoserialize
- description: string;
-
- /**
- * String representing the MIME type of this Bitstream Format
- */
- @autoserialize
- mimetype: string;
-
- /**
- * The level of support the system offers for this Bitstream Format
- */
- @autoserialize
- supportLevel: BitstreamFormatSupportLevel;
-
- /**
- * True if the Bitstream Format is used to store system information, rather than the content of items in the system
- */
- @autoserialize
- internal: boolean;
-
- /**
- * String representing this Bitstream Format's file extension
- */
- @autoserialize
- extensions: string[];
-
- /**
- * Identifier for this Bitstream Format
- * Note that this ID is unique for bitstream formats,
- * but might not be unique across different object types
- */
- @autoserialize
- id: string;
-
- /**
- * Universally unique identifier for this Bitstream Format
- * Consist of a prefix and the id field to ensure the identifier is unique across all object types
- */
- @autoserializeAs(new IDToUUIDSerializer('bitstream-format'), 'id')
- uuid: string;
-}
diff --git a/src/app/core/cache/models/normalized-bitstream.model.ts b/src/app/core/cache/models/normalized-bitstream.model.ts
deleted file mode 100644
index a9e389fd41..0000000000
--- a/src/app/core/cache/models/normalized-bitstream.model.ts
+++ /dev/null
@@ -1,60 +0,0 @@
-import { autoserialize, inheritSerialization } from 'cerialize';
-
-import { NormalizedDSpaceObject } from './normalized-dspace-object.model';
-import { Bitstream } from '../../shared/bitstream.model';
-import { mapsTo, relationship } from '../builders/build-decorators';
-import { Item } from '../../shared/item.model';
-import { BitstreamFormat } from '../../shared/bitstream-format.model';
-
-/**
- * Normalized model class for a DSpace Bitstream
- */
-@mapsTo(Bitstream)
-@inheritSerialization(NormalizedDSpaceObject)
-export class NormalizedBitstream extends NormalizedDSpaceObject {
- /**
- * The size of this bitstream in bytes
- */
- @autoserialize
- sizeBytes: number;
-
- /**
- * The relative path to this Bitstream's file
- */
- @autoserialize
- content: string;
-
- /**
- * The format of this Bitstream
- */
- @autoserialize
- @relationship(BitstreamFormat, false)
- format: string;
-
- /**
- * The description of this Bitstream
- */
- @autoserialize
- description: string;
-
- /**
- * An array of Bundles that are direct parents of this Bitstream
- */
- @autoserialize
- @relationship(Item, true)
- parents: string[];
-
- /**
- * The Bundle that owns this Bitstream
- */
- @autoserialize
- @relationship(Item, false)
- owner: string;
-
- /**
- * The name of the Bundle this Bitstream is part of
- */
- @autoserialize
- bundleName: string;
-
-}
diff --git a/src/app/core/cache/models/normalized-bundle.model.ts b/src/app/core/cache/models/normalized-bundle.model.ts
deleted file mode 100644
index 9582643efb..0000000000
--- a/src/app/core/cache/models/normalized-bundle.model.ts
+++ /dev/null
@@ -1,45 +0,0 @@
-import { autoserialize, inheritSerialization } from 'cerialize';
-
-import { NormalizedDSpaceObject } from './normalized-dspace-object.model';
-import { Bundle } from '../../shared/bundle.model';
-import { mapsTo, relationship } from '../builders/build-decorators';
-import { Bitstream } from '../../shared/bitstream.model';
-
-/**
- * Normalized model class for a DSpace Bundle
- */
-@mapsTo(Bundle)
-@inheritSerialization(NormalizedDSpaceObject)
-export class NormalizedBundle extends NormalizedDSpaceObject {
-
- /**
- * The bundle's name
- */
- @autoserialize
- name: string;
-
- /**
- * The primary bitstream of this Bundle
- */
- @autoserialize
- @relationship(Bitstream, false)
- primaryBitstream: string;
-
- /**
- * An array of Items that are direct parents of this Bundle
- */
- parents: string[];
-
- /**
- * The Item that owns this Bundle
- */
- owner: string;
-
- /**
- * List of Bitstreams that are part of this Bundle
- */
- @autoserialize
- @relationship(Bitstream, true)
- bitstreams: string[];
-
-}
diff --git a/src/app/core/cache/models/normalized-collection.model.ts b/src/app/core/cache/models/normalized-collection.model.ts
deleted file mode 100644
index 9b3419675a..0000000000
--- a/src/app/core/cache/models/normalized-collection.model.ts
+++ /dev/null
@@ -1,71 +0,0 @@
-import { autoserialize, deserialize, inheritSerialization } from 'cerialize';
-
-import { NormalizedDSpaceObject } from './normalized-dspace-object.model';
-import { Collection } from '../../shared/collection.model';
-import { mapsTo, relationship } from '../builders/build-decorators';
-import { NormalizedResourcePolicy } from './normalized-resource-policy.model';
-import { NormalizedBitstream } from './normalized-bitstream.model';
-import { NormalizedCommunity } from './normalized-community.model';
-import { NormalizedItem } from './normalized-item.model';
-import { License } from '../../shared/license.model';
-import { ResourcePolicy } from '../../shared/resource-policy.model';
-import { Bitstream } from '../../shared/bitstream.model';
-import { Community } from '../../shared/community.model';
-import { Item } from '../../shared/item.model';
-
-/**
- * Normalized model class for a DSpace Collection
- */
-@mapsTo(Collection)
-@inheritSerialization(NormalizedDSpaceObject)
-export class NormalizedCollection extends NormalizedDSpaceObject {
-
- /**
- * A string representing the unique handle of this Collection
- */
- @autoserialize
- handle: string;
-
- /**
- * The Bitstream that represents the license of this Collection
- */
- @autoserialize
- @relationship(License, false)
- license: string;
-
- /**
- * The Bitstream that represents the default Access Conditions of this Collection
- */
- @autoserialize
- @relationship(ResourcePolicy, false)
- defaultAccessConditions: string;
-
- /**
- * The Bitstream that represents the logo of this Collection
- */
- @deserialize
- @relationship(Bitstream, false)
- logo: string;
-
- /**
- * An array of Communities that are direct parents of this Collection
- */
- @deserialize
- @relationship(Community, true)
- parents: string[];
-
- /**
- * The Community that owns this Collection
- */
- @deserialize
- @relationship(Community, false)
- owner: string;
-
- /**
- * List of Items that are part of (not necessarily owned by) this Collection
- */
- @deserialize
- @relationship(Item, true)
- items: string[];
-
-}
diff --git a/src/app/core/cache/models/normalized-community.model.ts b/src/app/core/cache/models/normalized-community.model.ts
deleted file mode 100644
index 173760ca72..0000000000
--- a/src/app/core/cache/models/normalized-community.model.ts
+++ /dev/null
@@ -1,56 +0,0 @@
-import { autoserialize, deserialize, inheritSerialization } from 'cerialize';
-
-import { NormalizedDSpaceObject } from './normalized-dspace-object.model';
-import { Community } from '../../shared/community.model';
-import { mapsTo, relationship } from '../builders/build-decorators';
-import { ResourceType } from '../../shared/resource-type';
-import { NormalizedBitstream } from './normalized-bitstream.model';
-import { NormalizedCollection } from './normalized-collection.model';
-import { Bitstream } from '../../shared/bitstream.model';
-import { Collection } from '../../shared/collection.model';
-
-/**
- * Normalized model class for a DSpace Community
- */
-@mapsTo(Community)
-@inheritSerialization(NormalizedDSpaceObject)
-export class NormalizedCommunity extends NormalizedDSpaceObject {
- /**
- * A string representing the unique handle of this Community
- */
- @autoserialize
- handle: string;
-
- /**
- * The Bitstream that represents the logo of this Community
- */
- @deserialize
- @relationship(Bitstream, false)
- logo: string;
-
- /**
- * An array of Communities that are direct parents of this Community
- */
- @deserialize
- @relationship(Community, true)
- parents: string[];
-
- /**
- * The Community that owns this Community
- */
- @deserialize
- @relationship(Community, false)
- owner: string;
-
- /**
- * List of Collections that are owned by this Community
- */
- @deserialize
- @relationship(Collection, true)
- collections: string[];
-
- @deserialize
- @relationship(Community, true)
- subcommunities: string[];
-
-}
diff --git a/src/app/core/cache/models/normalized-dspace-object.model.ts b/src/app/core/cache/models/normalized-dspace-object.model.ts
deleted file mode 100644
index 3c43dd85dc..0000000000
--- a/src/app/core/cache/models/normalized-dspace-object.model.ts
+++ /dev/null
@@ -1,72 +0,0 @@
-import { autoserializeAs, deserializeAs, autoserialize } from 'cerialize';
-import { DSpaceObject } from '../../shared/dspace-object.model';
-import { MetadataMap, MetadataMapSerializer } from '../../shared/metadata.models';
-import { mapsTo } from '../builders/build-decorators';
-import { NormalizedObject } from './normalized-object.model';
-import { TypedObject } from '../object-cache.reducer';
-
-/**
- * An model class for a DSpaceObject.
- */
-@mapsTo(DSpaceObject)
-export class NormalizedDSpaceObject extends NormalizedObject implements TypedObject {
-
- /**
- * The link to the rest endpoint where this object can be found
- *
- * Repeated here to make the serialization work,
- * inheritSerialization doesn't seem to work for more than one level
- */
- @deserializeAs(String)
- self: string;
-
- /**
- * The human-readable identifier of this DSpaceObject
- *
- * Currently mapped to uuid but left in to leave room
- * for a shorter, more user friendly type of id
- */
- @autoserializeAs(String, 'uuid')
- id: string;
-
- /**
- * The universally unique identifier of this DSpaceObject
- */
- @autoserializeAs(String)
- uuid: string;
-
- /**
- * A string representing the kind of DSpaceObject, e.g. community, item, …
- */
- @autoserialize
- type: string;
-
- /**
- * All metadata of this DSpaceObject
- */
- @autoserializeAs(MetadataMapSerializer)
- metadata: MetadataMap;
-
- /**
- * An array of DSpaceObjects that are direct parents of this DSpaceObject
- */
- @deserializeAs(String)
- parents: string[];
-
- /**
- * The DSpaceObject that owns this DSpaceObject
- */
- @deserializeAs(String)
- owner: string;
-
- /**
- * The links to all related resources returned by the rest api.
- *
- * Repeated here to make the serialization work,
- * inheritSerialization doesn't seem to work for more than one level
- */
- @deserializeAs(Object)
- _links: {
- [name: string]: string
- }
-}
diff --git a/src/app/core/cache/models/normalized-external-source-entry.model.ts b/src/app/core/cache/models/normalized-external-source-entry.model.ts
deleted file mode 100644
index de262949e7..0000000000
--- a/src/app/core/cache/models/normalized-external-source-entry.model.ts
+++ /dev/null
@@ -1,42 +0,0 @@
-import { autoserialize, autoserializeAs, inheritSerialization } from 'cerialize';
-import { NormalizedObject } from './normalized-object.model';
-import { ExternalSourceEntry } from '../../shared/external-source-entry.model';
-import { mapsTo } from '../builders/build-decorators';
-import { MetadataMap, MetadataMapSerializer } from '../../shared/metadata.models';
-
-/**
- * Normalized model class for an external source entry
- */
-@mapsTo(ExternalSourceEntry)
-@inheritSerialization(NormalizedObject)
-export class NormalizedExternalSourceEntry extends NormalizedObject {
- /**
- * Unique identifier
- */
- @autoserialize
- id: string;
-
- /**
- * The value to display
- */
- @autoserialize
- display: string;
-
- /**
- * The value to store the entry with
- */
- @autoserialize
- value: string;
-
- /**
- * The ID of the external source this entry originates from
- */
- @autoserialize
- externalSource: string;
-
- /**
- * Metadata of the entry
- */
- @autoserializeAs(MetadataMapSerializer)
- metadata: MetadataMap;
-}
diff --git a/src/app/core/cache/models/normalized-external-source.model.ts b/src/app/core/cache/models/normalized-external-source.model.ts
deleted file mode 100644
index fd9a42fb72..0000000000
--- a/src/app/core/cache/models/normalized-external-source.model.ts
+++ /dev/null
@@ -1,29 +0,0 @@
-import { autoserialize, inheritSerialization } from 'cerialize';
-import { NormalizedObject } from './normalized-object.model';
-import { ExternalSource } from '../../shared/external-source.model';
-import { mapsTo } from '../builders/build-decorators';
-
-/**
- * Normalized model class for an external source
- */
-@mapsTo(ExternalSource)
-@inheritSerialization(NormalizedObject)
-export class NormalizedExternalSource extends NormalizedObject {
- /**
- * Unique identifier
- */
- @autoserialize
- id: string;
-
- /**
- * The name of this external source
- */
- @autoserialize
- name: string;
-
- /**
- * Is the source hierarchical?
- */
- @autoserialize
- hierarchical: boolean;
-}
diff --git a/src/app/core/cache/models/normalized-item.model.ts b/src/app/core/cache/models/normalized-item.model.ts
deleted file mode 100644
index 9b7edf70c0..0000000000
--- a/src/app/core/cache/models/normalized-item.model.ts
+++ /dev/null
@@ -1,72 +0,0 @@
-import { inheritSerialization, deserialize, autoserialize, autoserializeAs } from 'cerialize';
-
-import { NormalizedDSpaceObject } from './normalized-dspace-object.model';
-import { Item } from '../../shared/item.model';
-import { mapsTo, relationship } from '../builders/build-decorators';
-import { Collection } from '../../shared/collection.model';
-import { Relationship } from '../../shared/item-relationships/relationship.model';
-import { Bundle } from '../../shared/bundle.model';
-
-/**
- * Normalized model class for a DSpace Item
- */
-@mapsTo(Item)
-@inheritSerialization(NormalizedDSpaceObject)
-export class NormalizedItem extends NormalizedDSpaceObject- {
-
- /**
- * A string representing the unique handle of this Item
- */
- @autoserialize
- handle: string;
-
- /**
- * The Date of the last modification of this Item
- */
- @deserialize
- lastModified: Date;
-
- /**
- * A boolean representing if this Item is currently archived or not
- */
- @autoserializeAs(Boolean, 'inArchive')
- isArchived: boolean;
-
- /**
- * A boolean representing if this Item is currently discoverable or not
- */
- @autoserializeAs(Boolean, 'discoverable')
- isDiscoverable: boolean;
-
- /**
- * A boolean representing if this Item is currently withdrawn or not
- */
- @autoserializeAs(Boolean, 'withdrawn')
- isWithdrawn: boolean;
-
- /**
- * An array of Collections that are direct parents of this Item
- */
- @deserialize
- @relationship(Collection, true)
- parents: string[];
-
- /**
- * The Collection that owns this Item
- */
- @deserialize
- @relationship(Collection, false)
- owningCollection: string;
-
- /**
- * List of Bitstreams that are owned by this Item
- */
- @deserialize
- @relationship(Bundle, true)
- bundles: string[];
-
- @deserialize
- @relationship(Relationship, true)
- relationships: string[];
-
-}
diff --git a/src/app/core/cache/models/normalized-license.model.ts b/src/app/core/cache/models/normalized-license.model.ts
deleted file mode 100644
index 02bd1808c8..0000000000
--- a/src/app/core/cache/models/normalized-license.model.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-import { autoserialize, inheritSerialization } from 'cerialize';
-import { mapsTo } from '../builders/build-decorators';
-import { NormalizedDSpaceObject } from './normalized-dspace-object.model';
-import { License } from '../../shared/license.model';
-
-/**
- * Normalized model class for a Collection License
- */
-@mapsTo(License)
-@inheritSerialization(NormalizedDSpaceObject)
-export class NormalizedLicense extends NormalizedDSpaceObject
{
-
- /**
- * A boolean representing if this License is custom or not
- */
- @autoserialize
- custom: boolean;
-
- /**
- * The text of the license
- */
- @autoserialize
- text: string;
-}
diff --git a/src/app/core/cache/models/normalized-object.model.ts b/src/app/core/cache/models/normalized-object.model.ts
deleted file mode 100644
index 8a3aed32c9..0000000000
--- a/src/app/core/cache/models/normalized-object.model.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-import { CacheableObject, TypedObject } from '../object-cache.reducer';
-import { autoserialize, deserialize } from 'cerialize';
-import { ResourceType } from '../../shared/resource-type';
-/**
- * An abstract model class for a NormalizedObject.
- */
-export abstract class NormalizedObject implements CacheableObject {
- /**
- * The link to the rest endpoint where this object can be found
- */
- @deserialize
- self: string;
-
- @deserialize
- _links: {
- [name: string]: string
- };
-
- /**
- * A string representing the kind of object
- */
- @deserialize
- type: string;
-}
diff --git a/src/app/core/cache/models/normalized-resource-policy.model.ts b/src/app/core/cache/models/normalized-resource-policy.model.ts
deleted file mode 100644
index cd25a0af05..0000000000
--- a/src/app/core/cache/models/normalized-resource-policy.model.ts
+++ /dev/null
@@ -1,48 +0,0 @@
-import { autoserialize, autoserializeAs, inheritSerialization } from 'cerialize';
-import { ResourcePolicy } from '../../shared/resource-policy.model';
-
-import { mapsTo } from '../builders/build-decorators';
-import { NormalizedObject } from './normalized-object.model';
-import { IDToUUIDSerializer } from '../id-to-uuid-serializer';
-import { ActionType } from './action-type.model';
-
-/**
- * Normalized model class for a Resource Policy
- */
-@mapsTo(ResourcePolicy)
-@inheritSerialization(NormalizedObject)
-export class NormalizedResourcePolicy extends NormalizedObject {
- /**
- * The action that is allowed by this Resource Policy
- */
- @autoserialize
- action: ActionType;
-
- /**
- * The name for this Resource Policy
- */
- @autoserialize
- name: string;
-
- /**
- * The uuid of the Group this Resource Policy applies to
- */
- @autoserialize
- groupUUID: string;
-
- /**
- * Identifier for this Resource Policy
- * Note that this ID is unique for resource policies,
- * but might not be unique across different object types
- */
- @autoserialize
- id: string;
-
- /**
- * The universally unique identifier for this Resource Policy
- * Consist of a prefix and the id field to ensure the identifier is unique across all object types
- */
- @autoserializeAs(new IDToUUIDSerializer('resource-policy'), 'id')
- uuid: string;
-
-}
diff --git a/src/app/core/cache/models/normalized-site.model.ts b/src/app/core/cache/models/normalized-site.model.ts
deleted file mode 100644
index 68a7e0a480..0000000000
--- a/src/app/core/cache/models/normalized-site.model.ts
+++ /dev/null
@@ -1,13 +0,0 @@
-import { inheritSerialization } from 'cerialize';
-import { NormalizedDSpaceObject } from './normalized-dspace-object.model';
-import { mapsTo } from '../builders/build-decorators';
-import { Site } from '../../shared/site.model';
-
-/**
- * Normalized model class for a Site object
- */
-@mapsTo(Site)
-@inheritSerialization(NormalizedDSpaceObject)
-export class NormalizedSite extends NormalizedDSpaceObject {
-
-}
diff --git a/src/app/core/cache/object-cache.reducer.spec.ts b/src/app/core/cache/object-cache.reducer.spec.ts
index a65e63ab86..6519e887c9 100644
--- a/src/app/core/cache/object-cache.reducer.spec.ts
+++ b/src/app/core/cache/object-cache.reducer.spec.ts
@@ -1,6 +1,6 @@
import * as deepFreeze from 'deep-freeze';
-
-import { objectCacheReducer } from './object-cache.reducer';
+import { Operation } from 'fast-json-patch';
+import { Item } from '../shared/item.model';
import {
AddPatchObjectCacheAction,
AddToObjectCacheAction,
@@ -8,8 +8,8 @@ import {
RemoveFromObjectCacheAction,
ResetObjectCacheTimestampsAction
} from './object-cache.actions';
-import { Operation } from 'fast-json-patch';
-import { Item } from '../shared/item.model';
+
+import { objectCacheReducer } from './object-cache.reducer';
class NullAction extends RemoveFromObjectCacheAction {
type = null;
@@ -31,19 +31,21 @@ describe('objectCacheReducer', () => {
data: {
type: Item.type,
self: selfLink1,
- foo: 'bar'
+ foo: 'bar',
+ _links: { self: { href: selfLink1 } }
},
timeAdded: new Date().getTime(),
msToLive: 900000,
requestUUID: requestUUID1,
patches: [],
- isDirty: false
+ isDirty: false,
},
[selfLink2]: {
data: {
type: Item.type,
self: requestUUID2,
- foo: 'baz'
+ foo: 'baz',
+ _links: { self: { href: requestUUID2 } }
},
timeAdded: new Date().getTime(),
msToLive: 900000,
@@ -70,7 +72,7 @@ describe('objectCacheReducer', () => {
it('should add the payload to the cache in response to an ADD action', () => {
const state = Object.create(null);
- const objectToCache = { self: selfLink1, type: Item.type };
+ const objectToCache = { self: selfLink1, type: Item.type, _links: { self: { href: selfLink1 } } };
const timeAdded = new Date().getTime();
const msToLive = 900000;
const requestUUID = requestUUID1;
@@ -87,7 +89,8 @@ describe('objectCacheReducer', () => {
self: selfLink1,
foo: 'baz',
somethingElse: true,
- type: Item.type
+ type: Item.type,
+ _links: { self: { href: selfLink1 } }
};
const timeAdded = new Date().getTime();
const msToLive = 900000;
@@ -103,7 +106,7 @@ describe('objectCacheReducer', () => {
it('should perform the ADD action without affecting the previous state', () => {
const state = Object.create(null);
- const objectToCache = { self: selfLink1, type: Item.type };
+ const objectToCache = { self: selfLink1, type: Item.type, _links: { self: { href: selfLink1 } } };
const timeAdded = new Date().getTime();
const msToLive = 900000;
const requestUUID = requestUUID1;
@@ -121,8 +124,8 @@ describe('objectCacheReducer', () => {
expect(newState[selfLink1]).toBeUndefined();
});
- it("shouldn't do anything in response to the REMOVE action for an object that isn't cached", () => {
- const wrongKey = "this isn't cached";
+ it('shouldn\'t do anything in response to the REMOVE action for an object that isn\'t cached', () => {
+ const wrongKey = 'this isn\'t cached';
const action = new RemoveFromObjectCacheAction(wrongKey);
const newState = objectCacheReducer(testState, action);
diff --git a/src/app/core/cache/object-cache.reducer.ts b/src/app/core/cache/object-cache.reducer.ts
index afc040bf59..a39ceb4e16 100644
--- a/src/app/core/cache/object-cache.reducer.ts
+++ b/src/app/core/cache/object-cache.reducer.ts
@@ -1,3 +1,7 @@
+import { autoserialize, deserialize } from 'cerialize';
+import { HALLink } from '../shared/hal-link.model';
+import { HALResource } from '../shared/hal-resource.model';
+import { excludeFromEquals } from '../utilities/equals.decorators';
import {
ObjectCacheAction,
ObjectCacheActionTypes,
@@ -34,6 +38,7 @@ export interface Patch {
export abstract class TypedObject {
static type: ResourceType;
+ type: ResourceType;
}
/* tslint:disable:max-classes-per-file */
@@ -42,10 +47,13 @@ export abstract class TypedObject {
*
* A cacheable object should have a self link
*/
-export class CacheableObject extends TypedObject {
+export class CacheableObject extends TypedObject implements HALResource {
uuid?: string;
handle?: string;
- self: string;
+
+ _links: {
+ self: HALLink;
+ }
// isNew: boolean;
// dirtyType: DirtyType;
// hasDirtyAttributes: boolean;
@@ -129,9 +137,9 @@ export function objectCacheReducer(state = initialState, action: ObjectCacheActi
* the new state, with the object added, or overwritten.
*/
function addToObjectCache(state: ObjectCacheState, action: AddToObjectCacheAction): ObjectCacheState {
- const existing = state[action.payload.objectToCache.self];
+ const existing = state[action.payload.objectToCache._links.self.href];
return Object.assign({}, state, {
- [action.payload.objectToCache.self]: {
+ [action.payload.objectToCache._links.self.href]: {
data: action.payload.objectToCache,
timeAdded: action.payload.timeAdded,
msToLive: action.payload.msToLive,
diff --git a/src/app/core/cache/object-cache.service.spec.ts b/src/app/core/cache/object-cache.service.spec.ts
index 39dc10de2c..e7c208e095 100644
--- a/src/app/core/cache/object-cache.service.spec.ts
+++ b/src/app/core/cache/object-cache.service.spec.ts
@@ -1,34 +1,36 @@
import * as ngrx from '@ngrx/store';
import { Store } from '@ngrx/store';
+import { Operation } from 'fast-json-patch';
import { of as observableOf } from 'rxjs';
-
-import { ObjectCacheService } from './object-cache.service';
+import { first } from 'rxjs/operators';
+import { CoreState } from '../core.reducers';
+import { RestRequestMethod } from '../data/rest-request-method';
+import { Item } from '../shared/item.model';
import {
AddPatchObjectCacheAction,
AddToObjectCacheAction,
ApplyPatchObjectCacheAction,
RemoveFromObjectCacheAction
} from './object-cache.actions';
-import { CoreState } from '../core.reducers';
-import { NormalizedItem } from './models/normalized-item.model';
-import { first } from 'rxjs/operators';
-import { Operation } from 'fast-json-patch';
-import { RestRequestMethod } from '../data/rest-request-method';
-import { AddToSSBAction } from './server-sync-buffer.actions';
import { Patch } from './object-cache.reducer';
-import { Item } from '../shared/item.model';
+
+import { ObjectCacheService } from './object-cache.service';
+import { AddToSSBAction } from './server-sync-buffer.actions';
describe('ObjectCacheService', () => {
let service: ObjectCacheService;
let store: Store;
+ let linkServiceStub;
const selfLink = 'https://rest.api/endpoint/1698f1d3-be98-4c51-9fd8-6bfedcbd59b7';
const requestUUID = '4d3a4ce8-a375-4b98-859b-39f0a014d736';
const timestamp = new Date().getTime();
const msToLive = 900000;
let objectToCache = {
- self: selfLink,
- type: Item.type
+ type: Item.type,
+ _links: {
+ self: { href: selfLink }
+ }
};
let cacheEntry;
let invalidCacheEntry;
@@ -36,8 +38,10 @@ describe('ObjectCacheService', () => {
function init() {
objectToCache = {
- self: selfLink,
- type: Item.type
+ type: Item.type,
+ _links: {
+ self: { href: selfLink }
+ }
};
cacheEntry = {
data: objectToCache,
@@ -50,8 +54,12 @@ describe('ObjectCacheService', () => {
beforeEach(() => {
init();
store = new Store(undefined, undefined, undefined);
+ linkServiceStub = {
+ removeResolvedLinks: (a) => a
+ };
+ spyOn(linkServiceStub, 'removeResolvedLinks').and.callThrough();
spyOn(store, 'dispatch');
- service = new ObjectCacheService(store);
+ service = new ObjectCacheService(store, linkServiceStub);
spyOn(Date.prototype, 'getTime').and.callFake(() => {
return timestamp;
@@ -62,6 +70,7 @@ describe('ObjectCacheService', () => {
it('should dispatch an ADD action with the object to add, the time to live, and the current timestamp', () => {
service.add(objectToCache, msToLive, requestUUID);
expect(store.dispatch).toHaveBeenCalledWith(new AddToObjectCacheAction(objectToCache, timestamp, msToLive, requestUUID));
+ expect(linkServiceStub.removeResolvedLinks).toHaveBeenCalledWith(objectToCache);
});
});
@@ -82,9 +91,9 @@ describe('ObjectCacheService', () => {
// due to the implementation of spyOn above, this subscribe will be synchronous
service.getObjectBySelfLink(selfLink).pipe(first()).subscribe((o) => {
- expect(o.self).toBe(selfLink);
+ expect(o._links.self.href).toBe(selfLink);
// this only works if testObj is an instance of TestClass
- expect(o instanceof NormalizedItem).toBeTruthy();
+ expect(o instanceof Item).toBeTruthy();
}
);
});
@@ -105,13 +114,14 @@ describe('ObjectCacheService', () => {
describe('getList', () => {
it('should return an observable of the array of cached objects with the specified self link and type', () => {
- const item = new NormalizedItem();
- item.self = selfLink;
+ const item = Object.assign(new Item(), {
+ _links: { self: { href: selfLink } }
+ });
spyOn(service, 'getObjectBySelfLink').and.returnValue(observableOf(item));
service.getList([selfLink, selfLink]).pipe(first()).subscribe((arr) => {
- expect(arr[0].self).toBe(selfLink);
- expect(arr[0] instanceof NormalizedItem).toBeTruthy();
+ expect(arr[0]._links.self.href).toBe(selfLink);
+ expect(arr[0] instanceof Item).toBeTruthy();
});
});
});
@@ -127,7 +137,7 @@ describe('ObjectCacheService', () => {
expect(service.hasBySelfLink(selfLink)).toBe(true);
});
- it("should return false if the object with the supplied self link isn't cached", () => {
+ it('should return false if the object with the supplied self link isn\'t cached', () => {
spyOnProperty(ngrx, 'select').and.callFake(() => {
return () => {
return () => observableOf(undefined);
diff --git a/src/app/core/cache/object-cache.service.ts b/src/app/core/cache/object-cache.service.ts
index 8d4e910471..53894df5f1 100644
--- a/src/app/core/cache/object-cache.service.ts
+++ b/src/app/core/cache/object-cache.service.ts
@@ -10,7 +10,7 @@ import { coreSelector } from '../core.selectors';
import { RestRequestMethod } from '../data/rest-request-method';
import { selfLinkFromUuidSelector } from '../index/index.selectors';
import { GenericConstructor } from '../shared/generic-constructor';
-import { NormalizedObject } from './models/normalized-object.model';
+import { LinkService } from './builders/link.service';
import {
AddPatchObjectCacheAction,
AddToObjectCacheAction,
@@ -20,7 +20,7 @@ import {
import { CacheableObject, ObjectCacheEntry, ObjectCacheState } from './object-cache.reducer';
import { AddToSSBAction } from './server-sync-buffer.actions';
-import { getMapsToType } from './builders/build-decorators';
+import { getClassForType } from './builders/build-decorators';
/**
* The base selector function to select the object cache in the store
@@ -45,21 +45,25 @@ const entryFromSelfLinkSelector =
*/
@Injectable()
export class ObjectCacheService {
- constructor(private store: Store) {
+ constructor(
+ private store: Store,
+ private linkService: LinkService
+ ) {
}
/**
* Add an object to the cache
*
- * @param objectToCache
+ * @param object
* The object to add
* @param msToLive
* The number of milliseconds it should be cached for
* @param requestUUID
* The UUID of the request that resulted in this object
*/
- add(objectToCache: CacheableObject, msToLive: number, requestUUID: string): void {
- this.store.dispatch(new AddToObjectCacheAction(objectToCache, new Date().getTime(), msToLive, requestUUID));
+ add(object: CacheableObject, msToLive: number, requestUUID: string): void {
+ object = this.linkService.removeResolvedLinks(object); // Ensure the object we're storing has no resolved links
+ this.store.dispatch(new AddToObjectCacheAction(object, new Date().getTime(), msToLive, requestUUID));
}
/**
@@ -77,14 +81,14 @@ export class ObjectCacheService {
*
* @param uuid
* The UUID of the object to get
- * @return Observable>
- * An observable of the requested object in normalized form
+ * @return Observable
+ * An observable of the requested object
*/
getObjectByUUID(uuid: string):
- Observable> {
+ Observable {
return this.store.pipe(
select(selfLinkFromUuidSelector(uuid)),
- mergeMap((selfLink: string) => this.getObjectBySelfLink(selfLink)
+ mergeMap((selfLink: string) => this.getObjectBySelfLink(selfLink)
)
)
}
@@ -94,10 +98,10 @@ export class ObjectCacheService {
*
* @param selfLink
* The selfLink of the object to get
- * @return Observable>
- * An observable of the requested object in normalized form
+ * @return Observable
+ * An observable of the requested object
*/
- getObjectBySelfLink(selfLink: string): Observable> {
+ getObjectBySelfLink(selfLink: string): Observable {
return this.getBySelfLink(selfLink).pipe(
map((entry: ObjectCacheEntry) => {
if (isNotEmpty(entry.patches)) {
@@ -110,8 +114,11 @@ export class ObjectCacheService {
}
),
map((entry: ObjectCacheEntry) => {
- const type: GenericConstructor> = getMapsToType((entry.data as any).type);
- return Object.assign(new type(), entry.data) as NormalizedObject
+ const type: GenericConstructor = getClassForType((entry.data as any).type);
+ if (typeof type !== 'function') {
+ throw new Error(`${type} is not a valid constructor for ${JSON.stringify(entry.data)}`);
+ }
+ return Object.assign(new type(), entry.data) as T
})
);
}
@@ -180,7 +187,7 @@ export class ObjectCacheService {
* The type of the objects to get
* @return Observable>
*/
- getList(selfLinks: string[]): Observable>> {
+ getList(selfLinks: string[]): Observable {
return observableCombineLatest(
selfLinks.map((selfLink: string) => this.getObjectBySelfLink(selfLink))
);
@@ -254,7 +261,7 @@ export class ObjectCacheService {
const timeOutdated = entry.timeAdded + entry.msToLive;
const isOutDated = new Date().getTime() > timeOutdated;
if (isOutDated) {
- this.store.dispatch(new RemoveFromObjectCacheAction(entry.data.self));
+ this.store.dispatch(new RemoveFromObjectCacheAction(entry.data._links.self.href));
}
return !isOutDated;
}
diff --git a/src/app/core/cache/response.models.ts b/src/app/core/cache/response.models.ts
index 5f4e15e138..3f46ecf647 100644
--- a/src/app/core/cache/response.models.ts
+++ b/src/app/core/cache/response.models.ts
@@ -1,4 +1,5 @@
import { SearchQueryResponse } from '../../shared/search/search-query-response.model';
+import { AuthStatus } from '../auth/models/auth-status.model';
import { RequestError } from '../data/request.models';
import { PageInfo } from '../shared/page-info.model';
import { ConfigObject } from '../config/models/config.model';
@@ -11,7 +12,6 @@ import { RegistryBitstreamformatsResponse } from '../registry/registry-bitstream
import { PaginatedList } from '../data/paginated-list';
import { SubmissionObject } from '../submission/models/submission-object.model';
import { DSpaceObject } from '../shared/dspace-object.model';
-import { NormalizedAuthStatus } from '../auth/models/normalized-auth-status.model';
import { MetadataSchema } from '../metadata/metadata-schema.model';
import { MetadataField } from '../metadata/metadata-field.model';
import { ContentSource } from '../shared/content-source.model';
@@ -203,7 +203,7 @@ export class AuthStatusResponse extends RestResponse {
public toCache = false;
constructor(
- public response: NormalizedAuthStatus,
+ public response: AuthStatus,
public statusCode: number,
public statusText: string,
) {
diff --git a/src/app/core/cache/server-sync-buffer.effects.spec.ts b/src/app/core/cache/server-sync-buffer.effects.spec.ts
index 66477adc20..3cdde3c2c6 100644
--- a/src/app/core/cache/server-sync-buffer.effects.spec.ts
+++ b/src/app/core/cache/server-sync-buffer.effects.spec.ts
@@ -1,22 +1,22 @@
import { TestBed } from '@angular/core/testing';
-
-import { Observable, of as observableOf } from 'rxjs';
import { provideMockActions } from '@ngrx/effects/testing';
+import { Store, StoreModule } from '@ngrx/store';
import { cold, hot } from 'jasmine-marbles';
-import { ServerSyncBufferEffects } from './server-sync-buffer.effects';
-import { GLOBAL_CONFIG } from '../../../config';
-import { CommitSSBAction, EmptySSBAction, ServerSyncBufferActionTypes } from './server-sync-buffer.actions';
-import { RestRequestMethod } from '../data/rest-request-method';
-import { Store, StoreModule } from '@ngrx/store';
-import { RequestService } from '../data/request.service';
-import { ObjectCacheService } from './object-cache.service';
-import { MockStore } from '../../shared/testing/mock-store';
+import { Observable, of as observableOf } from 'rxjs';
import * as operators from 'rxjs/operators';
-import { spyOnOperator } from '../../shared/testing/utils';
-import { DSpaceObject } from '../shared/dspace-object.model';
+import { GLOBAL_CONFIG } from '../../../config';
import { getMockRequestService } from '../../shared/mocks/mock-request.service';
+import { MockStore } from '../../shared/testing/mock-store';
+import { spyOnOperator } from '../../shared/testing/utils';
+import { RequestService } from '../data/request.service';
+import { RestRequestMethod } from '../data/rest-request-method';
+import { DSpaceObject } from '../shared/dspace-object.model';
import { ApplyPatchObjectCacheAction } from './object-cache.actions';
+import { ObjectCacheService } from './object-cache.service';
+import { CommitSSBAction, EmptySSBAction, ServerSyncBufferActionTypes } from './server-sync-buffer.actions';
+
+import { ServerSyncBufferEffects } from './server-sync-buffer.effects';
describe('ServerSyncBufferEffects', () => {
let ssbEffects: ServerSyncBufferEffects;
@@ -47,8 +47,9 @@ describe('ServerSyncBufferEffects', () => {
{
provide: ObjectCacheService, useValue: {
getObjectBySelfLink: (link) => {
- const object = new DSpaceObject();
- object.self = link;
+ const object = Object.assign(new DSpaceObject(), {
+ _links: { self: { href: link } }
+ });
return observableOf(object);
},
getBySelfLink: (link) => {
diff --git a/src/app/core/cache/server-sync-buffer.effects.ts b/src/app/core/cache/server-sync-buffer.effects.ts
index dae1ab6f4f..ed9340b148 100644
--- a/src/app/core/cache/server-sync-buffer.effects.ts
+++ b/src/app/core/cache/server-sync-buffer.effects.ts
@@ -15,11 +15,9 @@ import { Action, createSelector, MemoizedSelector, select, Store } from '@ngrx/s
import { ServerSyncBufferEntry, ServerSyncBufferState } from './server-sync-buffer.reducer';
import { combineLatest as observableCombineLatest, of as observableOf } from 'rxjs';
import { RequestService } from '../data/request.service';
-import { PatchRequest, PutRequest } from '../data/request.models';
+import { PatchRequest } from '../data/request.models';
import { ObjectCacheService } from './object-cache.service';
import { ApplyPatchObjectCacheAction } from './object-cache.actions';
-import { DSpaceRESTv2Serializer } from '../dspace-rest-v2/dspace-rest-v2.serializer';
-import { GenericConstructor } from '../shared/generic-constructor';
import { hasValue, isNotEmpty, isNotUndefined } from '../../shared/empty.util';
import { Observable } from 'rxjs/internal/Observable';
import { RestRequestMethod } from '../data/rest-request-method';
diff --git a/src/app/core/config/config-response-parsing.service.spec.ts b/src/app/core/config/config-response-parsing.service.spec.ts
index 90dd1670b8..87a7057078 100644
--- a/src/app/core/config/config-response-parsing.service.spec.ts
+++ b/src/app/core/config/config-response-parsing.service.spec.ts
@@ -1,22 +1,21 @@
-import { ConfigSuccessResponse, ErrorResponse } from '../cache/response.models';
-import { ConfigResponseParsingService } from './config-response-parsing.service';
-import { ObjectCacheService } from '../cache/object-cache.service';
-import { GlobalConfig } from '../../../config/global-config.interface';
-import { ConfigRequest } from '../data/request.models';
-
import { Store } from '@ngrx/store';
+import { GlobalConfig } from '../../../config/global-config.interface';
+import { ObjectCacheService } from '../cache/object-cache.service';
+import { ConfigSuccessResponse, ErrorResponse } from '../cache/response.models';
import { CoreState } from '../core.reducers';
import { PaginatedList } from '../data/paginated-list';
+import { ConfigRequest } from '../data/request.models';
import { PageInfo } from '../shared/page-info.model';
-import { NormalizedSubmissionSectionModel } from './models/normalized-config-submission-section.model';
-import { NormalizedSubmissionDefinitionModel } from './models/normalized-config-submission-definition.model';
+import { ConfigResponseParsingService } from './config-response-parsing.service';
+import { SubmissionDefinitionModel } from './models/config-submission-definition.model';
+import { SubmissionSectionModel } from './models/config-submission-section.model';
describe('ConfigResponseParsingService', () => {
let service: ConfigResponseParsingService;
const EnvConfig = {} as GlobalConfig;
const store = {} as Store;
- const objectCacheService = new ObjectCacheService(store);
+ const objectCacheService = new ObjectCacheService(store, undefined);
let validResponse;
beforeEach(() => {
service = new ConfigResponseParsingService(EnvConfig, objectCacheService);
@@ -150,7 +149,7 @@ describe('ConfigResponseParsingService', () => {
},
_embedded: [{}, {}],
_links: {
- self: 'https://rest.api/config/submissiondefinitions/traditional/sections'
+ self: { href: 'https://rest.api/config/submissiondefinitions/traditional/sections' }
}
}
}
@@ -170,77 +169,76 @@ describe('ConfigResponseParsingService', () => {
totalElements: 4,
totalPages: 1,
currentPage: 1,
- self: 'https://rest.api/config/submissiondefinitions/traditional/sections'
+ _links: {
+ self: {
+ href: 'https://rest.api/config/submissiondefinitions/traditional/sections'
+ },
+ },
});
const definitions =
- Object.assign(new NormalizedSubmissionDefinitionModel(), {
+ Object.assign(new SubmissionDefinitionModel(), {
isDefault: true,
name: 'traditional',
type: 'submissiondefinition',
_links: {
- sections: 'https://rest.api/config/submissiondefinitions/traditional/sections',
- self: 'https://rest.api/config/submissiondefinitions/traditional'
+ sections: { href: 'https://rest.api/config/submissiondefinitions/traditional/sections' },
+ self: { href: 'https://rest.api/config/submissiondefinitions/traditional' }
},
- self: 'https://rest.api/config/submissiondefinitions/traditional',
sections: new PaginatedList(pageinfo, [
- Object.assign(new NormalizedSubmissionSectionModel(), {
+ Object.assign(new SubmissionSectionModel(), {
header: 'submit.progressbar.describe.stepone',
mandatory: true,
sectionType: 'submission-form',
- visibility:{
- main:null,
- other:'READONLY'
+ visibility: {
+ main: null,
+ other: 'READONLY'
},
type: 'submissionsection',
_links: {
- self: 'https://rest.api/config/submissionsections/traditionalpageone',
- config: 'https://rest.api/config/submissionforms/traditionalpageone'
+ self: { href: 'https://rest.api/config/submissionsections/traditionalpageone' },
+ config: { href: 'https://rest.api/config/submissionforms/traditionalpageone' }
},
- self: 'https://rest.api/config/submissionsections/traditionalpageone',
}),
- Object.assign(new NormalizedSubmissionSectionModel(), {
+ Object.assign(new SubmissionSectionModel(), {
header: 'submit.progressbar.describe.steptwo',
mandatory: true,
sectionType: 'submission-form',
- visibility:{
- main:null,
- other:'READONLY'
+ visibility: {
+ main: null,
+ other: 'READONLY'
},
type: 'submissionsection',
_links: {
- self: 'https://rest.api/config/submissionsections/traditionalpagetwo',
- config: 'https://rest.api/config/submissionforms/traditionalpagetwo'
+ self: { href: 'https://rest.api/config/submissionsections/traditionalpagetwo' },
+ config: { href: 'https://rest.api/config/submissionforms/traditionalpagetwo' }
},
- self: 'https://rest.api/config/submissionsections/traditionalpagetwo',
}),
- Object.assign(new NormalizedSubmissionSectionModel(), {
+ Object.assign(new SubmissionSectionModel(), {
header: 'submit.progressbar.upload',
mandatory: false,
sectionType: 'upload',
- visibility:{
- main:null,
- other:'READONLY'
+ visibility: {
+ main: null,
+ other: 'READONLY'
},
type: 'submissionsection',
_links: {
- self: 'https://rest.api/config/submissionsections/upload',
- config: 'https://rest.api/config/submissionuploads/upload'
+ self: { href: 'https://rest.api/config/submissionsections/upload' },
+ config: { href: 'https://rest.api/config/submissionuploads/upload' }
},
- self: 'https://rest.api/config/submissionsections/upload',
}),
- Object.assign(new NormalizedSubmissionSectionModel(), {
+ Object.assign(new SubmissionSectionModel(), {
header: 'submit.progressbar.license',
mandatory: true,
sectionType: 'license',
- visibility:{
- main:null,
- other:'READONLY'
+ visibility: {
+ main: null,
+ other: 'READONLY'
},
type: 'submissionsection',
_links: {
- self: 'https://rest.api/config/submissionsections/license'
+ self: { href: 'https://rest.api/config/submissionsections/license' }
},
- self: 'https://rest.api/config/submissionsections/license',
})
])
});
diff --git a/src/app/core/config/config-response-parsing.service.ts b/src/app/core/config/config-response-parsing.service.ts
index d1f49710d3..d674445d54 100644
--- a/src/app/core/config/config-response-parsing.service.ts
+++ b/src/app/core/config/config-response-parsing.service.ts
@@ -15,6 +15,7 @@ import { ObjectCacheService } from '../cache/object-cache.service';
@Injectable()
export class ConfigResponseParsingService extends BaseResponseParsingService implements ResponseParsingService {
protected toCache = false;
+ protected shouldDirectlyAttachEmbeds = true;
constructor(
@Inject(GLOBAL_CONFIG) protected EnvConfig: GlobalConfig,
diff --git a/src/app/core/config/models/config-submission-definition.model.ts b/src/app/core/config/models/config-submission-definition.model.ts
index 0449e6a964..f3e888d513 100644
--- a/src/app/core/config/models/config-submission-definition.model.ts
+++ b/src/app/core/config/models/config-submission-definition.model.ts
@@ -1,22 +1,40 @@
-import { ConfigObject } from './config.model';
-import { SubmissionSectionModel } from './config-submission-section.model';
+import { autoserialize, deserialize, inheritSerialization } from 'cerialize';
+import { typedObject } from '../../cache/builders/build-decorators';
import { PaginatedList } from '../../data/paginated-list';
+import { HALLink } from '../../shared/hal-link.model';
import { ResourceType } from '../../shared/resource-type';
+import { SubmissionSectionModel } from './config-submission-section.model';
+import { ConfigObject } from './config.model';
/**
* Class for the configuration describing the submission
*/
+@typedObject
+@inheritSerialization(ConfigObject)
export class SubmissionDefinitionModel extends ConfigObject {
static type = new ResourceType('submissiondefinition');
/**
* A boolean representing if this submission definition is the default or not
*/
+ @autoserialize
isDefault: boolean;
/**
* A list of SubmissionSectionModel that are present in this submission definition
*/
+ // TODO refactor using remotedata
+ @deserialize
sections: PaginatedList;
+ /**
+ * The links to all related resources returned by the rest api.
+ */
+ @deserialize
+ _links: {
+ self: HALLink,
+ collections: HALLink,
+ sections: HALLink
+ };
+
}
diff --git a/src/app/core/config/models/config-submission-definitions.model.ts b/src/app/core/config/models/config-submission-definitions.model.ts
index d9892f542f..1fdf571806 100644
--- a/src/app/core/config/models/config-submission-definitions.model.ts
+++ b/src/app/core/config/models/config-submission-definitions.model.ts
@@ -1,6 +1,10 @@
+import { inheritSerialization } from 'cerialize';
+import { typedObject } from '../../cache/builders/build-decorators';
import { SubmissionDefinitionModel } from './config-submission-definition.model';
import { ResourceType } from '../../shared/resource-type';
+@typedObject
+@inheritSerialization(SubmissionDefinitionModel)
export class SubmissionDefinitionsModel extends SubmissionDefinitionModel {
static type = new ResourceType('submissiondefinitions');
diff --git a/src/app/core/config/models/config-submission-form.model.ts b/src/app/core/config/models/config-submission-form.model.ts
index a65d285c95..d3fcfa9738 100644
--- a/src/app/core/config/models/config-submission-form.model.ts
+++ b/src/app/core/config/models/config-submission-form.model.ts
@@ -1,3 +1,5 @@
+import { autoserialize, inheritSerialization } from 'cerialize';
+import { typedObject } from '../../cache/builders/build-decorators';
import { ConfigObject } from './config.model';
import { FormFieldModel } from '../../../shared/form/builder/models/form-field.model';
import { ResourceType } from '../../shared/resource-type';
@@ -12,11 +14,14 @@ export interface FormRowModel {
/**
* A model class for a NormalizedObject.
*/
+@typedObject
+@inheritSerialization(ConfigObject)
export class SubmissionFormModel extends ConfigObject {
static type = new ResourceType('submissionform');
/**
* An array of [FormRowModel] that are present in this form
*/
+ @autoserialize
rows: FormRowModel[];
}
diff --git a/src/app/core/config/models/config-submission-forms.model.ts b/src/app/core/config/models/config-submission-forms.model.ts
index 017d7d68cc..8130bf3264 100644
--- a/src/app/core/config/models/config-submission-forms.model.ts
+++ b/src/app/core/config/models/config-submission-forms.model.ts
@@ -1,9 +1,13 @@
+import { inheritSerialization } from 'cerialize';
+import { typedObject } from '../../cache/builders/build-decorators';
import { SubmissionFormModel } from './config-submission-form.model';
import { ResourceType } from '../../shared/resource-type';
/**
* A model class for a NormalizedObject.
*/
+@typedObject
+@inheritSerialization(SubmissionFormModel)
export class SubmissionFormsModel extends SubmissionFormModel {
static type = new ResourceType('submissionforms');
}
diff --git a/src/app/core/config/models/config-submission-section.model.ts b/src/app/core/config/models/config-submission-section.model.ts
index 4c560fa631..d8249297b1 100644
--- a/src/app/core/config/models/config-submission-section.model.ts
+++ b/src/app/core/config/models/config-submission-section.model.ts
@@ -1,6 +1,9 @@
-import { ConfigObject } from './config.model';
+import { autoserialize, deserialize, inheritSerialization } from 'cerialize';
import { SectionsType } from '../../../submission/sections/sections-type';
+import { typedObject } from '../../cache/builders/build-decorators';
+import { HALLink } from '../../shared/hal-link.model';
import { ResourceType } from '../../shared/resource-type';
+import { ConfigObject } from './config.model';
/**
* An interface that define section visibility and its properties.
@@ -10,27 +13,42 @@ export interface SubmissionSectionVisibility {
other: any
}
+@typedObject
+@inheritSerialization(ConfigObject)
export class SubmissionSectionModel extends ConfigObject {
static type = new ResourceType('submissionsection');
/**
* The header for this section
*/
+ @autoserialize
header: string;
/**
* A boolean representing if this submission section is the mandatory or not
*/
+ @autoserialize
mandatory: boolean;
/**
* A string representing the kind of section object
*/
+ @autoserialize
sectionType: SectionsType;
/**
* The [SubmissionSectionVisibility] object for this section
*/
- visibility: SubmissionSectionVisibility
+ @autoserialize
+ visibility: SubmissionSectionVisibility;
+
+ /**
+ * The {@link HALLink}s for this SubmissionSectionModel
+ */
+ @deserialize
+ _links: {
+ self: HALLink;
+ config: HALLink;
+ }
}
diff --git a/src/app/core/config/models/config-submission-sections.model.ts b/src/app/core/config/models/config-submission-sections.model.ts
index ae7b133391..7f78712273 100644
--- a/src/app/core/config/models/config-submission-sections.model.ts
+++ b/src/app/core/config/models/config-submission-sections.model.ts
@@ -1,6 +1,10 @@
+import { inheritSerialization } from 'cerialize';
+import { typedObject } from '../../cache/builders/build-decorators';
import { SubmissionSectionModel } from './config-submission-section.model';
import { ResourceType } from '../../shared/resource-type';
+@typedObject
+@inheritSerialization(SubmissionSectionModel)
export class SubmissionSectionsModel extends SubmissionSectionModel {
static type = new ResourceType('submissionsections');
}
diff --git a/src/app/core/config/models/config-submission-uploads.model.ts b/src/app/core/config/models/config-submission-uploads.model.ts
index 812a590041..b7733ee25d 100644
--- a/src/app/core/config/models/config-submission-uploads.model.ts
+++ b/src/app/core/config/models/config-submission-uploads.model.ts
@@ -1,22 +1,30 @@
+import { autoserialize, inheritSerialization } from 'cerialize';
+import { typedObject } from '../../cache/builders/build-decorators';
import { ConfigObject } from './config.model';
import { AccessConditionOption } from './config-access-condition-option.model';
import { SubmissionFormsModel } from './config-submission-forms.model';
import { ResourceType } from '../../shared/resource-type';
+@typedObject
+@inheritSerialization(ConfigObject)
export class SubmissionUploadsModel extends ConfigObject {
static type = new ResourceType('submissionupload');
/**
* A list of available bitstream access conditions
*/
+ @autoserialize
accessConditionOptions: AccessConditionOption[];
/**
* An object representing the configuration describing the bistream metadata form
*/
+ @autoserialize
metadata: SubmissionFormsModel;
+ @autoserialize
required: boolean;
+ @autoserialize
maxSize: number;
}
diff --git a/src/app/core/config/models/config.model.ts b/src/app/core/config/models/config.model.ts
index 20d67ec69d..fabb16eb23 100644
--- a/src/app/core/config/models/config.model.ts
+++ b/src/app/core/config/models/config.model.ts
@@ -1,22 +1,30 @@
+import { autoserialize, deserialize } from 'cerialize';
import { CacheableObject } from '../../cache/object-cache.reducer';
+import { HALLink } from '../../shared/hal-link.model';
import { ResourceType } from '../../shared/resource-type';
+import { excludeFromEquals } from '../../utilities/equals.decorators';
export abstract class ConfigObject implements CacheableObject {
/**
* The name for this configuration
*/
+ @autoserialize
public name: string;
+ /**
+ * The type of this ConfigObject
+ */
+ @excludeFromEquals
+ @autoserialize
+ type: ResourceType;
+
/**
* The links to all related resources returned by the rest api.
*/
- public _links: {
- [name: string]: string
+ @deserialize
+ _links: {
+ self: HALLink,
+ [name: string]: HALLink
};
-
- /**
- * The link to the rest endpoint where this config object can be found
- */
- self: string;
}
diff --git a/src/app/core/config/models/normalized-config-submission-definition.model.ts b/src/app/core/config/models/normalized-config-submission-definition.model.ts
deleted file mode 100644
index cb56e01acf..0000000000
--- a/src/app/core/config/models/normalized-config-submission-definition.model.ts
+++ /dev/null
@@ -1,28 +0,0 @@
-import { autoserialize, autoserializeAs, inheritSerialization } from 'cerialize';
-import { SubmissionSectionModel } from './config-submission-section.model';
-import { PaginatedList } from '../../data/paginated-list';
-import { NormalizedConfigObject } from './normalized-config.model';
-import { SubmissionDefinitionsModel } from './config-submission-definitions.model';
-import { mapsTo } from '../../cache/builders/build-decorators';
-import { SubmissionDefinitionModel } from './config-submission-definition.model';
-
-/**
- * Normalized class for the configuration describing the submission
- */
-@mapsTo(SubmissionDefinitionModel)
-@inheritSerialization(NormalizedConfigObject)
-export class NormalizedSubmissionDefinitionModel extends NormalizedConfigObject {
-
- /**
- * A boolean representing if this submission definition is the default or not
- */
- @autoserialize
- isDefault: boolean;
-
- /**
- * A list of SubmissionSectionModel that are present in this submission definition
- */
- @autoserializeAs(SubmissionSectionModel)
- sections: PaginatedList;
-
-}
diff --git a/src/app/core/config/models/normalized-config-submission-definitions.model.ts b/src/app/core/config/models/normalized-config-submission-definitions.model.ts
deleted file mode 100644
index 4c52d96458..0000000000
--- a/src/app/core/config/models/normalized-config-submission-definitions.model.ts
+++ /dev/null
@@ -1,13 +0,0 @@
-import { inheritSerialization } from 'cerialize';
-import { NormalizedConfigObject } from './normalized-config.model';
-import { SubmissionDefinitionsModel } from './config-submission-definitions.model';
-import { mapsTo } from '../../cache/builders/build-decorators';
-import { NormalizedSubmissionDefinitionModel } from './normalized-config-submission-definition.model';
-
-/**
- * Normalized class for the configuration describing the submission
- */
-@mapsTo(SubmissionDefinitionsModel)
-@inheritSerialization(NormalizedConfigObject)
-export class NormalizedSubmissionDefinitionsModel extends NormalizedSubmissionDefinitionModel {
-}
diff --git a/src/app/core/config/models/normalized-config-submission-form.model.ts b/src/app/core/config/models/normalized-config-submission-form.model.ts
deleted file mode 100644
index afdfef4818..0000000000
--- a/src/app/core/config/models/normalized-config-submission-form.model.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-import { autoserialize, inheritSerialization } from 'cerialize';
-import { NormalizedConfigObject } from './normalized-config.model';
-import { mapsTo } from '../../cache/builders/build-decorators';
-import { FormRowModel, SubmissionFormModel } from './config-submission-form.model';
-
-/**
- * Normalized class for the configuration describing the submission form
- */
-@mapsTo(SubmissionFormModel)
-@inheritSerialization(NormalizedConfigObject)
-export class NormalizedSubmissionFormModel extends NormalizedConfigObject {
-
- /**
- * An array of [FormRowModel] that are present in this form
- */
- @autoserialize
- rows: FormRowModel[];
-}
diff --git a/src/app/core/config/models/normalized-config-submission-forms.model.ts b/src/app/core/config/models/normalized-config-submission-forms.model.ts
deleted file mode 100644
index c040a94587..0000000000
--- a/src/app/core/config/models/normalized-config-submission-forms.model.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-import { inheritSerialization } from 'cerialize';
-import { mapsTo } from '../../cache/builders/build-decorators';
-import { SubmissionFormsModel } from './config-submission-forms.model';
-import { NormalizedSubmissionFormModel } from './normalized-config-submission-form.model';
-
-/**
- * Normalized class for the configuration describing the submission form
- */
-@mapsTo(SubmissionFormsModel)
-@inheritSerialization(NormalizedSubmissionFormModel)
-export class NormalizedSubmissionFormsModel extends NormalizedSubmissionFormModel {
-}
diff --git a/src/app/core/config/models/normalized-config-submission-section.model.ts b/src/app/core/config/models/normalized-config-submission-section.model.ts
deleted file mode 100644
index 364a981060..0000000000
--- a/src/app/core/config/models/normalized-config-submission-section.model.ts
+++ /dev/null
@@ -1,41 +0,0 @@
-import { autoserialize, inheritSerialization } from 'cerialize';
-import { SectionsType } from '../../../submission/sections/sections-type';
-import { NormalizedConfigObject } from './normalized-config.model';
-import {
- SubmissionSectionModel,
- SubmissionSectionVisibility
-} from './config-submission-section.model';
-import { mapsTo } from '../../cache/builders/build-decorators';
-
-/**
- * Normalized class for the configuration describing the submission section
- */
-@mapsTo(SubmissionSectionModel)
-@inheritSerialization(NormalizedConfigObject)
-export class NormalizedSubmissionSectionModel extends NormalizedConfigObject {
-
- /**
- * The header for this section
- */
- @autoserialize
- header: string;
-
- /**
- * A boolean representing if this submission section is the mandatory or not
- */
- @autoserialize
- mandatory: boolean;
-
- /**
- * A string representing the kind of section object
- */
- @autoserialize
- sectionType: SectionsType;
-
- /**
- * The [SubmissionSectionVisibility] object for this section
- */
- @autoserialize
- visibility: SubmissionSectionVisibility
-
-}
diff --git a/src/app/core/config/models/normalized-config-submission-sections.model.ts b/src/app/core/config/models/normalized-config-submission-sections.model.ts
deleted file mode 100644
index fb1e4c671a..0000000000
--- a/src/app/core/config/models/normalized-config-submission-sections.model.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-import { autoserialize, inheritSerialization } from 'cerialize';
-import { SectionsType } from '../../../submission/sections/sections-type';
-import { NormalizedConfigObject } from './normalized-config.model';
-import {
- SubmissionSectionModel,
- SubmissionSectionVisibility
-} from './config-submission-section.model';
-import { mapsTo } from '../../cache/builders/build-decorators';
-import { SubmissionSectionsModel } from './config-submission-sections.model';
-import { NormalizedSubmissionSectionModel } from './normalized-config-submission-section.model';
-
-/**
- * Normalized class for the configuration describing the submission section
- */
-@mapsTo(SubmissionSectionsModel)
-@inheritSerialization(NormalizedSubmissionSectionModel)
-export class NormalizedSubmissionSectionsModel extends NormalizedSubmissionSectionModel {
-}
diff --git a/src/app/core/config/models/normalized-config-submission-uploads.model.ts b/src/app/core/config/models/normalized-config-submission-uploads.model.ts
deleted file mode 100644
index 7a21c15912..0000000000
--- a/src/app/core/config/models/normalized-config-submission-uploads.model.ts
+++ /dev/null
@@ -1,33 +0,0 @@
-import { autoserialize, autoserializeAs, inheritSerialization } from 'cerialize';
-import { AccessConditionOption } from './config-access-condition-option.model';
-import { SubmissionFormsModel } from './config-submission-forms.model';
-import { NormalizedConfigObject } from './normalized-config.model';
-import { SubmissionUploadsModel } from './config-submission-uploads.model';
-import { mapsTo } from '../../cache/builders/build-decorators';
-
-/**
- * Normalized class for the configuration describing the submission upload section
- */
-@mapsTo(SubmissionUploadsModel)
-@inheritSerialization(NormalizedConfigObject)
-export class NormalizedSubmissionUploadsModel extends NormalizedConfigObject {
-
- /**
- * A list of available bitstream access conditions
- */
- @autoserialize
- accessConditionOptions: AccessConditionOption[];
-
- /**
- * An object representing the configuration describing the bistream metadata form
- */
- @autoserializeAs(SubmissionFormsModel)
- metadata: SubmissionFormsModel;
-
- @autoserialize
- required: boolean;
-
- @autoserialize
- maxSize: number;
-
-}
diff --git a/src/app/core/config/models/normalized-config.model.ts b/src/app/core/config/models/normalized-config.model.ts
deleted file mode 100644
index 1bf4ffb826..0000000000
--- a/src/app/core/config/models/normalized-config.model.ts
+++ /dev/null
@@ -1,32 +0,0 @@
-import { autoserialize, inheritSerialization } from 'cerialize';
-import { NormalizedObject } from '../../cache/models/normalized-object.model';
-import { CacheableObject, TypedObject } from '../../cache/object-cache.reducer';
-import { ResourceType } from '../../shared/resource-type';
-
-/**
- * Normalized abstract class for a configuration object
- */
-@inheritSerialization(NormalizedObject)
-export abstract class NormalizedConfigObject implements CacheableObject {
-
- /**
- * The name for this configuration
- */
- @autoserialize
- public name: string;
-
- /**
- * The links to all related resources returned by the rest api.
- */
- @autoserialize
- public _links: {
- [name: string]: string
- };
-
- /**
- * The link to the rest endpoint where this config object can be found
- */
- @autoserialize
- self: string;
-
-}
diff --git a/src/app/core/core.module.ts b/src/app/core/core.module.ts
index e2c8e1a3b5..9180b0882a 100644
--- a/src/app/core/core.module.ts
+++ b/src/app/core/core.module.ts
@@ -1,149 +1,149 @@
-import { ModuleWithProviders, NgModule, Optional, SkipSelf } from '@angular/core';
import { CommonModule } from '@angular/common';
-
-import { StoreModule } from '@ngrx/store';
-import { EffectsModule } from '@ngrx/effects';
+import { HTTP_INTERCEPTORS, HttpClient } from '@angular/common/http';
+import { ModuleWithProviders, NgModule, Optional, SkipSelf } from '@angular/core';
import {
DynamicFormLayoutService,
DynamicFormService,
DynamicFormValidationService
} from '@ng-dynamic-forms/core';
+import { EffectsModule } from '@ngrx/effects';
-import { coreEffects } from './core.effects';
-import { coreReducers } from './core.reducers';
+import { StoreModule } from '@ngrx/store';
+import { MyDSpaceGuard } from '../+my-dspace-page/my-dspace.guard';
+import { ENV_CONFIG, GLOBAL_CONFIG, GlobalConfig } from '../../config';
import { isNotEmpty } from '../shared/empty.util';
-
-import { ApiService } from './services/api.service';
-import { BrowseEntriesResponseParsingService } from './data/browse-entries-response-parsing.service';
-import { CollectionDataService } from './data/collection-data.service';
-import { CommunityDataService } from './data/community-data.service';
-import { DebugResponseParsingService } from './data/debug-response-parsing.service';
-import { DSOResponseParsingService } from './data/dso-response-parsing.service';
-import { SearchResponseParsingService } from './data/search-response-parsing.service';
-import { DSpaceRESTv2Service } from './dspace-rest-v2/dspace-rest-v2.service';
import { FormBuilderService } from '../shared/form/builder/form-builder.service';
-import { SectionFormOperationsService } from '../submission/sections/form/section-form-operations.service';
import { FormService } from '../shared/form/form.service';
-import { GroupEpersonService } from './eperson/group-eperson.service';
import { HostWindowService } from '../shared/host-window.service';
-import { ItemDataService } from './data/item-data.service';
-import { MetadataService } from './metadata/metadata.service';
-import { ObjectCacheService } from './cache/object-cache.service';
-import { PaginationComponentOptions } from '../shared/pagination/pagination-component-options.model';
-import { RemoteDataBuildService } from './cache/builders/remote-data-build.service';
-import { RequestService } from './data/request.service';
-import { EndpointMapResponseParsingService } from './data/endpoint-map-response-parsing.service';
-import { ServerResponseService } from './services/server-response.service';
-import { NativeWindowFactory, NativeWindowService } from './services/window.service';
-import { BrowseService } from './browse/browse.service';
-import { BrowseResponseParsingService } from './data/browse-response-parsing.service';
-import { ConfigResponseParsingService } from './config/config-response-parsing.service';
-import { RouteService } from './services/route.service';
-import { SubmissionDefinitionsConfigService } from './config/submission-definitions-config.service';
-import { SubmissionFormsConfigService } from './config/submission-forms-config.service';
-import { SubmissionSectionsConfigService } from './config/submission-sections-config.service';
-import { SubmissionResponseParsingService } from './submission/submission-response-parsing.service';
-import { EpersonResponseParsingService } from './eperson/eperson-response-parsing.service';
-import { JsonPatchOperationsBuilder } from './json-patch/builder/json-patch-operations-builder';
-import { AuthorityService } from './integration/authority.service';
-import { IntegrationResponseParsingService } from './integration/integration-response-parsing.service';
-import { WorkspaceitemDataService } from './submission/workspaceitem-data.service';
-import { UUIDService } from './shared/uuid.service';
-import { AuthenticatedGuard } from './auth/authenticated.guard';
-import { AuthRequestService } from './auth/auth-request.service';
-import { AuthResponseParsingService } from './auth/auth-response-parsing.service';
-import { HTTP_INTERCEPTORS, HttpClient } from '@angular/common/http';
-import { AuthInterceptor } from './auth/auth.interceptor';
-import { HALEndpointService } from './shared/hal-endpoint.service';
-import { FacetValueResponseParsingService } from './data/facet-value-response-parsing.service';
-import { FacetValueMapResponseParsingService } from './data/facet-value-map-response-parsing.service';
-import { FacetConfigResponseParsingService } from './data/facet-config-response-parsing.service';
-import { ResourcePolicyService } from './data/resource-policy.service';
-import { RegistryService } from './registry/registry.service';
-import { RegistryMetadataschemasResponseParsingService } from './data/registry-metadataschemas-response-parsing.service';
-import { RegistryMetadatafieldsResponseParsingService } from './data/registry-metadatafields-response-parsing.service';
-import { RegistryBitstreamformatsResponseParsingService } from './data/registry-bitstreamformats-response-parsing.service';
-import { WorkflowItemDataService } from './submission/workflowitem-data.service';
-import { NotificationsService } from '../shared/notifications/notifications.service';
-import { UploaderService } from '../shared/uploader/uploader.service';
-import { FileService } from './shared/file.service';
-import { SubmissionRestService } from './submission/submission-rest.service';
-import { BrowseItemsResponseParsingService } from './data/browse-items-response-parsing-service';
-import { DSpaceObjectDataService } from './data/dspace-object-data.service';
-import { MetadataschemaParsingService } from './data/metadataschema-parsing.service';
-import { FilteredDiscoveryPageResponseParsingService } from './data/filtered-discovery-page-response-parsing.service';
-import { CSSVariableService } from '../shared/sass-helper/sass-helper.service';
import { MenuService } from '../shared/menu/menu.service';
-import { SubmissionJsonPatchOperationsService } from './submission/submission-json-patch-operations.service';
-import { NormalizedObjectBuildService } from './cache/builders/normalized-object-build.service';
-import { DSOChangeAnalyzer } from './data/dso-change-analyzer.service';
-import { ObjectUpdatesService } from './data/object-updates/object-updates.service';
-import { DefaultChangeAnalyzer } from './data/default-change-analyzer.service';
-import { SearchService } from './shared/search/search.service';
-import { RelationshipService } from './data/relationship.service';
-import { NormalizedCollection } from './cache/models/normalized-collection.model';
-import { NormalizedCommunity } from './cache/models/normalized-community.model';
-import { NormalizedDSpaceObject } from './cache/models/normalized-dspace-object.model';
-import { NormalizedBitstream } from './cache/models/normalized-bitstream.model';
-import { NormalizedBundle } from './cache/models/normalized-bundle.model';
-import { NormalizedBitstreamFormat } from './cache/models/normalized-bitstream-format.model';
-import { NormalizedItem } from './cache/models/normalized-item.model';
-import { NormalizedEPerson } from './eperson/models/normalized-eperson.model';
-import { NormalizedGroup } from './eperson/models/normalized-group.model';
-import { NormalizedResourcePolicy } from './cache/models/normalized-resource-policy.model';
-import { NormalizedMetadataSchema } from './metadata/normalized-metadata-schema.model';
-import { NormalizedMetadataField } from './metadata/normalized-metadata-field.model';
-import { NormalizedLicense } from './cache/models/normalized-license.model';
-import { NormalizedWorkflowItem } from './submission/models/normalized-workflowitem.model';
-import { NormalizedWorkspaceItem } from './submission/models/normalized-workspaceitem.model';
-import { NormalizedSubmissionDefinitionsModel } from './config/models/normalized-config-submission-definitions.model';
-import { NormalizedSubmissionFormsModel } from './config/models/normalized-config-submission-forms.model';
-import { NormalizedSubmissionSectionModel } from './config/models/normalized-config-submission-section.model';
-import { NormalizedAuthStatus } from './auth/models/normalized-auth-status.model';
-import { NormalizedAuthorityValue } from './integration/models/normalized-authority-value.model';
-import { RoleService } from './roles/role.service';
-import { MyDSpaceGuard } from '../+my-dspace-page/my-dspace.guard';
-import { MyDSpaceResponseParsingService } from './data/mydspace-response-parsing.service';
-import { ClaimedTaskDataService } from './tasks/claimed-task-data.service';
-import { PoolTaskDataService } from './tasks/pool-task-data.service';
-import { TaskResponseParsingService } from './tasks/task-response-parsing.service';
-import { BitstreamFormatDataService } from './data/bitstream-format-data.service';
-import { NormalizedClaimedTask } from './tasks/models/normalized-claimed-task-object.model';
-import { NormalizedTaskObject } from './tasks/models/normalized-task-object.model';
-import { NormalizedPoolTask } from './tasks/models/normalized-pool-task-object.model';
-import { NormalizedRelationship } from './cache/models/items/normalized-relationship.model';
-import { NormalizedRelationshipType } from './cache/models/items/normalized-relationship-type.model';
-import { NormalizedItemType } from './cache/models/items/normalized-item-type.model';
-import { MetadatafieldParsingService } from './data/metadatafield-parsing.service';
-import { NormalizedSubmissionUploadsModel } from './config/models/normalized-config-submission-uploads.model';
-import { NormalizedBrowseEntry } from './shared/normalized-browse-entry.model';
-import { BrowseDefinition } from './shared/browse-definition.model';
-import { BitstreamDataService } from './data/bitstream-data.service';
-import { ContentSourceResponseParsingService } from './data/content-source-response-parsing.service';
-import { MappedCollectionsReponseParsingService } from './data/mapped-collections-reponse-parsing.service';
-import { ObjectSelectService } from '../shared/object-select/object-select.service';
-import { ArrayMoveChangeAnalyzer } from './data/array-move-change-analyzer.service';
-import { EntityTypeService } from './data/entity-type.service';
-import { SiteDataService } from './data/site-data.service';
-import { NormalizedSite } from './cache/models/normalized-site.model';
+import { EndpointMockingRestService } from '../shared/mocks/dspace-rest-v2/endpoint-mocking-rest.service';
import {
MOCK_RESPONSE_MAP,
MockResponseMap,
mockResponseMap
} from '../shared/mocks/dspace-rest-v2/mocks/mock-response-map';
-import { EndpointMockingRestService } from '../shared/mocks/dspace-rest-v2/endpoint-mocking-rest.service';
-import { ENV_CONFIG, GLOBAL_CONFIG, GlobalConfig } from '../../config';
-import { SearchFilterService } from './shared/search/search-filter.service';
-import { SearchConfigurationService } from './shared/search/search-configuration.service';
+import { NotificationsService } from '../shared/notifications/notifications.service';
import { SelectableListService } from '../shared/object-list/selectable-list/selectable-list.service';
-import { RelationshipTypeService } from './data/relationship-type.service';
+import { ObjectSelectService } from '../shared/object-select/object-select.service';
+import { PaginationComponentOptions } from '../shared/pagination/pagination-component-options.model';
+import { CSSVariableService } from '../shared/sass-helper/sass-helper.service';
import { SidebarService } from '../shared/sidebar/sidebar.service';
-import { NormalizedExternalSource } from './cache/models/normalized-external-source.model';
-import { NormalizedExternalSourceEntry } from './cache/models/normalized-external-source-entry.model';
+import { UploaderService } from '../shared/uploader/uploader.service';
+import { SectionFormOperationsService } from '../submission/sections/form/section-form-operations.service';
+import { AuthRequestService } from './auth/auth-request.service';
+import { AuthResponseParsingService } from './auth/auth-response-parsing.service';
+import { AuthInterceptor } from './auth/auth.interceptor';
+import { AuthenticatedGuard } from './auth/authenticated.guard';
+import { AuthStatus } from './auth/models/auth-status.model';
+import { BrowseService } from './browse/browse.service';
+import { RemoteDataBuildService } from './cache/builders/remote-data-build.service';
+import { ObjectCacheService } from './cache/object-cache.service';
+import { ConfigResponseParsingService } from './config/config-response-parsing.service';
+import { SubmissionDefinitionsModel } from './config/models/config-submission-definitions.model';
+import { SubmissionFormsModel } from './config/models/config-submission-forms.model';
+import { SubmissionSectionModel } from './config/models/config-submission-section.model';
+import { SubmissionUploadsModel } from './config/models/config-submission-uploads.model';
+import { SubmissionDefinitionsConfigService } from './config/submission-definitions-config.service';
+import { SubmissionFormsConfigService } from './config/submission-forms-config.service';
+import { SubmissionSectionsConfigService } from './config/submission-sections-config.service';
+
+import { coreEffects } from './core.effects';
+import { coreReducers } from './core.reducers';
+import { BitstreamFormatDataService } from './data/bitstream-format-data.service';
+import { BrowseEntriesResponseParsingService } from './data/browse-entries-response-parsing.service';
+import { BrowseItemsResponseParsingService } from './data/browse-items-response-parsing-service';
+import { BrowseResponseParsingService } from './data/browse-response-parsing.service';
+import { CollectionDataService } from './data/collection-data.service';
+import { CommunityDataService } from './data/community-data.service';
+import { ContentSourceResponseParsingService } from './data/content-source-response-parsing.service';
+import { DebugResponseParsingService } from './data/debug-response-parsing.service';
+import { DefaultChangeAnalyzer } from './data/default-change-analyzer.service';
+import { DSOChangeAnalyzer } from './data/dso-change-analyzer.service';
+import { DSOResponseParsingService } from './data/dso-response-parsing.service';
+import { DSpaceObjectDataService } from './data/dspace-object-data.service';
+import { EndpointMapResponseParsingService } from './data/endpoint-map-response-parsing.service';
+import { ItemTypeDataService } from './data/entity-type-data.service';
+import { EntityTypeService } from './data/entity-type.service';
import { ExternalSourceService } from './data/external-source.service';
+import { FacetConfigResponseParsingService } from './data/facet-config-response-parsing.service';
+import { FacetValueMapResponseParsingService } from './data/facet-value-map-response-parsing.service';
+import { FacetValueResponseParsingService } from './data/facet-value-response-parsing.service';
+import { FilteredDiscoveryPageResponseParsingService } from './data/filtered-discovery-page-response-parsing.service';
+import { ItemDataService } from './data/item-data.service';
+import { LicenseDataService } from './data/license-data.service';
import { LookupRelationService } from './data/lookup-relation.service';
+import { MappedCollectionsReponseParsingService } from './data/mapped-collections-reponse-parsing.service';
+import { MetadatafieldParsingService } from './data/metadatafield-parsing.service';
+import { MetadataschemaParsingService } from './data/metadataschema-parsing.service';
+import { MyDSpaceResponseParsingService } from './data/mydspace-response-parsing.service';
+import { ObjectUpdatesService } from './data/object-updates/object-updates.service';
+import { RegistryBitstreamformatsResponseParsingService } from './data/registry-bitstreamformats-response-parsing.service';
+import { RegistryMetadatafieldsResponseParsingService } from './data/registry-metadatafields-response-parsing.service';
+import { RegistryMetadataschemasResponseParsingService } from './data/registry-metadataschemas-response-parsing.service';
+import { RelationshipTypeService } from './data/relationship-type.service';
+import { RelationshipService } from './data/relationship.service';
+import { ResourcePolicyService } from './data/resource-policy.service';
+import { SearchResponseParsingService } from './data/search-response-parsing.service';
+import { SiteDataService } from './data/site-data.service';
+import { DSpaceRESTv2Service } from './dspace-rest-v2/dspace-rest-v2.service';
+import { EPersonDataService } from './eperson/eperson-data.service';
+import { EpersonResponseParsingService } from './eperson/eperson-response-parsing.service';
+import { EPerson } from './eperson/models/eperson.model';
+import { Group } from './eperson/models/group.model';
+import { AuthorityService } from './integration/authority.service';
+import { IntegrationResponseParsingService } from './integration/integration-response-parsing.service';
+import { AuthorityValue } from './integration/models/authority.value';
+import { JsonPatchOperationsBuilder } from './json-patch/builder/json-patch-operations-builder';
+import { MetadataField } from './metadata/metadata-field.model';
+import { MetadataSchema } from './metadata/metadata-schema.model';
+import { MetadataService } from './metadata/metadata.service';
+import { RegistryService } from './registry/registry.service';
+import { RoleService } from './roles/role.service';
+
+import { ApiService } from './services/api.service';
+import { RouteService } from './services/route.service';
+import { ServerResponseService } from './services/server-response.service';
+import { NativeWindowFactory, NativeWindowService } from './services/window.service';
+import { BitstreamFormat } from './shared/bitstream-format.model';
+import { Bitstream } from './shared/bitstream.model';
+import { BrowseDefinition } from './shared/browse-definition.model';
+import { BrowseEntry } from './shared/browse-entry.model';
+import { Bundle } from './shared/bundle.model';
+import { Collection } from './shared/collection.model';
+import { Community } from './shared/community.model';
+import { DSpaceObject } from './shared/dspace-object.model';
+import { ExternalSourceEntry } from './shared/external-source-entry.model';
+import { ExternalSource } from './shared/external-source.model';
+import { FileService } from './shared/file.service';
+import { HALEndpointService } from './shared/hal-endpoint.service';
+import { ItemType } from './shared/item-relationships/item-type.model';
+import { RelationshipType } from './shared/item-relationships/relationship-type.model';
+import { Relationship } from './shared/item-relationships/relationship.model';
+import { Item } from './shared/item.model';
+import { License } from './shared/license.model';
+import { ResourcePolicy } from './shared/resource-policy.model';
+import { SearchConfigurationService } from './shared/search/search-configuration.service';
+import { SearchFilterService } from './shared/search/search-filter.service';
+import { SearchService } from './shared/search/search.service';
+import { Site } from './shared/site.model';
+import { UUIDService } from './shared/uuid.service';
+import { WorkflowItem } from './submission/models/workflowitem.model';
+import { WorkspaceItem } from './submission/models/workspaceitem.model';
+import { SubmissionJsonPatchOperationsService } from './submission/submission-json-patch-operations.service';
+import { SubmissionResponseParsingService } from './submission/submission-response-parsing.service';
+import { SubmissionRestService } from './submission/submission-rest.service';
+import { WorkflowItemDataService } from './submission/workflowitem-data.service';
+import { WorkspaceitemDataService } from './submission/workspaceitem-data.service';
+import { ClaimedTaskDataService } from './tasks/claimed-task-data.service';
+import { ClaimedTask } from './tasks/models/claimed-task-object.model';
+import { PoolTask } from './tasks/models/pool-task-object.model';
+import { TaskObject } from './tasks/models/task-object.model';
+import { PoolTaskDataService } from './tasks/pool-task-data.service';
+import { TaskResponseParsingService } from './tasks/task-response-parsing.service';
+import { ArrayMoveChangeAnalyzer } from './data/array-move-change-analyzer.service';
+import { BitstreamDataService } from './data/bitstream-data.service';
/**
* When not in production, endpoint responses can be mocked for testing purposes
@@ -185,7 +185,7 @@ const PROVIDERS = [
SectionFormOperationsService,
FormService,
EpersonResponseParsingService,
- GroupEpersonService,
+ EPersonDataService,
HALEndpointService,
HostWindowService,
ItemDataService,
@@ -195,9 +195,7 @@ const PROVIDERS = [
ResourcePolicyService,
RegistryService,
BitstreamFormatDataService,
- NormalizedObjectBuildService,
RemoteDataBuildService,
- RequestService,
EndpointMapResponseParsingService,
FacetValueResponseParsingService,
FacetValueMapResponseParsingService,
@@ -261,6 +259,8 @@ const PROVIDERS = [
RelationshipTypeService,
ExternalSourceService,
LookupRelationService,
+ LicenseDataService,
+ ItemTypeDataService,
// register AuthInterceptor as HttpInterceptor
{
provide: HTTP_INTERCEPTORS,
@@ -275,40 +275,40 @@ const PROVIDERS = [
/**
* Declaration needed to make sure all decorator functions are called in time
*/
-export const normalizedModels =
+export const models =
[
- NormalizedDSpaceObject,
- NormalizedBundle,
- NormalizedBitstream,
- NormalizedBitstreamFormat,
- NormalizedItem,
- NormalizedSite,
- NormalizedCollection,
- NormalizedCommunity,
- NormalizedEPerson,
- NormalizedGroup,
- NormalizedResourcePolicy,
- NormalizedMetadataSchema,
- NormalizedMetadataField,
- NormalizedLicense,
- NormalizedWorkflowItem,
- NormalizedWorkspaceItem,
- NormalizedSubmissionDefinitionsModel,
- NormalizedSubmissionFormsModel,
- NormalizedSubmissionSectionModel,
- NormalizedSubmissionUploadsModel,
- NormalizedAuthStatus,
- NormalizedAuthorityValue,
- NormalizedBrowseEntry,
+ DSpaceObject,
+ Bundle,
+ Bitstream,
+ BitstreamFormat,
+ Item,
+ Site,
+ Collection,
+ Community,
+ EPerson,
+ Group,
+ ResourcePolicy,
+ MetadataSchema,
+ MetadataField,
+ License,
+ WorkflowItem,
+ WorkspaceItem,
+ SubmissionDefinitionsModel,
+ SubmissionFormsModel,
+ SubmissionSectionModel,
+ SubmissionUploadsModel,
+ AuthStatus,
+ AuthorityValue,
+ BrowseEntry,
BrowseDefinition,
- NormalizedClaimedTask,
- NormalizedTaskObject,
- NormalizedPoolTask,
- NormalizedRelationship,
- NormalizedRelationshipType,
- NormalizedItemType,
- NormalizedExternalSource,
- NormalizedExternalSourceEntry
+ ClaimedTask,
+ TaskObject,
+ PoolTask,
+ Relationship,
+ RelationshipType,
+ ItemType,
+ ExternalSource,
+ ExternalSourceEntry,
];
@NgModule({
diff --git a/src/app/core/data/array-move-change-analyzer.service.ts b/src/app/core/data/array-move-change-analyzer.service.ts
index 91dd7809e0..39d22fc463 100644
--- a/src/app/core/data/array-move-change-analyzer.service.ts
+++ b/src/app/core/data/array-move-change-analyzer.service.ts
@@ -1,9 +1,5 @@
-import { MoveOperation, Operation } from 'fast-json-patch/lib/core';
-import { compare } from 'fast-json-patch';
-import { ChangeAnalyzer } from './change-analyzer';
+import { MoveOperation } from 'fast-json-patch/lib/core';
import { Injectable } from '@angular/core';
-import { CacheableObject } from '../cache/object-cache.reducer';
-import { NormalizedObject } from '../cache/models/normalized-object.model';
import { moveItemInArray } from '@angular/cdk/drag-drop';
import { hasValue } from '../../shared/empty.util';
diff --git a/src/app/core/data/base-response-parsing.service.ts b/src/app/core/data/base-response-parsing.service.ts
index ea2d71faa7..3615ab4023 100644
--- a/src/app/core/data/base-response-parsing.service.ts
+++ b/src/app/core/data/base-response-parsing.service.ts
@@ -1,21 +1,45 @@
import { hasNoValue, hasValue, isNotEmpty } from '../../shared/empty.util';
-import { DSpaceRESTv2Serializer } from '../dspace-rest-v2/dspace-rest-v2.serializer';
+import { DSpaceSerializer } from '../dspace-rest-v2/dspace.serializer';
import { CacheableObject } from '../cache/object-cache.reducer';
+import { Serializer } from '../serializer';
import { PageInfo } from '../shared/page-info.model';
import { ObjectCacheService } from '../cache/object-cache.service';
import { GlobalConfig } from '../../../config/global-config.interface';
import { GenericConstructor } from '../shared/generic-constructor';
import { PaginatedList } from './paginated-list';
-import { isRestDataObject, isRestPaginatedList } from '../cache/builders/normalized-object-build.service';
-import { ResourceType } from '../shared/resource-type';
-import { getMapsToType } from '../cache/builders/build-decorators';
+import { getClassForType } from '../cache/builders/build-decorators';
import { RestRequest } from './request.models';
/* tslint:disable:max-classes-per-file */
+/**
+ * Return true if halObj has a value for `_links.self`
+ *
+ * @param {any} halObj The object to test
+ */
+export function isRestDataObject(halObj: any): boolean {
+ return isNotEmpty(halObj._links) && hasValue(halObj._links.self);
+}
+
+/**
+ * Return true if halObj has a value for `page` with properties
+ * `size`, `totalElements`, `totalPages`, `number`
+ *
+ * @param {any} halObj The object to test
+ */
+export function isRestPaginatedList(halObj: any): boolean {
+ return hasValue(halObj.page) &&
+ hasValue(halObj.page.size) &&
+ hasValue(halObj.page.totalElements) &&
+ hasValue(halObj.page.totalPages) &&
+ hasValue(halObj.page.number);
+}
+
export abstract class BaseResponseParsingService {
protected abstract EnvConfig: GlobalConfig;
protected abstract objectCache: ObjectCacheService;
protected abstract toCache: boolean;
+ protected shouldDirectlyAttachEmbeds = false;
+ protected serializerConstructor: GenericConstructor> = DSpaceSerializer;
protected process(data: any, request: RestRequest): any {
if (isNotEmpty(data)) {
@@ -33,20 +57,20 @@ export abstract class BaseResponseParsingService {
.filter((property) => data._embedded.hasOwnProperty(property))
.forEach((property) => {
const parsedObj = this.process(data._embedded[property], request);
- if (isNotEmpty(parsedObj)) {
- if (isRestPaginatedList(data._embedded[property])) {
- object[property] = parsedObj;
- object[property].page = parsedObj.page.map((obj) => this.retrieveObjectOrUrl(obj));
- } else if (isRestDataObject(data._embedded[property])) {
- object[property] = this.retrieveObjectOrUrl(parsedObj);
- } else if (Array.isArray(parsedObj)) {
- object[property] = parsedObj.map((obj) => this.retrieveObjectOrUrl(obj))
- }
+ if (this.shouldDirectlyAttachEmbeds && isNotEmpty(parsedObj)) {
+ if (isRestPaginatedList(data._embedded[property])) {
+ object[property] = parsedObj;
+ object[property].page = parsedObj.page.map((obj) => this.retrieveObjectOrUrl(obj));
+ } else if (isRestDataObject(data._embedded[property])) {
+ object[property] = this.retrieveObjectOrUrl(parsedObj);
+ } else if (Array.isArray(parsedObj)) {
+ object[property] = parsedObj.map((obj) => this.retrieveObjectOrUrl(obj))
+ }
}
});
}
- this.cache(object, request);
+ this.cache(object, request, data);
return object;
}
const result = {};
@@ -87,33 +111,38 @@ export abstract class BaseResponseParsingService {
protected deserialize(obj): any {
const type: string = obj.type;
if (hasValue(type)) {
- const normObjConstructor = getMapsToType(type) as GenericConstructor;
+ const objConstructor = getClassForType(type) as GenericConstructor;
- if (hasValue(normObjConstructor)) {
- const serializer = new DSpaceRESTv2Serializer(normObjConstructor);
+ if (hasValue(objConstructor)) {
+ const serializer = new this.serializerConstructor(objConstructor);
return serializer.deserialize(obj);
} else {
- // TODO: move check to Validator?
- // throw new Error(`The server returned an object with an unknown a known type: ${type}`);
return null;
}
} else {
- // TODO: move check to Validator
- // throw new Error(`The server returned an object without a type: ${JSON.stringify(obj)}`);
return null;
}
}
- protected cache(obj, request: RestRequest) {
+ protected cache(obj, request: RestRequest, data: any) {
if (this.toCache) {
- this.addToObjectCache(obj, request);
+ this.addToObjectCache(obj, request, data);
}
}
- protected addToObjectCache(co: CacheableObject, request: RestRequest): void {
- if (hasNoValue(co) || hasNoValue(co.self)) {
- throw new Error('The server returned an invalid object');
+ protected addToObjectCache(co: CacheableObject, request: RestRequest, data: any): void {
+ if (hasNoValue(co) || hasNoValue(co._links) || hasNoValue(co._links.self) || hasNoValue(co._links.self.href)) {
+ const type = hasValue(data) && hasValue(data.type) ? data.type : 'object';
+ let dataJSON: string;
+ if (hasValue(data._embedded)) {
+ dataJSON = JSON.stringify(Object.assign({}, data, {
+ _embedded: '...'
+ }));
+ } else {
+ dataJSON = JSON.stringify(data);
+ }
+ throw new Error(`Can't cache incomplete ${type}: ${JSON.stringify(co)}, parsed from (partial) response: ${dataJSON}`);
}
this.objectCache.add(co, hasValue(request.responseMsToLive) ? request.responseMsToLive : this.EnvConfig.cache.msToLive.default, request.uuid);
}
@@ -121,7 +150,7 @@ export abstract class BaseResponseParsingService {
processPageInfo(payload: any): PageInfo {
if (hasValue(payload.page)) {
const pageObj = Object.assign({}, payload.page, { _links: payload._links });
- const pageInfoObject = new DSpaceRESTv2Serializer(PageInfo).deserialize(pageObj);
+ const pageInfoObject = new DSpaceSerializer(PageInfo).deserialize(pageObj);
if (pageInfoObject.currentPage >= 0) {
Object.assign(pageInfoObject, { currentPage: pageInfoObject.currentPage + 1 });
}
@@ -140,7 +169,7 @@ export abstract class BaseResponseParsingService {
}
protected retrieveObjectOrUrl(obj: any): any {
- return this.toCache ? obj.self : obj;
+ return this.toCache ? obj._links.self.href : obj;
}
protected isSuccessStatus(statusCode: number) {
diff --git a/src/app/core/data/bitstream-data.service.ts b/src/app/core/data/bitstream-data.service.ts
index 39d30c9e08..ca402f6f95 100644
--- a/src/app/core/data/bitstream-data.service.ts
+++ b/src/app/core/data/bitstream-data.service.ts
@@ -1,61 +1,177 @@
-import { Injectable } from '@angular/core';
-import { DataService } from './data.service';
-import { Bitstream } from '../shared/bitstream.model';
-import { RequestService } from './request.service';
-import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
-import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service';
-import { Store } from '@ngrx/store';
-import { CoreState } from '../core.reducers';
-import { BrowseService } from '../browse/browse.service';
-import { ObjectCacheService } from '../cache/object-cache.service';
-import { HALEndpointService } from '../shared/hal-endpoint.service';
-import { NotificationsService } from '../../shared/notifications/notifications.service';
import { HttpClient, HttpHeaders } from '@angular/common/http';
-import { DSOChangeAnalyzer } from './dso-change-analyzer.service';
-import { FindListOptions, PutRequest } from './request.models';
+import { Injectable } from '@angular/core';
+import { Store } from '@ngrx/store';
import { Observable } from 'rxjs/internal/Observable';
-import { RestResponse } from '../cache/response.models';
-import { BitstreamFormatDataService } from './bitstream-format-data.service';
import { map, switchMap } from 'rxjs/operators';
-import { combineLatest as observableCombineLatest } from 'rxjs';
-import { HttpOptions } from '../dspace-rest-v2/dspace-rest-v2.service';
-import {
- configureRequest,
- getResponseFromEntry,
-} from '../shared/operators';
+import { hasValue, isNotEmpty } from '../../shared/empty.util';
+import { NotificationsService } from '../../shared/notifications/notifications.service';
+import { FollowLinkConfig } from '../../shared/utils/follow-link-config.model';
+import { dataService } from '../cache/builders/build-decorators';
+import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
+import { ObjectCacheService } from '../cache/object-cache.service';
+import { CoreState } from '../core.reducers';
+import { Bitstream } from '../shared/bitstream.model';
+import { BITSTREAM } from '../shared/bitstream.resource-type';
+import { Bundle } from '../shared/bundle.model';
+import { HALEndpointService } from '../shared/hal-endpoint.service';
+import { Item } from '../shared/item.model';
+import { BundleDataService } from './bundle-data.service';
+import { CommunityDataService } from './community-data.service';
+import { DataService } from './data.service';
+import { DSOChangeAnalyzer } from './dso-change-analyzer.service';
+import { PaginatedList } from './paginated-list';
+import { RemoteData } from './remote-data';
+import { RemoteDataError } from './remote-data-error';
+import { FindListOptions, PutRequest } from './request.models';
+import { RequestService } from './request.service';
+import { BitstreamFormatDataService } from './bitstream-format-data.service';
import { BitstreamFormat } from '../shared/bitstream-format.model';
+import { RestResponse } from '../cache/response.models';
+import { HttpOptions } from '../dspace-rest-v2/dspace-rest-v2.service';
+import { configureRequest, getResponseFromEntry } from '../shared/operators';
+import { combineLatest as observableCombineLatest } from 'rxjs';
/**
- * A service responsible for fetching/sending data from/to the REST API on the bitstreams endpoint
+ * A service to retrieve {@link Bitstream}s from the REST API
*/
-@Injectable()
+@Injectable({
+ providedIn: 'root'
+})
+@dataService(BITSTREAM)
export class BitstreamDataService extends DataService {
+
+ /**
+ * The HAL path to the bitstream endpoint
+ */
protected linkPath = 'bitstreams';
- protected forceBypassCache = false;
constructor(
protected requestService: RequestService,
protected rdbService: RemoteDataBuildService,
- protected dataBuildService: NormalizedObjectBuildService,
protected store: Store,
- protected bs: BrowseService,
+ protected cds: CommunityDataService,
protected objectCache: ObjectCacheService,
protected halService: HALEndpointService,
protected notificationsService: NotificationsService,
protected http: HttpClient,
protected comparator: DSOChangeAnalyzer,
- protected bitstreamFormatService: BitstreamFormatDataService) {
+ protected bundleService: BundleDataService,
+ protected bitstreamFormatService: BitstreamFormatDataService
+ ) {
super();
}
/**
- * Get the endpoint for browsing bitstreams
- * @param {FindListOptions} options
- * @param linkPath
- * @returns {Observable}
+ * Retrieves the {@link Bitstream}s in a given bundle
+ *
+ * @param bundle the bundle to retrieve bitstreams from
+ * @param options options for the find all request
*/
- getBrowseEndpoint(options: FindListOptions = {}, linkPath: string = this.linkPath): Observable {
- return this.halService.getEndpoint(linkPath);
+ findAllByBundle(bundle: Bundle, options?: FindListOptions, ...linksToFollow: Array>): Observable>> {
+ return this.findAllByHref(bundle._links.bitstreams.href, options, ...linksToFollow);
+ }
+
+ /**
+ * Retrieves the thumbnail for the given item
+ * @returns {Observable>} the first bitstream in the THUMBNAIL bundle
+ */
+ // TODO should be implemented rest side. {@link Item} should get a thumbnail link
+ public getThumbnailFor(item: Item): Observable> {
+ return this.bundleService.findByItemAndName(item, 'THUMBNAIL').pipe(
+ switchMap((bundleRD: RemoteData) => {
+ if (isNotEmpty(bundleRD.payload)) {
+ return this.findAllByBundle(bundleRD.payload, { elementsPerPage: 1 }).pipe(
+ map((bitstreamRD: RemoteData>) => {
+ if (hasValue(bitstreamRD.payload) && hasValue(bitstreamRD.payload.page)) {
+ return new RemoteData(
+ false,
+ false,
+ true,
+ undefined,
+ bitstreamRD.payload.page[0]
+ );
+ } else {
+ return bitstreamRD as any;
+ }
+ })
+ );
+ } else {
+ return [bundleRD as any];
+ }
+ })
+ );
+ }
+
+ /**
+ * Retrieve the matching thumbnail for a {@link Bitstream}.
+ *
+ * The {@link Item} is technically redundant, but is available
+ * in all current use cases, and having it simplifies this method
+ *
+ * @param item The {@link Item} the {@link Bitstream} and its thumbnail are a part of
+ * @param bitstreamInOriginal The original {@link Bitstream} to find the thumbnail for
+ */
+ // TODO should be implemented rest side
+ public getMatchingThumbnail(item: Item, bitstreamInOriginal: Bitstream): Observable> {
+ return this.bundleService.findByItemAndName(item, 'THUMBNAIL').pipe(
+ switchMap((bundleRD: RemoteData) => {
+ if (isNotEmpty(bundleRD.payload)) {
+ return this.findAllByBundle(bundleRD.payload, { elementsPerPage: Number.MAX_SAFE_INTEGER }).pipe(
+ map((bitstreamRD: RemoteData>) => {
+ if (hasValue(bitstreamRD.payload) && hasValue(bitstreamRD.payload.page)) {
+ const matchingThumbnail = bitstreamRD.payload.page.find((thumbnail: Bitstream) =>
+ thumbnail.name.startsWith(bitstreamInOriginal.name)
+ );
+ if (hasValue(matchingThumbnail)) {
+ return new RemoteData(
+ false,
+ false,
+ true,
+ undefined,
+ matchingThumbnail
+ );
+ } else {
+ return new RemoteData(
+ false,
+ false,
+ false,
+ new RemoteDataError(404, '404', 'No matching thumbnail found'),
+ undefined
+ );
+ }
+ } else {
+ return bitstreamRD as any;
+ }
+ })
+ );
+ } else {
+ return [bundleRD as any];
+ }
+ })
+ );
+ }
+
+ /**
+ * Retrieve all {@link Bitstream}s in a certain {@link Bundle}.
+ *
+ * The {@link Item} is technically redundant, but is available
+ * in all current use cases, and having it simplifies this method
+ *
+ * @param item the {@link Item} the {@link Bundle} is a part of
+ * @param bundleName the name of the {@link Bundle} we want to find {@link Bitstream}s for
+ * @param options the {@link FindListOptions} for the request
+ * @param linksToFollow the {@link FollowLinkConfig}s for the request
+ */
+ public findAllByItemAndBundleName(item: Item, bundleName: string, options?: FindListOptions, ...linksToFollow: Array>): Observable>> {
+ return this.bundleService.findByItemAndName(item, bundleName).pipe(
+ switchMap((bundleRD: RemoteData) => {
+ if (hasValue(bundleRD.payload)) {
+ return this.findAllByBundle(bundleRD.payload, options, ...linksToFollow);
+ } else {
+ return [bundleRD as any];
+ }
+ })
+ );
}
/**
@@ -87,4 +203,5 @@ export class BitstreamDataService extends DataService {
getResponseFromEntry()
);
}
+
}
diff --git a/src/app/core/data/bitstream-format-data.service.spec.ts b/src/app/core/data/bitstream-format-data.service.spec.ts
index c626fcd6e2..7954416010 100644
--- a/src/app/core/data/bitstream-format-data.service.spec.ts
+++ b/src/app/core/data/bitstream-format-data.service.spec.ts
@@ -8,7 +8,6 @@ import { cold, getTestScheduler, hot } from 'jasmine-marbles';
import { HALEndpointService } from '../shared/hal-endpoint.service';
import { NotificationsService } from '../../shared/notifications/notifications.service';
import { HttpClient } from '@angular/common/http';
-import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service';
import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
import { BitstreamFormat } from '../shared/bitstream-format.model';
import { async } from '@angular/core/testing';
@@ -48,14 +47,12 @@ describe('BitstreamFormatDataService', () => {
const notificationsService = {} as NotificationsService;
const http = {} as HttpClient;
const comparator = {} as any;
- const dataBuildService = {} as NormalizedObjectBuildService;
const rdbService = {} as RemoteDataBuildService;
function initTestService(halService) {
return new BitstreamFormatDataService(
requestService,
rdbService,
- dataBuildService,
store,
objectCache,
halService,
@@ -285,7 +282,7 @@ describe('BitstreamFormatDataService', () => {
format.id = 'format-id';
const expected = cold('(b|)', {b: true});
- const result = service.delete(format);
+ const result = service.delete(format.id);
expect(result).toBeObservable(expected);
});
diff --git a/src/app/core/data/bitstream-format-data.service.ts b/src/app/core/data/bitstream-format-data.service.ts
index c30330a0a3..e8cf030a52 100644
--- a/src/app/core/data/bitstream-format-data.service.ts
+++ b/src/app/core/data/bitstream-format-data.service.ts
@@ -1,31 +1,34 @@
-import { Injectable } from '@angular/core';
-import { DataService } from './data.service';
-import { BitstreamFormat } from '../shared/bitstream-format.model';
-import { RequestService } from './request.service';
-import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
-import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service';
-import { createSelector, select, Store } from '@ngrx/store';
-import { ObjectCacheService } from '../cache/object-cache.service';
-import { HALEndpointService } from '../shared/hal-endpoint.service';
-import { NotificationsService } from '../../shared/notifications/notifications.service';
import { HttpClient } from '@angular/common/http';
-import { DefaultChangeAnalyzer } from './default-change-analyzer.service';
-import { DeleteByIDRequest, FindListOptions, PostRequest, PutRequest } from './request.models';
+import { Injectable } from '@angular/core';
+import { createSelector, select, Store } from '@ngrx/store';
import { Observable } from 'rxjs';
-import { find, map, tap } from 'rxjs/operators';
-import { configureRequest, getResponseFromEntry } from '../shared/operators';
import { distinctUntilChanged } from 'rxjs/internal/operators/distinctUntilChanged';
-import { RestResponse } from '../cache/response.models';
-import { BitstreamFormatRegistryState } from '../../+admin/admin-registries/bitstream-formats/bitstream-format.reducers';
+import { find, map, tap } from 'rxjs/operators';
import {
BitstreamFormatsRegistryDeselectAction,
BitstreamFormatsRegistryDeselectAllAction,
BitstreamFormatsRegistrySelectAction
} from '../../+admin/admin-registries/bitstream-formats/bitstream-format.actions';
+import { BitstreamFormatRegistryState } from '../../+admin/admin-registries/bitstream-formats/bitstream-format.reducers';
import { hasValue } from '../../shared/empty.util';
-import { RequestEntry } from './request.reducer';
+import { NotificationsService } from '../../shared/notifications/notifications.service';
+import { dataService } from '../cache/builders/build-decorators';
+import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
+import { ObjectCacheService } from '../cache/object-cache.service';
+import { RestResponse } from '../cache/response.models';
import { CoreState } from '../core.reducers';
import { coreSelector } from '../core.selectors';
+import { BitstreamFormat } from '../shared/bitstream-format.model';
+import { BITSTREAM_FORMAT } from '../shared/bitstream-format.resource-type';
+import { Bitstream } from '../shared/bitstream.model';
+import { HALEndpointService } from '../shared/hal-endpoint.service';
+import { configureRequest, getResponseFromEntry } from '../shared/operators';
+import { DataService } from './data.service';
+import { DefaultChangeAnalyzer } from './default-change-analyzer.service';
+import { RemoteData } from './remote-data';
+import { DeleteByIDRequest, PostRequest, PutRequest } from './request.models';
+import { RequestEntry } from './request.reducer';
+import { RequestService } from './request.service';
const bitstreamFormatsStateSelector = createSelector(
coreSelector,
@@ -38,6 +41,7 @@ const selectedBitstreamFormatSelector = createSelector(bitstreamFormatsStateSele
* A service responsible for fetching/sending data from/to the REST API on the bitstreamformats endpoint
*/
@Injectable()
+@dataService(BITSTREAM_FORMAT)
export class BitstreamFormatDataService extends DataService {
protected linkPath = 'bitstreamformats';
@@ -45,7 +49,6 @@ export class BitstreamFormatDataService extends DataService {
constructor(
protected requestService: RequestService,
protected rdbService: RemoteDataBuildService,
- protected dataBuildService: NormalizedObjectBuildService,
protected store: Store,
protected objectCache: ObjectCacheService,
protected halService: HALEndpointService,
@@ -55,16 +58,6 @@ export class BitstreamFormatDataService extends DataService {
super();
}
- /**
- * Get the endpoint for browsing bitstream formats
- * @param {FindListOptions} options
- * @param {string} linkPath
- * @returns {Observable
+
+
+