chore: deduplicate storage path access and create compass-utils (#3431)

In a number of places, we accessed the `@electron/remote` package
for fetching storage paths. However, with the enterprise improvements
project, we will now also require some of the packages which do this
to work in the main process, not just a renderer, so this needs
to be updated to conditionally use the `electron` package itself
rather than `@electron/remote`.

Instead of manually performing this change in every location,
extract this shared code and implement fallback handling there.
Also move the `promisifyAmpersandMethod` utility there, which
(as I understand it) only lived in data-service because we did
not have a better place for it at the time.

I know adding something named `utils` to a codebase can be a
pretty slippery slope, but I think it’s the best choice for
this particular problem.

Author: addaleax

package-lock.json

@@ -2,14 +2,8 @@ var Model = require('ampersand-model');
 var storageMixin = require('storage-mixin');
 var get = require('lodash.get');
 var format = require('util').format;
-
-var electronApp;
-try {
-  electronApp = require('@electron/remote').app;
-} catch (e) {
-  /* eslint no-console: 0 */
-  console.log('Could not load @electron/remote', e.message);
-}
+var compassUtils = require('@mongodb-js/compass-utils');
+var basepath = (compassUtils.getStoragePaths() || {}).basepath;
 
 var debug = require('debug')('mongodb-compass:models:preferences');
 
@@ -276,7 +270,7 @@ var Preferences = Model.extend(storageMixin, {
   namespace: 'AppPreferences',
   storage: {
     backend: 'disk',
-    basepath: electronApp ? electronApp.getPath('userData') : undefined
+    basepath: basepath
   },
   initialize: function() {
     this.on('page-refresh', this.onPageRefresh.bind(this));

packages/compass-preferences-model/lib/model.js

@@ -34,6 +34,7 @@
     "test-ci": "npm run test"
   },
   "dependencies": {
+    "@mongodb-js/compass-utils": "^0.1.0",
     "ampersand-collection-filterable": "^0.3.0",
     "ampersand-model": "^8.0.1",
     "ampersand-rest-collection": "^6.0.0",
@@ -47,9 +48,7 @@
     "storage-mixin": "^5.0.0"
   },
   "devDependencies": {
-    "@electron/remote": "^2.0.8",
     "depcheck": "^1.4.1",
-    "electron": "^15.5.7",
     "eslint": "^7.25.0",
     "eslint-config-mongodb-js": "^3.0.1",
     "lodash.result": "^4.5.2",

packages/compass-preferences-model/package.json

@@ -57,23 +57,22 @@
   "dependencies": {
     "@mongodb-js/compass-components": "^1.0.0",
     "@mongodb-js/compass-logging": "^1.0.0",
+    "@mongodb-js/compass-utils": "^0.1.0",
     "bson": "^4.4.1",
     "hadron-react-components": "^6.0.0",
-    "mongodb-data-service": "^22.0.0",
     "react": "^16.14.0",
     "storage-mixin": "^5.0.0"
   },
   "peerDependencies": {
     "@mongodb-js/compass-components": "^1.0.0",
     "@mongodb-js/compass-logging": "^1.0.0",
+    "@mongodb-js/compass-utils": "^0.1.0",
     "bson": "^4.4.1",
     "hadron-react-components": "^6.0.0",
-    "mongodb-data-service": "^22.0.0",
     "react": "^16.14.0",
     "storage-mixin": "^5.0.0"
   },
   "devDependencies": {
-    "@electron/remote": "^2.0.8",
     "@mongodb-js/eslint-config-compass": "^1.0.0",
     "@mongodb-js/mocha-config-compass": "^1.0.0",
     "@mongodb-js/prettier-config-compass": "^1.0.0",

packages/compass-query-history/package.json

@@ -1,13 +1,8 @@
 import Collection from 'ampersand-rest-collection';
 import FavoriteQuery from './favorite-query';
 import storageMixin from 'storage-mixin';
-
-let remote;
-try {
-  remote = require('@electron/remote');
-} catch (e) {
-  console.error('Could not load @electron/remote', e.message);
-}
+import { getStoragePaths } from '@mongodb-js/compass-utils';
+const { basepath } = getStoragePaths() || {};
 
 /**
  * Represents a collection of favorite queries.
@@ -23,7 +18,7 @@ const FavoriteQueryCollection = Collection.extend(storageMixin, {
   namespace: 'FavoriteQueries',
   storage: {
     backend: 'disk',
-    basepath: remote ? remote.app.getPath('userData') : undefined,
+    basepath,
   },
   mainIndex: '_id',
   comparator: (favorite) => {

packages/compass-query-history/src/models/favorite-query-collection.js

@@ -1,12 +1,7 @@
 import Query from './query';
 import storageMixin from 'storage-mixin';
-
-let remote;
-try {
-  remote = require('@electron/remote');
-} catch (e) {
-  console.error('Could not load @electron/remote', e.message);
-}
+import { getStoragePaths } from '@mongodb-js/compass-utils';
+const { basepath } = getStoragePaths() || {};
 
 /**
  * A model that represents a favorite MongoDB query.
@@ -16,7 +11,7 @@ const FavoriteQuery = Query.extend(storageMixin, {
   namespace: 'FavoriteQueries',
   storage: {
     backend: 'disk',
-    basepath: remote ? remote.app.getPath('userData') : undefined,
+    basepath,
   },
   props: {
     /**

packages/compass-query-history/src/models/favorite-query.js

@@ -1,13 +1,8 @@
 import Collection from 'ampersand-rest-collection';
 import RecentQuery from './recent-query';
 import storageMixin from 'storage-mixin';
-
-let remote;
-try {
-  remote = require('@electron/remote');
-} catch (e) {
-  console.error('Could not load @electron/remote', e.message);
-}
+import { getStoragePaths } from '@mongodb-js/compass-utils';
+const { basepath } = getStoragePaths() || {};
 
 /**
  * Represents a collection of recent queries.
@@ -23,7 +18,7 @@ const RecentQueryCollection = Collection.extend(storageMixin, {
   namespace: 'RecentQueries',
   storage: {
     backend: 'disk',
-    basepath: remote ? remote.app.getPath('userData') : undefined,
+    basepath,
   },
   mainIndex: '_id',
   comparator: (recent) => {

packages/compass-query-history/src/models/recent-query-collection.js

@@ -1,12 +1,7 @@
 import Query from './query';
 import storageMixin from 'storage-mixin';
-
-let remote;
-try {
-  remote = require('@electron/remote');
-} catch (e) {
-  console.error('Could not load @electron/remote', e.message);
-}
+import { getStoragePaths } from '@mongodb-js/compass-utils';
+const { basepath } = getStoragePaths() || {};
 
 /**
  * A model that represents a recent MongoDB query.
@@ -16,7 +11,7 @@ const RecentQuery = Query.extend(storageMixin, {
   namespace: 'RecentQueries',
   storage: {
     backend: 'disk',
-    basepath: remote ? remote.app.getPath('userData') : undefined,
+    basepath,
   },
 });
 

packages/compass-query-history/src/models/recent-query.js

@@ -1,4 +1,4 @@
-import { promisifyAmpersandMethod } from 'mongodb-data-service';
+import { promisifyAmpersandMethod } from '@mongodb-js/compass-utils';
 import { FavoriteQueryCollection, FavoriteQuery } from '../models';
 
 export class FavoriteQueryStorage {

packages/compass-query-history/src/utils/favorite-query-storage.js

@@ -3,7 +3,7 @@ import { expect } from 'chai';
 import fs from 'fs';
 import path from 'path';
 import os from 'os';
-import { promisifyAmpersandMethod } from 'mongodb-data-service';
+import { promisifyAmpersandMethod } from '@mongodb-js/compass-utils';
 
 import { FavoriteQueryStorage } from '.';
 import { FavoriteQuery, FavoriteQueryCollection } from '../models';