cleanup stepAction loading

Author: ShMcK

src/Channel.ts

@@ -28,9 +28,11 @@ class Channel implements Channel {
 				tutorialConfig(action.payload)
 				return
 			case 'SETUP_ACTIONS':
+				console.log(action.payload)
 				setupActions(action.payload)
 				return
 			case 'SOLUTION_ACTIONS':
+				console.log(action.payload)
 				solutionActions(action.payload)
 				return
 			default:

src/actions/runTest.ts

@@ -1,5 +1,5 @@
 import * as vscode from 'vscode'
-import {exec} from '../services/node'
+import node from '../services/node'
 
 // ensure only latest run_test action is taken
 let currentId = 0
@@ -50,7 +50,7 @@ export default async function runTest({onSuccess, onFail}: Props): Promise<void>
 	try {
 		// capture position early on test start
 		// in case position changes
-		const {stdout} = await exec(commandLine)
+		const {stdout} = await node.exec(commandLine)
 		if (shouldExitEarly(processId)) {
 			// exit early
 			return
@@ -98,7 +98,7 @@ export default async function runTest({onSuccess, onFail}: Props): Promise<void>
 			console.error('SOMETHING WENT WRONG WITH A PASSING TEST')
 		}
 		// test runner failed
-		const channel = getOutputChannel(outputChannelName)
+		channel = getOutputChannel(outputChannelName)
 
 		if (stdout) {
 			const lines = stdout.split(/\r{0,1}\n/)

src/actions/setupActions.ts

@@ -2,7 +2,7 @@ import * as G from 'typings/graphql'
 import {join} from 'path'
 import * as vscode from 'vscode'
 import * as git from '../services/git'
-import {exec} from '../services/node'
+import node from '../services/node'
 
 interface ErrorMessageFilter {
 	[lang: string]: {
@@ -25,7 +25,7 @@ const setupActions = async ({commands, commits, files}: G.StepActions): Promise<
 
 	// run command
 	for (const command of commands) {
-		const {stdout, stderr} = await exec(command)
+		const {stdout, stderr} = await node.exec(command)
 		if (stderr) {
 			console.error(stderr)
 			// language specific error messages from running commands

src/editor/index.ts

@@ -1,5 +1,4 @@
 import * as vscode from 'vscode'
-import {setWorkspaceRoot} from '../services/node'
 import {createCommands} from './commands'
 
 class Editor {
@@ -9,12 +8,10 @@ class Editor {
 
 	constructor() {
 		// set workspace root for node executions
-		const {workspace} = vscode
-		const {rootPath} = workspace
+		const rootPath = vscode.workspace.rootPath
 		if (!rootPath) {
 			throw new Error('Requires a workspace. Please open a folder')
 		}
-		setWorkspaceRoot(rootPath)
 	}
 	public activate = (vscodeExt: vscode.ExtensionContext): void => {
 		console.log('ACTIVATE!')

src/editor/workspace.ts

@@ -1,10 +1,10 @@
 import * as fs from 'fs'
 import * as path from 'path'
 import * as vscode from 'vscode'
-import {exec, exists} from '../services/node'
+import node from '../services/node'
 
 export async function isEmptyWorkspace(): Promise<boolean> {
-	const {stdout, stderr} = await exec('ls')
+	const {stdout, stderr} = await node.exec('ls')
 	if (stderr) {
 		throw new Error('Error validating if project is empty')
 	}
@@ -13,15 +13,15 @@ export async function isEmptyWorkspace(): Promise<boolean> {
 
 // // TODO: workspace change listener
 export async function openReadme(): Promise<void> {
-	const {stderr} = await exec('ls')
+	const {stderr} = await node.exec('ls')
 	if (stderr) {
 		throw new Error('Error looking for initial file')
 	}
 
 	const file = 'README.md'
 	const filePath = path.join(vscode.workspace.rootPath || '', file)
 	console.log('filePath', filePath)
-	const hasReadme = await exists(file)
+	const hasReadme = await node.exists(file)
 
 	if (!hasReadme) {
 		// add readme if none exists

src/services/git/index.ts

@@ -1,13 +1,13 @@
 import * as CR from 'typings'
-import {exec, exists} from '../node'
+import node from '../node'
 
 
 const gitOrigin = 'coderoad'
 
 const stashAllFiles = async () => {
 	console.log('stashAllFiles')
 	// stash files including untracked (eg. newly created file)
-	const {stdout, stderr} = await exec(`git stash --include-untracked`)
+	const {stdout, stderr} = await node.exec(`git stash --include-untracked`)
 	if (stderr) {
 		console.error(stderr)
 		throw new Error('Error stashing files')
@@ -20,7 +20,7 @@ const cherryPickCommit = async (commit: string, count = 0): Promise<void> => {
 		return
 	}
 	try {
-		const {stdout} = await exec(`git cherry-pick ${commit}`)
+		const {stdout} = await node.exec(`git cherry-pick ${commit}`)
 		if (!stdout) {
 			throw new Error('No cherry-pick output')
 		}
@@ -49,7 +49,7 @@ export function loadCommit(commit: string): Promise<void> {
 
 export async function saveCommit(position: CR.Position): Promise<void> {
 	const {levelId, stageId, stepId} = position
-	const {stdout, stderr} = await exec(`git commit -am 'completed ${levelId}/${stageId}/${stepId}'`)
+	const {stdout, stderr} = await node.exec(`git commit -am 'completed ${levelId}/${stageId}/${stepId}'`)
 	if (stderr) {
 		console.error(stderr)
 		throw new Error('Error saving progress to Git')
@@ -60,7 +60,7 @@ export async function saveCommit(position: CR.Position): Promise<void> {
 export async function clear(): Promise<void> {
 	try {
 		// commit progress to git
-		const {stderr} = await exec('git reset HEAD --hard && git clean -fd')
+		const {stderr} = await node.exec('git reset HEAD --hard && git clean -fd')
 		if (!stderr) {
 			return
 		}
@@ -72,7 +72,7 @@ export async function clear(): Promise<void> {
 }
 
 export async function version(): Promise<string | boolean> {
-	const {stdout, stderr} = await exec('git --version')
+	const {stdout, stderr} = await node.exec('git --version')
 	if (!stderr) {
 		const match = stdout.match(/^git version (\d+\.)?(\d+\.)?(\*|\d+)/)
 		if (match) {
@@ -85,7 +85,7 @@ export async function version(): Promise<string | boolean> {
 }
 
 async function init(): Promise<void> {
-	const {stderr} = await exec('git init')
+	const {stderr} = await node.exec('git init')
 	if (stderr) {
 		throw new Error('Error initializing Gits')
 	}
@@ -98,14 +98,14 @@ export async function initIfNotExists(): Promise<void> {
 		throw new Error('Git must be installed')
 	}
 
-	const hasGitInit = exists('.git')
+	const hasGitInit = node.exists('.git')
 	if (!hasGitInit) {
 		await init()
 	}
 }
 
 export async function addRemote(repo: string): Promise<void> {
-	const {stderr} = await exec(`git remote add ${gitOrigin} ${repo} && git fetch ${gitOrigin}`)
+	const {stderr} = await node.exec(`git remote add ${gitOrigin} ${repo} && git fetch ${gitOrigin}`)
 	if (stderr) {
 		const alreadyExists = stderr.match(`${gitOrigin} already exists.`)
 		const successfulNewBranch = stderr.match('new branch')
@@ -120,7 +120,7 @@ export async function addRemote(repo: string): Promise<void> {
 
 export async function checkRemoteExists(): Promise<boolean> {
 	try {
-		const {stdout, stderr} = await exec('git remote -v')
+		const {stdout, stderr} = await node.exec('git remote -v')
 		if (stderr) {
 			return false
 		}

src/services/node/index.ts

@@ -1,26 +1,29 @@
 import * as fs from 'fs'
-import { join } from 'path'
-import { exec as cpExec } from 'child_process'
-import { promisify } from 'util'
+import {join} from 'path'
+import {exec as cpExec} from 'child_process'
+import {promisify} from 'util'
+import * as vscode from 'vscode'
 
 const asyncExec = promisify(cpExec)
 
-let workspaceRoot: string
+class Node {
+	private workspaceRoot: string
+	constructor() {
+		this.workspaceRoot = vscode.workspace.rootPath || ''
+		if (!this.workspaceRoot.length) {
+			throw new Error('Invalid workspaceRoot')
+		}
+		console.log(`workspaceRoot: ${this.workspaceRoot}`)
+	}
+	public exec = (cmd: string): Promise<{stdout: string; stderr: string}> => asyncExec(cmd, {
+		cwd: this.workspaceRoot,
+	})
 
-// set workspace root
-// other function will use this to target the correct cwd
-export function setWorkspaceRoot(rootPath: string): void {
-  workspaceRoot = rootPath
+	public exists = (...paths: string[]): boolean => fs.existsSync(join(this.workspaceRoot, ...paths))
 }
 
-export const exec = (cmd: string): Promise<{ stdout: string; stderr: string }> =>
-  asyncExec(cmd, {
-    cwd: workspaceRoot,
-  })
+export default new Node()
 
-// note: fs.exists is deprecated
-// collect all paths together
-export const exists = (...paths: string[]): boolean => fs.existsSync(join(workspaceRoot, ...paths))
 
 // export async function clear(): Promise<void> {
 //   // remove all files including ignored

web-app/src/services/state/actions/editor.ts

@@ -1,3 +1,4 @@
+import * as G from 'typings/graphql'
 import * as CR from 'typings'
 import * as selectors from '../../selectors'
 import channel from '../../channel'
@@ -31,7 +32,7 @@ export default {
 		})
 	},
 	loadLevel(context: CR.MachineContext): void {
-		const level = selectors.currentLevel(context)
+		const level: G.Level = selectors.currentLevel(context)
 		if (level.setup) {
 			// load step actions
 			channel.editorSend({
@@ -41,7 +42,7 @@ export default {
 		}
 	},
 	loadStage(context: CR.MachineContext): void {
-		const stage = selectors.currentStage(context)
+		const stage: G.Stage = selectors.currentStage(context)
 		if (stage.setup) {
 			// load step actions	
 			channel.editorSend({
@@ -51,7 +52,7 @@ export default {
 		}
 	},
 	loadStep(context: CR.MachineContext): void {
-		const step = selectors.currentStep(context)
+		const step: G.Step = selectors.currentStep(context)
 		if (step.setup) {
 			// load step actions
 			channel.editorSend({

web-app/src/services/state/machine.ts

@@ -105,7 +105,7 @@ export const machine = Machine<CR.MachineContext, CR.MachineStateSchema, CR.Mach
 					},
 					Stage: {
 						id: 'tutorial-stage',
-						onEntry: ['loadStage'],
+						onEntry: ['loadStage', 'loadStep'],
 						initial: 'Normal',
 						states: {
 							Normal: {