Oct 30, 2021 · Aug 29, 2021 · Aug 29, 2021 · Aug 29, 2021 · Aug 29, 2021 · Aug 29, 2021
diff --git a/docs/docs/env-vars.md b/docs/docs/env-vars.md

 -`CODEROAD_CONTENT_SECURITY_POLICY_EXEMPTIONS` - a list of CSP exemption hashes. For multiples, separate the list with a space.

 -`CODEROAD_WEBHOOK_TOKEN` - an optional token for authenticating/authorizing webhook endpoints. Passed to the webhook endpoint in a`CodeRoad-User-Token` header.

 ##How to Use Variables

 ###Local
diff --git a/src/actions/onRunReset.ts b/src/actions/onRunReset.ts
 // if tutorial.config.reset.command, run it
 constresetActions=tutorial?.config?.reset
 if(resetActions){
 hooks.onReset({commands:resetActions?.commands,vscodeCommands:resetActions?.vscodeCommands})
 hooks.onReset(
 {commands:resetActions?.commands,vscodeCommands:resetActions?.vscodeCommands},
 tutorial?.idasstring,
 )
 }
 }

diff --git a/src/actions/onTutorialConfigContinue.ts b/src/actions/onTutorialConfigContinue.ts
 importtutorialConfigfrom'./utils/tutorialConfig'
 import{COMMANDS,send}from'../commands'
 importloggerfrom'../services/logger'
 import{setupWebhook}from'../services/hooks/webhooks'

 constonTutorialConfigContinue=async(action:T.Action,context:Context):Promise<void>=>{
 logger('onTutorialConfigContinue',action)
 data:tutorialToContinue,
 alreadyConfigured:true,
 })

 // configure webhook
 if(tutorialToContinue.config?.webhook){
 setupWebhook(tutorialToContinue.config.webhook)
 }
 }catch(e){
 consterror={
 type:'UnknownError',
diff --git a/src/actions/onTutorialConfigNew.ts b/src/actions/onTutorialConfigNew.ts
 importContextfrom'../services/context/context'
 importtutorialConfigfrom'./utils/tutorialConfig'
 import{send}from'../commands'
 import{setupWebhook}from'../services/hooks/webhooks'

 constonTutorialConfigNew=async(action:T.Action,context:Context):Promise<void>=>{
 try{
 return
 }

 // configure webhook
 if(data.config?.webhook){
 setupWebhook(data.config.webhook)
 }

 // report back to the webview that setup is complete
 send({type:'TUTORIAL_CONFIGURED'})
 }catch(e){
diff --git a/src/commands.ts b/src/commands.ts
      if (!alreadyConfigured) {
        const setupActions = data.config.setup
        if (setupActions) {
          hooks.onInit(setupActions)
          hooks.onInit(setupActions, data.id)
        }
      }
      testRunner = createTestRunner(data, {
diff --git a/src/environment.ts b/src/environment.ts
 // for multiple exemptions, separate each with a space "a1 b1"
 exportconstCONTENT_SECURITY_POLICY_EXEMPTIONS:string|null=
 process.env.CODEROAD_CONTENT_SECURITY_POLICY_EXEMPTIONS||null

 // optional token for authorization/authentication of webhook calls
 exportconstWEBHOOK_TOKEN=process.env.CODEROAD_WEBHOOK_TOKEN||null
diff --git a/src/services/hooks/index.ts b/src/services/hooks/index.ts
 importrunVSCodeCommandsfrom'./utils/runVSCodeCommands'
 import*astelemetryfrom'../telemetry'
 import{runTest}from'../../actions/onTest'
 importloggerfrom'../logger'
 import{VERSION}from'../../environment'
 import*aswebhooksfrom'./webhooks'

 // run at the end of when a tutorial is configured
 exportconstonInit=async(actions:TT.StepActions):Promise<void>=>{
 exportconstonInit=async(actions:TT.StepActions,tutorialId:string):Promise<void>=>{
 awaitloadCommits(actions?.commits)
 awaitrunCommands(actions?.commands)
 awaitrunVSCodeCommands(actions?.vscodeCommands)
 webhooks.onInit({
    tutorialId,
 coderoadVersion:VERSION,
 })
 }

 // run when a level starts
 }

 // run when "reset" is triggered
 exportconstonReset=async(actions:TT.StepActions):Promise<void>=>{
 exportconstonReset=async(actions:TT.StepActions,tutorialId:string):Promise<void>=>{
 awaitresetWatchers()
 awaitrunCommands(actions?.commands)
 awaitrunVSCodeCommands(actions?.vscodeCommands)
 webhooks.onReset({
    tutorialId,
 })
 }

 // run when an uncaught exception is thrown
 }):Promise<void>=>{
 git.saveCommit(`Save progress:${stepId}`)
 telemetry.onEvent('step_complete',{ tutorialId, stepId, levelId,version:VERSION})
 webhooks.onStepComplete({
    tutorialId,
    levelId,
    stepId,
 })
 }

 // run when a level is complete (all tasks pass or no tasks)
 levelId:string
 }):Promise<void>=>{
 telemetry.onEvent('level_complete',{ tutorialId, levelId,version:VERSION})
 webhooks.onLevelComplete({
    tutorialId,
    levelId,
 })
 }

 // run when all levels are complete
 exportconstonTutorialComplete=async({ tutorialId}:{tutorialId:string}):Promise<void>=>{
 telemetry.onEvent('tutorial_complete',{ tutorialId,version:VERSION})
 webhooks.onTutorialComplete({
    tutorialId,
 })
 }
diff --git a/src/services/hooks/webhooks.ts b/src/services/hooks/webhooks.ts
 import*asTTfrom'typings/tutorial'
 importfetchfrom'node-fetch'
 importloggerfrom'../logger'
 import{WEBHOOK_TOKEN}from'../../environment'

 constWEBHOOK_EVENTS={
 init:false,
 reset:false,
 step_complete:false,
 level_complete:false,
 tutorial_complete:false,
 }

 // varaibles set on init
 letWEBHOOK_URI:string|undefined

 exportconstsetupWebhook=(webhookConfig:TT.WebhookConfig)=>{
 if(!webhookConfig.url){
 return
 }
 // set webhook uri
 WEBHOOK_URI=webhookConfig.url

 // set webhook event triggers
 constevents=webhookConfig.eventsasTT.WebhookConfigEvents
 for(consteventNameofObject.keys(events||{})){
 WEBHOOK_EVENTS[eventName]=events[eventName]
 }
 }

 constcallWebhookEndpoint=async<B>(bodyObject:B):Promise<void>=>{
 if(!WEBHOOK_URI){
 return
 }

 constheaders={'Content-Type':'application/json'}
 // if the webhook token is specified as env var, sends a token with the request
 if(WEBHOOK_TOKEN){
 headers['CodeRoad-User-Token']=WEBHOOK_TOKEN
 }

 constbody=JSON.stringify(bodyObject)

 try{
 constsendEvent=awaitfetch(WEBHOOK_URI,{
 method:'POST',
      headers,
      body,
 })
 if(!sendEvent.ok){
 thrownewError('Error sending event')
 }
 }catch(err:unknown){
 logger(`Failed to call webhook endpoint${WEBHOOK_URI} with body${body}`)
 }
 }

 typeWebhookEventInit={
 tutorialId:string
 coderoadVersion:string
 }

 exportconstonInit=(event:WebhookEventInit):void=>{
 if(WEBHOOK_EVENTS.init){
 callWebhookEndpoint<WebhookEventInit>(event)
 }
 }

 typeWebhookEventReset={
 tutorialId:string
 }

 exportconstonReset=(event:WebhookEventReset):void=>{
 if(WEBHOOK_EVENTS.reset){
 callWebhookEndpoint<WebhookEventReset>(event)
 }
 }

 typeWebhookEventStepComplete={tutorialId:string;version:string;levelId:string;stepId:string}

 exportconstonStepComplete=(event:WebhookEventStepComplete):void=>{
 if(WEBHOOK_EVENTS.step_complete){
 callWebhookEndpoint<WebhookEventStepComplete>(event)
 }
 }

 typeWebhookEventLevelComplete={tutorialId:string;version:string;levelId:string}

 exportconstonLevelComplete=(event:WebhookEventLevelComplete):void=>{
 if(WEBHOOK_EVENTS.level_complete){
 callWebhookEndpoint<WebhookEventLevelComplete>(event)
 }
 }

 typeWebhookEevntTutorialComplete={tutorialId:string;version:string}

 exportconstonTutorialComplete=(event:WebhookEevntTutorialComplete):void=>{
 if(WEBHOOK_EVENTS.tutorial_complete){
 callWebhookEndpoint<WebhookEevntTutorialComplete>(event)
 }
 }
diff --git a/typings/tutorial.d.ts b/typings/tutorial.d.ts
 dependencies?:TutorialDependency[]
 setup?:StepActions
 reset?:ConfigReset
 webhook?:WebhookConfig
 }

 /** Logical groupings of tasks */
 }

 exporttypeVSCodeCommand=string|[string,any]

 exportinterfaceWebhookConfigEvents{
 init?:boolean
 reset?:boolean
 step_complete?:boolean
 level_complete?:boolean
 tutorial_complete?:boolean
 }
 exportinterfaceWebhookConfig{
 url:string
 events?:WebhookConfigEvents
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,6 +18,8 @@ CodeRoad has a number of configurations:

		-`CODEROAD_CONTENT_SECURITY_POLICY_EXEMPTIONS` - a list of CSP exemption hashes. For multiples, separate the list with a space.

		-`CODEROAD_WEBHOOK_TOKEN` - an optional token for authenticating/authorizing webhook endpoints. Passed to the webhook endpoint in a`CodeRoad-User-Token` header.

		##How to Use Variables

		###Local
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -32,7 +32,10 @@ const onRunReset = async (action: ResetAction, context: Context): Promise<void>
		// if tutorial.config.reset.command, run it
		constresetActions=tutorial?.config?.reset
		if(resetActions){
		hooks.onReset({commands:resetActions?.commands,vscodeCommands:resetActions?.vscodeCommands})
		hooks.onReset(
		{commands:resetActions?.commands,vscodeCommands:resetActions?.vscodeCommands},
		tutorial?.idasstring,
		)
		}
		}

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,6 +5,7 @@ import Context from '../services/context/context'
		importtutorialConfigfrom'./utils/tutorialConfig'
		import{COMMANDS,send}from'../commands'
		importloggerfrom'../services/logger'
		import{setupWebhook}from'../services/hooks/webhooks'

		constonTutorialConfigContinue=async(action:T.Action,context:Context):Promise<void>=>{
		logger('onTutorialConfigContinue',action)
Expand All		@@ -19,6 +20,11 @@ const onTutorialConfigContinue = async (action: T.Action, context: Context): Pro
		data:tutorialToContinue,
		alreadyConfigured:true,
		})

		// configure webhook
		if(tutorialToContinue.config?.webhook){
		setupWebhook(tutorialToContinue.config.webhook)
		}
		}catch(e){
		consterror={
		type:'UnknownError',
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,6 +8,7 @@ import { version, compareVersions } from '../services/dependencies'
		importContextfrom'../services/context/context'
		importtutorialConfigfrom'./utils/tutorialConfig'
		import{send}from'../commands'
		import{setupWebhook}from'../services/hooks/webhooks'

		constonTutorialConfigNew=async(action:T.Action,context:Context):Promise<void>=>{
		try{
Expand DownExpand Up		@@ -108,6 +109,11 @@ const onTutorialConfigNew = async (action: T.Action, context: Context): Promise<
		return
		}

		// configure webhook
		if(data.config?.webhook){
		setupWebhook(data.config.webhook)
		}

		// report back to the webview that setup is complete
		send({type:'TUTORIAL_CONFIGURED'})
		}catch(e){
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -65,7 +65,7 @@ export const createCommands = ({ extensionPath, workspaceState }: CreateCommandP
		if (!alreadyConfigured) {
		const setupActions = data.config.setup
		if (setupActions) {
		hooks.onInit(setupActions)
		hooks.onInit(setupActions, data.id)
		}
		}
		testRunner = createTestRunner(data, {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -43,3 +43,6 @@ export const DISABLE_RUN_ON_SAVE = (process.env.CODEROAD_DISABLE_RUN_ON_SAVE \|\|
		// for multiple exemptions, separate each with a space "a1 b1"
		exportconstCONTENT_SECURITY_POLICY_EXEMPTIONS:string\|null=
		process.env.CODEROAD_CONTENT_SECURITY_POLICY_EXEMPTIONS\|\|null

		// optional token for authorization/authentication of webhook calls
		exportconstWEBHOOK_TOKEN=process.env.CODEROAD_WEBHOOK_TOKEN\|\|null
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,14 +7,18 @@ import runCommands from './utils/runCommands'
		importrunVSCodeCommandsfrom'./utils/runVSCodeCommands'
		import*astelemetryfrom'../telemetry'
		import{runTest}from'../../actions/onTest'
		importloggerfrom'../logger'
		import{VERSION}from'../../environment'
		import*aswebhooksfrom'./webhooks'

		// run at the end of when a tutorial is configured
		exportconstonInit=async(actions:TT.StepActions):Promise<void>=>{
		exportconstonInit=async(actions:TT.StepActions,tutorialId:string):Promise<void>=>{
		awaitloadCommits(actions?.commits)
		awaitrunCommands(actions?.commands)
		awaitrunVSCodeCommands(actions?.vscodeCommands)
		webhooks.onInit({
		tutorialId,
		coderoadVersion:VERSION,
		})
		}

		// run when a level starts
Expand DownExpand Up		@@ -43,10 +47,13 @@ export const onSolutionEnter = async (actions: TT.StepActions): Promise<void> =>
		}

		// run when "reset" is triggered
		exportconstonReset=async(actions:TT.StepActions):Promise<void>=>{
		exportconstonReset=async(actions:TT.StepActions,tutorialId:string):Promise<void>=>{
		awaitresetWatchers()
		awaitrunCommands(actions?.commands)
		awaitrunVSCodeCommands(actions?.vscodeCommands)
		webhooks.onReset({
		tutorialId,
		})
		}

		// run when an uncaught exception is thrown
Expand All		@@ -66,6 +73,11 @@ export const onStepComplete = async ({
		}):Promise<void>=>{
		git.saveCommit(`Save progress:${stepId}`)
		telemetry.onEvent('step_complete',{ tutorialId, stepId, levelId,version:VERSION})
		webhooks.onStepComplete({
		tutorialId,
		levelId,
		stepId,
		})
		}

		// run when a level is complete (all tasks pass or no tasks)
Expand All		@@ -77,9 +89,16 @@ export const onLevelComplete = async ({
		levelId:string
		}):Promise<void>=>{
		telemetry.onEvent('level_complete',{ tutorialId, levelId,version:VERSION})
		webhooks.onLevelComplete({
		tutorialId,
		levelId,
		})
		}

		// run when all levels are complete
		exportconstonTutorialComplete=async({ tutorialId}:{tutorialId:string}):Promise<void>=>{
		telemetry.onEvent('tutorial_complete',{ tutorialId,version:VERSION})
		webhooks.onTutorialComplete({
		tutorialId,
		})
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,6 +14,7 @@ export type TutorialConfig = {
		dependencies?:TutorialDependency[]
		setup?:StepActions
		reset?:ConfigReset
		webhook?:WebhookConfig
		}

		/** Logical groupings of tasks */
Expand DownExpand Up		@@ -92,3 +93,15 @@ export interface TutorialAppVersions {
		}

		exporttypeVSCodeCommand=string\|[string,any]

		exportinterfaceWebhookConfigEvents{
		init?:boolean
		reset?:boolean
		step_complete?:boolean
		level_complete?:boolean
		tutorial_complete?:boolean
		}
		exportinterfaceWebhookConfig{
		url:string
		events?:WebhookConfigEvents
		}