Added project edits functionality. Resolves #1135. (#1144)

MillenniumFalconMechanic · web-flow · commit 27d6b9374fb9 · 2020-04-10T16:34:07.000-07:00
diff --git a/spa/src/app/_ngrx/app.effects.ts b/spa/src/app/_ngrx/app.effects.ts
@@ -13,6 +13,7 @@ import { FileManifestEffects } from "../files/_ngrx/file-manifest/file-manifest.
 import { IntegrationEffects } from "../files/_ngrx/integration/integration.effects";
 import { MatrixEffects } from "../files/_ngrx/matrix/matrix.effects";
 import { ProjectEffects } from "../files/_ngrx/project/project.effects";
+import { ProjectEditsEffects } from "../files/_ngrx/project-edits/project-edits.effects";
 import { ReleaseEffects } from "../files/_ngrx/release/release.effects";
 import { SystemEffects } from "../system/_ngrx/system.effects";
 import { TableEffects } from "../files/_ngrx/table/table.effects";
@@ -26,6 +27,7 @@ export const AppEffects = [
     IntegrationEffects,
     MatrixEffects,
     ProjectEffects,
+    ProjectEditsEffects,
     ReleaseEffects,
     SystemEffects,
     TableEffects,
diff --git a/spa/src/app/app.component.ts b/spa/src/app/app.component.ts
@@ -17,6 +17,8 @@ import { filter, map, takeUntil } from "rxjs/operators";
 import { Config } from "./config/config.model";
 import { selectConfigConfig } from "./config/_ngrx/config.selectors";
 import { SetViewStateAction } from "./files/_ngrx/file-facet-list/set-view-state.action";
+import { ClearReleaseReferrerAction } from "./files/_ngrx/release/clear-release-referrer.action";
+import { FetchProjectEditsRequestAction } from "./files/_ngrx/project-edits/fetch-project-edits-request.action";
 import { EntityName } from "./files/shared/entity-name.model";
 import { FileFacetName } from "./files/shared/file-facet-name.model";
 import { QueryStringFacet } from "./files/shared/query-string-facet.model";
@@ -28,7 +30,6 @@ import { HealthRequestAction } from "./system/_ngrx/health/health-request.action
 import { selectHealth, selectIndex } from "./system/_ngrx/system.selectors";
 import { IndexRequestAction } from "./system/_ngrx/index/index-request.action";
 import { SystemState } from "./system.state";
-import { ClearReleaseReferrerAction } from "./files/_ngrx/release/clear-release-referrer.action";
 
 @Component({
     selector: "app-root",
@@ -125,6 +126,14 @@ export class AppComponent implements OnInit, OnDestroy {
         return !!params["filter"];
     }
 
+    /**
+     * Load project edits data from local JSON files.
+     */
+    private loadProjectEditsData(): void {
+
+        this.store.dispatch(new FetchProjectEditsRequestAction());
+    }
+    
     /**
      * Load release data from local JSON files.
      */
@@ -285,6 +294,7 @@ export class AppComponent implements OnInit, OnDestroy {
         this.setAppStateFromURL();
         this.systemCheck();
         this.loadReleaseData();
+        this.loadProjectEditsData();
         this.initReleaseReferrerListener();
         
         this.config$ = this.store.pipe(
diff --git a/spa/src/app/files/_ngrx/file.reducer.ts b/spa/src/app/files/_ngrx/file.reducer.ts
@@ -12,6 +12,7 @@ import * as fileManifestReducer from "./file-manifest/file-manifest.reducer";
 import * as integrationReducer from "./integration/integration.reducer";
 import * as matrixReducer from "./matrix/matrix.reducer";
 import * as projectReducer from "./project/project.reducer";
+import * as projectEditsReducer from "./project-edits/project-edits.reducer";
 import * as releaseReducer from "./release/release.reducer";
 import * as tableReducer from "./table/table.reducer";
 import * as searchReducer from "./search/search.reducer";
@@ -23,6 +24,7 @@ export const reducer = {
     integration: integrationReducer.reducer,
     matrix: matrixReducer.reducer,
     project: projectReducer.reducer,
+    projectEdits: projectEditsReducer.reducer,
     release: releaseReducer.reducer,
     search: searchReducer.reducer,
     tableState: tableReducer.reducer
diff --git a/spa/src/app/files/_ngrx/file.state.mock.ts b/spa/src/app/files/_ngrx/file.state.mock.ts
@@ -19,6 +19,7 @@ import { EntityName } from "../shared/entity-name.model";
 import * as searchStateMock from "./search/search.state.mock";
 import { IntegrationState } from "./integration/integration.state";
 import { ReleaseState } from "./release/release.state";
+import { ProjectEditsState } from "./project-edits/project-edits.state";
 
 /**
  * Default project state - current tab is projects, no selected search terms
@@ -30,6 +31,7 @@ export const DEFAULT_PROJECTS_STATE = {
     integration: IntegrationState.getDefaultState(),
     matrix: MatrixState.getDefaultState(),
     project: ProjectState.getDefaultState(),
+    projectEdits: ProjectEditsState.getDefaultState(),
     release: ReleaseState.getDefaultState(),
     search: SearchState.getDefaultState(),
     tableState: getDefaultTableState(),
diff --git a/spa/src/app/files/_ngrx/file.state.ts b/spa/src/app/files/_ngrx/file.state.ts
@@ -13,6 +13,7 @@ import { FileSummaryState } from "./file-summary/file-summary.state";
 import { IntegrationState } from "./integration/integration.state";
 import { MatrixState } from "./matrix/matrix.state";
 import { ProjectState } from "./project/project.state";
+import { ProjectEditsState } from "./project-edits/project-edits.state";
 import { ReleaseState } from "./release/release.state";
 import { SearchState } from "./search/search.state";
 import { TableState } from "./table/table.state";
@@ -25,6 +26,7 @@ export interface FileState {
     integration: IntegrationState,
     matrix: MatrixState;
     project: ProjectState;
+    projectEdits: ProjectEditsState,
     release: ReleaseState,
     search: SearchState;
     tableState: TableState;
diff --git a/spa/src/app/files/_ngrx/project-edits/fetch-project-edits-request.action.ts b/spa/src/app/files/_ngrx/project-edits/fetch-project-edits-request.action.ts
@@ -0,0 +1,16 @@
+/**
+ * Human Cell Atlas
+ * https://www.humancellatlas.org/
+ *
+ * Action that is triggered on load of app, to read local JSON project edits data into store.
+ */
+
+// Core dependencies
+import { Action } from "@ngrx/store";
+
+export class FetchProjectEditsRequestAction implements Action {
+    public static ACTION_TYPE = "PROJECT.FETCH_EDITS_REQUEST";
+    public readonly type = FetchProjectEditsRequestAction.ACTION_TYPE;
+    constructor() {}
+}
+
diff --git a/spa/src/app/files/_ngrx/project-edits/fetch-project-edits-success.action.ts b/spa/src/app/files/_ngrx/project-edits/fetch-project-edits-success.action.ts
@@ -0,0 +1,19 @@
+/**
+ * Human Cell Atlas
+ * https://www.humancellatlas.org/
+ *
+ * Action that is triggered when project edits data has been successfully read from local JSON.
+ */
+
+// Core dependencies
+import { Action } from "@ngrx/store";
+
+// App dependencies
+import { Project } from "../../shared/project.model";
+
+export class FetchProjectEditsSuccessAction implements Action {
+    public static ACTION_TYPE = "PROJECT.FETCH_EDITS_SUCCESS";
+    public readonly type = FetchProjectEditsSuccessAction.ACTION_TYPE;
+    constructor(public readonly projects: Project[]) {}
+}
+
diff --git a/spa/src/app/files/_ngrx/project-edits/project-edits.effects.ts b/spa/src/app/files/_ngrx/project-edits/project-edits.effects.ts
@@ -0,0 +1,50 @@
+/**
+ * Human Cell Atlas
+ * https://www.humancellatlas.org/
+ *
+ * Coordination of side effects from project edits-related functionality.
+ */
+
+// Core dependencies
+import { Injectable } from "@angular/core";
+import { Actions, Effect, ofType } from "@ngrx/effects";
+import { Action, select, Store } from "@ngrx/store";
+import { Observable, of } from "rxjs";
+import { map, switchMap, take } from "rxjs/operators";
+
+// App dependencies
+import { FetchProjectEditsRequestAction } from "./fetch-project-edits-request.action";
+import { FetchProjectEditsSuccessAction } from "./fetch-project-edits-success.action";
+import { AppState } from "../../../_ngrx/app.state";
+import { ProjectEditsService } from "../../shared/project-edits.service";
+
+@Injectable()
+export class ProjectEditsEffects {
+
+    /**
+     * @param {Store<AppState>} store
+     * @param {Actions} actions$
+     * @param {ProjectEditsService} projectEditsService
+     */
+    constructor(private store: Store<AppState>,
+                private actions$: Actions,
+                private projectEditsService: ProjectEditsService) {
+    }
+    
+    /**
+     * Trigger fetch of project edits.
+     */
+    @Effect()
+    fetchProjectEdits: Observable<Action> = this.actions$
+        .pipe(
+            ofType(FetchProjectEditsRequestAction.ACTION_TYPE),
+            switchMap(() => {
+
+                return this.projectEditsService.fetchProjectEdits();
+            }),
+            map((projects) => {
+
+                return new FetchProjectEditsSuccessAction(projects);
+            })
+        );
+}
diff --git a/spa/src/app/files/_ngrx/project-edits/project-edits.model.ts b/spa/src/app/files/_ngrx/project-edits/project-edits.model.ts
@@ -0,0 +1,14 @@
+/**
+ * Human Cell Atlas
+ * https://www.humancellatlas.org/
+ *
+ * Model of project edits-related state, persisted in local store.
+ */
+
+// App dependencies
+import { Project } from "../../shared/project.model";
+
+export interface ProjectEdits {
+    projects: Project[];
+    projectsById: Map<string, Project>;
+}
diff --git a/spa/src/app/files/_ngrx/project-edits/project-edits.reducer.ts b/spa/src/app/files/_ngrx/project-edits/project-edits.reducer.ts
@@ -0,0 +1,29 @@
+/**
+ * Human Cell Atlas
+ * https://www.humancellatlas.org/
+ *
+ * Reducer responsible for updating project edits-related state.
+ */
+
+// Core dependencies
+import { Action } from "@ngrx/store";
+
+// App dependencies
+import { FetchProjectEditsRequestAction } from "./fetch-project-edits-request.action";
+import { FetchProjectEditsSuccessAction } from "./fetch-project-edits-success.action";
+import { ProjectEditsState } from "./project-edits.state";
+
+export function reducer(state: ProjectEditsState = ProjectEditsState.getDefaultState(), action: Action): ProjectEditsState {
+
+    switch (action.type) {
+
+        case FetchProjectEditsRequestAction.ACTION_TYPE:
+            return state.fetchProjectEditsRequest();
+
+        case FetchProjectEditsSuccessAction.ACTION_TYPE:
+            return state.fetchProjectEditsSuccess(action as FetchProjectEditsSuccessAction);
+
+        default:
+            return state;
+    }
+}
diff --git a/spa/src/app/files/_ngrx/project-edits/project-edits.selectors.ts b/spa/src/app/files/_ngrx/project-edits/project-edits.selectors.ts
@@ -0,0 +1,33 @@
+/**
+ * Human Cell Atlas
+ * https://www.humancellatlas.org/
+ *
+ * Selectors for querying project edits-related state from the file store.
+ */
+
+// Core dependencies
+import { createFeatureSelector, createSelector } from "@ngrx/store";
+import { ProjectEditsState } from "./project-edits.state";
+
+// App dependencies
+
+/**
+ * Returns the project edits-related slice of state.
+ */
+export const selectProjectEdits = createFeatureSelector<ProjectEditsState>("projectEdits");
+
+/**
+ * Returns all projects.
+ */
+export const selectProjects =
+    createSelector(selectProjectEdits, (state) => state.projects);
+
+/**
+ * Returns the project with the specified ID.
+ */
+export const selectProjectById =
+    createSelector(selectProjectEdits, (state, props) => {
+        return state.projectsById.get(props.id) || {};
+    });
+
+
diff --git a/spa/src/app/files/_ngrx/project-edits/project-edits.state.ts b/spa/src/app/files/_ngrx/project-edits/project-edits.state.ts
@@ -0,0 +1,54 @@
+/**
+ * Human Cell Atlas
+ * https://www.humancellatlas.org/
+ *
+ * Representation of project edits-related state persisted in local store.
+ */
+
+// App dependencies
+import { FetchProjectEditsSuccessAction } from "./fetch-project-edits-success.action";
+import { ProjectEdits } from "./project-edits.model";
+import { Project } from "../../shared/project.model";
+
+export class ProjectEditsState implements ProjectEdits {
+
+    projects: Project[];
+    projectsById: Map<string, Project>;
+
+    /**
+     * @param {Project[]} projects
+     */
+    constructor(projects) {
+        
+        this.projects = projects;
+        this.projectsById = projects.reduce((accum, project) => {
+            accum.set(project.entryId, project);
+            return accum;
+        }, new Map<string, Project>());
+    }
+
+    /**
+     * @returns {ProjectEditsState}
+     */
+    public fetchProjectEditsRequest(): ProjectEditsState {
+        return this;
+    }
+
+    /**
+     * Project edits data has been successfully read from local JSON, store it.
+     * 
+     * @param {FetchProjectEditsSuccessAction} action
+     * @returns {ProjectEditsState}
+     */
+    public fetchProjectEditsSuccess(action: FetchProjectEditsSuccessAction): ProjectEditsState {
+
+        return new ProjectEditsState(action.projects);
+    }
+
+    /**
+     * @returns {ProjectEditsState}
+     */
+    public static getDefaultState() {
+        return new ProjectEditsState([]);
+    }
+}
diff --git a/spa/src/app/files/_ngrx/table/table.effects.ts b/spa/src/app/files/_ngrx/table/table.effects.ts
@@ -22,14 +22,15 @@ import {
     FetchProjectSuccessAction,
 } from "./table.actions";
 import { FetchFileFacetsRequestAction } from "../file-facet-list/file-facet-list.actions";
+import { selectTableQueryParams } from "../file.selectors";
 import { FetchFileSummaryRequestAction } from "../file-summary/file-summary.actions";
 import { FetchTableDataRequestAction } from "./fetch-table-data-request.action";
 import { FetchTableDataSuccessAction } from "./fetch-table-data-success.action";
 import { FetchTableModelRequestAction } from "./fetch-table-model-request.action";
 import { FetchTableModelSuccessAction } from "./fetch-table-model-success.action";
+import { selectProjectById } from "../project-edits/project-edits.selectors";
 import { EntityName } from "../../shared/entity-name.model";
 import { SelectProjectIdAction } from "../search/select-project-id.action";
-import { selectTableQueryParams } from "../file.selectors";
 import { EntitySearchResults } from "../../shared/entity-search-results.model";
 import { DEFAULT_TABLE_PARAMS } from "../../table/table-params.model";
 import { FilesService } from "../../shared/files.service";
@@ -114,13 +115,26 @@ export class TableEffects {
         );
 
     /**
-     * Trigger fetch and display of project, when selected from the project table.
+     * Trigger fetch and display of project, when selected from the project table. Must also grab projects edit data from
+     * the store to update publication and contributor details, where specifed.
      */
     @Effect()
     fetchProject: Observable<Action> = this.actions$
         .pipe(
             ofType(FetchProjectRequestAction.ACTION_TYPE),
-            switchMap((action: FetchProjectRequestAction) => this.projectService.fetchProjectById(action.projectId)),
+            switchMap((action: FetchProjectRequestAction) => {
+                
+                return this.store.pipe(
+                    select(selectProjectById, {id: action.projectId}),
+                    map((updatedProject: Project) => {
+                        
+                        // Grab the project from the release
+                        return {action, updatedProject};
+                    })
+                );
+            }),
+            switchMap(({action, updatedProject}) => 
+                this.projectService.fetchProjectById(action.projectId, updatedProject)),
             map((project: Project) => new FetchProjectSuccessAction(project))
         );
 
diff --git a/spa/src/app/files/files.module.ts b/spa/src/app/files/files.module.ts
@@ -96,6 +96,7 @@ import { ProjectNavComponent } from "./project-nav/project-nav.component";
 import { ProjectOverviewComponent } from "./project-overview/project-overview.component";
 import { ProjectOverviewDataSummaryComponent } from "./project-overview-data-summary/project-overview-data-summary.component";
 import { ProjectReleaseComponent } from "./project-release/project-release.component";
+import { ProjectEditsService } from "./shared/project-edits.service";
 import { ProjectService } from "./project/project.service";
 import { ProjectSummaryStatsComponent } from "./project-summary-stats-component/project-summary-stats.component";
 import { ProjectViewFactory } from "./project-view/project-view.factory";
@@ -239,6 +240,7 @@ import { ReleaseVisualizationsModalContainerComponent } from "./releases/visuali
         IntegrationService,
         MatrixService,
         ProjectService,
+        ProjectEditsService,
         ProjectViewFactory,
         ReleaseService,
         SearchTermService,
diff --git a/spa/src/app/files/hca-get-data/hca-export-to-terra/hca-export-to-terra.component.ts b/spa/src/app/files/hca-get-data/hca-export-to-terra/hca-export-to-terra.component.ts
@@ -31,7 +31,6 @@ import { GTMService } from "../../../shared/gtm/gtm.service";
 import { GACategory } from "../../../shared/gtm/ga-category.model";
 import { GAAction } from "../../../shared/gtm/ga-action.model";
 import { GADimension } from "../../../shared/gtm/ga-dimension.model";
-import { ReleaseName } from "../../releases/release-name.model";
 import { ToolName } from "../../shared/tool-name.model";
 
 @Component({
diff --git a/spa/src/app/files/project-edits/project-edits.json b/spa/src/app/files/project-edits/project-edits.json
diff --git a/spa/src/app/files/project/project-mapper.ts b/spa/src/app/files/project/project-mapper.ts
diff --git a/spa/src/app/files/project/project.service.spec.ts b/spa/src/app/files/project/project.service.spec.ts
diff --git a/spa/src/app/files/project/project.service.ts b/spa/src/app/files/project/project.service.ts
diff --git a/spa/src/app/files/shared/project-edits.service.ts b/spa/src/app/files/shared/project-edits.service.ts
