refactor onTutorialConfig

Signed-off-by: shmck <[email protected]>

src/actions/index.ts

@@ -1,3 +1,4 @@
 export { default as onStartup } from './onStartup'
+export { default as onTutorialConfig } from './onTutorialConfig'
 export { default as onErrorPage } from './onErrorPage'
 export { default as onTestPass } from './onTestPass'

src/actions/onTutorialConfig.ts

@@ -0,0 +1,121 @@
+import * as vscode from 'vscode'
+import * as T from 'typings'
+import * as TT from 'typings/tutorial'
+import * as E from 'typings/error'
+import { satisfies } from 'semver'
+import { onEvent } from '../services/telemetry'
+import { version, compareVersions } from '../services/dependencies'
+import Context from '../services/context/context'
+import tutorialConfig from './utils/tutorialConfig'
+
+const onTutorialConfig = async (action: T.Action, context: Context, workspaceState: vscode.Memento, send: any) => {
+  try {
+    const data: TT.Tutorial = action.payload.tutorial
+
+    onEvent('tutorial_start', {
+      tutorial_id: data.id,
+      tutorial_version: data.version,
+      tutorial_title: data.summary.title,
+    })
+
+    // validate extension version
+    const expectedAppVersion = data.config?.appVersions?.vscode
+    if (expectedAppVersion) {
+      const extension = vscode.extensions.getExtension('coderoad.coderoad')
+      if (extension) {
+        const currentAppVersion = extension.packageJSON.version
+        const satisfied = satisfies(currentAppVersion, expectedAppVersion)
+        if (!satisfied) {
+          const error: E.ErrorMessage = {
+            type: 'UnmetExtensionVersion',
+            message: `Expected CodeRoad v${expectedAppVersion}, but found v${currentAppVersion}`,
+          }
+          send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
+          return
+        }
+      }
+    }
+
+    // setup tutorial config (save watcher, test runner, etc)
+    await context.setTutorial(workspaceState, data)
+
+    // validate dependencies
+    const dependencies = data.config.dependencies
+    if (dependencies && dependencies.length) {
+      for (const dep of dependencies) {
+        // check dependency is installed
+        const currentVersion: string | null = await version(dep.name)
+        if (!currentVersion) {
+          // use a custom error message
+          const error: E.ErrorMessage = {
+            type: 'MissingTutorialDependency',
+            message: dep.message || `Process "${dep.name}" is required but not found. It may need to be installed`,
+            actions: [
+              {
+                label: 'Check Again',
+                transition: 'TRY_AGAIN',
+              },
+            ],
+          }
+          send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
+          return
+        }
+
+        // check dependency version
+        const satisfiedDependency = await compareVersions(currentVersion, dep.version)
+
+        if (!satisfiedDependency) {
+          const error: E.ErrorMessage = {
+            type: 'UnmetTutorialDependency',
+            message: `Expected ${dep.name} to have version ${dep.version}, but found version ${currentVersion}`,
+            actions: [
+              {
+                label: 'Check Again',
+                transition: 'TRY_AGAIN',
+              },
+            ],
+          }
+          send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
+          return
+        }
+
+        if (satisfiedDependency !== true) {
+          const error: E.ErrorMessage = satisfiedDependency || {
+            type: 'UnknownError',
+            message: `Something went wrong comparing dependency for ${name}`,
+            actions: [
+              {
+                label: 'Try Again',
+                transition: 'TRY_AGAIN',
+              },
+            ],
+          }
+          send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
+          return
+        }
+      }
+    }
+
+    const error: E.ErrorMessage | void = await tutorialConfig({ data }).catch((error: Error) => ({
+      type: 'UnknownError',
+      message: `Location: tutorial config.\n\n${error.message}`,
+    }))
+
+    // has error
+    if (error && error.type) {
+      send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
+      return
+    }
+
+    // report back to the webview that setup is complete
+    send({ type: 'TUTORIAL_CONFIGURED' })
+  } catch (e) {
+    const error = {
+      type: 'UnknownError',
+      message: `Location: EditorTutorialConfig.\n\n ${e.message}`,
+    }
+    send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
+  }
+}
+
+export default onTutorialConfig

src/actions/tutorialConfig.ts → src/actions/utils/tutorialConfig.ts

@@ -1,9 +1,9 @@
 import * as E from 'typings/error'
 import * as TT from 'typings/tutorial'
 import * as vscode from 'vscode'
-import { COMMANDS } from '../commands'
-import * as git from '../services/git'
-import { DISABLE_RUN_ON_SAVE } from '../environment'
+import { COMMANDS } from '../../commands'
+import * as git from '../../services/git'
+import { DISABLE_RUN_ON_SAVE } from '../../environment'
 
 interface TutorialConfigParams {
   data: TT.Tutorial

src/channel.ts

@@ -2,19 +2,18 @@ import * as T from 'typings'
 import * as TT from 'typings/tutorial'
 import * as E from 'typings/error'
 import * as vscode from 'vscode'
-import { satisfies } from 'semver'
 import { setupActions, solutionActions } from './actions/setupActions'
-import tutorialConfig from './actions/tutorialConfig'
+import tutorialConfig from './actions/utils/tutorialConfig'
 import { COMMANDS } from './commands'
 import Context from './services/context/context'
 import logger from './services/logger'
-import { version, compareVersions } from './services/dependencies'
+import { version } from './services/dependencies'
 import { openWorkspace, checkWorkspaceEmpty } from './services/workspace'
 import { showOutput } from './services/testRunner/output'
 import { exec } from './services/node'
 import reset from './services/reset'
 import getLastCommitHash from './services/reset/lastHash'
-import { onEvent } from './services/telemetry'
+
 import * as actions from './actions'
 
 interface Channel {
@@ -58,114 +57,7 @@ class Channel implements Channel {
         return
       // configure test runner, language, git
       case 'EDITOR_TUTORIAL_CONFIG':
-        try {
-          const data: TT.Tutorial = action.payload.tutorial
-
-          onEvent('tutorial_start', {
-            tutorial_id: data.id,
-            tutorial_version: data.version,
-            tutorial_title: data.summary.title,
-          })
-
-          // validate extension version
-          const expectedAppVersion = data.config?.appVersions?.vscode
-          if (expectedAppVersion) {
-            const extension = vscode.extensions.getExtension('coderoad.coderoad')
-            if (extension) {
-              const currentAppVersion = extension.packageJSON.version
-              const satisfied = satisfies(currentAppVersion, expectedAppVersion)
-              if (!satisfied) {
-                const error: E.ErrorMessage = {
-                  type: 'UnmetExtensionVersion',
-                  message: `Expected CodeRoad v${expectedAppVersion}, but found v${currentAppVersion}`,
-                }
-                this.send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
-                return
-              }
-            }
-          }
-
-          // setup tutorial config (save watcher, test runner, etc)
-          await this.context.setTutorial(this.workspaceState, data)
-
-          // validate dependencies
-          const dependencies = data.config.dependencies
-          if (dependencies && dependencies.length) {
-            for (const dep of dependencies) {
-              // check dependency is installed
-              const currentVersion: string | null = await version(dep.name)
-              if (!currentVersion) {
-                // use a custom error message
-                const error: E.ErrorMessage = {
-                  type: 'MissingTutorialDependency',
-                  message:
-                    dep.message || `Process "${dep.name}" is required but not found. It may need to be installed`,
-                  actions: [
-                    {
-                      label: 'Check Again',
-                      transition: 'TRY_AGAIN',
-                    },
-                  ],
-                }
-                this.send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
-                return
-              }
-
-              // check dependency version
-              const satisfiedDependency = await compareVersions(currentVersion, dep.version)
-
-              if (!satisfiedDependency) {
-                const error: E.ErrorMessage = {
-                  type: 'UnmetTutorialDependency',
-                  message: `Expected ${dep.name} to have version ${dep.version}, but found version ${currentVersion}`,
-                  actions: [
-                    {
-                      label: 'Check Again',
-                      transition: 'TRY_AGAIN',
-                    },
-                  ],
-                }
-                this.send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
-                return
-              }
-
-              if (satisfiedDependency !== true) {
-                const error: E.ErrorMessage = satisfiedDependency || {
-                  type: 'UnknownError',
-                  message: `Something went wrong comparing dependency for ${name}`,
-                  actions: [
-                    {
-                      label: 'Try Again',
-                      transition: 'TRY_AGAIN',
-                    },
-                  ],
-                }
-                this.send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
-                return
-              }
-            }
-          }
-
-          const error: E.ErrorMessage | void = await tutorialConfig({ data }).catch((error: Error) => ({
-            type: 'UnknownError',
-            message: `Location: tutorial config.\n\n${error.message}`,
-          }))
-
-          // has error
-          if (error && error.type) {
-            this.send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
-            return
-          }
-
-          // report back to the webview that setup is complete
-          this.send({ type: 'TUTORIAL_CONFIGURED' })
-        } catch (e) {
-          const error = {
-            type: 'UnknownError',
-            message: `Location: EditorTutorialConfig.\n\n ${e.message}`,
-          }
-          this.send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })
-        }
+        actions.onTutorialConfig(action, this.context, this.workspaceState, this.send)
         return
       case 'EDITOR_TUTORIAL_CONTINUE_CONFIG':
         try {