fix(shell-api): apply readPreference to admin read commands MONGOSH-1837

packages/shell-api/src/collection.ts

@@ -2054,7 +2054,7 @@ export default class Collection extends ShellApiWithMongoClass {
  @apiVersions([])
  async getShardVersion(): Promise<Document> {
  this._emitCollectionApiCall('getShardVersion', {});
- return await this._database._runAdminCommand({
+ return await this._database._runAdminReadCommand({
  getShardVersion: `${this._database._name}.${this._name}`,
  });
  }
@@ -2258,7 +2258,7 @@ export default class Collection extends ShellApiWithMongoClass {
  ): Promise<Document> {
  assertArgsDefinedType([key], [true], 'Collection.analyzeShardKey');
  this._emitCollectionApiCall('analyzeShardKey', { key });
- return await this._database._runAdminCommand({
+ return await this._database._runAdminReadCommand({
  analyzeShardKey: this.getFullName(),
  key,
  ...options,

packages/shell-api/src/database.ts

@@ -185,10 +185,14 @@ export default class Database extends ShellApiWithMongoClass {
  cmd: Document,
  options: CommandOperationOptions = {}
  ): Promise<Document> {
- return this.getSiblingDB('admin')._runCommand(cmd, {
- ...(await this._baseOptions()),
- ...options,
- });
+ return this.getSiblingDB('admin')._runCommand(cmd, options);
+ }
+
+ public async _runAdminReadCommand(
+ cmd: Document,
+ options: CommandOperationOptions = {}
+ ): Promise<Document> {
+ return this.getSiblingDB('admin')._runReadCommand(cmd, options);
  }
 
  public async _runCursorCommand(
@@ -1126,10 +1130,10 @@ export default class Database extends ShellApiWithMongoClass {
  }
 
  @returnsPromise
- @apiVersions([]) // TODO: Update this after https://jira.mongodb.org/browse/SPM-2327
+ @apiVersions([])
  async version(): Promise<string> {
  this._emitDatabaseApiCall('version', {});
- const info: Document = await this._runAdminCommand({
+ const info: Document = await this._runAdminReadCommand({
  buildInfo: 1,
  });
  if (!info || info.version === undefined) {
@@ -1144,10 +1148,10 @@ export default class Database extends ShellApiWithMongoClass {
  }
 
  @returnsPromise
- @apiVersions([]) // TODO: Maybe update this after https://jira.mongodb.org/browse/SPM-2327
+ @apiVersions([])
  async serverBits(): Promise<Document> {
  this._emitDatabaseApiCall('serverBits', {});
- const info: Document = await this._runAdminCommand({
+ const info: Document = await this._runAdminReadCommand({
  buildInfo: 1,
  });
  if (!info || info.bits === undefined) {
@@ -1197,7 +1201,7 @@ export default class Database extends ShellApiWithMongoClass {
  @apiVersions([])
  async serverBuildInfo(): Promise<Document> {
  this._emitDatabaseApiCall('serverBuildInfo', {});
- return await this._runAdminCommand({
+ return await this._runAdminReadCommand({
  buildInfo: 1,
  });
  }
@@ -1206,7 +1210,7 @@ export default class Database extends ShellApiWithMongoClass {
  @apiVersions([])
  async serverStatus(opts = {}): Promise<Document> {
  this._emitDatabaseApiCall('serverStatus', { options: opts });
- return await this._runAdminCommand({
+ return await this._runAdminReadCommand({
  serverStatus: 1,
  ...opts,
  });
@@ -1235,7 +1239,7 @@ export default class Database extends ShellApiWithMongoClass {
  @apiVersions([])
  async hostInfo(): Promise<Document> {
  this._emitDatabaseApiCall('hostInfo', {});
- return await this._runAdminCommand({
+ return await this._runAdminReadCommand({
  hostInfo: 1,
  });
  }
@@ -1244,7 +1248,7 @@ export default class Database extends ShellApiWithMongoClass {
  @apiVersions([])
  async serverCmdLineOpts(): Promise<Document> {
  this._emitDatabaseApiCall('serverCmdLineOpts', {});
- return await this._runAdminCommand({
+ return await this._runAdminReadCommand({
  getCmdLineOpts: 1,
  });
  }
@@ -1353,7 +1357,7 @@ export default class Database extends ShellApiWithMongoClass {
  this._emitDatabaseApiCall('getLogComponents', {});
  const cmdObj = { getParameter: 1, logComponentVerbosity: 1 };
 
- const result = await this._runAdminCommand(cmdObj);
+ const result = await this._runAdminReadCommand(cmdObj);
  if (!result || result.logComponentVerbosity === undefined) {
  throw new MongoshRuntimeError(
  `Error running command ${result ? result.errmsg || '' : ''}`,
@@ -1493,7 +1497,7 @@ export default class Database extends ShellApiWithMongoClass {
  if (
  (await local.getCollection('system.replset').countDocuments({})) !== 0
  ) {
- const status = await this._runAdminCommand({ replSetGetStatus: 1 });
+ const status = await this._runAdminReadCommand({ replSetGetStatus: 1 });
  // get primary
  let primary = null;
  for (const member of status.members) {

packages/shell-api/src/replica-set.ts

@@ -60,7 +60,7 @@ export default class ReplicaSet extends ShellApiWithMongoClass {
 
  async _getConfig(): Promise<ReplSetConfig> {
  try {
- const result = await this._database._runAdminCommand({
+ const result = await this._database._runAdminReadCommand({
  replSetGetConfig: 1,
  });
  if (result.config === undefined) {
@@ -242,7 +242,7 @@ export default class ReplicaSet extends ShellApiWithMongoClass {
  @apiVersions([])
  async status(): Promise<Document> {
  this._emitReplicaSetApiCall('status', {});
- return this._database._runAdminCommand({
+ return this._database._runAdminReadCommand({
  replSetGetStatus: 1,
  });
  }

packages/shell-api/src/shard.ts

@@ -486,7 +486,7 @@ export default class Shard extends ShellApiWithMongoClass {
  async balancerCollectionStatus(ns: string): Promise<Document> {
  assertArgsDefinedType([ns], ['string'], 'Shard.balancerCollectionStatus');
  this._emitShardApiCall('balancerCollectionStatus', { ns });
- return this._database._runAdminCommand({
+ return this._database._runAdminReadCommand({
  balancerCollectionStatus: ns,
  });
  }
@@ -540,7 +540,7 @@ export default class Shard extends ShellApiWithMongoClass {
  async isBalancerRunning(): Promise<Document> {
  this._emitShardApiCall('isBalancerRunning', {});
  await getConfigDB(this._database);
- return this._database._runAdminCommand({
+ return this._database._runAdminReadCommand({
  balancerStatus: 1,
  });
  }
@@ -550,7 +550,7 @@ export default class Shard extends ShellApiWithMongoClass {
  async startBalancer(timeout = 60000): Promise<Document> {
  assertArgsDefinedType([timeout], ['number'], 'Shard.startBalancer');
  this._emitShardApiCall('startBalancer', { timeout });
- return this._database._runAdminCommand({
+ return this._database._runAdminReadCommand({
  balancerStart: 1,
  maxTimeMS: timeout,
  });