diff --git a/package-lock.json b/package-lock.json index 953ec39a..082ee37e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22555,11 +22555,8 @@ "link": true }, "node_modules/mongodb-ns": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/mongodb-ns/-/mongodb-ns-2.4.2.tgz", - "integrity": "sha512-gYJjEYG4v4a1WSXgUf81OBoBRlj+Z1SlnQVO392fC/4a1CN7CLWDITajZWPFTPh/yRozYk6sHHtZwZmQhodBEA==", - "license": "MIT", - "optional": true + "resolved": "packages/mongodb-ns", + "link": true }, "node_modules/mongodb-query-parser": { "resolved": "packages/query-parser", @@ -30845,6 +30842,41 @@ "node": ">=14.17" } }, + "packages/mongodb-ns": { + "version": "2.4.3", + "license": "Apache-2.0", + "devDependencies": { + "@mongodb-js/eslint-config-devtools": "0.9.11", + "@mongodb-js/mocha-config-devtools": "^1.0.5", + "@mongodb-js/prettier-config-devtools": "^1.0.2", + "@mongodb-js/tsconfig-devtools": "^1.0.3", + "@types/chai": "^4.2.21", + "@types/mocha": "^9.1.1", + "@types/sinon-chai": "^3.2.5", + "depcheck": "^1.4.7", + "eslint": "^7.25.0", + "gen-esm-wrapper": "^1.1.3", + "mocha": "^8.4.0", + "nyc": "^15.1.0", + "prettier": "^3.5.3", + "sinon": "^9.2.3", + "typescript": "^5.8.2" + } + }, + "packages/mongodb-ns/node_modules/typescript": { + "version": "5.9.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.2.tgz", + "integrity": "sha512-CWBzXQrc/qOkhidw1OzBTQuYRbfyxDXJMVJ1XNwUHGROVmuaeiEm3OslpZ1RV96d7SKKjZKrSJu3+t/xlw3R9A==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, "packages/mongodb-redact": { "version": "1.2.0", "license": "Apache-2.0", @@ -31436,6 +31468,32 @@ "node": ">=14.17" } }, + "packages/ns": { + "name": "mongodb-ns", + "version": "0.1.0", + "extraneous": true, + "license": "Apache-2.0", + "devDependencies": { + "@mongodb-js/eslint-config-devtools": "0.9.11", + "@mongodb-js/mocha-config-devtools": "^1.0.5", + "@mongodb-js/prettier-config-devtools": "^1.0.2", + "@mongodb-js/tsconfig-devtools": "^1.0.3", + "@types/chai": "^4.2.21", + "@types/mocha": "^9.1.1", + "@types/node": "^22.15.30", + "@types/sinon-chai": "^3.2.5", + "chai": "^4.5.0", + "depcheck": "^1.4.7", + "eslint": "^7.25.0", + "gen-esm-wrapper": "^1.1.3", + "mocha": "^8.4.0", + "mongodb-js-precommit": "^2.0.0", + "nyc": "^15.1.0", + "prettier": "^3.5.3", + "sinon": "^9.2.3", + "typescript": "^5.8.2" + } + }, "packages/oidc-http-server-pages": { "name": "@mongodb-js/oidc-http-server-pages", "version": "1.1.6", @@ -50785,10 +50843,32 @@ } }, "mongodb-ns": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/mongodb-ns/-/mongodb-ns-2.4.2.tgz", - "integrity": "sha512-gYJjEYG4v4a1WSXgUf81OBoBRlj+Z1SlnQVO392fC/4a1CN7CLWDITajZWPFTPh/yRozYk6sHHtZwZmQhodBEA==", - "optional": true + "version": "file:packages/mongodb-ns", + "requires": { + "@mongodb-js/eslint-config-devtools": "0.9.11", + "@mongodb-js/mocha-config-devtools": "^1.0.5", + "@mongodb-js/prettier-config-devtools": "^1.0.2", + "@mongodb-js/tsconfig-devtools": "^1.0.3", + "@types/chai": "^4.2.21", + "@types/mocha": "^9.1.1", + "@types/sinon-chai": "^3.2.5", + "depcheck": "^1.4.7", + "eslint": "^7.25.0", + "gen-esm-wrapper": "^1.1.3", + "mocha": "^8.4.0", + "nyc": "^15.1.0", + "prettier": "^3.5.3", + "sinon": "^9.2.3", + "typescript": "^5.8.2" + }, + "dependencies": { + "typescript": { + "version": "5.9.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.2.tgz", + "integrity": "sha512-CWBzXQrc/qOkhidw1OzBTQuYRbfyxDXJMVJ1XNwUHGROVmuaeiEm3OslpZ1RV96d7SKKjZKrSJu3+t/xlw3R9A==", + "dev": true + } + } }, "mongodb-query-parser": { "version": "file:packages/query-parser", diff --git a/packages/mongodb-ns/.depcheckrc b/packages/mongodb-ns/.depcheckrc new file mode 100644 index 00000000..48bf9af6 --- /dev/null +++ b/packages/mongodb-ns/.depcheckrc @@ -0,0 +1,8 @@ +ignores: + - '@mongodb-js/prettier-config-devtools' + - '@mongodb-js/tsconfig-devtools' + - '@types/chai' + - '@types/sinon-chai' + - 'sinon' +ignore-patterns: + - 'dist' diff --git a/packages/mongodb-ns/.eslintignore b/packages/mongodb-ns/.eslintignore new file mode 100644 index 00000000..85a8a75e --- /dev/null +++ b/packages/mongodb-ns/.eslintignore @@ -0,0 +1,2 @@ +.nyc-output +dist diff --git a/packages/mongodb-ns/.eslintrc.js b/packages/mongodb-ns/.eslintrc.js new file mode 100644 index 00000000..83296d73 --- /dev/null +++ b/packages/mongodb-ns/.eslintrc.js @@ -0,0 +1,8 @@ +module.exports = { + root: true, + extends: ['@mongodb-js/eslint-config-devtools'], + parserOptions: { + tsconfigRootDir: __dirname, + project: ['./tsconfig-lint.json'], + }, +}; diff --git a/packages/mongodb-ns/.mocharc.js b/packages/mongodb-ns/.mocharc.js new file mode 100644 index 00000000..64afeb1f --- /dev/null +++ b/packages/mongodb-ns/.mocharc.js @@ -0,0 +1 @@ +module.exports = require('@mongodb-js/mocha-config-devtools'); diff --git a/packages/mongodb-ns/.prettierignore b/packages/mongodb-ns/.prettierignore new file mode 100644 index 00000000..4d28df66 --- /dev/null +++ b/packages/mongodb-ns/.prettierignore @@ -0,0 +1,3 @@ +.nyc_output +dist +coverage diff --git a/packages/mongodb-ns/.prettierrc.json b/packages/mongodb-ns/.prettierrc.json new file mode 100644 index 00000000..dfae21d0 --- /dev/null +++ b/packages/mongodb-ns/.prettierrc.json @@ -0,0 +1 @@ +"@mongodb-js/prettier-config-devtools" diff --git a/packages/mongodb-ns/LICENSE b/packages/mongodb-ns/LICENSE new file mode 100644 index 00000000..5e0fd33c --- /dev/null +++ b/packages/mongodb-ns/LICENSE @@ -0,0 +1,201 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, +and distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by +the copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all +other entities that control, are controlled by, or are under common +control with that entity. For the purposes of this definition, +"control" means (i) the power, direct or indirect, to cause the +direction or management of such entity, whether by contract or +otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity +exercising permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, +including but not limited to software source code, documentation +source, and configuration files. + +"Object" form shall mean any form resulting from mechanical +transformation or translation of a Source form, including but +not limited to compiled object code, generated documentation, +and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or +Object form, made available under the License, as indicated by a +copyright notice that is included in or attached to the work +(an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object +form, that is based on (or derived from) the Work and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. For the purposes +of this License, Derivative Works shall not include works that remain +separable from, or merely link (or bind by name) to the interfaces of, +the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including +the original version of the Work and any modifications or additions +to that Work or Derivative Works thereof, that is intentionally +submitted to Licensor for inclusion in the Work by the copyright owner +or by an individual or Legal Entity authorized to submit on behalf of +the copyright owner. For the purposes of this definition, "submitted" +means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, +and issue tracking systems that are managed by, or on behalf of, the +Licensor for the purpose of discussing and improving the Work, but +excluding communication that is conspicuously marked or otherwise +designated in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity +on behalf of whom a Contribution has been received by Licensor and +subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the +Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +(except as stated in this section) patent license to make, have made, +use, offer to sell, sell, import, and otherwise transfer the Work, +where such license applies only to those patent claims licensable +by such Contributor that are necessarily infringed by their +Contribution(s) alone or by combination of their Contribution(s) +with the Work to which such Contribution(s) was submitted. If You +institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work +or a Contribution incorporated within the Work constitutes direct +or contributory patent infringement, then any patent licenses +granted to You under this License for that Work shall terminate +as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the +Work or Derivative Works thereof in any medium, with or without +modifications, and in Source or Object form, provided that You +meet the following conditions: + +(a) You must give any other recipients of the Work or +Derivative Works a copy of this License; and + +(b) You must cause any modified files to carry prominent notices +stating that You changed the files; and + +(c) You must retain, in the Source form of any Derivative Works +that You distribute, all copyright, patent, trademark, and +attribution notices from the Source form of the Work, +excluding those notices that do not pertain to any part of +the Derivative Works; and + +(d) If the Work includes a "NOTICE" text file as part of its +distribution, then any Derivative Works that You distribute must +include a readable copy of the attribution notices contained +within such NOTICE file, excluding those notices that do not +pertain to any part of the Derivative Works, in at least one +of the following places: within a NOTICE text file distributed +as part of the Derivative Works; within the Source form or +documentation, if provided along with the Derivative Works; or, +within a display generated by the Derivative Works, if and +wherever such third-party notices normally appear. The contents +of the NOTICE file are for informational purposes only and +do not modify the License. You may add Your own attribution +notices within Derivative Works that You distribute, alongside +or as an addendum to the NOTICE text from the Work, provided +that such additional attribution notices cannot be construed +as modifying the License. + +You may add Your own copyright statement to Your modifications and +may provide additional or different license terms and conditions +for use, reproduction, or distribution of Your modifications, or +for any such Derivative Works as a whole, provided Your use, +reproduction, and distribution of the Work otherwise complies with +the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, +any Contribution intentionally submitted for inclusion in the Work +by You to the Licensor shall be under the terms and conditions of +this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify +the terms of any separate license agreement you may have executed +with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade +names, trademarks, service marks, or product names of the Licensor, +except as required for reasonable and customary use in describing the +origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or +agreed to in writing, Licensor provides the Work (and each +Contributor provides its Contributions) on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +implied, including, without limitation, any warranties or conditions +of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A +PARTICULAR PURPOSE. You are solely responsible for determining the +appropriateness of using or redistributing the Work and assume any +risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, +whether in tort (including negligence), contract, or otherwise, +unless required by applicable law (such as deliberate and grossly +negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, +incidental, or consequential damages of any character arising as a +result of this License or out of the use or inability to use the +Work (including but not limited to damages for loss of goodwill, +work stoppage, computer failure or malfunction, or any and all +other commercial damages or losses), even if such Contributor +has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing +the Work or Derivative Works thereof, You may choose to offer, +and charge a fee for, acceptance of support, warranty, indemnity, +or other liability obligations and/or rights consistent with this +License. However, in accepting such obligations, You may act only +on Your own behalf and on Your sole responsibility, not on behalf +of any other Contributor, and only if You agree to indemnify, +defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason +of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + +To apply the Apache License to your work, attach the following +boilerplate notice, with the fields enclosed by brackets "{}" +replaced with your own identifying information. (Don't include +the brackets!) The text should be enclosed in the appropriate +comment syntax for the file format. We also recommend that a +file or class name and description of purpose be included on the +same "printed page" as the copyright notice for easier +identification within third-party archives. + +Copyright {yyyy} {name of copyright owner} + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/packages/mongodb-ns/README.md b/packages/mongodb-ns/README.md new file mode 100644 index 00000000..221868f4 --- /dev/null +++ b/packages/mongodb-ns/README.md @@ -0,0 +1,30 @@ +# mongodb-ns + +Handle dem namespaces like the kernel do. + +``` +var ns = require('mongodb-ns'); + +var bacon = ns('canadian-things.songs-aboot-bacon'); +console.log(bacon.toString() + '\n', bacon); +``` + +will output + +``` +canadian-things.songs-aboot-bacon + NS { + ns: 'canadian-things.songs-aboot-bacon', + dotIndex: 15, + database: 'canadian-things', + collection: 'songs-aboot-bacon', + system: false, + oplog: false, + command: false, + special: false, + specialish: false, + normal: true, + validDatabaseName: true, + validCollectionName: true, + databaseHash: 23620443216 } +``` diff --git a/packages/mongodb-ns/package.json b/packages/mongodb-ns/package.json new file mode 100644 index 00000000..55f0d8c6 --- /dev/null +++ b/packages/mongodb-ns/package.json @@ -0,0 +1,71 @@ +{ + "name": "mongodb-ns", + "description": "MongoDB namespace parsing and validation", + "author": { + "name": "MongoDB Inc", + "email": "compass@mongodb.com" + }, + "publishConfig": { + "access": "public" + }, + "bugs": { + "url": "https://jira.mongodb.org/projects/COMPASS/issues", + "email": "compass@mongodb.com" + }, + "homepage": "https://github.com/mongodb-js/devtools-shared", + "version": "2.4.3", + "repository": { + "type": "git", + "url": "https://github.com/mongodb-js/devtools-shared.git" + }, + "files": [ + "dist" + ], + "license": "Apache-2.0", + "main": "dist/index.js", + "types": "./dist/index.d.ts", + "exports": { + "require": { + "default": "./dist/index.js", + "types": "./dist/index.d.ts" + }, + "import": { + "default": "./dist/.esm-wrapper.mjs", + "types": "./dist/index.d.ts" + } + }, + "scripts": { + "bootstrap": "npm run compile", + "prepublishOnly": "npm run compile", + "compile": "tsc -p tsconfig.json && gen-esm-wrapper . ./dist/.esm-wrapper.mjs", + "typecheck": "tsc --noEmit", + "eslint": "eslint", + "prettier": "prettier", + "lint": "npm run eslint . && npm run prettier -- --check .", + "depcheck": "depcheck", + "check": "npm run typecheck && npm run lint && npm run depcheck", + "check-ci": "npm run check", + "test": "mocha", + "test-cov": "nyc -x \"**/*.spec.*\" --reporter=lcov --reporter=text --reporter=html npm run test", + "test-watch": "npm run test -- --watch", + "test-ci": "npm run test-cov", + "reformat": "npm run prettier -- --write ." + }, + "devDependencies": { + "@mongodb-js/eslint-config-devtools": "0.9.11", + "@mongodb-js/mocha-config-devtools": "^1.0.5", + "@mongodb-js/prettier-config-devtools": "^1.0.2", + "@mongodb-js/tsconfig-devtools": "^1.0.3", + "@types/chai": "^4.2.21", + "@types/mocha": "^9.1.1", + "@types/sinon-chai": "^3.2.5", + "depcheck": "^1.4.7", + "eslint": "^7.25.0", + "gen-esm-wrapper": "^1.1.3", + "mocha": "^8.4.0", + "nyc": "^15.1.0", + "prettier": "^3.5.3", + "sinon": "^9.2.3", + "typescript": "^5.8.2" + } +} diff --git a/packages/mongodb-ns/src/index.test.js b/packages/mongodb-ns/src/index.test.js new file mode 100644 index 00000000..782f5432 --- /dev/null +++ b/packages/mongodb-ns/src/index.test.js @@ -0,0 +1,249 @@ +var assert = require('assert'); +var ns = require('..'); + +describe('ns', function () { + describe('normal', function () { + it('should acccept `a`', function () { + assert(ns('a').normal); + }); + it('should acccept `a.b`', function () { + assert(ns('a.b').normal); + }); + it('should acccept `a.b.c`', function () { + assert(ns('a.b.c').normal); + }); + it('should acccept `local.oplog.$main`', function () { + assert(ns('local.oplog.$main').normal); + }); + it('should acccept `local.oplog.rs`', function () { + assert(ns('local.oplog.rs').normal); + }); + it('should not acccept `a.b.$c`', function () { + assert.equal(ns('a.b.$c').normal, false); + }); + it('should not acccept `a.b.$.c`', function () { + assert.equal(ns('a.b.$.c').normal, false); + }); + }); + + it('should identify oplog namespaces', function () { + assert.equal(ns('a').oplog, false); + assert.equal(ns('a.b').oplog, false); + assert(ns('local.oplog.rs').oplog); + assert.equal(ns('local.oplog.foo').oplog, false); + assert(ns('local.oplog.$main').oplog); + assert.equal(ns('local.oplog.$foo').oplog, false); + }); + + describe('should identify special namespaces', function () { + it('should NOT accept `a.$.b as special`', function () { + assert.equal(ns('a.$.b').special, false); + }); + it('should acccept `a.system.foo`', function () { + assert(ns('a.system.foo').special); + }); + it('should acccept `a.enxcol_.foo`', function () { + assert(ns('a.enxcol_.foo').special); + }); + it('should not accept `a.foo`', function () { + assert.equal(ns('a.foo').special, false); + }); + it('should not accept `a.systemfoo`', function () { + assert.equal(ns('a.systemfoo').special, false); + }); + it('should not accept `a.foo.system.bar`', function () { + assert.equal(ns('a.foo.system.bar').special, false); + }); + it('should not accept `prefix__mdb_internal_suffix`', function () { + assert.equal(ns('prefix__mdb_internal_suffix').special, false); + }); + it('should not accept `anyDB.prefix__mdb_internal_suffix`', function () { + assert.equal( + ns('anyDB.prefix__mdb_internal_itsACollectionNow').special, + false, + ); + }); + it('should not accept `prefix__mdb_internal_`', function () { + assert.equal(ns('prefix__mdb_internal_').special, false); + }); + it('should acccept `__mdb_internal_suffix`', function () { + assert(ns('__mdb_internal_suffix').special); + }); + }); + + describe('should identify system namespaces', function () { + it('should acccept `anyDB.enxcol_.` as system`', function () { + assert(ns('anyDB.enxcol_.').system); + }); + it('should acccept `anyDB.system.` as system`', function () { + assert(ns('anyDB.system.').system); + }); + it('should acccept `anyDB.system.anyCollSuffix` as system`', function () { + assert(ns('anyDB.system.anyCollSuffix').system); + }); + it('should NOT acccept `anyDB.anyCollPrefix.system` as system`', function () { + assert.equal(ns('anyDB.anyCollPrefix.system').system, false); + }); + it('should NOT acccept `anyDB.system` as system`', function () { + assert.equal(ns('anyDB.system').system, false); + }); + // exception for system.profile COMPASS-9377 + it('should NOT acccept `anyDB.system.profile as system`', function () { + assert.equal(ns('anyDB.system.profile').system, false); + }); + it('should acccept `anyDB.system.profile_anything as system`', function () { + assert(ns('anyDB.system.profile_anything').system); + }); + }); + + describe('database name validation', function () { + it('should accept `foo` as a valid database name', function () { + assert.equal(ns('foo').validDatabaseName, true); + }); + it('should not accept `foo/bar` as a valid database name', function () { + assert.equal(ns('foo/bar').validDatabaseName, false); + }); + it('should not accept `foo bar` as a valid database name', function () { + assert.equal(ns('foo bar').validDatabaseName, false); + }); + it('should not accept `foo\\bar` as a valid database name', function () { + assert.equal(ns('foo\\bar').validDatabaseName, false); + }); + it('should not accept `foo"bar` as a valid database name', function () { + assert.equal(ns('foo"bar').validDatabaseName, false); + }); + it.skip('should not accept `foo*bar` as a valid database name', function () { + assert.equal(ns('foo*bar').validDatabaseName, false); + }); + it.skip('should not accept `foobar` as a valid database name', function () { + assert.equal(ns('foo>bar').validDatabaseName, false); + }); + it.skip('should not accept `foo:bar` as a valid database name', function () { + assert.equal(ns('foo:bar').validDatabaseName, false); + }); + it.skip('should not accept `foo|bar` as a valid database name', function () { + assert.equal(ns('foo|bar').validDatabaseName, false); + }); + it.skip('should not accept `foo?bar` as a valid database name', function () { + assert.equal(ns('foo?bar').validDatabaseName, false); + }); + }); + + describe('collection name validation', function () { + it('should accept `a.b` as valid', function () { + assert.equal(ns('a.b').validCollectionName, true); + }); + it('should accept `a.b.` as valid', function () { + assert.equal(ns('a.b.').validCollectionName, true); + }); + it('should accept `a$b` as valid', function () { + assert.equal(ns('a$b').validCollectionName, false); + }); + + it('should not accept `a.` as valid', function () { + assert.equal(ns('a.').validCollectionName, false); + }); + + it('should not accept `$a` as valid', function () { + assert.equal(ns('$a').validCollectionName, false); + }); + + it('should not accept `` as valid', function () { + assert.equal(ns('').validCollectionName, false); + }); + }); + + describe('database hash', function () { + it('should have the same value for `foo` and `foo`', function () { + assert.equal(ns('foo').databaseHash, ns('foo').databaseHash); + }); + it('should have the same value for `foo` and `foo.a`', function () { + assert.equal(ns('foo').databaseHash, ns('foo.a').databaseHash); + }); + it('should have the same value for `foo` and `foo.`', function () { + assert.equal(ns('foo').databaseHash, ns('foo.').databaseHash); + }); + it('should have the same value for `` and ``', function () { + assert.equal(ns('').databaseHash, ns('').databaseHash); + }); + it('should have the same value for `` and `.a`', function () { + assert.equal(ns('').databaseHash, ns('.a').databaseHash); + }); + it('should have the same value for `` and `.`', function () { + assert.equal(ns('').databaseHash, ns('.').databaseHash); + }); + it('should not have the same value for `foo` and `food`', function () { + assert.notEqual(ns('foo').databaseHash, ns('food').databaseHash); + }); + it('should not have the same value for `foo.` and `food`', function () { + assert.notEqual(ns('foo.').databaseHash, ns('food').databaseHash); + }); + it('should not have the same value for `foo.d` and `food`', function () { + assert.notEqual(ns('foo.d').databaseHash, ns('food').databaseHash); + }); + }); + + it('should extract database names', function () { + assert.equal(ns('foo').database, ns('foo').database); + assert.equal(ns('foo').database, ns('foo.a').database); + assert.equal(ns('foo.a').database, ns('foo.a').database); + assert.equal(ns('foo.a').database, ns('foo.b').database); + + assert.equal(ns('').database, ns('').database); + assert.equal(ns('').database, ns('.').database); + assert.equal(ns('').database, ns('.x').database); + + assert.notEqual(ns('foo').database, ns('bar').database); + assert.notEqual(ns('foo').database, ns('food').database); + assert.notEqual(ns('foo.').database, ns('food').database); + + assert.notEqual(ns('').database, ns('x').database); + assert.notEqual(ns('').database, ns('x.').database); + assert.notEqual(ns('').database, ns('x.y').database); + assert.notEqual(ns('.').database, ns('x').database); + assert.notEqual(ns('.').database, ns('x.').database); + assert.notEqual(ns('.').database, ns('x.y').database); + + assert.equal('foo', ns('foo.bar').database); + assert.equal('foo', ns('foo').database); + assert.equal('foo', ns('foo.bar').database); + assert.equal('foo', ns('foo').database); + + assert.equal(ns('a.b').database, 'a'); + assert.equal(ns('a.b').collection, 'b'); + + assert.equal(ns('a.b').database, 'a'); + assert.equal(ns('a.b.c').collection, 'b.c'); + + assert.equal(ns('abc.').collection, ''); + assert.equal(ns('abc.').database, 'abc'); + }); + + describe('sorting', function () { + it('should sort them', function () { + var names = [ + 'admin', + 'canadian-things', + 'github', + 'local', + 'scope_stat', + 'statsd', + 'test', + ]; + var expect = [ + 'canadian-things', + 'github', + 'scope_stat', + 'statsd', + 'test', + 'admin', + 'local', + ]; + ns.sort(names); + assert.deepEqual(names, expect); + }); + }); +}); diff --git a/packages/mongodb-ns/src/index.ts b/packages/mongodb-ns/src/index.ts new file mode 100644 index 00000000..33a76e8c --- /dev/null +++ b/packages/mongodb-ns/src/index.ts @@ -0,0 +1,143 @@ +type NS = { + ns: string; + dotIndex: number; + database: string; + collection: string; + system: boolean; + isSystem(): boolean; + oplog: boolean; + isOplog(): boolean; + command: boolean; + isCommand(): boolean; + special: boolean; + isSpecial(): boolean; + specialish: boolean; + normal: boolean; + isNormal(): boolean; + validDatabaseName: boolean; + validCollectionName: boolean; + databaseHash: number; + toString(): string; + // Assigned in the constructor, but will always be undefined + isConf(): undefined; +}; + +type NSConstructor = { + (ns: string | NS): NS; + new (ns: string | NS): NS; + prototype: NS; + MAX_DATABASE_NAME_LENGTH: number; + sort(namespaces: (string | NS)[]): typeof namespaces; +}; + +// eslint-disable-next-line complexity +const NS: NSConstructor = function (this: NS, ns: string | NS): NS { + ns = ns.toString(); + if (!(this instanceof NS)) { + return new NS(ns); + } + + this.ns = ns; + this.dotIndex = ns.indexOf('.'); + if (this.dotIndex === -1) { + this.database = ns; + this.collection = ''; + } else { + this.database = ns.slice(0, this.dotIndex); + this.collection = ns.slice(this.dotIndex + 1); + } + + this.system = /^(?:system(?!\.profile$).*|enxcol_)\./.test(this.collection); + + this.oplog = /local\.oplog\.(\$main|rs)/.test(ns); + + this.command = + this.collection === '$cmd' || this.collection.indexOf('$cmd.sys') === 0; + this.special = + this.oplog || + this.command || + this.system || + this.database === 'config' || + /^__mdb_internal_\w/.test(this.database); + + this.specialish = + this.special || ['local', 'admin'].indexOf(this.database) > -1; + + this.normal = this.oplog || this.ns.indexOf('$') === -1; + + /** + * @note (imlucas) The following are not valid on windows: + * `*<>:|?` + */ + this.validDatabaseName = + new RegExp('^[^\\\\/". ]*$').test(this.database) && + this.database.length <= NS.MAX_DATABASE_NAME_LENGTH; + this.validCollectionName = + this.collection.length > 0 && + (this.oplog || /^[^\0$]*$/.test(this.collection)); + + this.databaseHash = 7; + this.ns.split('').every((c, i) => { + if (c === '.') { + return false; + } + this.databaseHash += 11 * this.ns.charCodeAt(i); + this.databaseHash *= 3; + return true; + }); + return this; +} as unknown as NSConstructor; + +NS.prototype.database = ''; +NS.prototype.databaseHash = 0; +NS.prototype.collection = ''; + +NS.prototype.command = false; +NS.prototype.special = false; +NS.prototype.system = false; +NS.prototype.oplog = false; +NS.prototype.normal = false; +NS.prototype.specialish = false; + +NS.prototype.isCommand = function () { + return this.command; +}; +NS.prototype.isSpecial = function () { + return this.special; +}; +NS.prototype.isSystem = function () { + return this.system; +}; +NS.prototype.isNormal = function () { + return this.normal; +}; +NS.prototype.isOplog = function () { + return this.oplog; +}; +NS.prototype.isConf = function () { + return undefined; +}; + +NS.prototype.toString = function () { + return this.ns; +}; + +NS.MAX_DATABASE_NAME_LENGTH = 128; + +NS.sort = function (namespaces: (NS | string)[]) { + namespaces.sort(function (a, b) { + if (new NS(a).specialish && new NS(b).specialish) { + return 0; + } + if (new NS(a).specialish && !new NS(b).specialish) { + return 1; + } + if (!new NS(a).specialish && new NS(b).specialish) { + return -1; + } + return a > b ? 1 : -1; + }); + return namespaces; +}; + +export = NS; diff --git a/packages/mongodb-ns/tsconfig-lint.json b/packages/mongodb-ns/tsconfig-lint.json new file mode 100644 index 00000000..6bdef84f --- /dev/null +++ b/packages/mongodb-ns/tsconfig-lint.json @@ -0,0 +1,5 @@ +{ + "extends": "./tsconfig.json", + "include": ["**/*"], + "exclude": ["node_modules", "dist"] +} diff --git a/packages/mongodb-ns/tsconfig.json b/packages/mongodb-ns/tsconfig.json new file mode 100644 index 00000000..156674a5 --- /dev/null +++ b/packages/mongodb-ns/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json", + "compilerOptions": { + "outDir": "dist", + "allowJs": true, + "strict": true + }, + "include": ["src/**/*"], + "exclude": ["./src/**/*.spec.*"] +}