From 120e97848e1882270d784cd13c29375c80c901c2 Mon Sep 17 00:00:00 2001 From: Eric Dobbertin Date: Mon, 3 Feb 2020 16:01:04 -0600 Subject: [PATCH 1/7] feat: initial project Signed-off-by: Eric Dobbertin --- .gitignore | 7 ++++ .nvmrc | 1 + .prettierrc | 1 + CODE_OF_CONDUCT.md | 38 ++++++++++++++++++++++ README.md | 51 ++++++++++++++++++++++++++++++ package-lock.json | 5 +++ package.json | 39 +++++++++++++++++++++++ src/doesDatabaseVersionMatch.js | 32 +++++++++++++++++++ src/main.js | 3 ++ src/validateAndTransformVersion.js | 45 ++++++++++++++++++++++++++ 10 files changed, 222 insertions(+) create mode 100644 .gitignore create mode 100644 .nvmrc create mode 100644 .prettierrc create mode 100644 CODE_OF_CONDUCT.md create mode 100644 README.md create mode 100644 package-lock.json create mode 100644 package.json create mode 100644 src/doesDatabaseVersionMatch.js create mode 100644 src/main.js create mode 100644 src/validateAndTransformVersion.js diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000000..4f8cf2ceb91 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +yarn.lock +dist +node_modules diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 00000000000..5c088ddb94a --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +12.14.1 diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 00000000000..73ba663efd2 --- /dev/null +++ b/.prettierrc @@ -0,0 +1 @@ +arrowParens: always diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000000..63b7f2b3d0f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,38 @@ +# Reaction Commerce Code of Conduct + +All Community Guidelines content is licensed under a [Creative Commons Attribution](https://creativecommons.org/licenses/by/3.0/) license. + +Like the technical community as a whole, the Reaction team and community is made up of a mixture of professionals and volunteers from all over the world, working on every aspect of the mission - including mentorship, teaching, and connecting people. + +Diversity is one of our huge strengths, but it can also lead to communication issues and unhappiness. To that end, we have a few ground rules that we ask people to adhere to. This code applies equally to founders, mentors, and those seeking help and guidance. + +This isn’t an exhaustive list of things that you can’t do. Rather, take it in the spirit in which it’s intended - a guide to make it easier to enrich all of us and the broader communities in which we participate. + +This code of conduct applies to all spaces managed by Reaction Commerce. This includes our [development chat room](https://gitter.im/reactioncommerce/reaction), [forums](https://forums.reactioncommerce.com), [blog](https://blog.reactioncommerce.com), mailing lists, [issue tracker](https://github.com/reactioncommerce/reaction/issues), [project boards](https://github.com/reactioncommerce/reaction/projects), Reaction events and meetups, and any other forums or service created by the core project team which the community uses for communication. In addition, violations of this code outside these spaces may affect a person's ability to participate within them. + +If you believe someone is violating the code of conduct, we ask that you report it by emailing . For more details, please see our [Reporting Guidelines](https://docs.reactioncommerce.com/reaction-docs/master/reporting-guide). + +- **Be friendly and patient.** + +- **Be welcoming.** We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, color, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability. + +- **Be considerate.** Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we're a world-wide community, so you might not be communicating in someone else's primary language. + +- **Be respectful.** Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. Members of the Reaction community should be respectful when dealing with other members as well as with people outside the Reaction community. + +- **Be careful in the words that you choose.** We are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren't acceptable. This includes, but is not limited to: + + - Violent threats or language directed against another person. + - Discriminatory jokes and language. + - Posting sexually explicit or violent material. + - Posting (or threatening to post) other people's personally identifying information ("doxing"). + - Personal insults, especially those using racist or sexist terms. + - Unwelcome sexual attention. + - Advocating for, or encouraging, any of the above behavior. + - Repeated harassment of others. In general, if someone asks you to stop, then stop. + +- **When we disagree, try to understand why.** Disagreements, both social and technical, happen all the time and Reaction is no exception. It is important that we resolve disagreements and differing views constructively. Remember that we’re different. The strength of Reaction comes from its varied community, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes. + +## Questions? + +If you have questions, please see the [FAQs](https://docs.reactioncommerce.com/reaction-docs/master/guideline-faqs). If that doesn't answer your questions, feel free to [contact us](mailto:hello@reactioncommerce.com). diff --git a/README.md b/README.md new file mode 100644 index 00000000000..3f3e61b239f --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# @reactioncommerce/migrator-version-check + +An NPM package that provides migrations for use with the `@reactioncommerce/migrator` CLI tool should use this package to check whether data is at the correct version before running any database commands. + +## Usage + +This package exports only one function: `doesDatabaseVersionMatch`. + +```js +import doesDatabaseVersionMatch from "@reactioncommerce/migrator-version-check"; + +const ok = await doesDatabaseVersionMatch({ + // `db` is a Db instance from the `mongodb` NPM package, + // such as what is returned when you do `client.db()` + db, + // These must match one of the namespaces and versions + // your package exports in the `migrations` named export + expectedVersion: 2, + namespace: "my-package-name" +}); + +if (!ok) { + throw new Error('Database needs migrating. The "my-package-name" namespace must be at version 2.'); +} +``` + +## Commit Messages + +To ensure that all contributors follow the correct message convention, each time you commit your message will be validated with the [commitlint](https://www.npmjs.com/package/@commitlint/cli) package, enabled by the [husky](https://www.npmjs.com/package/husky) Git hooks manager. + +Examples of commit messages: https://github.com/semantic-release/semantic-release + +## Publication to NPM + +The `@reactioncommerce/migrator-version-check` package is automatically published by CI when commits are merged or pushed to the `master` branch. This is done using [semantic-release](https://www.npmjs.com/package/semantic-release), which also determines version bumps based on conventional Git commit messages. + +## License +Copyright 2020 Reaction Commerce + +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/package-lock.json b/package-lock.json new file mode 100644 index 00000000000..e429cb8a965 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,5 @@ +{ + "name": "@reactioncommerce/migrator-version-check", + "version": "0.0.0-development", + "lockfileVersion": 1 +} diff --git a/package.json b/package.json new file mode 100644 index 00000000000..bd6dc182e1f --- /dev/null +++ b/package.json @@ -0,0 +1,39 @@ +{ + "name": "@reactioncommerce/migrator-version-check", + "version": "0.0.0-development", + "description": "Data version checker function compatible with @reactioncommerce/migrator", + "main": "./src/main.js", + "type": "module", + "scripts": { + "lint": "eslint src", + "test": "jest src" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/reactioncommerce/migrator-version-check.git" + }, + "author": "Reaction Commerce ", + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/reactioncommerce/migrator-version-check/issues" + }, + "homepage": "https://github.com/reactioncommerce/migrator-version-check#readme", + "dependencies": {}, + "devDependencies": {}, + "eslintConfig": { + "extends": "@reactioncommerce" + }, + "commitlint": { + "extends": [ + "@commitlint/config-conventional" + ] + }, + "husky": { + "hooks": { + "commit-msg": "commitlint -E HUSKY_GIT_PARAMS" + } + }, + "publishConfig": { + "access": "public" + } +} diff --git a/src/doesDatabaseVersionMatch.js b/src/doesDatabaseVersionMatch.js new file mode 100644 index 00000000000..e44ea514e0a --- /dev/null +++ b/src/doesDatabaseVersionMatch.js @@ -0,0 +1,32 @@ +import validateAndTransformVersion from "./validateAndTransformVersion.js"; + +const DEFAULT_MIGRATIONS_COLLECTION_NAME = "migrations"; + +/** + * @summary Determines whether the version in the database for `namespace` is + * the expected one. + * @param {Object} input Input object + * @param {Db} db Mongo library Db instance, connected + * @param {String|Number} expectedVersion Expected version. A number will be coerced into a string. + * @param {String} [migrationsCollectionName] If you use a non-default migrations collection name, + * pass it here. Otherwise "migrations" will be used. + * @param {String} namespace Migration namespace to check + * @return {Boolean} True if they match exactly. + */ +export default async function doesDatabaseVersionMatch({ + db, + expectedVersion, + migrationsCollectionName = DEFAULT_MIGRATIONS_COLLECTION_NAME, + namespace +}) { + const doc = await db.collection(migrationsCollectionName).findOne({ + namespace + }, { + projection: { + version: 1 + } + }); + + const currentVersion = doc && doc.version ? doc.version : "1-0"; + return validateAndTransformVersion(currentVersion) === validateAndTransformVersion(expectedVersion); +} diff --git a/src/main.js b/src/main.js new file mode 100644 index 00000000000..7a7ca746909 --- /dev/null +++ b/src/main.js @@ -0,0 +1,3 @@ +import doesDatabaseVersionMatch from "./doesDatabaseVersionMatch.js"; + +export default doesDatabaseVersionMatch; diff --git a/src/validateAndTransformVersion.js b/src/validateAndTransformVersion.js new file mode 100644 index 00000000000..bae465898c2 --- /dev/null +++ b/src/validateAndTransformVersion.js @@ -0,0 +1,45 @@ +/** + * @summary Given some variable "version", ensures it's either + * a number or a string, transforms it to the standard string + * version format, and validates that it's acceptable. + * @param {String|Number} version Version identifier + * @returns {String} Cleaned and valid version, or `null` + * if invalid + */ +export default function validateAndTransformVersion(version) { + if (typeof version !== "string" && typeof version !== "number") { + throw new Error(`Version "${version}" is not a string or a number`); + } + + const stringVersion = String(version); + if (stringVersion === "NaN" || stringVersion === "") { + throw new Error(`Version "${stringVersion}" is not a number`); + } + + const versionPieces = stringVersion.split("-"); + if (versionPieces.length > 2) { + throw new Error(`Version "${version}" has more than one dash in it`); + } + + const [firstPiece, secondPiece = "0"] = versionPieces; + + const firstNumber = Number(firstPiece); + if (isNaN(firstNumber) || !Number.isInteger(firstNumber)) { + throw new Error(`The major version "${firstPiece}" of version "${version}" is not an integer`); + } + + const secondNumber = Number(secondPiece); + if (isNaN(secondNumber) || !Number.isInteger(secondNumber)) { + throw new Error(`The minor version "${secondPiece}" of version "${version}" is not an integer`); + } + + if (firstNumber < 1) { + throw new Error(`The major version "${firstNumber}" of version "${version}" is less than the minimum of 1`); + } + + if (secondNumber < 0) { + throw new Error(`The minor version "${secondNumber}" of version "${version}" is less than the minimum of 0`); + } + + return `${firstNumber}-${secondNumber}`; +} From ca584a7fef9fec1aa649819a246ac339f9322fe2 Mon Sep 17 00:00:00 2001 From: Spencer Norman Date: Tue, 4 Feb 2020 17:31:16 -0700 Subject: [PATCH 2/7] chore: add DCO instructions and LICENSE file Signed-off-by: Spencer Norman --- LICENSE | 176 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 14 +++++ 2 files changed, 190 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000000..2bb9ad240fa --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + 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 \ No newline at end of file diff --git a/README.md b/README.md index 3f3e61b239f..8cba10d9c36 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,20 @@ Examples of commit messages: https://github.com/semantic-release/semantic-releas The `@reactioncommerce/migrator-version-check` package is automatically published by CI when commits are merged or pushed to the `master` branch. This is done using [semantic-release](https://www.npmjs.com/package/semantic-release), which also determines version bumps based on conventional Git commit messages. +## Developer Certificate of Origin +We use the [Developer Certificate of Origin (DCO)](https://developercertificate.org/) in lieu of a Contributor License Agreement for all contributions to Reaction Commerce open source projects. We request that contributors agree to the terms of the DCO and indicate that agreement by signing-off all commits made to Reaction Commerce projects by adding a line with your name and email address to every Git commit message contributed: +``` +Signed-off-by: Jane Doe +``` + +You can sign-off your commit automatically with Git by using `git commit -s` if you have your `user.name` and `user.email` set as part of your Git configuration. + +We ask that you use your real full name (please no anonymous contributions or pseudonyms) and a real email address. By signing-off your commit you are certifying that you have the right to submit it under the [Apache 2.0 License](./LICENSE). + +We use the [Probot DCO GitHub app](https://github.com/apps/dco) to check for DCO sign-offs of every commit. + +If you forget to sign-off your commits, the DCO bot will remind you and give you detailed instructions for how to amend your commits to add a signature. + ## License Copyright 2020 Reaction Commerce From 8c6b301875b7c7aec6164939fd8c02148c91d385 Mon Sep 17 00:00:00 2001 From: Eric Dobbertin Date: Wed, 5 Feb 2020 18:43:42 -0600 Subject: [PATCH 3/7] feat: add setToExpectedIfMissing option Signed-off-by: Eric Dobbertin --- src/doesDatabaseVersionMatch.js | 44 +++++++++++++++++++++++++++++---- 1 file changed, 39 insertions(+), 5 deletions(-) diff --git a/src/doesDatabaseVersionMatch.js b/src/doesDatabaseVersionMatch.js index e44ea514e0a..263ff41c1fe 100644 --- a/src/doesDatabaseVersionMatch.js +++ b/src/doesDatabaseVersionMatch.js @@ -8,18 +8,28 @@ const DEFAULT_MIGRATIONS_COLLECTION_NAME = "migrations"; * @param {Object} input Input object * @param {Db} db Mongo library Db instance, connected * @param {String|Number} expectedVersion Expected version. A number will be coerced into a string. - * @param {String} [migrationsCollectionName] If you use a non-default migrations collection name, + * @param {String} [migrationsCollectionName=migrations] If you use a non-default migrations collection name, * pass it here. Otherwise "migrations" will be used. * @param {String} namespace Migration namespace to check + * @param {Boolean|Function} [setToExpectedIfMissing=false] Defines what to do if no current + * version is found for this track in the database. By default, the check will fail. That is, + * we will assume that some data must need to be migrated. If you have a way of checking whether + * it's an empty database or confirming that no migrations are needed, you can do that and pass + * `true` here. Then the check will succeed and the current version for the track will be set to + * `expectedVersion`. Alternatively, pass a function that returns a Promise that returns `true` + * or `false`. This way you can avoid database lookups unless a decision is necessary. * @return {Boolean} True if they match exactly. */ export default async function doesDatabaseVersionMatch({ db, expectedVersion, migrationsCollectionName = DEFAULT_MIGRATIONS_COLLECTION_NAME, - namespace + namespace, + setToExpectedIfMissing = false }) { - const doc = await db.collection(migrationsCollectionName).findOne({ + const collection = db.collection(migrationsCollectionName); + + const doc = await collection.findOne({ namespace }, { projection: { @@ -27,6 +37,30 @@ export default async function doesDatabaseVersionMatch({ } }); - const currentVersion = doc && doc.version ? doc.version : "1-0"; - return validateAndTransformVersion(currentVersion) === validateAndTransformVersion(expectedVersion); + const cleanedExpectedVersion = validateAndTransformVersion(expectedVersion); + + let compareVersion; + if (!doc || typeof doc.version !== "string") { + let shouldSetIt = false; + if (typeof setToExpectedIfMissing === "function") { + shouldSetIt = await setToExpectedIfMissing(); + } else if (typeof setToExpectedIfMissing === "boolean") { + shouldSetIt = setToExpectedIfMissing; + } + + if (shouldSetIt) { + await collection.insertOne({ + namespace, + version: cleanedExpectedVersion + }); + + return true; + } + + compareVersion = "1-0"; + } else { + compareVersion = validateAndTransformVersion(doc.version); + } + + return compareVersion === cleanedExpectedVersion; } From 8f724e6c9792f2ad37631f92b650538da9af83c8 Mon Sep 17 00:00:00 2001 From: Eric Dobbertin Date: Wed, 5 Feb 2020 18:46:44 -0600 Subject: [PATCH 4/7] chore: rename to db-version-check Signed-off-by: Eric Dobbertin --- README.md | 6 +++--- package-lock.json | 2 +- package.json | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8cba10d9c36..ac3e06cfdd8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# @reactioncommerce/migrator-version-check +# @reactioncommerce/db-version-check An NPM package that provides migrations for use with the `@reactioncommerce/migrator` CLI tool should use this package to check whether data is at the correct version before running any database commands. @@ -7,7 +7,7 @@ An NPM package that provides migrations for use with the `@reactioncommerce/migr This package exports only one function: `doesDatabaseVersionMatch`. ```js -import doesDatabaseVersionMatch from "@reactioncommerce/migrator-version-check"; +import doesDatabaseVersionMatch from "@reactioncommerce/db-version-check"; const ok = await doesDatabaseVersionMatch({ // `db` is a Db instance from the `mongodb` NPM package, @@ -32,7 +32,7 @@ Examples of commit messages: https://github.com/semantic-release/semantic-releas ## Publication to NPM -The `@reactioncommerce/migrator-version-check` package is automatically published by CI when commits are merged or pushed to the `master` branch. This is done using [semantic-release](https://www.npmjs.com/package/semantic-release), which also determines version bumps based on conventional Git commit messages. +The `@reactioncommerce/db-version-check` package is automatically published by CI when commits are merged or pushed to the `master` branch. This is done using [semantic-release](https://www.npmjs.com/package/semantic-release), which also determines version bumps based on conventional Git commit messages. ## Developer Certificate of Origin We use the [Developer Certificate of Origin (DCO)](https://developercertificate.org/) in lieu of a Contributor License Agreement for all contributions to Reaction Commerce open source projects. We request that contributors agree to the terms of the DCO and indicate that agreement by signing-off all commits made to Reaction Commerce projects by adding a line with your name and email address to every Git commit message contributed: diff --git a/package-lock.json b/package-lock.json index e429cb8a965..c24321c3e52 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "@reactioncommerce/migrator-version-check", + "name": "@reactioncommerce/db-version-check", "version": "0.0.0-development", "lockfileVersion": 1 } diff --git a/package.json b/package.json index bd6dc182e1f..529b3df861c 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@reactioncommerce/migrator-version-check", + "name": "@reactioncommerce/db-version-check", "version": "0.0.0-development", "description": "Data version checker function compatible with @reactioncommerce/migrator", "main": "./src/main.js", @@ -10,14 +10,14 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/reactioncommerce/migrator-version-check.git" + "url": "git+https://github.com/reactioncommerce/db-version-check.git" }, "author": "Reaction Commerce ", "license": "Apache-2.0", "bugs": { - "url": "https://github.com/reactioncommerce/migrator-version-check/issues" + "url": "https://github.com/reactioncommerce/db-version-check/issues" }, - "homepage": "https://github.com/reactioncommerce/migrator-version-check#readme", + "homepage": "https://github.com/reactioncommerce/db-version-check#readme", "dependencies": {}, "devDependencies": {}, "eslintConfig": { From d954b0d5cb7b2968dc22ec5c5a51a5801bdb4357 Mon Sep 17 00:00:00 2001 From: Eric Dobbertin Date: Wed, 5 Feb 2020 20:27:00 -0600 Subject: [PATCH 5/7] chore: CI publish Signed-off-by: Eric Dobbertin --- .circleci/config.yml | 24 ++++++++++++++++++++++++ package.json | 5 +++++ 2 files changed, 29 insertions(+) create mode 100644 .circleci/config.yml diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 00000000000..dbc4c9bf2c0 --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,24 @@ +# Javascript Node CircleCI 2.0 configuration file +# +# Check https://circleci.com/docs/2.0/language-javascript/ for more details +# +version: 2 +jobs: + deploy: + docker: + - image: circleci/node:12.14.1 + working_directory: ~/repo + steps: + - checkout + - run: npm install + - run: npx semantic-release + +workflows: + version: 2 + deploy: + jobs: + - deploy: + context: reaction-publish-semantic-release + filters: + branches: + only: trunk diff --git a/package.json b/package.json index 529b3df861c..89e8049d85f 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,11 @@ "version": "0.0.0-development", "description": "Data version checker function compatible with @reactioncommerce/migrator", "main": "./src/main.js", + "files": [ + "src", + "LICENSE", + "README.md" + ], "type": "module", "scripts": { "lint": "eslint src", From 8473782ad55394752a3c9492cdbad08d26030f5f Mon Sep 17 00:00:00 2001 From: Eric Dobbertin Date: Wed, 5 Feb 2020 20:32:57 -0600 Subject: [PATCH 6/7] chore: add semantic release branch config Signed-off-by: Eric Dobbertin --- package.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/package.json b/package.json index 89e8049d85f..caa9559dd13 100644 --- a/package.json +++ b/package.json @@ -40,5 +40,8 @@ }, "publishConfig": { "access": "public" + }, + "release": { + "branches": ["trunk"] } } From 8b3e0973fa88db8c20249d68964b4742f9c4b992 Mon Sep 17 00:00:00 2001 From: Eric Dobbertin Date: Wed, 5 Feb 2020 20:41:51 -0600 Subject: [PATCH 7/7] docs: document setToExpectedIfMissing Signed-off-by: Eric Dobbertin --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ac3e06cfdd8..1332465c8c5 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,23 @@ const ok = await doesDatabaseVersionMatch({ // These must match one of the namespaces and versions // your package exports in the `migrations` named export expectedVersion: 2, - namespace: "my-package-name" + namespace: "my-package-name", + // Defines what to do if no current version is found for this track in + // the database. By default, the check will fail. That is, we will assume + // that some data must need to be migrated. If you have a way of checking + // whether it's an empty database or confirming that no migrations are + // needed, you can do that and pass `true` here. Then the check will + // succeed and the current version for the track will be set to + // `expectedVersion`. Alternatively, pass a function that returns + // a Promise that returns `true` or `false`. This way you can avoid + // database lookups unless a decision is necessary. + async setToExpectedIfMissing() { + const anyAccount = await db.collection("Accounts").findOne(); + // If there are no accounts, it's probably a brand new database + // so we can assume all our data will be at the latest version + // and mark it as such in the database. + return !anyAccount; + } }); if (!ok) { @@ -32,7 +48,7 @@ Examples of commit messages: https://github.com/semantic-release/semantic-releas ## Publication to NPM -The `@reactioncommerce/db-version-check` package is automatically published by CI when commits are merged or pushed to the `master` branch. This is done using [semantic-release](https://www.npmjs.com/package/semantic-release), which also determines version bumps based on conventional Git commit messages. +The `@reactioncommerce/db-version-check` package is automatically published by CI when commits are merged or pushed to the `trunk` branch. This is done using [semantic-release](https://www.npmjs.com/package/semantic-release), which also determines version bumps based on conventional Git commit messages. ## Developer Certificate of Origin We use the [Developer Certificate of Origin (DCO)](https://developercertificate.org/) in lieu of a Contributor License Agreement for all contributions to Reaction Commerce open source projects. We request that contributors agree to the terms of the DCO and indicate that agreement by signing-off all commits made to Reaction Commerce projects by adding a line with your name and email address to every Git commit message contributed: