Merge pull request #389 from coderoad/feature/reset

Feature/reset

Author: ShMcK

src/channel/index.ts

@@ -18,6 +18,8 @@ import { openWorkspace, checkWorkspaceEmpty } from '../services/workspace'
 import { showOutput } from '../services/testRunner/output'
 import { exec } from '../services/node'
 import { WORKSPACE_ROOT, TUTORIAL_URL } from '../environment'
+import reset from '../services/reset'
+import getLastCommitHash from '../services/reset/lastHash'
 
 const readFileAsync = promisify(readFile)
 
@@ -320,17 +322,29 @@ class Channel implements Channel {
       case 'EDITOR_RUN_TEST':
         vscode.commands.executeCommand(COMMANDS.RUN_TEST, action?.payload)
         return
-      case 'EDITOR_RUN_RESET_SCRIPT':
+      case 'EDITOR_RUN_RESET':
+        // reset to timeline
         const tutorial: TT.Tutorial | null = this.context.tutorial.get()
+        const position: T.Position = this.context.position.get()
+
+        // get last pass commit
+        const hash = getLastCommitHash(position, tutorial?.levels || [])
+
+        const branch = tutorial?.config.repo.branch
+
+        if (!branch) {
+          console.error('No repo branch found for tutorial')
+          return
+        }
+
+        // load timeline until last pass commit
+        reset({ branch, hash })
+
         // if tutorial.config.reset.command, run it
         if (tutorial?.config?.reset?.command) {
           await exec({ command: tutorial.config.reset.command })
         }
         return
-      case 'EDITOR_RUN_RESET_TO_LAST_PASS':
-        return
-      case 'EDITOR_RUN_RESET_TO_TIMELINE':
-        return
       default:
         logger(`No match for action type: ${actionType}`)
         return

src/services/git/index.ts

@@ -1,9 +1,8 @@
 import * as TT from 'typings/tutorial'
 import { exec, exists } from '../node'
 import logger from '../logger'
-import { stringify } from 'querystring'
 
-const gitOrigin = 'coderoad'
+export const gitOrigin = 'coderoad'
 
 const stashAllFiles = async (): Promise<never | void> => {
   // stash files including untracked (eg. newly created file)

src/services/git/lastPass.ts

@@ -5,6 +5,7 @@ import { promisify } from 'util'
 import { WORKSPACE_ROOT } from '../../environment'
 
 const asyncExec = promisify(cpExec)
+const asyncRemoveFile = promisify(fs.unlink)
 
 interface ExecParams {
   command: string
@@ -19,3 +20,7 @@ export const exec = (params: ExecParams): Promise<{ stdout: string; stderr: stri
 export const exists = (...paths: string[]): boolean | never => {
   return fs.existsSync(join(WORKSPACE_ROOT, ...paths))
 }
+
+export const removeFile = (...paths: string[]) => {
+  return asyncRemoveFile(join(WORKSPACE_ROOT, ...paths))
+}

src/services/node/index.ts

@@ -0,0 +1,70 @@
+import { exec, removeFile } from '../node'
+
+interface Input {
+  hash: string
+  branch: string
+}
+
+const ignoreError = () => {}
+
+// note: attempted to do this as a bash script
+// but requires the bash script has git permissions
+const reset = async ({ branch, hash }: Input): Promise<void> => {
+  const remote = 'coderoad'
+
+  try {
+    // if no git init, will initialize
+    // otherwise re-initializes git
+    await exec({ command: 'git init' }).catch(console.log)
+
+    // capture current branch
+    const hasBranch = await exec({ command: 'git branch --show-current' })
+    const localBranch = hasBranch.stdout
+    // check if coderoad remote exists
+    const hasRemote = await exec({ command: 'git remote -v' }).catch(console.warn)
+    if (!hasRemote || !hasRemote.stdout || !hasRemote.stdout.length) {
+      throw new Error('No remote found')
+    } else if (!hasRemote.stdout.match(new RegExp(remote))) {
+      throw new Error(`No "${remote}" remote found`)
+    }
+
+    // switch to an empty branch
+    await exec({
+      command: 'git checkout --orphan reset-orphan-branch',
+    })
+    // stash any current work
+    await exec({
+      command: 'git stash',
+    }).catch(ignoreError)
+
+    // remove any other files
+    await exec({
+      command: 'git rm -rf .',
+    }).catch(ignoreError)
+    await removeFile('.gitignore').catch(ignoreError)
+
+    await exec({
+      command: `git branch -D ${localBranch}`,
+    })
+    await exec({
+      command: `git checkout -b ${localBranch}`,
+    })
+
+    // load git timeline
+    await exec({
+      command: `git fetch coderoad ${branch}`,
+    })
+    await exec({
+      command: `git merge coderoad/${branch}`,
+    })
+    // reset to target commit hash
+    await exec({
+      command: `git reset --hard ${hash}`,
+    })
+  } catch (error) {
+    console.error('Error resetting')
+    console.error(error.message)
+  }
+}
+
+export default reset

src/services/reset/index.ts

@@ -0,0 +1,56 @@
+import * as TT from '../../../typings/tutorial'
+import * as T from '../../../typings'
+import getLastCommitHash from './lastHash'
+
+describe('lastHash', () => {
+  it('should grab the last passing hash from a step', () => {
+    const position: T.Position = { levelId: '1', stepId: '1.2' }
+    const levels: TT.Level[] = [
+      {
+        id: '1',
+        title: '',
+        summary: '',
+        content: '',
+        steps: [
+          {
+            id: '1.1',
+            content: '',
+            setup: { commits: ['abcdef1'] },
+          },
+          {
+            id: '1.2',
+            content: '',
+            setup: { commits: ['abcdef2'] },
+          },
+        ],
+      },
+    ]
+    const result = getLastCommitHash(position, levels)
+    expect(result).toBe('abcdef2')
+  })
+  it('should grab the last passing hash from a step with several commits', () => {
+    const position: T.Position = { levelId: '1', stepId: '1.2' }
+    const levels: TT.Level[] = [
+      {
+        id: '1',
+        title: '',
+        summary: '',
+        content: '',
+        steps: [
+          {
+            id: '1.1',
+            content: '',
+            setup: { commits: ['abcdef1'] },
+          },
+          {
+            id: '1.2',
+            content: '',
+            setup: { commits: ['abcdef2', 'abcdef3'] },
+          },
+        ],
+      },
+    ]
+    const result = getLastCommitHash(position, levels)
+    expect(result).toBe('abcdef3')
+  })
+})

src/services/reset/lastHash.test.ts

@@ -0,0 +1,23 @@
+import * as TT from '../../../typings/tutorial'
+import * as T from '../../../typings'
+
+const getLastCommitHash = (position: T.Position, levels: TT.Level[]) => {
+  // get previous position
+  const { levelId, stepId } = position
+
+  const level: TT.Level | undefined = levels.find((l) => levelId === l.id)
+  if (!level) {
+    throw new Error(`No level found matching ${levelId}`)
+  }
+  const step = level.steps.find((s) => stepId === s.id)
+  if (!step) {
+    throw new Error(`No step found matching ${stepId}`)
+  }
+  const commits = step.setup.commits
+  if (!commits.length) {
+    throw new Error(`No commits found on step ${stepId}`)
+  }
+  return commits[commits.length - 1]
+}
+
+export default getLastCommitHash

src/services/reset/lastHash.ts

@@ -34,7 +34,7 @@ export type Step = {
   id: string
   content: string
   setup: StepActions
-  solution: Maybe<StepActions>
+  solution?: Maybe<StepActions>
   hints?: string[]
   subtasks?: string[]
 }

typings/tutorial.d.ts

@@ -12,7 +12,7 @@ import StepProgress from './components/StepProgress'
 import { DISPLAY_RUN_TEST_BUTTON } from '../../environment'
 import formatLevels from './formatLevels'
 // import SettingsPage from './containers/Settings'
-// import Reset from './components/Reset'
+import Reset from './components/Reset'
 
 const styles = {
   header: {
@@ -95,7 +95,7 @@ const TutorialPage = (props: PageProps) => {
   }
 
   const onReset = (): void => {
-    // TODO
+    props.send({ type: 'RUN_RESET' })
   }
 
   const [menuVisible, setMenuVisible] = React.useState(false)
@@ -148,7 +148,7 @@ const TutorialPage = (props: PageProps) => {
 
         {/* Center */}
         <div css={{ flex: 1, display: 'flex', justifyContent: 'center' }}>
-          {/* <Reset onReset={onReset} disabled={processes.length > 0} /> */}
+          <Reset onReset={onReset} disabled={processes.length > 0} />
         </div>
 
         {/* Right */}

web-app/src/containers/Tutorial/index.tsx

@@ -117,9 +117,9 @@ export default (editorSend: any) => ({
       payload: { position: context.position },
     })
   },
-  runResetScript() {
+  runReset() {
     editorSend({
-      type: 'EDITOR_RUN_RESET_SCRIPT',
+      type: 'EDITOR_RUN_RESET',
     })
   },
 })