Merge pull request #24 from ShMcK/feature/commit-consistency

Feature/commit consistency

Author: ShMcK

package-lock.json

@@ -53,7 +53,7 @@
   },
   "devDependencies": {
     "@types/mocha": "^5.2.7",
-    "@types/node": "^12.6.2",
+    "@types/node": "^12.6.8",
     "concurrently": "^4.1.1",
     "prettier": "^1.18.2",
     "tslint": "^5.18.0",

package.json

@@ -89,13 +89,6 @@ export const createCommands = ({ context, machine, storage, git, position }: Cre
       // TODO: use actual tutorial repo
       await Promise.all([git.gitSetupRemote(tutorial.meta.repo), storage.setTutorial(tutorial), storage.resetProgress()])
 
-      // TODO: refactor to allow client to call initialization
-      const pos: CR.Position = await position.getInitial(tutorial)
-
-      // eslint-disable-next-line
-      const { steps } = tutorial.data
-      const { setup } = steps[pos.stepId].actions
-      await git.gitLoadCommits(setup, dispatch)
       machine.send('TUTORIAL_LOADED')
     },
     [COMMANDS.TUTORIAL_SETUP]: async (tutorial: CR.Tutorial) => {

src/editor/commands/index.ts

@@ -3,20 +3,51 @@ import { exec, exists } 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`)
+  if (stderr) {
+    console.error(stderr)
+    throw new Error('Error stashing files')
+  }
+}
+
+const cherryPickCommit = async (commit: string, count = 0): Promise<void> => {
+  if (count > 1) {
+    console.warn('cherry-pick failed')
+    return
+  }
+  try {
+    const { stdout } = await exec(`git cherry-pick ${commit}`)
+    if (!stdout) {
+      throw new Error('No cherry-pick output')
+    }
+  } catch (error) {
+    console.log('cherry-pick-commit failed')
+    // stash all files if cherry-pick fails
+    await stashAllFiles()
+    return cherryPickCommit(commit, ++count)
+  }
+}
+
+const errorMessages = {
+  js: {
+    'node-gyp': 'Error running npm setup command'
+  }
+}
+
 /*
     SINGLE git cherry-pick %COMMIT%
-    MULTIPLE git cherry-pick %COMMIT_START%..%COMMIT_END%
-    if shell, run shell
+    if fails, will stash all and retry
 */
 export async function gitLoadCommits(actions: CR.TutorialAction, dispatch: CR.EditorDispatch): Promise<void> {
   const { commits, commands, files } = actions
 
   for (const commit of commits) {
-    const { stdout, stderr } = await exec(`git cherry-pick ${commit}`)
-    if (stderr) {
-      console.error(stderr)
-      throw new Error('Error loading commit')
-    }
+    // pull a commit from tutorial repo
+    console.log(`try cherry-pick ${commit}`)
+    await cherryPickCommit(commit)
   }
 
   if (commands) {
@@ -25,10 +56,12 @@ export async function gitLoadCommits(actions: CR.TutorialAction, dispatch: CR.Ed
       const { stdout, stderr } = await exec(command)
       if (stderr) {
         console.error(stderr)
-
-        if (stderr.match(/node-gyp/)) {
-          // ignored error
-          throw new Error('Error running setup command')
+        // langauge specific error messages from running commands
+        for (const message of Object.keys(errorMessages.js)) {
+          if (stderr.match(message)) {
+            // ignored error
+            throw new Error('Error running setup command')
+          }
         }
       }
       console.log(`run command: ${command}`, stdout)

src/services/git/index.ts

@@ -107,8 +107,9 @@ export default (dispatch: CR.EditorDispatch) => ({
   testStart() {
     dispatch('coderoad.run_test')
   },
-  testPass() {
+  testPass(context: CR.MachineContext): void {
     dispatch('coderoad.test_pass')
+    git.gitSaveCommit(context.position)
   },
   testFail() {
     dispatch('coderoad.test_fail')
@@ -157,18 +158,34 @@ export default (dispatch: CR.EditorDispatch) => ({
       return nextPosition
     },
   }),
-  loadLevel() {
+  loadLevel(context: CR.MachineContext): void {
+    const { data, position } = context
     console.log('loadLevel')
+    console.log(position)
+    const { levels } = data
+    const level = levels[position.levelId]
+
+    // run level setup if it exists
+    if (level && level.actions && level.actions.setup) {
+      git.gitLoadCommits(level.actions.setup, dispatch)
+    }
   },
   stageLoadNext(context: CR.MachineContext) {
     console.log('stageLoadNext')
     const { position } = context
     console.log(position)
   },
   loadStage(context: CR.MachineContext): void {
+    const { data, position } = context
     console.log('loadStage')
-    const { position } = context
     console.log(position)
+    const { stages } = data
+    const stage = stages[position.levelId]
+
+    // run level setup if it exists
+    if (stage && stage.actions && stage.actions.setup) {
+      git.gitLoadCommits(stage.actions.setup, dispatch)
+    }
   },
   // @ts-ignore
   updatePosition: assign({

src/state/actions/index.ts

@@ -17,16 +17,29 @@ const basic: CR.Tutorial = {
     summary: {
       title: 'Basic Test',
       description: 'A basic coding skills example',
-      levelList: ['level1Id'],
+      levelList: ['level1Id', 'level2Id'],
     },
     levels: {
       level1Id: {
         stageList: ['stage1Id', 'stage2Id'],
         content: {
-          title: 'Sum Level',
+          title: 'Operators',
           text: 'A description of this stage',
         },
+        actions: {
+          setup: {
+            commits: ['aab5f3d'],
+            commands: ['npm install'],
+          }
+        }
       },
+      level2Id: {
+        stageList: ['a'],
+        content: {
+          title: 'Logic',
+          text: 'Some basic logic in level 2'
+        }
+      }
     },
     stages: {
       stage1Id: {
@@ -42,7 +55,14 @@ const basic: CR.Tutorial = {
           title: 'Second Stage',
           text: 'Going into round 2'
         }
-      }
+      },
+      a: {
+        stepList: ['a1', 'a2'],
+        content: {
+          title: 'Part 1',
+          text: 'Going into round 1'
+        }
+      },
     },
     steps: {
       step1Id: {
@@ -52,12 +72,11 @@ const basic: CR.Tutorial = {
         },
         actions: {
           setup: {
-            commits: ['430500f', '8383061'],
-            commands: ['npm install'],
+            commits: ['8fa5ad5'],
             files: ['src/sum.js'],
           },
           solution: {
-            commits: ['abbe136'],
+            commits: ['abe3123'],
           },
         },
         hints: [],
@@ -69,11 +88,11 @@ const basic: CR.Tutorial = {
         },
         actions: {
           setup: {
-            commits: ['9cbb518'],
+            commits: ['0e01df8'],
             files: ['src/multiply.js'],
           },
           solution: {
-            commits: ['5ae011f'],
+            commits: ['1b9a520'],
           },
         },
         hints: [],
@@ -85,11 +104,11 @@ const basic: CR.Tutorial = {
         },
         actions: {
           setup: {
-            commits: ['70c774c'],
+            commits: ['40802cf'],
             files: ['src/divide.js'],
           },
           solution: {
-            commits: ['3180bed'],
+            commits: ['b321a3d'],
           },
         },
         hints: [],
@@ -101,11 +120,11 @@ const basic: CR.Tutorial = {
         },
         actions: {
           setup: {
-            commits: ['16d9699'],
+            commits: ['4db40b4'],
             files: ['src/modulo.js'],
           },
           solution: {
-            commits: ['bbf8aa5']
+            commits: ['3580c9d']
           }
         }
       },
@@ -116,11 +135,41 @@ const basic: CR.Tutorial = {
         },
         actions: {
           setup: {
-            commits: ['683c8db'],
+            commits: ['abc1e2d'],
             files: ['src/power.js'],
           },
           solution: {
-            commits: ['deaf3a8']
+            commits: ['5d28c25']
+          }
+        }
+      },
+      a1: {
+        content: {
+          title: 'Hello',
+          text: 'Return the word "hello"'
+        },
+        actions: {
+          setup: {
+            commits: ['d2c5827'],
+            files: ['src/hello.js'],
+          },
+          solution: {
+            commits: ['f668bf7']
+          }
+        }
+      },
+      a2: {
+        content: {
+          title: 'Bye',
+          text: 'Return the word "bye"'
+        },
+        actions: {
+          setup: {
+            commits: ['3aa0ccd'],
+            files: ['src/hello.js'],
+          },
+          solution: {
+            commits: ['9897785']
           }
         }
       },

src/tutorials/basic.ts

@@ -20,7 +20,8 @@
     "emitDecoratorMetadata": true,
     "paths": {
       "typings": ["../typings/index.d.ts"]
-    }
+    },
+    "allowJs": true
   },
   "exclude": ["node_modules", ".vscode-test", "build", "resources", "web-app"]
 }

tsconfig.json

@@ -6,6 +6,9 @@ export interface TutorialLevel {
     title: string
     text: string
   }
+  actions?: {
+    setup: TutorialAction
+  }
 }
 
 export interface TutorialStage {
@@ -14,6 +17,9 @@ export interface TutorialStage {
     title: string
     text: string
   }
+  actions?: {
+    setup: TutorialAction
+  }
 }
 
 export interface TutorialHint {