Merge remote-tracking branch 'origin/master' into 1.24-releases

Author: rose-m

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,14 @@
-<!-- Ticket number and a general summary of your changes in the Title above -->
-<!-- e.g. COMPASS-1111: updates ace editor width in agg pipeline view -->
+<!--
+  ^^^^^
+  Please fill the title above according to https://www.conventionalcommits.org/en/v1.0.0/.
 
-<!--- The following fields are not obligatory. Use your best judgement on what you think is applicable to the work you've done -->
+  type(scope): message <TICKET-NUMBER>
+
+  eg. fix(crud): updates ace editor width in agg pipeline view COMPASS-1111
+
+  NOTE: use `feat`, `fix` and `perf` for user facing changes that will be part of
+  release notes.
+-->
 
 ## Description
 <!--- Describe your changes in detail -->

.gitignore

@@ -15,4 +15,5 @@ report.json
 src/app/compiled-less/
 expansions.yml
 .nvmrc
-.vscode
+.vscode
+src/app/fonts/akzid*

package-lock.json

@@ -221,6 +221,7 @@
     ]
   },
   "scripts": {
+    "install": "node scripts/download-akzidenz.js",
     "postinstall": "electron-rebuild --only kerberos,keytar",
     "prestart": "rm -rf .compiled-sources",
     "start": "hadron-build develop",
@@ -237,7 +238,7 @@
     "test-renderer": "npm test -- --renderer",
     "test-functional": "npm test -- --functional",
     "test-release": "npm test -- --release",
-    "test-release-tasks": "mocha --timeout 30000 release/*.spec.js",
+    "test-release-tasks": "cross-env MONGODB_DOWNLOADS_AWS_ACCESS_KEY_ID='' mocha --timeout 30000 release/*.spec.js",
     "pretravis": "npm run check",
     "travis": "npm test",
     "upload": "hadron-build upload",
@@ -249,7 +250,7 @@
     "url": "git://github.com/mongodb-js/compass.git"
   },
   "dependencies": {
-    "@mongodb-js/compass-aggregations": "^7.1.7",
+    "@mongodb-js/compass-aggregations": "^7.1.10",
     "@mongodb-js/compass-app-stores": "^4.0.2",
     "@mongodb-js/compass-auth-kerberos": "^4.0.1",
     "@mongodb-js/compass-auth-ldap": "^4.0.1",
@@ -259,7 +260,7 @@
     "@mongodb-js/compass-collection-stats": "^5.0.5",
     "@mongodb-js/compass-collections-ddl": "^3.0.5",
     "@mongodb-js/compass-connect": "^5.4.13",
-    "@mongodb-js/compass-crud": "^10.0.5",
+    "@mongodb-js/compass-crud": "^10.1.2",
     "@mongodb-js/compass-database": "^1.0.1",
     "@mongodb-js/compass-databases-ddl": "^3.0.5",
     "@mongodb-js/compass-deployment-awareness": "^10.0.7",
@@ -268,7 +269,7 @@
     "@mongodb-js/compass-field-store": "^6.0.3",
     "@mongodb-js/compass-find-in-page": "^2.0.4",
     "@mongodb-js/compass-home": "^4.2.0",
-    "@mongodb-js/compass-import-export": "^5.1.21",
+    "@mongodb-js/compass-import-export": "^5.1.22",
     "@mongodb-js/compass-indexes": "^3.0.10",
     "@mongodb-js/compass-instance": "^2.0.3",
     "@mongodb-js/compass-loading": "^1.0.7",
@@ -280,8 +281,8 @@
     "@mongodb-js/compass-schema-validation": "^4.0.5",
     "@mongodb-js/compass-server-version": "^4.0.1",
     "@mongodb-js/compass-serverstats": "^14.0.0",
-    "@mongodb-js/compass-shell": "^0.5.0",
-    "@mongodb-js/compass-sidebar": "^3.2.8",
+    "@mongodb-js/compass-shell": "^0.5.2",
+    "@mongodb-js/compass-sidebar": "^3.2.9",
     "@mongodb-js/compass-ssh-tunnel-status": "^5.0.1",
     "@mongodb-js/compass-status": "^4.0.1",
     "ampersand-collection": "^1.5.0",
@@ -319,22 +320,22 @@
     "hadron-react-components": "^4.0.5",
     "hadron-style-manager": "^0.3.0",
     "highlight.js": "^8.9.1",
-    "jquery": "^2.1.4",
+    "jquery": "^3.5.0",
     "kerberos": "^1.1.3",
     "keytar": "^5.1.0",
     "less": "^2.6.1",
     "local-links": "^1.4.0",
-    "lodash": "^3.10.1",
+    "lodash": "^4.17.19",
     "marky": "^1.2.0",
     "moment": "^2.10.6",
     "mongodb": "^3.6.3",
-    "mongodb-ace-autocompleter": "^0.4.12",
+    "mongodb-ace-autocompleter": "^0.4.13",
     "mongodb-ace-mode": "^0.4.1",
     "mongodb-ace-theme": "^0.0.1",
     "mongodb-ace-theme-query": "^0.0.2",
     "mongodb-collection-model": "^3.1.0",
-    "mongodb-connection-model": "^17.0.1",
-    "mongodb-data-service": "^17.0.2",
+    "mongodb-connection-model": "^17.0.3",
+    "mongodb-data-service": "^17.0.3",
     "mongodb-database-model": "^0.1.3",
     "mongodb-explain-plan-model": "^0.2.3",
     "mongodb-extended-json": "^1.11.0",
@@ -351,7 +352,7 @@
     "numeral": "^1.5.3",
     "pluralize": "^1.2.1",
     "prop-types": "^15.5.8",
-    "qs": "^5.2.0",
+    "qs": "^6.0.4",
     "raf": "^3.1.0",
     "react": "^16.8.0",
     "react-ace": "^6.1.1",
@@ -385,6 +386,7 @@
     "cli-ux": "^5.5.0",
     "cross-env": "^7.0.0",
     "devtron": "^1.4.0",
+    "download": "^8.0.0",
     "electron": "6.1.7",
     "electron-rebuild": "^1.10.0",
     "enzyme": "^3.11.0",

package.json

@@ -0,0 +1,88 @@
+const { cli } = require('cli-ux');
+const chalk = require('chalk');
+const _ = require('lodash');
+const git = require('./git');
+const ux = require('./ux');
+
+function capitalize(s) {
+  if (typeof s !== 'string') return '';
+  return s.charAt(0).toUpperCase() + s.slice(1);
+}
+
+function renderCommit({ scope, message, pr, ticket }) {
+  let links = [ticket, pr].filter(Boolean).join(', ');
+
+  if (links) {
+    links = ` (${links})`;
+  }
+
+  return `${scope ? `**${scope}**` + ': ' : ''}${capitalize(message)}${links}`;
+}
+
+async function render(previousTag, releaseTag) {
+  cli.info('');
+  cli.info(`Changes from ${chalk.bold(previousTag)}:`);
+
+  const parseCommit = (commit) => {
+    const PR_RE = /\s+\((#\d+)\)$/;
+    const pr = (commit.match(PR_RE) || [])[1];
+    commit = commit.replace(PR_RE, '');
+
+    const TICKET_RE_WITH_BRACES = /\s+\((COMPASS-\d+)\)$/;
+    let ticket = (commit.match(TICKET_RE_WITH_BRACES) || [])[1];
+    commit = commit.replace(TICKET_RE_WITH_BRACES, '');
+
+    const TICKET_RE_WITHOUT_BRACES = /\s+(COMPASS-\d+)$/;
+    ticket = (commit.match(TICKET_RE_WITHOUT_BRACES) || [])[1];
+    commit = commit.replace(TICKET_RE_WITHOUT_BRACES, '');
+
+    const COMMIT_RE = /^(?<type>feat|fix|perf)(\((?<scope>[^)]*)\))?:\s*(?<message>\S.*)/;
+    const groups = (commit.match(COMMIT_RE) || []).groups;
+    if (!groups) {
+      return;
+    }
+
+    if (groups.scope && groups.scope.match(/COMPASS-\d+/)) {
+      ticket = groups.scope;
+      groups.scope = '';
+    }
+
+    groups.message = groups.message.trim();
+    return {...groups, pr, ticket};
+  };
+
+  const renderLine = (commit) => `- ${renderCommit(commit)}`;
+  const renderSection = ({ title, commits }) => `## ${title}\n\n${commits.map(renderLine).join('\n')}\n\n`;
+
+  const commits = _.uniq(await git.log(previousTag, releaseTag))
+    .map(parseCommit)
+    .filter(Boolean); // only conventional commits
+
+  const changes = [
+    {
+      title: 'Features',
+      commits: commits.filter(({ type }) => type === 'feat')
+    },
+    {
+      title: 'Bug Fixes',
+      commits: commits.filter(({ type }) => type === 'fix')
+    },
+    {
+      title: 'Performance Improvements',
+      commits: commits.filter(({ type }) => type === 'perf')
+    }
+  ]
+    .filter((section) => section.commits.length)
+    .map(renderSection)
+    .join('\n');
+
+  cli.info(
+    `${changes}You can see the full list of commits here:`,
+    '\n' + ux.link(`https://github.com/mongodb-js/compass/compare/${previousTag}...${releaseTag}`)
+  );
+}
+
+module.exports = {
+  render
+};
+

release/changelog.js

@@ -1,5 +1,4 @@
 /* eslint-disable no-console */
-const _ = require('lodash');
 const { cli } = require('cli-ux');
 const chalk = require('chalk');
 const pkgUp = require('pkg-up');
@@ -16,6 +15,8 @@ const version = require('./version');
 
 const publishRelease = require('./publish');
 const waitForAssets = require('./wait-for-assets');
+const ux = require('./ux');
+const changelog = require('./changelog');
 
 async function getPackageJsonVersion() {
   return require(await pkgUp()).version;
@@ -74,31 +75,30 @@ async function startRelease(bumpFn, evergreenProject) {
     return;
   }
 
-  cli.info('');
   cli.info(
-    chalk.bgYellow(
-      chalk.gray(
-        chalk.bold(' MANUAL ACTION REQUIRED!: '))
+    '\n\n',
+    ux.manualAction(
+      `Make sure that ${chalk.bold(evergreenProject)} is building from ${chalk.bold(currentBranch)}:\n`,
+      ux.link(`https://evergreen.mongodb.com/projects##${evergreenProject}`)
     ),
-    `Make sure that ${evergreenProject} is building from ${currentBranch}:\n` +
-    `\thttps://evergreen.mongodb.com/projects##${evergreenProject}`
+    '\n'
   );
 
-  cli.anykey('Press any key to continue.');
+  cli.info('Press enter to continue or Ctrl+C to abort....');
+  ux.waitForEnter();
 
   await commitAndPushNewVersion(
     newSemver,
     currentBranch
   );
 
-  cli.info('');
   cli.info(
-    chalk.bgYellow(
-      chalk.gray(
-        chalk.bold(' MANUAL ACTION REQUIRED!: '))
+    '\n',
+    ux.manualAction(
+      'Make sure that the build is running in evergreen:\n',
+      ux.link(`https://evergreen.mongodb.com/waterfall/${evergreenProject}`)
     ),
-    'Make sure that the build is running in evergreen:\n' +
-    `\thttps://evergreen.mongodb.com/waterfall/${evergreenProject}`
+    '\n'
   );
 
   await waitForAssets(newSemver, { downloadCenter });
@@ -130,6 +130,21 @@ async function releaseCheckout(versionLike) {
   }
 
   await git.checkout(releaseBranchName);
+
+  const remoteBranches = await git.getRemoteBranches();
+  if (!remoteBranches.includes(releaseBranchName)) {
+    cli.info(
+      '\n',
+      ux.manualAction(
+        'You just checked out a new release branch that does not exist in the remote. Run:\n',
+        ux.command(`git push -u origin ${releaseBranchName}`), '\n',
+        'to create the remote branch before proceeding with the release.'
+      ),
+      '\n'
+    );
+  }
+
+  cli.info('Switched to branch:', chalk.bold(await git.getCurrentBranch()));
 }
 
 async function releaseChangelog() {
@@ -151,18 +166,7 @@ async function releaseChangelog() {
     .reverse()
     .find((t) => semver.lt(t, releaseTag));
 
-  cli.info('');
-  cli.info(`Changes from ${chalk.bold(previousTag)}:`);
-  const changes = _.uniq(await git.log(previousTag, releaseTag))
-    .filter((line) => !semver.valid(line)) // filter out tag commits
-    .map((line) => `- ${line}`);
-
-  cli.info(changes.join('\n'));
-
-  cli.info('');
-  cli.info('You can see the full list of commits here:');
-  const githubCompareUrl = `https://github.com/mongodb-js/compass/compare/${previousTag}...${releaseTag}`;
-  cli.url(githubCompareUrl, githubCompareUrl);
+  await changelog.render(previousTag, releaseTag);
 }
 
 async function releasePublish() {
@@ -201,6 +205,15 @@ async function releaseWait() {
   await getValidReleaseBranch();
   const releaseVersion = await getPackageJsonVersion();
 
+  const evergreenProject = version.isGa(releaseVersion) ?
+    '10gen-compass-stable' : '10gen-compass-testing';
+
+  cli.info(
+    `Waiting ${chalk.bold(releaseVersion)} assets for being built in evergreen:`,
+    ux.link(`https://evergreen.mongodb.com/waterfall/${evergreenProject}`),
+    '\n'
+  );
+
   await waitForAssets(releaseVersion, {
     downloadCenter: createDownloadCenter()
   });
@@ -221,4 +234,3 @@ function createDownloadCenter() {
     secretAccessKey: env.requireEnvVar('MONGODB_DOWNLOADS_AWS_SECRET_ACCESS_KEY')
   });
 }
-

release/commands.js

@@ -44,6 +44,15 @@ async function getTags() {
   return stdout.split('\n');
 }
 
+async function getRemoteBranches() {
+  await execa('git', ['fetch', '--all']);
+  const { stdout } = await execa('git', ['branch', '-a']);
+  return stdout.split('\n')
+    .map(s => s.trim())
+    .filter(s => s.match(/^remotes\/origin/))
+    .map(s => s.replace(/^remotes\/origin\//, ''));
+}
+
 async function log(ref1, ref2) {
   const { stdout } = await execa('git', [
     'log',
@@ -64,5 +73,6 @@ module.exports = {
   pushTags,
   getCurrentBranch,
   getTags,
+  getRemoteBranches,
   log
 };

release/git.js

@@ -21,19 +21,12 @@ async function getRelease(tagOrVersion) {
   return releases.find(({ tag_name }) => tag_name === tag);
 }
 
-async function waitForReleaseCreated(tagOrVersion) {
-  return await wait(
-    () => getRelease(tagOrVersion),
-    WAIT_OPTIONS
-  );
-}
-
 async function waitForReleasePublished(tagOrVersion) {
   return await wait(
-    () => getRelease(tagOrVersion).then(({ draft }) => !draft),
+    () => getRelease(tagOrVersion).then((release) => release && !release.draft),
     WAIT_OPTIONS
   );
 }
 
-module.exports = { waitForReleaseCreated, waitForReleasePublished };
+module.exports = { waitForReleasePublished };