Skip to content
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

refactor(NODE-4144): remove all symbol properties #4351

Merged
merged 4 commits into from
Dec 11, 2024
Merged

refactor(NODE-4144): remove all symbol properties #4351

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e105954
chore: remove all symbol properties
nbbeeken Dec 10, 2024
ff0abd4
chore: comments
nbbeeken Dec 11, 2024
3004589
chore: fix closed
nbbeeken Dec 11, 2024
727ad46
fix: test
nbbeeken Dec 11, 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
15 changes: 6 additions & 9 deletions src/bulk/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@ import {
} from '../utils';
import { WriteConcern } from '../write_concern';

/** @internal */
const kServerError = Symbol('serverError');

/** @public */
export const BatchType = Object.freeze({
INSERT: 1,
Expand Down Expand Up @@ -315,29 +312,29 @@ export interface WriteConcernErrorData {
*/
export class WriteConcernError {
/** @internal */
[kServerError]: WriteConcernErrorData;
private serverError: WriteConcernErrorData;

constructor(error: WriteConcernErrorData) {
this[kServerError] = error;
this.serverError = error;
}

/** Write concern error code. */
get code(): number | undefined {
return this[kServerError].code;
return this.serverError.code;
}

/** Write concern error message. */
get errmsg(): string | undefined {
return this[kServerError].errmsg;
return this.serverError.errmsg;
}

/** Write concern error info. */
get errInfo(): Document | undefined {
return this[kServerError].errInfo;
return this.serverError.errInfo;
}

toJSON(): WriteConcernErrorData {
return this[kServerError];
return this.serverError;
}

toString(): string {
Expand Down
58 changes: 23 additions & 35 deletions src/change_stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,6 @@ import type { ServerSessionId } from './sessions';
import { CSOTTimeoutContext, type TimeoutContext } from './timeout';
import { filterOptions, getTopology, type MongoDBNamespace, squashError } from './utils';

/** @internal */
const kCursorStream = Symbol('cursorStream');
/** @internal */
const kClosed = Symbol('closed');
/** @internal */
const kMode = Symbol('mode');

const CHANGE_STREAM_OPTIONS = [
'resumeAfter',
'startAfter',
Expand Down Expand Up @@ -584,14 +577,14 @@ export class ChangeStream<
namespace: MongoDBNamespace;
type: symbol;
/** @internal */
cursor: ChangeStreamCursor<TSchema, TChange>;
private cursor: ChangeStreamCursor<TSchema, TChange>;
streamOptions?: CursorStreamOptions;
/** @internal */
[kCursorStream]?: Readable & AsyncIterable<TChange>;
private cursorStream?: Readable & AsyncIterable<TChange>;
/** @internal */
[kClosed]: boolean;
private isClosed: boolean;
/** @internal */
[kMode]: false | 'iterator' | 'emitter';
private mode: false | 'iterator' | 'emitter';

/** @event */
static readonly RESPONSE = RESPONSE;
Expand Down Expand Up @@ -668,8 +661,8 @@ export class ChangeStream<
// Create contained Change Stream cursor
this.cursor = this._createChangeStreamCursor(options);

this[kClosed] = false;
this[kMode] = false;
this.isClosed = false;
this.mode = false;

// Listen for any `change` listeners being added to ChangeStream
this.on('newListener', eventName => {
Expand All @@ -680,7 +673,7 @@ export class ChangeStream<

this.on('removeListener', eventName => {
if (eventName === 'change' && this.listenerCount('change') === 0 && this.cursor) {
this[kCursorStream]?.removeAllListeners('data');
this.cursorStream?.removeAllListeners('data');
}
});

Expand All @@ -692,11 +685,6 @@ export class ChangeStream<
}
}

/** @internal */
get cursorStream(): (Readable & AsyncIterable<TChange>) | undefined {
return this[kCursorStream];
}

/** The cached resume token that is used to resume after the most recently returned change. */
get resumeToken(): ResumeToken {
return this.cursor?.resumeToken;
Expand Down Expand Up @@ -806,7 +794,7 @@ export class ChangeStream<
}

async *[Symbol.asyncIterator](): AsyncGenerator<TChange, void, void> {
if (this.closed) {
if (this.isClosed) {
baileympearson marked this conversation as resolved.
Show resolved Hide resolved
return;
}

Expand All @@ -826,8 +814,8 @@ export class ChangeStream<
}

/** Is the cursor closed */
get closed(): boolean {
return this[kClosed] || this.cursor.closed;
public get closed(): boolean {
return this.isClosed || this.cursor.closed;
}

/**
Expand All @@ -836,7 +824,7 @@ export class ChangeStream<
async close(): Promise<void> {
this.timeoutContext?.clear();
this.timeoutContext = undefined;
this[kClosed] = true;
this.isClosed = true;

const cursor = this.cursor;
try {
Expand All @@ -855,7 +843,7 @@ export class ChangeStream<
* @throws MongoChangeStreamError if the underlying cursor or the change stream is closed
*/
stream(options?: CursorStreamOptions): Readable & AsyncIterable<TChange> {
if (this.closed) {
if (this.isClosed) {
baileympearson marked this conversation as resolved.
Show resolved Hide resolved
throw new MongoChangeStreamError(CHANGESTREAM_CLOSED_ERROR);
}

Expand All @@ -865,24 +853,24 @@ export class ChangeStream<

/** @internal */
private _setIsEmitter(): void {
if (this[kMode] === 'iterator') {
if (this.mode === 'iterator') {
// TODO(NODE-3485): Replace with MongoChangeStreamModeError
throw new MongoAPIError(
'ChangeStream cannot be used as an EventEmitter after being used as an iterator'
);
}
this[kMode] = 'emitter';
this.mode = 'emitter';
}

/** @internal */
private _setIsIterator(): void {
if (this[kMode] === 'emitter') {
if (this.mode === 'emitter') {
// TODO(NODE-3485): Replace with MongoChangeStreamModeError
throw new MongoAPIError(
'ChangeStream cannot be used as an iterator after being used as an EventEmitter'
);
}
this[kMode] = 'iterator';
this.mode = 'iterator';
}

/**
Expand Down Expand Up @@ -947,8 +935,8 @@ export class ChangeStream<
/** @internal */
private _streamEvents(cursor: ChangeStreamCursor<TSchema, TChange>): void {
this._setIsEmitter();
const stream = this[kCursorStream] ?? cursor.stream();
this[kCursorStream] = stream;
const stream = this.cursorStream ?? cursor.stream();
this.cursorStream = stream;
stream.on('data', change => {
try {
const processedChange = this._processChange(change);
Expand All @@ -963,18 +951,18 @@ export class ChangeStream<

/** @internal */
private _endStream(): void {
const cursorStream = this[kCursorStream];
const cursorStream = this.cursorStream;
if (cursorStream) {
['data', 'close', 'end', 'error'].forEach(event => cursorStream.removeAllListeners(event));
cursorStream.destroy();
}

this[kCursorStream] = undefined;
this.cursorStream = undefined;
}

/** @internal */
private _processChange(change: TChange | null): TChange {
if (this[kClosed]) {
if (this.isClosed) {
// TODO(NODE-3485): Replace with MongoChangeStreamClosedError
throw new MongoAPIError(CHANGESTREAM_CLOSED_ERROR);
}
Expand Down Expand Up @@ -1002,7 +990,7 @@ export class ChangeStream<
/** @internal */
private _processErrorStreamMode(changeStreamError: AnyError, cursorInitialized: boolean) {
// If the change stream has been closed explicitly, do not process error.
if (this[kClosed]) return;
if (this.isClosed) return;

if (
cursorInitialized &&
Expand Down Expand Up @@ -1034,7 +1022,7 @@ export class ChangeStream<

/** @internal */
private async _processErrorIteratorMode(changeStreamError: AnyError, cursorInitialized: boolean) {
if (this[kClosed]) {
if (this.isClosed) {
// TODO(NODE-3485): Replace with MongoChangeStreamClosedError
throw new MongoAPIError(CHANGESTREAM_CLOSED_ERROR);
}
Expand Down
Loading
Loading