feat(ci): monitor typescript perf

.github/workflows/js-build-and-lint.yml

@@ -105,7 +105,7 @@ jobs:
       - name: tsc
         if: steps.dependencies.outcome == 'success' && steps.changes.outputs.frontend == 'true'
         run: |
-          yarn tsc -p config/tsconfig.build.json
+          yarn tsc -p config/tsconfig.build.json | tee /tmp/typescript-monitor-log && node .github/workflows/scripts/monitor-typescript.js
 
       - name: storybook
         if: github.ref != 'refs/heads/master' && steps.changes.outputs.frontend == 'true'

.github/workflows/scripts/monitor-typescript.js

@@ -0,0 +1,105 @@
+/* eslint-env node */
+
+// eslint-disable-next-line
+const fs = require('fs');
+const Sentry = require('@sentry/node');
+
+Sentry.init({
+  // jest project under Sentry organization (dev productivity team)
+  dsn: 'https://[email protected]/4857230',
+  tracesSampleRate: 1.0,
+  environment: 'ci',
+});
+
+if (!fs.existsSync('/tmp/typescript-monitor.log')) {
+  // We failed to retrieve the log file, but we dont want to impact the pipeline so just exit.
+  // The absence of metrics in sentry should warn us here
+  process.exit(0);
+}
+
+const ALLOWED_KEYS = new Set([
+  'Files',
+  'Lines',
+  'Nodes',
+  'Identifiers',
+  'Symbols',
+  'Types',
+  'Instantiations',
+  'Memory used',
+  'I/O Read',
+  'I/O Write',
+  'Parse time',
+  'Bind time',
+  'Check time',
+  'Emit time',
+  'Total time',
+]);
+
+const tsLogFile = fs.readFileSync('/tmp/typescript-monitor.log', 'utf8');
+
+function toKeyValue(input) {
+  try {
+    return input
+      .split('\n')
+      .filter(n => !!n)
+      .reduce((acc, line) => {
+        const [k, v] = line.split(':');
+
+        if (typeof k !== 'string' || typeof v !== 'string') {
+          return acc;
+        }
+
+        const key = k.trim();
+        const value = v.trim();
+
+        if (ALLOWED_KEYS.has(key)) {
+          let number = parseFloat(value);
+          let unit = undefined;
+
+          if (!isNaN(number)) {
+            acc[key] = {value: number, unit};
+          }
+
+          if (/([a-zA-Z]$)/.test(value)) {
+            number = parseFloat(v.substring(0, v.length - 2));
+            unit = v.match(/([a-zA-Z]$)/)?.[0];
+            acc[key] = {value: number, unit};
+          }
+        }
+
+        return acc;
+      }, {});
+  } catch (e) {
+    return null;
+  }
+}
+
+const parsedDiagnostics = toKeyValue(tsLogFile);
+
+if (parsedDiagnostics === null) {
+  // We failed to parse here, but we dont want to impact the pipeline so just exit.
+  // The absence of metrics in sentry should warn us here
+  process.exit(0);
+}
+
+const bindTime = parsedDiagnostics['Bind time'];
+const checkTime = parsedDiagnostics['Check time'];
+const parseTime = parsedDiagnostics['Parse time'];
+const totalTime = parsedDiagnostics['Total time'];
+const memoryUsage = parsedDiagnostics['Memory used'];
+
+const transaction = Sentry.startTransaction({name: 'typescript.compilation'});
+
+transaction.setMeasurements({
+  'typescript.time.check': {value: checkTime.value},
+  'typescript.time.bind': {value: bindTime.value},
+  'typescript.time.parse': {value: parseTime.value},
+  'typescript.time.total': {value: totalTime.value},
+  'typescript.memory.used': {value: memoryUsage.value},
+});
+
+transaction.finish();
+
+(async () => {
+  await Sentry.flush(5000);
+})();

jest.config.ts

@@ -201,6 +201,7 @@ const config: Config.InitialOptions = {
   testEnvironmentOptions: {
     sentryConfig: {
       init: {
+        // jest project under Sentry organization (dev productivity team)
         dsn: 'https://[email protected]/4857230',
         environment: !!CI ? 'ci' : 'local',
         tracesSampleRate: 1.0,