Skip to content

fix(NODE-6066): signature can be optional at runtime #4069

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 2 commits into from
Apr 4, 2024
Merged

fix(NODE-6066): signature can be optional at runtime #4069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4e687d
fix(NODE-6066): signature can be optional at runtime
nbbeeken Apr 4, 2024
d9769ad
fix: lint
nbbeeken Apr 4, 2024
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
10 changes: 8 additions & 2 deletions src/sdam/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,16 @@ export function drainTimerQueue(queue: TimerQueue): void {
queue.clear();
}

/** @public */
/**
* @public
* Gossiped in component for the cluster time tracking the state of user databases
* across the cluster. It may optionally include a signature identifying the process that
* generated such a value.
*/
export interface ClusterTime {
clusterTime: Timestamp;
signature: {
/** Used to validate the identity of a request or response's ClusterTime. */
signature?: {
hash: Binary;
keyId: Long;
};
Expand Down
10 changes: 8 additions & 2 deletions test/types/sessions.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { expectError, expectType } from 'tsd';
import { expectAssignable, expectError, expectType } from 'tsd';

import type { ClientSession } from '../mongodb';
import type { Binary, ClientSession, ClusterTime, Long, Timestamp } from '../mongodb';
import { MongoClient, ReadConcern, ReadConcernLevel } from '../mongodb';

// test mapped cursor types
Expand All @@ -25,3 +25,9 @@ const unknownFn: () => Promise<unknown> = async () => 2;
expectType<unknown>(await client.withSession(unknownFn));
// Not a promise returning function
expectError(await client.withSession(() => null));

declare const ct: ClusterTime;
expectType<Timestamp>(ct.clusterTime);
expectAssignable<ClusterTime['signature']>(undefined);
expectType<Binary | undefined>(ct.signature?.hash);
expectType<Long | undefined>(ct.signature?.keyId);