Added matrix mouse functionality. Resolves #895. (#957)

* Spawned request for each non-human request. Resolves #895.

* Test for hca-get-matrix component. First pass.

* Updated UI.

* Test for hca-get-matrix component. Second pass.

* Test for hca-get-matrix component. Third pass.

* Test for matrix-url-request-form component.

* Test for matrix-url-request-completed component.

* Updated UI for multiple requests.

* Test for hca-get-matrix component. Second pass.

* Test for matrix-url-request-form component. Second pass.

* Test for matrix-url-request-completed component. Second pass.

* Test for hca-get-matrix component. Third pass.

* Updated failed logic. Updated tests. Resolves #895.

Author: MillenniumFalconMechanic

spa/src/app/files/_ngrx/matrix/fetch-matrix-url-species-success.action.ts

@@ -0,0 +1,17 @@
+/**
+ * Human Cell Atlas
+ * https://www.humancellatlas.org/
+ *
+ * Action that is triggered when a successful response is received when requesting the matrix URL and we need to set up
+ * the state for each species contained in the response.
+ */
+
+// Core dependencies
+import { Action } from "@ngrx/store";
+import { MatrixUrlRequestSpecies } from "../../shared/matrix-url-request-species.model";
+
+export class FetchMatrixUrlSpeciesSuccessAction implements Action {
+    public static ACTION_TYPE = "FILE.FETCH_MATRIX_URL_SPECIES_SUCCESS";
+    public readonly type = FetchMatrixUrlSpeciesSuccessAction.ACTION_TYPE;
+    constructor(public readonly response: MatrixUrlRequestSpecies) {}
+}

spa/src/app/files/_ngrx/matrix/fetch-matrix-url-success.action.ts

@@ -9,10 +9,10 @@
 
 // Core dependencies
 import { Action } from "@ngrx/store";
-import { MatrixResponse } from "../../shared/matrix-response.model";
+import { MatrixUrlRequest } from "../../shared/matrix-url-request.model";
 
 export class FetchMatrixUrlSuccessAction implements Action {
     public static ACTION_TYPE = "FILE.FETCH_MATRIX_URL_SUCCESS";
     public readonly type = FetchMatrixUrlSuccessAction.ACTION_TYPE;
-    constructor(public readonly response: MatrixResponse) {}
+    constructor(public readonly response: MatrixUrlRequest) {}
 }

spa/src/app/files/_ngrx/matrix/matrix.effects.ts

@@ -19,6 +19,7 @@ import { FetchMatrixPartialQueryMatchSuccessAction } from "./fetch-matrix-partia
 import { FetchMatrixPartialQueryMatchRequestAction } from "./fetch-matrix-partial-query-match-request.action";
 import { FetchMatrixUrlRequestAction } from "./fetch-matrix-url-request.action";
 import { FetchMatrixUrlSuccessAction } from "./fetch-matrix-url-success.action";
+import { FetchMatrixUrlSpeciesSuccessAction } from "./fetch-matrix-url-species-success.action";
 import { FetchProjectMatrixUrlsRequestAction } from "./fetch-project-matrix-urls-request.action";
 import { FetchProjectMatrixUrlsSuccessAction } from "./fetch-project-matrix-urls-success.action";
 import { MatrixService } from "../../shared/matrix.service";
@@ -28,14 +29,16 @@ import { selectSelectedSearchTerms, selectSelectedSearchTermsBySearchKey } from
 import { FilesService } from "../../shared/files.service";
 import { DEFAULT_TABLE_PARAMS } from "../../table/table-params.model";
 import { SearchTerm } from "../../search/search-term.model";
+import { MatrixUrlRequest } from "../../shared/matrix-url-request.model";
+import { MatrixUrlRequestSpecies } from "../../shared/matrix-url-request-species.model";
 
 @Injectable()
 export class MatrixEffects {
 
     /**
      * @param {Store<AppState>} store
      * @param {Actions} actions$
-     * @param {FilesService} filesService
+     * @param {FilesService} fileService
      * @param {MatrixService} matrixService
      */
     constructor(private store: Store<AppState>,
@@ -99,7 +102,15 @@ export class MatrixEffects {
                 const {fileFormat, killSwitch$} = (action as FetchMatrixUrlRequestAction);
                 return this.matrixService.requestMatrixUrl(searchTerms, fileFormat, killSwitch$);
             }),
-            map(response => new FetchMatrixUrlSuccessAction(response))
+            map(response => {
+
+                // Response can be of type MatrixUrlRequest or MatrixUrlRequestSpecies
+                if ( response["matrixUrlRequestsBySpecies"] ) {
+                    return new FetchMatrixUrlSpeciesSuccessAction(response as MatrixUrlRequestSpecies)
+                }
+
+                return new FetchMatrixUrlSuccessAction(response as MatrixUrlRequest);
+            })
         );
 
     /**

spa/src/app/files/_ngrx/matrix/matrix.model.ts

@@ -6,12 +6,12 @@
  */
 
 // App dependencies
-import { MatrixResponse } from "../../shared/matrix-response.model";
+import { MatrixUrlRequest } from "../../shared/matrix-url-request.model";
 import { ProjectMatrixUrls } from "../../shared/project-matrix-urls.model";
 
 export interface Matrix {
     fileFormats: string[];
     partialQueryMatch: boolean;
-    matrixResponse: MatrixResponse;
-    matrixUrlsByProjectId: Map<string, ProjectMatrixUrls>
+    matrixUrlRequestsBySpecies: Map<string, MatrixUrlRequest>;
+    matrixUrlsByProjectId: Map<string, ProjectMatrixUrls>;
 }

spa/src/app/files/_ngrx/matrix/matrix.reducer.ts

@@ -17,6 +17,7 @@ import { FetchMatrixUrlSuccessAction } from "./fetch-matrix-url-success.action";
 import { FetchProjectMatrixUrlsSuccessAction } from "./fetch-project-matrix-urls-success.action";
 import { CancelFetchMatrixUrlRequestAction } from "./cancel-fetch-matrix-url-request.action";
 import { MatrixState } from "./matrix.state";
+import { FetchMatrixUrlSpeciesSuccessAction } from "./fetch-matrix-url-species-success.action";
 
 export function reducer(state: MatrixState = MatrixState.getDefaultState(), action: Action): MatrixState {
 
@@ -38,7 +39,11 @@ export function reducer(state: MatrixState = MatrixState.getDefaultState(), acti
 
         // Matrix URL request status has been updated
         case FetchMatrixUrlSuccessAction.ACTION_TYPE:
-            return state.fetchMatrixUrlSuccess(action as FetchMatrixUrlSuccessAction);
+            return state.fetchMatrixUrlRequestSuccess(action as FetchMatrixUrlSuccessAction);
+
+        // Initial Matrix URL request status for each species has been received
+        case FetchMatrixUrlSpeciesSuccessAction.ACTION_TYPE:
+            return state.fetchMatrixUrlRequestSpeciesSuccess(action as FetchMatrixUrlSpeciesSuccessAction);
 
         // Matrix URL request has been canceled
         case CancelFetchMatrixUrlRequestAction.ACTION_TYPE:

spa/src/app/files/_ngrx/matrix/matrix.selectors.ts

@@ -22,14 +22,16 @@ export const selectMatrix = createFeatureSelector<MatrixState>("matrix");
 export const selectMatrixFileFormats = createSelector(selectMatrix, (state) => state.fileFormats);
 
 /**
- * Returns the status of the current matrix URL request.
+ * Returns the status of the current matrix URL requests, for each species.
  */
-export const selectMatrixResponse = createSelector(selectMatrix, (state) => state.matrixResponse);
+export const selectMatrixUrlRequestsBySpecies =
+    createSelector(selectMatrix, (state) => state.matrixUrlRequestsBySpecies);
 
 /**
  * Returns the current set of cached per-project matrix URLs
  */
-export const selectProjectMatrixUrlsByProjectId = createSelector(selectMatrix, (state) => state.matrixUrlsByProjectId);
+export const selectProjectMatrixUrlsByProjectId =
+    createSelector(selectMatrix, (state) => state.matrixUrlsByProjectId);
 
 /**
  * Returns the matrix partial query match. That is, return true when not all of the data for the current search terms

spa/src/app/files/_ngrx/matrix/matrix.state.ts

@@ -7,30 +7,28 @@
 
 // App dependencies
 import { FetchMatrixFileFormatsSuccessAction } from "./fetch-matrix-file-formats-success.action";
+import { FetchMatrixUrlSpeciesSuccessAction } from "./fetch-matrix-url-species-success.action";
 import { FetchFileManifestUrlSuccessAction } from "../file-manifest/fetch-file-manifest-url-success.action";
 import { FileManifestState } from "../file-manifest/file-manifest.state";
 import { FetchMatrixUrlSuccessAction } from "./fetch-matrix-url-success.action";
 import { FetchMatrixPartialQueryMatchSuccessAction } from "./fetch-matrix-partial-query-match-success.action";
 import { FetchProjectMatrixUrlsSuccessAction } from "./fetch-project-matrix-urls-success.action";
 import { Matrix } from "./matrix.model";
-import { MatrixResponse } from "../../shared/matrix-response.model";
-import { MatrixStatus } from "../../shared/matrix-status.model";
+import { MatrixUrlRequest } from "../../shared/matrix-url-request.model";
 import { ProjectMatrixUrls } from "../../shared/project-matrix-urls.model";
 
 const DEFAULT_MATRIX = {
     fileFormats: [],
     partialQueryMatch: null,
-    matrixResponse: {
-        status: MatrixStatus.NOT_STARTED
-    } as MatrixResponse,
+    matrixUrlRequestsBySpecies: new Map<string,MatrixUrlRequest>(),
     matrixUrlsByProjectId: new Map<string, ProjectMatrixUrls>()
 };
 
 export class MatrixState implements Matrix {
 
     fileFormats: string[];
     partialQueryMatch: boolean;
-    matrixResponse: MatrixResponse;
+    matrixUrlRequestsBySpecies: Map<string,MatrixUrlRequest>;
     matrixUrlsByProjectId: Map<string, ProjectMatrixUrls>;
 
     /**
@@ -50,9 +48,7 @@ export class MatrixState implements Matrix {
         return new MatrixState({
             fileFormats: this.fileFormats,
             partialQueryMatch: this.partialQueryMatch,
-            matrixResponse: {
-                status: MatrixStatus.NOT_STARTED
-            } as MatrixResponse,
+            matrixUrlRequestsBySpecies: new Map(),
             matrixUrlsByProjectId: this.matrixUrlsByProjectId
         });
     }
@@ -67,7 +63,7 @@ export class MatrixState implements Matrix {
         return new MatrixState({
             fileFormats: this.fileFormats,
             partialQueryMatch: null,
-            matrixResponse: this.matrixResponse,
+            matrixUrlRequestsBySpecies: this.matrixUrlRequestsBySpecies,
             matrixUrlsByProjectId: this.matrixUrlsByProjectId
         });
     }
@@ -84,11 +80,12 @@ export class MatrixState implements Matrix {
      * @returns {MatrixState}
      */
     public fetchMatrixFileFormatsSuccess(action: FetchMatrixFileFormatsSuccessAction) {
+
         const fileFormats = action.fileFormats;
         return new MatrixState({
             fileFormats,
             partialQueryMatch: this.partialQueryMatch,
-            matrixResponse: this.matrixResponse,
+            matrixUrlRequestsBySpecies: this.matrixUrlRequestsBySpecies,
             matrixUrlsByProjectId: this.matrixUrlsByProjectId
         });
     }
@@ -104,7 +101,7 @@ export class MatrixState implements Matrix {
         return new MatrixState({
             fileFormats: this.fileFormats,
             partialQueryMatch: action.partialQueryMatch,
-            matrixResponse: this.matrixResponse,
+            matrixUrlRequestsBySpecies: this.matrixUrlRequestsBySpecies,
             matrixUrlsByProjectId: this.matrixUrlsByProjectId
         });
     }
@@ -124,7 +121,7 @@ export class MatrixState implements Matrix {
         return new MatrixState({
             fileFormats: this.fileFormats,
             partialQueryMatch: this.partialQueryMatch,
-            matrixResponse: this.matrixResponse,
+            matrixUrlRequestsBySpecies: this.matrixUrlRequestsBySpecies,
             matrixUrlsByProjectId: updatedMatrixUrlsByProjectId
         });
     }
@@ -137,11 +134,32 @@ export class MatrixState implements Matrix {
      * @param {FetchFileManifestUrlSuccessAction} action
      * @returns {FileManifestState}
      */
-    public fetchMatrixUrlSuccess(action: FetchMatrixUrlSuccessAction) {
+    public fetchMatrixUrlRequestSuccess(action: FetchMatrixUrlSuccessAction) {
+
+        const requestsBySpecies = new Map(this.matrixUrlRequestsBySpecies);
+        requestsBySpecies.set(action.response.species, action.response);
+
+        return new MatrixState({
+            fileFormats: this.fileFormats,
+            partialQueryMatch: this.partialQueryMatch,
+            matrixUrlRequestsBySpecies: requestsBySpecies,
+            matrixUrlsByProjectId: this.matrixUrlsByProjectId
+        });
+    }
+
+    /**
+     * Manifest URL request response has been received from server and we have determined the set of species for the
+     * request.
+     *
+     * @param {FetchFileManifestUrlSuccessAction} action
+     * @returns {FileManifestState}
+     */
+    public fetchMatrixUrlRequestSpeciesSuccess(action: FetchMatrixUrlSpeciesSuccessAction) {
+
         return new MatrixState({
             fileFormats: this.fileFormats,
             partialQueryMatch: this.partialQueryMatch,
-            matrixResponse: action.response,
+            matrixUrlRequestsBySpecies: action.response.matrixUrlRequestsBySpecies,
             matrixUrlsByProjectId: this.matrixUrlsByProjectId
         });
     }

spa/src/app/files/files.module.ts

@@ -54,6 +54,9 @@ import { HCAGetDataFileSummaryComponent } from "./hca-get-data/hca-get-data-file
 import { HCAGetDataSummaryComponent } from "./hca-get-data/hca-get-data-summary/hca-get-data-summary.component";
 import { HCAGetManifestComponent } from "./hca-get-data/hca-get-manifest/hca-get-manifest.component";
 import { HCAGetMatrixComponent } from "./hca-get-data/hca-get-matrix/hca-get-matrix.component";
+import { MatrixPartialQueryMatchWarningComponent } from "./hca-get-data/matrix-partial-query-match-warning/matrix-partial-query-match-warning.component";
+import { MatrixUrlRequestFormComponent } from "./hca-get-data/matrix-url-request-form/matrix-url-request-form.component";
+import { MatrixUrlRequestCompletedComponent } from "./hca-get-data/matrix-url-request-completed/matrix-url-request-completed.component";
 import { HCAEllipsisTextComponent } from "./hca-content-ellipsis/hca-ellipsis-text.component";
 import { HCAProjectComponent } from "./hca-project/hca-project.component";
 import { HCATableColumnHeaderComponent } from "./hca-table-column-header/hca-table-column-header.component";
@@ -137,6 +140,9 @@ import { TableScroll } from "./table-scroll/table-scroll.component";
         HCAFileFilterComponent,
         HCAFileFilterResultComponent,
         HCAFileFilterWrapperComponent,
+        MatrixPartialQueryMatchWarningComponent,
+        MatrixUrlRequestFormComponent,
+        MatrixUrlRequestCompletedComponent,
         ProjectDeprecatedComponent,
         ProjectDownloadsComponent,
         ProjectGuardComponent,

spa/src/app/files/hca-download-file/hca-download-file.component.ts

@@ -161,7 +161,7 @@ export class HCADownloadFileComponent implements OnDestroy, OnInit {
 
         return this.isDownloadInitiated(response) ||
             this.isDownloadInProgress(response) ||
-            // Include COMPLETE here as there is a delay between when the "complete" status is received
+            // Include COMPLETED here as there is a delay between when the "complete" status is received
             // from the server and when the browser initiates the actual download.
             this.isDownloadComplete(response);
     }