Commit94f483b

authored

add onContinue hook (#561)

* add onContinue hookSigned-off-by: shmck <shawn.j.mckay@gmail.com>* cleanup typoSigned-off-by: shmck <shawn.j.mckay@gmail.com>

1 parent122bd53 commit94f483bCopy full SHA for 94f483b

File tree

+42

-4

lines changed

+42

-4

lines changed

Lines changed: 8 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,12 @@ All notable changes to the "coderoad-vscode" extension will be documented in thi`
`4`	`4`
`5`	`5`	`Check[Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.`
`6`	`6`
	`7`	`+#[0.19.0]`
	`8`	`+`
	`9`	`+- Add the ability to run scripts on continue to address an issue where continued tutorials weren't configured correctly.`
	`10`	`+- adds a "continue" webhook`
	`11`	+- adds a`tutorial.config.continue` that lets you run`commands` or`vscodeCommands`
	`12`	`+`
`7`	`13`	`##[0.18.0]`
`8`	`14`
`9`	`15`	`- Improved error logging in output channel "CodeRoad (Logs)"`
`@@ -18,10 +24,10 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how`
`18`	`24`
`19`	`25`	`##[0.17.0]`
`20`	`26`
`21`		`--auto-launch a continued tutorial`
	`27`	`+-Auto-launch a continued tutorial`
`22`	`28`	`##[0.16.0]`
`23`	`29`
`24`		`--add support for writing session state to a file. This is useful in multi-container environments where local storage is not necessarily preserved across sessions.`
	`30`	`+-Add support for writing session state to a file. This is useful in multi-container environments where local storage is not necessarily preserved across sessions.`
`25`	`31`
`26`	`32`	`##[0.15.1]`
`27`	`33`

Lines changed: 10 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import tutorialConfig from './utils/tutorialConfig'`
`6`	`6`	`import{COMMANDS,send}from'../commands'`
`7`	`7`	`importloggerfrom'../services/logger'`
`8`	`8`	`import{setupWebhook}from'../services/hooks/webhooks'`
	`9`	`+import*ashooksfrom'../services/hooks'`
`9`	`10`
`10`	`11`	`constonTutorialConfigContinue=async(action:T.Action,context:Context):Promise<void>=>{`
`11`	`12`	`try{`
`@@ -25,6 +26,15 @@ const onTutorialConfigContinue = async (action: T.Action, context: Context): Pro`
`25`	`26`	`if(tutorialToContinue.config?.webhook){`
`26`	`27`	`setupWebhook(tutorialToContinue.config.webhook)`
`27`	`28`	`}`
	`29`	`+`
	`30`	`+// if tutorial.config.reset.command, run it`
	`31`	`+constcontinueActions=tutorialToContinue?.config?.continue`
	`32`	`+if(continueActions){`
	`33`	`+hooks.onContinue(`
	`34`	`+{commands:continueActions?.commands,vscodeCommands:continueActions?.vscodeCommands},`
	`35`	`+tutorialToContinue?.idasstring,`
	`36`	`+)`
	`37`	`+}`
`28`	`38`	`}catch(e:any){`
`29`	`39`	`consterror={`
`30`	`40`	`type:'UnknownError',`

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,15 @@ export const onReset = async (actions: TT.StepActions, tutorialId: string): Prom`
`56`	`56`	`})`
`57`	`57`	`}`
`58`	`58`
	`59`	`+// run when a tutorial is continued`
	`60`	`+exportconstonContinue=async(actions:TT.StepActions,tutorialId:string):Promise<void>=>{`
	`61`	`+awaitrunCommands(actions?.commands)`
	`62`	`+awaitrunVSCodeCommands(actions?.vscodeCommands)`
	`63`	`+webhooks.onContinue({`
	`64`	`+ tutorialId,`
	`65`	`+})`
	`66`	`+}`
	`67`	`+`
`59`	`68`	`// run when an uncaught exception is thrown`
`60`	`69`	`exportconstonError=async(error:Error):Promise<void>=>{`
`61`	`70`	`telemetry.onError(error)`

Lines changed: 11 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import { WEBHOOK_TOKEN } from '../../environment'`
`6`	`6`	`constWEBHOOK_EVENTS={`
`7`	`7`	`init:false,`
`8`	`8`	`reset:false,`
	`9`	`+continue:false,`
`9`	`10`	`step_complete:false,`
`10`	`11`	`level_complete:false,`
`11`	`12`	`tutorial_complete:false,`
`@@ -76,6 +77,16 @@ export const onReset = (event: WebhookEventReset): void => {`
`76`	`77`	`}`
`77`	`78`	`}`
`78`	`79`
	`80`	`+typeWebhookEventContinue={`
	`81`	`+tutorialId:string`
	`82`	`+}`
	`83`	`+`
	`84`	`+exportconstonContinue=(event:WebhookEventReset):void=>{`
	`85`	`+if(WEBHOOK_EVENTS.continue){`
	`86`	`+callWebhookEndpoint<WebhookEventContinue>(event)`
	`87`	`+}`
	`88`	`+}`
	`89`	`+`
`79`	`90`	`typeWebhookEventStepComplete={tutorialId:string;version?:string;levelId:string;stepId:string}`
`80`	`91`
`81`	`92`	`exportconstonStepComplete=(event:WebhookEventStepComplete):void=>{`

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import { ProgressStatus } from './index'`
`2`	`2`
`3`	`3`	`exporttypeMaybe<T>=T\|null`
`4`	`4`
`5`		`-exporttypeConfigReset={`
	`5`	`+exporttypeConfigCommands={`
`6`	`6`	`commands?:string[]`
`7`	`7`	`vscodeCommands?:VSCodeCommand[]`
`8`	`8`	`}`
`@@ -13,7 +13,8 @@ export type TutorialConfig = {`
`13`	`13`	`repo:TutorialRepo`
`14`	`14`	`dependencies?:TutorialDependency[]`
`15`	`15`	`setup?:StepActions`
`16`		`-reset?:ConfigReset`
	`16`	`+continue?:ConfigCommands`
	`17`	`+reset?:ConfigCommands`
`17`	`18`	`webhook?:WebhookConfig`
`18`	`19`	`}`
`19`	`20`
`@@ -97,6 +98,7 @@ export type VSCodeCommand = string \| [string, any]`
`97`	`98`	`exportinterfaceWebhookConfigEvents{`
`98`	`99`	`init?:boolean`
`99`	`100`	`reset?:boolean`
	`101`	`+continue?:boolean`
`100`	`102`	`step_complete?:boolean`
`101`	`103`	`level_complete?:boolean`
`102`	`104`	`tutorial_complete?:boolean`

Comments

(0)