hudson-newey commented 1 month ago

Verification Interface

This pull request creates an annotations search page & accompanying verification grid to the workbench client.

Changes

Features

Add open-ecoacoustics web components as a dependency
Add annotations search page
Add verification interface page
Add @angular/elements allowing us to create custom elements using Angular components (was needed for full Lit + Angular interoperability within slotted content)
Add semantic selectors to wip component
Add disabled attributes to date-time-input.component start/end date/time inputs
Add pageSize attribute to pagination template
You can now add response headers to the SSR server using the angular.json serve.options.headers object

Bug Fixes

Fix the previously non-functional UnsavedInputGuard
Fix docker image publish workflow doubling the inputted tag name on manual dispatches
Fix docker version build numbers now use an incrementing number instead of the number of commits in the tag
Fixes a bug with route titles when viewing profiles
Fixes a bug where typeahead input component pills would not be vertically centered
Fix failing CI due to deprecated dependencies

Code Quality

Disable AOT during development builds and disable lib check (don't typecheck third party library code). These changes result in decreased dev build time by ~40-50%
Add new test helpers selectFromTypeahead and getElementByInnerText

Issues

Fixes: #2140

Visual Changes

Annotations search page

Verification grid page

Verification grid with context card expanded

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)

github-actions[bot] commented 1 month ago

Size Change: +566 kB (+18.73%) ⚠️

Total Size: 3.59 MB

Filename	Size	Change
`dist/workbench-client/browser/index.html`	4.79 kB	+55 B (+1.16%)
`dist/workbench-client/browser/main-67QZJSXS.js`	0 B	-1.08 MB (removed)	🏆
`dist/workbench-client/browser/styles-UNSEPFNK.css`	0 B	-39.6 kB (removed)	🏆
`dist/workbench-client/server/main.js`	1.94 MB	+55.8 kB (+2.97%)
`dist/workbench-client/browser/@ecoacoustics/web-components/_commonjsHelpers-BVfed4GL.js`	432 B	+432 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/abstractComponent-gI12hGSz.js`	6.49 kB	+6.49 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/assets/buffer-builder-processor-BhnxGUx8.js`	1.16 kB	+1.16 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/assets/high-accuracy-time-processor-BevUJNwo.js`	354 B	+354 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/attributes-DayhhJl-.js`	313 B	+313 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/class-map-BJ2wQJjp.js`	675 B	+675 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/classification-syqJf8YO.js`	125 B	+125 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/colors-DMCqRncD.js`	328 B	+328 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components.js`	116 kB	+116 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/axes.js`	3.19 kB	+3.19 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/classification.js`	1.77 kB	+1.77 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/data-source.js`	63.3 kB	+63.3 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/decision.js`	1.25 kB	+1.25 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/help-dialog.js`	2.61 kB	+2.61 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/helpers/constants/contextTokens.js`	209 B	+209 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/indicator.js`	1.12 kB	+1.12 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/info-card.js`	1.59 kB	+1.59 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/logger.js`	418 B	+418 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/media-controls.js`	38.2 kB	+38.2 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/progress-bar.js`	1.13 kB	+1.13 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/spectrogram.js`	167 kB	+167 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/verification-grid-settings.js`	1.48 kB	+1.48 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/verification-grid-tile.js`	3.55 kB	+3.55 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/verification-grid.js`	387 B	+387 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/components/verification.js`	1.3 kB	+1.3 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/consume-D2RSb1qY.js`	614 B	+614 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/context-request-event-Bc4uem__.js`	239 B	+239 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/custom-elements.json`	9.58 kB	+9.58 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/decision-Btskh9bB.js`	202 B	+202 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/decisionColors-DNuXUVq4.js`	3.84 kB	+3.84 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/decorators-zsXcIcN9.js`	516 B	+516 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/directive-B76A7YXI.js`	343 B	+343 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/directive-helpers-DAca9yBy.js`	638 B	+638 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/if-defined-YSzpD1Zv.js`	178 B	+178 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/keyboard-MZyub3T-.js`	117 B	+117 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/lit-element-CNpxFSzF.js`	6.77 kB	+6.77 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/map-D8heArFD.js`	184 B	+184 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/property-cctOu2Be.js`	639 B	+639 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/provide-Ce8Vz0mw.js`	1.18 kB	+1.18 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/query-sbFTBDPt.js`	340 B	+340 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/signal-watcher-CbQ3umdl.js`	377 B	+377 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/signals-core.module-BUxpRF5s.js`	1.59 kB	+1.59 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/state-DJrhCpxL.js`	203 B	+203 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/userAgent-CdrtNGdV.js`	1.04 kB	+1.04 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/utilities-C38J31_r.js`	432 B	+432 B (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/verification-grid-BTP5tbOH.js`	12 kB	+12 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/watch-BnoWuiCc.js`	1.02 kB	+1.02 kB (new file)	🆕
`dist/workbench-client/browser/@ecoacoustics/web-components/when-CDK1Tt5Y.js`	168 B	+168 B (new file)	🆕
`dist/workbench-client/browser/assets/test-assets/index.html`	21 B	+21 B (new file)	🆕
`dist/workbench-client/browser/main-7AVCUVYU.js`	1.13 MB	+1.13 MB (new file)	🆕
`dist/workbench-client/browser/styles-ETV6J7SM.css`	39.6 kB	+39.6 kB (new file)	🆕

ℹ️ View Unchanged

| Filename | Size | | :--- | :---: | | `dist/workbench-client/browser/assets/environment.json` | 555 B | | `dist/workbench-client/browser/manifest.json` | 147 B | | `dist/workbench-client/browser/polyfills-C5CKP5CH.js` | 12.4 kB | | `dist/workbench-client/server/952.js` | 4.21 kB |

_{compressed-size-action}

hudson-newey commented 1 month ago

Known issues I want to fix before meging into main

[ ] I currently have a hack so that audio event tags attribute is converted into a string to get around https://github.com/ecoacoustics/web-components/issues/213
[ ] The decision buttons sometimes error on initalization
[ ] The verification grid can sometimes collapse into a 1x1 shape
[x] The tile context doesn't disapear when paging in the verification grid
[ ] You should only be able to open one context dialog at a time
[x] Grid tile context can go off the edge of the screen
[ ] Search page can lock up causing a crashed tab
[x] Audio files can sometimes not load
[x] Round start/end times to get around range request bug
[x] AnnotationSearchParameters model should be constructed inside a resolver
[ ] Search page has a lot of cumulitive shift when loading grid tiles
[ ] Use grayscale spectrograms (depends on https://github.com/ecoacoustics/web-components/issues/179)
[ ] ?page=n query string parameters get removed when reloading the search page
[ ] Annotation tiles are variable size on search page

Like to do

Unit/e2e tests

Out of scope

Re-order search annotations menu link (out-of-scope for PR; completing in https://github.com/QutEcoacoustics/workbench-client/issues/2149)

github-actions[bot] commented 3 weeks ago

Unit Test Results

        4 files         4 suites 6m 55s :stopwatch: 15 988 tests 15 580 :heavy_check_mark: 408 :zzz: 0 :x: 16 136 runs 15 728 :heavy_check_mark: 408 :zzz: 0 :x:

Results for commit 78ba8fed.

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

QutEcoacoustics / workbench-client

Add Annotation Search and Verification Pages #2145