Merge pull request #1472 from 4Science/CST-4875-Feedback-form

Feedback form

Author: tdonohue

src/app/app-routing-paths.ts

@@ -32,6 +32,12 @@ export function getBitstreamRequestACopyRoute(item, bitstream): { routerLink: st
   };
 }
 
+export const HOME_PAGE_PATH = 'admin';
+
+export function getHomePageRoute() {
+  return `/${HOME_PAGE_PATH}`;
+}
+
 export const ADMIN_MODULE_PATH = 'admin';
 
 export function getAdminModuleRoute() {

src/app/core/core.module.ts

@@ -77,6 +77,7 @@ 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 { FeedbackDataService } from './feedback/feedback-data.service';
 
 import { ApiService } from './services/api.service';
 import { ServerResponseService } from './services/server-response.service';
@@ -286,7 +287,8 @@ const PROVIDERS = [
   VocabularyService,
   VocabularyTreeviewService,
   SequenceService,
-  GroupDataService
+  GroupDataService,
+  FeedbackDataService,
 ];
 
 /**

src/app/core/data/feature-authorization/feature-id.ts

@@ -27,4 +27,5 @@ export enum FeatureID {
   CanDeleteVersion = 'canDeleteVersion',
   CanCreateVersion = 'canCreateVersion',
   CanViewUsageStatistics = 'canViewUsageStatistics',
+  CanSendFeedback = 'canSendFeedback',
 }

src/app/core/feedback/feedback-data.service.spec.ts

@@ -0,0 +1,88 @@
+import { FeedbackDataService } from './feedback-data.service';
+import { HALLink } from '../shared/hal-link.model';
+import { Item } from '../shared/item.model';
+import { HALEndpointServiceStub } from '../../shared/testing/hal-endpoint-service.stub';
+import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
+import { getMockRequestService } from '../../shared/mocks/request.service.mock';
+import { NotificationsService } from '../../shared/notifications/notifications.service';
+import { HttpClient } from '@angular/common/http';
+import { Store } from '@ngrx/store';
+import { CoreState } from '../core.reducers';
+import { DSOChangeAnalyzer } from '../data/dso-change-analyzer.service';
+import { Feedback } from './models/feedback.model';
+
+describe('FeedbackDataService', () => {
+  let service: FeedbackDataService;
+  let requestService;
+  let halService;
+  let rdbService;
+  let notificationsService;
+  let http;
+  let comparator;
+  let objectCache;
+  let store;
+  let item;
+  let bundleLink;
+  let bundleHALLink;
+
+  const feedbackPayload = Object.assign(new Feedback(), {
+    email: '[email protected]',
+    message: 'message',
+    page: '/home'
+  });
+
+
+  function initTestService(): FeedbackDataService {
+    bundleLink = '/items/0fdc0cd7-ff8c-433d-b33c-9b56108abc07/bundles';
+    bundleHALLink = new HALLink();
+    bundleHALLink.href = bundleLink;
+    item = new Item();
+    item._links = {
+      bundles: bundleHALLink
+    };
+    requestService = getMockRequestService();
+    halService = new HALEndpointServiceStub('url') as any;
+    rdbService = {} as RemoteDataBuildService;
+    notificationsService = {} as NotificationsService;
+    http = {} as HttpClient;
+    comparator = new DSOChangeAnalyzer() as any;
+    objectCache = {
+
+      addPatch: () => {
+        /* empty */
+      },
+      getObjectBySelfLink: () => {
+        /* empty */
+      }
+    } as any;
+    store = {} as Store<CoreState>;
+    return new FeedbackDataService(
+      requestService,
+      rdbService,
+      store,
+      objectCache,
+      halService,
+      notificationsService,
+      http,
+      comparator,
+    );
+  }
+
+
+  beforeEach(() => {
+    service = initTestService();
+  });
+
+
+  describe('getFeedback', () => {
+    beforeEach(() => {
+      spyOn(service, 'getFeedback');
+      service.getFeedback('3');
+    });
+
+    it('should call getFeedback with the feedback link', () => {
+      expect(service.getFeedback).toHaveBeenCalledWith('3');
+    });
+  });
+
+});

src/app/core/feedback/feedback-data.service.ts

@@ -0,0 +1,49 @@
+import { Injectable } from '@angular/core';
+import { Observable } from 'rxjs';
+import { DataService } from '../data/data.service';
+import { Feedback } from './models/feedback.model';
+import { FEEDBACK } from './models/feedback.resource-type';
+import { dataService } from '../cache/builders/build-decorators';
+import { RequestService } from '../data/request.service';
+import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
+import { 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 { DSOChangeAnalyzer } from '../data/dso-change-analyzer.service';
+import { getFirstSucceededRemoteData, getRemoteDataPayload } from '../shared/operators';
+
+/**
+ * Service for checking and managing the feedback
+ */
+@Injectable()
+@dataService(FEEDBACK)
+export class FeedbackDataService extends DataService<Feedback> {
+  protected linkPath = 'feedbacks';
+
+  constructor(
+    protected requestService: RequestService,
+    protected rdbService: RemoteDataBuildService,
+    protected store: Store<any>,
+    protected objectCache: ObjectCacheService,
+    protected halService: HALEndpointService,
+    protected notificationsService: NotificationsService,
+    protected http: HttpClient,
+    protected comparator: DSOChangeAnalyzer<Feedback>,
+  ) {
+    super();
+  }
+
+  /**
+   * Get feedback from its id
+   * @param uuid string the id of the feedback
+   */
+  getFeedback(uuid: string): Observable<Feedback> {
+    return this.findById(uuid).pipe(
+      getFirstSucceededRemoteData(),
+      getRemoteDataPayload(),
+    );
+  }
+
+}

src/app/core/feedback/feedback.guard.ts

@@ -0,0 +1,20 @@
+import { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot, UrlTree } from '@angular/router';
+import { Observable } from 'rxjs';
+import { AuthorizationDataService } from '../data/feature-authorization/authorization-data.service';
+import { FeatureID } from '../data/feature-authorization/feature-id';
+import { Injectable } from '@angular/core';
+
+/**
+ * An guard for redirecting users to the feedback page if user is authorized
+ */
+@Injectable()
+export class FeedbackGuard implements CanActivate {
+
+  constructor(private authorizationService: AuthorizationDataService) {
+  }
+
+  canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean | UrlTree> {
+    return this.authorizationService.isAuthorized(FeatureID.CanSendFeedback);
+  }
+
+}

src/app/core/feedback/models/feedback.model.ts

@@ -0,0 +1,34 @@
+import { autoserialize, inheritSerialization } from 'cerialize';
+import { typedObject } from '../../cache/builders/build-decorators';
+
+import { DSpaceObject } from '../../shared/dspace-object.model';
+import { HALLink } from '../../shared/hal-link.model';
+import { FEEDBACK } from './feedback.resource-type';
+
+@typedObject
+@inheritSerialization(DSpaceObject)
+export class Feedback extends DSpaceObject {
+  static type = FEEDBACK;
+
+  /**
+   * The email address
+   */
+  @autoserialize
+  public email: string;
+
+  /**
+   * A string representing message the user inserted
+   */
+  @autoserialize
+  public message: string;
+  /**
+   * A string representing the page from which the user came from
+   */
+  @autoserialize
+  public page: string;
+
+  _links: {
+    self: HALLink;
+  };
+
+}

src/app/core/feedback/models/feedback.resource-type.ts

@@ -0,0 +1,9 @@
+import { ResourceType } from '../../shared/resource-type';
+
+/**
+ * The resource type for Feedback
+ *
+ * Needs to be in a separate file to prevent circular
+ * dependencies in webpack.
+ */
+export const FEEDBACK = new ResourceType('feedback');

src/app/footer/footer.component.html

@@ -75,6 +75,10 @@ <h5 class="text-uppercase">Footer Content</h5>
           <a class="text-white"
              routerLink="info/end-user-agreement">{{ 'footer.link.end-user-agreement' | translate}}</a>
         </li>
+        <li>
+          <a class="text-white"
+             routerLink="info/feedback">{{ 'footer.link.feedback' | translate}}</a>
+        </li>
       </ul>
     </div>
   </div>

src/app/info/feedback/feedback-form/feedback-form.component.html

@@ -0,0 +1,45 @@
+<div class="row row-offcanvas row-offcanvas-right">
+  <div class="col-xs-12 col-sm-12 col-md-9 main-content">
+    <form class="primary" [formGroup]="feedbackForm" (ngSubmit)="createFeedback()">
+      <h2>{{ 'info.feedback.head' | translate }}</h2>
+      <p>{{ 'info.feedback.info' | translate }}</p>
+      <fieldset class="col p-0">
+        <div class="row">
+          <div class="control-group col-sm-12">
+            <label class="control-label" for="email">{{ 'info.feedback.email-label' | translate }}&nbsp;</label>
+            <input id="email" class="form-control" name="email" type="text" value="" formControlName="email" autofocus="autofocus" title="{{ 'info.feedback.email_help' | translate }}">
+            <small class="text-muted">{{ 'info.feedback.email_help' | translate }}</small>
+          </div>
+        </div>
+
+        <ng-container *ngIf="feedbackForm.controls.email.invalid && (feedbackForm.controls.email.dirty || feedbackForm.controls.email.touched)"
+          class="alert">
+          <ds-error *ngIf="feedbackForm.controls.email.errors?.required" message="{{'info.feedback.error.email.required' | translate}}"></ds-error>
+          <ds-error *ngIf="feedbackForm.controls.email.errors?.pattern" message="{{'info.feedback.error.email.required' | translate}}"></ds-error>
+        </ng-container>
+        <div class="row">
+          <div class="control-group col-sm-12">
+            <label class="control-label" for="comments">{{ 'info.feedback.comments' | translate }}:&nbsp;</label>
+            <textarea id="comments" formControlName="message" class="form-control" name="message" cols="20" rows="5"> </textarea>
+          </div>
+        </div>
+        <ng-container *ngIf="feedbackForm.controls.message.invalid && (feedbackForm.controls.message.dirty || feedbackForm.controls.message.touched)"
+          class="alert">
+          <ds-error *ngIf="feedbackForm.controls.message.errors?.required" message="{{'info.feedback.error.message.required' | translate}}"></ds-error>
+        </ng-container>
+        <div class="row">
+          <div class="control-group col-sm-12">
+            <label class="control-label" for="page">{{ 'info.feedback.page-label' | translate }}&nbsp;</label>
+            <input id="page" readonly class="form-control" name="page" type="text" value="" formControlName="page" autofocus="autofocus" title="{{ 'info.feedback.page_help' | translate }}">
+            <small class="text-muted">{{ 'info.feedback.page_help' | translate }}</small>
+          </div>
+        </div>
+        <div class="row py-2">
+          <div class="control-group col-sm-12 text-right">
+            <button [disabled]="!feedbackForm.valid" class="btn btn-primary" name="submit" type="submit">{{ 'info.feedback.send' | translate }}</button>
+          </div>
+        </div>
+      </fieldset>
+    </form>
+  </div>
+</div>