[AutoRun] Move all files to TS in a new folder, add npm scripts

Bug: none
Change-Id: Icea4a123a218ecbc2db184d4fed201ab270782fc
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6519933
Reviewed-by: Mathias Bynens <mathias@chromium.org>
Reviewed-by: Alex Rudenko <alexrudenko@chromium.org>
Commit-Queue: Ergün Erdoğmuş <ergunsh@chromium.org>

Author: ergunsh

.gitignore

@@ -26,6 +26,7 @@ config.gypi
 npm-debug.log
 /scripts/protocol_typescript/*.js
 /scripts/ai_assistance/data
+/scripts/ai_assistance/auto-run/data
 /scripts/ai_assistance/performance-trace-downloads
 
 /build

scripts/ai_assistance/README.md

@@ -2,8 +2,7 @@
 
 This directory contains scripts for the prompt iteration & evaluation process for AI Assistance.
 
-Mainly, `auto-run.ts` script takes example URLs, runs the examples and outputs the results to the `data/` directory. Then, the HTML page in `eval/` folder
-takes these results and presents them in a UI for evaluation.
+Mainly, `auto-run/auto-run.ts` script takes example URLs, runs the examples and outputs the results to the `auto-run/data/` directory. Then, the HTML page in `eval/` folder takes these results and presents them in a UI for evaluation.
 
 ## Running
 
@@ -22,16 +21,16 @@ takes these results and presents them in a UI for evaluation.
 
 3. Close the DevTools window for the initial `about:blank` page but keep the tab open.
 
-4. Run the following command. See below for the list of values `--test-target` supports. This flag is used to determine which AI experience is evaluated.
+4. Run the following command from the `scripts/ai_assistance` folder. See below for the list of values `--test-target` supports. This flag is used to determine which AI experience is evaluated.
 ```
-node --no-warnings --experimental-strip-types scripts/ai_assistance/auto-run.ts --test-target elements --example-urls <example-url-1> <example-url-2>
+npm run auto-run -- --test-target elements --example-urls <example-url-1> <example-url-2>
 ```
 
-At the end of these steps, the examples in the urls `<example-url-1>` and `<example-url-2>` should be run and the results must be saved to the `data/` folder.
+At the end of these steps, the examples in the urls `<example-url-1>` and `<example-url-2>` should be run and the results must be saved to the `auto-run/data/` folder.
 
 Tip: You can add a `--label <label>` argument to the run to label the dataset. For example:
 ```
-node --no-warnings --experimental-strip-types scripts/ai_assistance/auto-run.ts --label title-change --example-urls <example-url-1> <example-url-2>
+npm run auto-run -- --label title-change --example-urls <example-url-1> <example-url-2>
 ```
 
 ## `--test-target` values
@@ -49,7 +48,7 @@ compatible with the eval UI.
 ## Evaluating the results
 
 **Steps**
-1. Serve the `scripts/ai_assistance` folder by using a simple file server. For example:
+1. Serve the `scripts/ai_assistance` folder in 8000 port by using a simple file server. For example:
 ```
 python3 -m http.server
 ```

scripts/ai_assistance/auto-run-helpers.js …_assistance/auto-run/auto-run-helpers.tsscripts/ai_assistance/auto-run-helpers.js renamed to scripts/ai_assistance/auto-run/auto-run-helpers.ts scripts/ai_assistance/auto-run-helpers.js renamed to scripts/ai_assistance/auto-run/auto-run-helpers.ts

@@ -24,14 +24,12 @@
  * @param {string} comment The comment string to split.
  * @return {Record<string, string>} An object containing the found keys and their values.
  */
-export function parseComment(comment) {
+export function parseComment(comment: string): Record<string, string> {
   // Tracks which section of the comment we are in so we know where to
   // associate lines with.
-  /** @type {string|null} */
-  let activeKey = null;
+  let activeKey: string|null = null;
 
-  /** @type {Record<string, string[]>} */
-  const lines = {
+  const lines: Record<string, string[]> = {
     // We may get other keys, but these two are required.
     explanation: [],
     prompt: [],
@@ -70,21 +68,15 @@ export function parseComment(comment) {
     }
   }
 
-  /** @type {Record<string, string>} */
-  const result = {};
+  const result: Record<string, string> = {};
   Object.keys(lines).forEach(lineKey => {
     result[lineKey] = lines[lineKey].join('\n');
   });
   return result;
 }
 
-/**
- * @param {Record<string, string>} comment
- * @return {string[]}
- */
-export function parseFollowUps(comment) {
-  /** @type {string[]} */
-  const followUpPrompts = [];
+export function parseFollowUps(comment: Record<string, string>): string[] {
+  const followUpPrompts: string[] = [];
   const FOLLOW_UP_PREFIX = 'followup';
   Object.entries(comment).forEach(([key, value]) => {
     if (key.toLowerCase().startsWith(FOLLOW_UP_PREFIX)) {

scripts/ai_assistance/auto-run.test.js …/ai_assistance/auto-run/auto-run.test.tsscripts/ai_assistance/auto-run.test.js renamed to scripts/ai_assistance/auto-run/auto-run.test.ts scripts/ai_assistance/auto-run.test.js renamed to scripts/ai_assistance/auto-run/auto-run.test.ts

@@ -5,12 +5,11 @@
 /**
  * Tests for parts of the AI Assistance auto-run script.
  * NOTE: these are not run on CQ but exist to help you locally.
- * Run these with `npx mocha scripts/ai_assistance/auto-run.test.js`
+ * Run these with `npm run auto-run:test` from `scripts/ai_assistance` folder.
  */
+import {assert} from 'chai';
 
-const {assert} = require('chai');
-
-const {parseComment, parseFollowUps} = require('./auto-run-helpers.js');
+import {parseComment, parseFollowUps} from './auto-run-helpers.ts';
 
 describe('parsing comments', () => {
   it('parses out the prompt and evaluation sections using the "old" syntax', () => {

scripts/ai_assistance/auto-run.ts …ripts/ai_assistance/auto-run/auto-run.tsscripts/ai_assistance/auto-run.ts renamed to scripts/ai_assistance/auto-run/auto-run.ts scripts/ai_assistance/auto-run.ts renamed to scripts/ai_assistance/auto-run/auto-run.ts

@@ -3,6 +3,8 @@
 // found in the LICENSE file.
 
 import * as fs from 'fs';
+// We don't have types for `js-yaml` in the codebase.
+// @ts-expect-error
 import * as yaml from 'js-yaml';
 import * as url from 'node:url';
 import * as path from 'path';
@@ -11,9 +13,10 @@ import puppeteer from 'puppeteer-core';
 import {hideBin} from 'yargs/helpers';
 import yargs from 'yargs/yargs';
 
-import {parseComment, parseFollowUps} from './auto-run-helpers.js';
 import type {
-  ExampleMetadata, ExecutedExample, IndividualPromptRequestResponse, Logs, PatchTest, RunResult} from './types.js';
+  ExampleMetadata, ExecutedExample, IndividualPromptRequestResponse, Logs, PatchTest, RunResult} from '../types';
+
+import {parseComment, parseFollowUps} from './auto-run-helpers.ts';
 
 // eslint-disable-next-line  @typescript-eslint/naming-convention
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));

scripts/ai_assistance/eval/index.js

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-const FREESTYLER_SERVER_URL = 'http://localhost:8000';
+const DATA_URL = 'http://localhost:8000/auto-run/data';
 const Utils = {
   jsonToAsciiTable(data) {
     const exampleIdEvaluations = {};
@@ -138,7 +138,7 @@ const Utils = {
 const examplesMapCache = {};
 const API = {
   fetchDatasets: async () => {
-    const datasetNamesHtml = await (await fetch(`${FREESTYLER_SERVER_URL}/data`)).text();
+    const datasetNamesHtml = await (await fetch(DATA_URL)).text();
     const parser = new DOMParser();
     const document = parser.parseFromString(datasetNamesHtml, 'text/html');
     const links = document.querySelectorAll('a');
@@ -150,7 +150,7 @@ const API = {
       return examplesMapCache[title];
     }
 
-    const {examples, metadata} = await (await fetch(`${FREESTYLER_SERVER_URL}/data/${title}`)).json();
+    const {examples, metadata} = await (await fetch(`${DATA_URL}/${title}`)).json();
     examples.sort((ex1, ex2) => ex1.exampleId > ex2.exampleId ? 1 : ex1.exampleId < ex2.exampleId ? -1 : 0);
     const examplesMap = {};
     for (const example of examples) {

scripts/ai_assistance/package.json

@@ -1,3 +1,7 @@
 {
-  "type": "module"
-}
+  "type": "module",
+  "scripts": {
+    "auto-run": "node --no-warnings --experimental-strip-types auto-run/auto-run.ts",
+    "auto-run:test": "npx --node-options='--no-warnings --experimental-strip-types' mocha auto-run/auto-run.test.ts"
+  }
+}

scripts/ai_assistance/tsconfig.json

@@ -6,7 +6,9 @@
     "allowJs": true,
     "module": "ESNext",
     "moduleResolution": "Bundler",
-    "target": "ESNext"
+    "target": "ESNext",
+    "noEmit": true,
+    "allowImportingTsExtensions": true,
   },
-  "include": ["./auto-run-helpers.js", "auto-run.ts", "./auto-run.test.js"]
+  "include": ["auto-run/*"]
 }