Migrate Baw Client Routes #780

Allcharles · 2021-01-20T04:44:55Z

Migration of Baw Client Routes

Create all of the routing required to handle displaying the baw client pages. This makes use of the BawClientComponent created in the parent PR.

Changes

Added the following pages:
- Listen
  - Listen Page (/listen) (Recent Audio Recordings #206)
  - Play Page (/listen/:audioRecordingId) (Listen #207)
- Library
  - Library Page (/library) (Library #208)
  - Annotation Page (/library/:audioRecordingId/audio_events/:audioEventId) (Library Item #209)
- Visualize Page (/visualize) (Visualize #210)
- Audio Analysis
  - List Page (/audio_analysis) (Analysis Jobs #211)
  - New Page (/audio_analysis/new) (New Analysis Job #212)
  - Details Page (/audio_analysis/:analysisJobId) (Analysis Job #213)
  - Results Page (/audio_analysis/:analysisJobId/results) (Analysis Job Result #214)

Problems

Some menu routes are still wrong (AbstractModel viewUrls #772)
Identified component required redesign to simplify (Simplify Site/Region Details Component #778 )
Have not migrated citizen science pages, this will be a separate PR

Test migrated pages load similar to

workbench-client/src/app/components/shared/baw-client/baw-client.component.spec.ts

Lines 133 to 142 in f6cb05d

    
           it("should load old client in iframe", async () => { 
        
             navigate("/"); 
        
             spec.detectChanges(); 
        
             await waitForLoad(); 
        
             spec.detectChanges(); 
        
             expect(getIframe().contentWindow.document.body).toContainText( 
        
               "Client application home page" 
        
             ); 
        
           });

~~Still haven't dealt with Emphasis Disabled Menu Links #779~~ Closed in Restyling Disabled Menu Item Links #807
Potential issue with library link on secondary menu. When accessing an annotation inside the library, the library menu item will update to include the audio recording id in the query parameters. This means, if the user clicks back to the library, it will be prefilled and search for the audio recording. Depending on perspective, this is a bug or a feature
~~Add step in CI to download and build baw-client. This will allow for unit tests on whether the migration is working in the current build~~ Closed in Build baw client #839

Visual Changes

Listen Page (`/listen`)

Play Page (`/listen/:audioRecordingId`)

Library Page (`/library`)

Annotation Page (`/library/:audioRecordingId/audio_events/:audioEventId`)

Visualize Page (`/visualize`)

Audio Analysis

List Page (`/audio_analysis`)

New Page (`/audio_analysis/new`)

Details Page (`/audio_analysis/:analysisJobId`)

Results Page (`/audio_analysis/:analysisJobId/results`)

Final Checklist

Assign reviewers if you have permission
Assign labels if you have permission
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 · 2021-01-20T04:51:30Z

Size Change: +4.22 kB (0%)

Total Size: 1.17 MB

Filename	Size	Change
`dist/workbench-client/browser/assets/environment.json`	401 B	-30 B (-7%)	✅
`dist/workbench-client/browser/index.html`	1.04 kB	-1 B (0%)
`dist/workbench-client/browser/main-es2015.********************.js`	530 kB	+1.89 kB (0%)
`dist/workbench-client/browser/main-es5.********************.js`	554 kB	+2.37 kB (0%)

ℹ️ View Unchanged

Filename	Size	Change
`dist/workbench-client/browser/manifest.json`	150 B	0 B
`dist/workbench-client/browser/polyfills-es2015.********************.js`	12.6 kB	0 B
`dist/workbench-client/browser/polyfills-es5.********************.js`	46.1 kB	0 B
`dist/workbench-client/browser/runtime-es2015.********************.js`	719 B	0 B
`dist/workbench-client/browser/runtime-es5.********************.js`	719 B	0 B
`dist/workbench-client/browser/styles.********************.css`	27.2 kB	0 B

_{compressed-size-action}

atruskie

I'd say a lot of these non-CRUD pages don't fit well into the list/details nomenclature we've used for CRUD pages. Listen, visualise are more composite pages that tie more than one basic resource together. Not important enough to change now, might be worth considering later.

There are several places with TODOs for malformed URLs (good). Just add issue link to each so they're findable using the same pattern.

Great work, minor changes suggested

src/app/components/projects/site-card/site-card.component.ts

src/app/components/sites/site/site.component.html

src/app/components/sites/site/site.component.ts

src/app/components/visualize/visualize.menus.ts

src/app/models/AudioEvent.ts

src/app/models/Bookmark.ts

src/app/services/baw-api/audio-recording/audio-recordings.service.ts

src/app/services/baw-api/baw-api.service.ts

atruskie

💯

Create all of the routing required to handle displaying the baw client pages. This makes use of the `BawClientComponent` created in #727.

Build baw client in github actions, this allows the unit tests to validate that the baw client has been correctly integrated into the project.

* Cleanup app styling to create full height components - Cleanup CSS styling for the app component so that the default router outlet component will have access to the full height of the page - Created basic audio analysis page * Working example Couple bugs to fix - AngularJS links are not reloading the parent page - IFrame does not resize to content which causes the scrollbar to be in the wrong location * Created new audio analysis page * Cleanup iframe module - Disabled broken tests - Renamed IFrameComponent to BawClientComponent - Isolated BawClientComponent into a module - Created placeholder unit tests - Updated interceptor to include cookies in requests * Implemented BawClientComponent unit tests * Fixed broken tests and rebase conflicts * Fixed broken unit tests Discovered bug in how secondary menu unit tests were saving/restoring the defaultMenu global variable (converted Lists to arrays, but not back) * Fix site/region details tag links * Working login request * Update security service tests * Cleanup interceptor tests * Fix rebase issues * Cleanup api request responseType's This should make things a lot more clear for when the interceptor should set accept/content-type headers to requests * Cleanup review comments

Create all of the routing required to handle displaying the baw client pages. This makes use of the `BawClientComponent` created in #727.

github-actions · 2021-02-11T01:56:23Z

Unit Test Results

        7 files +        6         7 suites +6 7m 34s ⏱️ + 6m 49s
15 260 tests +13 131 14 588 ✔️ +12 557 672 💤 +575 0 ❌ - 1

Results for commit 3231cd7. ± Comparison against base commit 9d9e2a2.

Allcharles added enhancement New feature or request ui feature A new feature/page to add to the project labels Jan 20, 2021

Allcharles marked this pull request as draft January 20, 2021 04:45

This comment has been minimized.

Sign in to view

Allcharles added blocking/blocked Pull requests or issues that are blocked by something parent pr Pull request with children branches. Do not rebase/squash merge. labels Feb 8, 2021

Allcharles marked this pull request as ready for review February 9, 2021 01:13

Allcharles requested a review from atruskie February 9, 2021 01:13

Allcharles force-pushed the iframes branch from f6cb05d to e53704c Compare February 9, 2021 03:55

Allcharles force-pushed the initial-migration branch from fd41bf3 to b5a99a4 Compare February 9, 2021 05:39

This comment has been minimized.

Sign in to view

atruskie requested changes Feb 9, 2021

View reviewed changes

Allcharles requested a review from atruskie February 10, 2021 04:00

This comment has been minimized.

Sign in to view

atruskie approved these changes Feb 10, 2021

View reviewed changes

Allcharles added 3 commits February 11, 2021 11:34

Migrate Baw Client Routes (#780)

a726e5c

Create all of the routing required to handle displaying the baw client pages. This makes use of the `BawClientComponent` created in #727.

Build Baw Client (#839)

06e6997

Build baw client in github actions, this allows the unit tests to validate that the baw client has been correctly integrated into the project.

Allcharles force-pushed the initial-migration branch from 60175a3 to dc77961 Compare February 11, 2021 01:35

Allcharles merged commit 3231cd7 into iframes Feb 11, 2021

Allcharles deleted the initial-migration branch February 11, 2021 01:40

Allcharles added a commit that referenced this pull request Feb 11, 2021

Migrate Baw Client Routes (#780)

f3580f9

Create all of the routing required to handle displaying the baw client pages. This makes use of the `BawClientComponent` created in #727.

This comment has been minimized.

Sign in to view

Allcharles linked an issue Apr 16, 2021 that may be closed by this pull request

Merge with AngularJS Client #257

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate Baw Client Routes #780

Migrate Baw Client Routes #780

Allcharles commented Jan 20, 2021 •

edited

Loading

This comment has been minimized.

github-actions bot commented Jan 20, 2021 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

atruskie left a comment

This comment has been minimized.

This comment has been minimized.

atruskie left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Feb 11, 2021

	it("should load old client in iframe", async () => {
	navigate("/");
	spec.detectChanges();
	await waitForLoad();
	spec.detectChanges();

	expect(getIframe().contentWindow.document.body).toContainText(
	"Client application home page"
	);
	});

Migrate Baw Client Routes #780

Migrate Baw Client Routes #780

Conversation

Allcharles commented Jan 20, 2021 • edited Loading

Migration of Baw Client Routes

Changes

Problems

Visual Changes

Listen Page (/listen)

Play Page (/listen/:audioRecordingId)

Library Page (/library)

Annotation Page (/library/:audioRecordingId/audio_events/:audioEventId)

Visualize Page (/visualize)

Audio Analysis

List Page (/audio_analysis)

New Page (/audio_analysis/new)

Details Page (/audio_analysis/:analysisJobId)

Results Page (/audio_analysis/:analysisJobId/results)

Final Checklist

This comment has been minimized.

github-actions bot commented Jan 20, 2021 • edited Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

atruskie left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

atruskie left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Feb 11, 2021

Unit Test Results

Allcharles commented Jan 20, 2021 •

edited

Loading

Listen Page (`/listen`)

Play Page (`/listen/:audioRecordingId`)

Library Page (`/library`)

Annotation Page (`/library/:audioRecordingId/audio_events/:audioEventId`)

Visualize Page (`/visualize`)

List Page (`/audio_analysis`)

New Page (`/audio_analysis/new`)

Details Page (`/audio_analysis/:analysisJobId`)

Results Page (`/audio_analysis/:analysisJobId/results`)

github-actions bot commented Jan 20, 2021 •

edited

Loading