Switch to TS syntax (#3090)

Author: IvanGoncharov

src/__testUtils__/__tests__/genFuzzStrings-test.ts

@@ -4,8 +4,8 @@ import { describe, it } from 'mocha';
 import { genFuzzStrings } from '../genFuzzStrings';
 
 function expectFuzzStrings(options: {
-  allowedChars: Array<string>,
-  maxLength: number,
+  allowedChars: Array<string>;
+  maxLength: number;
 }) {
   return expect([...genFuzzStrings(options)]);
 }

src/__testUtils__/dedent.ts

@@ -27,8 +27,8 @@ export function dedentString(string: string): string {
  * str === "{\n  test\n}";
  */
 export function dedent(
-  strings: $ReadOnlyArray<string>,
-  ...values: $ReadOnlyArray<string>
+  strings: ReadonlyArray<string>,
+  ...values: ReadonlyArray<string>
 ): string {
   let str = strings[0];
 

src/__testUtils__/genFuzzStrings.ts

@@ -2,8 +2,8 @@
  * Generator that produces all possible combinations of allowed characters.
  */
 export function* genFuzzStrings(options: {
-  allowedChars: Array<string>,
-  maxLength: number,
+  allowedChars: Array<string>;
+  maxLength: number;
 }): Generator<string, void, void> {
   const { allowedChars, maxLength } = options;
   const numAllowedChars = allowedChars.length;

src/__testUtils__/inspectStr.ts

@@ -1,7 +1,9 @@
+import type { Maybe } from '../jsutils/Maybe';
+
 /**
  * Special inspect function to produce readable string literal for error messages in tests
  */
-export function inspectStr(str: ?string): string {
+export function inspectStr(str: Maybe<string>): string {
   if (str == null) {
     return 'null';
   }

src/__tests__/starWarsData.ts

@@ -2,31 +2,30 @@
  * These are types which correspond to the schema.
  * They represent the shape of the data visited during field resolution.
  */
-export type Character = {
-  id: string,
-  name: string,
-  friends: Array<string>,
-  appearsIn: Array<number>,
-  ...
-};
+export interface Character {
+  id: string;
+  name: string;
+  friends: Array<string>;
+  appearsIn: Array<number>;
+}
 
-export type Human = {
-  type: 'Human',
-  id: string,
-  name: string,
-  friends: Array<string>,
-  appearsIn: Array<number>,
-  homePlanet?: string,
-};
+export interface Human {
+  type: 'Human';
+  id: string;
+  name: string;
+  friends: Array<string>;
+  appearsIn: Array<number>;
+  homePlanet?: string;
+}
 
-export type Droid = {
-  type: 'Droid',
-  id: string,
-  name: string,
-  friends: Array<string>,
-  appearsIn: Array<number>,
-  primaryFunction: string,
-};
+export interface Droid {
+  type: 'Droid';
+  id: string;
+  name: string;
+  friends: Array<string>;
+  appearsIn: Array<number>;
+  primaryFunction: string;
+}
 
 /**
  * This defines a basic set of data for our Star Wars Schema.

src/error/GraphQLError.ts

@@ -2,6 +2,7 @@
 // flowlint uninitialized-instance-property:off
 
 import { isObjectLike } from '../jsutils/isObjectLike';
+import type { Maybe } from '../jsutils/Maybe';
 
 import type { ASTNode } from '../language/ast';
 import type { Source } from '../language/source';
@@ -35,53 +36,53 @@ export class GraphQLError extends Error {
    *
    * Enumerable, and appears in the result of JSON.stringify().
    */
-  +locations: $ReadOnlyArray<SourceLocation> | void;
+  readonly locations?: ReadonlyArray<SourceLocation>;
 
   /**
    * An array describing the JSON-path into the execution response which
    * corresponds to this error. Only included for errors during execution.
    *
    * Enumerable, and appears in the result of JSON.stringify().
    */
-  +path: $ReadOnlyArray<string | number> | void;
+  readonly path?: ReadonlyArray<string | number>;
 
   /**
    * An array of GraphQL AST Nodes corresponding to this error.
    */
-  +nodes: $ReadOnlyArray<ASTNode> | void;
+  readonly nodes?: ReadonlyArray<ASTNode>;
 
   /**
    * The source GraphQL document for the first location of this error.
    *
    * Note that if this Error represents more than one node, the source may not
    * represent nodes after the first node.
    */
-  +source: Source | void;
+  readonly source?: Source;
 
   /**
    * An array of character offsets within the source GraphQL document
    * which correspond to this error.
    */
-  +positions: $ReadOnlyArray<number> | void;
+  readonly positions?: ReadonlyArray<number>;
 
   /**
    * The original error thrown from a field resolver during execution.
    */
-  +originalError: ?Error;
+  readonly originalError: Maybe<Error>;
 
   /**
    * Extension fields to add to the formatted error.
    */
-  +extensions: { [key: string]: mixed, ... } | void;
+  readonly extensions?: { [key: string]: unknown };
 
   constructor(
     message: string,
-    nodes?: $ReadOnlyArray<ASTNode> | ASTNode | void | null,
-    source?: ?Source,
-    positions?: ?$ReadOnlyArray<number>,
-    path?: ?$ReadOnlyArray<string | number>,
-    originalError?: ?(Error & { +extensions?: mixed, ... }),
-    extensions?: ?{ [key: string]: mixed, ... },
+    nodes?: ReadonlyArray<ASTNode> | ASTNode | null,
+    source?: Maybe<Source>,
+    positions?: Maybe<ReadonlyArray<number>>,
+    path?: Maybe<ReadonlyArray<string | number>>,
+    originalError?: Maybe<Error & { readonly extensions?: unknown }>,
+    extensions?: Maybe<{ [key: string]: unknown }>,
   ) {
     super(message);
 
@@ -100,8 +101,10 @@ export class GraphQLError extends Error {
       _source = _nodes[0].loc?.source;
     }
 
-    let _positions = positions;
-    if (!_positions && _nodes) {
+    let _positions;
+    if (positions) {
+      _positions = positions;
+    } else if (_nodes) {
       _positions = [];
       for (const node of _nodes) {
         if (node.loc) {
@@ -133,7 +136,6 @@ export class GraphQLError extends Error {
       }
     }
 
-    // $FlowFixMe[cannot-write] FIXME
     Object.defineProperties(this, {
       name: { value: 'GraphQLError' },
       message: {
@@ -212,7 +214,6 @@ export class GraphQLError extends Error {
   }
 
   // FIXME: workaround to not break chai comparisons, should be remove in v16
-  // $FlowFixMe[unsupported-syntax] Flow doesn't support computed properties yet
   get [Symbol.toStringTag](): string {
     return 'Object';
   }

src/error/__tests__/formatError-test.ts

@@ -6,7 +6,7 @@ import { GraphQLError } from '../GraphQLError';
 
 describe('formatError: default error formatter', () => {
   it('uses default message', () => {
-    // $FlowExpectedError[incompatible-call]
+    // @ts-expect-error
     const e = new GraphQLError();
 
     expect(formatError(e)).to.deep.equal({
@@ -45,12 +45,12 @@ describe('formatError: default error formatter', () => {
   });
 
   it('rejects null and undefined errors', () => {
-    // $FlowExpectedError[incompatible-call]
+    // @ts-expect-error
     expect(() => formatError(undefined)).to.throw(
       'Received null or undefined error.',
     );
 
-    // $FlowExpectedError[incompatible-call]
+    // @ts-expect-error
     expect(() => formatError(null)).to.throw(
       'Received null or undefined error.',
     );

src/error/__tests__/locatedError-test.ts

@@ -18,15 +18,15 @@ describe('locatedError', () => {
 
   it('passes GraphQLError-ish through', () => {
     const e = new Error();
-    // $FlowExpectedError[prop-missing]
+    // @ts-expect-error
     e.locations = [];
-    // $FlowExpectedError[prop-missing]
+    // @ts-expect-error
     e.path = [];
-    // $FlowExpectedError[prop-missing]
+    // @ts-expect-error
     e.nodes = [];
-    // $FlowExpectedError[prop-missing]
+    // @ts-expect-error
     e.source = null;
-    // $FlowExpectedError[prop-missing]
+    // @ts-expect-error
     e.positions = [];
     e.name = 'GraphQLError';
 
@@ -35,7 +35,7 @@ describe('locatedError', () => {
 
   it('does not pass through elasticsearch-like errors', () => {
     const e = new Error('I am from elasticsearch');
-    // $FlowExpectedError[prop-missing]
+    // @ts-expect-error
     e.path = '/something/feed/_search';
 
     expect(locatedError(e, [], [])).to.not.deep.equal(e);

src/error/formatError.ts

@@ -23,28 +23,28 @@ export function formatError(error: GraphQLError): GraphQLFormattedError {
 /**
  * @see https://github.com/graphql/graphql-spec/blob/master/spec/Section%207%20--%20Response.md#errors
  */
-export type GraphQLFormattedError = {
+export interface GraphQLFormattedError {
   /**
    * A short, human-readable summary of the problem that **SHOULD NOT** change
    * from occurrence to occurrence of the problem, except for purposes of
    * localization.
    */
-  +message: string,
+  readonly message: string;
   /**
    * If an error can be associated to a particular point in the requested
    * GraphQL document, it should contain a list of locations.
    */
-  +locations: $ReadOnlyArray<SourceLocation> | void,
+  readonly locations?: ReadonlyArray<SourceLocation>;
   /**
    * If an error can be associated to a particular field in the GraphQL result,
    * it _must_ contain an entry with the key `path` that details the path of
    * the response field which experienced the error. This allows clients to
    * identify whether a null result is intentional or caused by a runtime error.
    */
-  +path: $ReadOnlyArray<string | number> | void,
+  readonly path?: ReadonlyArray<string | number>;
   /**
    * Reserved for implementors to extend the protocol however they see fit,
    * and hence there are no additional restrictions on its contents.
    */
-  +extensions?: { [key: string]: mixed, ... },
-};
+  readonly extensions?: { [key: string]: unknown };
+}

src/error/locatedError.ts

@@ -1,4 +1,5 @@
 import { inspect } from '../jsutils/inspect';
+import type { Maybe } from '../jsutils/Maybe';
 
 import type { ASTNode } from '../language/ast';
 
@@ -10,9 +11,9 @@ import { GraphQLError } from './GraphQLError';
  * document responsible for the original Error.
  */
 export function locatedError(
-  rawOriginalError: mixed,
-  nodes: ASTNode | $ReadOnlyArray<ASTNode> | void | null,
-  path?: ?$ReadOnlyArray<string | number>,
+  rawOriginalError: unknown,
+  nodes: ASTNode | ReadonlyArray<ASTNode> | undefined | null,
+  path?: Maybe<ReadonlyArray<string | number>>,
 ): GraphQLError {
   // Sometimes a non-error is thrown, wrap it as an Error instance to ensure a consistent Error interface.
   const originalError: Error | GraphQLError =
@@ -22,17 +23,17 @@ export function locatedError(
 
   // Note: this uses a brand-check to support GraphQL errors originating from other contexts.
   if (Array.isArray(originalError.path)) {
-    // $FlowExpectedError[incompatible-return]
+    // @ts-expect-error
     return originalError;
   }
 
   return new GraphQLError(
     originalError.message,
-    // $FlowFixMe[prop-missing] FIXME
+    // @ts-expect-error FIXME
     originalError.nodes ?? nodes,
-    // $FlowFixMe[prop-missing] FIXME
+    // @ts-expect-error FIXME
     originalError.source,
-    // $FlowFixMe[prop-missing] FIXME
+    // @ts-expect-error FIXME
     originalError.positions,
     path,
     originalError,