From 51e732e430ce3fa808e27f91326608e21482a5a4 Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Tue, 10 Mar 2020 17:06:59 +0100 Subject: [PATCH 01/13] 69432: Profile page intermediate commit --- resources/i18n/en.json5 | 34 ++++ src/app/app-routing.module.ts | 1 + .../profile-page-metadata-form.component.html | 5 + .../profile-page-metadata-form.component.ts | 147 ++++++++++++++++++ .../profile-page-routing.module.ts | 15 ++ .../profile-page-security-form.component.html | 6 + .../profile-page-security-form.component.ts | 56 +++++++ .../profile-page/profile-page.component.html | 18 +++ .../profile-page/profile-page.component.ts | 35 +++++ src/app/profile-page/profile-page.module.ts | 23 +++ 10 files changed, 340 insertions(+) create mode 100644 src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.html create mode 100644 src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts create mode 100644 src/app/profile-page/profile-page-routing.module.ts create mode 100644 src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html create mode 100644 src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts create mode 100644 src/app/profile-page/profile-page.component.html create mode 100644 src/app/profile-page/profile-page.component.ts create mode 100644 src/app/profile-page/profile-page.module.ts diff --git a/resources/i18n/en.json5 b/resources/i18n/en.json5 index cfa202fe4a..82f295f28e 100644 --- a/resources/i18n/en.json5 +++ b/resources/i18n/en.json5 @@ -1411,6 +1411,40 @@ + "profile.breadcrumbs": "Update Profile", + + "profile.card.identify": "Identify", + + "profile.card.security": "Security", + + "profile.form.submit": "Update Profile", + + "profile.head": "Update Profile", + + "profile.metadata.form.error.firstname": "First Name is required", + + "profile.metadata.form.error.lastname": "Last Name is required", + + "profile.metadata.form.label.email": "Email Address", + + "profile.metadata.form.label.firstname": "First Name", + + "profile.metadata.form.label.language": "Language", + + "profile.metadata.form.label.lastname": "Last Name", + + "profile.metadata.form.label.phone": "Contact Telephone", + + "profile.security.form.info": "Optionally, you can enter a new password in the box below, and confirm it by typing it again into the second box. It should be at least six characters long.", + + "profile.security.form.label.password": "Password", + + "profile.security.form.label.passwordrepeat": "Retype to confirm", + + "profile.title": "Update Profile", + + + "project.listelement.badge": "Research Project", "project.page.contributor": "Contributors", diff --git a/src/app/app-routing.module.ts b/src/app/app-routing.module.ts index 4cf5efae41..da2b896241 100644 --- a/src/app/app-routing.module.ts +++ b/src/app/app-routing.module.ts @@ -68,6 +68,7 @@ export function getDSOPath(dso: DSpaceObject): string { { path: 'submit', loadChildren: './+submit-page/submit-page.module#SubmitPageModule' }, { path: 'workspaceitems', loadChildren: './+workspaceitems-edit-page/workspaceitems-edit-page.module#WorkspaceitemsEditPageModule' }, { path: 'workflowitems', loadChildren: './+workflowitems-edit-page/workflowitems-edit-page.module#WorkflowItemsEditPageModule' }, + { path: 'profile', loadChildren: './profile-page/profile-page.module#ProfilePageModule', canActivate: [AuthenticatedGuard] }, { path: '**', pathMatch: 'full', component: PageNotFoundComponent }, ]) ], diff --git a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.html b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.html new file mode 100644 index 0000000000..8f68b82b7b --- /dev/null +++ b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.html @@ -0,0 +1,5 @@ + + diff --git a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts new file mode 100644 index 0000000000..6c5b9acb55 --- /dev/null +++ b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts @@ -0,0 +1,147 @@ +import { Component, Inject, Input, OnInit } from '@angular/core'; +import { + DynamicFormControlModel, + DynamicFormService, DynamicFormValueControlModel, + DynamicInputModel, DynamicSelectModel +} from '@ng-dynamic-forms/core'; +import { FormGroup } from '@angular/forms'; +import { EPerson } from '../../core/eperson/models/eperson.model'; +import { Location } from '@angular/common'; +import { TranslateService } from '@ngx-translate/core'; +import { hasValue, isNotEmpty } from '../../shared/empty.util'; +import { GLOBAL_CONFIG, GlobalConfig } from '../../../config'; +import { LangConfig } from '../../../config/lang-config.interface'; +import { EPersonDataService } from '../../core/eperson/eperson-data.service'; +import { cloneDeep } from 'lodash'; +import { getRemoteDataPayload, getSucceededRemoteData } from '../../core/shared/operators'; + +@Component({ + selector: 'ds-profile-page-metadata-form', + templateUrl: './profile-page-metadata-form.component.html' +}) +export class ProfilePageMetadataFormComponent implements OnInit { + /** + * The user to display the form for + */ + @Input() user: EPerson; + + formModel: DynamicFormControlModel[] = [ + new DynamicInputModel({ + id: 'email', + name: 'email', + readOnly: true + }), + new DynamicInputModel({ + id: 'firstname', + name: 'eperson.firstname', + required: true, + validators: { + required: null + }, + errorMessages: { + required: 'This field is required' + }, + }), + new DynamicInputModel({ + id: 'lastname', + name: 'eperson.lastname', + required: true, + validators: { + required: null + }, + errorMessages: { + required: 'This field is required' + }, + }), + new DynamicInputModel({ + id: 'phone', + name: 'eperson.phone' + }), + new DynamicSelectModel({ + id: 'language', + name: 'eperson.language' + }) + ]; + + /** + * The form group of this form + */ + formGroup: FormGroup; + + LABEL_PREFIX = 'profile.metadata.form.label.'; + + ERROR_PREFIX = 'profile.metadata.form.error.'; + + /** + * All of the configured active languages + */ + activeLangs: LangConfig[]; + + constructor(@Inject(GLOBAL_CONFIG) protected config: GlobalConfig, + protected location: Location, + protected formService: DynamicFormService, + protected translate: TranslateService, + protected epersonService: EPersonDataService) { + } + + ngOnInit(): void { + this.activeLangs = this.config.languages.filter((MyLangConfig) => MyLangConfig.active === true); + this.formModel.forEach( + (fieldModel: DynamicInputModel | DynamicSelectModel) => { + if (fieldModel.name === 'email') { + fieldModel.value = this.user.email; + } else { + fieldModel.value = this.user.firstMetadataValue(fieldModel.name); + } + if (fieldModel.id === 'language') { + (fieldModel as DynamicSelectModel).options = + this.activeLangs.map((langConfig) => Object.assign({ value: langConfig.code, label: langConfig.label })) + } + } + ); + this.formGroup = this.formService.createFormGroup(this.formModel); + this.updateFieldTranslations(); + this.translate.onLangChange + .subscribe(() => { + this.updateFieldTranslations(); + }); + } + + updateFieldTranslations() { + this.formModel.forEach( + (fieldModel: DynamicInputModel) => { + fieldModel.label = this.translate.instant(this.LABEL_PREFIX + fieldModel.id); + if (isNotEmpty(fieldModel.validators)) { + fieldModel.errorMessages = {}; + Object.keys(fieldModel.validators).forEach((key) => { + fieldModel.errorMessages[key] = this.translate.instant(this.ERROR_PREFIX + fieldModel.id + '.' + key); + }); + } + } + ); + } + + updateProfile() { + const newMetadata = Object.assign({}, this.user.metadata); + this.formModel.forEach((fieldModel: DynamicFormValueControlModel) => { + if (newMetadata.hasOwnProperty(fieldModel.name) && newMetadata[fieldModel.name].length > 0) { + if (hasValue(fieldModel.value)) { + newMetadata[fieldModel.name][0].value = fieldModel.value; + } else { + newMetadata[fieldModel.name] = []; + } + } else if (hasValue(fieldModel.value)) { + newMetadata[fieldModel.name] = [{ + value: fieldModel.value, + language: null + } as any]; + } + }); + this.epersonService.update(Object.assign(cloneDeep(this.user), { metadata: newMetadata })).pipe( + getSucceededRemoteData(), + getRemoteDataPayload() + ).subscribe((user) => { + this.user = user; + }); + } +} diff --git a/src/app/profile-page/profile-page-routing.module.ts b/src/app/profile-page/profile-page-routing.module.ts new file mode 100644 index 0000000000..4b9f2b7fff --- /dev/null +++ b/src/app/profile-page/profile-page-routing.module.ts @@ -0,0 +1,15 @@ +import { NgModule } from '@angular/core'; +import { RouterModule } from '@angular/router'; +import { I18nBreadcrumbResolver } from '../core/breadcrumbs/i18n-breadcrumb.resolver'; +import { ProfilePageComponent } from './profile-page.component'; + +@NgModule({ + imports: [ + RouterModule.forChild([ + { path: '', pathMatch: 'full', component: ProfilePageComponent, resolve: { breadcrumb: I18nBreadcrumbResolver }, data: { breadcrumbKey: 'profile', title: 'profile.title' } } + ]) + ] +}) +export class ProfilePageRoutingModule { + +} diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html new file mode 100644 index 0000000000..59c6f5c248 --- /dev/null +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html @@ -0,0 +1,6 @@ +
{{'profile.security.form.info' | translate}}
+ + diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts new file mode 100644 index 0000000000..dd5ac478e2 --- /dev/null +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts @@ -0,0 +1,56 @@ +import { Component, OnInit } from '@angular/core'; +import { + DynamicFormControlModel, + DynamicFormService, + DynamicInputModel +} from '@ng-dynamic-forms/core'; +import { TranslateService } from '@ngx-translate/core'; +import { FormGroup } from '@angular/forms'; + +@Component({ + selector: 'ds-profile-page-security-form', + templateUrl: './profile-page-security-form.component.html' +}) +export class ProfilePageSecurityFormComponent implements OnInit { + + formModel: DynamicFormControlModel[] = [ + new DynamicInputModel({ + id: 'password', + name: 'password', + inputType: 'password' + }), + new DynamicInputModel({ + id: 'passwordrepeat', + name: 'passwordrepeat', + inputType: 'password' + }) + ]; + + /** + * The form group of this form + */ + formGroup: FormGroup; + + LABEL_PREFIX = 'profile.security.form.label.'; + + constructor(protected formService: DynamicFormService, + protected translate: TranslateService) { + } + + ngOnInit(): void { + this.formGroup = this.formService.createFormGroup(this.formModel); + this.updateFieldTranslations(); + this.translate.onLangChange + .subscribe(() => { + this.updateFieldTranslations(); + }); + } + + updateFieldTranslations() { + this.formModel.forEach( + (fieldModel: DynamicInputModel) => { + fieldModel.label = this.translate.instant(this.LABEL_PREFIX + fieldModel.id); + } + ); + } +} diff --git a/src/app/profile-page/profile-page.component.html b/src/app/profile-page/profile-page.component.html new file mode 100644 index 0000000000..3b0b2d712b --- /dev/null +++ b/src/app/profile-page/profile-page.component.html @@ -0,0 +1,18 @@ + +
+

{{'profile.head' | translate}}

+
+
{{'profile.card.identify' | translate}}
+
+ +
+
+
+
{{'profile.card.security' | translate}}
+
+ +
+
+ +
+ diff --git a/src/app/profile-page/profile-page.component.ts b/src/app/profile-page/profile-page.component.ts new file mode 100644 index 0000000000..eb182aab4e --- /dev/null +++ b/src/app/profile-page/profile-page.component.ts @@ -0,0 +1,35 @@ +import { Component, OnInit, ViewChild } from '@angular/core'; +import { Observable } from 'rxjs/internal/Observable'; +import { EPerson } from '../core/eperson/models/eperson.model'; +import { select, Store } from '@ngrx/store'; +import { getAuthenticatedUser } from '../core/auth/selectors'; +import { AppState } from '../app.reducer'; +import { ProfilePageMetadataFormComponent } from './profile-page-metadata-form/profile-page-metadata-form.component'; + +@Component({ + selector: 'ds-profile-page', + templateUrl: './profile-page.component.html' +}) +/** + * Component for a user to edit their profile information + */ +export class ProfilePageComponent implements OnInit { + + @ViewChild(ProfilePageMetadataFormComponent, { static: false }) metadataForm: ProfilePageMetadataFormComponent; + + /** + * The authenticated user + */ + user$: Observable; + + constructor(private store: Store) { + } + + ngOnInit(): void { + this.user$ = this.store.pipe(select(getAuthenticatedUser)); + } + + updateProfile() { + this.metadataForm.updateProfile(); + } +} diff --git a/src/app/profile-page/profile-page.module.ts b/src/app/profile-page/profile-page.module.ts new file mode 100644 index 0000000000..f40c125ff8 --- /dev/null +++ b/src/app/profile-page/profile-page.module.ts @@ -0,0 +1,23 @@ +import { NgModule } from '@angular/core'; +import { CommonModule } from '@angular/common'; +import { SharedModule } from '../shared/shared.module'; +import { ProfilePageRoutingModule } from './profile-page-routing.module'; +import { ProfilePageComponent } from './profile-page.component'; +import { ProfilePageMetadataFormComponent } from './profile-page-metadata-form/profile-page-metadata-form.component'; +import { ProfilePageSecurityFormComponent } from './profile-page-security-form/profile-page-security-form.component'; + +@NgModule({ + imports: [ + ProfilePageRoutingModule, + CommonModule, + SharedModule + ], + declarations: [ + ProfilePageComponent, + ProfilePageMetadataFormComponent, + ProfilePageSecurityFormComponent + ] +}) +export class ProfilePageModule { + +} From 53c457689cc7a65e94e05b7efce100078807549a Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Wed, 11 Mar 2020 10:50:04 +0100 Subject: [PATCH 02/13] 69432: Object update metadata PUT to PATCH --- .../core/cache/server-sync-buffer.effects.ts | 23 +++++++++++-------- .../core/data/dso-change-analyzer.service.ts | 19 ++++++++++++++- src/app/core/data/request.models.ts | 2 ++ 3 files changed, 34 insertions(+), 10 deletions(-) diff --git a/src/app/core/cache/server-sync-buffer.effects.ts b/src/app/core/cache/server-sync-buffer.effects.ts index 3a0e801f27..96cd8496d2 100644 --- a/src/app/core/cache/server-sync-buffer.effects.ts +++ b/src/app/core/cache/server-sync-buffer.effects.ts @@ -16,13 +16,15 @@ 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 { PutRequest } from '../data/request.models'; +import { PatchRequest, PutRequest } from '../data/request.models'; import { ObjectCacheService } from './object-cache.service'; import { ApplyPatchObjectCacheAction } from './object-cache.actions'; 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'; +import { ObjectCacheEntry } from './object-cache.reducer'; +import { Operation } from 'fast-json-patch'; @Injectable() export class ServerSyncBufferEffects { @@ -96,17 +98,20 @@ export class ServerSyncBufferEffects { * @returns {Observable} ApplyPatchObjectCacheAction to be dispatched */ private applyPatch(href: string): Observable { - const patchObject = this.objectCache.getObjectBySelfLink(href).pipe(take(1)); + const patchObject = this.objectCache.getBySelfLink(href).pipe(take(1)); return patchObject.pipe( - map((object) => { - const serializedObject = new DSpaceSerializer(object.constructor as GenericConstructor<{}>).serialize(object); - - this.requestService.configure(new PutRequest(this.requestService.generateRequestId(), href, serializedObject)); - - return new ApplyPatchObjectCacheAction(href) + map((entry: ObjectCacheEntry) => { + if (isNotEmpty(entry.patches)) { + const flatPatch: Operation[] = [].concat(...entry.patches.map((patch) => patch.operations)); + const objectPatch = flatPatch.filter((op: Operation) => op.path.startsWith('/metadata')); + if (isNotEmpty(objectPatch)) { + this.requestService.configure(new PatchRequest(this.requestService.generateRequestId(), href, objectPatch)); + } + } + return new ApplyPatchObjectCacheAction(href); }) - ) + ); } constructor(private actions$: Actions, diff --git a/src/app/core/data/dso-change-analyzer.service.ts b/src/app/core/data/dso-change-analyzer.service.ts index dba8395bc5..af0b95234b 100644 --- a/src/app/core/data/dso-change-analyzer.service.ts +++ b/src/app/core/data/dso-change-analyzer.service.ts @@ -3,6 +3,8 @@ import { compare } from 'fast-json-patch'; import { ChangeAnalyzer } from './change-analyzer'; import { Injectable } from '@angular/core'; import { DSpaceObject } from '../shared/dspace-object.model'; +import { MetadataMap } from '../shared/metadata.models'; +import { cloneDeep } from 'lodash'; /** * A class to determine what differs between two @@ -21,6 +23,21 @@ export class DSOChangeAnalyzer implements ChangeAnalyzer * The second object to compare */ diff(object1: DSpaceObject, object2: DSpaceObject): Operation[] { - return compare(object1.metadata, object2.metadata).map((operation: Operation) => Object.assign({}, operation, { path: '/metadata' + operation.path })); + return compare(this.filterUUIDsFromMetadata(object1.metadata), this.filterUUIDsFromMetadata(object2.metadata)) + .map((operation: Operation) => Object.assign({}, operation, { path: '/metadata' + operation.path })); + } + + /** + * Filter the UUIDs out of a MetadataMap + * @param metadata + */ + filterUUIDsFromMetadata(metadata: MetadataMap): MetadataMap { + const result = cloneDeep(metadata); + for (const key of Object.keys(result)) { + for (const metadataValue of result[key]) { + metadataValue.uuid = undefined; + } + } + return result; } } diff --git a/src/app/core/data/request.models.ts b/src/app/core/data/request.models.ts index fe992146d8..e17ffcac3f 100644 --- a/src/app/core/data/request.models.ts +++ b/src/app/core/data/request.models.ts @@ -119,6 +119,8 @@ export class HeadRequest extends RestRequest { } export class PatchRequest extends RestRequest { + public responseMsToLive = 60 * 15 * 1000; + constructor( public uuid: string, public href: string, From 004297fcfae3acaffcd1b48b222f83a40ff8e4fc Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Wed, 11 Mar 2020 11:54:32 +0100 Subject: [PATCH 03/13] 69432: Profile metadata form validation + notifications --- resources/i18n/en.json5 | 10 +++- src/app/app-routing.module.ts | 8 ++- .../profile-page-metadata-form.component.ts | 50 +++++++++++++++---- .../user-menu/user-menu.component.html | 1 + .../user-menu/user-menu.component.ts | 6 +++ 5 files changed, 61 insertions(+), 14 deletions(-) diff --git a/resources/i18n/en.json5 b/resources/i18n/en.json5 index 82f295f28e..a9cee1bd6f 100644 --- a/resources/i18n/en.json5 +++ b/resources/i18n/en.json5 @@ -1353,6 +1353,8 @@ "nav.mydspace": "MyDSpace", + "nav.profile": "Profile", + "nav.search": "Search", "nav.statistics.header": "Statistics", @@ -1421,9 +1423,9 @@ "profile.head": "Update Profile", - "profile.metadata.form.error.firstname": "First Name is required", + "profile.metadata.form.error.firstname.required": "First Name is required", - "profile.metadata.form.error.lastname": "Last Name is required", + "profile.metadata.form.error.lastname.required": "Last Name is required", "profile.metadata.form.label.email": "Email Address", @@ -1435,6 +1437,10 @@ "profile.metadata.form.label.phone": "Contact Telephone", + "profile.metadata.form.notifications.success.content": "Your changes to the profile were saved.", + + "profile.metadata.form.notifications.success.title": "Profile saved", + "profile.security.form.info": "Optionally, you can enter a new password in the box below, and confirm it by typing it again into the second box. It should be at least six characters long.", "profile.security.form.label.password": "Password", diff --git a/src/app/app-routing.module.ts b/src/app/app-routing.module.ts index da2b896241..a2c3713861 100644 --- a/src/app/app-routing.module.ts +++ b/src/app/app-routing.module.ts @@ -37,6 +37,12 @@ export function getAdminModulePath() { return `/${ADMIN_MODULE_PATH}`; } +const PROFILE_MODULE_PATH = 'profile'; + +export function getProfileModulePath() { + return `/${PROFILE_MODULE_PATH}`; +} + export function getDSOPath(dso: DSpaceObject): string { switch ((dso as any).type) { case Community.type.value: @@ -68,7 +74,7 @@ export function getDSOPath(dso: DSpaceObject): string { { path: 'submit', loadChildren: './+submit-page/submit-page.module#SubmitPageModule' }, { path: 'workspaceitems', loadChildren: './+workspaceitems-edit-page/workspaceitems-edit-page.module#WorkspaceitemsEditPageModule' }, { path: 'workflowitems', loadChildren: './+workflowitems-edit-page/workflowitems-edit-page.module#WorkflowItemsEditPageModule' }, - { path: 'profile', loadChildren: './profile-page/profile-page.module#ProfilePageModule', canActivate: [AuthenticatedGuard] }, + { path: PROFILE_MODULE_PATH, loadChildren: './profile-page/profile-page.module#ProfilePageModule', canActivate: [AuthenticatedGuard] }, { path: '**', pathMatch: 'full', component: PageNotFoundComponent }, ]) ], diff --git a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts index 6c5b9acb55..cf59f2d331 100644 --- a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts +++ b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts @@ -1,4 +1,4 @@ -import { Component, Inject, Input, OnInit } from '@angular/core'; +import { Component, Inject, Input, OnInit, ViewChild } from '@angular/core'; import { DynamicFormControlModel, DynamicFormService, DynamicFormValueControlModel, @@ -14,6 +14,10 @@ import { LangConfig } from '../../../config/lang-config.interface'; import { EPersonDataService } from '../../core/eperson/eperson-data.service'; import { cloneDeep } from 'lodash'; import { getRemoteDataPayload, getSucceededRemoteData } from '../../core/shared/operators'; +import { FormService } from '../../shared/form/form.service'; +import { FormBuilderService } from '../../shared/form/builder/form-builder.service'; +import { FormComponent } from '../../shared/form/form.component'; +import { NotificationsService } from '../../shared/notifications/notifications.service'; @Component({ selector: 'ds-profile-page-metadata-form', @@ -25,6 +29,12 @@ export class ProfilePageMetadataFormComponent implements OnInit { */ @Input() user: EPerson; + /** + * Reference to the form component + * Used for validating the form before sending update requests + */ + @ViewChild(FormComponent, { static: false }) formRef: FormComponent; + formModel: DynamicFormControlModel[] = [ new DynamicInputModel({ id: 'email', @@ -72,6 +82,8 @@ export class ProfilePageMetadataFormComponent implements OnInit { ERROR_PREFIX = 'profile.metadata.form.error.'; + NOTIFICATION_PREFIX = 'profile.metadata.form.notifications.'; + /** * All of the configured active languages */ @@ -79,13 +91,24 @@ export class ProfilePageMetadataFormComponent implements OnInit { constructor(@Inject(GLOBAL_CONFIG) protected config: GlobalConfig, protected location: Location, - protected formService: DynamicFormService, + protected formService: FormService, + protected formBuilderService: FormBuilderService, protected translate: TranslateService, - protected epersonService: EPersonDataService) { + protected epersonService: EPersonDataService, + protected notificationsService: NotificationsService) { } ngOnInit(): void { this.activeLangs = this.config.languages.filter((MyLangConfig) => MyLangConfig.active === true); + this.setFormValues(); + this.updateFieldTranslations(); + this.translate.onLangChange + .subscribe(() => { + this.updateFieldTranslations(); + }); + } + + setFormValues() { this.formModel.forEach( (fieldModel: DynamicInputModel | DynamicSelectModel) => { if (fieldModel.name === 'email') { @@ -99,12 +122,7 @@ export class ProfilePageMetadataFormComponent implements OnInit { } } ); - this.formGroup = this.formService.createFormGroup(this.formModel); - this.updateFieldTranslations(); - this.translate.onLangChange - .subscribe(() => { - this.updateFieldTranslations(); - }); + this.formGroup = this.formBuilderService.createFormGroup(this.formModel); } updateFieldTranslations() { @@ -122,8 +140,13 @@ export class ProfilePageMetadataFormComponent implements OnInit { } updateProfile() { - const newMetadata = Object.assign({}, this.user.metadata); - this.formModel.forEach((fieldModel: DynamicFormValueControlModel) => { + if (!this.formRef.formGroup.valid) { + this.formService.validateAllFormFields(this.formGroup); + return; + } + + const newMetadata = cloneDeep(this.user.metadata); + this.formModel.filter((fieldModel) => fieldModel.id !== 'email').forEach((fieldModel: DynamicFormValueControlModel) => { if (newMetadata.hasOwnProperty(fieldModel.name) && newMetadata[fieldModel.name].length > 0) { if (hasValue(fieldModel.value)) { newMetadata[fieldModel.name][0].value = fieldModel.value; @@ -142,6 +165,11 @@ export class ProfilePageMetadataFormComponent implements OnInit { getRemoteDataPayload() ).subscribe((user) => { this.user = user; + this.setFormValues(); + this.notificationsService.success( + this.translate.instant(this.NOTIFICATION_PREFIX + 'success.title'), + this.translate.instant(this.NOTIFICATION_PREFIX + 'success.content') + ); }); } } diff --git a/src/app/shared/auth-nav-menu/user-menu/user-menu.component.html b/src/app/shared/auth-nav-menu/user-menu/user-menu.component.html index fef47b395b..ac55a211e9 100644 --- a/src/app/shared/auth-nav-menu/user-menu/user-menu.component.html +++ b/src/app/shared/auth-nav-menu/user-menu/user-menu.component.html @@ -1,6 +1,7 @@
{{(user$ | async)?.name}} ({{(user$ | async)?.email}}) + {{'nav.profile' | translate}} {{'nav.mydspace' | translate}}
diff --git a/src/app/shared/auth-nav-menu/user-menu/user-menu.component.ts b/src/app/shared/auth-nav-menu/user-menu/user-menu.component.ts index e3c21b4e24..2d57a837c7 100644 --- a/src/app/shared/auth-nav-menu/user-menu/user-menu.component.ts +++ b/src/app/shared/auth-nav-menu/user-menu/user-menu.component.ts @@ -7,6 +7,7 @@ import { EPerson } from '../../../core/eperson/models/eperson.model'; import { AppState } from '../../../app.reducer'; import { getAuthenticatedUser, isAuthenticationLoading } from '../../../core/auth/selectors'; import { MYDSPACE_ROUTE } from '../../../+my-dspace-page/my-dspace-page.component'; +import { getProfileModulePath } from '../../../app-routing.module'; /** * This component represents the user nav menu. @@ -36,6 +37,11 @@ export class UserMenuComponent implements OnInit { */ public mydspaceRoute = MYDSPACE_ROUTE; + /** + * The profile page route + */ + public profileRoute = getProfileModulePath(); + constructor(private store: Store) { } From 1f1846c487d2b0dc2fc451db6ac5438555c10092 Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Wed, 11 Mar 2020 12:38:32 +0100 Subject: [PATCH 04/13] 69432: Immediate patch --- src/app/core/data/data.service.ts | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/src/app/core/data/data.service.ts b/src/app/core/data/data.service.ts index 3e67675290..a7528bae0c 100644 --- a/src/app/core/data/data.service.ts +++ b/src/app/core/data/data.service.ts @@ -44,7 +44,7 @@ import { FindByIDRequest, FindListOptions, FindListRequest, - GetRequest + GetRequest, PatchRequest } from './request.models'; import { RequestEntry } from './request.reducer'; import { RequestService } from './request.service'; @@ -337,6 +337,32 @@ export abstract class DataService { this.objectCache.addPatch(href, operations); } + /** + * Send out an immediate patch request, instead of adding to the object cache first + * This is useful in cases where you need the returned response and an object cache update is not needed + * @param dso The dso to send the patch to + * @param operations The patch operations + */ + immediatePatch(dso: T, operations: Operation[]): Observable { + const requestId = this.requestService.generateRequestId(); + + const hrefObs = this.halService.getEndpoint(this.linkPath).pipe( + map((endpoint: string) => this.getIDHref(endpoint, dso.uuid))); + + hrefObs.pipe( + find((href: string) => hasValue(href)), + map((href: string) => { + const request = new PatchRequest(requestId, href, operations); + this.requestService.configure(request); + }) + ).subscribe(); + + return this.requestService.getByUUID(requestId).pipe( + find((request: RequestEntry) => request.completed), + map((request: RequestEntry) => request.response) + ); + } + /** * Add a new patch to the object cache * The patch is derived from the differences between the given object and its version in the object cache From 892a985156815572dd803ba993cb019bef2f697e Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Wed, 11 Mar 2020 14:32:38 +0100 Subject: [PATCH 05/13] 69432: Functional profile security form + notifications + metadata form refactoring --- resources/i18n/en.json5 | 14 +++++ src/app/core/eperson/eperson-data.service.ts | 2 +- .../profile-page-metadata-form.component.html | 1 + .../profile-page-metadata-form.component.ts | 49 ++++++++-------- .../profile-page-security-form.component.html | 2 + .../profile-page-security-form.component.ts | 57 +++++++++++++++++-- .../profile-page/profile-page.component.html | 2 +- .../profile-page/profile-page.component.ts | 20 ++++++- 8 files changed, 116 insertions(+), 31 deletions(-) diff --git a/resources/i18n/en.json5 b/resources/i18n/en.json5 index a9cee1bd6f..63e2b161fe 100644 --- a/resources/i18n/en.json5 +++ b/resources/i18n/en.json5 @@ -1441,12 +1441,26 @@ "profile.metadata.form.notifications.success.title": "Profile saved", + "profile.notifications.warning.no-changes.content": "No changes were made to the Profile.", + + "profile.notifications.warning.no-changes.title": "No changes", + + "profile.security.form.error.matching-passwords": "The passwords do not match.", + "profile.security.form.info": "Optionally, you can enter a new password in the box below, and confirm it by typing it again into the second box. It should be at least six characters long.", "profile.security.form.label.password": "Password", "profile.security.form.label.passwordrepeat": "Retype to confirm", + "profile.security.form.notifications.success.content": "Successfully changed password.", + + "profile.security.form.notifications.success.title": "Password changed", + + "profile.security.form.notifications.error.title": "Error changing passwords", + + "profile.security.form.notifications.error.not-same": "The provided passwords are not the same.", + "profile.title": "Update Profile", diff --git a/src/app/core/eperson/eperson-data.service.ts b/src/app/core/eperson/eperson-data.service.ts index ef2e76c7c6..6a46b20792 100644 --- a/src/app/core/eperson/eperson-data.service.ts +++ b/src/app/core/eperson/eperson-data.service.ts @@ -20,7 +20,7 @@ import { EPERSON } from './models/eperson.resource-type'; @dataService(EPERSON) export class EPersonDataService extends DataService { - protected linkPath: 'epersons'; + protected linkPath = 'epersons'; constructor( protected requestService: RequestService, diff --git a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.html b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.html index 8f68b82b7b..c1c1cff0f3 100644 --- a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.html +++ b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.html @@ -1,5 +1,6 @@ diff --git a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts index cf59f2d331..dbd49b802a 100644 --- a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts +++ b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts @@ -29,12 +29,6 @@ export class ProfilePageMetadataFormComponent implements OnInit { */ @Input() user: EPerson; - /** - * Reference to the form component - * Used for validating the form before sending update requests - */ - @ViewChild(FormComponent, { static: false }) formRef: FormComponent; - formModel: DynamicFormControlModel[] = [ new DynamicInputModel({ id: 'email', @@ -91,7 +85,6 @@ export class ProfilePageMetadataFormComponent implements OnInit { constructor(@Inject(GLOBAL_CONFIG) protected config: GlobalConfig, protected location: Location, - protected formService: FormService, protected formBuilderService: FormBuilderService, protected translate: TranslateService, protected epersonService: EPersonDataService, @@ -139,37 +132,47 @@ export class ProfilePageMetadataFormComponent implements OnInit { ); } - updateProfile() { - if (!this.formRef.formGroup.valid) { - this.formService.validateAllFormFields(this.formGroup); - return; + updateProfile(): boolean { + if (!this.formGroup.valid) { + return false; } const newMetadata = cloneDeep(this.user.metadata); + let changed = false; this.formModel.filter((fieldModel) => fieldModel.id !== 'email').forEach((fieldModel: DynamicFormValueControlModel) => { if (newMetadata.hasOwnProperty(fieldModel.name) && newMetadata[fieldModel.name].length > 0) { if (hasValue(fieldModel.value)) { - newMetadata[fieldModel.name][0].value = fieldModel.value; + if (newMetadata[fieldModel.name][0].value !== fieldModel.value) { + newMetadata[fieldModel.name][0].value = fieldModel.value; + changed = true; + } } else { newMetadata[fieldModel.name] = []; + changed = true; } } else if (hasValue(fieldModel.value)) { newMetadata[fieldModel.name] = [{ value: fieldModel.value, language: null } as any]; + changed = true; } }); - this.epersonService.update(Object.assign(cloneDeep(this.user), { metadata: newMetadata })).pipe( - getSucceededRemoteData(), - getRemoteDataPayload() - ).subscribe((user) => { - this.user = user; - this.setFormValues(); - this.notificationsService.success( - this.translate.instant(this.NOTIFICATION_PREFIX + 'success.title'), - this.translate.instant(this.NOTIFICATION_PREFIX + 'success.content') - ); - }); + + if (changed) { + this.epersonService.update(Object.assign(cloneDeep(this.user), {metadata: newMetadata})).pipe( + getSucceededRemoteData(), + getRemoteDataPayload() + ).subscribe((user) => { + this.user = user; + this.setFormValues(); + this.notificationsService.success( + this.translate.instant(this.NOTIFICATION_PREFIX + 'success.title'), + this.translate.instant(this.NOTIFICATION_PREFIX + 'success.content') + ); + }); + } + + return changed; } } diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html index 59c6f5c248..81519e5a42 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html @@ -2,5 +2,7 @@ +
{{'profile.security.form.error.matching-passwords' | translate}}
diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts index dd5ac478e2..d5a8d358b8 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts @@ -1,17 +1,26 @@ -import { Component, OnInit } from '@angular/core'; +import { Component, Input, OnInit } from '@angular/core'; import { DynamicFormControlModel, - DynamicFormService, + DynamicFormService, DynamicFormValueControlModel, DynamicInputModel } from '@ng-dynamic-forms/core'; import { TranslateService } from '@ngx-translate/core'; import { FormGroup } from '@angular/forms'; +import { hasValue, isEmpty, isNotEmpty } from '../../shared/empty.util'; +import { EPersonDataService } from '../../core/eperson/eperson-data.service'; +import { EPerson } from '../../core/eperson/models/eperson.model'; +import { ErrorResponse, RestResponse } from '../../core/cache/response.models'; +import { NotificationsService } from '../../shared/notifications/notifications.service'; @Component({ selector: 'ds-profile-page-security-form', templateUrl: './profile-page-security-form.component.html' }) export class ProfilePageSecurityFormComponent implements OnInit { + /** + * The user to display the form for + */ + @Input() user: EPerson; formModel: DynamicFormControlModel[] = [ new DynamicInputModel({ @@ -31,14 +40,18 @@ export class ProfilePageSecurityFormComponent implements OnInit { */ formGroup: FormGroup; + NOTIFICATIONS_PREFIX = 'profile.security.form.notifications.'; + LABEL_PREFIX = 'profile.security.form.label.'; constructor(protected formService: DynamicFormService, - protected translate: TranslateService) { + protected translate: TranslateService, + protected epersonService: EPersonDataService, + protected notificationsService: NotificationsService) { } ngOnInit(): void { - this.formGroup = this.formService.createFormGroup(this.formModel); + this.formGroup = this.formService.createFormGroup(this.formModel, { validators: this.checkPasswords }); this.updateFieldTranslations(); this.translate.onLangChange .subscribe(() => { @@ -53,4 +66,40 @@ export class ProfilePageSecurityFormComponent implements OnInit { } ); } + + checkPasswords(group: FormGroup) { + const pass = group.get('password').value; + const repeatPass = group.get('passwordrepeat').value; + + return isEmpty(repeatPass) || pass === repeatPass ? null : { notSame: true }; + } + + updateSecurity() { + const pass = this.formGroup.get('password').value; + const passEntered = isNotEmpty(pass); + if (!this.formGroup.valid) { + if (passEntered) { + this.notificationsService.error(this.translate.instant(this.NOTIFICATIONS_PREFIX + 'error.not-same')); + return true; + } + return false; + } + if (passEntered) { + const operation = Object.assign({ op: 'replace', path: '/password', value: pass }); + this.epersonService.immediatePatch(this.user, [operation]).subscribe((response: RestResponse) => { + if (response.isSuccessful) { + this.notificationsService.success( + this.translate.instant(this.NOTIFICATIONS_PREFIX + 'success.title'), + this.translate.instant(this.NOTIFICATIONS_PREFIX + 'success.content') + ); + } else { + this.notificationsService.error( + this.translate.instant(this.NOTIFICATIONS_PREFIX + 'error.title'), (response as ErrorResponse).errorMessage + ); + } + }); + } + + return passEntered; + } } diff --git a/src/app/profile-page/profile-page.component.html b/src/app/profile-page/profile-page.component.html index 3b0b2d712b..1d1112f52e 100644 --- a/src/app/profile-page/profile-page.component.html +++ b/src/app/profile-page/profile-page.component.html @@ -10,7 +10,7 @@
{{'profile.card.security' | translate}}
- +
diff --git a/src/app/profile-page/profile-page.component.ts b/src/app/profile-page/profile-page.component.ts index eb182aab4e..1b0baddbee 100644 --- a/src/app/profile-page/profile-page.component.ts +++ b/src/app/profile-page/profile-page.component.ts @@ -5,6 +5,9 @@ import { select, Store } from '@ngrx/store'; import { getAuthenticatedUser } from '../core/auth/selectors'; import { AppState } from '../app.reducer'; import { ProfilePageMetadataFormComponent } from './profile-page-metadata-form/profile-page-metadata-form.component'; +import { ProfilePageSecurityFormComponent } from './profile-page-security-form/profile-page-security-form.component'; +import { NotificationsService } from '../shared/notifications/notifications.service'; +import { TranslateService } from '@ngx-translate/core'; @Component({ selector: 'ds-profile-page', @@ -17,12 +20,18 @@ export class ProfilePageComponent implements OnInit { @ViewChild(ProfilePageMetadataFormComponent, { static: false }) metadataForm: ProfilePageMetadataFormComponent; + @ViewChild(ProfilePageSecurityFormComponent, { static: false }) securityForm: ProfilePageSecurityFormComponent; + /** * The authenticated user */ user$: Observable; - constructor(private store: Store) { + NOTIFICATIONS_PREFIX = 'profile.notifications.'; + + constructor(private store: Store, + private notificationsService: NotificationsService, + private translate: TranslateService) { } ngOnInit(): void { @@ -30,6 +39,13 @@ export class ProfilePageComponent implements OnInit { } updateProfile() { - this.metadataForm.updateProfile(); + const metadataChanged = this.metadataForm.updateProfile(); + const securityChanged = this.securityForm.updateSecurity(); + if (!metadataChanged && !securityChanged) { + this.notificationsService.warning( + this.translate.instant(this.NOTIFICATIONS_PREFIX + 'warning.no-changes.title'), + this.translate.instant(this.NOTIFICATIONS_PREFIX + 'warning.no-changes.content') + ); + } } } From 7d26fd478d39ee8a445ea4778a9dbdfee7dfb309 Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Wed, 11 Mar 2020 14:56:35 +0100 Subject: [PATCH 06/13] 69432: Groups on profile page --- resources/i18n/en.json5 | 2 ++ .../profile-page/profile-page.component.html | 9 +++++++ .../profile-page/profile-page.component.ts | 25 +++++++++++++++++-- 3 files changed, 34 insertions(+), 2 deletions(-) diff --git a/resources/i18n/en.json5 b/resources/i18n/en.json5 index 63e2b161fe..a82b4d6593 100644 --- a/resources/i18n/en.json5 +++ b/resources/i18n/en.json5 @@ -1421,6 +1421,8 @@ "profile.form.submit": "Update Profile", + "profile.groups.head": "Authorization groups you belong to", + "profile.head": "Update Profile", "profile.metadata.form.error.firstname.required": "First Name is required", diff --git a/src/app/profile-page/profile-page.component.html b/src/app/profile-page/profile-page.component.html index 1d1112f52e..b6e62665b4 100644 --- a/src/app/profile-page/profile-page.component.html +++ b/src/app/profile-page/profile-page.component.html @@ -14,5 +14,14 @@
+ + +
+

{{'profile.groups.head' | translate}}

+
    +
  • {{group.name}}
    • +
+
+ diff --git a/src/app/profile-page/profile-page.component.ts b/src/app/profile-page/profile-page.component.ts index 1b0baddbee..f353ab108f 100644 --- a/src/app/profile-page/profile-page.component.ts +++ b/src/app/profile-page/profile-page.component.ts @@ -8,6 +8,14 @@ import { ProfilePageMetadataFormComponent } from './profile-page-metadata-form/p import { ProfilePageSecurityFormComponent } from './profile-page-security-form/profile-page-security-form.component'; import { NotificationsService } from '../shared/notifications/notifications.service'; import { TranslateService } from '@ngx-translate/core'; +import { Group } from '../core/eperson/models/group.model'; +import { RemoteData } from '../core/data/remote-data'; +import { PaginatedList } from '../core/data/paginated-list'; +import { filter, switchMap, tap } from 'rxjs/operators'; +import { EPersonDataService } from '../core/eperson/eperson-data.service'; +import { getAllSucceededRemoteData, getRemoteDataPayload, getSucceededRemoteData } from '../core/shared/operators'; +import { hasValue } from '../shared/empty.util'; +import { followLink } from '../shared/utils/follow-link-config.model'; @Component({ selector: 'ds-profile-page', @@ -27,15 +35,28 @@ export class ProfilePageComponent implements OnInit { */ user$: Observable; + /** + * The groups the user belongs to + */ + groupsRD$: Observable>>; + NOTIFICATIONS_PREFIX = 'profile.notifications.'; constructor(private store: Store, private notificationsService: NotificationsService, - private translate: TranslateService) { + private translate: TranslateService, + private epersonService: EPersonDataService) { } ngOnInit(): void { - this.user$ = this.store.pipe(select(getAuthenticatedUser)); + this.user$ = this.store.pipe( + select(getAuthenticatedUser), + filter((user: EPerson) => hasValue(user.id)), + switchMap((user: EPerson) => this.epersonService.findById(user.id, followLink('groups'))), + getAllSucceededRemoteData(), + getRemoteDataPayload() + ); + this.groupsRD$ = this.user$.pipe(switchMap((user: EPerson) => user.groups)); } updateProfile() { From adfffac730177b76c81c1feff3eaba2c6e398404 Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Wed, 11 Mar 2020 15:53:48 +0100 Subject: [PATCH 07/13] 69432: Profile page - missing JSDocs --- .../profile-page-metadata-form.component.ts | 38 +++++++++++++++++++ .../profile-page-security-form.component.ts | 30 +++++++++++++++ .../profile-page/profile-page.component.ts | 14 ++++++- 3 files changed, 81 insertions(+), 1 deletion(-) diff --git a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts index dbd49b802a..0b06b3f076 100644 --- a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts +++ b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts @@ -23,12 +23,24 @@ import { NotificationsService } from '../../shared/notifications/notifications.s selector: 'ds-profile-page-metadata-form', templateUrl: './profile-page-metadata-form.component.html' }) +/** + * Component for a user to edit their metadata + * Displays a form containing: + * - readonly email field, + * - required first name text field + * - required last name text field + * - phone text field + * - language dropdown + */ export class ProfilePageMetadataFormComponent implements OnInit { /** * The user to display the form for */ @Input() user: EPerson; + /** + * The form's input models + */ formModel: DynamicFormControlModel[] = [ new DynamicInputModel({ id: 'email', @@ -72,14 +84,24 @@ export class ProfilePageMetadataFormComponent implements OnInit { */ formGroup: FormGroup; + /** + * Prefix for the form's label messages of this component + */ LABEL_PREFIX = 'profile.metadata.form.label.'; + /** + * Prefix for the form's error messages of this component + */ ERROR_PREFIX = 'profile.metadata.form.error.'; + /** + * Prefix for the notification messages of this component + */ NOTIFICATION_PREFIX = 'profile.metadata.form.notifications.'; /** * All of the configured active languages + * Used to populate the language dropdown */ activeLangs: LangConfig[]; @@ -101,6 +123,10 @@ export class ProfilePageMetadataFormComponent implements OnInit { }); } + /** + * Loop over all the form's input models and set their values depending on the user's metadata + * Create the FormGroup + */ setFormValues() { this.formModel.forEach( (fieldModel: DynamicInputModel | DynamicSelectModel) => { @@ -118,6 +144,9 @@ export class ProfilePageMetadataFormComponent implements OnInit { this.formGroup = this.formBuilderService.createFormGroup(this.formModel); } + /** + * Update the translations of the field labels and error messages + */ updateFieldTranslations() { this.formModel.forEach( (fieldModel: DynamicInputModel) => { @@ -132,6 +161,15 @@ export class ProfilePageMetadataFormComponent implements OnInit { ); } + /** + * Update the user's metadata + * + * Sends a patch request for updating the user's metadata when at least one value changed or got added/removed and the + * form is valid. + * Nothing happens when the form is invalid or no metadata changed. + * + * Returns false when nothing happened. + */ updateProfile(): boolean { if (!this.formGroup.valid) { return false; diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts index d5a8d358b8..2c02027b4a 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts @@ -16,12 +16,19 @@ import { NotificationsService } from '../../shared/notifications/notifications.s selector: 'ds-profile-page-security-form', templateUrl: './profile-page-security-form.component.html' }) +/** + * Component for a user to edit their security information + * Displays a form containing a password field and a confirmation of the password + */ export class ProfilePageSecurityFormComponent implements OnInit { /** * The user to display the form for */ @Input() user: EPerson; + /** + * The form's input models + */ formModel: DynamicFormControlModel[] = [ new DynamicInputModel({ id: 'password', @@ -40,8 +47,14 @@ export class ProfilePageSecurityFormComponent implements OnInit { */ formGroup: FormGroup; + /** + * Prefix for the notification messages of this component + */ NOTIFICATIONS_PREFIX = 'profile.security.form.notifications.'; + /** + * Prefix for the form's label messages of this component + */ LABEL_PREFIX = 'profile.security.form.label.'; constructor(protected formService: DynamicFormService, @@ -59,6 +72,9 @@ export class ProfilePageSecurityFormComponent implements OnInit { }); } + /** + * Update the translations of the field labels + */ updateFieldTranslations() { this.formModel.forEach( (fieldModel: DynamicInputModel) => { @@ -67,6 +83,10 @@ export class ProfilePageSecurityFormComponent implements OnInit { ); } + /** + * Check if both password fields are filled in and equal + * @param group The FormGroup to validate + */ checkPasswords(group: FormGroup) { const pass = group.get('password').value; const repeatPass = group.get('passwordrepeat').value; @@ -74,6 +94,16 @@ export class ProfilePageSecurityFormComponent implements OnInit { return isEmpty(repeatPass) || pass === repeatPass ? null : { notSame: true }; } + /** + * Update the user's security details + * + * Sends a patch request for changing the user's password when a new password is present and the password confirmation + * matches the new password. + * Nothing happens when no passwords are filled in. + * An error notification is displayed when the password confirmation does not match the new password. + * + * Returns false when nothing happened + */ updateSecurity() { const pass = this.formGroup.get('password').value; const passEntered = isNotEmpty(pass); diff --git a/src/app/profile-page/profile-page.component.ts b/src/app/profile-page/profile-page.component.ts index f353ab108f..5a2736593a 100644 --- a/src/app/profile-page/profile-page.component.ts +++ b/src/app/profile-page/profile-page.component.ts @@ -25,9 +25,14 @@ import { followLink } from '../shared/utils/follow-link-config.model'; * Component for a user to edit their profile information */ export class ProfilePageComponent implements OnInit { - + /** + * A reference to the metadata form component + */ @ViewChild(ProfilePageMetadataFormComponent, { static: false }) metadataForm: ProfilePageMetadataFormComponent; + /** + * A reference to the security form component + */ @ViewChild(ProfilePageSecurityFormComponent, { static: false }) securityForm: ProfilePageSecurityFormComponent; /** @@ -40,6 +45,9 @@ export class ProfilePageComponent implements OnInit { */ groupsRD$: Observable>>; + /** + * Prefix for the notification messages of this component + */ NOTIFICATIONS_PREFIX = 'profile.notifications.'; constructor(private store: Store, @@ -59,6 +67,10 @@ export class ProfilePageComponent implements OnInit { this.groupsRD$ = this.user$.pipe(switchMap((user: EPerson) => user.groups)); } + /** + * Fire an update on both the metadata and security forms + * Show a warning notification when no changes were made in both forms + */ updateProfile() { const metadataChanged = this.metadataForm.updateProfile(); const securityChanged = this.securityForm.updateSecurity(); From 20f8f913cf154399508e276d2b5420a05de07acb Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Thu, 12 Mar 2020 10:18:49 +0100 Subject: [PATCH 08/13] 69432: Tests --- .../cache/server-sync-buffer.effects.spec.ts | 8 + ...ofile-page-metadata-form.component.spec.ts | 142 ++++++++++++++++++ .../profile-page-metadata-form.component.ts | 6 +- ...ofile-page-security-form.component.spec.ts | 106 +++++++++++++ .../profile-page-security-form.component.ts | 4 +- .../profile-page.component.spec.ts | 129 ++++++++++++++++ 6 files changed, 388 insertions(+), 7 deletions(-) create mode 100644 src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.spec.ts create mode 100644 src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts create mode 100644 src/app/profile-page/profile-page.component.spec.ts 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 37ad0e6346..c2aa7b14f9 100644 --- a/src/app/core/cache/server-sync-buffer.effects.spec.ts +++ b/src/app/core/cache/server-sync-buffer.effects.spec.ts @@ -51,6 +51,14 @@ describe('ServerSyncBufferEffects', () => { _links: { self: { href: link } } }); return observableOf(object); + }, + getBySelfLink: (link) => { + const object = Object.assign(new DSpaceObject(), { + _links: { + self: { href: link } + } + }); + return observableOf(object); } } }, diff --git a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.spec.ts b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.spec.ts new file mode 100644 index 0000000000..7aeb33d84d --- /dev/null +++ b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.spec.ts @@ -0,0 +1,142 @@ +import { ProfilePageMetadataFormComponent } from './profile-page-metadata-form.component'; +import { async, ComponentFixture, TestBed } from '@angular/core/testing'; +import { VarDirective } from '../../shared/utils/var.directive'; +import { TranslateModule, TranslateService } from '@ngx-translate/core'; +import { RouterTestingModule } from '@angular/router/testing'; +import { EventEmitter, NO_ERRORS_SCHEMA } from '@angular/core'; +import { EPerson } from '../../core/eperson/models/eperson.model'; +import { GLOBAL_CONFIG } from '../../../config'; +import { FormBuilderService } from '../../shared/form/builder/form-builder.service'; +import { NotificationsService } from '../../shared/notifications/notifications.service'; +import { EPersonDataService } from '../../core/eperson/eperson-data.service'; +import { cloneDeep } from 'lodash'; +import { createSuccessfulRemoteDataObject$ } from '../../shared/testing/utils'; + +describe('ProfilePageMetadataFormComponent', () => { + let component: ProfilePageMetadataFormComponent; + let fixture: ComponentFixture; + + const config = { + languages: [{ + code: 'en', + label: 'English', + active: true, + }, { + code: 'de', + label: 'Deutsch', + active: true, + }] + } as any; + + const user = Object.assign(new EPerson(), { + email: 'example@gmail.com', + metadata: { + 'eperson.firstname': [ + { + value: 'John', + language: null + } + ], + 'eperson.lastname': [ + { + value: 'Doe', + language: null + } + ], + 'eperson.language': [ + { + value: 'de', + language: null + } + ] + } + }); + + const epersonService = jasmine.createSpyObj('epersonService', { + update: createSuccessfulRemoteDataObject$(user) + }); + const notificationsService = jasmine.createSpyObj('notificationsService', { + success: {}, + error: {}, + warning: {} + }); + const translate = { + instant: () => 'translated', + onLangChange: new EventEmitter() + }; + + beforeEach(async(() => { + TestBed.configureTestingModule({ + declarations: [ProfilePageMetadataFormComponent, VarDirective], + imports: [TranslateModule.forRoot(), RouterTestingModule.withRoutes([])], + providers: [ + { provide: GLOBAL_CONFIG, useValue: config }, + { provide: EPersonDataService, useValue: epersonService }, + { provide: TranslateService, useValue: translate }, + { provide: NotificationsService, useValue: notificationsService }, + FormBuilderService + ], + schemas: [NO_ERRORS_SCHEMA] + }).compileComponents(); + })); + + beforeEach(() => { + fixture = TestBed.createComponent(ProfilePageMetadataFormComponent); + component = fixture.componentInstance; + component.user = user; + fixture.detectChanges(); + }); + + it('should automatically fill in the user\'s email in the correct field', () => { + expect(component.formGroup.get('email').value).toEqual(user.email); + }); + + it('should automatically fill the present metadata values and leave missing ones empty', () => { + expect(component.formGroup.get('firstname').value).toEqual('John'); + expect(component.formGroup.get('lastname').value).toEqual('Doe'); + expect(component.formGroup.get('phone').value).toBeUndefined(); + expect(component.formGroup.get('language').value).toEqual('de'); + }); + + describe('updateProfile', () => { + describe('when no values changed', () => { + let result; + + beforeEach(() => { + result = component.updateProfile(); + }); + + it('should return false', () => { + expect(result).toEqual(false); + }); + + it('should not call epersonService.update', () => { + expect(epersonService.update).not.toHaveBeenCalled(); + }); + }); + + describe('when a form value changed', () => { + let result; + let newUser; + + beforeEach(() => { + newUser = cloneDeep(user); + newUser.metadata['eperson.firstname'][0].value = 'Johnny'; + setModelValue('firstname', 'Johnny'); + result = component.updateProfile(); + }); + + it('should return true', () => { + expect(result).toEqual(true); + }); + + it('should call epersonService.update', () => { + expect(epersonService.update).toHaveBeenCalledWith(newUser); + }); + }); + }); + + function setModelValue(id: string, value: string) { + component.formModel.filter((model) => model.id === id).forEach((model) => (model as any).value = value); + } +}); diff --git a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts index 0b06b3f076..b44faa8c4a 100644 --- a/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts +++ b/src/app/profile-page/profile-page-metadata-form/profile-page-metadata-form.component.ts @@ -1,4 +1,4 @@ -import { Component, Inject, Input, OnInit, ViewChild } from '@angular/core'; +import { Component, Inject, Input, OnInit } from '@angular/core'; import { DynamicFormControlModel, DynamicFormService, DynamicFormValueControlModel, @@ -6,7 +6,6 @@ import { } from '@ng-dynamic-forms/core'; import { FormGroup } from '@angular/forms'; import { EPerson } from '../../core/eperson/models/eperson.model'; -import { Location } from '@angular/common'; import { TranslateService } from '@ngx-translate/core'; import { hasValue, isNotEmpty } from '../../shared/empty.util'; import { GLOBAL_CONFIG, GlobalConfig } from '../../../config'; @@ -14,9 +13,7 @@ import { LangConfig } from '../../../config/lang-config.interface'; import { EPersonDataService } from '../../core/eperson/eperson-data.service'; import { cloneDeep } from 'lodash'; import { getRemoteDataPayload, getSucceededRemoteData } from '../../core/shared/operators'; -import { FormService } from '../../shared/form/form.service'; import { FormBuilderService } from '../../shared/form/builder/form-builder.service'; -import { FormComponent } from '../../shared/form/form.component'; import { NotificationsService } from '../../shared/notifications/notifications.service'; @Component({ @@ -106,7 +103,6 @@ export class ProfilePageMetadataFormComponent implements OnInit { activeLangs: LangConfig[]; constructor(@Inject(GLOBAL_CONFIG) protected config: GlobalConfig, - protected location: Location, protected formBuilderService: FormBuilderService, protected translate: TranslateService, protected epersonService: EPersonDataService, diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts new file mode 100644 index 0000000000..da0ad049c4 --- /dev/null +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts @@ -0,0 +1,106 @@ +import { async, ComponentFixture, TestBed } from '@angular/core/testing'; +import { EPerson } from '../../core/eperson/models/eperson.model'; +import { NO_ERRORS_SCHEMA } from '@angular/core'; +import { VarDirective } from '../../shared/utils/var.directive'; +import { TranslateModule } from '@ngx-translate/core'; +import { RouterTestingModule } from '@angular/router/testing'; +import { EPersonDataService } from '../../core/eperson/eperson-data.service'; +import { NotificationsService } from '../../shared/notifications/notifications.service'; +import { FormBuilderService } from '../../shared/form/builder/form-builder.service'; +import { ProfilePageSecurityFormComponent } from './profile-page-security-form.component'; +import { of as observableOf } from 'rxjs'; +import { RestResponse } from '../../core/cache/response.models'; + +describe('ProfilePageSecurityFormComponent', () => { + let component: ProfilePageSecurityFormComponent; + let fixture: ComponentFixture; + + const user = new EPerson(); + + const epersonService = jasmine.createSpyObj('epersonService', { + immediatePatch: observableOf(new RestResponse(true, 200, 'OK')) + }); + const notificationsService = jasmine.createSpyObj('notificationsService', { + success: {}, + error: {}, + warning: {} + }); + + beforeEach(async(() => { + TestBed.configureTestingModule({ + declarations: [ProfilePageSecurityFormComponent, VarDirective], + imports: [TranslateModule.forRoot(), RouterTestingModule.withRoutes([])], + providers: [ + { provide: EPersonDataService, useValue: epersonService }, + { provide: NotificationsService, useValue: notificationsService }, + FormBuilderService + ], + schemas: [NO_ERRORS_SCHEMA] + }).compileComponents(); + })); + + beforeEach(() => { + fixture = TestBed.createComponent(ProfilePageSecurityFormComponent); + component = fixture.componentInstance; + component.user = user; + fixture.detectChanges(); + }); + + describe('updateSecurity', () => { + describe('when no values changed', () => { + let result; + + beforeEach(() => { + result = component.updateSecurity(); + }); + + it('should return false', () => { + expect(result).toEqual(false); + }); + + it('should not call epersonService.immediatePatch', () => { + expect(epersonService.immediatePatch).not.toHaveBeenCalled(); + }); + }); + + describe('when password is filled in, but the confirm field is empty', () => { + let result; + + beforeEach(() => { + setModelValue('password', 'test'); + result = component.updateSecurity(); + }); + + it('should return true', () => { + expect(result).toEqual(true); + }); + }); + + describe('when both password fields are filled in and equal', () => { + let result; + let operations; + + beforeEach(() => { + setModelValue('password', 'test'); + setModelValue('passwordrepeat', 'test'); + operations = [{ op: 'replace', path: '/password', value: 'test' }]; + result = component.updateSecurity(); + }); + + it('should return true', () => { + expect(result).toEqual(true); + }); + + it('should return call epersonService.immediatePatch', () => { + expect(epersonService.immediatePatch).toHaveBeenCalledWith(user, operations); + }); + }); + }); + + function setModelValue(id: string, value: string) { + component.formGroup.patchValue({ + [id]: value + }); + component.formGroup.markAllAsTouched(); + } +}); diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts index 2c02027b4a..5885cc48db 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts @@ -1,12 +1,12 @@ import { Component, Input, OnInit } from '@angular/core'; import { DynamicFormControlModel, - DynamicFormService, DynamicFormValueControlModel, + DynamicFormService, DynamicInputModel } from '@ng-dynamic-forms/core'; import { TranslateService } from '@ngx-translate/core'; import { FormGroup } from '@angular/forms'; -import { hasValue, isEmpty, isNotEmpty } from '../../shared/empty.util'; +import { isEmpty, isNotEmpty } from '../../shared/empty.util'; import { EPersonDataService } from '../../core/eperson/eperson-data.service'; import { EPerson } from '../../core/eperson/models/eperson.model'; import { ErrorResponse, RestResponse } from '../../core/cache/response.models'; diff --git a/src/app/profile-page/profile-page.component.spec.ts b/src/app/profile-page/profile-page.component.spec.ts new file mode 100644 index 0000000000..5992012be9 --- /dev/null +++ b/src/app/profile-page/profile-page.component.spec.ts @@ -0,0 +1,129 @@ +import { ProfilePageComponent } from './profile-page.component'; +import { async, ComponentFixture, inject, TestBed } from '@angular/core/testing'; +import { VarDirective } from '../shared/utils/var.directive'; +import { TranslateModule } from '@ngx-translate/core'; +import { RouterTestingModule } from '@angular/router/testing'; +import { NO_ERRORS_SCHEMA } from '@angular/core'; +import { EPerson } from '../core/eperson/models/eperson.model'; +import { createPaginatedList, createSuccessfulRemoteDataObject$ } from '../shared/testing/utils'; +import { Store, StoreModule } from '@ngrx/store'; +import { AppState } from '../app.reducer'; +import { AuthTokenInfo } from '../core/auth/models/auth-token-info.model'; +import { EPersonDataService } from '../core/eperson/eperson-data.service'; +import { NotificationsService } from '../shared/notifications/notifications.service'; +import { authReducer } from '../core/auth/auth.reducer'; + +describe('ProfilePageComponent', () => { + let component: ProfilePageComponent; + let fixture: ComponentFixture; + + const user = Object.assign(new EPerson(), { + groups: createSuccessfulRemoteDataObject$(createPaginatedList([])) + }); + const authState = { + authenticated: true, + loaded: true, + loading: false, + authToken: new AuthTokenInfo('test_token'), + user: user + }; + + const epersonService = jasmine.createSpyObj('epersonService', { + findById: createSuccessfulRemoteDataObject$(user) + }); + const notificationsService = jasmine.createSpyObj('notificationsService', { + success: {}, + error: {}, + warning: {} + }); + + beforeEach(async(() => { + TestBed.configureTestingModule({ + declarations: [ProfilePageComponent, VarDirective], + imports: [StoreModule.forRoot(authReducer), TranslateModule.forRoot(), RouterTestingModule.withRoutes([])], + providers: [ + { provide: EPersonDataService, useValue: epersonService }, + { provide: NotificationsService, useValue: notificationsService } + ], + schemas: [NO_ERRORS_SCHEMA] + }).compileComponents(); + })); + + beforeEach(inject([Store], (store: Store) => { + store + .subscribe((state) => { + (state as any).core = Object.create({}); + (state as any).core.auth = authState; + }); + + fixture = TestBed.createComponent(ProfilePageComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + })); + + describe('updateProfile', () => { + describe('when the metadata form returns false and the security form returns true', () => { + beforeEach(() => { + component.metadataForm = jasmine.createSpyObj('metadataForm', { + updateProfile: false + }); + component.securityForm = jasmine.createSpyObj('securityForm', { + updateSecurity: true + }); + component.updateProfile(); + }); + + it('should not display a warning', () => { + expect(notificationsService.warning).not.toHaveBeenCalled(); + }); + }); + + describe('when the metadata form returns true and the security form returns false', () => { + beforeEach(() => { + component.metadataForm = jasmine.createSpyObj('metadataForm', { + updateProfile: true + }); + component.securityForm = jasmine.createSpyObj('securityForm', { + updateSecurity: false + }); + component.updateProfile(); + }); + + it('should not display a warning', () => { + expect(notificationsService.warning).not.toHaveBeenCalled(); + }); + }); + + describe('when the metadata form returns true and the security form returns true', () => { + beforeEach(() => { + component.metadataForm = jasmine.createSpyObj('metadataForm', { + updateProfile: true + }); + component.securityForm = jasmine.createSpyObj('securityForm', { + updateSecurity: true + }); + component.updateProfile(); + }); + + it('should not display a warning', () => { + expect(notificationsService.warning).not.toHaveBeenCalled(); + }); + }); + + describe('when the metadata form returns false and the security form returns false', () => { + beforeEach(() => { + component.metadataForm = jasmine.createSpyObj('metadataForm', { + updateProfile: false + }); + component.securityForm = jasmine.createSpyObj('securityForm', { + updateSecurity: false + }); + component.updateProfile(); + }); + + it('should display a warning', () => { + expect(notificationsService.warning).toHaveBeenCalled(); + }); + }); + }); +}); From c1bd6938a7ad8f91f1a393a0d38070dc95534387 Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Thu, 12 Mar 2020 16:24:47 +0100 Subject: [PATCH 09/13] 69432: Remove immediatePatch and replace usage with patch --- resources/i18n/en.json5 | 4 +-- .../core/cache/server-sync-buffer.effects.ts | 5 ++-- src/app/core/data/data.service.ts | 28 +------------------ .../profile-page-security-form.component.ts | 17 ++++------- 4 files changed, 10 insertions(+), 44 deletions(-) diff --git a/resources/i18n/en.json5 b/resources/i18n/en.json5 index a82b4d6593..decad7309b 100644 --- a/resources/i18n/en.json5 +++ b/resources/i18n/en.json5 @@ -1455,9 +1455,9 @@ "profile.security.form.label.passwordrepeat": "Retype to confirm", - "profile.security.form.notifications.success.content": "Successfully changed password.", + "profile.security.form.notifications.success.content": "Your changes to the password were saved.", - "profile.security.form.notifications.success.title": "Password changed", + "profile.security.form.notifications.success.title": "Password saved", "profile.security.form.notifications.error.title": "Error changing passwords", diff --git a/src/app/core/cache/server-sync-buffer.effects.ts b/src/app/core/cache/server-sync-buffer.effects.ts index 96cd8496d2..fd398f2971 100644 --- a/src/app/core/cache/server-sync-buffer.effects.ts +++ b/src/app/core/cache/server-sync-buffer.effects.ts @@ -104,9 +104,8 @@ export class ServerSyncBufferEffects { map((entry: ObjectCacheEntry) => { if (isNotEmpty(entry.patches)) { const flatPatch: Operation[] = [].concat(...entry.patches.map((patch) => patch.operations)); - const objectPatch = flatPatch.filter((op: Operation) => op.path.startsWith('/metadata')); - if (isNotEmpty(objectPatch)) { - this.requestService.configure(new PatchRequest(this.requestService.generateRequestId(), href, objectPatch)); + if (isNotEmpty(flatPatch)) { + this.requestService.configure(new PatchRequest(this.requestService.generateRequestId(), href, flatPatch)); } } return new ApplyPatchObjectCacheAction(href); diff --git a/src/app/core/data/data.service.ts b/src/app/core/data/data.service.ts index a7528bae0c..3e67675290 100644 --- a/src/app/core/data/data.service.ts +++ b/src/app/core/data/data.service.ts @@ -44,7 +44,7 @@ import { FindByIDRequest, FindListOptions, FindListRequest, - GetRequest, PatchRequest + GetRequest } from './request.models'; import { RequestEntry } from './request.reducer'; import { RequestService } from './request.service'; @@ -337,32 +337,6 @@ export abstract class DataService { this.objectCache.addPatch(href, operations); } - /** - * Send out an immediate patch request, instead of adding to the object cache first - * This is useful in cases where you need the returned response and an object cache update is not needed - * @param dso The dso to send the patch to - * @param operations The patch operations - */ - immediatePatch(dso: T, operations: Operation[]): Observable { - const requestId = this.requestService.generateRequestId(); - - const hrefObs = this.halService.getEndpoint(this.linkPath).pipe( - map((endpoint: string) => this.getIDHref(endpoint, dso.uuid))); - - hrefObs.pipe( - find((href: string) => hasValue(href)), - map((href: string) => { - const request = new PatchRequest(requestId, href, operations); - this.requestService.configure(request); - }) - ).subscribe(); - - return this.requestService.getByUUID(requestId).pipe( - find((request: RequestEntry) => request.completed), - map((request: RequestEntry) => request.response) - ); - } - /** * Add a new patch to the object cache * The patch is derived from the differences between the given object and its version in the object cache diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts index 5885cc48db..d7f6213dc6 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts @@ -116,18 +116,11 @@ export class ProfilePageSecurityFormComponent implements OnInit { } if (passEntered) { const operation = Object.assign({ op: 'replace', path: '/password', value: pass }); - this.epersonService.immediatePatch(this.user, [operation]).subscribe((response: RestResponse) => { - if (response.isSuccessful) { - this.notificationsService.success( - this.translate.instant(this.NOTIFICATIONS_PREFIX + 'success.title'), - this.translate.instant(this.NOTIFICATIONS_PREFIX + 'success.content') - ); - } else { - this.notificationsService.error( - this.translate.instant(this.NOTIFICATIONS_PREFIX + 'error.title'), (response as ErrorResponse).errorMessage - ); - } - }); + this.epersonService.patch(this.user.self, [operation]); + this.notificationsService.success( + this.translate.instant(this.NOTIFICATIONS_PREFIX + 'success.title'), + this.translate.instant(this.NOTIFICATIONS_PREFIX + 'success.content') + ); } return passEntered; From 5c096d5f6608ebe109c7cc34ffafd53827be4c91 Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Thu, 12 Mar 2020 16:56:00 +0100 Subject: [PATCH 10/13] 69432: Fix for automatically updating authenticated user --- src/app/core/auth/auth.service.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/app/core/auth/auth.service.ts b/src/app/core/auth/auth.service.ts index fd5c98f789..f8847b0b2e 100644 --- a/src/app/core/auth/auth.service.ts +++ b/src/app/core/auth/auth.service.ts @@ -23,7 +23,7 @@ import { NativeWindowRef, NativeWindowService } from '../services/window.service import { Base64EncodeUrl } from '../../shared/utils/encode-decode.util'; import { RouteService } from '../services/route.service'; import { EPersonDataService } from '../eperson/eperson-data.service'; -import { getFirstSucceededRemoteDataPayload } from '../shared/operators'; +import { getAllSucceededRemoteDataPayload, getFirstSucceededRemoteDataPayload } from '../shared/operators'; export const LOGIN_ROUTE = '/login'; export const LOGOUT_ROUTE = '/logout'; @@ -149,7 +149,7 @@ export class AuthService { */ public retrieveAuthenticatedUserByHref(userHref: string): Observable { return this.epersonService.findByHref(userHref).pipe( - getFirstSucceededRemoteDataPayload() + getAllSucceededRemoteDataPayload() ) } From d9e6d25da0f9ea96ebbedd8fff95f5bd90d79474 Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Thu, 12 Mar 2020 17:18:28 +0100 Subject: [PATCH 11/13] 69432: Test fixes --- ...rofile-page-security-form.component.spec.ts | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts index da0ad049c4..9c05fa98d1 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts @@ -8,17 +8,19 @@ import { EPersonDataService } from '../../core/eperson/eperson-data.service'; import { NotificationsService } from '../../shared/notifications/notifications.service'; import { FormBuilderService } from '../../shared/form/builder/form-builder.service'; import { ProfilePageSecurityFormComponent } from './profile-page-security-form.component'; -import { of as observableOf } from 'rxjs'; -import { RestResponse } from '../../core/cache/response.models'; describe('ProfilePageSecurityFormComponent', () => { let component: ProfilePageSecurityFormComponent; let fixture: ComponentFixture; - const user = new EPerson(); + const user = Object.assign(new EPerson(), { + _links: { + self: { href: 'user-selflink' } + } + }); const epersonService = jasmine.createSpyObj('epersonService', { - immediatePatch: observableOf(new RestResponse(true, 200, 'OK')) + patch: {} }); const notificationsService = jasmine.createSpyObj('notificationsService', { success: {}, @@ -58,8 +60,8 @@ describe('ProfilePageSecurityFormComponent', () => { expect(result).toEqual(false); }); - it('should not call epersonService.immediatePatch', () => { - expect(epersonService.immediatePatch).not.toHaveBeenCalled(); + it('should not call epersonService.patch', () => { + expect(epersonService.patch).not.toHaveBeenCalled(); }); }); @@ -91,8 +93,8 @@ describe('ProfilePageSecurityFormComponent', () => { expect(result).toEqual(true); }); - it('should return call epersonService.immediatePatch', () => { - expect(epersonService.immediatePatch).toHaveBeenCalledWith(user, operations); + it('should return call epersonService.patch', () => { + expect(epersonService.patch).toHaveBeenCalledWith(user.self, operations); }); }); }); From 33e395a7f638e85d72ef351fec9e9ee00cf0f11b Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Thu, 12 Mar 2020 17:59:12 +0100 Subject: [PATCH 12/13] 69432: refactor patch to return response --- src/app/core/data/data.service.spec.ts | 29 ++++++++++++------- src/app/core/data/data.service.ts | 26 +++++++++++++---- ...ofile-page-security-form.component.spec.ts | 6 ++-- .../profile-page-security-form.component.ts | 18 ++++++++---- 4 files changed, 56 insertions(+), 23 deletions(-) diff --git a/src/app/core/data/data.service.spec.ts b/src/app/core/data/data.service.spec.ts index c5748b05fb..c370be2b9e 100644 --- a/src/app/core/data/data.service.spec.ts +++ b/src/app/core/data/data.service.spec.ts @@ -16,8 +16,10 @@ import { HALEndpointService } from '../shared/hal-endpoint.service'; import { Item } from '../shared/item.model'; import { ChangeAnalyzer } from './change-analyzer'; import { DataService } from './data.service'; -import { FindListOptions } from './request.models'; +import { FindListOptions, PatchRequest } from './request.models'; import { RequestService } from './request.service'; +import { getMockRequestService } from '../../shared/mocks/mock-request.service'; +import { HALEndpointServiceStub } from '../../shared/testing/hal-endpoint-service-stub'; const endpoint = 'https://rest.api/core'; @@ -53,8 +55,8 @@ class DummyChangeAnalyzer implements ChangeAnalyzer { describe('DataService', () => { let service: TestService; let options: FindListOptions; - const requestService = { generateRequestId: () => uuidv4() } as RequestService; - const halService = {} as HALEndpointService; + const requestService = getMockRequestService(); + const halService = new HALEndpointServiceStub('url') as any; const rdbService = {} as RemoteDataBuildService; const notificationsService = {} as NotificationsService; const http = {} as HttpClient; @@ -285,18 +287,23 @@ describe('DataService', () => { }); describe('patch', () => { - let operations; - let selfLink; + const dso = { + uuid: 'dso-uuid' + }; + const operations = [ + Object.assign({ + op: 'move', + from: '/1', + path: '/5' + }) as Operation + ]; beforeEach(() => { - operations = [{ op: 'replace', path: '/metadata/dc.title', value: 'random string' } as Operation]; - selfLink = 'https://rest.api/endpoint/1698f1d3-be98-4c51-9fd8-6bfedcbd59b7'; - spyOn(objectCache, 'addPatch'); + service.patch(dso, operations); }); - it('should call addPatch on the object cache with the right parameters', () => { - service.patch(selfLink, operations); - expect(objectCache.addPatch).toHaveBeenCalledWith(selfLink, operations); + it('should configure a PatchRequest', () => { + expect(requestService.configure).toHaveBeenCalledWith(jasmine.any(PatchRequest)); }); }); diff --git a/src/app/core/data/data.service.ts b/src/app/core/data/data.service.ts index 3e67675290..473e03d6f7 100644 --- a/src/app/core/data/data.service.ts +++ b/src/app/core/data/data.service.ts @@ -44,7 +44,7 @@ import { FindByIDRequest, FindListOptions, FindListRequest, - GetRequest + GetRequest, PatchRequest } from './request.models'; import { RequestEntry } from './request.reducer'; import { RequestService } from './request.service'; @@ -329,12 +329,28 @@ export abstract class DataService { } /** - * Add a new patch to the object cache to a specified object - * @param {string} href The selflink of the object that will be patched + * Send a patch request for a specified object + * @param {T} dso The object to send a patch request for * @param {Operation[]} operations The patch operations to be performed */ - patch(href: string, operations: Operation[]) { - this.objectCache.addPatch(href, operations); + patch(dso: T, operations: Operation[]): Observable { + const requestId = this.requestService.generateRequestId(); + + const hrefObs = this.halService.getEndpoint(this.linkPath).pipe( + map((endpoint: string) => this.getIDHref(endpoint, dso.uuid))); + + hrefObs.pipe( + find((href: string) => hasValue(href)), + map((href: string) => { + const request = new PatchRequest(requestId, href, operations); + this.requestService.configure(request); + }) + ).subscribe(); + + return this.requestService.getByUUID(requestId).pipe( + find((request: RequestEntry) => request.completed), + map((request: RequestEntry) => request.response) + ); } /** diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts index 9c05fa98d1..2cb687d34d 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts @@ -8,6 +8,8 @@ import { EPersonDataService } from '../../core/eperson/eperson-data.service'; import { NotificationsService } from '../../shared/notifications/notifications.service'; import { FormBuilderService } from '../../shared/form/builder/form-builder.service'; import { ProfilePageSecurityFormComponent } from './profile-page-security-form.component'; +import { of as observableOf } from 'rxjs'; +import { RestResponse } from '../../core/cache/response.models'; describe('ProfilePageSecurityFormComponent', () => { let component: ProfilePageSecurityFormComponent; @@ -20,7 +22,7 @@ describe('ProfilePageSecurityFormComponent', () => { }); const epersonService = jasmine.createSpyObj('epersonService', { - patch: {} + patch: observableOf(new RestResponse(true, 200, 'OK')) }); const notificationsService = jasmine.createSpyObj('notificationsService', { success: {}, @@ -94,7 +96,7 @@ describe('ProfilePageSecurityFormComponent', () => { }); it('should return call epersonService.patch', () => { - expect(epersonService.patch).toHaveBeenCalledWith(user.self, operations); + expect(epersonService.patch).toHaveBeenCalledWith(user, operations); }); }); }); diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts index d7f6213dc6..f964b02280 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts @@ -116,11 +116,19 @@ export class ProfilePageSecurityFormComponent implements OnInit { } if (passEntered) { const operation = Object.assign({ op: 'replace', path: '/password', value: pass }); - this.epersonService.patch(this.user.self, [operation]); - this.notificationsService.success( - this.translate.instant(this.NOTIFICATIONS_PREFIX + 'success.title'), - this.translate.instant(this.NOTIFICATIONS_PREFIX + 'success.content') - ); + this.epersonService.patch(this.user, [operation]).subscribe((response: RestResponse) => { + if (response.isSuccessful) { + this.notificationsService.success( + this.translate.instant(this.NOTIFICATIONS_PREFIX + 'success.title'), + this.translate.instant(this.NOTIFICATIONS_PREFIX + 'success.content') + ); + } else { + this.notificationsService.error( + this.translate.instant(this.NOTIFICATIONS_PREFIX + 'error.title'), (response as ErrorResponse).errorMessage + ); + } + }); + } return passEntered; From a8636b0e5c99e4e956032f9560fbcfc81bfdb4ee Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Wed, 18 Mar 2020 11:43:56 +0100 Subject: [PATCH 13/13] 69432: Fix being able to send invalid password form + 6 character password validator --- resources/i18n/en.json5 | 4 ++++ .../profile-page-security-form.component.html | 1 + ...ofile-page-security-form.component.spec.ts | 8 +++---- .../profile-page-security-form.component.ts | 23 +++++++++++++++---- 4 files changed, 28 insertions(+), 8 deletions(-) diff --git a/resources/i18n/en.json5 b/resources/i18n/en.json5 index decad7309b..a1610c9fd9 100644 --- a/resources/i18n/en.json5 +++ b/resources/i18n/en.json5 @@ -1449,6 +1449,8 @@ "profile.security.form.error.matching-passwords": "The passwords do not match.", + "profile.security.form.error.password-length": "The password should be at least 6 characters long.", + "profile.security.form.info": "Optionally, you can enter a new password in the box below, and confirm it by typing it again into the second box. It should be at least six characters long.", "profile.security.form.label.password": "Password", @@ -1461,6 +1463,8 @@ "profile.security.form.notifications.error.title": "Error changing passwords", + "profile.security.form.notifications.error.not-long-enough": "The password has to be at least 6 characters long.", + "profile.security.form.notifications.error.not-same": "The provided passwords are not the same.", "profile.title": "Update Profile", diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html index 81519e5a42..50a081c6f2 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.html @@ -5,4 +5,5 @@ [formGroup]="formGroup" [displaySubmit]="false"> +
{{'profile.security.form.error.password-length' | translate}}
{{'profile.security.form.error.matching-passwords' | translate}}
diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts index 2cb687d34d..324230ce9f 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.spec.ts @@ -80,14 +80,14 @@ describe('ProfilePageSecurityFormComponent', () => { }); }); - describe('when both password fields are filled in and equal', () => { + describe('when both password fields are filled in, long enough and equal', () => { let result; let operations; beforeEach(() => { - setModelValue('password', 'test'); - setModelValue('passwordrepeat', 'test'); - operations = [{ op: 'replace', path: '/password', value: 'test' }]; + setModelValue('password', 'testest'); + setModelValue('passwordrepeat', 'testest'); + operations = [{ op: 'replace', path: '/password', value: 'testest' }]; result = component.updateSecurity(); }); diff --git a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts index f964b02280..b8ac07e6d8 100644 --- a/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts +++ b/src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts @@ -64,7 +64,7 @@ export class ProfilePageSecurityFormComponent implements OnInit { } ngOnInit(): void { - this.formGroup = this.formService.createFormGroup(this.formModel, { validators: this.checkPasswords }); + this.formGroup = this.formService.createFormGroup(this.formModel, { validators: [this.checkPasswordsEqual, this.checkPasswordLength] }); this.updateFieldTranslations(); this.translate.onLangChange .subscribe(() => { @@ -87,11 +87,21 @@ export class ProfilePageSecurityFormComponent implements OnInit { * Check if both password fields are filled in and equal * @param group The FormGroup to validate */ - checkPasswords(group: FormGroup) { + checkPasswordsEqual(group: FormGroup) { const pass = group.get('password').value; const repeatPass = group.get('passwordrepeat').value; - return isEmpty(repeatPass) || pass === repeatPass ? null : { notSame: true }; + return pass === repeatPass ? null : { notSame: true }; + } + + /** + * Check if the password is at least 6 characters long + * @param group The FormGroup to validate + */ + checkPasswordLength(group: FormGroup) { + const pass = group.get('password').value; + + return isEmpty(pass) || pass.length >= 6 ? null : { notLongEnough: true }; } /** @@ -109,7 +119,12 @@ export class ProfilePageSecurityFormComponent implements OnInit { const passEntered = isNotEmpty(pass); if (!this.formGroup.valid) { if (passEntered) { - this.notificationsService.error(this.translate.instant(this.NOTIFICATIONS_PREFIX + 'error.not-same')); + if (this.checkPasswordsEqual(this.formGroup) != null) { + this.notificationsService.error(this.translate.instant(this.NOTIFICATIONS_PREFIX + 'error.not-same')); + } + if (this.checkPasswordLength(this.formGroup) != null) { + this.notificationsService.error(this.translate.instant(this.NOTIFICATIONS_PREFIX + 'error.not-long-enough')); + } return true; } return false;