chore: convert additional server files to TypeScript #32950

AtofStryker · 2025-11-13T21:28:59Z

Closes

Additional details

Converts files, fixtures, resolve, status_code, system, and a few other files to TypeScript

Steps to test

How has the user experience changed?

PR Tasks

Have tests been added/updated?
Has a PR for user-facing changes been opened in cypress-documentation?
Have API changes been updated in the type definitions?

Note

Migrates key server modules (files, fixture, terminal, tty, resolve, status_code, system) and related tests to TypeScript, updates call sites/imports and typings, and adds safe error serialization.

Server/Utilities:
- Convert util/{terminal.ts, tty.ts, resolve.ts, status_code.ts, system.ts} to TypeScript; adjust consumers to import * as ... where needed.
- Add fs.readJsonAsync to util/fs.ts; remove legacy TS ignores in util/file.ts.
- Update server-base.ts, project-base.ts, modes/run.ts to use typed utilities and minor typing tweaks.
Fixtures/Files:
- Replace lib/files.js and lib/fixture.js with lib/files.ts and lib/fixture.ts; update usages in socket-base.ts, controllers/xhrs.ts, and privileged-commands-manager.ts (get as fixtureGet, * as files).
- Implement queueing/encoding logic in TS and preserve existing behavior; minor Bluebird delays and type guards.
Cloud:
- cloud/exception.ts: switch to * as system import and add safeErrorSerialize() for robust error stringification.
CLI Startup:
- start-cypress.js: import override from util/tty and call directly.
Printing/Output:
- util/print-run.ts: type fixes (e.g., HorizontalAlignment) and table alignment updates.
Tests:
- Migrate unit tests to TS where applicable (files_spec.ts, fixture_spec.ts, status_code_spec.ts, util/terminal_spec.ts, util/tty_spec.ts) and update snapshots.
- Child process test sets NODE_OPTIONS='--import tsx' for TS config loading.

^{Written by Cursor Bugbot for commit 7db621a. This will update automatically on new commits. Configure here.}

packages/server/lib/files.ts

cypress · 2025-11-13T22:40:48Z

cypress Run #67420

Run Properties: Errored #67420 • 7db621a15d: empty commit

Project	`cypress`
Branch Review	`chore/server-files-p3`
Run status	`Errored #67420`
Run duration	`18m 23s`
Commit	`7db621a15d: empty commit`
Committer	`Bill Glesias`
View all properties for this run ↗︎

Test results
Failures	`1`
Flaky	`1`
Pending	`72`
Skipped	`0`
Passing	`5641`
View all changes introduced in this branch ↗︎

Warning

Partial Report: The results for the Application Quality reports may be incomplete.

Warning

No Report: Something went wrong and we could not generate a report for the Application Quality products.

cursor

Bug: Silent Encoding Failure in `readJson` Calls

The fs.readJsonAsync call passes 'utf8' as a second parameter, but fs-extra's readJson/readJsonSync methods only accept an options object as the second parameter, not an encoding string. This will cause the encoding to be ignored or potentially throw an error. The original code had a @ts-expect-error comment acknowledging this type mismatch, which was removed during the TypeScript conversion without fixing the underlying issue.

packages/server/lib/util/file.ts#L161-L162

cypress/packages/server/lib/util/file.ts

Lines 161 to 162 in 32aa387


	return fs.readJsonAsync(this.path, 'utf8')

packages/server/lib/files.ts

cursor

Bug: `readJsonAsync` Parameter Type Mismatch

The fs.readJsonAsync call passes 'utf8' as a second parameter, but fs-extra's readJson method expects an options object, not a direct encoding string. When promisified by Bluebird, readJsonAsync should be called as fs.readJsonAsync(this.path, { encoding: 'utf8' }) or simply fs.readJsonAsync(this.path) since utf8 is the default encoding. This will cause the method to fail or behave unexpectedly.

packages/server/lib/util/file.ts#L161-L162

cypress/packages/server/lib/util/file.ts

Lines 161 to 162 in 03ffbf0


	return fs.readJsonAsync(this.path, 'utf8')

packages/server/lib/files.ts

packages/server/test/unit/plugins/child/run_child_fixture.js

AtofStryker · 2025-11-18T15:50:14Z

packages/server/test/unit/fixture_spec.ts


+    // needed to run these tests locally
+    // sinon.stub(ctx.browser, 'machineBrowsers').resolves([
+    //   {


eventually when we convert these tests to vitest we need to address this problem, as the tests don't run locally without this stub but run fine in CI because electron is installed

convert fixture file to TS fix types remove only

packages/server/test/unit/plugins/child/run_child_fixture.js

jennifer-shehane

A few comments, fine to merge

jennifer-shehane · 2025-11-19T14:35:43Z

packages/server/lib/controllers/xhrs.ts

+    // @ts-expect-error
+    return fixtureGet(config.fixturesFolder, filePath, options)


Can you add a contextual comment for this expect-error?

jennifer-shehane · 2025-11-19T14:41:42Z

packages/server/lib/util/terminal.ts

+    // @ts-expect-error
+    const colors = <string[]>[].concat(options.color)


can you add context to this comment?

jennifer-shehane · 2025-11-19T14:48:30Z

packages/server/lib/files.ts

+export async function readFiles (projectRoot: string, options: { files: { path: string, encoding?: BufferEncoding }[] } = { files: [] }) {
+  const files = await Promise.all(options.files.map(async (file) => {
+    const { contents, filePath } = await readFile(projectRoot, {
+      file: file.path,
+      encoding: file.encoding,
+    })
+
+    return {
+      ...file,
+      filePath,
+      contents,
+    }
+  }))
+
+  return files
+}


I know this is a direct translation, but just wondering if this should have a try/catch here.

jennifer-shehane · 2025-11-19T14:52:34Z

packages/server/lib/fixture.ts

+    // @ts-expect-error
+    err.code = 'ENOENT'


comment on this expect-error?

jennifer-shehane · 2025-11-19T14:53:11Z

packages/server/lib/fixture.ts

+
+export async function parseFile (p: string, fixture: string, options: { encoding?: (ObjectEncodingOptions & { flag?: string | undefined }) | BufferEncoding | null } = {}) {
+  if (queue[p]) {
+    await Bluebird.delay(1)


Why Bluebird here exactly?

jennifer-shehane · 2025-11-19T14:55:18Z

packages/server/lib/fixture.ts

+  const dc = process.env.NODE_DISABLE_COLORS
+
+  process.env.NODE_DISABLE_COLORS = '0'


Love the zero context on why this is necessary 😆

jennifer-shehane · 2025-11-19T14:56:24Z

packages/server/lib/fixture.ts

+export async function parseHtml (p: string, fixture: string) {
+  try {
+    const content = await fs.readFileAsync(p, 'utf8')
+
+    return content
+  } catch (err) {
+    throw new Error(`Unable to parse '${fixture}'.\n${err.toString()}`)
+  }
+}
+
+export async function parse (p: string, fixture: string, encoding: (ObjectEncodingOptions & { flag?: string | undefined }) | BufferEncoding | null | undefined) {
+  try {
+    const content = await fs.readFileAsync(p, encoding)
+
+    return content
+  } catch (err) {
+    throw new Error(`Unable to parse '${fixture}'.\n${err.toString()}`)
+  }
+}


Seems these can be consolidated, but maybe another time.

AtofStryker self-assigned this Nov 13, 2025

cursor bot reviewed Nov 13, 2025

View reviewed changes

packages/server/lib/files.ts Show resolved Hide resolved

AtofStryker force-pushed the chore/server-files-p3 branch 2 times, most recently from 0d1dd13 to f262fa7 Compare November 14, 2025 15:12

cursor bot reviewed Nov 14, 2025

View reviewed changes

AtofStryker force-pushed the chore/server-files-p3 branch from 32aa387 to 1fea56c Compare November 14, 2025 16:57

cursor bot reviewed Nov 14, 2025

View reviewed changes

packages/server/lib/files.ts Outdated Show resolved Hide resolved

packages/server/lib/files.ts Outdated Show resolved Hide resolved

AtofStryker force-pushed the chore/server-files-p3 branch from 0d5411e to 1fd4bad Compare November 14, 2025 18:56

cursor bot reviewed Nov 14, 2025

View reviewed changes

packages/server/lib/files.ts Outdated Show resolved Hide resolved

AtofStryker commented Nov 14, 2025

View reviewed changes

packages/server/test/unit/plugins/child/run_child_fixture.js Outdated Show resolved Hide resolved

AtofStryker changed the title ~~chore: convert server files p3~~ chore: convert additional server files to TypeScript Nov 18, 2025

AtofStryker commented Nov 18, 2025

View reviewed changes

AtofStryker force-pushed the chore/server-files-p3 branch from 03ffbf0 to 0989d19 Compare November 18, 2025 16:02

AtofStryker added 8 commits November 18, 2025 11:03

chore: convert server files p3

1a3cead

convert fixture file to TS fix types remove only

does deleting this break anything? looks unused

03aee40

chore: convert tty to TS

79f55f2

convert terminal util to TS

d9db155

convert status code to TS

ddb24a9

chore: convert system util to TS

7598e41

convert resolve to ts (tsx works inside child process)

be44496

empty commit

7db621a

AtofStryker force-pushed the chore/server-files-p3 branch from 0989d19 to 7db621a Compare November 18, 2025 16:03

cursor bot reviewed Nov 18, 2025

View reviewed changes

packages/server/test/unit/plugins/child/run_child_fixture.js Show resolved Hide resolved

jennifer-shehane self-requested a review November 19, 2025 14:34

jennifer-shehane approved these changes Nov 19, 2025

View reviewed changes

		// @ts-expect-error
		return fixtureGet(config.fixturesFolder, filePath, options)

		// @ts-expect-error
		const colors = <string[]>[].concat(options.color)

		const dc = process.env.NODE_DISABLE_COLORS

		process.env.NODE_DISABLE_COLORS = '0'

chore: convert additional server files to TypeScript #32950

Are you sure you want to change the base?

chore: convert additional server files to TypeScript #32950

Conversation

AtofStryker commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Additional details

Steps to test

How has the user experience changed?

PR Tasks

Uh oh!

Uh oh!

cypress bot commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Silent Encoding Failure in `readJson` Calls

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: `readJsonAsync` Parameter Type Mismatch

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jennifer-shehane left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AtofStryker commented Nov 13, 2025 •

edited

Loading

cypress bot commented Nov 13, 2025 •

edited

Loading