feat(utils): add load test seed dataset

GoogleChrome · Oct 24, 2019 · 65feb1e · 65feb1e
1 parent fbb2a0d
commit 65feb1e
Show file tree

Hide file tree

Showing 8 changed files with 5,362 additions and 17 deletions.
diff --git a/packages/utils/src/lodash.js b/packages/utils/src/lodash.js
@@ -98,6 +98,15 @@ module.exports = {
       .map(word => `${word.slice(0, 1).toUpperCase()}${word.slice(1)}`)
       .join(' ');
   },
+  /**
+   * @param {string} s
+   * @param {number} length
+   * @param {string} [padding]
+   */
+  padStart(s, length, padding = ' ') {
+    if (s.length >= length) return s;
+    return `${padding.repeat(length)}${s}`.slice(-length);
+  },
   /**
    * Deep clones an object via JSON.parse/JSON.stringify.
    * @template T

diff --git a/packages/utils/src/seed-data/dataset-generator.js b/packages/utils/src/seed-data/dataset-generator.js
@@ -5,6 +5,8 @@
  */
 'use strict';
 
+const fs = require('fs');
+const path = require('path');
 const _ = require('../lodash.js');
 const PRandom = require('./prandom.js');
 const {createLHR} = require('./lhr-generator.js');
@@ -59,7 +61,7 @@ function removeAllItems(auditsToFakeSrc) {
 /**
  * @return {{projects: Array<LHCI.ServerCommand.Project>, builds: Array<LHCI.ServerCommand.Build>, runs: Array<LHCI.ServerCommand.Run>}}
  */
-function createDataset() {
+function createDefaultDataset() {
   const fiftyFiftyImages = [
     {
       inclusionRate: 0.5,
@@ -441,4 +443,90 @@ function createDataset() {
   };
 }
 
-module.exports = {createDataset, createRuns};
+/**
+ * @return {{projects: Array<LHCI.ServerCommand.Project>, builds: Array<LHCI.ServerCommand.Build>, runs: Array<LHCI.ServerCommand.Run>}}
+ */
+function createLoadTestDataset() {
+  const sourceLhr = fs.readFileSync(path.join(__dirname, 'sample-report.json'), 'utf8');
+
+  const project = {id: '0', name: 'Example', externalUrl: 'https://www.example.com', token: ''};
+  /** @type {Array<LHCI.ServerCommand.Build>} */
+  const builds = [];
+  /** @type {Array<LHCI.ServerCommand.Run>} */
+  const runs = [];
+  for (let i = 0; i < 100; i++) {
+    const runAt = new Date(
+      new Date((builds[i - 1] || {runAt: new Date('2019-07-01')}).runAt).getTime() +
+        Math.round(Math.random() * 24 * 60 * 60 * 1000)
+    ).toISOString();
+    const hash = _.padStart(`${i}`, 40, '0');
+    const ancestorHash = i % 3 === 0 ? '' : _.padStart(`${i - (i % 2 === 0 ? 2 : 1)}`, 40, '0');
+    const author =
+      i % 3 === 0
+        ? {
+            author: 'Patrick Hulce <patrick@example.com>',
+            avatarUrl: 'https://avatars1.githubusercontent.com/u/2301202?s=460&v=4',
+          }
+        : {
+            author: 'Paul Irish <paul@example.com>',
+            avatarUrl: 'https://avatars1.githubusercontent.com/u/39191?s=460&v=4',
+          };
+
+    /** @type {LHCI.ServerCommand.Build} */
+    const build = {
+      id: `${i}`,
+      projectId: project.id,
+      lifecycle: 'unsealed',
+      branch: i % 2 === 0 ? 'master' : `dev${i}`,
+      externalBuildUrl: `https://example.com#${i}`,
+      commitMessage: `${i % 2 === 0 ? 'feat' : 'fix'}: ${i}`,
+      hash,
+      ancestorHash,
+      runAt,
+      ...author,
+    };
+
+    const port = 1000 + Math.round(Math.random() * 60000);
+    const urls = [`http://localhost:${port}/index.html`, `http://localhost:${port}/about.html`];
+    for (let j = 0; j < 10; j++) {
+      for (const url of urls) {
+        runs.push({
+          id: '',
+          buildId: build.id,
+          projectId: project.id,
+          representative: false,
+          url: url.replace(/:\d+/, ':PORT'),
+          // @ts-ignore - programmatic creation of LHR supported by seed-data
+          lhr: () => {
+            /** @type {LH.Result} */
+            const lhr = JSON.parse(sourceLhr);
+            lhr.requestedUrl = url;
+            lhr.finalUrl = url;
+            for (const auditId of Object.keys(lhr.audits)) {
+              const multiplier = 1 + Math.random() * 0.4 - 2;
+              const audit = lhr.audits[auditId];
+              if (typeof audit.numericValue === 'number') {
+                audit.numericValue = audit.numericValue * multiplier;
+              }
+              if (typeof audit.score === 'number') {
+                audit.score = audit.score * multiplier;
+              }
+            }
+
+            return JSON.stringify(lhr);
+          },
+        });
+      }
+    }
+
+    builds.push(build);
+  }
+
+  return {
+    projects: [project],
+    builds,
+    runs,
+  };
+}
+
+module.exports = {createDefaultDataset, createLoadTestDataset, createRuns};
diff --git a/packages/utils/src/seed-data/sample-report.json b/packages/utils/src/seed-data/sample-report.json
diff --git a/packages/utils/src/seed-data/seed-data.js b/packages/utils/src/seed-data/seed-data.js
@@ -6,19 +6,25 @@
 'use strict';
 
 const {createLHR} = require('./lhr-generator.js');
-const {createDataset} = require('./dataset-generator.js');
+const {createDefaultDataset} = require('./dataset-generator.js');
 
 /** @typedef {import('../api-client.js')} ApiClient */
 
 /**
  * @param {ApiClient} client
- * @param {{projects: LHCI.ServerCommand.Project[], builds: LHCI.ServerCommand.Build[], runs: LHCI.ServerCommand.Run[]}} [data]
+ * @param {{projects: LHCI.ServerCommand.Project[], builds: LHCI.ServerCommand.Build[], runs: LHCI.ServerCommand.Run[]}} [rawData]
  */
-async function writeSeedDataToApi(client, data) {
-  data = data || createDataset();
+async function writeSeedDataToApi(client, rawData) {
+  let data = rawData || createDefaultDataset();
   data = JSON.parse(JSON.stringify(data));
   if (!data) throw new Error('TS cannot infer truth');
 
+  if (rawData) {
+    data.runs.forEach((run, i) => {
+      run.lhr = rawData.runs[i].lhr;
+    });
+  }
+
   /** @type {Array<LHCI.ServerCommand.Project>} */
   const projects = [];
   for (const project of data.projects) {
@@ -38,12 +44,17 @@ async function writeSeedDataToApi(client, data) {
     delete run.id;
     run.projectId = projects[Number(run.projectId)].id;
     run.buildId = builds[Number(run.buildId)].id;
-    await client.createRun(run);
+    await client.createRun({
+      ...run,
+      lhr:
+        // @ts-ignore - allow programmatic creation of LHR
+        typeof run.lhr === 'function' ? run.lhr() : run.lhr,
+    });
   }
 
   for (const build of builds) {
     await client.sealBuild(build.projectId, build.id);
   }
 }
 
-module.exports = {createLHR, createDataset, writeSeedDataToApi};
+module.exports = {createLHR, createDefaultDataset, writeSeedDataToApi};
diff --git a/scripts/diff-seed-fixture.js b/scripts/diff-seed-fixture.js
@@ -8,13 +8,13 @@
 
 const fs = require('fs');
 const path = require('path');
-const {createDataset} = require('../packages/utils/src/seed-data/seed-data.js');
+const {createDefaultDataset} = require('../packages/utils/src/seed-data/seed-data.js');
 
 const FIXTURE_PATH = path.join(__dirname, '../packages/server/test/fixtures/seed-data.json');
 
 function run() {
   const existingContents = JSON.parse(fs.readFileSync(FIXTURE_PATH, 'utf8'));
-  const newContents = createDataset();
+  const newContents = createDefaultDataset();
 
   newContents.runs.forEach((newRun, i) => {
     const oldRun = existingContents.runs[i];

diff --git a/scripts/open-seed-report-in-viewer.js b/scripts/open-seed-report-in-viewer.js
@@ -8,10 +8,10 @@
 
 const fs = require('fs');
 const puppeteer = require('puppeteer');
-const {createDataset} = require('../packages/utils/src/seed-data/seed-data.js');
+const {createDefaultDataset} = require('../packages/utils/src/seed-data/seed-data.js');
 
 async function run() {
-  const lhr = JSON.stringify(JSON.parse(createDataset().runs[0].lhr), null, 2);
+  const lhr = JSON.stringify(JSON.parse(createDefaultDataset().runs[0].lhr), null, 2);
   const browser = await puppeteer.launch({headless: false, devtools: true});
   const page = await browser.newPage();
   await page.goto('https://googlechrome.github.io/lighthouse/viewer/');

diff --git a/scripts/seed-database.js b/scripts/seed-database.js
@@ -9,9 +9,13 @@
 const {loadAndParseRcFile} = require('../packages/utils/src/lighthouserc.js');
 const ApiClient = require('../packages/utils/src/api-client.js');
 const {writeSeedDataToApi} = require('../packages/utils/src/seed-data/seed-data.js');
+const {
+  createDefaultDataset,
+  createLoadTestDataset,
+} = require('../packages/utils/src/seed-data/dataset-generator.js');
 
-if (process.argv.length !== 3) {
-  process.stderr.write(`Usage ./scripts/seed-database.js <path to rc file>`);
+if (process.argv.length !== 3 && process.argv.length !== 4) {
+  process.stderr.write(`Usage ./scripts/seed-database.js <path to rc file> [--load]`);
   process.exit(1);
 }
 
@@ -20,7 +24,10 @@ async function run() {
   if (!serverBaseUrl) throw new Error('RC file did not set the serverBaseUrl');
 
   const api = new ApiClient({rootURL: serverBaseUrl});
-  await writeSeedDataToApi(api);
+  await writeSeedDataToApi(
+    api,
+    process.argv.includes('--load') ? createLoadTestDataset() : createDefaultDataset()
+  );
 }
 
 run();
diff --git a/scripts/update-seed-fixtures.js b/scripts/update-seed-fixtures.js
@@ -8,12 +8,12 @@
 
 const fs = require('fs');
 const path = require('path');
-const {createDataset} = require('../packages/utils/src/seed-data/seed-data.js');
+const {createDefaultDataset} = require('../packages/utils/src/seed-data/seed-data.js');
 
 const FIXTURE_PATH = path.join(__dirname, '../packages/server/test/fixtures/seed-data.json');
 
 function run() {
-  fs.writeFileSync(FIXTURE_PATH, JSON.stringify(createDataset(), null, 2));
+  fs.writeFileSync(FIXTURE_PATH, JSON.stringify(createDefaultDataset(), null, 2));
 }
 
 run();