When searching, build the path objects asynchronously while returning the results #7265

scottbell · 2023-11-30T18:54:53Z

Closes #7264

Describe your changes:

When building the search results, return them as soon as we can, and asynchronously build the paths incrementally as we receive them.
Asynchronously search for tags
Pass abort controllers to search for more details about objects. For ObjectPath, if we've been dismounted, abort the original path search.

All Submissions:

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?
Is this change backwards compatible? For example, developers won't need to change how they are calling the API or how they've extended core plugins such as Tables or Plots.

Author Checklist

Changes address original issue?
Tests included and/or updated with changes?
Command line build passes?
Has this been smoke tested?
Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

Changes appear to address issue?
Reviewer has tested changes by following the provided instructions?
Changes appear not to be breaking changes?
Appropriate automated tests included?
Code style and in-line documentation are appropriate?
Has associated issue been labelled unverified? (only applicable if this PR closes the issue)
Has associated issue been labelled bug? (only applicable if this PR is for a bug fix)

deploysentinel · 2023-11-30T18:59:24Z

Current Playwright Test Results Summary

✅ 162 Passing - ⚠️ 2 Flaky

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 12/04/2023 09:40:08pm UTC)

Run Details

Running Job e2e-stable on CircleCI

Commit: f573aa8

Started: 12/04/2023 09:33:31pm UTC

⚠️ Flakes

📄 functional/plugins/tabs/tabs.e2e.spec.js • 1 Flake

Test Case Results

Test Case	Last 7 days Failures	Last 7 days Flakes
Tabs View Renders tabbed elements Retry 1 • Initial Attempt	0% (0) 0 / 42 runs failed over last 7 days	4.76% (2) 2 / 42 runs flaked over last 7 days

📄 functional/plugins/notebook/restrictedNotebook.e2e.spec.js • 1 Flake

Test Case Results

Test Case	Last 7 days Failures	Last 7 days Flakes
Restricted Notebook with a page locked and with an embed @addinit Disallows embeds to be deleted if page locked @addinit Retry 1 • Initial Attempt	2.33% (1) 1 / 43 run failed over last 7 days	37.21% (16) 16 / 43 runs flaked over last 7 days

View Detailed Build Results

Current Playwright Test Results Summary

✅ 14 Passing - ⚠️ 1 Flaky

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 12/04/2023 09:40:08pm UTC)

Run Details

Running Workflow e2e-couchdb on Github Actions

Commit: f573aa8

Started: 12/04/2023 09:34:07pm UTC

⚠️ Flakes

📄 functional/couchdb.e2e.spec.js • 1 Flake

Test Case Results

Test Case	Last 7 days Failures	Last 7 days Flakes
CouchDB Status Indicator with mocked responses @couchdb Shows unknown if it receives an unexpected response code Retry 1 • Initial Attempt	0% (0) 0 / 39 runs failed over last 7 days	15.38% (6) 6 / 39 runs flaked over last 7 days

View Detailed Build Results

codecov · 2023-11-30T19:01:49Z

Codecov Report

Merging #7265 (979e172) into master (e7b9481) will increase coverage by 0.39%.
The diff coverage is 71.42%.

❗ Current head 979e172 differs from pull request most recent head f573aa8. Consider uploading reports for the commit f573aa8 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7265      +/-   ##
==========================================
+ Coverage   54.76%   55.16%   +0.39%     
==========================================
  Files         654      654              
  Lines       26256    26238      -18     
  Branches     2536     2530       -6     
==========================================
+ Hits        14380    14474      +94     
+ Misses      11171    11059     -112     
  Partials      705      705

Flag	Coverage Δ
e2e-full	`41.86% <ø> (-0.03%)`	⬇️
e2e-stable	`55.04% <100.00%> (+0.07%)`	⬆️
unit	`49.30% <71.42%> (+0.52%)`	⬆️

Files	Coverage Δ
src/api/annotation/AnnotationAPI.js	`90.14% <100.00%> (ø)`
src/api/objects/ObjectAPI.js	`84.54% <100.00%> (ø)`
src/ui/components/ObjectPath.vue	`60.46% <66.66%> (-1.70%)`	⬇️
src/ui/layout/search/GrandSearch.vue	`70.49% <61.53%> (+6.69%)`	⬆️

... and 15 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e7b9481...f573aa8. Read the comment docs.

scottbell · 2023-12-01T12:52:14Z

Before:

before.mov

Note all the results, object paths, and annotations come at once.

After:

after.mov

Note you get results relatively quickly that you can click on.

ozyx

LGTM! A legit use of for await!

ozyx · 2023-12-04T21:11:14Z

src/api/objects/ObjectAPI.js

- async getOriginalPath(identifier, path = []) {
- const domainObject = await this.get(identifier);
+ async getOriginalPath(identifier, path = [], abortSignal = null) {
+ const domainObject = await this.get(identifier, abortSignal);


ozyx · 2023-12-04T21:15:15Z

src/ui/layout/search/GrandSearch.vue

+ },
+ async searchObjects(abortSignal) {
+ const objectSearchPromises = this.openmct.objects.search(this.searchValue, abortSignal);
+ for await (const objectSearchResult of objectSearchPromises) {


brilliant stuff!

build paths as fast as we can

0f8e08f

scottbell linked an issue Nov 30, 2023 that may be closed by this pull request

Speed up search with CouchDB #7264

Closed

scottbell changed the title ~~When searching, build the paths asynchronously~~ When searching, build the path objects asynchronously to returning the results Nov 30, 2023

fix tests

4fab206

scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Nov 30, 2023

scottbell requested review from ozyx and khalidadil November 30, 2023 20:28

github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Nov 30, 2023

scottbell marked this pull request as ready for review November 30, 2023 20:33

scottbell changed the title ~~When searching, build the path objects asynchronously to returning the results~~ When searching, build the path objects asynchronously while returning the results Nov 30, 2023

add abort controllers and async load tags

826b00d

scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Dec 1, 2023

github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Dec 1, 2023

Merge branch 'master' into 7264-speed-up-search-with-couchdb

25a35d3

scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Dec 1, 2023

github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Dec 1, 2023

khalidadil approved these changes Dec 4, 2023

View reviewed changes

ozyx approved these changes Dec 4, 2023

View reviewed changes

Merge branch 'master' into 7264-speed-up-search-with-couchdb

979e172

ozyx enabled auto-merge (squash) December 4, 2023 21:21

ozyx added the pr:e2e:couchdb npm run test:e2e:couchdb label Dec 4, 2023

ozyx added this to the Target:3.3.0 milestone Dec 4, 2023

github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Dec 4, 2023

Merge branch 'master' into 7264-speed-up-search-with-couchdb

f573aa8

ozyx added the pr:e2e:couchdb npm run test:e2e:couchdb label Dec 4, 2023

github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Dec 4, 2023

ozyx added the performance impacts or improves performance label Dec 4, 2023

ozyx merged commit 72e0621 into master Dec 4, 2023
21 of 22 checks passed

ozyx deleted the 7264-speed-up-search-with-couchdb branch December 4, 2023 21:40

unlikelyzero modified the milestones: Target:3.3.0, Target:4.0.0 Feb 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

When searching, build the path objects asynchronously while returning the results #7265

When searching, build the path objects asynchronously while returning the results #7265

scottbell commented Nov 30, 2023 •

edited by ozyx

Loading

deploysentinel bot commented Nov 30, 2023 •

edited

Loading

Test Case Results

Test Case Results

Test Case Results

codecov bot commented Nov 30, 2023 •

edited

Loading

scottbell commented Dec 1, 2023

ozyx left a comment

ozyx Dec 4, 2023

ozyx Dec 4, 2023

When searching, build the path objects asynchronously while returning the results #7265

When searching, build the path objects asynchronously while returning the results #7265

Conversation

scottbell commented Nov 30, 2023 • edited by ozyx Loading

Describe your changes:

All Submissions:

Author Checklist

Reviewer Checklist

deploysentinel bot commented Nov 30, 2023 • edited Loading

Current Playwright Test Results Summary

⚠️ Flakes

Test Case Results

Test Case Results

Current Playwright Test Results Summary

⚠️ Flakes

Test Case Results

codecov bot commented Nov 30, 2023 • edited Loading

Codecov Report

scottbell commented Dec 1, 2023

ozyx left a comment

Choose a reason for hiding this comment

ozyx Dec 4, 2023

Choose a reason for hiding this comment

ozyx Dec 4, 2023

Choose a reason for hiding this comment

scottbell commented Nov 30, 2023 •

edited by ozyx

Loading

deploysentinel bot commented Nov 30, 2023 •

edited

Loading

codecov bot commented Nov 30, 2023 •

edited

Loading