Skip to content

chore(data-service): Rename killSession to killSessions #2594

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 1 commit into from
Nov 18, 2021
Merged

chore(data-service): Rename killSession to killSessions #2594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/compass-crud/src/stores/crud-store.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1150,7 +1150,7 @@ const configureStore = (options = {}) => {
}
this.setState({ sessions: null });
try {
await this.dataService.killSession(sessions);
await this.dataService.killSessions(sessions);
} catch (err) {
log.warn(mongoLogId(1001000096), 'Documents', 'Attempting to kill the session failed');
}
Expand Down
6 changes: 3 additions & 3 deletions packages/compass-crud/src/utils/cancellable-queries.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ describe('cancellable-queries', function() {
await expect(promise).to.be.rejectedWith(Error, OPERATION_CANCELLED_MESSAGE);

// kill the session
await dataService.killSession(session);
await dataService.killSessions(session);

// give it enough time to be killed
await delay(100);
Expand Down Expand Up @@ -180,7 +180,7 @@ describe('cancellable-queries', function() {
// kill the session
// (unfortunately I can't think of a way to slow the query down enough so
// we can make sure the operation appeared and then disappeared)
await dataService.killSession(session);
await dataService.killSessions(session);
});
});

Expand All @@ -204,7 +204,7 @@ describe('cancellable-queries', function() {

// kill the session
// (same problem with testing that this actually worked as for count queries above)
await dataService.killSession(session);
await dataService.killSessions(session);
});

// TODO: if (configDocs && configDocs.length) { implies that configDocs could be empty?
Expand Down
8 changes: 4 additions & 4 deletions packages/data-service/src/data-service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1313,16 +1313,16 @@ describe('DataService', function () {
const session = dataService.startSession();
expect(session.constructor.name).to.equal('ClientSession');

// used by killSession, must be a bson UUID in order to work
// used by killSessions, must be a bson UUID in order to work
expect(session.id!.id._bsontype).to.equal('Binary');
expect(session.id!.id.sub_type).to.equal(4);
});
});

describe('#killSession', function () {
describe('#killSessions', function () {
it('does not throw if kill a non existing session', async function () {
const session = dataService.startSession();
await dataService.killSession(session);
await dataService.killSessions(session);
});

it('kills a command with a session', async function () {
Expand All @@ -1337,7 +1337,7 @@ describe('DataService', function () {
);

const session = dataService.startSession();
await dataService.killSession(session);
await dataService.killSessions(session);

expect(commandSpy.args[0][0]).to.deep.equal({
killSessions: [session.id],
Expand Down
2 changes: 1 addition & 1 deletion packages/data-service/src/data-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1420,7 +1420,7 @@ class DataService extends EventEmitter {
* Kill a session and terminate all in progress operations.
* @param clientSession - a ClientSession (can be created with startSession())
*/
killSession(sessions: ClientSession | ClientSession[]): Promise<Document> {
killSessions(sessions: ClientSession | ClientSession[]): Promise<Document> {
return this._initializedClient.db('admin').command({
killSessions: Array.isArray(sessions)
? sessions.map((s) => s.id)
Expand Down