Skip to content

feat(shell-api): add support for snapshot reads MONGOSH-1151 #1237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 17, 2022
Merged

feat(shell-api): add support for snapshot reads MONGOSH-1151 #1237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
30fb18d
feat(shell-api): add support for snapshot reads MONGOSH-1151
addaleax Mar 16, 2022
de2f23b
fixup: snapshot reads are 5.0+ only
addaleax Mar 16, 2022
209b037
fixup: missing import
addaleax Mar 17, 2022
7475b39
fixup: use function call instead of assignment for typechecking
addaleax Mar 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 31 additions & 14 deletions packages/shell-api/src/mongo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import {
} from './decorators';
import {
ChangeStreamOptions,
ClientSessionOptions,
CommandOperationOptions,
Document,
generateUri,
ListDatabasesOptions,
Expand Down Expand Up @@ -451,22 +453,37 @@ export default class Mongo extends ShellApiClass {

@topologies([Topologies.ReplSet])
startSession(options: Document = {}): Session {
const driverOptions = {};
if (options === undefined) {
return new Session(this, driverOptions, this._serviceProvider.startSession(driverOptions));
const allTransactionOptions = [
'readConcern', 'writeConcern', 'readPreference', 'maxCommitTimeMS'
] as const;
// eslint-disable-next-line @typescript-eslint/no-unused-vars
function assertAllTransactionOptionsUsed(_options: (typeof allTransactionOptions)[number]) {
// These typechecks might look weird, but will tell us if we are missing
// support for a newly introduced driver option when it is being added
// to the driver API.
}
assertAllTransactionOptionsUsed('' as Exclude<keyof TransactionOptions, keyof CommandOperationOptions>);
const defaultTransactionOptions: TransactionOptions = {};
for (const key of allTransactionOptions) {
if (typeof options[key] !== 'undefined') {
defaultTransactionOptions[key] = options[key];
}
}

const allSessionOptions = [ 'causalConsistency', 'snapshot' ] as const;
// eslint-disable-next-line @typescript-eslint/no-unused-vars
function assertAllSessionOptionsUsed(_options: (typeof allSessionOptions)[number] | 'defaultTransactionOptions') {}
assertAllSessionOptionsUsed('' as keyof ClientSessionOptions);
const driverOptions: ClientSessionOptions = {};
if (Object.keys(defaultTransactionOptions).length > 0) {
driverOptions.defaultTransactionOptions = defaultTransactionOptions;
}
for (const key of allSessionOptions) {
if (typeof options[key] !== 'undefined') {
driverOptions[key] = options[key];
}
}
const defaultTransactionOptions = {} as TransactionOptions;

// Only include option if not undef
Object.assign(defaultTransactionOptions,
options.readConcern && { readConcern: options.readConcern },
options.writeConcern && { writeConcern: options.writeConcern },
options.readPreference && { readPreference: options.readPreference }
);
Object.assign(driverOptions,
Object.keys(defaultTransactionOptions).length > 0 && { defaultTransactionOptions: defaultTransactionOptions },
options.causalConsistency !== undefined && { causalConsistency: options.causalConsistency }
);
return new Session(this, driverOptions, this._serviceProvider.startSession(driverOptions));
}

Expand Down
18 changes: 17 additions & 1 deletion packages/shell-api/src/session.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
ALL_TOPOLOGIES
} from './enums';
import { CliServiceProvider } from '../../service-provider-server';
import { startTestCluster, skipIfApiStrict } from '../../../testing/integration-testing-hooks';
import { startTestCluster, skipIfServerVersion, skipIfApiStrict } from '../../../testing/integration-testing-hooks';
import { ensureMaster, ensureSessionExists } from '../../../testing/helpers';
import Database from './database';
import { CommonErrors, MongoshInvalidInputError } from '@mongosh/errors';
Expand Down Expand Up @@ -227,6 +227,22 @@ describe('Session', () => {
}
expect.fail('Error not thrown');
});
context('with 5.0+ server', () => {
skipIfApiStrict();
skipIfServerVersion(srv0, '< 5.0');
it('starts a session with snapshot reads if requested', async() => {
session = mongo.startSession({ snapshot: true });
await session.getDatabase(databaseName).getCollection('coll').findOne({});
try {
await session.getDatabase(databaseName).getCollection('coll').insertOne({});
expect.fail('missed exception');
} catch (e) {
expect(e.message).to.include('snapshot'); // Cannot do writes with snapshot: true
}
expect(session._session.snapshotEnabled).to.equal(true);
await session.endSession();
});
});
});
describe('transaction methods are called', () => {
it('cannot call start transaction twice', () => {
Expand Down