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

Jump to bottom

fix: versioned api low node compat fix #2970

Merged
merged 3 commits into from
Aug 31, 2021
Merged

fix: versioned api low node compat fix #2970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80330f6
fix: versioned api low node compat
dariakp Aug 31, 2021
b6498e9
test: do not use node util for deep equality check
dariakp Aug 31, 2021
5ee94a2
refactor: review suggestion
dariakp Aug 31, 2021
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: 2 additions & 0 deletions lib/core/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ try {
const ServerApiVersion = Object.freeze({
v1: '1'
});
const ValidServerApiVersions = Object.keys(ServerApiVersion).map(key => ServerApiVersion[key]);

module.exports = {
// Versioned API
ServerApiVersion,
ValidServerApiVersions,
// Errors
MongoError: require('./error').MongoError,
MongoNetworkError: require('./error').MongoNetworkError,
Expand Down
16 changes: 8 additions & 8 deletions lib/mongo_client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ const Db = require('./db');
const EventEmitter = require('events').EventEmitter;
const inherits = require('util').inherits;
const MongoError = require('./core').MongoError;
const ServerApiVersion = require('./core').ServerApiVersion;
const ValidServerApiVersions = require('./core').ValidServerApiVersions;
const deprecate = require('util').deprecate;
const WriteConcern = require('./write_concern');
const MongoDBNamespace = require('./utils').MongoDBNamespace;
Expand Down Expand Up @@ -206,16 +206,16 @@ function MongoClient(url, options) {
const versionToValidate = serverApiToValidate && serverApiToValidate.version;
if (!versionToValidate) {
throw new MongoError(
`Invalid \`serverApi\` property; must specify a version from the following enum: ["${Object.values(
ServerApiVersion
).join('", "')}"]`
`Invalid \`serverApi\` property; must specify a version from the following enum: ["${ValidServerApiVersions.join(
'", "'
)}"]`
);
}
if (!Object.values(ServerApiVersion).some(v => v === versionToValidate)) {
if (!ValidServerApiVersions.some(v => v === versionToValidate)) {
throw new MongoError(
`Invalid server API version=${versionToValidate}; must be in the following enum: ["${Object.values(
ServerApiVersion
).join('", "')}"]`
`Invalid server API version=${versionToValidate}; must be in the following enum: ["${ValidServerApiVersions.join(
'", "'
)}"]`
);
}
options.serverApi = serverApiToValidate;
Expand Down
7 changes: 5 additions & 2 deletions test/functional/unified-spec-runner/unified-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import { expect } from 'chai';
import type { CollectionOrDatabaseOptions, RunOnRequirement, Document } from './schema';
import { gte as semverGte, lte as semverLte } from 'semver';
import { MongoClient } from '../../../index';
import { isDeepStrictEqual } from 'util';
import { TestConfiguration } from './runner';

export async function topologySatisfies(
Expand Down Expand Up @@ -41,7 +40,11 @@ export async function topologySatisfies(
if (!config.parameters) throw new Error('Configuration does not have server parameters');
for (const [name, value] of Object.entries(r.serverParameters)) {
if (name in config.parameters) {
ok &&= isDeepStrictEqual(config.parameters[name], value);
try {
expect(config.parameters[name]).to.deep.equal(value);
} catch (_err) {
ok = false;
}
}
}
}
Expand Down
4 changes: 1 addition & 3 deletions test/functional/versioned-api.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@
const expect = require('chai').expect;
const loadSpecTests = require('../spec/index').loadSpecTests;
const runUnifiedTest = require('./unified-spec-runner/runner').runUnifiedTest;
const ServerApiVersion = require('../../lib/core').ServerApiVersion;
const validVersions = require('../../lib/core').ValidServerApiVersions;

describe('Versioned API', function() {
describe('client option validation', function() {
it('is supported as a client option when it is a valid ServerApiVersion string', function() {
const validVersions = Object.values(ServerApiVersion);
expect(validVersions.length).to.be.at.least(1);
for (const version of validVersions) {
const client = this.configuration.newClient('mongodb://localhost/', {
Expand All @@ -21,7 +20,6 @@ describe('Versioned API', function() {
});

it('is supported as a client option when it is an object with a valid version property', function() {
const validVersions = Object.values(ServerApiVersion);
expect(validVersions.length).to.be.at.least(1);
for (const version of validVersions) {
const client = this.configuration.newClient('mongodb://localhost/', {
Expand Down