Add support for multiple CouchDB databases, multiple namespaces, and `readOnly` configurations #7413

scottbell · 2024-01-25T09:13:14Z

Closes #7359 #7360

Describe your changes:

Add support for multiple CouchDB databases, namespaces, and readOnly configurations.

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?
Has this been smoke tested?
Have you associated this PR with a type: label? Note: this is not necessarily the same as the original issue.
Have you associated a milestone with this PR? Note: leave blank if unsure.
Is this a breaking change to be called out in the release notes?
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?

…han-one-couch-database-for-a-single-couch-server

codecov · 2024-01-25T09:19:23Z

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Comparison is base (69b81c0) 55.53% compared to head (c79d50a) 55.55%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7413      +/-   ##
==========================================
+ Coverage   55.53%   55.55%   +0.02%     
==========================================
  Files         668      668              
  Lines       26704    26723      +19     
  Branches     2585     2585              
==========================================
+ Hits        14829    14845      +16     
- Misses      11164    11165       +1     
- Partials      711      713       +2

Flag	Coverage Δ
e2e-full	`41.27% <ø> (-0.10%)`	⬇️
e2e-stable	`59.05% <17.77%> (-0.06%)`	⬇️
unit	`48.67% <91.11%> (+0.04%)`	⬆️

Files	Coverage Δ
src/api/objects/ObjectAPI.js	`92.03% <100.00%> (+0.07%)`	⬆️
...plugins/localStorage/LocalStorageObjectProvider.js	`100.00% <100.00%> (ø)`
src/plugins/myItems/myItemsInterceptor.js	`100.00% <100.00%> (ø)`
src/plugins/myItems/plugin.js	`100.00% <100.00%> (ø)`
...c/plugins/persistence/couch/CouchObjectProvider.js	`87.86% <100.00%> (-0.04%)`	⬇️
...c/plugins/persistence/couch/CouchSearchProvider.js	`86.27% <0.00%> (-1.73%)`	⬇️
src/plugins/persistence/couch/plugin.js	`88.88% <88.00%> (-11.12%)`	⬇️

... and 3 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 69b81c0...c79d50a. Read the comment docs.

ozyx

Wow, this is awesome. I haven't tried it, but I assume this works with multiple CouchDB databases as well?

I did find one issue with search, where after the search has completed, the "loading" progress bar is still spinning permanently:

Screen.Recording.2024-01-26.at.1.35.19.PM.mov

I think we can spin that off into its own issue, though. I don't have any PR-blocking comments at this time! I tested locally and everything seems to work well.

src/plugins/persistence/couch/README.md

…for-a-single-couch-server

unlikelyzero · 2024-01-29T15:36:27Z

@scottbell while you're waiting for additional review from Andrew, can you make sure our backup and restore scripts are up to date with this pattern?

scottbell · 2024-01-29T16:20:10Z

@scottbell while you're waiting for additional review from Andrew, can you make sure our backup and restore scripts are up to date with this pattern?

@unlikelyzero good idea! I’ll take a look

scottbell · 2024-01-29T20:38:29Z

@scottbell while you're waiting for additional review from Andrew, can you make sure our backup and restore scripts are up to date with this pattern?

@unlikelyzero good idea! I’ll take a look

@unlikelyzero they seem like they still work, provided you're using the default db name of openmct, but that's always been the case.

…for-a-single-couch-server

Co-authored-by: Jesse Mazzella <ozyx@users.noreply.github.com>

akhenry

This looks great, thank you. My only request is that for consistency with the default namespace we remove the logic to create the root if it doesn't exist. Users can install My Items for additional namespaces if they desire, and the omitRoot logic might be confusing. For the intended use-case the second read-only namespace will be created by an external script.

src/plugins/persistence/couch/CouchObjectProvider.js

akhenry · 2024-01-30T16:28:10Z

src/plugins/persistence/couch/plugin.js

+        {
+          url: unnnormalizedOptions.url,
+          namespace: DEFAULT_NAMESPACE,
+          additionalNamespaces: [LEGACY_SPACE],


chef's kiss 🤌

akhenry · 2024-01-30T16:28:48Z

src/plugins/persistence/couch/plugin.js

+    }
+
+    // final sanity check, ensure we have all options
+    normalizedOptions.databases.forEach((databaseConfiguration) => {


akhenry · 2024-01-30T22:40:22Z

.cspell.json

@@ -493,6 +493,7 @@
    "WCAG",
    "stackedplot",
    "Andale",
+    "unnnormalized",


I'm prepared to accept unnormalized at a stretch. But unnnormalized? With three n's?

🤦‍♂️

…for-a-single-couch-server

scottbell added 9 commits January 24, 2024 13:29

two namespaces appear

7f49118

works with two databases

c04ba36

try to batch requests

7560677

fix indicators

5d76fec

Merge remote-tracking branch 'origin/master' into 7359-support-more-t…

c6d3bf7

…han-one-couch-database-for-a-single-couch-server

add option to omit root for myitems

6cdb016

ready for review

6ba422e

ready for review

6190c06

ready for review

da14772

scottbell linked an issue Jan 25, 2024 that may be closed by this pull request

Support more than one Couch database for a single Couch Server #7359

Closed

scottbell added the type:feature Feature. Required intentional design label Jan 25, 2024

scottbell added this to the Target:4.0.0 milestone Jan 25, 2024

typo in README

3b0894a

scottbell requested review from akhenry and ozyx January 25, 2024 09:35

scottbell changed the title ~~Support more than one couch database for a single couch server~~ Add support for multiple CouchDB databases, multiple namespaces, and readOnly configurations Jan 25, 2024

scottbell changed the title ~~Add support for multiple CouchDB databases, multiple namespaces, and readOnly configurations~~ Add support for multiple CouchDB databases, multiple namespaces, and readOnly configurations Jan 25, 2024

scottbell added 4 commits January 25, 2024 10:37

spelling

5229b28

spelling

c70d958

update readme

cfef0e6

fix tests

896c241

scottbell marked this pull request as ready for review January 25, 2024 09:57

scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 25, 2024

github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 25, 2024

scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 25, 2024

github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 25, 2024

scottbell linked an issue Jan 25, 2024 that may be closed by this pull request

Support "read-only" Couch databases #7360

Closed

ozyx approved these changes Jan 26, 2024

View reviewed changes

src/plugins/persistence/couch/README.md Outdated Show resolved Hide resolved

Merge branch 'master' into 7359-support-more-than-one-couch-database-…

74ccec3

…for-a-single-couch-server

Merge branch 'master' into 7359-support-more-than-one-couch-database-…

90bc350

…for-a-single-couch-server

scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 30, 2024

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

Update src/plugins/persistence/couch/README.md

e7074b4

Co-authored-by: Jesse Mazzella <ozyx@users.noreply.github.com>

akhenry requested changes Jan 30, 2024

View reviewed changes

scottbell added 2 commits January 30, 2024 19:24

remove omitRoot

6f14720

remove omitRoot

e6e5515

scottbell requested a review from akhenry January 30, 2024 18:27

scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 30, 2024

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

scottbell added 2 commits January 30, 2024 20:14

fix my items to check for namespace when intercepting

4a9c62f

update readme

75d496a

scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 30, 2024

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

akhenry reviewed Jan 30, 2024

View reviewed changes

akhenry approved these changes Jan 30, 2024

View reviewed changes

Merge branch 'master' into 7359-support-more-than-one-couch-database-…

c79d50a

…for-a-single-couch-server

unlikelyzero added pr:e2e:couchdb npm run test:e2e:couchdb pr:e2e:perf Trigger perf tests labels Jan 30, 2024

akhenry enabled auto-merge (squash) January 30, 2024 22:53

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

akhenry added the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 30, 2024

unlikelyzero disabled auto-merge January 30, 2024 23:01

github-actions bot removed pr:e2e:couchdb npm run test:e2e:couchdb pr:e2e:perf Trigger perf tests labels Jan 30, 2024

unlikelyzero merged commit d42aa54 into master Jan 30, 2024
37 checks passed

unlikelyzero deleted the 7359-support-more-than-one-couch-database-for-a-single-couch-server branch January 30, 2024 23:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for multiple CouchDB databases, multiple namespaces, and `readOnly` configurations #7413

Add support for multiple CouchDB databases, multiple namespaces, and `readOnly` configurations #7413

scottbell commented Jan 25, 2024 •

edited by akhenry

Loading

codecov bot commented Jan 25, 2024 •

edited

Loading

ozyx left a comment

unlikelyzero commented Jan 29, 2024

scottbell commented Jan 29, 2024

scottbell commented Jan 29, 2024

akhenry left a comment •

edited

Loading

akhenry Jan 30, 2024

akhenry Jan 30, 2024

akhenry Jan 30, 2024

scottbell Jan 31, 2024

Add support for multiple CouchDB databases, multiple namespaces, and readOnly configurations #7413

Add support for multiple CouchDB databases, multiple namespaces, and readOnly configurations #7413

Conversation

scottbell commented Jan 25, 2024 • edited by akhenry Loading

Describe your changes:

All Submissions:

Author Checklist

Reviewer Checklist

codecov bot commented Jan 25, 2024 • edited Loading

Codecov Report

ozyx left a comment

Choose a reason for hiding this comment

unlikelyzero commented Jan 29, 2024

scottbell commented Jan 29, 2024

scottbell commented Jan 29, 2024

akhenry left a comment • edited Loading

Choose a reason for hiding this comment

akhenry Jan 30, 2024

Choose a reason for hiding this comment

akhenry Jan 30, 2024

Choose a reason for hiding this comment

akhenry Jan 30, 2024

Choose a reason for hiding this comment

scottbell Jan 31, 2024

Choose a reason for hiding this comment

Add support for multiple CouchDB databases, multiple namespaces, and `readOnly` configurations #7413

Add support for multiple CouchDB databases, multiple namespaces, and `readOnly` configurations #7413

scottbell commented Jan 25, 2024 •

edited by akhenry

Loading

codecov bot commented Jan 25, 2024 •

edited

Loading

akhenry left a comment •

edited

Loading