chore(cli): show a warning on a platform with a known bug (#23076)

A particular combination of software has hard-to-diagnose bug.

Add a check and warning for it.

Closes #21379.

----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: rix0rrr

packages/aws-cdk/lib/cli.ts

@@ -25,6 +25,7 @@ import { Command, Configuration, Settings } from '../lib/settings';
 import * as version from '../lib/version';
 import { DeploymentMethod } from './api';
 import { enableTracing } from './util/tracing';
+import { checkForPlatformWarnings } from './platform-warnings';
 
 // https://github.com/yargs/yargs/issues/1929
 // https://github.com/evanw/esbuild/issues/1492
@@ -294,6 +295,13 @@ async function initCommandLine() {
   if (argv.ci) {
     setCI(true);
   }
+
+  try {
+    await checkForPlatformWarnings();
+  } catch (e) {
+    debug(`Error while checking for platform warnings: ${e}`);
+  }
+
   debug('CDK toolkit version:', version.DISPLAY_VERSION);
   debug('Command line arguments:', argv);
 

packages/aws-cdk/lib/platform-warnings.ts

@@ -0,0 +1,41 @@
+import * as os from 'os';
+import * as logging from './logging';
+import * as fs from 'fs-extra';
+
+export async function checkForPlatformWarnings() {
+  if (await hasDockerCopyBug()) {
+    logging.warning('`cdk synth` may hang in Docker on Linux 5.6-5.10. See https://github.com/aws/aws-cdk/issues/21379 for workarounds.');
+  }
+}
+
+async function hasDockerCopyBug() {
+  return await runningInDocker() && os.platform() === 'linux' && isVersionBetween(os.release(), '5.6', '5.10');
+}
+
+async function runningInDocker() {
+  return fs.pathExists('/.dockerenv');
+}
+
+export function isVersionBetween(version: string, lower: string, upper: string) {
+  const ver = splitVersion(version);
+  const lo = splitVersion(lower);
+  const up = splitVersion(upper);
+
+  while (lo.length < ver.length) { lo.push(0); }
+  while (up.length < ver.length) { up.push(9999999); }
+
+  let n = ver.length;
+  for (let i = 0; i < n; i++) {
+    if (lo[i] < ver[i] && ver[i] < up[i]) { return true; }
+    if (lo[i] > ver[i] || ver[i] > up[i]) { return false; }
+  }
+
+  return false;
+
+}
+
+function splitVersion(version: string): number[] {
+  return `${version}`.split('.')
+    .map(x => parseInt(x, 10))
+    .map(x => isNaN(x) ? 0 : x);
+}

packages/aws-cdk/test/platform-warnings.test.ts

@@ -0,0 +1,15 @@
+import { isVersionBetween } from '../lib/platform-warnings';
+
+
+test.each([
+  ['2.1', false],
+  ['2.2', true],
+  ['2', false],
+  ['3', true],
+  ['4', false],
+  ['4.3', true],
+  ['4.3', true],
+  ['4.2.294-220.533.amzn2.x86_64', true],
+])('%p is in range: %p', (version, expected) => {
+  expect(isVersionBetween(version, '2.1.0.6', '4.9.2')).toEqual(expected);
+});