@vercel/devlow-bench 0.3.1 → 0.3.3

package/dist/browser.js

@@ -170,6 +170,9 @@ function networkIdle(page, delayMs = 300, timeoutMs = 180000) {
     });
 }
 class BrowserSessionImpl {
+    browser;
+    context;
+    page;
     constructor(browser, context) {
         this.browser = browser;
         this.context = context;

package/dist/cli.js

@@ -12,6 +12,7 @@ import { pathToFileURL } from "url";
         "j",
         "console",
         "datadog",
+        "snowflake",
         "interactive",
         "i",
         "help",
@@ -39,6 +40,8 @@ import { pathToFileURL } from "url";
         console.log("  --console                          Print the results to the console");
         console.log("  --datadog[=<hostname>]             Upload the results to Datadog");
         console.log("                                     (requires DATADOG_API_KEY environment variables)");
+        console.log("  --snowflake[=<batch-uri>]          Upload the results to Snowflake");
+        console.log("                                     (requires SNOWFLAKE_TOPIC_NAME and SNOWFLAKE_SCHEMA_ID and environment variables)");
         console.log("## Help");
         console.log("  --help, -h, -?                     Show this help");
     }
@@ -79,10 +82,13 @@ import { pathToFileURL } from "url";
         args.json && (await import("./interfaces/json.js")).default(args.json),
         args.datadog &&
             (await import("./interfaces/datadog.js")).default(typeof args.datadog === "string" ? { host: args.datadog } : undefined),
+        args.snowflake &&
+            (await import("./interfaces/snowflake.js")).default(typeof args.snowflake === "string" ? { gatewayUri: args.snowflake } : undefined),
         args.console !== false &&
             (await import("./interfaces/console.js")).default(),
     ].filter((x) => x);
     await runScenarios(scenarios, compose(...ifaces));
 })().catch((e) => {
     console.error(e.stack);
+    process.exit(1);
 });

package/dist/file.js

@@ -1,8 +1,8 @@
-import { watch } from "fs";
-import { access, constants } from "fs/promises";
-import { dirname } from "path";
+import { watch } from 'fs';
+import { access, constants } from 'fs/promises';
+import { dirname } from 'path';
 export async function waitForFile(path, timeout) {
-    let currentAction = "";
+    let currentAction = '';
     let timeoutRef;
     const timeoutPromise = new Promise((resolve, reject) => {
         timeoutRef = setTimeout(() => {
@@ -37,6 +37,7 @@ export async function waitForFile(path, timeout) {
                 try {
                     do {
                         await Promise.race([timeoutPromise, checkAgainPromise]);
+                        // eslint-disable-next-line no-loop-func
                         checkAgainPromise = new Promise((resolve) => {
                             resolveCheckAgain = resolve;
                         });

package/dist/interfaces/console.js

@@ -1,16 +1,17 @@
-import chalk from "chalk";
+import picocolors from "picocolors";
 import { formatUnit } from "../units.js";
 import { formatVariant } from "../utils.js";
+const { bgCyan, bold, magenta, red, underline } = picocolors;
 export default function createInterface() {
     const iface = {
         start: async (scenario, props) => {
-            console.log(chalk.bold.underline(`Running ${formatVariant(scenario, props)}...`));
+            console.log(bold(underline(`Running ${formatVariant(scenario, props)}...`)));
         },
         measurement: async (scenario, props, name, value, unit, relativeTo) => {
-            console.log(chalk.bgCyan.bold.magenta(`${formatVariant(scenario, props)}: ${name} = ${formatUnit(value, unit)}${relativeTo ? ` (from ${relativeTo})` : ""}`));
+            console.log(bgCyan(bold(magenta(`${formatVariant(scenario, props)}: ${name} = ${formatUnit(value, unit)}${relativeTo ? ` (from ${relativeTo})` : ""}`))));
         },
         error: async (scenario, props, error) => {
-            console.log(chalk.bold.red(`${formatVariant(scenario, props)}: ${(error && error.stack) || error}`));
+            console.log(bold(red(`${formatVariant(scenario, props)}: ${(error && error.stack) || error}`)));
         },
     };
     return iface;

package/dist/interfaces/constants.d.ts

@@ -0,0 +1,11 @@
+export declare const UNIT_MAPPING: Record<string, string>;
+export declare const GIT_SHA: string;
+export declare const GIT_BRANCH: string;
+export declare const IS_CI: boolean;
+export declare const OS: NodeJS.Platform;
+export declare const OS_RELEASE: string;
+export declare const NUM_CPUS: number;
+export declare const CPU_MODEL: string;
+export declare const USERNAME: string;
+export declare const CPU_ARCH: string;
+export declare const NODE_VERSION: string;

package/dist/interfaces/constants.js

@@ -0,0 +1,27 @@
+import os from "node:os";
+import { command } from "../shell.js";
+export const UNIT_MAPPING = {
+    ms: "millisecond",
+    requests: "request",
+    bytes: "byte",
+};
+export const GIT_SHA = process.env.GITHUB_SHA ??
+    (await (async () => {
+        const cmd = command("git", ["rev-parse", "HEAD"]);
+        await cmd.ok();
+        return cmd.output.trim();
+    })());
+export const GIT_BRANCH = process.env.GITHUB_REF_NAME ??
+    (await (async () => {
+        const cmd = command("git", ["rev-parse", "--abbrev-ref", "HEAD"]);
+        await cmd.ok();
+        return cmd.output.trim();
+    })());
+export const IS_CI = Boolean(process.env.CI);
+export const OS = process.platform;
+export const OS_RELEASE = os.release();
+export const NUM_CPUS = os.cpus().length;
+export const CPU_MODEL = os.cpus()[0].model;
+export const USERNAME = os.userInfo().username;
+export const CPU_ARCH = os.arch();
+export const NODE_VERSION = process.version;

package/dist/interfaces/datadog.js

@@ -1,5 +1,6 @@
 import datadogApiClient from "@datadog/datadog-api-client";
 import os from "os";
+import { CPU_ARCH, CPU_MODEL, GIT_BRANCH, GIT_SHA, IS_CI, NODE_VERSION, NUM_CPUS, OS, OS_RELEASE, USERNAME } from "./constants.js";
 function toIdentifier(str) {
     return str.replace(/\//g, ".").replace(/ /g, "_");
 }
@@ -12,15 +13,17 @@ export default function createInterface({ apiKey = process.env.DATADOG_API_KEY,
     if (!apiKey)
         throw new Error("Datadog API key is required (set DATADOG_API_KEY)");
     const commonTags = [
-        `ci:${!!process.env.CI || "false"}`,
-        `os:${process.platform}`,
-        `os_release:${os.release()}`,
-        `cpus:${os.cpus().length}`,
-        `cpu_model:${os.cpus()[0].model}`,
-        `user:${os.userInfo().username}`,
-        `arch:${os.arch()}`,
+        `ci:${IS_CI}`,
+        `os:${OS}`,
+        `os_release:${OS_RELEASE}`,
+        `cpus:${NUM_CPUS}`,
+        `cpu_model:${CPU_MODEL}`,
+        `user:${USERNAME}`,
+        `arch:${CPU_ARCH}`,
         `total_memory:${Math.round(os.totalmem() / 1024 / 1024 / 1024)}`,
-        `node_version:${process.version}`,
+        `node_version:${NODE_VERSION}`,
+        `git_sha:${GIT_SHA}`,
+        `git_branch:${GIT_BRANCH}`,
     ];
     const configuration = datadogApiClient.client.createConfiguration({
         authMethods: {

package/dist/interfaces/snowflake-test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/snowflake-test.js

@@ -0,0 +1,42 @@
+import assert from "assert";
+import createInterface from "./snowflake.js";
+import { mock, test } from "node:test";
+test('sending measurements to the batch endpoint', async () => {
+    const requests = [];
+    const fetchMock = mock.method(global, 'fetch', (req, options) => {
+        requests.push([req, options]);
+        return Promise.resolve(Response.json({}));
+    });
+    const iface = createInterface({
+        gatewayUri: 'http://127.0.0.1/v1/batch',
+        topicName: 'my-topic',
+        schemaId: 123,
+    });
+    assert(iface.measurement != null);
+    await iface.measurement('scenario', { myprop: 'foo' }, 'one', 42, 'ms');
+    await iface.measurement('scenario', { myprop: 'foo' }, 'two', 45, 'ms');
+    await iface.measurement('scenario', { myprop: 'foo' }, 'three', 38, 'ms');
+    assert(iface.end != null);
+    await iface.end('scenario', { myprop: 'foo' });
+    assert.equal(requests.length, 1);
+    const [url, options] = requests[0];
+    assert.equal(url, 'http://127.0.0.1/v1/batch');
+    assert(typeof options.body === 'string');
+    const body = JSON.parse(options.body);
+    assert.equal(body.schema_id, 123);
+    assert.equal(body.topic, 'my-topic');
+    assert(body.records.length === 3);
+    assert.equal(body.records[0].metric, 'one');
+    assert.equal(body.records[0].value, 42);
+    assert.equal(body.records[0].props_json, '{"myprop":"foo"}');
+    assert.equal(body.records[0].unit, 'ms');
+    assert.equal(body.records[1].metric, 'two');
+    assert.equal(body.records[1].value, 45);
+    assert.equal(body.records[1].props_json, '{"myprop":"foo"}');
+    assert.equal(body.records[1].unit, 'ms');
+    assert.equal(body.records[2].metric, 'three');
+    assert.equal(body.records[2].value, 38);
+    assert.equal(body.records[2].props_json, '{"myprop":"foo"}');
+    assert.equal(body.records[2].unit, 'ms');
+    fetchMock.mock.restore();
+});

package/dist/interfaces/snowflake.d.ts

@@ -0,0 +1,9 @@
+import type { Interface } from "../index.js";
+export default function createInterface({ gatewayUri, topicName, schemaId, }?: {
+    gatewayUri?: string;
+    topicName?: string;
+    schemaId?: number;
+}): Interface;
+export declare function omit<T extends {
+    [key: string]: unknown;
+}, K extends keyof T>(object: T, keys: K[]): Omit<T, K>;

package/dist/interfaces/snowflake.js

@@ -0,0 +1,78 @@
+import os from "os";
+import { CPU_ARCH, CPU_MODEL, GIT_BRANCH, GIT_SHA, IS_CI, NODE_VERSION, NUM_CPUS, OS, OS_RELEASE, USERNAME } from "./constants.js";
+import { randomUUID } from "crypto";
+export default function createInterface({ gatewayUri = process.env.SNOWFLAKE_BATCH_URI, topicName = process.env.SNOWFLAKE_TOPIC_NAME, schemaId = process.env.SNOWFLAKE_SCHEMA_ID ? parseInt(process.env.SNOWFLAKE_SCHEMA_ID, 10) : undefined, } = {}) {
+    if (!gatewayUri)
+        throw new Error("Snowflake gateway URI is required (set SNOWFLAKE_GATEWAY_URI)");
+    if (!topicName)
+        throw new Error("Snowflake topic name is required (set SNOWFLAKE_TOPIC_NAME)");
+    if (!schemaId)
+        throw new Error("Snowflake schema ID is required (set SNOWFLAKE_SCHEMA_ID to a valid integer)");
+    const records = [];
+    const iface = {
+        measurement: async (scenario, props, name, value, unit, relativeTo) => {
+            const ts = Math.round(Date.now() / 1000);
+            records.push({
+                event_time: ts,
+                scenario,
+                props,
+                metric: name,
+                value,
+                unit,
+                relative_to: relativeTo,
+                is_ci: IS_CI,
+                os: OS,
+                os_release: OS_RELEASE,
+                cpus: NUM_CPUS,
+                cpu_model: CPU_MODEL,
+                user: USERNAME,
+                arch: CPU_ARCH,
+                total_memory_bytes: os.totalmem(),
+                node_version: NODE_VERSION,
+                git_sha: GIT_SHA,
+                git_branch: GIT_BRANCH,
+            });
+        },
+        end: async (scenario, props) => {
+            await trackAnalytics(gatewayUri, topicName, schemaId, records);
+        },
+    };
+    return iface;
+}
+async function trackAnalytics(batchUri, topic, schemaId, records) {
+    try {
+        const res = await fetch(batchUri, {
+            method: "POST",
+            headers: {
+                "Client-Id": "nextjs",
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify({
+                schema_id: schemaId,
+                topic,
+                records: records.map((record) => omit({
+                    ...record,
+                    id: randomUUID(),
+                    props_json: JSON.stringify(record.props),
+                }, ["props"])),
+            }),
+        });
+        if (!res.ok) {
+            throw new Error(`Unexpected HTTP response from reporting ${topic} event to Snowflake: ${res.status}. Body: ${await res.text()}`);
+        }
+    }
+    catch (e) {
+        const wrappedError = new Error("Unexpected error tracking analytics event");
+        wrappedError.cause = e;
+        console.error(wrappedError);
+    }
+}
+export function omit(object, keys) {
+    const omitted = {};
+    Object.keys(object).forEach((key) => {
+        if (!keys.includes(key)) {
+            omitted[key] = object[key];
+        }
+    });
+    return omitted;
+}

package/dist/shell.js

@@ -5,12 +5,14 @@ import pidusage from "pidusage-tree";
 import { reportMeasurement } from "./describe.js";
 const shellOutput = !!process.env.SHELL_OUTPUT;
 class CommandImpl {
+    process;
+    stdout = "";
+    stderr = "";
+    output = "";
+    exitPromise;
+    waitingForOutput = [];
     constructor(process) {
         this.process = process;
-        this.stdout = "";
-        this.stderr = "";
-        this.output = "";
-        this.waitingForOutput = [];
         process.stdout?.pipe(split2()).on("data", (data) => {
             const str = data.toString();
             this.stdout += str + "\n";

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@vercel/devlow-bench",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Benchmarking tool for the developer workflow",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vercel/next.js",
+    "directory": "turbopack/packages/devlow-bench"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -29,13 +34,13 @@
     "@types/minimist": "^1.2.2",
     "@types/node": "^20.3.0",
     "@types/split2": "^4.2.0",
-    "@turbo/eslint-config": "0.0.0"
+    "tsx": "4.19.2"
   },
   "dependencies": {
     "@datadog/datadog-api-client": "^1.13.0",
-    "chalk": "2.4.2",
     "inquirer": "^9.2.7",
     "minimist": "^1.2.8",
+    "picocolors": "1.0.1",
     "pidusage-tree": "^2.0.5",
     "playwright-chromium": "^1.39.0",
     "split2": "^4.2.0",
@@ -43,7 +48,8 @@
   },
   "scripts": {
     "lint": "eslint src/",
-    "prerelease": "pnpm run build:ts",
-    "build:ts": "tsc"
+    "prerelease": "pnpm run build",
+    "test": "node --import tsx --test src/**/*-test.ts",
+    "build": "tsc"
   }
 }

package/LICENSE

@@ -1,7 +0,0 @@
-Copyright (c) 2024 Vercel, Inc
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.