convert a handful of files to TypeScript

Author: AtofStryker

packages/server/lib/cache.ts

@@ -3,7 +3,7 @@ import Promise from 'bluebird'
 import { globalPubSub } from '@packages/data-context'
 import { fs } from './util/fs'
 import appData from './util/app_data'
-import FileUtil from './util/file'
+import { File as FileUtil } from './util/file'
 import type { Cache, CachedUser, Preferences, Cohort } from '@packages/types'
 
 interface Transaction {
@@ -55,6 +55,7 @@ export const cache = {
   },
 
   getProjectRoots (): Promise<string[]> {
+    // @ts-expect-error - transaction is untyped currently
     return fileUtil.transaction((tx: Transaction) => {
       return this._getProjects(tx).then((projects) => {
         const pathsToRemove = Promise.reduce(projects, (memo: string[], path: string) => {
@@ -76,6 +77,7 @@ export const cache = {
   },
 
   removeProject (path: string): Promise<void> {
+    // @ts-expect-error - transaction is untyped currently
     return fileUtil.transaction((tx: Transaction) => {
       return this._getProjects(tx).then((projects) => {
         return this._removeProjects(tx, projects, path)
@@ -84,6 +86,7 @@ export const cache = {
   },
 
   insertProject (path: string): Promise<void> {
+    // @ts-expect-error - transaction is untyped currently
     return fileUtil.transaction((tx: Transaction) => {
       return this._getProjects(tx).then((projects) => {
         // projects are sorted by most recently used, so add a project to
@@ -124,6 +127,7 @@ export const cache = {
   },
 
   insertProjectPreferences (projectTitle: string, projectPreferences: Preferences): Promise<void> {
+    // @ts-expect-error - transaction is untyped currently
     return fileUtil.transaction((tx: Transaction) => {
       return tx.get('PROJECT_PREFERENCES', {}).then((preferences) => {
         return tx.set('PROJECT_PREFERENCES', {
@@ -163,6 +167,7 @@ export const cache = {
   },
 
   insertCohort (cohort: Cohort): Promise<void> {
+    // @ts-expect-error - transaction is untyped currently
     return fileUtil.transaction((tx: Transaction) => {
       return tx.get('COHORTS', {}).then((cohorts) => {
         return tx.set('COHORTS', {

packages/server/lib/cloud/protocol.ts

@@ -8,7 +8,7 @@ import os from 'os'
 import path from 'path'
 import { strictAgent } from '@packages/network'
 import pkg from '@packages/root'
-import env from '../util/env'
+import * as env from '../util/env'
 import { putProtocolArtifact } from './api/put_protocol_artifact'
 import { requireScript } from './require_script'
 import * as routes from './routes'

packages/server/lib/modes/record.ts

@@ -16,7 +16,7 @@ import type { AllCypressErrorNames } from '@packages/errors'
 import { get as getErrors, warning as errorsWarning, throwErr } from '../errors'
 import * as capture from '../capture'
 import { getResolvedRuntimeConfig } from '../config'
-import env from '../util/env'
+import * as env from '../util/env'
 import ciProvider from '../util/ci_provider'
 import { flattenSuiteIntoRunnables } from '../util/tests_utils'
 import { countStudioUsage } from '../util/spec_writer'

packages/server/lib/modes/run.ts

@@ -15,7 +15,7 @@ import { openProject } from '../open_project'
 import * as videoCapture from '../video_capture'
 import { fs, getPath } from '../util/fs'
 import runEvents from '../plugins/run_events'
-import env from '../util/env'
+import * as env from '../util/env'
 import trash from '../util/trash'
 import { id as randomId } from '../util/random'
 import system from '../util/system'

packages/server/lib/saved_state.ts

@@ -4,7 +4,7 @@ import Debug from 'debug'
 import Bluebird from 'bluebird'
 import appData from './util/app_data'
 import { getCwd } from './cwd'
-import FileUtil from './util/file'
+import { File as FileUtil } from './util/file'
 import { fs } from './util/fs'
 import { AllowedState, allowedKeys } from '@packages/types'
 import { globalPubSub } from '@packages/data-context'

packages/server/lib/util/env.js

@@ -0,0 +1,7 @@
+export const set = (key: string, val: string): string | undefined => {
+  return process.env[key] = val
+}
+
+export const get = (key: string): string | undefined => {
+  return process.env[key]
+}

packages/server/lib/util/env.ts

@@ -1,21 +1,24 @@
-const _ = require('lodash')
-const os = require('os')
-const md5 = require('md5')
-const path = require('path')
-const debugVerbose = require('debug')('cypress-verbose:server:util:file')
-const Promise = require('bluebird')
-const lockFile = Promise.promisifyAll(require('lockfile'))
-const { fs } = require('./fs')
-const env = require('./env')
-const exit = require('./exit')
-const { default: pQueue } = require('p-queue')
+import _ from 'lodash'
+import os from 'os'
+import md5 from 'md5'
+import path from 'path'
+import debugModule from 'debug'
+import Promise from 'bluebird'
+import lockFileModule from 'lockfile'
+import { fs } from './fs'
+import * as env from './env'
+import exit from './exit'
+import pQueue from 'p-queue'
+const lockFile = Promise.promisifyAll(lockFileModule)
+
+const debugVerbose = debugModule('cypress-verbose:server:util:file')
 
 const DEBOUNCE_LIMIT = 1000
 const LOCK_TIMEOUT = 2000
 
 function getUid () {
   try {
-    // eslint-disable-next-line no-restricted-properties
+    // @ts-expect-error - process.geteuid is defined
     return process.geteuid()
   } catch (err) {
     // process.geteuid() can fail, return a constant
@@ -24,8 +27,28 @@ function getUid () {
   }
 }
 
-class File {
-  constructor (options = {}) {
+export class File {
+  _lockFileDir!: string
+  _lockFilePath!: string
+  _queue!: pQueue
+  _cache!: Record<string, any>
+  _lastRead!: number
+  path: string
+
+  static noopFile = {
+    get () {
+      return Promise.resolve({})
+    },
+    set () {
+      return Promise.resolve()
+    },
+    transaction () {},
+    remove () {
+      return Promise.resolve()
+    },
+  }
+
+  constructor (options: { path?: string } = {}) {
     if (!options.path) {
       throw new Error('Must specify path to file when creating new FileUtil()')
     }
@@ -70,13 +93,13 @@ class File {
   get (...args) {
     debugVerbose('get values from %s', this.path)
 
-    return this._get(false, ...args)
+    return this._get(false, ...(args as [string, any]))
   }
 
   set (...args) {
     debugVerbose('set values in %s', this.path)
 
-    return this._set(false, ...args)
+    return this._set(false, ...(args as [string, any]))
   }
 
   remove () {
@@ -136,6 +159,7 @@ class File {
     .then(() => {
       debugVerbose('read %s', this.path)
 
+      // @ts-expect-error
       return fs.readJsonAsync(this.path, 'utf8')
     })
     .catch((err) => {
@@ -208,6 +232,7 @@ class File {
     .then(() => {
       debugVerbose('write %s', this.path)
 
+      // @ts-expect-error
       return fs.outputJsonAsync(this.path, this._cache, { spaces: 2 })
     })
     .finally(() => {
@@ -221,6 +246,7 @@ class File {
     debugVerbose('attempt to get lock on %s', this.path)
 
     return fs
+    // @ts-expect-error
     .ensureDirAsync(this._lockFileDir)
     .then(() => {
       // polls every 100ms up to 2000ms to obtain lock, otherwise rejects
@@ -245,18 +271,3 @@ class File {
     })
   }
 }
-
-File.noopFile = {
-  get () {
-    return Promise.resolve({})
-  },
-  set () {
-    return Promise.resolve()
-  },
-  transaction () {},
-  remove () {
-    return Promise.resolve()
-  },
-}
-
-module.exports = File

packages/server/lib/util/file.js renamed to packages/server/lib/util/file.ts

@@ -8,7 +8,7 @@ import pkg from '@packages/root'
 import humanTime from './human_time'
 import duration from './duration'
 import newlines from './newlines'
-import env from './env'
+import * as env from './env'
 import terminal from './terminal'
 import { getIsCi } from './ci_provider'
 import * as experiments from '../experiments'
@@ -704,7 +704,7 @@ export const beginUploadActivityOutput = () => {
   process.stdout.write(chalk.bold.blue('. '))
   const uploadActivityInterval = setInterval(() => {
     process.stdout.write(chalk.bold.blue('. '))
-  }, UPLOAD_ACTIVITY_INTERVAL)
+  }, Number(UPLOAD_ACTIVITY_INTERVAL))
 
   return () => {
     if (uploadActivityInterval) {

packages/server/lib/util/print-run.ts

@@ -1,4 +1,3 @@
-const env = require('./env')
 const debug = require('debug')('cypress:server:plugins')
 
 module.exports = {
@@ -9,7 +8,7 @@ module.exports = {
    * @returns {string|null} path if typescript exists, otherwise null
    */
   typescript: (projectRoot) => {
-    if (env.get('CYPRESS_INTERNAL_NO_TYPESCRIPT') === '1' || !projectRoot) {
+    if (process.env['CYPRESS_INTERNAL_NO_TYPESCRIPT'] === '1' || !projectRoot) {
       return null
     }