FilesExpand file tree

master

/

onTutorialConfigNew.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

143 lines (130 loc) · 4.61 KB

master

/

onTutorialConfigNew.ts

Copy path

Top

File metadata and controls

• Code
• Blame

143 lines (130 loc) · 4.61 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

import * as vscode from 'vscode'

import * as T from 'typings'

import * as TT from 'typings/tutorial'

import * as E from 'typings/error'

import { satisfies } from 'semver'

import { onEvent } from '../services/telemetry'

import { getVersion, compareVersions } from '../services/dependencies'

import Context from '../services/context/context'

import tutorialConfig from './utils/tutorialConfig'

import { send } from '../commands'

import { setupWebhook } from '../services/hooks/webhooks'

const onTutorialConfigNew = async (action: T.Action, context: Context): Promise<void> => {

try {

const data: TT.Tutorial = action.payload.tutorial

onEvent('tutorial_start', {

tutorialId: data.id,

tutorialVersion: data.version,

tutorialTitle: data.summary.title,

})

// validate extension version

const expectedAppVersion = data.config?.appVersions?.vscode

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 v${currentAppVersion}`,

}

send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })

return

}

}

}

// setup tutorial config (save watcher, test runner, etc)

await context.onNew(data)

// validate dependencies

const dependencies = data.config.dependencies

if (dependencies && dependencies.length) {

for (const dep of dependencies) {

// check dependency is installed

const { version, error: gitError } = await getVersion(dep.name)

if (gitError) {

// git config issue

const error: E.ErrorMessage = {

type: 'GitConfigError',

message: gitError.message,

actions: [

{

label: 'Check Again',

transition: 'TRY_AGAIN',

},

],

}

send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })

return

}

if (!version) {

// use a custom error message

const error: E.ErrorMessage = {

type: 'MissingTutorialDependency',

message: dep.message || `Process "${dep.name}" is required but not found. It may need to be installed`,

actions: [

{

label: 'Check Again',

transition: 'TRY_AGAIN',

},

],

}

send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })

return

}

// check dependency version

const satisfiedDependency = await compareVersions(version, dep.version)

if (!satisfiedDependency) {

const error: E.ErrorMessage = {

type: 'UnmetTutorialDependency',

message: `Expected ${dep.name} to have version ${dep.version}, but found version ${version}`,

actions: [

{

label: 'Check Again',

transition: 'TRY_AGAIN',

},

],

}

send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })

return

}

if (satisfiedDependency !== true) {

const error: E.ErrorMessage = satisfiedDependency || {

type: 'UnknownError',

message: `Something went wrong comparing dependency for ${dep.name}`,

actions: [

{

label: 'Try Again',

transition: 'TRY_AGAIN',

},

],

}

send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })

return

}

}

}

const error: E.ErrorMessage | void = await tutorialConfig({ data }).catch((error: Error) => ({

type: 'UnknownError',

message: `Location: tutorial config.\n\n${error.message}`,

}))

// has error

if (error && error.type) {

send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })

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: any) {

const error = {

type: 'UnknownError',

message: `Location: EditorTutorialConfig.\n\n ${e.message}`,

}

send({ type: 'TUTORIAL_CONFIGURE_FAIL', payload: { error } })

}

}

export default onTutorialConfigNew