validate extension version

Signed-off-by: shmck <shawn.j.mckay@gmail.com>

Author: ShMcK

errors/GitProjectAlreadyExists.md

@@ -1,5 +1,5 @@
-### Git Project Already Exists
+### Git Remote Already Exists
 
-CodeRoad requires an empty Git project.
+Have you started this tutorial before in this workspace? The Git remote already exists.
 
-Open a new workspace to start a tutorial.
+Consider deleting your `.git` folder and restarting.

errors/GitRemoteAlreadyExists.md

@@ -0,0 +1,5 @@
+### Git Project Already Exists
+
+CodeRoad requires an empty Git project.
+
+Open a new workspace to start a tutorial.

errors/UnmetExtensionVersion.md

@@ -0,0 +1,3 @@
+### Unmet Tutorial Dependency
+
+This tutorial requires a different version of CodeRoad.

errors/UnmetTutorialDependency.md

@@ -1,5 +1,3 @@
 ### Unmet Tutorial Dependency
 
-### Unmet Tutorial Dependency
-
 Tutorial cannot reun because a dependency version doesn't match. Install the correct dependency and click "Check Again".

src/channel/index.ts

@@ -2,6 +2,7 @@ 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 saveCommit from '../actions/saveCommit'
 import setupActions from '../actions/setupActions'
 import solutionActions from '../actions/solutionActions'
@@ -110,6 +111,25 @@ class Channel implements Channel {
       case 'EDITOR_TUTORIAL_CONFIG':
         try {
           const data: TT.Tutorial = action.payload.tutorial
+
+          // validate extension version
+          const expectedAppVersion = data.config?.appVersions?.coderoadVSCode
+          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 ${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)
 
@@ -121,7 +141,7 @@ class Channel implements Channel {
               const currentVersion: string | null = await version(dep.name)
               if (!currentVersion) {
                 // use a custom error message
-                const error = {
+                const error: E.ErrorMessage = {
                   type: 'MissingTutorialDependency',
                   message:
                     dep.message || `Process "${dep.name}" is required but not found. It may need to be installed`,
@@ -140,7 +160,7 @@ class Channel implements Channel {
               const satisfiedDependency = await compareVersions(currentVersion, dep.version)
 
               if (!satisfiedDependency) {
-                const error = {
+                const error: E.ErrorMessage = {
                   type: 'UnmetTutorialDependency',
                   message: `Expected ${dep.name} to have version ${dep.version}, but found version ${currentVersion}`,
                   actions: [
@@ -155,7 +175,7 @@ class Channel implements Channel {
               }
 
               if (satisfiedDependency !== true) {
-                const error = satisfiedDependency || {
+                const error: E.ErrorMessage = satisfiedDependency || {
                   type: 'UnknownError',
                   message: `Something went wrong comparing dependency for ${name}`,
                   actions: [

typings/error.d.ts

@@ -1,13 +1,16 @@
 export type ErrorMessageView = 'FULL_PAGE' | 'NOTIFY' | 'NONE'
 
 export type ErrorMessageType =
-  | 'UnknownError'
-  | 'NoWorkspaceFound'
-  | 'GitNotFound'
-  | 'WorkspaceNotEmpty'
   | 'FailedToConnectToGitRepo'
+  | 'GitNotFound'
   | 'GitProjectAlreadyExists'
   | 'GitRemoteAlreadyExists'
+  | 'MissingTutorialDependency'
+  | 'NoWorkspaceFound'
+  | 'UnknownError'
+  | 'UnmetExtensionVersion'
+  | 'UnmetTutorialDependency'
+  | 'WorkspaceNotEmpty'
 
 export type ErrorAction = {
   label: string

typings/tutorial.d.ts

@@ -1,6 +1,7 @@
 export type Maybe<T> = T | null
 
 export type TutorialConfig = {
+  appVersions: TutorialAppVersions
   testRunner: TutorialTestRunner
   repo: TutorialRepo
   dependencies?: TutorialDependency[]
@@ -64,3 +65,7 @@ export interface TutorialDependency {
   version: string
   message?: string
 }
+
+export interface TutorialAppVersions {
+  coderoadVSCode: string
+}