Analyses results view

[hudson-newey]

Default Analyses results view

Downloading the default analyses from audio recordings

Changes

• Created analysis download row components
• Creates new routes for analyses downloads
• Creates analysis results component

Problems

Download functionality for directories in the form of ZIP files needs to be completed as part of another ticket

Issues

Fixes: #2011

Visual Changes

Final Checklist

• [x] Assign reviewers if you have permission
• [x] Assign labels if you have permission
• [x] Link issues related to PR
• [ ] Ensure project linter is not producing any warnings (npm run lint)
• [ ] Ensure build is passing on all browsers (npm run test:all)
• [ ] Ensure CI build is passing
• [ ] Ensure docker container is passing (docs)

[hudson-newey]

Todo:

• [x] Unit tests for opening and closing a folder in Analysis Results view
• [x] Loading rows through be done asynchronously using an observable code (at the moment it's rendering opening a folder by code, this is obviously not ideal)
• [x] Method for converting large bytes to readable format (KB, MB, GB, etc...) needs to either a. find a library or b. be refactored code
• [x] Link view to real data, (instead of mock / predetermined data) code
• [x] Bind analyses-results component to AnalysisResults model
• [x] Refactor & clean up code quality
• [x] Investigate why faker.js is causing bundle to be so large (causing CI to fail)
• [x] Change getItems() method in analyses-results.component.ts to an async/await method. This should fix this race conditions & unit tests

[github-actions[bot]]

Unit Test Results

         6 files           6 suites   16m 4s :stopwatch: 17 616 tests 17 052 :heavy_check_mark: 564 :zzz: 0 :x: 17 724 runs  17 160 :heavy_check_mark: 564 :zzz: 0 :x:

Results for commit a00e9087.

:recycle: This comment has been updated with latest results.

[github-actions[bot]]

Size Change: +10.1 kB (0%)

Total Size: 2.68 MB

Filename	Size	Change
dist/workbench-client/browser/index.html	3.85 kB	+17 B (0%)
dist/workbench-client/browser/main.****************.js	849 kB	+4.15 kB (0%)
dist/workbench-client/browser/styles.****************.css	37.5 kB	+17 B (0%)
dist/workbench-client/server/main.js	1.78 MB	+5.87 kB (0%)

ℹ️ View Unchanged

| Filename | Size | | :--- | :---: | | `dist/workbench-client/browser/assets/environment.json` | 555 B | | `dist/workbench-client/browser/manifest.json` | 150 B | | `dist/workbench-client/browser/polyfills.****************.js` | 12.5 kB | | `dist/workbench-client/browser/runtime.****************.js` | 648 B |

_{compressed-size-action}

[hudson-newey]

I'm currently observing a race condition. It is originating from this getItems() method in analyses-results.component.ts. To fix this, I am going to be changing getItems() to an async/await method, and am going to change the api.list() to api.show(). This is the last remaining task, everything else should be all done and ready for review

[hudson-newey]

I know this is a big PR, so thanks for the review. I'm going through the requested changes now and will get back to you asap

[hudson-newey]

The code currently pushed is not ideal & is of bad quality, but has the requirements listed above implemented (sub 1).

I am going to be cleaning up the code quality before submitting it for review, but I wanted to push it to avoid losing my work due to a hard drive failure, etc... and create a point of reference for a very rough MVP.

Personal Review TODO list

• [x] Fix indentation method
• [x] Update analyses-results.component.spec.ts test
• [x] Update analysis-download-row.component.spec.ts tests
• [x] Update AudioRecording.spec.ts tests
• [x] Add unit tests for file Array.prototype.sort() method
• [x] Using filter & map methods means the this.rows array is a new instance every change. Therefore the observable isn't being updated. I need to find a fix for this
• [x] Remove root path from analysis-results.component.ts
• [x] Fix system routes in menu items
• [x] Change typescript access modifiers to better reflect usage
• [x] Add code comments
• [x] Add @BawBytes decorator to AnalysisJobItemResult model
• [x] Write JsDoc comments
• [x] Consolidate duplicate code in analysis-download-row.component.ts
• [x] Fix download button for folders of more than 2 levels of depth
• [x] Add error notification if there are no analysis job item results
• [x] Fix eslint errors
• [x] Move system analysis job to menu items instead of routes
• [x] Fix code comment in analysis-download-row.component.spec.ts
• [x] Assert that buttons next to files are not disabled
• [x] Use analysis-download-row.component.ts view model in tests
• [x] Remove API root references from analysis-download-row.component.ts (it shouldn't have any knowledge of routes)
• [x] Remove reminence of using px in css and replace with em / rem
• [x] Change even checkered background colour to use css variables defined in the global style
• [x] Change analysis-results.component.spec.ts default audio recording not to have a specified ID attribute
• [x] See if setup() in analysis-results.component.spec.ts needs { detectChanges: false } (it does)
• [x] In getDownloadButton in analysis-results.component.spec.ts I should use By.css() instead of by index (By.css only works on jasmine fixtures, not HTML elements, this is NA)
• [x] Remove re-instantiating AnalysisJobItemResult model on ResultNode (not needed because the models are incomplete)
• [x] Download button tests sometimes fail randomly
• [x] Fix view on mobile

[atruskie]

I'm not going to merge this until associated changes with the API are finalized. https://github.com/QutEcoacoustics/baw-server/tree/pbs-analysis