File: request.go

package info (click to toggle)
golang-github-azure-azure-sdk-for-go 68.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 556,256 kB
  • sloc: javascript: 196; sh: 96; makefile: 7
file content (197 lines) | stat: -rw-r--r-- 5,548 bytes parent folder | download
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
189
190
191
192
193
194
195
196
197
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

package request

import (
	"context"
	"fmt"
	"regexp"
	"strings"
	"time"

	"github.com/Azure/azure-sdk-for-go/eng/tools/generator/cmd/issue/link"
	"github.com/Azure/azure-sdk-for-go/eng/tools/generator/cmd/issue/query"
	"github.com/google/go-github/v32/github"
)

var (
	resultHandlerMap = map[link.Code]resultHandlerFunc{
		link.CodeSuccess:     handleSuccess,
		link.CodeDataPlane:   handleDataPlane,
		link.CodePRNotMerged: handlePRNotMerged,
	}
)

// ParsingOptions ...
type ParsingOptions struct {
	IncludeDataPlaneRequests bool
}

type resultHandlerFunc func(ctx context.Context, client *query.Client, reqIssue ReleaseRequestIssue, result link.ResolveResult) (*Request, error)

// Request represents a parsed SDK release request
type Request struct {
	RequestLink string
	TargetDate  time.Time
	ReadmePath  string
	Tag         string
	Track       Track
}

// Track ...
type Track string

const (
	// Track1 ...
	Track1 Track = "Track1"
	// Track2 ...
	Track2 Track = "Track2"
)

const (
	linkKeyword        = "**Link**: "
	tagKeyword         = "**Readme Tag**: "
	releaseDateKeyword = "**Target release date**: "
)

type issueError struct {
	issue github.Issue
	err   error
}

// Error ...
func (e *issueError) Error() string {
	return fmt.Sprintf("cannot parse release request from issue %s: %+v", e.issue.GetHTMLURL(), e.err)
}

func initializeHandlers(options ParsingOptions) {
	if options.IncludeDataPlaneRequests {
		resultHandlerMap[link.CodeDataPlane] = handleSuccess
	}
}

// ParseIssue parses the release request issues to release requests
func ParseIssue(ctx context.Context, client *query.Client, issue github.Issue, options ParsingOptions) (*Request, error) {
	initializeHandlers(options)

	reqIssue, err := NewReleaseRequestIssue(issue)
	if err != nil {
		return nil, err
	}
	result, err := ParseReadmeFromLink(ctx, client, *reqIssue)
	if err != nil {
		return nil, err
	}
	handler := resultHandlerMap[result.GetCode()]
	if handler == nil {
		panic(fmt.Sprintf("unhandled code '%s'", result.GetCode()))
	}
	return handler(ctx, client, *reqIssue, result)
}

// ReleaseRequestIssue represents a release request issue
type ReleaseRequestIssue struct {
	IssueLink   string
	TargetLink  string
	Tag         string
	ReleaseDate time.Time
	Labels      []*github.Label
}

// NewReleaseRequestIssue ...
func NewReleaseRequestIssue(issue github.Issue) (*ReleaseRequestIssue, error) {
	body := issue.GetBody()
	contents := getRawContent(strings.Split(body, "\n"), []string{
		linkKeyword, tagKeyword, releaseDateKeyword,
	})
	// get release date
	releaseDate, err := time.Parse("2006-01-02", contents[releaseDateKeyword])
	if err != nil {
		return nil, &issueError{
			issue: issue,
			err:   err,
		}
	}
	return &ReleaseRequestIssue{
		IssueLink:   issue.GetHTMLURL(),
		TargetLink:  parseLink(contents[linkKeyword]),
		Tag:         contents[tagKeyword],
		ReleaseDate: releaseDate,
		Labels:      issue.Labels,
	}, nil
}

func getRawContent(lines []string, keywords []string) map[string]string {
	result := make(map[string]string)
	for _, line := range lines {
		for _, keyword := range keywords {
			raw := getContentByPrefix(line, keyword)
			if raw != "" {
				result[keyword] = raw
			}
		}
	}
	return result
}

func getContentByPrefix(line, prefix string) string {
	if strings.HasPrefix(line, prefix) {
		return strings.TrimSpace(strings.TrimPrefix(line, prefix))
	}
	return ""
}

func parseLink(rawLink string) string {
	regex := regexp.MustCompile(`^\[.+\]\((.+)\)$`)
	r := regex.FindStringSubmatch(rawLink)
	if len(r) < 1 {
		return ""
	}
	return r[1]
}

// ParseReadmeFromLink ...
func ParseReadmeFromLink(ctx context.Context, client *query.Client, reqIssue ReleaseRequestIssue) (link.ResolveResult, error) {
	// check if invalid characters in a url
	regex := regexp.MustCompile(`^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\-._~:/\?#\[\]@!\$&'\(\)\*\+,;=]+$`)
	if !regex.MatchString(reqIssue.TargetLink) {
		return nil, fmt.Errorf("link '%s' contains invalid characters", reqIssue.TargetLink)
	}
	r, err := parseResolver(ctx, client, reqIssue.IssueLink, reqIssue.TargetLink)
	if err != nil {
		return nil, err
	}
	return r.Resolve()
}

func parseResolver(ctx context.Context, client *query.Client, requestLink, releaseLink string) (link.Resolver, error) {
	if !strings.HasPrefix(releaseLink, link.SpecRepoPrefix) {
		return nil, fmt.Errorf("link '%s' is not from '%s'", releaseLink, link.SpecRepoPrefix)
	}
	releaseLink = strings.TrimPrefix(releaseLink, link.SpecRepoPrefix)
	prefix, err := getLinkPrefix(releaseLink)
	if err != nil {
		return nil, fmt.Errorf("cannot resolve link '%s': %+v", releaseLink, err)
	}
	switch prefix {
	case link.PullRequestPrefix:
		return link.NewPullRequestLink(ctx, client, requestLink, releaseLink), nil
	case link.DirectoryPrefix:
		return link.NewDirectoryLink(ctx, client, requestLink, releaseLink), nil
	case link.FilePrefix:
		return link.NewFileLink(ctx, client, requestLink, releaseLink), nil
	case link.CommitPrefix:
		return link.NewCommitLink(ctx, client, requestLink, releaseLink), nil
	default:
		return nil, fmt.Errorf("prefix '%s' of link '%s' not supported yet", prefix, releaseLink)
	}
}

func getLinkPrefix(link string) (string, error) {
	segments := strings.Split(link, "/")
	if len(segments) < 2 {
		return "", fmt.Errorf("cannot determine the prefix of link")
	}
	return segments[0] + "/", nil
}