cleanup event typings

ShMcK · ShMcK · commit 9257205bcde2 · 2020-01-25T19:14:00.000-08:00
diff --git a/src/channel/index.ts b/src/channel/index.ts
@@ -1,6 +1,6 @@
 import * as CR from 'typings'
 import * as G from 'typings/graphql'
-import { EditorEvent, ClientEvent } from 'typings/events'
+import { EditorEvents, ClientEvents } from 'typings/events'
 import * as vscode from 'vscode'
 import saveCommit from '../actions/saveCommit'
 import setupActions from '../actions/setupActions'
@@ -11,18 +11,18 @@ import logger from '../services/logger'
 import Context from './context'
 
 interface Channel {
-  receive(action: EditorEvent): Promise<void>
-  send(action: ClientEvent): Promise<void>
+  receive(action: EditorEvents): Promise<void>
+  send(action: ClientEvents): Promise<void>
 }
 
 interface ChannelProps {
-  postMessage: (action: ClientEvent) => Thenable<boolean>
+  postMessage: (action: ClientEvents) => Thenable<boolean>
   workspaceState: vscode.Memento
   workspaceRoot: vscode.WorkspaceFolder
 }
 
 class Channel implements Channel {
-  private postMessage: (action: ClientEvent) => Thenable<boolean>
+  private postMessage: (action: ClientEvents) => Thenable<boolean>
   private workspaceState: vscode.Memento
   private workspaceRoot: vscode.WorkspaceFolder
   private context: Context
@@ -35,7 +35,7 @@ class Channel implements Channel {
   }
 
   // receive from webview
-  public receive = async (action: EditorEvent) => {
+  public receive = async (action: EditorEvents) => {
     // action may be an object.type or plain string
     const actionType: string = typeof action === 'string' ? action : action.type
     const onError = (error: CR.ErrorMessage) => this.send({ type: 'ERROR', payload: { error } })
@@ -98,7 +98,7 @@ class Channel implements Channel {
         if (!tutorialContinue) {
           throw new Error('Invalid tutorial to continue')
         }
-        const continueConfig: T.TutorialConfig = tutorialContinue.version.data.config
+        const continueConfig: CR.TutorialConfig = tutorialContinue.version.data.config
         tutorialConfig(
           {
             config: continueConfig,
@@ -127,7 +127,7 @@ class Channel implements Channel {
     }
   }
   // send to webview
-  public send = async (action: ClientEvent) => {
+  public send = async (action: ClientEvents) => {
     // action may be an object.type or plain string
     const actionType: string = typeof action === 'string' ? action : action.type
     switch (actionType) {
diff --git a/tsconfig.json b/tsconfig.json
@@ -20,7 +20,8 @@
     "emitDecoratorMetadata": true,
     "paths": {
       "typings": ["../typings/index.d.ts"],
-      "typings/graphql": ["../typings/graphql.d.ts"]
+      "typings/graphql": ["../typings/graphql.d.ts"],
+      "typings/events": ["../typings/events.d.ts"]
     },
     "allowJs": true,
     "removeComments": true
diff --git a/web-app/src/components/Router/index.tsx b/web-app/src/components/Router/index.tsx
@@ -1,20 +1,21 @@
 import * as React from 'react'
+import { ClientEvents } from 'typings/events'
 import channel from '../../services/channel'
 import messageBusReceiver from '../../services/channel/receiver'
 import machine from '../../services/state/machine'
 import { useMachine } from '../../services/xstate-react'
 import debuggerWrapper from '../Debugger/debuggerWrapper'
 import Route from './Route'
 import onError from '../../services/sentry/onError'
-import { MachineContext, MachineEvent } from '../../services/state/machine'
+import { MachineContext } from '../../services/state/machine'
 
 interface Props {
   children: any
 }
 
 interface CloneElementProps {
   context: MachineContext
-  send(action: MachineEvent): void
+  send(action: ClientEvents): void
 }
 
 // TODO: rewrite router, logic is messy
diff --git a/web-app/src/containers/Continue/index.tsx b/web-app/src/containers/Continue/index.tsx
@@ -1,6 +1,7 @@
 import * as React from 'react'
+import { ClientEvents } from 'typings/events'
 import * as G from 'typings/graphql'
-import { MachineContext, MachineEvent } from '../../services/state/selectTutorial'
+import { MachineContext } from '../../services/state/selectTutorial'
 import { css, jsx } from '@emotion/core'
 import Button from '../../components/Button'
 import Card from '../../components/Card'
@@ -48,7 +49,7 @@ export const ContinuePage = (props: Props) => (
 
 interface ContainerProps {
   context: MachineContext
-  send(action: MachineEvent): void
+  send(action: ClientEvents): void
 }
 
 const ContinuePageContainer = ({ context, send }: ContainerProps) => {
diff --git a/web-app/src/containers/New/index.tsx b/web-app/src/containers/New/index.tsx
@@ -1,14 +1,15 @@
 import { useQuery } from '@apollo/react-hooks'
 import * as React from 'react'
+import { ClientEvents } from 'typings/events'
 import * as G from 'typings/graphql'
-import { MachineContext, MachineEvent } from '../../services/state/selectTutorial'
+import { MachineContext } from '../../services/state/selectTutorial'
 import ErrorView from '../../components/Error'
 import queryTutorials from '../../services/apollo/queries/tutorials'
 import LoadingPage from '../LoadingPage'
 import NewPage from './NewPage'
 
 interface ContainerProps {
-  send(action: MachineEvent): void
+  send(action: ClientEvents): void
   context: MachineContext
 }
 
diff --git a/web-app/src/containers/Overview/index.tsx b/web-app/src/containers/Overview/index.tsx
@@ -1,14 +1,15 @@
 import { useQuery } from '@apollo/react-hooks'
 import * as React from 'react'
 import * as G from 'typings/graphql'
+import { ClientEvents } from 'typings/events'
 import ErrorView from '../../components/Error'
 import queryTutorial from '../../services/apollo/queries/tutorial'
 import OverviewPage from './OverviewPage'
-import { MachineContext, MachineEvent } from '../../services/state/selectTutorial'
+import { MachineContext } from '../../services/state/selectTutorial'
 
 interface PageProps {
   context: MachineContext
-  send(action: MachineEvent): void
+  send(action: ClientEvents): void
 }
 
 interface TutorialData {
diff --git a/web-app/src/containers/Tutorial/CompletedPage.tsx b/web-app/src/containers/Tutorial/CompletedPage.tsx
@@ -1,5 +1,6 @@
 import * as React from 'react'
-import { MachineContext, MachineEvent } from '../../services/state/playTutorial'
+import { ClientEvents } from 'typings/events'
+import { MachineContext } from '../../services/state/playTutorial'
 import { css, jsx } from '@emotion/core'
 import Button from '../../components/Button'
 
@@ -11,7 +12,7 @@ const styles = {
 
 interface Props {
   context: MachineContext
-  send(action: MachineEvent): void
+  send(action: ClientEvents): void
 }
 
 const CompletedPage = (props: Props) => {
diff --git a/web-app/src/services/channel/index.ts b/web-app/src/services/channel/index.ts
@@ -1,11 +1,11 @@
 import * as CR from 'typings'
 import * as G from 'typings/graphql'
-import { EditorEvent, ClientEvent } from 'typings/events'
+import { EditorEvents, ClientEvents } from 'typings/events'
 
 declare let acquireVsCodeApi: any
 
 interface ReceivedEvent {
-  data: ClientEvent
+  data: ClientEvents
 }
 
 class Channel {
@@ -23,10 +23,10 @@ class Channel {
     this.editorSend = editor.postMessage
   }
 
-  public machineSend = (event: ClientEvent) => {
+  public machineSend = (event: ClientEvents) => {
     /* implemented by `setMachineSend` in router on startup */
   }
-  public editorSend = (event: EditorEvent) => {
+  public editorSend = (event: EditorEvents) => {
     /* */
   }
 
diff --git a/web-app/src/services/channel/mock.ts b/web-app/src/services/channel/mock.ts
@@ -1,25 +1,25 @@
-import { Action } from 'typings'
+import { ClientEvents } from 'typings/events'
 import channel from './index'
 
-const createReceiveEvent = (action: Action) => ({
+const createReceiveEvent = (action: ClientEvents) => ({
   data: action,
 })
 
 // mock vscode from client side development
 // @ts-ignore
 window.acquireVsCodeApi = () => ({
-  postMessage(action: Action) {
+  postMessage(action: ClientEvents) {
     switch (action.type) {
       case 'TUTORIAL_START':
         return setTimeout(() => {
-          const receiveAction: Action = {
+          const receiveAction: ClientEvents = {
             type: 'TUTORIAL_LOADED',
           }
           channel.receive(createReceiveEvent(receiveAction))
         }, 1000)
       case 'TEST_RUN':
         return setTimeout(() => {
-          const receiveAction: Action = {
+          const receiveAction: ClientEvents = {
             type: 'TEST_PASS',
             payload: action.payload,
           }
diff --git a/web-app/src/services/state/authenticate/actions.ts b/web-app/src/services/state/authenticate/actions.ts
@@ -1,6 +1,6 @@
 import * as CR from 'typings'
 import * as G from 'typings/graphql'
-import { AuthenticateEvent, EnvGetEvent } from 'typings/events'
+import { AuthenticateEvents, EnvGetEvent } from 'typings/events'
 import { assign, ActionFunctionMap } from 'xstate'
 import client from '../../apollo'
 import { setAuthToken } from '../../apollo/auth'
@@ -22,7 +22,7 @@ interface AuthenticateVariables {
   editor: 'VSCODE'
 }
 
-const actions: ActionFunctionMap<MachineContext, AuthenticateEvent> = {
+const actions: ActionFunctionMap<MachineContext, AuthenticateEvents> = {
   // @ts-ignore
   setEnv: assign({
     env: (context: MachineContext, event: EnvGetEvent): CR.Environment => ({
diff --git a/web-app/src/services/state/authenticate/index.ts b/web-app/src/services/state/authenticate/index.ts
@@ -1,5 +1,5 @@
 import * as CR from 'typings'
-import { AuthenticateEvent } from 'typings/events'
+import { AuthenticateEvents } from 'typings/events'
 import { Machine } from 'xstate'
 import actions from './actions'
 
@@ -20,7 +20,7 @@ const options = {
   actions,
 }
 
-export const authenticateMachine = Machine<MachineContext, StateSchema, AuthenticateEvent>(
+export const authenticateMachine = Machine<MachineContext, StateSchema, AuthenticateEvents>(
   {
     id: 'authenticate',
     context: {
diff --git a/web-app/src/services/state/selectTutorial/actions.ts b/web-app/src/services/state/selectTutorial/actions.ts
@@ -19,11 +19,6 @@ interface TutorialDataVariables {
 }
 
 const actionMap: ActionFunctionMap<MachineContext, Event.SelectTutorialEvents> = {
-  loadEnv(): void {
-    channel.editorSend({
-      type: 'ENV_GET',
-    })
-  },
   loadStoredTutorial(): void {
     // send message to editor to see if there is existing tutorial progress
     // in local storage on the editor
@@ -81,10 +76,10 @@ const actionMap: ActionFunctionMap<MachineContext, Event.SelectTutorialEvents> =
   //     },
   //   })
   // },
-  initPositionAndProgress: assign((context: MachineContext, event: Event.LoadTutorialEvent) => ({
-    position: selectors.initialPosition(event.payload),
-    progress: selectors.defaultProgress(),
-  })),
+  // initPositionAndProgress: assign((context: MachineContext, event: Event.LoadTutorialEvent) => ({
+  //   position: selectors.initialPosition(event.payload),
+  //   progress: selectors.defaultProgress(),
+  // })),
   clearStorage(): void {
     channel.editorSend({ type: 'TUTORIAL_CLEAR' })
   },

Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,11 @@`
`1`	`1`	`import * as CR from 'typings'`
`2`	`2`	`import * as G from 'typings/graphql'`
`3`		`-import { EditorEvent, ClientEvent } from 'typings/events'`
	`3`	`+import { EditorEvents, ClientEvents } from 'typings/events'`
`4`	`4`
`5`	`5`	`declare let acquireVsCodeApi: any`
`6`	`6`
`7`	`7`	`interface ReceivedEvent {`
`8`		`- data: ClientEvent`
	`8`	`+ data: ClientEvents`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`class Channel {`
`@@ -23,10 +23,10 @@ class Channel {`
`23`	`23`	`this.editorSend = editor.postMessage`
`24`	`24`	`}`
`25`	`25`
`26`		`- public machineSend = (event: ClientEvent) => {`
	`26`	`+ public machineSend = (event: ClientEvents) => {`
`27`	`27`	/* implemented by `setMachineSend` in router on startup */
`28`	`28`	`}`
`29`		`- public editorSend = (event: EditorEvent) => {`
	`29`	`+ public editorSend = (event: EditorEvents) => {`
`30`	`30`	`/* */`
`31`	`31`	`}`
`32`	`32`