Merge pull request #249 from coderoad/fix/cr-fail-on-startup

Fix/cr fail on startup

Author: ShMcK

errors/NoWorkspaceFound.md

@@ -0,0 +1,3 @@
+### Open a Workspace Folder
+
+CodeRoad requires a workspace folder to run. Open a new workspace and re-launch CodeRoad.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "coderoad",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Play interactive coding tutorials in your editor",
   "keywords": [
     "tutorial",
@@ -26,7 +26,6 @@
   "scripts": {
     "build": "./scripts/build.sh",
     "postinstall": "node ./node_modules/vscode/bin/install",
-    "publish": "vsce publish -p $PERSONAL_ACCESS_TOKEN --packagePath ./releases/coderoad-$npm_package_version.vsix --baseContentUrl https://github.com/coderoad/coderoad-vscode/blob/master --baseImagesUrl https://github.com/coderoad/coderoad-vscode/blob/master",
     "lint": "eslint src/**/*ts",
     "package": "./scripts/package.sh",
     "storybook": "cd web-app && npm run storybook",

package.json

@@ -1,14 +1,12 @@
 import * as T from 'typings'
 import * as TT from 'typings/tutorial'
-import * as vscode from 'vscode'
 import * as git from '../services/git'
 import loadWatchers from './utils/loadWatchers'
 import openFiles from './utils/openFiles'
 import runCommands from './utils/runCommands'
 import onError from '../services/sentry/onError'
 
 const setupActions = async (
-  workspaceRoot: vscode.WorkspaceFolder,
   actions: TT.StepActions,
   send: (action: T.Action) => void, // send messages to client
 ): Promise<void> => {
@@ -26,7 +24,7 @@ const setupActions = async (
   openFiles(files || [])
 
   // 3. start file watchers
-  loadWatchers(watchers || [], workspaceRoot.uri)
+  loadWatchers(watchers || [])
 
   // 4. run command
   await runCommands(commands || [], send).catch(onError)

src/actions/setupActions.ts

@@ -1,17 +1,12 @@
 import * as T from 'typings'
 import * as TT from 'typings/tutorial'
-import * as vscode from 'vscode'
 import * as git from '../services/git'
 import setupActions from './setupActions'
 import onError from '../services/sentry/onError'
 
-const solutionActions = async (
-  workspaceRoot: vscode.WorkspaceFolder,
-  stepActions: TT.StepActions,
-  send: (action: T.Action) => void,
-): Promise<void> => {
+const solutionActions = async (stepActions: TT.StepActions, send: (action: T.Action) => void): Promise<void> => {
   await git.clear()
-  return setupActions(workspaceRoot, stepActions, send).catch(onError)
+  return setupActions(stepActions, send).catch(onError)
 }
 
 export default solutionActions

src/actions/solutionActions.ts

@@ -1,6 +1,7 @@
 import * as chokidar from 'chokidar'
 import * as vscode from 'vscode'
 import { COMMANDS } from '../../editor/commands'
+import environment from '../../environment'
 
 // NOTE: vscode createFileWatcher doesn't seem to detect changes outside of vscode
 // such as `npm install` of a package. Went with chokidar instead
@@ -13,7 +14,7 @@ const disposeWatcher = (watcher: string) => {
   delete watcherObject[watcher]
 }
 
-const loadWatchers = (watchers: string[], workspaceUri: vscode.Uri) => {
+const loadWatchers = (watchers: string[]) => {
   if (!watchers.length) {
     // remove all watchers
     for (const watcher of Object.keys(watcherObject)) {
@@ -24,13 +25,8 @@ const loadWatchers = (watchers: string[], workspaceUri: vscode.Uri) => {
     if (!watcherObject[watcher]) {
       // see how glob patterns are used in VSCode (not like a regex)
       // https://code.visualstudio.com/api/references/vscode-api#GlobPattern
-      const rootUri = vscode.workspace.getWorkspaceFolder(workspaceUri)
-      if (!rootUri) {
-        return
-      }
-
       const fsWatcher: chokidar.FSWatcher = chokidar.watch(watcher, {
-        cwd: rootUri.uri.path,
+        cwd: environment.WORKSPACE_ROOT,
         interval: 1000,
       })
 

src/actions/utils/loadWatchers.ts

@@ -1,5 +1,5 @@
 import * as T from 'typings'
-import node from '../../services/node'
+import { exec } from '../../services/node'
 
 const runCommands = async (commands: string[], send: (action: T.Action) => void) => {
   if (!commands.length) {
@@ -13,7 +13,7 @@ const runCommands = async (commands: string[], send: (action: T.Action) => void)
     send({ type: 'COMMAND_START', payload: { process: { ...process, status: 'RUNNING' } } })
     let result: { stdout: string; stderr: string }
     try {
-      result = await node.exec(command)
+      result = await exec(command)
     } catch (error) {
       console.log(error)
       send({ type: 'COMMAND_FAIL', payload: { process: { ...process, status: 'FAIL' } } })

src/actions/utils/runCommands.ts

@@ -14,7 +14,7 @@ import { openWorkspace, checkWorkspaceEmpty } from '../services/workspace'
 import { readFile } from 'fs'
 import { join } from 'path'
 import { promisify } from 'util'
-import { compare } from 'semver'
+import environment from '../environment'
 
 const readFileAsync = promisify(readFile)
 
@@ -26,18 +26,15 @@ interface Channel {
 interface ChannelProps {
   postMessage: (action: T.Action) => Thenable<boolean>
   workspaceState: vscode.Memento
-  workspaceRoot: vscode.WorkspaceFolder
 }
 
 class Channel implements Channel {
   private postMessage: (action: T.Action) => Thenable<boolean>
   private workspaceState: vscode.Memento
-  private workspaceRoot: vscode.WorkspaceFolder
   private context: Context
-  constructor({ postMessage, workspaceState, workspaceRoot }: ChannelProps) {
+  constructor({ postMessage, workspaceState }: ChannelProps) {
     // workspaceState used for local storage
     this.workspaceState = workspaceState
-    this.workspaceRoot = workspaceRoot
     this.postMessage = postMessage
     this.context = new Context(workspaceState)
   }
@@ -52,6 +49,22 @@ class Channel implements Channel {
 
     switch (actionType) {
       case 'EDITOR_ENV_GET':
+        // check if a workspace is open, otherwise nothing works
+        const noActiveWorksapce = !environment.WORKSPACE_ROOT.length
+        if (noActiveWorksapce) {
+          const error: E.ErrorMessage = {
+            type: 'NoWorkspaceFound',
+            message: '',
+            actions: [
+              {
+                label: 'Open Workspace',
+                transition: 'REQUEST_WORKSPACE',
+              },
+            ],
+          }
+          this.send({ type: 'NO_WORKSPACE', payload: { error } })
+          return
+        }
         this.send({
           type: 'ENV_LOAD',
           payload: {
@@ -180,8 +193,8 @@ class Channel implements Channel {
         vscode.commands.executeCommand(COMMANDS.SET_CURRENT_STEP, action.payload)
         return
       case 'EDITOR_VALIDATE_SETUP':
-        // 1. check workspace is selected
-        const isEmptyWorkspace = await checkWorkspaceEmpty(this.workspaceRoot.uri.path)
+        // check workspace is selected
+        const isEmptyWorkspace = await checkWorkspaceEmpty()
         if (!isEmptyWorkspace) {
           const error: E.ErrorMessage = {
             type: 'WorkspaceNotEmpty',
@@ -200,7 +213,7 @@ class Channel implements Channel {
           this.send({ type: 'VALIDATE_SETUP_FAILED', payload: { error } })
           return
         }
-        // 2. check Git is installed.
+        // check Git is installed.
         // Should wait for workspace before running otherwise requires access to root folder
         const isGitInstalled = await version('git')
         if (!isGitInstalled) {
@@ -225,11 +238,11 @@ class Channel implements Channel {
       // load step actions (git commits, commands, open files)
       case 'SETUP_ACTIONS':
         await vscode.commands.executeCommand(COMMANDS.SET_CURRENT_STEP, action.payload)
-        setupActions(this.workspaceRoot, action.payload, this.send)
+        setupActions(action.payload, this.send)
         return
       // load solution step actions (git commits, commands, open files)
       case 'SOLUTION_ACTIONS':
-        await solutionActions(this.workspaceRoot, action.payload, this.send)
+        await solutionActions(action.payload, this.send)
         // run test following solution to update position
         vscode.commands.executeCommand(COMMANDS.RUN_TEST, action.payload)
         return

src/channel/index.ts

@@ -14,10 +14,9 @@ export const COMMANDS = {
 interface CreateCommandProps {
   extensionPath: string
   workspaceState: vscode.Memento
-  workspaceRoot: vscode.WorkspaceFolder
 }
 
-export const createCommands = ({ extensionPath, workspaceState, workspaceRoot }: CreateCommandProps) => {
+export const createCommands = ({ extensionPath, workspaceState }: CreateCommandProps) => {
   // React panel webview
   let webview: any
   let currentStepId = ''
@@ -41,7 +40,6 @@ export const createCommands = ({ extensionPath, workspaceState, workspaceRoot }:
       webview = createWebView({
         extensionPath,
         workspaceState,
-        workspaceRoot,
       })
     },
     // open React webview

src/editor/commands.ts

@@ -28,18 +28,10 @@ class Editor {
   }
 
   private activateCommands = (): void => {
-    // set workspace root for node executions
-    const workspaceRoots: vscode.WorkspaceFolder[] | undefined = vscode.workspace.workspaceFolders
-    if (!workspaceRoots || !workspaceRoots.length) {
-      throw new Error('No workspace root path')
-    }
-    const workspaceRoot: vscode.WorkspaceFolder = workspaceRoots[0]
-
     const commands = createCommands({
       extensionPath: this.vscodeExt.extensionPath,
       // NOTE: local storage must be bound to the vscodeExt.workspaceState
       workspaceState: this.vscodeExt.workspaceState,
-      workspaceRoot,
     })
 
     // register commands