FilesExpand file tree

 main

/

ActionBase.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

188 lines (173 loc) · 6.91 KB

 main

/

ActionBase.ts

Copy path

Top

File metadata and controls

• Code
• Blame

188 lines (173 loc) · 6.91 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

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

/*---------------------------------------------------------------------------------------------

* Copyright (c) Microsoft Corporation. All rights reserved.

* Licensed under the MIT License. See LICENSE in the project root for license information.

*--------------------------------------------------------------------------------------------*/

import { Issue } from '../api/api'

import { safeLog } from './utils';

export class ActionBase {

constructor(

private labels?: string,

private milestoneName?: string,

private milestoneId?: string,

private ignoreLabels?: string,

private ignoreMilestoneNames?: string,

private ignoreMilestoneIds?: string,

private minimumVotes?: number,

private maximumVotes?: number,

private involves?: string,

) {}

private labelsSet: string[] = [];

private ignoreLabelsSet: string[] = [];

private ignoreMilestoneNamesSet: string[] = [];

private ignoreMilestoneIdsSet: string[] = [];

private ignoreAllWithLabels: boolean = false;

private ignoreAllWithMilestones: boolean = false;

private involvesSet: string[] = [];

buildQuery(baseQuery: string): string {

let query = baseQuery;

safeLog(`labels: ${this.labels}`);

safeLog(`milestoneName: ${this.milestoneName}`);

safeLog(`milestoneId: ${this.milestoneId}`);

safeLog(`ignoreLabels: ${this.ignoreLabels}`);

safeLog(`ignoreMilestoneNames: ${this.ignoreMilestoneNames}`);

safeLog(`ignoreMilestoneIds: ${this.ignoreMilestoneIds}`);

safeLog(`minimumVotes: ${this.minimumVotes}`);

safeLog(`maximumVotes: ${this.maximumVotes}`);

safeLog(`involves: ${this.involves}`);

// Both milestone name and milestone Id must be provided and must match.

// The name is used to construct the query, which does not accept ID.

// The ID is used for comparisons with issue data, which does not include the name.

// TODO: Figure out a way to convert either from milestone name to ID, or vice versa.

// If label inclusion and exclusion are mixed, exclusion will take precedence.

// For example, an issue with both labels A and B will not match if B is excluded, even if A is included.

// If a milestoneName/milestoneId are set, ignoreMilenameName/ignoreMilestoneIds are ignored.

// GitHub does not appear to support searching for all issues with milestones (not lacking a milestone). "-no:milestone" does not work.

// GitHub does not appear to support searching for all issues with labels (not lacking a label). "-no:label" does not work.

// All indicated labels must be present

if (this.labels) {

if (this.labels?.length > 2 && this.labels?.startsWith('"') && this.labels?.endsWith('"')) {

this.labels = this.labels.substring(1, this.labels.length - 2);

}

this.labelsSet = this.labels?.split(',');

for (const str of this.labelsSet) {

if (str != "") {

query = query.concat(` label:"${str}"`);

}

}

}

// The "involves" qualifier to find issues that in some way involve a certain user.

// It is a logical OR between the author, assignee, and mentions.

if (this.involves) {

this.involvesSet = this.involves?.split(',');

for (const str of this.involvesSet) {

if (str != "") {

query = query.concat(` involves:"${str}"`)

}

}

}

if (this.ignoreLabels) {

if (this.ignoreLabels == "*" && !this.labels) { // only if unlabeled

query = query.concat(` no:label`)

this.ignoreAllWithLabels = true;

} else {

this.ignoreLabelsSet = this.ignoreLabels?.split(',');

for (const str of this.ignoreLabelsSet) {

if (str != "") {

query = query.concat(` -label:"${str}"`)

}

}

}

}

if (this.milestoneName) {

query = query.concat(` milestone:"${this.milestoneName}"`)

}

else if (this.ignoreMilestoneNames) {

if (this.ignoreMilestoneNames == "*") {

query = query.concat(` no:milestone`)

this.ignoreAllWithMilestones = true;

} else if (this.ignoreMilestoneIds) {

this.ignoreMilestoneNamesSet = this.ignoreMilestoneNames.split(',');

this.ignoreMilestoneIdsSet = this.ignoreMilestoneIds.split(',');

for (const str of this.ignoreMilestoneNamesSet) {

if (str != "") {

query = query.concat(` -milestone:"${str}"`)

}

}

}

}

return query;

}

// This is necessary because GitHub sometimes returns incorrect results,

// and because issues may get modified while we are processing them.

validateIssue(issue: Issue): boolean {

if (this.ignoreAllWithLabels) {

// Validate that the issue does not have labels

if (issue.labels && issue.labels.length !== 0) {

safeLog(`Issue ${issue.number} skipped due to label found after querying for no:label.`);

return false;

}

} else {

// Make sure all labels we wanted are present.

if ((!issue.labels || issue.labels.length == 0) && this.labelsSet.length > 0) {

safeLog(`Issue ${issue.number} skipped due to not having a required label set. No labels found.`);

return false;

}

for (const str of this.labelsSet) {

if (!issue.labels.includes(str)) {

safeLog(`Issue ${issue.number} skipped due to not having a required label set.`);

return false;

}

}

// Make sure no labels we wanted to ignore are present.

if (issue.labels && issue.labels.length > 0) {

for (const str of this.ignoreLabelsSet) {

if (issue.labels.includes(str)) {

safeLog(`Issue ${issue.number} skipped due to having an ignore label set: ${str}`);

return false;

}

}

}

}

if (this.ignoreAllWithMilestones) {

// Validate that the issue does not have a milestone.

if (issue.milestone) {

safeLog(`Issue ${issue.number} skipped due to milestone found after querying for no:milestone.`);

return false;

}

} else {

// Make sure milestone is present, if required.

if (this.milestoneId != null && issue.milestone?.milestoneId != +this.milestoneId) {

safeLog(`Issue ${issue.number} skipped due to not having required milsetone id ${this.milestoneId}. Had: ${issue.milestone?.milestoneId}`);

return false;

}

// Make sure a milestones we wanted to ignore is not present.

if (issue.milestone && issue.milestone.milestoneId != null) {

for (const str of this.ignoreMilestoneIdsSet) {

if (issue.milestone.milestoneId == +str) {

safeLog(`Issue ${issue.number} skipped due to milestone ${issue.milestone.milestoneId} found in list of ignored milestone IDs.`);

return false;

}

}

}

}

// Verify the issue has a sufficient number of upvotes

let upvotes = 0;

if (issue.reactions) {

upvotes = issue.reactions['+1'];

}

if (this.minimumVotes != undefined) {

if (upvotes < this.minimumVotes) {

safeLog(`Issue ${issue.number} skipped due to not having at least ${this.minimumVotes} upvotes. Had: ${upvotes}`);

return false;

}

}

// Verify the issue does not have too many upvotes

if (this.maximumVotes != undefined) {

if (upvotes > this.maximumVotes) {

safeLog(`Issue ${issue.number} skipped due to having more than ${this.maximumVotes} upvotes. Had: ${upvotes}`);

return false;

}

}

return true;

}

}