feat: windows support (#1184)

Co-authored-by: Jason Kuhrt <[email protected]>

Author: Weakky

.github/workflows/pr.yml

@@ -21,12 +21,36 @@ jobs:
       - run: yarn -s build
       - run: yarn -s test:unit
 
+  system-tests-windows:
+    strategy:
+      matrix:
+        os: [windows-latest]
+        node-version: [10.x, 12.x]
+        test-case: [kitchen-sink]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install deps
+        run: yarn --frozen-lockfile
+      - run: yarn -s build
+      - name: Setup global git user
+        run: |
+          # For nexus create app flow which will make an init commit
+          git config --global user.name prisma-labs
+          git config --global user.email [email protected]
+      - run: yarn -s test system/${{matrix.test-case}}
+
   system-tests:
-    runs-on: ubuntu-latest
     strategy:
       matrix:
+        os: [ubuntu-latest]
         node-version: [10.x, 12.x]
         test-case: [kitchen-sink, create-prisma-app]
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}

package.json

@@ -76,6 +76,7 @@
     "@types/lodash": "4.14.152",
     "@types/node": "13.13.9",
     "@types/parse-json": "^4.0.0",
+    "@types/which": "^1.3.2",
     "cross-env": "^7.0.2",
     "docsify": "4.11.3",
     "docsify-cli": "4.4.0",
@@ -86,7 +87,8 @@
     "nock": "^12.0.3",
     "node-pty": "0.9.0",
     "prettier": "2.0.5",
-    "ts-jest": "26.0.0"
+    "ts-jest": "26.0.0",
+    "which": "^2.0.2"
   },
   "engines": {
     "node": ">=10.0.0"
@@ -113,7 +115,7 @@
     "postpublish": "yarn clean",
     "postinstall": "node scripts/postinstall",
     "prepublishOnly": "yarn build",
-    "test": "cross-env FORCE_COLOR=3 LOG_PRETTY=true DEBUG=true jest --verbose --testTimeout 360000 --forceExit",
+    "test": "cross-env FORCE_COLOR=3 LOG_PRETTY=true DEBUG=true jest --verbose --testTimeout 1200000 --forceExit",
     "test:unit": "yarn test src",
     "dev:test": "yarn test --watch src",
     "dev": "yarn clean && node scripts/build-module-facades && tsc -b tsconfig.cjs.json -w"

src/cli/commands/create/app.ts

@@ -83,7 +83,7 @@ export async function runBootstrapper(configInput?: Partial<ConfigInput>): Promi
     sourceRoot: Path.join(process.cwd(), 'api'),
     ...configInput,
   }
-  const nexusVersion = await getNexusVersion()
+  const nexusVersion = getNexusVersion()
   const packageManager = await getPackageManager(internalConfig.projectRoot)
 
   if (packageManager === 'sigtermed') {
@@ -213,7 +213,7 @@ async function getPackageManager(projectRoot: string): Promise<PackageManager.Pa
   return packageManager
 }
 
-async function getNexusVersion(): Promise<string> {
+function getNexusVersion(): string {
   const nexusVersionEnvVar = process.env.CREATE_APP_CHOICE_NEXUS_VERSION
   const nexusVersion = nexusVersionEnvVar ?? `${ownPackage.version}`
   return nexusVersion

src/lib/add-to-context-extractor/typegen.ts

@@ -1,6 +1,7 @@
 import { codeBlock } from 'common-tags'
 import { Either, isLeft } from 'fp-ts/lib/Either'
 import * as fs from 'fs-jetpack'
+import slash from 'slash'
 import { hardWriteFile } from '../fs'
 import * as Layout from '../layout'
 import { rootLogger } from '../nexus-logger'
@@ -76,7 +77,7 @@ export async function writeContextTypeGenFile(contextTypes: ExtractedContextType
 }
 
 function renderImport(input: { from: string; names: string[] }) {
-  return `import { ${input.names.join(', ')} } from '${input.from}'`
+  return `import { ${input.names.join(', ')} } from '${slash(input.from)}'`
 }
 
 function renderContextInterfaceForExtractedReturnType(contribType: ContribType): string {

src/lib/e2e-testing.ts

@@ -5,10 +5,12 @@
 import * as Logger from '@nexus/logger'
 import * as FS from 'fs-jetpack'
 import { IPty, IPtyForkOptions, IWindowsPtyForkOptions } from 'node-pty'
+import * as os from 'os'
 import * as Path from 'path'
 import { ConnectableObservable, Observable, Subject } from 'rxjs'
 import { multicast } from 'rxjs/operators'
 import stripAnsi from 'strip-ansi'
+import * as which from 'which'
 import { Database } from '../cli/commands/create/app'
 import { GraphQLClient } from '../lib/graphql-client'
 import { getTmpDir } from './fs'
@@ -59,6 +61,11 @@ interface Config {
   }
 }
 
+/**
+ * The path at which to spawn node processes
+ */
+const NODE_PATH = os.platform() === 'win32' ? 'node.exe' : 'node'
+
 export function createE2EContext(config: Config) {
   Logger.log.settings({ filter: { level: 'trace' } })
   process.env.LOG_LEVEL = 'trace'
@@ -89,7 +96,7 @@ export function createE2EContext(config: Config) {
     fs: FS.cwd(projectDir),
     client: new GraphQLClient(`http://localhost:${config.serverPort}/graphql`),
     node(args: string[], opts: IPtyForkOptions = {}) {
-      return spawn('node', args, { cwd: projectDir, ...opts })
+      return spawn(NODE_PATH, args, { cwd: projectDir, ...opts })
     },
     spawn(binPathAndArgs: string[], opts: IPtyForkOptions = {}) {
       const [binPath, ...args] = binPathAndArgs
@@ -131,7 +138,7 @@ export function createE2EContext(config: Config) {
     },
     localNexus: config.localNexus
       ? (args: string[]) => {
-          return spawn('node', [localNexusBinPath!, ...args], {
+          return spawn(NODE_PATH, [localNexusBinPath!, ...args], {
             cwd: projectDir,
             env: {
               ...process.env,
@@ -142,7 +149,7 @@ export function createE2EContext(config: Config) {
       : null,
     localNexusCreateApp: config.localNexus
       ? (options: CreateAppOptions) => {
-          return spawn('node', [localNexusBinPath!], {
+          return spawn(NODE_PATH, [localNexusBinPath!], {
             cwd: projectDir,
             env: {
               ...process.env,
@@ -156,7 +163,7 @@ export function createE2EContext(config: Config) {
       : null,
     localNexusCreatePlugin: config.localNexus
       ? (options: CreatePluginOptions) => {
-          return spawn('node', [localNexusBinPath!, 'create', 'plugin'], {
+          return spawn(NODE_PATH, [localNexusBinPath!, 'create', 'plugin'], {
             cwd: projectDir,
             env: {
               ...process.env,
@@ -178,8 +185,10 @@ export function createE2EContext(config: Config) {
 export function spawn(command: string, args: string[], opts: IPtyForkOptions): ConnectableObservable<string> {
   const nodePty = requireNodePty()
   const subject = new Subject<string>()
+  // On windows, node-pty needs an absolute path to the executable. `which` is used to find that path.
+  const commandPath = which.sync(command)
   const ob = new Observable<string>((sub) => {
-    const proc = nodePty.spawn(command, args, {
+    const proc = nodePty.spawn(commandPath, args, {
       cols: process.stdout.columns ?? 80,
       rows: process.stdout.rows ?? 80,
       ...opts,

src/lib/fs.ts

@@ -102,8 +102,8 @@ export async function hardWriteFile(filePath: string, data: string) {
  * Return the path to a temporary directory on the machine. This works around a
  * limitation in Node wherein a symlink is returned on macOS for `os.tmpdir`.
  */
-export function getTmpDir(prefix: string = '') {
-  const tmpDirPath = NodeFS.realpathSync(OS.tmpdir())
+export function getTmpDir(prefix: string = '', baseTmpDir?: string) {
+  const tmpDirPath = NodeFS.realpathSync(baseTmpDir ?? OS.tmpdir())
   const id = Math.random().toString().slice(2)
   const dirName = [prefix, id].filter((x) => x).join('-')
 

src/lib/glocal/detect-exec-layout.spec.ts

@@ -1,8 +1,11 @@
+import * as os from 'os'
 import * as path from 'path'
 import * as TestContext from '../test-context'
 import { normalizePathsInData, Param1 } from '../utils'
 import { detectExecLayout } from './detect-exec-layout'
 
+const isWindows = os.platform() === 'win32'
+
 const ctx = TestContext.compose(TestContext.tmpDir(), TestContext.fs(), (ctx) => {
   return {
     detectExecLayout: (input?: Partial<Param1<typeof detectExecLayout>>) => {
@@ -24,13 +27,25 @@ function nodeProject() {
   ctx.fs.write('package.json', '{}')
 }
 function installTool() {
-  ctx.fs.write('package.json', '{ "dependencies": { "a": "foo" } }')
+  ctx.fs.write('package.json', {
+    dependencies: { a: 'foo' },
+  })
   ctx.fs.write('node_modules/a/index.js', '')
-  ctx.fs.symlink(ctx.fs.path('node_modules/a/index.js'), 'node_modules/.bin/a')
+  ctx.fs.write('node_modules/a/package.json', {
+    name: 'a',
+    bin: {
+      a: 'index.js',
+    },
+  })
+  if (isWindows) {
+    ctx.fs.write('node_modules/.bin/a', '')
+  } else {
+    ctx.fs.symlink(ctx.fs.path('node_modules/a/index.js'), 'node_modules/.bin/a')
+  }
 }
 
 beforeEach(() => {
-  ctx.fs.dir('some/other/bin/a')
+  ctx.fs.write('some/other/bin/a', '')
   ctx.fs.dir('node_modules/.bin')
 })
 
@@ -105,28 +120,46 @@ describe('local available detection', () => {
       runningLocalTool: false,
     })
   })
-  it('if just node_module/dir missing, discounts being available', () => {
-    ctx.fs.remove('node_modules/a')
-    expect(ctx.detectExecLayout()).toMatchObject({
-      nodeProject: true,
-      toolProject: true,
-      toolCurrentlyPresentInNodeModules: false,
-      runningLocalTool: false,
-    })
-  })
+  // todo | Test disabled becuase on posix the symlink in node_modules/.bin
+  // todo |   dir is deleted when the node_modules package it links to is deleted
+  // todo |   meaning that the test is testing nothing.
+  // todo | Bring back just for windows?
+  //  it('if just node_module/dir missing, discounts being available', () => {
+  //    ctx.fs.remove('node_modules/a')
+  //    expect(ctx.detectExecLayout()).toMatchObject({
+  //      nodeProject: true,
+  //     toolProject: true,
+  //      toolCurrentlyPresentInNodeModules: false,
+  //      runningLocalTool: false,
+  //    })
+  //  })
 })
 
 describe('running locally detection', () => {
   beforeEach(installTool)
-  it('if process script path matches path to tool in project bin then considered running locally', () => {
-    expect(ctx.detectExecLayout({ scriptPath: ctx.fs.path('node_modules/.bin/a') })).toMatchObject({
+
+  describe('if process tool path matches project tool path in dot-bin then considered running locally', () => {
+    const runningLocalToolResult = {
       nodeProject: true,
       toolProject: true,
       toolCurrentlyPresentInNodeModules: true,
       runningLocalTool: true,
+    }
+    it('process tool path as direct to script', () => {
+      expect(ctx.detectExecLayout({ scriptPath: ctx.fs.path('node_modules/a/index.js') })).toMatchObject(
+        runningLocalToolResult
+      )
     })
+    if (!isWindows) {
+      it('on posix: process tool path as dot-bin path (b/c argv[0] symlink not followed in some cases)', () => {
+        expect(ctx.detectExecLayout({ scriptPath: ctx.fs.path('node_modules/.bin/a') })).toMatchObject(
+          runningLocalToolResult
+        )
+      })
+    }
   })
-  it('if process script path does not match path to tool in project bin then not considered running locally', () => {
+
+  it('if process tool path does not match project tool path in dot-bin then not considered running locally', () => {
     expect(ctx.detectExecLayout({ scriptPath: ctx.fs.path('some/other/bin/a') })).toMatchObject({
       nodeProject: true,
       toolProject: true,
@@ -136,34 +169,28 @@ describe('running locally detection', () => {
   })
 })
 
-describe('this process analysis', () => {
+describe('analysis about "this process"', () => {
   beforeEach(() => {
     ctx.fs.write('a/b/c/real.js', '')
-    ctx.fs.symlink(ctx.fs.path('a/b/c/real.js'), 'x/y/z/fake')
+    if (isWindows) {
+      ctx.fs.write('x/y/z/fake', '')
+    } else {
+      ctx.fs.symlink(ctx.fs.path('a/b/c/real.js'), 'x/y/z/fake')
+    }
   })
   it('finds the real path of the script node executed', () => {
     const data = ctx.detectExecLayout({ scriptPath: ctx.fs.path('x/y/z/fake') })
-    expect(data.thisProcessToolBin).toMatchInlineSnapshot(`
-      Object {
-        "dir": "/__dynamic__/x/y/z",
-        "name": "fake",
-        "path": "/__dynamic__/x/y/z/fake",
-        "realDir": "/__dynamic__/a/b/c",
-        "realPath": "/__dynamic__/a/b/c/real.js",
-      }
-    `)
+
+    if (isWindows) {
+      expect(data.process.toolPath).toMatchInlineSnapshot(`"/__dynamic__/x/y/z/fake"`)
+    } else {
+      expect(data.process.toolPath).toMatchInlineSnapshot(`"/__dynamic__/a/b/c/real.js"`)
+    }
   })
+
   it('supports node running script without extension', () => {
     const data = ctx.detectExecLayout({ scriptPath: ctx.fs.path('a/b/c/real') })
-    expect(data.thisProcessToolBin).toMatchInlineSnapshot(`
-      Object {
-        "dir": "/__dynamic__/a/b/c",
-        "name": "real.js",
-        "path": "/__dynamic__/a/b/c/real.js",
-        "realDir": "/__dynamic__/a/b/c",
-        "realPath": "/__dynamic__/a/b/c/real.js",
-      }
-    `)
+    expect(data.process.toolPath).toMatchInlineSnapshot(`"/__dynamic__/a/b/c/real.js"`)
   })
 })
 
@@ -177,13 +204,20 @@ describe('project analysis', () => {
     nodeProject()
     const data = ctx.detectExecLayout()
     expect(data.nodeProject).toEqual(true)
+    // expect(data.project).toMatchInlineSnapshot(`
+    //   Object {
+    //     "binDir": "/__dynamic__/node_modules/.bin",
+    //     "dir": "/__dynamic__",
+    //     "nodeModulesDir": "/__dynamic__/node_modules",
+    //     "toolBinPath": "/__dynamic__/node_modules/.bin/a",
+    //     "toolBinRealPath": null,
+    //   }
+    // `)
     expect(data.project).toMatchInlineSnapshot(`
       Object {
-        "binDir": "/__dynamic__/node_modules/.bin",
         "dir": "/__dynamic__",
         "nodeModulesDir": "/__dynamic__/node_modules",
-        "toolBinPath": "/__dynamic__/node_modules/.bin/a",
-        "toolBinRealPath": null,
+        "toolPath": null,
       }
     `)
   })
@@ -192,13 +226,11 @@ describe('project analysis', () => {
     const data = ctx.detectExecLayout()
     expect(data.toolProject).toEqual(true)
     expect(data.project).toMatchInlineSnapshot(`
-      Object {
-        "binDir": "/__dynamic__/node_modules/.bin",
-        "dir": "/__dynamic__",
-        "nodeModulesDir": "/__dynamic__/node_modules",
-        "toolBinPath": "/__dynamic__/node_modules/.bin/a",
-        "toolBinRealPath": "/__dynamic__/node_modules/a/index.js",
-      }
-    `)
+    Object {
+      "dir": "/__dynamic__",
+      "nodeModulesDir": "/__dynamic__/node_modules",
+      "toolPath": "/__dynamic__/node_modules/a/index.js",
+    }
+  `)
   })
 })