refactor: remove fatals from layout tsconfig (#1046)

Author: Jason Kuhrt

src/lib/glocal/utils.ts

@@ -1,5 +1,6 @@
 import { Either, isLeft, isRight } from 'fp-ts/lib/Either'
 import * as Path from 'path'
+import { inspect } from 'util'
 import { findFileRecurisvelyUpwardSync } from '../fs'
 import { fatal } from '../process'
 
@@ -47,6 +48,14 @@ export function rightOrThrow<A extends Error, B>(x: Either<A, B>): B {
   return x.right
 }
 
+/**
+ * Extract the left value from an Either or throw.
+ */
+export function leftOrThrow<A, B>(x: Either<A, B>): A {
+  if (isLeft(x)) return x.left
+  throw new Error(`Unexpected Either.right:\n${inspect(x.right)}`)
+}
+
 /**
  * Extract the right value from an Either or throw.
  */

src/lib/layout/index.spec.ts

@@ -1,10 +1,9 @@
 import { log } from '@nexus/logger'
 import { defaultsDeep } from 'lodash'
-import stripAnsi from 'strip-ansi'
 import { TsConfigJson } from 'type-fest'
 import * as Layout from '.'
 import { FSSpec, writeFSSpec } from '../../lib/testing-utils'
-import { rightOrThrow } from '../glocal/utils'
+import { leftOrThrow, rightOrThrow } from '../glocal/utils'
 import * as TC from '../test-context'
 import { repalceInObject, replaceEvery } from '../utils'
 import { NEXUS_TS_LSP_IMPORT_ID } from './tsconfig'
@@ -136,33 +135,42 @@ describe('projectRoot', () => {
 
 describe('sourceRoot', () => {
   it('defaults to project dir', async () => {
-    ctx.setup({ 'tsconfig.json': '' })
-    const result = await ctx.createLayoutThrow()
-    expect(result.sourceRoot).toEqual('__DYNAMIC__')
-    expect(result.projectRoot).toEqual('__DYNAMIC__')
+    ctx.setup({ 'tsconfig.json': '', 'app.ts': '' })
+    const res = await ctx.createLayout().then(rightOrThrow)
+    expect(res.sourceRoot).toEqual('__DYNAMIC__')
+    expect(res.projectRoot).toEqual('__DYNAMIC__')
   })
-  it('honours the value in tsconfig rootDir', async () => {
-    ctx.setup({ 'tsconfig.json': tsconfigSource({ compilerOptions: { rootDir: 'api' } }) })
-    const result = await ctx.createLayoutThrow()
-    expect(result.sourceRoot).toMatchInlineSnapshot(`"__DYNAMIC__/api"`)
+  it('uses the value in tsconfig compilerOptions.rootDir if present', async () => {
+    ctx.setup({ 'tsconfig.json': tsconfigSource({ compilerOptions: { rootDir: 'api' } }), 'api/app.ts': '' })
+    const res = await ctx.createLayout().then(rightOrThrow)
+    expect(res.sourceRoot).toMatchInlineSnapshot(`"__DYNAMIC__/api"`)
   })
 })
 
-it('fails if empty file tree', async () => {
-  ctx.setup()
-
-  try {
-    await ctx.createLayoutThrow()
-  } catch (err) {
-    expect(err.message).toContain("Path you want to find stuff in doesn't exist")
-  }
-})
-
 describe('tsconfig', () => {
   beforeEach(() => {
     ctx.setup({ 'app.ts': '' })
   })
 
+  it('fails if tsconfig settings does not lead to matching any source files', async () => {
+    ctx.fs.remove('app.ts')
+    const res = await ctx.createLayout().then(leftOrThrow)
+    expect(res).toMatchInlineSnapshot(`
+      Object {
+        "context": Object {
+          "diagnostics": Array [
+            Object {
+              "category": 1,
+              "code": 18003,
+              "messageText": "No inputs were found in config file '__DYNAMIC__/tsconfig.json'. Specified 'include' paths were '[\\".\\"]' and 'exclude' paths were '[]'.",
+            },
+          ],
+        },
+        "type": "invalid_tsconfig",
+      }
+    `)
+  })
+
   it('will scaffold tsconfig if not present', async () => {
     await ctx.createLayoutThrow()
     expect(logs).toMatchInlineSnapshot(`
@@ -320,56 +328,44 @@ describe('tsconfig', () => {
     })
   })
 
-  it('will fatal message and exit if error reading file', async () => {
+  it('will return exception if error reading file', async () => {
     ctx.setup({
       'tsconfig.json': 'bad json',
     })
-    await ctx.createLayoutThrow()
-    expect(stripAnsi(logs)).toMatchInlineSnapshot(`
-      "✕ nexus:tsconfig Unable to read your tsconifg.json
-
-      ../../../../..__DYNAMIC__/tsconfig.json:1:1 - error TS1005: '{' expected.
-
-      1 bad json
-        ~~~
-
-
-
-      --- process.exit(1) ---
-
-      ▲ nexus:tsconfig You have not setup the Nexus TypeScript Language Service Plugin. Add this to your compiler options:
+    const res = await ctx.createLayout().then(leftOrThrow)
+    expect(res).toMatchInlineSnapshot(`
+      Object {
+        "context": Object {},
+        "message": "Unable to read your tsconifg.json
 
-          \\"plugins\\": [{ \\"name\\": \\"nexus/typescript-language-service\\" }]
+      [96m../../../../..__DYNAMIC__/tsconfig.json[0m:[93m1[0m:[93m1[0m - [91merror[0m[90m TS1005: [0m'{' expected.
 
-      ▲ nexus:tsconfig Please set \`compilerOptions.rootDir\` to \\".\\"
-      ▲ nexus:tsconfig Please set \`include\` to have \\".\\"
-      ▲ nexus:tsconfig Please set \`compilerOptions.noEmit\` to true. This will ensure you do not accidentally emit using \`$ tsc\`. Use \`$ nexus build\` to build your app and emit JavaScript.
-      "
+      1 bad json
+        ~~~
+      ",
+        "type": "generic",
+      }
     `)
   })
 
-  it('will fatal message and exit if invalid tsconfig schema', async () => {
+  it('will return exception if invalid tsconfig schema', async () => {
     ctx.setup({
       'tsconfig.json': '{ "exclude": "bad" }',
     })
-    await ctx.createLayoutThrow()
-    expect(stripAnsi(logs)).toMatchInlineSnapshot(`
-      "▲ nexus:tsconfig You have not setup the Nexus TypeScript Language Service Plugin. Add this to your compiler options:
-
-          \\"plugins\\": [{ \\"name\\": \\"nexus/typescript-language-service\\" }]
-
-      ▲ nexus:tsconfig Please set \`compilerOptions.rootDir\` to \\".\\"
-      ▲ nexus:tsconfig Please set \`include\` to have \\".\\"
-      ▲ nexus:tsconfig Please set \`compilerOptions.noEmit\` to true. This will ensure you do not accidentally emit using \`$ tsc\`. Use \`$ nexus build\` to build your app and emit JavaScript.
-      ✕ nexus:tsconfig Your tsconfig.json is invalid
-
-      error TS5024: Compiler option 'exclude' requires a value of type Array.
-
-
-
-      --- process.exit(1) ---
-
-      "
+    const res = await ctx.createLayout().then(leftOrThrow)
+    expect(res).toMatchInlineSnapshot(`
+      Object {
+        "context": Object {
+          "diagnostics": Array [
+            Object {
+              "category": 1,
+              "code": 5024,
+              "messageText": "Compiler option 'exclude' requires a value of type Array.",
+            },
+          ],
+        },
+        "type": "invalid_tsconfig",
+      }
     `)
   })
 })
@@ -516,7 +512,7 @@ describe('entrypoint', () => {
     await ctx.setup({ 'tsconfig.json': tsconfigSource(), 'index.ts': `console.log('entrypoint')` })
     const result = await ctx.createLayout({ entrypointPath: './wrong-path.ts' })
     expect(JSON.stringify(result)).toMatchInlineSnapshot(
-      `"{\\"_tag\\":\\"Left\\",\\"left\\":{\\"message\\":\\"Entrypoint does not exist\\",\\"context\\":{\\"path\\":\\"__DYNAMIC__/wrong-path.ts\\"}}}"`
+      `"{\\"_tag\\":\\"Left\\",\\"left\\":{\\"message\\":\\"Entrypoint does not exist\\",\\"context\\":{\\"path\\":\\"__DYNAMIC__/wrong-path.ts\\"},\\"type\\":\\"generic\\"}}"`
     )
   })
 
@@ -528,7 +524,7 @@ describe('entrypoint', () => {
     })
     const result = await ctx.createLayout({ entrypointPath: './index.js' })
     expect(JSON.stringify(result)).toMatchInlineSnapshot(
-      `"{\\"_tag\\":\\"Left\\",\\"left\\":{\\"message\\":\\"Entrypoint must be a .ts file\\",\\"context\\":{\\"path\\":\\"__DYNAMIC__/index.js\\"}}}"`
+      `"{\\"_tag\\":\\"Left\\",\\"left\\":{\\"message\\":\\"Entrypoint must be a .ts file\\",\\"context\\":{\\"path\\":\\"__DYNAMIC__/index.js\\"},\\"type\\":\\"generic\\"}}"`
     )
   })
 })

src/lib/layout/layout.ts

@@ -10,7 +10,7 @@ import { findFile, isEmptyDir } from '../../lib/fs'
 import { rootLogger } from '../nexus-logger'
 import * as PJ from '../package-json'
 import * as PackageManager from '../package-manager'
-import { createContextualError } from '../utils'
+import { exception } from '../utils'
 import { BuildLayout, getBuildLayout } from './build'
 import { saveDataForChildProcess } from './cache'
 import { readOrScaffoldTsconfig } from './tsconfig'
@@ -160,9 +160,11 @@ export async function create(options?: Options): Promise<Either<Error, Layout>>
 
   const packageManagerType = await PackageManager.detectProjectPackageManager({ projectRoot })
   const maybeAppModule = normalizedEntrypoint ?? findAppModule({ projectRoot })
-  const tsConfig = await readOrScaffoldTsconfig({
-    projectRoot,
-  })
+
+  const errTsConfig = await readOrScaffoldTsconfig({ projectRoot })
+  if (isLeft(errTsConfig)) return errTsConfig
+  const tsConfig = errTsConfig.right
+
   const nexusModules = findNexusModules(tsConfig, maybeAppModule)
   const project = packageJson
     ? {
@@ -340,12 +342,12 @@ function normalizeEntrypoint(
   const absoluteEntrypoint = Path.isAbsolute(entrypoint) ? entrypoint : Path.join(projectRoot, entrypoint)
 
   if (!absoluteEntrypoint.endsWith('.ts')) {
-    const error = createContextualError('Entrypoint must be a .ts file', { path: absoluteEntrypoint })
+    const error = exception('Entrypoint must be a .ts file', { path: absoluteEntrypoint })
     return left(error)
   }
 
   if (!FS.exists(absoluteEntrypoint)) {
-    const error = createContextualError('Entrypoint does not exist', { path: absoluteEntrypoint })
+    const error = exception('Entrypoint does not exist', { path: absoluteEntrypoint })
     return left(error)
   }
 

src/lib/layout/tsconfig.ts

@@ -1,5 +1,6 @@
 import chalk from 'chalk'
 import { stripIndent } from 'common-tags'
+import { Either, left, right } from 'fp-ts/lib/Either'
 import * as fs from 'fs-jetpack'
 import { cloneDeep } from 'lodash'
 import { EOL } from 'os'
@@ -8,6 +9,7 @@ import { TsConfigJson } from 'type-fest'
 import * as ts from 'typescript'
 import { isDeepStrictEqual } from 'util'
 import { rootLogger } from '../nexus-logger'
+import { exception, exceptionType } from '../utils'
 import { DEFAULT_BUILD_DIR_PATH_RELATIVE_TO_PROJECT_ROOT } from './build'
 
 export const NEXUS_TS_LSP_IMPORT_ID = 'nexus/typescript-language-service'
@@ -20,12 +22,20 @@ const diagnosticHost: ts.FormatDiagnosticsHost = {
   getCanonicalFileName: (path) => path,
 }
 
+/**
+ * An error following the parsing of tsconfig. Kinds of errors include type validations like if include field is an array.
+ */
+const invalidTsConfig = exceptionType<'invalid_tsconfig', { diagnostics: ts.Diagnostic[] }>(
+  'invalid_tsconfig',
+  ({ diagnostics }) =>
+    'Your tsconfig.json is invalid\n\n' + ts.formatDiagnosticsWithColorAndContext(diagnostics, diagnosticHost)
+)
+
 export async function readOrScaffoldTsconfig(input: {
   projectRoot: string
   overrides?: { outRoot?: string }
-}): Promise<{ content: ts.ParsedCommandLine; path: string }> {
+}): Promise<Either<Error, { content: ts.ParsedCommandLine; path: string }>> {
   log.trace('start read')
-
   let tsconfigPath = ts.findConfigFile(input.projectRoot, ts.sys.fileExists, 'tsconfig.json')
 
   if (!tsconfigPath) {
@@ -44,12 +54,16 @@ export async function readOrScaffoldTsconfig(input: {
   const tscfgReadResult = ts.readConfigFile(tsconfigPath, ts.sys.readFile)
 
   if (tscfgReadResult.error) {
-    // todo either
-    log.fatal(
-      'Unable to read your tsconifg.json\n\n' +
-        ts.formatDiagnosticsWithColorAndContext([tscfgReadResult.error], diagnosticHost)
+    return left(
+      exception(
+        'Unable to read your tsconifg.json\n\n' +
+          ts.formatDiagnosticsWithColorAndContext([tscfgReadResult.error], diagnosticHost),
+        {
+          // todo leads to circ ref error in json serialize
+          // diagnostics: [tscfgReadResult.error],
+        }
+      )
     )
-    process.exit(1)
   }
 
   const tsconfigSource: TsConfigJson = tscfgReadResult.config
@@ -70,9 +84,16 @@ export async function readOrScaffoldTsconfig(input: {
     // If the include is present but not array it must mean a mal-formed tsconfig.
     // Exit early, if we contintue we will have a runtime error when we try .push on a non-array.
     // todo testme once we're not relying on mock process exit
-    checkNoTsConfigErrors(
-      ts.parseJsonConfigFileContent(tsconfigSource, ts.sys, projectRoot, undefined, tsconfigPath)
-    )
+    const diagnostics = ts.parseJsonConfigFileContent(
+      tsconfigSource,
+      ts.sys,
+      projectRoot,
+      undefined,
+      tsconfigPath
+    ).errors
+    if (diagnostics.length > 0) {
+      return left(invalidTsConfig({ diagnostics }))
+    }
   }
 
   const tsconfigSourceOriginal = cloneDeep(tsconfigSource)
@@ -210,22 +231,13 @@ export async function readOrScaffoldTsconfig(input: {
    * Validate the tsconfig
    */
 
-  checkNoTsConfigErrors(tsconfigParsed)
+  if (tsconfigParsed.errors.length > 0) {
+    return left(invalidTsConfig({ diagnostics: tsconfigParsed.errors }))
+  }
 
   log.trace('finished read')
 
-  return { content: tsconfigParsed, path: tsconfigPath }
-}
-
-function checkNoTsConfigErrors(tsconfig: ts.ParsedCommandLine) {
-  if (tsconfig.errors.length > 0) {
-    // Kinds of errors include type validations like if include field is an array.
-    log.fatal(
-      'Your tsconfig.json is invalid\n\n' +
-        ts.formatDiagnosticsWithColorAndContext(tsconfig.errors, diagnosticHost)
-    )
-    process.exit(1)
-  }
+  return right({ content: tsconfigParsed, path: tsconfigPath })
 }
 
 export function tsconfigTemplate(input: { sourceRootRelative: string; outRootRelative: string }): string {

src/lib/plugin/index.spec.ts

@@ -46,10 +46,11 @@ describe('manifest', () => {
             "plugin": Object {
               "packageJsonPath": "<project root>/package.json",
             },
-          },
-          "message": "Failed to read the the package.json file.
+            "reason": "Failed to read the the package.json file.
 
       Error: Cannot find module '<project root>/package.json' from 'src/lib/plugin/manifest.ts'",
+          },
+          "type": "get_manifest_error",
         },
       }
     `)
@@ -66,8 +67,9 @@ describe('manifest', () => {
             "plugin": Object {
               "packageJsonPath": "<project root>/package.json",
             },
+            "reason": "\`name\` property is missing in the package.json",
           },
-          "message": "\`name\` property is missing in package.json",
+          "type": "get_manifest_error",
         },
       }
     `)
@@ -85,8 +87,9 @@ describe('manifest', () => {
             "plugin": Object {
               "packageJsonPath": "<project root>/package.json",
             },
+            "reason": "\`main\` property is missing in the package.json",
           },
-          "message": "\`main\` property is missing in package.json",
+          "type": "get_manifest_error",
         },
       }
     `)