Skip to content

Commit c18016a

Browse files
authored
chore: rename service-provider-server and CliServiceProvider (#2232)
`ServiceProvider` is our abstraction for how mongosh interacts with the database. The two notable implementations of that that are actually being used are based on the Node.js driver and the Java driver, respectively. Neither `CliServiceProvider` (has no inherent connection with CLI usage) nor `service-provider-server` (connects to the same servers as any other service provider would) are great names and only reflect the historical architecture for mongosh at this point. So, let's rename this to something that accurately reflects what this service provider implementation is and what distinguishes it from others!
1 parent 80f8b19 commit c18016a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+569
-484
lines changed

.evergreen.yml

Lines changed: 334 additions & 334 deletions
Large diffs are not rendered by default.

package-lock.json

Lines changed: 44 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@
149149
"packages/logging",
150150
"packages/service-provider-core",
151151
"packages/arg-parser",
152-
"packages/service-provider-server",
152+
"packages/service-provider-node-driver",
153153
"packages/shell-api",
154154
"packages/autocomplete",
155155
"packages/shell-evaluator",

packages/browser-runtime-electron/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"@mongodb-js/eslint-config-mongosh": "^1.0.0",
4242
"@mongodb-js/prettier-config-devtools": "^1.0.1",
4343
"@mongodb-js/tsconfig-mongosh": "^1.0.0",
44-
"@mongosh/service-provider-server": "0.0.0-dev.0",
44+
"@mongosh/service-provider-node-driver": "0.0.0-dev.0",
4545
"@types/sinon": "^7.5.1",
4646
"@types/sinon-chai": "^3.2.4",
4747
"depcheck": "^1.4.7",

packages/browser-runtime-electron/src/electron-runtime.spec.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ import sinonChai from 'sinon-chai';
55
chai.use(sinonChai);
66
const { expect } = chai;
77

8-
import { CliServiceProvider } from '@mongosh/service-provider-server';
8+
import { NodeDriverServiceProvider } from '@mongosh/service-provider-node-driver';
99
import { bson } from '@mongosh/service-provider-core';
1010
import { ElectronRuntime } from './electron-runtime';
1111
import { EventEmitter } from 'events';
1212
import type { RuntimeEvaluationListener } from '@mongosh/browser-runtime-core';
1313

1414
describe('Electron runtime', function () {
15-
let serviceProvider: SinonStubbedInstance<CliServiceProvider>;
15+
let serviceProvider: SinonStubbedInstance<NodeDriverServiceProvider>;
1616
let messageBus: SinonStubbedInstance<EventEmitter>;
1717
let evaluationListener: SinonStubbedInstance<RuntimeEvaluationListener>;
1818
let electronRuntime: ElectronRuntime;
1919

2020
beforeEach(function () {
21-
serviceProvider = sinon.createStubInstance(CliServiceProvider);
21+
serviceProvider = sinon.createStubInstance(NodeDriverServiceProvider);
2222
serviceProvider.bsonLibrary = bson;
2323
serviceProvider.getConnectionInfo.resolves({
2424
extraInfo: { uri: '' },

packages/build/src/compile/signable-compiler.ts

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { compileJSFileAsBinary } from 'boxednode';
1010
async function preCompileHook(nodeSourceTree: string) {
1111
const fleAddonVersion = require(path.join(
1212
await findModulePath(
13-
'service-provider-server',
13+
'service-provider-node-driver',
1414
'mongodb-client-encryption'
1515
),
1616
'package.json'
@@ -108,17 +108,20 @@ export class SignableCompiler {
108108
async compile(): Promise<void> {
109109
const fleAddon = {
110110
path: await findModulePath(
111-
'service-provider-server',
111+
'service-provider-node-driver',
112112
'mongodb-client-encryption'
113113
),
114114
requireRegexp: /\bmongocrypt\.node$/,
115115
};
116116
const kerberosAddon = {
117-
path: await findModulePath('service-provider-server', 'kerberos'),
117+
path: await findModulePath('service-provider-node-driver', 'kerberos'),
118118
requireRegexp: /\bkerberos\.node$/,
119119
};
120120
const osDnsAddon = {
121-
path: await findModulePath('service-provider-server', 'os-dns-native'),
121+
path: await findModulePath(
122+
'service-provider-node-driver',
123+
'os-dns-native'
124+
),
122125
requireRegexp: /\bos_dns_native\.node$/,
123126
};
124127
const cryptLibraryVersionAddon = {
@@ -130,7 +133,7 @@ export class SignableCompiler {
130133
requireRegexp: /\bglibc_version\.node$/,
131134
};
132135
// Warning! Until https://jira.mongodb.org/browse/MONGOSH-990,
133-
// packages/service-provider-server *also* has a copy of these.
136+
// packages/service-provider-node-driver *also* has a copy of these.
134137
// We use the versions included in packages/cli-repl here, so these
135138
// should be kept in sync!
136139
const winCAAddon =

packages/cli-repl/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
"@mongosh/js-multiline-to-singleline": "0.0.0-dev.0",
7272
"@mongosh/logging": "0.0.0-dev.0",
7373
"@mongosh/service-provider-core": "0.0.0-dev.0",
74-
"@mongosh/service-provider-server": "0.0.0-dev.0",
74+
"@mongosh/service-provider-node-driver": "0.0.0-dev.0",
7575
"@mongosh/shell-api": "0.0.0-dev.0",
7676
"@mongosh/shell-evaluator": "0.0.0-dev.0",
7777
"@mongosh/snippet-manager": "0.0.0-dev.0",

packages/cli-repl/src/build-info.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import os from 'os';
2-
import { CliServiceProvider } from '@mongosh/service-provider-server';
2+
import { NodeDriverServiceProvider } from '@mongosh/service-provider-node-driver';
33

44
export interface BuildInfo {
55
version: string;
@@ -16,7 +16,7 @@ export interface BuildInfo {
1616
sharedOpenssl: boolean;
1717
segmentApiKey?: string;
1818
runtimeGlibcVersion: string;
19-
deps: ReturnType<typeof CliServiceProvider.getVersionInformation>;
19+
deps: ReturnType<typeof NodeDriverServiceProvider.getVersionInformation>;
2020
}
2121

2222
function getSystemArch(): (typeof process)['arch'] {
@@ -79,7 +79,7 @@ export async function buildInfo({
7979
withSegmentApiKey?: boolean;
8080
} = {}): Promise<BuildInfo> {
8181
const dependencyVersionInfo: BuildInfo['deps'] = {
82-
...CliServiceProvider.getVersionInformation(),
82+
...NodeDriverServiceProvider.getVersionInformation(),
8383
};
8484

8585
const buildInfo = { ...baseBuildInfo(), deps: { ...dependencyVersionInfo } };

packages/cli-repl/src/cli-repl.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import ConnectionString from 'mongodb-connection-string-url';
2929
import type { CliReplOptions } from './cli-repl';
3030
import { CliRepl } from './cli-repl';
3131
import { CliReplErrors } from './error-codes';
32-
import type { DevtoolsConnectOptions } from '@mongosh/service-provider-server';
32+
import type { DevtoolsConnectOptions } from '@mongosh/service-provider-node-driver';
3333
import type { AddressInfo } from 'net';
3434
const { EJSON } = bson;
3535

packages/cli-repl/src/cli-repl.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { redactURICredentials } from '@mongosh/history';
77
import i18n from '@mongosh/i18n';
88
import type { AutoEncryptionOptions } from '@mongosh/service-provider-core';
99
import { bson } from '@mongosh/service-provider-core';
10-
import { CliServiceProvider } from '@mongosh/service-provider-server';
10+
import { NodeDriverServiceProvider } from '@mongosh/service-provider-node-driver';
1111
import type { CliOptions, DevtoolsConnectOptions } from '@mongosh/arg-parser';
1212
import { SnippetManager } from '@mongosh/snippet-manager';
1313
import { Editor } from '@mongosh/editor';
@@ -829,7 +829,7 @@ export class CliRepl implements MongoshIOProvider {
829829
async connect(
830830
driverUri: string,
831831
driverOptions: DevtoolsConnectOptions
832-
): Promise<CliServiceProvider> {
832+
): Promise<NodeDriverServiceProvider> {
833833
const { quiet } = CliRepl.getFileAndEvalInfo(this.cliOptions);
834834
if (!this.cliOptions.nodb && !quiet) {
835835
this.output.write(
@@ -839,7 +839,7 @@ export class CliRepl implements MongoshIOProvider {
839839
'\n'
840840
);
841841
}
842-
return await CliServiceProvider.connect(
842+
return await NodeDriverServiceProvider.connect(
843843
driverUri,
844844
driverOptions,
845845
this.cliOptions,

0 commit comments

Comments
 (0)