refactor storage into editor

src/editor/commands/loadSolution.ts

@@ -1,5 +1,5 @@
 import * as CR from 'typings'
-import * as storage from '../storage'
+import * as storage from '../../services/storage'
 import { gitLoadCommits, gitClear } from '../../services/git'
 
 export default async function loadSolution(): Promise<void> {

src/editor/commands/runTest.ts

@@ -1,6 +1,6 @@
 import { getOutputChannel } from '../channel'
 import { exec } from '../../services/node'
-import * as storage from '../storage'
+import * as storage from '../../services/storage'
 import * as testResult from '../../services/testResult'
 
 // ensure only latest run_test action is taken

src/editor/commands/tutorialLoad.ts

@@ -4,7 +4,7 @@ import * as CR from 'typings'
 import api from '../../services/api'
 import tutorialSetup from '../../services/tutorialSetup'
 import { loadProgressPosition } from '../../services/position'
-import * as storage from '../storage'
+import * as storage from '../../services/storage'
 import rootSetup from '../../services/rootSetup'
 import { isEmptyWorkspace, openReadme } from '../workspace'
 import * as git from '../../services/git'

src/editor/storage.ts

@@ -8,77 +8,11 @@ export function setStorage(workspaceState: vscode.Memento): void {
   storage = workspaceState
 }
 
-// TUTORIAL
-const STORE_TUTORIAL = 'coderoad:tutorial'
-
-export async function getTutorial(): Promise<CR.Tutorial | undefined> {
-  return storage.get(STORE_TUTORIAL)
-}
-
-export async function setTutorial(tutorial: CR.Tutorial): Promise<void> {
-  await storage.update(STORE_TUTORIAL, tutorial)
+export function get<T>(key: string): T | undefined {
+  return storage.get(key)
 }
 
-// POSITION
-const STORE_POSITION = 'coderoad:position'
-
-const defaultPosition = { levelId: '', stageId: '', stepId: '' }
-
-export async function getPosition(): Promise<CR.Position> {
-  const position: CR.Position | undefined = storage.get(STORE_POSITION)
-  return position || defaultPosition
+export function update<T>(key: string, value: string | Object): Thenable<void> {
+  return storage.update(key, value)
 }
 
-export async function setPosition(position: CR.Position): Promise<void> {
-  await storage.update(STORE_POSITION, position)
-}
-
-// PROGRESS
-const STORE_PROGRESS = 'coderoad:progress'
-
-const defaultProgress = { levels: {}, stages: {}, steps: {}, hints: {}, complete: false }
-
-export async function getProgress(): Promise<CR.Progress> {
-  const progress: CR.Progress | undefined = await storage.get(STORE_PROGRESS)
-  return progress || defaultProgress
-}
-
-export async function resetProgress(): Promise<void> {
-  await storage.update(STORE_PROGRESS, defaultProgress)
-}
-
-interface ProgressUpdate {
-  levels?: {
-    [levelId: string]: boolean
-  }
-  stages?: {
-    [stageid: string]: boolean
-  }
-  steps?: {
-    [stepId: string]: boolean
-  }
-}
-
-export async function updateProgress(record: ProgressUpdate): Promise<void> {
-  const progress = await getProgress()
-  if (record.levels) {
-    progress.levels = {
-      ...progress.levels,
-      ...record.levels,
-    }
-  }
-  if (record.stages) {
-    progress.stages = {
-      ...progress.stages,
-      ...record.stages,
-    }
-  }
-  if (record.steps) {
-    progress.steps = {
-      ...progress.steps,
-      ...record.steps,
-    }
-  }
-
-  await storage.update(STORE_PROGRESS, progress)
-}

src/services/position.ts

@@ -1,5 +1,5 @@
 import * as CR from 'typings'
-import * as storage from '../editor/storage'
+import * as storage from './storage'
 
 export async function getInitial(tutorial: CR.Tutorial): Promise<CR.Position> {
   const { data } = tutorial

src/services/storage.ts

@@ -0,0 +1,77 @@
+import * as CR from 'typings'
+import * as storage from '../editor/storage'
+
+// TUTORIAL
+const STORE_TUTORIAL = 'coderoad:tutorial'
+
+export async function getTutorial(): Promise<CR.Tutorial | undefined> {
+    return storage.get<CR.Tutorial>(STORE_TUTORIAL)
+}
+
+export async function setTutorial(tutorial: CR.Tutorial): Promise<void> {
+    await storage.update<CR.Tutorial>(STORE_TUTORIAL, tutorial)
+}
+
+// POSITION
+const STORE_POSITION = 'coderoad:position'
+
+const defaultPosition = { levelId: '', stageId: '', stepId: '' }
+
+export async function getPosition(): Promise<CR.Position> {
+    const position: CR.Position | undefined = storage.get<CR.Position>(STORE_POSITION)
+    return position || defaultPosition
+}
+
+export async function setPosition(position: CR.Position): Promise<void> {
+    await storage.update<CR.Position>(STORE_POSITION, position)
+}
+
+// PROGRESS
+const STORE_PROGRESS = 'coderoad:progress'
+
+const defaultProgress = { levels: {}, stages: {}, steps: {}, hints: {}, complete: false }
+
+export async function getProgress(): Promise<CR.Progress> {
+    const progress: CR.Progress | undefined = await storage.get<CR.Progress>(STORE_PROGRESS)
+    return progress || defaultProgress
+}
+
+export async function resetProgress(): Promise<void> {
+    await storage.update<CR.Progress>(STORE_PROGRESS, defaultProgress)
+}
+
+interface ProgressUpdate {
+    levels?: {
+        [levelId: string]: boolean
+    }
+    stages?: {
+        [stageid: string]: boolean
+    }
+    steps?: {
+        [stepId: string]: boolean
+    }
+}
+
+export async function updateProgress(record: ProgressUpdate): Promise<void> {
+    const progress = await getProgress()
+    if (record.levels) {
+        progress.levels = {
+            ...progress.levels,
+            ...record.levels,
+        }
+    }
+    if (record.stages) {
+        progress.stages = {
+            ...progress.stages,
+            ...record.stages,
+        }
+    }
+    if (record.steps) {
+        progress.steps = {
+            ...progress.steps,
+            ...record.steps,
+        }
+    }
+
+    await storage.update<CR.Progress>(STORE_PROGRESS, progress)
+}

src/services/testResult.ts

@@ -1,6 +1,6 @@
 import * as CR from 'typings'
 import * as vscode from 'vscode'
-import * as storage from '../editor/storage'
+import * as storage from './storage'
 
 
 export async function onSuccess(position: CR.Position) {

src/services/tutorialSetup.ts

@@ -1,6 +1,6 @@
 import * as CR from 'typings'
 import * as position from '../services/position'
-import * as storage from '../editor/storage'
+import * as storage from '../services/storage'
 import { isEmptyWorkspace } from '../editor/workspace'
 import { gitLoadCommits, gitInitIfNotExists, gitSetupRemote } from '../services/git'
 

src/state/actions/index.ts

@@ -1,6 +1,6 @@
 import { assign, send } from 'xstate'
 import * as CR from 'typings'
-import * as storage from '../../editor/storage'
+import * as storage from '../../services/storage'
 import * as git from '../../services/git'
 
 let initialTutorial: CR.Tutorial | undefined