From 0ed8a3d0d21f56e3e43b8663d66babc754b27599 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sat, 27 Aug 2022 17:30:28 +0800 Subject: [PATCH 01/44] feat: extend issue template for yaml --- modules/context/repo.go | 91 +++++++++++++++++++-------------- modules/structs/issue.go | 105 ++++++++++++++++++++++++++++++++++++--- 2 files changed, 152 insertions(+), 44 deletions(-) diff --git a/modules/context/repo.go b/modules/context/repo.go index 5404acc05a3a6..06d78826d1919 100644 --- a/modules/context/repo.go +++ b/modules/context/repo.go @@ -13,6 +13,7 @@ import ( "net/http" "net/url" "path" + "path/filepath" "strings" "code.gitea.io/gitea/models" @@ -35,6 +36,7 @@ import ( asymkey_service "code.gitea.io/gitea/services/asymkey" "github.com/editorconfig/editorconfig-core-go/v2" + "gopkg.in/yaml.v2" ) // IssueTemplateDirCandidates issue templates directory @@ -1060,44 +1062,61 @@ func (ctx *Context) IssueTemplatesFromDefaultBranch() []api.IssueTemplate { return issueTemplates } for _, entry := range entries { - if strings.HasSuffix(entry.Name(), ".md") { - if entry.Blob().Size() >= setting.UI.MaxDisplayFileSize { - log.Debug("Issue template is too large: %s", entry.Name()) - continue - } - r, err := entry.Blob().DataAsync() - if err != nil { - log.Debug("DataAsync: %v", err) - continue - } - closed := false - defer func() { - if !closed { - _ = r.Close() - } - }() - data, err := io.ReadAll(r) - if err != nil { - log.Debug("ReadAll: %v", err) - continue - } - _ = r.Close() - var it api.IssueTemplate - content, err := markdown.ExtractMetadata(string(data), &it) - if err != nil { - log.Debug("ExtractMetadata: %v", err) - continue - } - it.Content = content - it.FileName = entry.Name() - if it.Valid() { - issueTemplates = append(issueTemplates, it) - } + if t := ctx.extractIssueTemplate(entry); t != nil { + issueTemplates = append(issueTemplates, *t) } } - if len(issueTemplates) > 0 { - return issueTemplates - } } return issueTemplates } + +func (ctx *Context) extractIssueTemplate(entry *git.TreeEntry) *api.IssueTemplate { + it := &api.IssueTemplate{ + FileName: entry.Name(), + } + if it.Type() == "" { + return nil + } + + if name := filepath.Base(it.FileName); name == "config.yaml" || name == "config.yml" { + // ignore config.yaml which is a special configuration file + return nil + } + + if entry.Blob().Size() >= setting.UI.MaxDisplayFileSize { + log.Debug("Issue template is too large: %s", entry.Name()) + return nil + } + + r, err := entry.Blob().DataAsync() + if err != nil { + log.Debug("DataAsync: %v", err) + return nil + } + defer r.Close() + + data, err := io.ReadAll(r) + if err != nil { + log.Debug("ReadAll: %v", err) + return nil + } + + if it.Type() == "md" { + content, err := markdown.ExtractMetadata(string(data), it) + if err != nil { + log.Debug("ExtractMetadata: %v", err) + return nil + } + it.Content = content + } else if it.Type() == "yaml" { + if err := yaml.Unmarshal(data, it); err != nil { + log.Debug("Unmarshal: %v", err) + return nil + } + } + + if !it.Valid() { + return nil + } + return it +} diff --git a/modules/structs/issue.go b/modules/structs/issue.go index c72487fe4dcad..68d54989890ad 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -5,6 +5,8 @@ package structs import ( + "fmt" + "path/filepath" "strings" "time" ) @@ -123,16 +125,103 @@ type IssueDeadline struct { // IssueTemplate represents an issue template for a repository // swagger:model type IssueTemplate struct { - Name string `json:"name" yaml:"name"` - Title string `json:"title" yaml:"title"` - About string `json:"about" yaml:"about"` - Labels []string `json:"labels" yaml:"labels"` - Ref string `json:"ref" yaml:"ref"` - Content string `json:"content" yaml:"-"` - FileName string `json:"file_name" yaml:"-"` + Name string `json:"name" yaml:"name"` + Title string `json:"title" yaml:"title"` + About string `json:"about" yaml:"about"` // TODO: compatible with description + Labels []string `json:"labels" yaml:"labels"` + Ref string `json:"ref" yaml:"ref"` + Content string `json:"content" yaml:"-"` // for markdown only + Body []*IssueTemplateField `json:"body" yaml:"body"` // for yaml only + FileName string `json:"file_name" yaml:"-"` +} + +type IssueTemplateField struct { + Type string `json:"type" yaml:"type"` + ID string `json:"id" yaml:"id"` + Attributes map[string]interface{} `json:"attributes" yaml:"attributes"` + Validations map[string]interface{} `json:"validations" yaml:"validations"` +} + +// Validate checks whether an IssueTemplate is considered valid, and returns the first error +func (it IssueTemplate) Validate() error { + // TODO check the format of id, and more + + errMissField := func(f string) error { + return fmt.Errorf("field '%s' is required", f) + } + + if strings.TrimSpace(it.Name) != "" { + return errMissField("name") + } + if strings.TrimSpace(it.About) != "" { + return errMissField("about") + } + + for idx, field := range it.Body { + checkStringAttr := func(name string) error { + attr := field.Attributes[name] + if s, ok := attr.(string); !ok || s == "" { + return fmt.Errorf( + "body[%d]: the '%s' attribute is required and should be string with type %s", + idx, name, field.Type, + ) + } + return nil + } + switch field.Type { + case "markdown": + if err := checkStringAttr("value"); err != nil { + return err + } + case "textarea", "input", "dropdown": + if err := checkStringAttr("label"); err != nil { + return err + } + case "checkboxes": + if err := checkStringAttr("label"); err != nil { + } + if err := checkStringAttr("label"); err != nil { + return err + } + attr := field.Attributes["options"] + if options, ok := attr.([]map[string]any); !ok { + return fmt.Errorf( + "body[%d]: the '%s' attribute is required and should be array with type %s", + idx, "options", field.Type, + ) + } else { + for optIdx, option := range options { + label := option["label"] + if s, ok := label.(string); !ok || s == "" { + return fmt.Errorf( + "body[%d], option[%d]: the '%s' is required and should be string with type %s", + idx, optIdx, "label", field.Type, + ) + } + } + } + + default: + return fmt.Errorf( + "(field #%d '%s'): unknown type '%s'", + idx+1, field.ID, field.Type, + ) + } + } + return nil } // Valid checks whether an IssueTemplate is considered valid, e.g. at least name and about func (it IssueTemplate) Valid() bool { - return strings.TrimSpace(it.Name) != "" && strings.TrimSpace(it.About) != "" + return it.Validate() == nil +} + +// Type returns the type of IssueTemplate, it could be "md", "yaml" or empty for known +func (it IssueTemplate) Type() string { + if ext := filepath.Ext(it.FileName); ext == ".md" { + return "md" + } else if ext == ".yaml" || ext == ".yml" { + return "yaml" + } + return "" } From 4efe0b40fd0811dbbaa55e3350324aaf7bcc860b Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sat, 27 Aug 2022 21:26:34 +0800 Subject: [PATCH 02/44] feat: support yaml template --- modules/context/repo.go | 17 +---- modules/structs/issue.go | 103 +++++++++++++++++++++++--- routers/web/repo/issue.go | 72 +++++++++--------- templates/repo/issue/comment_tab.tmpl | 96 ++++++++++++++++++++---- 4 files changed, 215 insertions(+), 73 deletions(-) diff --git a/modules/context/repo.go b/modules/context/repo.go index 06d78826d1919..d8c3fad661e81 100644 --- a/modules/context/repo.go +++ b/modules/context/repo.go @@ -28,7 +28,6 @@ import ( "code.gitea.io/gitea/modules/git" code_indexer "code.gitea.io/gitea/modules/indexer/code" "code.gitea.io/gitea/modules/log" - "code.gitea.io/gitea/modules/markup/markdown" repo_module "code.gitea.io/gitea/modules/repository" "code.gitea.io/gitea/modules/setting" api "code.gitea.io/gitea/modules/structs" @@ -36,7 +35,6 @@ import ( asymkey_service "code.gitea.io/gitea/services/asymkey" "github.com/editorconfig/editorconfig-core-go/v2" - "gopkg.in/yaml.v2" ) // IssueTemplateDirCandidates issue templates directory @@ -1101,18 +1099,9 @@ func (ctx *Context) extractIssueTemplate(entry *git.TreeEntry) *api.IssueTemplat return nil } - if it.Type() == "md" { - content, err := markdown.ExtractMetadata(string(data), it) - if err != nil { - log.Debug("ExtractMetadata: %v", err) - return nil - } - it.Content = content - } else if it.Type() == "yaml" { - if err := yaml.Unmarshal(data, it); err != nil { - log.Debug("Unmarshal: %v", err) - return nil - } + if err := it.Fill(data); err != nil { + log.Debug("fill template: %v", err) + return nil } if !it.Valid() { diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 68d54989890ad..70d6392c1467b 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -9,6 +9,8 @@ import ( "path/filepath" "strings" "time" + + "gopkg.in/yaml.v2" ) // StateType issue state type @@ -127,7 +129,7 @@ type IssueDeadline struct { type IssueTemplate struct { Name string `json:"name" yaml:"name"` Title string `json:"title" yaml:"title"` - About string `json:"about" yaml:"about"` // TODO: compatible with description + About string `json:"about" yaml:"about"` Labels []string `json:"labels" yaml:"labels"` Ref string `json:"ref" yaml:"ref"` Content string `json:"content" yaml:"-"` // for markdown only @@ -142,18 +144,26 @@ type IssueTemplateField struct { Validations map[string]interface{} `json:"validations" yaml:"validations"` } +func NewIssueTemplate(filename string, content []byte) (*IssueTemplate, error) { + ret := &IssueTemplate{ + FileName: filename, + } + + return ret, nil +} + // Validate checks whether an IssueTemplate is considered valid, and returns the first error -func (it IssueTemplate) Validate() error { +func (it *IssueTemplate) Validate() error { // TODO check the format of id, and more errMissField := func(f string) error { return fmt.Errorf("field '%s' is required", f) } - if strings.TrimSpace(it.Name) != "" { + if strings.TrimSpace(it.Name) == "" { return errMissField("name") } - if strings.TrimSpace(it.About) != "" { + if strings.TrimSpace(it.About) == "" { return errMissField("about") } @@ -184,19 +194,26 @@ func (it IssueTemplate) Validate() error { return err } attr := field.Attributes["options"] - if options, ok := attr.([]map[string]any); !ok { + if options, ok := attr.([]any); !ok { return fmt.Errorf( "body[%d]: the '%s' attribute is required and should be array with type %s", idx, "options", field.Type, ) } else { for optIdx, option := range options { - label := option["label"] - if s, ok := label.(string); !ok || s == "" { + if opt, ok := option.(map[any]any); !ok { return fmt.Errorf( - "body[%d], option[%d]: the '%s' is required and should be string with type %s", - idx, optIdx, "label", field.Type, + "body[%d], option[%d]: should be dictionary with type %s", + idx, optIdx, field.Type, ) + } else { + label := opt["label"] + if s, ok := label.(string); !ok || s == "" { + return fmt.Errorf( + "body[%d], option[%d]: the '%s' is required and should be string with type %s", + idx, optIdx, "label", field.Type, + ) + } } } } @@ -212,12 +229,12 @@ func (it IssueTemplate) Validate() error { } // Valid checks whether an IssueTemplate is considered valid, e.g. at least name and about -func (it IssueTemplate) Valid() bool { +func (it *IssueTemplate) Valid() bool { return it.Validate() == nil } // Type returns the type of IssueTemplate, it could be "md", "yaml" or empty for known -func (it IssueTemplate) Type() string { +func (it *IssueTemplate) Type() string { if ext := filepath.Ext(it.FileName); ext == ".md" { return "md" } else if ext == ".yaml" || ext == ".yml" { @@ -225,3 +242,67 @@ func (it IssueTemplate) Type() string { } return "" } + +func (it *IssueTemplate) Fill(content []byte) error { + if typ := it.Type(); typ == "md" { + templateBody, err := it.extractMetadata(string(content), it) + if err != nil { + return fmt.Errorf("extract metadata: %w", err) + } + it.Content = templateBody + } else if typ == "yaml" { + if err := yaml.Unmarshal(content, it); err != nil { + return fmt.Errorf("yaml unmarshal: %w", err) + } + if it.About == "" { + // Compatible with treating description as about + compatibleTemplate := &struct { + About string `yaml:"description"` + }{} + if err := yaml.Unmarshal(content, compatibleTemplate); err == nil && compatibleTemplate.About != "" { + it.About = compatibleTemplate.About + } + } + } + return nil +} + +// extractMetadata consumes a markdown file, parses YAML frontmatter, +// and returns the frontmatter metadata separated from the markdown content. +// Copy from markdown.ExtractMetadata to avoid import cycle. +func (*IssueTemplate) extractMetadata(contents string, out interface{}) (string, error) { + isYAMLSeparator := func(line string) bool { + line = strings.TrimSpace(line) + for i := 0; i < len(line); i++ { + if line[i] != '-' { + return false + } + } + return len(line) > 2 + } + + var front, body []string + lines := strings.Split(contents, "\n") + for idx, line := range lines { + if idx == 0 { + // First line has to be a separator + if !isYAMLSeparator(line) { + return "", fmt.Errorf("frontmatter must start with a separator line") + } + continue + } + if isYAMLSeparator(line) { + front, body = lines[1:idx], lines[idx+1:] + break + } + } + + if len(front) == 0 { + return "", fmt.Errorf("could not determine metadata") + } + + if err := yaml.Unmarshal([]byte(strings.Join(front, "\n")), out); err != nil { + return "", err + } + return strings.Join(body, "\n"), nil +} diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index 3f14416e48371..fe53c665ed5dd 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -751,51 +751,57 @@ func getFileContentFromDefaultBranch(ctx *context.Context, filename string) (str } func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleDirs, possibleFiles []string) { - templateCandidates := make([]string, 0, len(possibleFiles)) - if ctx.FormString("template") != "" { + templateCandidates := make([]string, 0, len(possibleDirs)+len(possibleFiles)) + if t := ctx.FormString("template"); t != "" { for _, dirName := range possibleDirs { - templateCandidates = append(templateCandidates, path.Join(dirName, ctx.FormString("template"))) + templateCandidates = append(templateCandidates, path.Join(dirName, t)) } } templateCandidates = append(templateCandidates, possibleFiles...) // Append files to the end because they should be fallback for _, filename := range templateCandidates { templateContent, found := getFileContentFromDefaultBranch(ctx, filename) - if found { - var meta api.IssueTemplate - templateBody, err := markdown.ExtractMetadata(templateContent, &meta) - if err != nil { - log.Debug("could not extract metadata from %s [%s]: %v", filename, ctx.Repo.Repository.FullName(), err) - ctx.Data[ctxDataKey] = templateContent - return - } - ctx.Data[issueTemplateTitleKey] = meta.Title - ctx.Data[ctxDataKey] = templateBody - labelIDs := make([]string, 0, len(meta.Labels)) - if repoLabels, err := issues_model.GetLabelsByRepoID(ctx, ctx.Repo.Repository.ID, "", db.ListOptions{}); err == nil { - ctx.Data["Labels"] = repoLabels - if ctx.Repo.Owner.IsOrganization() { - if orgLabels, err := issues_model.GetLabelsByOrgID(ctx, ctx.Repo.Owner.ID, ctx.FormString("sort"), db.ListOptions{}); err == nil { - ctx.Data["OrgLabels"] = orgLabels - repoLabels = append(repoLabels, orgLabels...) - } + if !found { + continue + } + template := api.IssueTemplate{ + FileName: filename, + } + if err := template.Fill([]byte(templateContent)); err != nil { + log.Debug("could fill template from %s [%s]: %v", filename, ctx.Repo.Repository.FullName(), err) + ctx.Data[ctxDataKey] = templateContent + return + } + + ctx.Data[issueTemplateTitleKey] = template.Title + ctx.Data[ctxDataKey] = template.Content + if template.Type() == "yaml" { + ctx.Data[ctxDataKey+"Form"] = template // TODO use template.Body + } + labelIDs := make([]string, 0, len(template.Labels)) + if repoLabels, err := issues_model.GetLabelsByRepoID(ctx, ctx.Repo.Repository.ID, "", db.ListOptions{}); err == nil { + ctx.Data["Labels"] = repoLabels + if ctx.Repo.Owner.IsOrganization() { + if orgLabels, err := issues_model.GetLabelsByOrgID(ctx, ctx.Repo.Owner.ID, ctx.FormString("sort"), db.ListOptions{}); err == nil { + ctx.Data["OrgLabels"] = orgLabels + repoLabels = append(repoLabels, orgLabels...) } + } - for _, metaLabel := range meta.Labels { - for _, repoLabel := range repoLabels { - if strings.EqualFold(repoLabel.Name, metaLabel) { - repoLabel.IsChecked = true - labelIDs = append(labelIDs, strconv.FormatInt(repoLabel.ID, 10)) - break - } + for _, metaLabel := range template.Labels { + for _, repoLabel := range repoLabels { + if strings.EqualFold(repoLabel.Name, metaLabel) { + repoLabel.IsChecked = true + labelIDs = append(labelIDs, strconv.FormatInt(repoLabel.ID, 10)) + break } } } - ctx.Data["HasSelectedLabel"] = len(labelIDs) > 0 - ctx.Data["label_ids"] = strings.Join(labelIDs, ",") - ctx.Data["Reference"] = meta.Ref - ctx.Data["RefEndName"] = git.RefEndName(meta.Ref) - return } + ctx.Data["HasSelectedLabel"] = len(labelIDs) > 0 + ctx.Data["label_ids"] = strings.Join(labelIDs, ",") + ctx.Data["Reference"] = template.Ref + ctx.Data["RefEndName"] = git.RefEndName(template.Ref) + return } } diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index c1ca69dfb3e2f..59dccaf1ec046 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -1,19 +1,85 @@ -
- {{.locale.Tr "write"}} - {{.locale.Tr "preview"}} -
-
-
- +{{- if .IssueTemplateForm}} + + {{range $field_idx, $field := .IssueTemplateForm.Body}} + {{- if $field.Attributes.label}}

{{$field.Attributes.label}} {{if $field.Validations.required}} *{{end}}

{{end}} + {{- if $field.Attributes.description}}
{{RenderMarkdownToHtml $field.Attributes.description}}
{{end}} + + {{- if eq .Type "markdown"}} +
{{RenderMarkdownToHtml $field.Attributes.value}}
+ {{else if eq .Type "input"}} + + {{else if eq .Type "textarea"}} + {{- if .Attributes.render}} + + {{end}} + + {{else if eq .Type "checkboxes"}} + {{range $chk_id, $chk := $field.Attributes.options}} +
+ {{end}} + {{else if and (eq .Type "dropdown") $field.Attributes.multiple}} + {{range $chk_id, $chk := $field.Attributes.options}} +
+ {{end}} + {{else if eq .Type "dropdown"}} + + {{end}} + + {{end}} +{{else}} +
+ {{.locale.Tr "write"}} + {{.locale.Tr "preview"}}
-
- {{.locale.Tr "loading"}} -
-
-{{if .IsAttachmentEnabled}}
- {{template "repo/upload" .}} +
+ +
+
+ {{.locale.Tr "loading"}} +
+ {{if .IsAttachmentEnabled}} +
+ {{template "repo/upload" .}} +
+ {{end}} {{end}} From 1539e79d05cf8dc72fe71c3a07b1b880adadb550 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sat, 27 Aug 2022 21:51:30 +0800 Subject: [PATCH 03/44] feat: render form to markdown --- modules/structs/issue.go | 6 ++ routers/web/repo/issue.go | 83 ++++++++++++++++++++++++++- templates/repo/issue/comment_tab.tmpl | 2 +- 3 files changed, 88 insertions(+), 3 deletions(-) diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 70d6392c1467b..e1c99fdee9842 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -7,6 +7,7 @@ package structs import ( "fmt" "path/filepath" + "strconv" "strings" "time" @@ -263,6 +264,11 @@ func (it *IssueTemplate) Fill(content []byte) error { it.About = compatibleTemplate.About } } + for i, v := range it.Body { + if v.ID == "" { + v.ID = strconv.Itoa(i) + } + } } return nil } diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index fe53c665ed5dd..9fc1cd1892475 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -775,7 +775,7 @@ func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleDirs, ctx.Data[issueTemplateTitleKey] = template.Title ctx.Data[ctxDataKey] = template.Content if template.Type() == "yaml" { - ctx.Data[ctxDataKey+"Form"] = template // TODO use template.Body + ctx.Data[ctxDataKey+"Form"] = template // TODO: maybe use template.Body } labelIDs := make([]string, 0, len(template.Labels)) if repoLabels, err := issues_model.GetLabelsByRepoID(ctx, ctx.Repo.Repository.ID, "", db.ListOptions{}); err == nil { @@ -1037,6 +1037,19 @@ func NewIssuePost(ctx *context.Context) { return } + content := form.Content + if form := ctx.Req.Form; form.Has("template-file") { + // If the issue submitted is a form, render it to Markdown + if c, err := renderIssueFormValues(ctx, &ctx.Req.Form); err != nil { + ctx.Flash.ErrorMsg = ctx.Tr("repo.issues.new.invalid_form_values") + ctx.Data["Flash"] = ctx.Flash + NewIssue(ctx) + return + } else { + content = c + } + } + issue := &issues_model.Issue{ RepoID: repo.ID, Repo: repo, @@ -1044,7 +1057,7 @@ func NewIssuePost(ctx *context.Context) { PosterID: ctx.Doer.ID, Poster: ctx.Doer, MilestoneID: milestoneID, - Content: form.Content, + Content: content, Ref: form.Ref, } @@ -1077,6 +1090,72 @@ func NewIssuePost(ctx *context.Context) { } } +// TODO: new design +// Renders the given form values to Markdown +// Returns an empty string if user submitted a non-form issue +func renderIssueFormValues(ctx *context.Context, form *url.Values) (string, error) { + filename := form.Get("template-file") + template := api.IssueTemplate{ + FileName: filename, + } + if templateContent, found := getFileContentFromDefaultBranch(ctx, form.Get("template-file")); !found { + return "", fmt.Errorf("template file %q not found", filename) + } else if err := template.Fill([]byte(templateContent)); err != nil { + return "", fmt.Errorf("fill template with %q: %w", filename, err) + } + + // Render values + result := "" + for _, field := range template.Body { + if field.ID != "" { + // Get field label + label := field.Attributes["label"] + if label == "" { + label = field.ID + } + + // Format the value into Markdown + if field.Type == "markdown" { + // Markdown blocks do not appear in output + } else if field.Type == "checkboxes" || (field.Type == "dropdown" && field.Attributes["multiple"] == true) { + result += fmt.Sprintf("### %s\n", label) + for i, option := range field.Attributes["options"].([]interface{}) { + // Get "checked" value + checkedStr := " " + isChecked := form.Get(fmt.Sprintf("form-field-%s-%d", field.ID, i)) == "on" + if isChecked { + checkedStr = "x" + } else if field.Type == "checkboxes" && (option.(map[interface{}]interface{})["required"] == true && !isChecked) { + return "", fmt.Errorf("checkbox #%d in field '%s' is required, but not checked", i, field.ID) + } + + // Get label + var label string + if field.Type == "checkboxes" { + label = option.(map[interface{}]interface{})["label"].(string) + } else { + label = option.(string) + } + result += fmt.Sprintf("- [%s] %s\n", checkedStr, label) + } + result += "\n" + } else if field.Type == "input" || field.Type == "textarea" || field.Type == "dropdown" { + if renderType, ok := field.Attributes["render"]; ok { + result += fmt.Sprintf("### %s\n```%s\n%s\n```\n\n", label, renderType, form.Get("form-field-"+field.ID)) + } else { + result += fmt.Sprintf("### %s\n%s\n\n", label, form.Get("form-field-"+field.ID)) + } + } else { + // Template should have been validated at this point + // TODO: should be better implemented + panic(fmt.Errorf("Invalid field type: '%s'", field.Type)) + } + } + } + + return result, nil +} + // roleDescriptor returns the Role Descriptor for a comment in/with the given repo, poster and issue func roleDescriptor(ctx stdCtx.Context, repo *repo_model.Repository, poster *user_model.User, issue *issues_model.Issue) (issues_model.RoleDescriptor, error) { perm, err := access_model.GetUserRepoPermission(ctx, repo, poster) diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index 59dccaf1ec046..684137dffe4c6 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -1,5 +1,5 @@ {{- if .IssueTemplateForm}} - + {{range $field_idx, $field := .IssueTemplateForm.Body}} {{- if $field.Attributes.label}}

{{$field.Attributes.label}} {{if $field.Validations.required}} *{{end}}

{{end}} {{- if $field.Attributes.description}}
{{RenderMarkdownToHtml $field.Attributes.description}}
{{end}} From bf89e5ae0c9aea2c4e0235976255999cf2df9691 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sat, 27 Aug 2022 22:16:12 +0800 Subject: [PATCH 04/44] feat: support yaml template for pr --- modules/structs/issue.go | 8 ------ routers/web/repo/issue.go | 14 ++++++++- routers/web/repo/pull.go | 41 +++++++++++++++++++++++++-- templates/repo/issue/comment_tab.tmpl | 6 ++-- 4 files changed, 54 insertions(+), 15 deletions(-) diff --git a/modules/structs/issue.go b/modules/structs/issue.go index e1c99fdee9842..6f3dc2b1f34bc 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -145,14 +145,6 @@ type IssueTemplateField struct { Validations map[string]interface{} `json:"validations" yaml:"validations"` } -func NewIssueTemplate(filename string, content []byte) (*IssueTemplate, error) { - ret := &IssueTemplate{ - FileName: filename, - } - - return ret, nil -} - // Validate checks whether an IssueTemplate is considered valid, and returns the first error func (it *IssueTemplate) Validate() error { // TODO check the format of id, and more diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index 9fc1cd1892475..290a7ece441a7 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -70,11 +70,23 @@ const ( // IssueTemplateCandidates issue templates var IssueTemplateCandidates = []string{ "ISSUE_TEMPLATE.md", + "ISSUE_TEMPLATE.yaml", + "ISSUE_TEMPLATE.yml", "issue_template.md", + "issue_template.yaml", + "issue_template.yml", ".gitea/ISSUE_TEMPLATE.md", + ".gitea/ISSUE_TEMPLATE.yaml", + ".gitea/ISSUE_TEMPLATE.yml", ".gitea/issue_template.md", + ".gitea/issue_template.yaml", + ".gitea/issue_template.md", + ".github/ISSUE_TEMPLATE.md", + ".github/ISSUE_TEMPLATE.yml", ".github/ISSUE_TEMPLATE.md", ".github/issue_template.md", + ".github/issue_template.yaml", + ".github/issue_template.yml", } // MustAllowUserComment checks to make sure if an issue is locked. @@ -775,7 +787,7 @@ func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleDirs, ctx.Data[issueTemplateTitleKey] = template.Title ctx.Data[ctxDataKey] = template.Content if template.Type() == "yaml" { - ctx.Data[ctxDataKey+"Form"] = template // TODO: maybe use template.Body + ctx.Data["TemplateForm"] = template // TODO: maybe use template.Body } labelIDs := make([]string, 0, len(template.Labels)) if repoLabels, err := issues_model.GetLabelsByRepoID(ctx, ctx.Repo.Repository.ID, "", db.ListOptions{}); err == nil { diff --git a/routers/web/repo/pull.go b/routers/web/repo/pull.go index 9b2c7c02cb78b..4342660f0a015 100644 --- a/routers/web/repo/pull.go +++ b/routers/web/repo/pull.go @@ -58,11 +58,20 @@ const ( var pullRequestTemplateCandidates = []string{ "PULL_REQUEST_TEMPLATE.md", + "PULL_REQUEST_TEMPLATE.yaml", + "PULL_REQUEST_TEMPLATE.yml", "pull_request_template.md", + "pull_request_template.yaml", + "pull_request_template.yml", ".gitea/PULL_REQUEST_TEMPLATE.md", + ".gitea/PULL_REQUEST_TEMPLATE.yaml", + ".gitea/PULL_REQUEST_TEMPLATE.yml", ".gitea/pull_request_template.md", + ".gitea/pull_request_template.yaml", + ".gitea/pull_request_template.yml", ".github/PULL_REQUEST_TEMPLATE.md", - ".github/pull_request_template.md", + ".github/PULL_REQUEST_TEMPLATE.yaml", + ".github/PULL_REQUEST_TEMPLATE.yml", } func getRepository(ctx *context.Context, repoID int64) *repo_model.Repository { @@ -1171,11 +1180,24 @@ func CompareAndPullRequestPost(ctx *context.Context) { return } + content := form.Content + if form := ctx.Req.Form; form.Has("template-file") { + // If the issue submitted is a form, render it to Markdown + if c, err := renderIssueFormValues(ctx, &ctx.Req.Form); err != nil { + ctx.Flash.ErrorMsg = ctx.Tr("repo.issues.new.invalid_form_values") + ctx.Data["Flash"] = ctx.Flash + NewIssue(ctx) + return + } else { + content = c + } + } + if len(form.Title) > 255 { var trailer string form.Title, trailer = util.SplitStringAtByteN(form.Title, 255) - form.Content = trailer + "\n\n" + form.Content + content = trailer + "\n\n" + content } middleware.AssignForm(form, ctx.Data) @@ -1194,6 +1216,19 @@ func CompareAndPullRequestPost(ctx *context.Context) { return } + content := form.Content + if form := ctx.Req.Form; form.Has("template-file") { + // If the issue submitted is a form, render it to Markdown + if c, err := renderIssueFormValues(ctx, &ctx.Req.Form); err != nil { + ctx.Flash.ErrorMsg = ctx.Tr("repo.issues.new.invalid_form_values") + ctx.Data["Flash"] = ctx.Flash + NewIssue(ctx) + return + } else { + content = c + } + } + pullIssue := &issues_model.Issue{ RepoID: repo.ID, Repo: repo, @@ -1202,7 +1237,7 @@ func CompareAndPullRequestPost(ctx *context.Context) { Poster: ctx.Doer, MilestoneID: milestoneID, IsPull: true, - Content: form.Content, + Content: content, } pullRequest := &issues_model.PullRequest{ HeadRepoID: ci.HeadRepo.ID, diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index 684137dffe4c6..9a471ccc6621c 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -1,6 +1,6 @@ -{{- if .IssueTemplateForm}} - - {{range $field_idx, $field := .IssueTemplateForm.Body}} +{{- if .TemplateForm}} + + {{range $field_idx, $field := .TemplateForm.Body}} {{- if $field.Attributes.label}}

{{$field.Attributes.label}} {{if $field.Validations.required}} *{{end}}

{{end}} {{- if $field.Attributes.description}}
{{RenderMarkdownToHtml $field.Attributes.description}}
{{end}} From 3337a6c7c348232ae865cbd14adabe4a8e496fbd Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sun, 28 Aug 2022 10:31:00 +0800 Subject: [PATCH 05/44] chore: rename to Fields --- modules/issue/template/template.go | 24 ++++++++++++++++++++++ modules/structs/issue.go | 33 +++++++++++++++--------------- routers/web/repo/issue.go | 2 +- 3 files changed, 42 insertions(+), 17 deletions(-) create mode 100644 modules/issue/template/template.go diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go new file mode 100644 index 0000000000000..b9ec2ae6921b9 --- /dev/null +++ b/modules/issue/template/template.go @@ -0,0 +1,24 @@ +// Copyright 2022 The Gitea Authors. All rights reserved. +// Use of this source code is governed by a MIT-style +// license that can be found in the LICENSE file. + +package template + +import "html/template" + +// Field represents a field interface which could be a component in the issue create UI +type Field interface { + Name() string + Description() string + Render() template.HTML +} + +type CheckBox struct{} + +type Markdown struct{} + +type Input struct{} + +type TextArea struct{} + +type Dropdown struct{} diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 6f3dc2b1f34bc..2988cd0465135 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -125,26 +125,27 @@ type IssueDeadline struct { Deadline *time.Time `json:"due_date"` } -// IssueTemplate represents an issue template for a repository -// swagger:model -type IssueTemplate struct { - Name string `json:"name" yaml:"name"` - Title string `json:"title" yaml:"title"` - About string `json:"about" yaml:"about"` - Labels []string `json:"labels" yaml:"labels"` - Ref string `json:"ref" yaml:"ref"` - Content string `json:"content" yaml:"-"` // for markdown only - Body []*IssueTemplateField `json:"body" yaml:"body"` // for yaml only - FileName string `json:"file_name" yaml:"-"` -} - -type IssueTemplateField struct { +// IssueFormField represents a form field +type IssueFormField struct { Type string `json:"type" yaml:"type"` ID string `json:"id" yaml:"id"` Attributes map[string]interface{} `json:"attributes" yaml:"attributes"` Validations map[string]interface{} `json:"validations" yaml:"validations"` } +// IssueTemplate represents an issue template for a repository +// swagger:model +type IssueTemplate struct { + Name string `json:"name" yaml:"name"` + Title string `json:"title" yaml:"title"` + About string `json:"about" yaml:"about"` + Labels []string `json:"labels" yaml:"labels"` + Ref string `json:"ref" yaml:"ref"` + Content string `json:"content" yaml:"-"` // for markdown only + Fields []*IssueFormField `json:"body" yaml:"body"` // for yaml only + FileName string `json:"file_name" yaml:"-"` +} + // Validate checks whether an IssueTemplate is considered valid, and returns the first error func (it *IssueTemplate) Validate() error { // TODO check the format of id, and more @@ -160,7 +161,7 @@ func (it *IssueTemplate) Validate() error { return errMissField("about") } - for idx, field := range it.Body { + for idx, field := range it.Fields { checkStringAttr := func(name string) error { attr := field.Attributes[name] if s, ok := attr.(string); !ok || s == "" { @@ -256,7 +257,7 @@ func (it *IssueTemplate) Fill(content []byte) error { it.About = compatibleTemplate.About } } - for i, v := range it.Body { + for i, v := range it.Fields { if v.ID == "" { v.ID = strconv.Itoa(i) } diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index 290a7ece441a7..a2acb1b3d7b2a 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -1118,7 +1118,7 @@ func renderIssueFormValues(ctx *context.Context, form *url.Values) (string, erro // Render values result := "" - for _, field := range template.Body { + for _, field := range template.Fields { if field.ID != "" { // Get field label label := field.Attributes["label"] From d25217d9b65f543a96fd3c850924e507ea9ddccc Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sun, 28 Aug 2022 11:44:21 +0800 Subject: [PATCH 06/44] feat: template unmarshal --- modules/context/repo.go | 62 +++++-------------- modules/issue/template/unmarshal.go | 92 +++++++++++++++++++++++++++++ modules/structs/issue.go | 77 ++---------------------- routers/web/repo/issue.go | 58 ++++-------------- 4 files changed, 123 insertions(+), 166 deletions(-) create mode 100644 modules/issue/template/unmarshal.go diff --git a/modules/context/repo.go b/modules/context/repo.go index d8c3fad661e81..3d19db31eeb38 100644 --- a/modules/context/repo.go +++ b/modules/context/repo.go @@ -9,11 +9,9 @@ import ( "context" "fmt" "html" - "io" "net/http" "net/url" "path" - "path/filepath" "strings" "code.gitea.io/gitea/models" @@ -27,6 +25,7 @@ import ( "code.gitea.io/gitea/modules/cache" "code.gitea.io/gitea/modules/git" code_indexer "code.gitea.io/gitea/modules/indexer/code" + "code.gitea.io/gitea/modules/issue/template" "code.gitea.io/gitea/modules/log" repo_module "code.gitea.io/gitea/modules/repository" "code.gitea.io/gitea/modules/setting" @@ -1035,8 +1034,8 @@ func UnitTypes() func(ctx *Context) { } // IssueTemplatesFromDefaultBranch checks for issue templates in the repo's default branch -func (ctx *Context) IssueTemplatesFromDefaultBranch() []api.IssueTemplate { - var issueTemplates []api.IssueTemplate +func (ctx *Context) IssueTemplatesFromDefaultBranch() []*api.IssueTemplate { + var issueTemplates []*api.IssueTemplate if ctx.Repo.Repository.IsEmpty { return issueTemplates @@ -1060,52 +1059,19 @@ func (ctx *Context) IssueTemplatesFromDefaultBranch() []api.IssueTemplate { return issueTemplates } for _, entry := range entries { - if t := ctx.extractIssueTemplate(entry); t != nil { - issueTemplates = append(issueTemplates, *t) + it := &api.IssueTemplate{ + FileName: entry.Name(), + } + if it.Type() == "" { + continue + } + it, err := template.UnmarshalFromEntry(entry) + if err != nil { + log.Debug("unmarshal template from %s: %v", entry.Name(), err) + } else if it.Valid() { + issueTemplates = append(issueTemplates, it) } } } return issueTemplates } - -func (ctx *Context) extractIssueTemplate(entry *git.TreeEntry) *api.IssueTemplate { - it := &api.IssueTemplate{ - FileName: entry.Name(), - } - if it.Type() == "" { - return nil - } - - if name := filepath.Base(it.FileName); name == "config.yaml" || name == "config.yml" { - // ignore config.yaml which is a special configuration file - return nil - } - - if entry.Blob().Size() >= setting.UI.MaxDisplayFileSize { - log.Debug("Issue template is too large: %s", entry.Name()) - return nil - } - - r, err := entry.Blob().DataAsync() - if err != nil { - log.Debug("DataAsync: %v", err) - return nil - } - defer r.Close() - - data, err := io.ReadAll(r) - if err != nil { - log.Debug("ReadAll: %v", err) - return nil - } - - if err := it.Fill(data); err != nil { - log.Debug("fill template: %v", err) - return nil - } - - if !it.Valid() { - return nil - } - return it -} diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go new file mode 100644 index 0000000000000..97c5f2a211ef7 --- /dev/null +++ b/modules/issue/template/unmarshal.go @@ -0,0 +1,92 @@ +// Copyright 2022 The Gitea Authors. All rights reserved. +// Use of this source code is governed by a MIT-style +// license that can be found in the LICENSE file. + +package template + +import ( + "fmt" + "io" + "strconv" + + "code.gitea.io/gitea/modules/git" + "code.gitea.io/gitea/modules/markup/markdown" + "code.gitea.io/gitea/modules/setting" + api "code.gitea.io/gitea/modules/structs" + + "gopkg.in/yaml.v2" +) + +// TODO +func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { + it := &api.IssueTemplate{ + FileName: filename, + } + + if typ := it.Type(); typ == "md" { + templateBody, err := markdown.ExtractMetadata(string(content), it) + if err != nil { + return nil, fmt.Errorf("extract metadata: %w", err) + } + it.Content = templateBody + } else if typ == "yaml" { + if err := yaml.Unmarshal(content, it); err != nil { + return nil, fmt.Errorf("yaml unmarshal: %w", err) + } + if it.About == "" { + // Compatible with treating description as about + compatibleTemplate := &struct { + About string `yaml:"description"` + }{} + if err := yaml.Unmarshal(content, compatibleTemplate); err == nil && compatibleTemplate.About != "" { + it.About = compatibleTemplate.About + } + } + for i, v := range it.Fields { + if v.ID == "" { + v.ID = strconv.Itoa(i) + } + } + } + + return it, nil +} + +// TODO +func UnmarshalFromEntry(entry *git.TreeEntry) (*api.IssueTemplate, error) { + if size := entry.Blob().Size(); size > setting.UI.MaxDisplayFileSize { + return nil, fmt.Errorf("too large: %v > MaxDisplayFileSize", size) + } + + r, err := entry.Blob().DataAsync() + if err != nil { + return nil, fmt.Errorf("data async: %w", err) + } + defer r.Close() + + content, err := io.ReadAll(r) + if err != nil { + return nil, fmt.Errorf("read all: %w", err) + } + + return Unmarshal(entry.Name(), content) +} + +// TODO +func UnmarshalFromCommit(commit *git.Commit, filename string) (*api.IssueTemplate, error) { + entry, err := commit.GetTreeEntryByPath(filename) + if err != nil { + return nil, fmt.Errorf("get entry for %q: %w", filename, err) + } + return UnmarshalFromEntry(entry) +} + +// TODO +func UnmarshalFromRepo(repo *git.Repository, branch, filename string) (*api.IssueTemplate, error) { + commit, err := repo.GetBranchCommit(branch) + if err != nil { + return nil, fmt.Errorf("get commit on branch %q: %w", branch, err) + } + + return UnmarshalFromCommit(commit, filename) +} diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 2988cd0465135..73a9d246faeb9 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -7,11 +7,8 @@ package structs import ( "fmt" "path/filepath" - "strconv" "strings" "time" - - "gopkg.in/yaml.v2" ) // StateType issue state type @@ -229,6 +226,11 @@ func (it *IssueTemplate) Valid() bool { // Type returns the type of IssueTemplate, it could be "md", "yaml" or empty for known func (it *IssueTemplate) Type() string { + if it.Name == "config.yaml" || it.Name == "config.yml" { + // TODO: should it be? + // ignore config.yaml which is a special configuration file + return "" + } if ext := filepath.Ext(it.FileName); ext == ".md" { return "md" } else if ext == ".yaml" || ext == ".yml" { @@ -236,72 +238,3 @@ func (it *IssueTemplate) Type() string { } return "" } - -func (it *IssueTemplate) Fill(content []byte) error { - if typ := it.Type(); typ == "md" { - templateBody, err := it.extractMetadata(string(content), it) - if err != nil { - return fmt.Errorf("extract metadata: %w", err) - } - it.Content = templateBody - } else if typ == "yaml" { - if err := yaml.Unmarshal(content, it); err != nil { - return fmt.Errorf("yaml unmarshal: %w", err) - } - if it.About == "" { - // Compatible with treating description as about - compatibleTemplate := &struct { - About string `yaml:"description"` - }{} - if err := yaml.Unmarshal(content, compatibleTemplate); err == nil && compatibleTemplate.About != "" { - it.About = compatibleTemplate.About - } - } - for i, v := range it.Fields { - if v.ID == "" { - v.ID = strconv.Itoa(i) - } - } - } - return nil -} - -// extractMetadata consumes a markdown file, parses YAML frontmatter, -// and returns the frontmatter metadata separated from the markdown content. -// Copy from markdown.ExtractMetadata to avoid import cycle. -func (*IssueTemplate) extractMetadata(contents string, out interface{}) (string, error) { - isYAMLSeparator := func(line string) bool { - line = strings.TrimSpace(line) - for i := 0; i < len(line); i++ { - if line[i] != '-' { - return false - } - } - return len(line) > 2 - } - - var front, body []string - lines := strings.Split(contents, "\n") - for idx, line := range lines { - if idx == 0 { - // First line has to be a separator - if !isYAMLSeparator(line) { - return "", fmt.Errorf("frontmatter must start with a separator line") - } - continue - } - if isYAMLSeparator(line) { - front, body = lines[1:idx], lines[idx+1:] - break - } - } - - if len(front) == 0 { - return "", fmt.Errorf("could not determine metadata") - } - - if err := yaml.Unmarshal([]byte(strings.Join(front, "\n")), out); err != nil { - return "", err - } - return strings.Join(body, "\n"), nil -} diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index a2acb1b3d7b2a..aa4545c126b7c 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -10,7 +10,6 @@ import ( stdCtx "context" "errors" "fmt" - "io" "math/big" "net/http" "net/url" @@ -35,6 +34,7 @@ import ( "code.gitea.io/gitea/modules/convert" "code.gitea.io/gitea/modules/git" issue_indexer "code.gitea.io/gitea/modules/indexer/issues" + issue_template "code.gitea.io/gitea/modules/issue/template" "code.gitea.io/gitea/modules/log" "code.gitea.io/gitea/modules/markup" "code.gitea.io/gitea/modules/markup/markdown" @@ -734,34 +734,6 @@ func RetrieveRepoMetas(ctx *context.Context, repo *repo_model.Repository, isPull return labels } -func getFileContentFromDefaultBranch(ctx *context.Context, filename string) (string, bool) { - if ctx.Repo.Commit == nil { - var err error - ctx.Repo.Commit, err = ctx.Repo.GitRepo.GetBranchCommit(ctx.Repo.Repository.DefaultBranch) - if err != nil { - return "", false - } - } - - entry, err := ctx.Repo.Commit.GetTreeEntryByPath(filename) - if err != nil { - return "", false - } - if entry.Blob().Size() >= setting.UI.MaxDisplayFileSize { - return "", false - } - r, err := entry.Blob().DataAsync() - if err != nil { - return "", false - } - defer r.Close() - bytes, err := io.ReadAll(r) - if err != nil { - return "", false - } - return string(bytes), true -} - func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleDirs, possibleFiles []string) { templateCandidates := make([]string, 0, len(possibleDirs)+len(possibleFiles)) if t := ctx.FormString("template"); t != "" { @@ -771,23 +743,19 @@ func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleDirs, } templateCandidates = append(templateCandidates, possibleFiles...) // Append files to the end because they should be fallback for _, filename := range templateCandidates { - templateContent, found := getFileContentFromDefaultBranch(ctx, filename) - if !found { + template, err := issue_template.UnmarshalFromRepo(ctx.Repo.GitRepo, ctx.Repo.Repository.DefaultBranch, filename) + if err == nil { continue } - template := api.IssueTemplate{ - FileName: filename, - } - if err := template.Fill([]byte(templateContent)); err != nil { - log.Debug("could fill template from %s [%s]: %v", filename, ctx.Repo.Repository.FullName(), err) - ctx.Data[ctxDataKey] = templateContent - return + if !template.Valid() { + continue } ctx.Data[issueTemplateTitleKey] = template.Title ctx.Data[ctxDataKey] = template.Content + if template.Type() == "yaml" { - ctx.Data["TemplateForm"] = template // TODO: maybe use template.Body + ctx.Data["Fields"] = template.Fields } labelIDs := make([]string, 0, len(template.Labels)) if repoLabels, err := issues_model.GetLabelsByRepoID(ctx, ctx.Repo.Repository.ID, "", db.ListOptions{}); err == nil { @@ -1107,13 +1075,11 @@ func NewIssuePost(ctx *context.Context) { // Returns an empty string if user submitted a non-form issue func renderIssueFormValues(ctx *context.Context, form *url.Values) (string, error) { filename := form.Get("template-file") - template := api.IssueTemplate{ - FileName: filename, - } - if templateContent, found := getFileContentFromDefaultBranch(ctx, form.Get("template-file")); !found { - return "", fmt.Errorf("template file %q not found", filename) - } else if err := template.Fill([]byte(templateContent)); err != nil { - return "", fmt.Errorf("fill template with %q: %w", filename, err) + template, err := issue_template.UnmarshalFromRepo(ctx.Repo.GitRepo, ctx.Repo.Repository.DefaultBranch, form.Get("template-file")) + if err != nil { + return "", fmt.Errorf("unmarshal template %q: %w", filename, err) + } else if !template.Valid() { + return "", fmt.Errorf("invalid template %q", filename) } // Render values From c0a37272fa2deb64daaf793d569c6fa60d90863e Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sun, 28 Aug 2022 15:15:39 +0800 Subject: [PATCH 07/44] feat: split template --- modules/issue/template/template.go | 1 + modules/structs/issue.go | 10 +-- routers/web/repo/issue.go | 2 +- templates/repo/issue/comment_tab.tmpl | 84 +++++---------------- templates/repo/issue/fields/checkboxes.tmpl | 13 ++++ templates/repo/issue/fields/dropdown.tmpl | 23 ++++++ templates/repo/issue/fields/header.tmpl | 10 +++ templates/repo/issue/fields/input.tmpl | 9 +++ templates/repo/issue/fields/markdown.tmpl | 1 + templates/repo/issue/fields/textarea.tmpl | 8 ++ 10 files changed, 88 insertions(+), 73 deletions(-) create mode 100644 templates/repo/issue/fields/checkboxes.tmpl create mode 100644 templates/repo/issue/fields/dropdown.tmpl create mode 100644 templates/repo/issue/fields/header.tmpl create mode 100644 templates/repo/issue/fields/input.tmpl create mode 100644 templates/repo/issue/fields/markdown.tmpl create mode 100644 templates/repo/issue/fields/textarea.tmpl diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index b9ec2ae6921b9..7e1b34976ef61 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -7,6 +7,7 @@ package template import "html/template" // Field represents a field interface which could be a component in the issue create UI +// TODO: Do we need it? type Field interface { Name() string Description() string diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 73a9d246faeb9..420ca872dc35b 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -138,13 +138,13 @@ type IssueTemplate struct { About string `json:"about" yaml:"about"` Labels []string `json:"labels" yaml:"labels"` Ref string `json:"ref" yaml:"ref"` - Content string `json:"content" yaml:"-"` // for markdown only - Fields []*IssueFormField `json:"body" yaml:"body"` // for yaml only + Content string `json:"content" yaml:"-"` + Fields []*IssueFormField `json:"body" yaml:"body"` FileName string `json:"file_name" yaml:"-"` } // Validate checks whether an IssueTemplate is considered valid, and returns the first error -func (it *IssueTemplate) Validate() error { +func (it IssueTemplate) Validate() error { // TODO check the format of id, and more errMissField := func(f string) error { @@ -220,12 +220,12 @@ func (it *IssueTemplate) Validate() error { } // Valid checks whether an IssueTemplate is considered valid, e.g. at least name and about -func (it *IssueTemplate) Valid() bool { +func (it IssueTemplate) Valid() bool { return it.Validate() == nil } // Type returns the type of IssueTemplate, it could be "md", "yaml" or empty for known -func (it *IssueTemplate) Type() string { +func (it IssueTemplate) Type() string { if it.Name == "config.yaml" || it.Name == "config.yml" { // TODO: should it be? // ignore config.yaml which is a special configuration file diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index aa4545c126b7c..4ef16d39c11ef 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -744,7 +744,7 @@ func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleDirs, templateCandidates = append(templateCandidates, possibleFiles...) // Append files to the end because they should be fallback for _, filename := range templateCandidates { template, err := issue_template.UnmarshalFromRepo(ctx.Repo.GitRepo, ctx.Repo.Repository.DefaultBranch, filename) - if err == nil { + if err != nil { continue } if !template.Valid() { diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index 9a471ccc6621c..48c01bb2a362c 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -1,66 +1,16 @@ -{{- if .TemplateForm}} - - {{range $field_idx, $field := .TemplateForm.Body}} - {{- if $field.Attributes.label}}

{{$field.Attributes.label}} {{if $field.Validations.required}} *{{end}}

{{end}} - {{- if $field.Attributes.description}}
{{RenderMarkdownToHtml $field.Attributes.description}}
{{end}} - - {{- if eq .Type "markdown"}} -
{{RenderMarkdownToHtml $field.Attributes.value}}
- {{else if eq .Type "input"}} - +{{if .Fields}} + {{range .Fields}} + {{if eq .Type "input"}} + {{template "repo/issue/fields/input" .}} + {{else if eq .Type "markdown"}} + {{template "repo/issue/fields/markdown" .}} {{else if eq .Type "textarea"}} - {{- if .Attributes.render}} - - {{end}} - - {{else if eq .Type "checkboxes"}} - {{range $chk_id, $chk := $field.Attributes.options}} -
- {{end}} - {{else if and (eq .Type "dropdown") $field.Attributes.multiple}} - {{range $chk_id, $chk := $field.Attributes.options}} -
- {{end}} + {{template "repo/issue/fields/textarea" .}} {{else if eq .Type "dropdown"}} - + {{template "repo/issue/fields/dropdown" .}} + {{else if eq .Type "checkboxes"}} + {{template "repo/issue/fields/checkboxes" .}} {{end}} - {{end}} {{else}}
@@ -69,17 +19,17 @@
- +
- {{.locale.Tr "loading"}} + {{.locale.Tr "loading"}}
- {{if .IsAttachmentEnabled}} + {{if .IsAttachmentEnabled}}
- {{template "repo/upload" .}} + {{template "repo/upload" .}}
- {{end}} + {{end}} {{end}} diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl new file mode 100644 index 0000000000000..19ea63f15ef16 --- /dev/null +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -0,0 +1,13 @@ +{{template "repo/issue/fields/header" .}} +{{$field := .}} +{{range $i, $opt := .Attributes.options}} +
+{{end}} diff --git a/templates/repo/issue/fields/dropdown.tmpl b/templates/repo/issue/fields/dropdown.tmpl new file mode 100644 index 0000000000000..f2942252f1401 --- /dev/null +++ b/templates/repo/issue/fields/dropdown.tmpl @@ -0,0 +1,23 @@ +{{template "repo/issue/fields/header" .}} +{{$field := .}} +{{if .Attributes.multiple}} + {{range $i, $opt := .Attributes.options}} +
+ {{end}} +{{else}} + +{{end}} diff --git a/templates/repo/issue/fields/header.tmpl b/templates/repo/issue/fields/header.tmpl new file mode 100644 index 0000000000000..991eef8f8b616 --- /dev/null +++ b/templates/repo/issue/fields/header.tmpl @@ -0,0 +1,10 @@ +{{- if .Attributes.label}} +

{{.Attributes.label}} + {{if .Validations.required}} + * + {{end}} +

+{{end}} +{{- if .Attributes.description}} +
{{RenderMarkdownToHtml .Attributes.description}}
+{{end}} diff --git a/templates/repo/issue/fields/input.tmpl b/templates/repo/issue/fields/input.tmpl new file mode 100644 index 0000000000000..75e748b30052a --- /dev/null +++ b/templates/repo/issue/fields/input.tmpl @@ -0,0 +1,9 @@ +{{template "repo/issue/fields/header" .}} + diff --git a/templates/repo/issue/fields/markdown.tmpl b/templates/repo/issue/fields/markdown.tmpl new file mode 100644 index 0000000000000..668ad3e93da20 --- /dev/null +++ b/templates/repo/issue/fields/markdown.tmpl @@ -0,0 +1 @@ +
{{RenderMarkdownToHtml .Attributes.value}}
diff --git a/templates/repo/issue/fields/textarea.tmpl b/templates/repo/issue/fields/textarea.tmpl new file mode 100644 index 0000000000000..260ddaf998f7c --- /dev/null +++ b/templates/repo/issue/fields/textarea.tmpl @@ -0,0 +1,8 @@ +{{template "repo/issue/fields/header" .}} + From 7de200b7de665df45b414397d8998860dcffe270 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sun, 28 Aug 2022 16:41:03 +0800 Subject: [PATCH 08/44] feat: render to markdown --- modules/issue/template/render.go | 121 +++++++++++++++++++++++++++++++ routers/web/repo/issue.go | 76 +------------------ routers/web/repo/pull.go | 31 ++------ 3 files changed, 132 insertions(+), 96 deletions(-) create mode 100644 modules/issue/template/render.go diff --git a/modules/issue/template/render.go b/modules/issue/template/render.go new file mode 100644 index 0000000000000..189b714b5cf9f --- /dev/null +++ b/modules/issue/template/render.go @@ -0,0 +1,121 @@ +// Copyright 2022 The Gitea Authors. All rights reserved. +// Use of this source code is governed by a MIT-style +// license that can be found in the LICENSE file. + +package template + +import ( + "fmt" + "net/url" + "strings" + + api "code.gitea.io/gitea/modules/structs" +) + +func RenderToMarkdown(template *api.IssueTemplate, values url.Values) string { + builder := &strings.Builder{} + + for _, field := range template.Fields { + f := &valuedField{ + IssueFormField: field, + Values: values, + } + if f.ID == "" { + continue + } + f.WriteTo(builder) + } + + return builder.String() +} + +type valuedField struct { + *api.IssueFormField + url.Values +} + +func (f *valuedField) WriteTo(builder *strings.Builder) { + if f.Type == "markdown" { + // markdown blocks do not appear in output + return + } + + // write label + _, _ = fmt.Fprintf(builder, "### %s\n", f.Label()) + + // write body + switch f.Type { + case "checkboxes", "dropdown": + for _, option := range f.Options() { + checked := " " + if option.IsChecked() { + checked = "x" + } + _, _ = fmt.Fprintf(builder, "- [%s] %s\n", checked, option.Label()) + } + case "input": + _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) + case "textarea": + _, _ = fmt.Fprintf(builder, "```%s\n%s```", f.Render(), f.Value()) + } + _, _ = fmt.Fprintln(builder) +} + +func (f *valuedField) Label() string { + if label, ok := f.Attributes["label"].(string); ok { + return label + } + return "" +} + +func (f *valuedField) Render() string { + if render, ok := f.Attributes["render"].(string); ok { + return render + } + return "" +} + +func (f *valuedField) Value() string { + return f.Get(fmt.Sprintf("form-field-" + f.ID)) +} + +func (f *valuedField) Options() []*valuedOption { + if options, ok := f.Attributes["options"].([]interface{}); ok { + ret := make([]*valuedOption, 0, len(options)) + for i, option := range options { + ret = append(ret, &valuedOption{ + index: i, + data: option, + field: f, + }) + } + return ret + } + return nil +} + +type valuedOption struct { + index int + data interface{} + field *valuedField +} + +func (o *valuedOption) Label() string { + switch o.field.Type { + case "dropdown": + if label, ok := o.data.(string); ok { + return label + } + case "checkboxes": + if vs, ok := o.data.(map[interface{}]interface{}); ok { + if v, ok := vs["label"].(string); ok { + return v + } + } + } + return "" +} + +func (o *valuedOption) IsChecked() bool { + return o.field.Get(fmt.Sprintf("form-field-%s-%d", o.field.ID, o.index)) == "on" +} diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index 4ef16d39c11ef..f2c81c87c6a46 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -1018,15 +1018,9 @@ func NewIssuePost(ctx *context.Context) { } content := form.Content - if form := ctx.Req.Form; form.Has("template-file") { - // If the issue submitted is a form, render it to Markdown - if c, err := renderIssueFormValues(ctx, &ctx.Req.Form); err != nil { - ctx.Flash.ErrorMsg = ctx.Tr("repo.issues.new.invalid_form_values") - ctx.Data["Flash"] = ctx.Flash - NewIssue(ctx) - return - } else { - content = c + if filename := ctx.Req.Form.Get("template-file"); filename != "" { + if template, err := issue_template.UnmarshalFromRepo(ctx.Repo.GitRepo, ctx.Repo.Repository.DefaultBranch, filename); err == nil { + content = issue_template.RenderToMarkdown(template, ctx.Req.Form) } } @@ -1070,70 +1064,6 @@ func NewIssuePost(ctx *context.Context) { } } -// TODO: new design -// Renders the given form values to Markdown -// Returns an empty string if user submitted a non-form issue -func renderIssueFormValues(ctx *context.Context, form *url.Values) (string, error) { - filename := form.Get("template-file") - template, err := issue_template.UnmarshalFromRepo(ctx.Repo.GitRepo, ctx.Repo.Repository.DefaultBranch, form.Get("template-file")) - if err != nil { - return "", fmt.Errorf("unmarshal template %q: %w", filename, err) - } else if !template.Valid() { - return "", fmt.Errorf("invalid template %q", filename) - } - - // Render values - result := "" - for _, field := range template.Fields { - if field.ID != "" { - // Get field label - label := field.Attributes["label"] - if label == "" { - label = field.ID - } - - // Format the value into Markdown - if field.Type == "markdown" { - // Markdown blocks do not appear in output - } else if field.Type == "checkboxes" || (field.Type == "dropdown" && field.Attributes["multiple"] == true) { - result += fmt.Sprintf("### %s\n", label) - for i, option := range field.Attributes["options"].([]interface{}) { - // Get "checked" value - checkedStr := " " - isChecked := form.Get(fmt.Sprintf("form-field-%s-%d", field.ID, i)) == "on" - if isChecked { - checkedStr = "x" - } else if field.Type == "checkboxes" && (option.(map[interface{}]interface{})["required"] == true && !isChecked) { - return "", fmt.Errorf("checkbox #%d in field '%s' is required, but not checked", i, field.ID) - } - - // Get label - var label string - if field.Type == "checkboxes" { - label = option.(map[interface{}]interface{})["label"].(string) - } else { - label = option.(string) - } - result += fmt.Sprintf("- [%s] %s\n", checkedStr, label) - } - result += "\n" - } else if field.Type == "input" || field.Type == "textarea" || field.Type == "dropdown" { - if renderType, ok := field.Attributes["render"]; ok { - result += fmt.Sprintf("### %s\n```%s\n%s\n```\n\n", label, renderType, form.Get("form-field-"+field.ID)) - } else { - result += fmt.Sprintf("### %s\n%s\n\n", label, form.Get("form-field-"+field.ID)) - } - } else { - // Template should have been validated at this point - // TODO: should be better implemented - panic(fmt.Errorf("Invalid field type: '%s'", field.Type)) - } - } - } - - return result, nil -} - // roleDescriptor returns the Role Descriptor for a comment in/with the given repo, poster and issue func roleDescriptor(ctx stdCtx.Context, repo *repo_model.Repository, poster *user_model.User, issue *issues_model.Issue) (issues_model.RoleDescriptor, error) { perm, err := access_model.GetUserRepoPermission(ctx, repo, poster) diff --git a/routers/web/repo/pull.go b/routers/web/repo/pull.go index 4342660f0a015..aa2c4cdb53b2d 100644 --- a/routers/web/repo/pull.go +++ b/routers/web/repo/pull.go @@ -30,6 +30,7 @@ import ( "code.gitea.io/gitea/modules/base" "code.gitea.io/gitea/modules/context" "code.gitea.io/gitea/modules/git" + issue_template "code.gitea.io/gitea/modules/issue/template" "code.gitea.io/gitea/modules/log" "code.gitea.io/gitea/modules/notification" "code.gitea.io/gitea/modules/setting" @@ -72,6 +73,9 @@ var pullRequestTemplateCandidates = []string{ ".github/PULL_REQUEST_TEMPLATE.md", ".github/PULL_REQUEST_TEMPLATE.yaml", ".github/PULL_REQUEST_TEMPLATE.yml", + ".github/pull_request_template.md", + ".github/pull_request_template.yaml", + ".github/pull_request_template.yml", } func getRepository(ctx *context.Context, repoID int64) *repo_model.Repository { @@ -1180,24 +1184,11 @@ func CompareAndPullRequestPost(ctx *context.Context) { return } - content := form.Content - if form := ctx.Req.Form; form.Has("template-file") { - // If the issue submitted is a form, render it to Markdown - if c, err := renderIssueFormValues(ctx, &ctx.Req.Form); err != nil { - ctx.Flash.ErrorMsg = ctx.Tr("repo.issues.new.invalid_form_values") - ctx.Data["Flash"] = ctx.Flash - NewIssue(ctx) - return - } else { - content = c - } - } - if len(form.Title) > 255 { var trailer string form.Title, trailer = util.SplitStringAtByteN(form.Title, 255) - content = trailer + "\n\n" + content + form.Content = trailer + "\n\n" + form.Content } middleware.AssignForm(form, ctx.Data) @@ -1217,15 +1208,9 @@ func CompareAndPullRequestPost(ctx *context.Context) { } content := form.Content - if form := ctx.Req.Form; form.Has("template-file") { - // If the issue submitted is a form, render it to Markdown - if c, err := renderIssueFormValues(ctx, &ctx.Req.Form); err != nil { - ctx.Flash.ErrorMsg = ctx.Tr("repo.issues.new.invalid_form_values") - ctx.Data["Flash"] = ctx.Flash - NewIssue(ctx) - return - } else { - content = c + if filename := ctx.Req.Form.Get("template-file"); filename != "" { + if template, err := issue_template.UnmarshalFromRepo(ctx.Repo.GitRepo, ctx.Repo.Repository.DefaultBranch, filename); err == nil { + content = issue_template.RenderToMarkdown(template, ctx.Req.Form) } } From a949489e41871ae7199799132d4935da66effe5b Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sun, 28 Aug 2022 18:01:34 +0800 Subject: [PATCH 09/44] feat: use full name as template file name --- modules/context/repo.go | 7 ++-- modules/issue/template/render.go | 2 +- modules/issue/template/unmarshal.go | 48 +++++++++++++++++---------- routers/web/repo/compare.go | 2 +- routers/web/repo/issue.go | 12 +++---- templates/repo/issue/comment_tab.tmpl | 1 + 6 files changed, 40 insertions(+), 32 deletions(-) diff --git a/modules/context/repo.go b/modules/context/repo.go index 3d19db31eeb38..272811442feae 100644 --- a/modules/context/repo.go +++ b/modules/context/repo.go @@ -1059,13 +1059,10 @@ func (ctx *Context) IssueTemplatesFromDefaultBranch() []*api.IssueTemplate { return issueTemplates } for _, entry := range entries { - it := &api.IssueTemplate{ - FileName: entry.Name(), - } - if it.Type() == "" { + if !template.CouldBe(entry.Name()) { continue } - it, err := template.UnmarshalFromEntry(entry) + it, err := template.UnmarshalFromEntry(entry, dirName) if err != nil { log.Debug("unmarshal template from %s: %v", entry.Name(), err) } else if it.Valid() { diff --git a/modules/issue/template/render.go b/modules/issue/template/render.go index 189b714b5cf9f..c4e8e899e922b 100644 --- a/modules/issue/template/render.go +++ b/modules/issue/template/render.go @@ -56,7 +56,7 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { case "input": _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) case "textarea": - _, _ = fmt.Fprintf(builder, "```%s\n%s```", f.Render(), f.Value()) + _, _ = fmt.Fprintf(builder, "```%s\n%s\n```\n", f.Render(), f.Value()) } _, _ = fmt.Fprintln(builder) } diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 97c5f2a211ef7..12b2be18d2fc9 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -7,6 +7,7 @@ package template import ( "fmt" "io" + "path/filepath" "strconv" "code.gitea.io/gitea/modules/git" @@ -53,23 +54,8 @@ func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { } // TODO -func UnmarshalFromEntry(entry *git.TreeEntry) (*api.IssueTemplate, error) { - if size := entry.Blob().Size(); size > setting.UI.MaxDisplayFileSize { - return nil, fmt.Errorf("too large: %v > MaxDisplayFileSize", size) - } - - r, err := entry.Blob().DataAsync() - if err != nil { - return nil, fmt.Errorf("data async: %w", err) - } - defer r.Close() - - content, err := io.ReadAll(r) - if err != nil { - return nil, fmt.Errorf("read all: %w", err) - } - - return Unmarshal(entry.Name(), content) +func UnmarshalFromEntry(entry *git.TreeEntry, dir string) (*api.IssueTemplate, error) { + return unmarshalFromEntry(entry, filepath.Join(dir, entry.Name())) } // TODO @@ -78,7 +64,7 @@ func UnmarshalFromCommit(commit *git.Commit, filename string) (*api.IssueTemplat if err != nil { return nil, fmt.Errorf("get entry for %q: %w", filename, err) } - return UnmarshalFromEntry(entry) + return unmarshalFromEntry(entry, filename) } // TODO @@ -90,3 +76,29 @@ func UnmarshalFromRepo(repo *git.Repository, branch, filename string) (*api.Issu return UnmarshalFromCommit(commit, filename) } + +func unmarshalFromEntry(entry *git.TreeEntry, filename string) (*api.IssueTemplate, error) { + if size := entry.Blob().Size(); size > setting.UI.MaxDisplayFileSize { + return nil, fmt.Errorf("too large: %v > MaxDisplayFileSize", size) + } + + r, err := entry.Blob().DataAsync() + if err != nil { + return nil, fmt.Errorf("data async: %w", err) + } + defer r.Close() + + content, err := io.ReadAll(r) + if err != nil { + return nil, fmt.Errorf("read all: %w", err) + } + + return Unmarshal(filename, content) +} + +func CouldBe(filename string) bool { + it := &api.IssueTemplate{ + FileName: filename, + } + return it.Type() != "" +} diff --git a/routers/web/repo/compare.go b/routers/web/repo/compare.go index f34d3a520343a..cdd80f57a7b58 100644 --- a/routers/web/repo/compare.go +++ b/routers/web/repo/compare.go @@ -784,7 +784,7 @@ func CompareDiff(ctx *context.Context) { ctx.Data["IsRepoToolbarCommits"] = true ctx.Data["IsDiffCompare"] = true ctx.Data["RequireTribute"] = true - setTemplateIfExists(ctx, pullRequestTemplateKey, nil, pullRequestTemplateCandidates) + setTemplateIfExists(ctx, pullRequestTemplateKey, pullRequestTemplateCandidates) // If a template content is set, prepend the "content". In this case that's only // applicable if you have one commit to compare and that commit has a message. diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index f2c81c87c6a46..4d6794f4d1ec9 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -13,7 +13,6 @@ import ( "math/big" "net/http" "net/url" - "path" "strconv" "strings" "time" @@ -734,12 +733,10 @@ func RetrieveRepoMetas(ctx *context.Context, repo *repo_model.Repository, isPull return labels } -func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleDirs, possibleFiles []string) { - templateCandidates := make([]string, 0, len(possibleDirs)+len(possibleFiles)) +func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleFiles []string) { + templateCandidates := make([]string, 0, 1+len(possibleFiles)) if t := ctx.FormString("template"); t != "" { - for _, dirName := range possibleDirs { - templateCandidates = append(templateCandidates, path.Join(dirName, t)) - } + templateCandidates = append(templateCandidates, t) } templateCandidates = append(templateCandidates, possibleFiles...) // Append files to the end because they should be fallback for _, filename := range templateCandidates { @@ -756,6 +753,7 @@ func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleDirs, if template.Type() == "yaml" { ctx.Data["Fields"] = template.Fields + ctx.Data["TemplateFile"] = template.FileName } labelIDs := make([]string, 0, len(template.Labels)) if repoLabels, err := issues_model.GetLabelsByRepoID(ctx, ctx.Repo.Repository.ID, "", db.ListOptions{}); err == nil { @@ -831,7 +829,7 @@ func NewIssue(ctx *context.Context) { } RetrieveRepoMetas(ctx, ctx.Repo.Repository, false) - setTemplateIfExists(ctx, issueTemplateKey, context.IssueTemplateDirCandidates, IssueTemplateCandidates) + setTemplateIfExists(ctx, issueTemplateKey, IssueTemplateCandidates) if ctx.Written() { return } diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index 48c01bb2a362c..f7acd4da76551 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -1,4 +1,5 @@ {{if .Fields}} + {{range .Fields}} {{if eq .Type "input"}} {{template "repo/issue/fields/input" .}} From 64190cdc9481a7a2ad0fbd50e7773be6393ce43b Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sun, 28 Aug 2022 18:23:58 +0800 Subject: [PATCH 10/44] chore: remove useless file --- modules/issue/template/template.go | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 modules/issue/template/template.go diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go deleted file mode 100644 index 7e1b34976ef61..0000000000000 --- a/modules/issue/template/template.go +++ /dev/null @@ -1,25 +0,0 @@ -// Copyright 2022 The Gitea Authors. All rights reserved. -// Use of this source code is governed by a MIT-style -// license that can be found in the LICENSE file. - -package template - -import "html/template" - -// Field represents a field interface which could be a component in the issue create UI -// TODO: Do we need it? -type Field interface { - Name() string - Description() string - Render() template.HTML -} - -type CheckBox struct{} - -type Markdown struct{} - -type Input struct{} - -type TextArea struct{} - -type Dropdown struct{} From ad7e58cf7fc47fae13aa1de03a81bf3ba1c81d7a Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sun, 28 Aug 2022 21:07:17 +0800 Subject: [PATCH 11/44] feat: use dropdown of fomantic ui --- modules/issue/template/render.go | 42 ++++++++++++++++++++--- templates/repo/issue/fields/dropdown.tmpl | 33 ++++++------------ 2 files changed, 49 insertions(+), 26 deletions(-) diff --git a/modules/issue/template/render.go b/modules/issue/template/render.go index c4e8e899e922b..4ba7c978fafd4 100644 --- a/modules/issue/template/render.go +++ b/modules/issue/template/render.go @@ -7,6 +7,7 @@ package template import ( "fmt" "net/url" + "strconv" "strings" api "code.gitea.io/gitea/modules/structs" @@ -43,20 +44,46 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { // write label _, _ = fmt.Fprintf(builder, "### %s\n", f.Label()) + blankPlaceholder := "_No response_\n" + // write body switch f.Type { - case "checkboxes", "dropdown": + case "checkboxes": + empty := true for _, option := range f.Options() { checked := " " if option.IsChecked() { checked = "x" + empty = true } _, _ = fmt.Fprintf(builder, "- [%s] %s\n", checked, option.Label()) } + if empty { + _, _ = fmt.Fprint(builder, blankPlaceholder) + } + case "dropdown": + var checkeds []string + for _, option := range f.Options() { + if option.IsChecked() { + checkeds = append(checkeds, option.Label()) + } + } + if len(checkeds) > 0 { + _, _ = fmt.Fprintf(builder, "%s\n", strings.Join(checkeds, ", ")) + } else { + _, _ = fmt.Fprint(builder, blankPlaceholder) + } case "input": + if v := f.Value(); v == "" { + _, _ = fmt.Fprint(builder, blankPlaceholder) + } _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) case "textarea": - _, _ = fmt.Fprintf(builder, "```%s\n%s\n```\n", f.Render(), f.Value()) + if v := f.Value(); v == "" { + _, _ = fmt.Fprint(builder, blankPlaceholder) + } else { + _, _ = fmt.Fprintf(builder, "```%s\n%s\n```\n", f.Render(), f.Value()) + } } _, _ = fmt.Fprintln(builder) } @@ -76,7 +103,7 @@ func (f *valuedField) Render() string { } func (f *valuedField) Value() string { - return f.Get(fmt.Sprintf("form-field-" + f.ID)) + return strings.TrimSpace(f.Get(fmt.Sprintf("form-field-" + f.ID))) } func (f *valuedField) Options() []*valuedOption { @@ -117,5 +144,12 @@ func (o *valuedOption) Label() string { } func (o *valuedOption) IsChecked() bool { - return o.field.Get(fmt.Sprintf("form-field-%s-%d", o.field.ID, o.index)) == "on" + checks := strings.Split(o.field.Get(fmt.Sprintf("form-field-%s", o.field.ID)), ",") + idx := strconv.Itoa(o.index) + for _, v := range checks { + if v == idx { + return true + } + } + return false } diff --git a/templates/repo/issue/fields/dropdown.tmpl b/templates/repo/issue/fields/dropdown.tmpl index f2942252f1401..cb9db39830d0e 100644 --- a/templates/repo/issue/fields/dropdown.tmpl +++ b/templates/repo/issue/fields/dropdown.tmpl @@ -1,23 +1,12 @@ {{template "repo/issue/fields/header" .}} -{{$field := .}} -{{if .Attributes.multiple}} - {{range $i, $opt := .Attributes.options}} -
- {{end}} -{{else}} - -{{end}} +
+ + +
+
+ {{range $i, $opt := .Attributes.options}} +
{{$opt}}
+ {{end}} +
+
+ From f2d38f16c8a7ab99b488e3ff6ed03b514f4c64e3 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sun, 28 Aug 2022 21:27:28 +0800 Subject: [PATCH 12/44] feat: update input style --- modules/issue/template/render.go | 23 +++++++++++---------- templates/repo/issue/fields/checkboxes.tmpl | 13 ++++-------- templates/repo/issue/fields/dropdown.tmpl | 2 +- templates/repo/issue/fields/input.tmpl | 9 +------- templates/repo/issue/fields/textarea.tmpl | 8 +------ 5 files changed, 19 insertions(+), 36 deletions(-) diff --git a/modules/issue/template/render.go b/modules/issue/template/render.go index 4ba7c978fafd4..e3498ab0de984 100644 --- a/modules/issue/template/render.go +++ b/modules/issue/template/render.go @@ -42,25 +42,20 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { } // write label - _, _ = fmt.Fprintf(builder, "### %s\n", f.Label()) + _, _ = fmt.Fprintf(builder, "### %s\n\n", f.Label()) blankPlaceholder := "_No response_\n" // write body switch f.Type { case "checkboxes": - empty := true for _, option := range f.Options() { checked := " " if option.IsChecked() { checked = "x" - empty = true } _, _ = fmt.Fprintf(builder, "- [%s] %s\n", checked, option.Label()) } - if empty { - _, _ = fmt.Fprint(builder, blankPlaceholder) - } case "dropdown": var checkeds []string for _, option := range f.Options() { @@ -144,12 +139,18 @@ func (o *valuedOption) Label() string { } func (o *valuedOption) IsChecked() bool { - checks := strings.Split(o.field.Get(fmt.Sprintf("form-field-%s", o.field.ID)), ",") - idx := strconv.Itoa(o.index) - for _, v := range checks { - if v == idx { - return true + switch o.field.Type { + case "dropdown": + checks := strings.Split(o.field.Get(fmt.Sprintf("form-field-%s", o.field.ID)), ",") + idx := strconv.Itoa(o.index) + for _, v := range checks { + if v == idx { + return true + } } + return false + case "checkboxes": + return o.field.Get(fmt.Sprintf("form-field-%s-%d", o.field.ID, o.index)) == "on" } return false } diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index 19ea63f15ef16..b0e25e8fe4098 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -1,13 +1,8 @@ {{template "repo/issue/fields/header" .}} {{$field := .}} {{range $i, $opt := .Attributes.options}} -
+
+ + +
{{end}} diff --git a/templates/repo/issue/fields/dropdown.tmpl b/templates/repo/issue/fields/dropdown.tmpl index cb9db39830d0e..0ce8877a18afe 100644 --- a/templates/repo/issue/fields/dropdown.tmpl +++ b/templates/repo/issue/fields/dropdown.tmpl @@ -1,5 +1,5 @@ {{template "repo/issue/fields/header" .}} -
+
diff --git a/templates/repo/issue/fields/input.tmpl b/templates/repo/issue/fields/input.tmpl index 75e748b30052a..a384085644f00 100644 --- a/templates/repo/issue/fields/input.tmpl +++ b/templates/repo/issue/fields/input.tmpl @@ -1,9 +1,2 @@ {{template "repo/issue/fields/header" .}} - + diff --git a/templates/repo/issue/fields/textarea.tmpl b/templates/repo/issue/fields/textarea.tmpl index 260ddaf998f7c..7c55f3d6bbc6a 100644 --- a/templates/repo/issue/fields/textarea.tmpl +++ b/templates/repo/issue/fields/textarea.tmpl @@ -1,8 +1,2 @@ {{template "repo/issue/fields/header" .}} - + From 03ab6066006943f0d7c1522250b4b1f30a9eefa6 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Sun, 28 Aug 2022 22:14:19 +0800 Subject: [PATCH 13/44] docs: more comments --- modules/issue/template/render.go | 1 + modules/issue/template/unmarshal.go | 10 ++++++---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/modules/issue/template/render.go b/modules/issue/template/render.go index e3498ab0de984..326c19142a10f 100644 --- a/modules/issue/template/render.go +++ b/modules/issue/template/render.go @@ -13,6 +13,7 @@ import ( api "code.gitea.io/gitea/modules/structs" ) +// RenderToMarkdown renders template to markdown with specified values func RenderToMarkdown(template *api.IssueTemplate, values url.Values) string { builder := &strings.Builder{} diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 12b2be18d2fc9..13ce75244e3fb 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -18,7 +18,7 @@ import ( "gopkg.in/yaml.v2" ) -// TODO +// Unmarshal parses out a template from the content func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { it := &api.IssueTemplate{ FileName: filename, @@ -53,12 +53,12 @@ func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { return it, nil } -// TODO +// UnmarshalFromEntry parses out a template from the blob in entry func UnmarshalFromEntry(entry *git.TreeEntry, dir string) (*api.IssueTemplate, error) { return unmarshalFromEntry(entry, filepath.Join(dir, entry.Name())) } -// TODO +// UnmarshalFromCommit parses out a template from the commit func UnmarshalFromCommit(commit *git.Commit, filename string) (*api.IssueTemplate, error) { entry, err := commit.GetTreeEntryByPath(filename) if err != nil { @@ -67,7 +67,7 @@ func UnmarshalFromCommit(commit *git.Commit, filename string) (*api.IssueTemplat return unmarshalFromEntry(entry, filename) } -// TODO +// UnmarshalFromRepo parses out a template from the head commit of the branch func UnmarshalFromRepo(repo *git.Repository, branch, filename string) (*api.IssueTemplate, error) { commit, err := repo.GetBranchCommit(branch) if err != nil { @@ -96,6 +96,8 @@ func unmarshalFromEntry(entry *git.TreeEntry, filename string) (*api.IssueTempla return Unmarshal(filename, content) } +// CouldBe indicates a file with the filename could be a template, +// it is a low cost check before further processing. func CouldBe(filename string) bool { it := &api.IssueTemplate{ FileName: filename, From 64b44e2b62cf1a032f8610224d937329db3ff801 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Mon, 29 Aug 2022 10:21:02 +0800 Subject: [PATCH 14/44] fix: render text without render --- modules/issue/template/render.go | 4 +++- templates/repo/issue/comment_tab.tmpl | 12 ++++++------ templates/repo/issue/fields/header.tmpl | 4 ++-- templates/repo/issue/fields/textarea.tmpl | 1 + 4 files changed, 12 insertions(+), 9 deletions(-) diff --git a/modules/issue/template/render.go b/modules/issue/template/render.go index 326c19142a10f..bcdb592eac85a 100644 --- a/modules/issue/template/render.go +++ b/modules/issue/template/render.go @@ -77,8 +77,10 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { case "textarea": if v := f.Value(); v == "" { _, _ = fmt.Fprint(builder, blankPlaceholder) - } else { + } else if render := f.Render(); render != "" { _, _ = fmt.Fprintf(builder, "```%s\n%s\n```\n", f.Render(), f.Value()) + } else { + _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) } } _, _ = fmt.Fprintln(builder) diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index f7acd4da76551..b70433a966431 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -25,12 +25,12 @@
- {{.locale.Tr "loading"}} + {{.locale.Tr "loading"}}
- {{if .IsAttachmentEnabled}} -
- {{template "repo/upload" .}} -
- {{end}} +{{end}} +{{if .IsAttachmentEnabled}} +
+ {{template "repo/upload" .}} +
{{end}} diff --git a/templates/repo/issue/fields/header.tmpl b/templates/repo/issue/fields/header.tmpl index 991eef8f8b616..49f20e6e46bd4 100644 --- a/templates/repo/issue/fields/header.tmpl +++ b/templates/repo/issue/fields/header.tmpl @@ -1,10 +1,10 @@ -{{- if .Attributes.label}} +{{if .Attributes.label}}

{{.Attributes.label}} {{if .Validations.required}} * {{end}}

{{end}} -{{- if .Attributes.description}} +{{if .Attributes.description}}
{{RenderMarkdownToHtml .Attributes.description}}
{{end}} diff --git a/templates/repo/issue/fields/textarea.tmpl b/templates/repo/issue/fields/textarea.tmpl index 7c55f3d6bbc6a..582eda402d99a 100644 --- a/templates/repo/issue/fields/textarea.tmpl +++ b/templates/repo/issue/fields/textarea.tmpl @@ -1,2 +1,3 @@ {{template "repo/issue/fields/header" .}} +{{/*FIXME: preview markdown */}} From b0f54725a3ceed8bfc5d084d66531a85f6514d56 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Mon, 29 Aug 2022 11:41:26 +0800 Subject: [PATCH 15/44] chore: fix lint error --- modules/structs/issue.go | 40 +++++++++++++++++----------------------- 1 file changed, 17 insertions(+), 23 deletions(-) diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 420ca872dc35b..3ddf4b757e0d4 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -160,8 +160,7 @@ func (it IssueTemplate) Validate() error { for idx, field := range it.Fields { checkStringAttr := func(name string) error { - attr := field.Attributes[name] - if s, ok := attr.(string); !ok || s == "" { + if attr, ok := field.Attributes[name].(string); !ok || attr == "" { return fmt.Errorf( "body[%d]: the '%s' attribute is required and should be string with type %s", idx, name, field.Type, @@ -179,33 +178,29 @@ func (it IssueTemplate) Validate() error { return err } case "checkboxes": - if err := checkStringAttr("label"); err != nil { - } if err := checkStringAttr("label"); err != nil { return err } - attr := field.Attributes["options"] - if options, ok := attr.([]any); !ok { + options, ok := field.Attributes["options"].([]interface{}) + if !ok { return fmt.Errorf( "body[%d]: the '%s' attribute is required and should be array with type %s", idx, "options", field.Type, ) - } else { - for optIdx, option := range options { - if opt, ok := option.(map[any]any); !ok { - return fmt.Errorf( - "body[%d], option[%d]: should be dictionary with type %s", - idx, optIdx, field.Type, - ) - } else { - label := opt["label"] - if s, ok := label.(string); !ok || s == "" { - return fmt.Errorf( - "body[%d], option[%d]: the '%s' is required and should be string with type %s", - idx, optIdx, "label", field.Type, - ) - } - } + } + for optIdx, option := range options { + opt, ok := option.(map[interface{}]interface{}) + if !ok { + return fmt.Errorf( + "body[%d], option[%d]: should be dictionary with type %s", + idx, optIdx, field.Type, + ) + } + if label, ok := opt["label"].(string); !ok || label == "" { + return fmt.Errorf( + "body[%d], option[%d]: the '%s' is required and should be string with type %s", + idx, optIdx, "label", field.Type, + ) } } @@ -227,7 +222,6 @@ func (it IssueTemplate) Valid() bool { // Type returns the type of IssueTemplate, it could be "md", "yaml" or empty for known func (it IssueTemplate) Type() string { if it.Name == "config.yaml" || it.Name == "config.yml" { - // TODO: should it be? // ignore config.yaml which is a special configuration file return "" } From 5e9e60eb5c3ecd48b698eb4652c01b7efb3e27a6 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Mon, 29 Aug 2022 11:47:26 +0800 Subject: [PATCH 16/44] fix: support use description as about in markdown --- modules/issue/template/unmarshal.go | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 13ce75244e3fb..089fa38c1ca38 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -24,21 +24,28 @@ func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { FileName: filename, } + // Compatible with treating description as about + compatibleTemplate := &struct { + About string `yaml:"description"` + }{} + if typ := it.Type(); typ == "md" { templateBody, err := markdown.ExtractMetadata(string(content), it) if err != nil { return nil, fmt.Errorf("extract metadata: %w", err) } it.Content = templateBody + if it.About == "" { + if _, err := markdown.ExtractMetadata(string(content), compatibleTemplate); err == nil && compatibleTemplate.About != "" { + it.About = compatibleTemplate.About + } + } + } else if typ == "yaml" { if err := yaml.Unmarshal(content, it); err != nil { return nil, fmt.Errorf("yaml unmarshal: %w", err) } if it.About == "" { - // Compatible with treating description as about - compatibleTemplate := &struct { - About string `yaml:"description"` - }{} if err := yaml.Unmarshal(content, compatibleTemplate); err == nil && compatibleTemplate.About != "" { it.About = compatibleTemplate.About } From 1d1d7dc2f58b5bb94fb5ea99298d0d0a1dfc492d Mon Sep 17 00:00:00 2001 From: Jason Song Date: Mon, 29 Aug 2022 11:56:18 +0800 Subject: [PATCH 17/44] fix: add field class in form --- modules/issue/template/unmarshal.go | 1 - templates/repo/issue/fields/checkboxes.tmpl | 18 ++++++++++-------- templates/repo/issue/fields/dropdown.tmpl | 21 +++++++++++---------- templates/repo/issue/fields/input.tmpl | 6 ++++-- templates/repo/issue/fields/markdown.tmpl | 4 +++- templates/repo/issue/fields/textarea.tmpl | 8 +++++--- 6 files changed, 33 insertions(+), 25 deletions(-) diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 089fa38c1ca38..af80ee397b194 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -40,7 +40,6 @@ func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { it.About = compatibleTemplate.About } } - } else if typ == "yaml" { if err := yaml.Unmarshal(content, it); err != nil { return nil, fmt.Errorf("yaml unmarshal: %w", err) diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index b0e25e8fe4098..6dfea77f7c958 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -1,8 +1,10 @@ -{{template "repo/issue/fields/header" .}} -{{$field := .}} -{{range $i, $opt := .Attributes.options}} -
- - -
-{{end}} +
+ {{template "repo/issue/fields/header" .}} + {{$field := .}} + {{range $i, $opt := .Attributes.options}} +
+ + +
+ {{end}} +
diff --git a/templates/repo/issue/fields/dropdown.tmpl b/templates/repo/issue/fields/dropdown.tmpl index 0ce8877a18afe..e9708f7e1e21f 100644 --- a/templates/repo/issue/fields/dropdown.tmpl +++ b/templates/repo/issue/fields/dropdown.tmpl @@ -1,12 +1,13 @@ -{{template "repo/issue/fields/header" .}} -
- - -
-
- {{range $i, $opt := .Attributes.options}} -
{{$opt}}
- {{end}} +
+ {{template "repo/issue/fields/header" .}} +
+ + +
+
+ {{range $i, $opt := .Attributes.options}} +
{{$opt}}
+ {{end}} +
- diff --git a/templates/repo/issue/fields/input.tmpl b/templates/repo/issue/fields/input.tmpl index a384085644f00..cf32a64dd2532 100644 --- a/templates/repo/issue/fields/input.tmpl +++ b/templates/repo/issue/fields/input.tmpl @@ -1,2 +1,4 @@ -{{template "repo/issue/fields/header" .}} - +
+ {{template "repo/issue/fields/header" .}} + +
diff --git a/templates/repo/issue/fields/markdown.tmpl b/templates/repo/issue/fields/markdown.tmpl index 668ad3e93da20..8236171523e0a 100644 --- a/templates/repo/issue/fields/markdown.tmpl +++ b/templates/repo/issue/fields/markdown.tmpl @@ -1 +1,3 @@ -
{{RenderMarkdownToHtml .Attributes.value}}
+
+
{{RenderMarkdownToHtml .Attributes.value}}
+
diff --git a/templates/repo/issue/fields/textarea.tmpl b/templates/repo/issue/fields/textarea.tmpl index 582eda402d99a..ba521e063b74f 100644 --- a/templates/repo/issue/fields/textarea.tmpl +++ b/templates/repo/issue/fields/textarea.tmpl @@ -1,3 +1,5 @@ -{{template "repo/issue/fields/header" .}} -{{/*FIXME: preview markdown */}} - +
+ {{template "repo/issue/fields/header" .}} + {{/*FIXME: preview markdown */}} + +
From 3d65d9ae40fb2b6360d51a4e782faef57a89b467 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Mon, 29 Aug 2022 12:07:57 +0800 Subject: [PATCH 18/44] chore: generate swagger --- modules/structs/issue.go | 1 + templates/swagger/v1_json.tmpl | 36 ++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 3ddf4b757e0d4..cf237d2b650df 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -123,6 +123,7 @@ type IssueDeadline struct { } // IssueFormField represents a form field +// swagger:model type IssueFormField struct { Type string `json:"type" yaml:"type"` ID string `json:"id" yaml:"id"` diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index cc6399cab4c52..87852b578c8e4 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -16584,6 +16584,35 @@ }, "x-go-package": "code.gitea.io/gitea/modules/structs" }, + "IssueFormField": { + "description": "IssueFormField represents a form field", + "type": "object", + "properties": { + "attributes": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "x-go-name": "Attributes" + }, + "id": { + "type": "string", + "x-go-name": "ID" + }, + "type": { + "type": "string", + "x-go-name": "Type" + }, + "validations": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "x-go-name": "Validations" + } + }, + "x-go-package": "code.gitea.io/gitea/modules/structs" + }, "IssueLabelsOption": { "description": "IssueLabelsOption a collection of labels", "type": "object", @@ -16608,6 +16637,13 @@ "type": "string", "x-go-name": "About" }, + "body": { + "type": "array", + "items": { + "$ref": "#/definitions/IssueFormField" + }, + "x-go-name": "Fields" + }, "content": { "type": "string", "x-go-name": "Content" From 69df4773f892c2a5c381da65f1130cfcfda3945d Mon Sep 17 00:00:00 2001 From: Jason Song Date: Mon, 29 Aug 2022 17:32:11 +0800 Subject: [PATCH 19/44] feat: validate template --- modules/context/repo.go | 4 +- modules/issue/template/render.go | 159 ----------- modules/issue/template/template.go | 364 ++++++++++++++++++++++++ modules/issue/template/template_test.go | 296 +++++++++++++++++++ modules/structs/issue.go | 80 +----- routers/web/repo/issue.go | 2 +- 6 files changed, 665 insertions(+), 240 deletions(-) delete mode 100644 modules/issue/template/render.go create mode 100644 modules/issue/template/template.go create mode 100644 modules/issue/template/template_test.go diff --git a/modules/context/repo.go b/modules/context/repo.go index 272811442feae..e011ce8108bc4 100644 --- a/modules/context/repo.go +++ b/modules/context/repo.go @@ -1065,7 +1065,9 @@ func (ctx *Context) IssueTemplatesFromDefaultBranch() []*api.IssueTemplate { it, err := template.UnmarshalFromEntry(entry, dirName) if err != nil { log.Debug("unmarshal template from %s: %v", entry.Name(), err) - } else if it.Valid() { + } else if err := template.Validate(it); err != nil { + log.Debug("invalid template file %s: %v", entry.Name(), err) + } else { issueTemplates = append(issueTemplates, it) } } diff --git a/modules/issue/template/render.go b/modules/issue/template/render.go deleted file mode 100644 index bcdb592eac85a..0000000000000 --- a/modules/issue/template/render.go +++ /dev/null @@ -1,159 +0,0 @@ -// Copyright 2022 The Gitea Authors. All rights reserved. -// Use of this source code is governed by a MIT-style -// license that can be found in the LICENSE file. - -package template - -import ( - "fmt" - "net/url" - "strconv" - "strings" - - api "code.gitea.io/gitea/modules/structs" -) - -// RenderToMarkdown renders template to markdown with specified values -func RenderToMarkdown(template *api.IssueTemplate, values url.Values) string { - builder := &strings.Builder{} - - for _, field := range template.Fields { - f := &valuedField{ - IssueFormField: field, - Values: values, - } - if f.ID == "" { - continue - } - f.WriteTo(builder) - } - - return builder.String() -} - -type valuedField struct { - *api.IssueFormField - url.Values -} - -func (f *valuedField) WriteTo(builder *strings.Builder) { - if f.Type == "markdown" { - // markdown blocks do not appear in output - return - } - - // write label - _, _ = fmt.Fprintf(builder, "### %s\n\n", f.Label()) - - blankPlaceholder := "_No response_\n" - - // write body - switch f.Type { - case "checkboxes": - for _, option := range f.Options() { - checked := " " - if option.IsChecked() { - checked = "x" - } - _, _ = fmt.Fprintf(builder, "- [%s] %s\n", checked, option.Label()) - } - case "dropdown": - var checkeds []string - for _, option := range f.Options() { - if option.IsChecked() { - checkeds = append(checkeds, option.Label()) - } - } - if len(checkeds) > 0 { - _, _ = fmt.Fprintf(builder, "%s\n", strings.Join(checkeds, ", ")) - } else { - _, _ = fmt.Fprint(builder, blankPlaceholder) - } - case "input": - if v := f.Value(); v == "" { - _, _ = fmt.Fprint(builder, blankPlaceholder) - } - _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) - case "textarea": - if v := f.Value(); v == "" { - _, _ = fmt.Fprint(builder, blankPlaceholder) - } else if render := f.Render(); render != "" { - _, _ = fmt.Fprintf(builder, "```%s\n%s\n```\n", f.Render(), f.Value()) - } else { - _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) - } - } - _, _ = fmt.Fprintln(builder) -} - -func (f *valuedField) Label() string { - if label, ok := f.Attributes["label"].(string); ok { - return label - } - return "" -} - -func (f *valuedField) Render() string { - if render, ok := f.Attributes["render"].(string); ok { - return render - } - return "" -} - -func (f *valuedField) Value() string { - return strings.TrimSpace(f.Get(fmt.Sprintf("form-field-" + f.ID))) -} - -func (f *valuedField) Options() []*valuedOption { - if options, ok := f.Attributes["options"].([]interface{}); ok { - ret := make([]*valuedOption, 0, len(options)) - for i, option := range options { - ret = append(ret, &valuedOption{ - index: i, - data: option, - field: f, - }) - } - return ret - } - return nil -} - -type valuedOption struct { - index int - data interface{} - field *valuedField -} - -func (o *valuedOption) Label() string { - switch o.field.Type { - case "dropdown": - if label, ok := o.data.(string); ok { - return label - } - case "checkboxes": - if vs, ok := o.data.(map[interface{}]interface{}); ok { - if v, ok := vs["label"].(string); ok { - return v - } - } - } - return "" -} - -func (o *valuedOption) IsChecked() bool { - switch o.field.Type { - case "dropdown": - checks := strings.Split(o.field.Get(fmt.Sprintf("form-field-%s", o.field.ID)), ",") - idx := strconv.Itoa(o.index) - for _, v := range checks { - if v == idx { - return true - } - } - return false - case "checkboxes": - return o.field.Get(fmt.Sprintf("form-field-%s-%d", o.field.ID, o.index)) == "on" - } - return false -} diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go new file mode 100644 index 0000000000000..801feb4db58f0 --- /dev/null +++ b/modules/issue/template/template.go @@ -0,0 +1,364 @@ +// Copyright 2022 The Gitea Authors. All rights reserved. +// Use of this source code is governed by a MIT-style +// license that can be found in the LICENSE file. + +package template + +import ( + "fmt" + "net/url" + "strconv" + "strings" + + api "code.gitea.io/gitea/modules/structs" + + "gitea.com/go-chi/binding" +) + +const ( + TypeMarkdown = "markdown" + TypeTextarea = "textarea" + TypeInput = "input" + TypeDropdown = "dropdown" + TypeCheckboxes = "checkboxes" +) + +// Validate checks whether an IssueTemplate is considered valid, and returns the first error +func Validate(template *api.IssueTemplate) error { + errRequired := func(name string) error { + return fmt.Errorf("'%s' is required", name) + } + if strings.TrimSpace(template.Name) == "" { + return errRequired("name") + } + if strings.TrimSpace(template.About) == "" { + return errRequired("about") + } + if len(template.Fields) == 0 { + return errRequired("body") + } + ids := map[string]struct{}{} + for idx, field := range template.Fields { + if err := validateID(field, idx, ids); err != nil { + return err + } + if err := validateLabel(field, idx); err != nil { + return err + } + + position := newErrorPosition(idx, field.Type) + switch field.Type { + case TypeMarkdown: + if err := validateStringItem(position, field.Attributes, true, "value"); err != nil { + return err + } + case TypeTextarea: + if err := validateStringItem(position, field.Attributes, false, + "description", + "placeholder", + "value", + "render", + ); err != nil { + return err + } + case TypeInput: + if err := validateStringItem(position, field.Attributes, false, + "description", + "placeholder", + "value", + ); err != nil { + return err + } + case TypeDropdown: + if err := validateStringItem(position, field.Attributes, false, "description"); err != nil { + return err + } + if err := validateBoolItem(position, field.Attributes, "multiple"); err != nil { + return err + } + if err := validateOptions(field, idx); err != nil { + return err + } + case TypeCheckboxes: + if err := validateStringItem(position, field.Attributes, false, "description"); err != nil { + return err + } + if err := validateOptions(field, idx); err != nil { + return err + } + default: + return position.Errorf("unknown type") + } + + if err := validateRequired(field, idx); err != nil { + return err + } + } + return nil +} + +func validateLabel(field *api.IssueFormField, idx int) error { + if field.Type == TypeMarkdown { + // The label is not required for a markdown field + return nil + } + return validateStringItem(newErrorPosition(idx, field.Type), field.Attributes, true, "label") +} + +func validateRequired(field *api.IssueFormField, idx int) error { + if field.Type == TypeMarkdown || field.Type == TypeCheckboxes { + // The label is not required for a markdown or checkboxes field + return nil + } + return validateBoolItem(newErrorPosition(idx, field.Type), field.Validations, "required") +} + +func validateID(field *api.IssueFormField, idx int, ids map[string]struct{}) error { + if field.Type == TypeMarkdown { + // The ID is not required for a markdown field + return nil + } + + position := newErrorPosition(idx, field.Type) + if field.ID == "" { + // If the ID is empty in yaml, template.Unmarshal will auto autofill it, so it cannot be empty + return position.Errorf("'id' is required") + } + if binding.AlphaDashPattern.MatchString(field.ID) { + return position.Errorf("'id' should contain only alphanumeric, '-' and '_'") + } + if _, ok := ids[field.ID]; ok { + return position.Errorf("'id' should be unique") + } + ids[field.ID] = struct{}{} + return nil +} + +func validateOptions(field *api.IssueFormField, idx int) error { + if field.Type != TypeDropdown && field.Type != TypeCheckboxes { + return nil + } + position := newErrorPosition(idx, field.Type) + + options, ok := field.Attributes["options"].([]interface{}) + if !ok || len(options) == 0 { + return position.Errorf("'options' is required and should be a array") + } + + for optIdx, option := range options { + position := newErrorPosition(idx, field.Type, optIdx) + switch field.Type { + case TypeDropdown: + if _, ok := option.(string); !ok { + return position.Errorf("should be a string") + } + case TypeCheckboxes: + opt, ok := option.(map[interface{}]interface{}) + if !ok { + return position.Errorf("should be a dictionary") + } + if label, ok := opt["label"].(string); !ok || label == "" { + return position.Errorf("'label' is required and should be a string") + } + + if required, ok := opt["required"]; ok { + if _, ok := required.(bool); !ok { + return position.Errorf("'required' should be a bool") + } + } + } + } + return nil +} + +func validateStringItem(position errorPosition, m map[string]interface{}, required bool, names ...string) error { + for _, name := range names { + v, ok := m[name] + if !ok { + if required { + return position.Errorf("'%s' is required", name) + } + return nil + } + attr, ok := v.(string) + if !ok { + return position.Errorf("'%s' should be a string", name) + } + if strings.TrimSpace(attr) == "" && required { + return position.Errorf("'%s' is required", name) + } + } + return nil +} + +func validateBoolItem(position errorPosition, m map[string]interface{}, names ...string) error { + for _, name := range names { + v, ok := m[name] + if !ok { + return nil + } + if _, ok := v.(bool); !ok { + return position.Errorf("'%s' should be a bool", name) + } + } + return nil +} + +type errorPosition string + +func (p errorPosition) Errorf(format string, a ...interface{}) error { + return fmt.Errorf(string(p)+": "+format, a...) +} + +func newErrorPosition(fieldIdx int, fieldType string, optionIndex ...int) errorPosition { + ret := fmt.Sprintf("body[%d](%s)", fieldIdx, fieldType) + if len(optionIndex) > 0 { + ret += fmt.Sprintf(", option[%d]", optionIndex[0]) + } + return errorPosition(ret) +} + +// RenderToMarkdown renders template to markdown with specified values +func RenderToMarkdown(template *api.IssueTemplate, values url.Values) string { + builder := &strings.Builder{} + + for _, field := range template.Fields { + f := &valuedField{ + IssueFormField: field, + Values: values, + } + if f.ID == "" { + continue + } + f.WriteTo(builder) + } + + return builder.String() +} + +type valuedField struct { + *api.IssueFormField + url.Values +} + +func (f *valuedField) WriteTo(builder *strings.Builder) { + if f.Type == TypeMarkdown { + // markdown blocks do not appear in output + return + } + + // write label + _, _ = fmt.Fprintf(builder, "### %s\n\n", f.Label()) + + blankPlaceholder := "_No response_\n" + + // write body + switch f.Type { + case TypeCheckboxes: + for _, option := range f.Options() { + checked := " " + if option.IsChecked() { + checked = "x" + } + _, _ = fmt.Fprintf(builder, "- [%s] %s\n", checked, option.Label()) + } + case TypeDropdown: + var checkeds []string + for _, option := range f.Options() { + if option.IsChecked() { + checkeds = append(checkeds, option.Label()) + } + } + if len(checkeds) > 0 { + _, _ = fmt.Fprintf(builder, "%s\n", strings.Join(checkeds, ", ")) + } else { + _, _ = fmt.Fprint(builder, blankPlaceholder) + } + case TypeInput: + if v := f.Value(); v == "" { + _, _ = fmt.Fprint(builder, blankPlaceholder) + } + _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) + case TypeTextarea: + if v := f.Value(); v == "" { + _, _ = fmt.Fprint(builder, blankPlaceholder) + } else if render := f.Render(); render != "" { + _, _ = fmt.Fprintf(builder, "```%s\n%s\n```\n", f.Render(), f.Value()) + } else { + _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) + } + } + _, _ = fmt.Fprintln(builder) +} + +func (f *valuedField) Label() string { + if label, ok := f.Attributes["label"].(string); ok { + return label + } + return "" +} + +func (f *valuedField) Render() string { + if render, ok := f.Attributes["render"].(string); ok { + return render + } + return "" +} + +func (f *valuedField) Value() string { + return strings.TrimSpace(f.Get(fmt.Sprintf("form-field-" + f.ID))) +} + +func (f *valuedField) Options() []*valuedOption { + if options, ok := f.Attributes["options"].([]interface{}); ok { + ret := make([]*valuedOption, 0, len(options)) + for i, option := range options { + ret = append(ret, &valuedOption{ + index: i, + data: option, + field: f, + }) + } + return ret + } + return nil +} + +type valuedOption struct { + index int + data interface{} + field *valuedField +} + +func (o *valuedOption) Label() string { + switch o.field.Type { + case TypeDropdown: + if label, ok := o.data.(string); ok { + return label + } + case TypeCheckboxes: + if vs, ok := o.data.(map[interface{}]interface{}); ok { + if v, ok := vs["label"].(string); ok { + return v + } + } + } + return "" +} + +func (o *valuedOption) IsChecked() bool { + switch o.field.Type { + case TypeDropdown: + checks := strings.Split(o.field.Get(fmt.Sprintf("form-field-%s", o.field.ID)), ",") + idx := strconv.Itoa(o.index) + for _, v := range checks { + if v == idx { + return true + } + } + return false + case TypeCheckboxes: + return o.field.Get(fmt.Sprintf("form-field-%s-%d", o.field.ID, o.index)) == "on" + } + return false +} diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go new file mode 100644 index 0000000000000..afc73d98453a3 --- /dev/null +++ b/modules/issue/template/template_test.go @@ -0,0 +1,296 @@ +// Copyright 2022 The Gitea Authors. All rights reserved. +// Use of this source code is governed by a MIT-style +// license that can be found in the LICENSE file. + +package template + +import ( + "testing" +) + +func TestValidate(t *testing.T) { + tests := []struct { + name string + content string + wantErr string + }{ + { + name: "miss name", + content: ``, + wantErr: "'name' is required", + }, + { + name: "miss about", + content: ` +name: "test" +`, + wantErr: "'about' is required", + }, + { + name: "miss body", + content: ` +name: "test" +about: "this is about" +`, + wantErr: "'body' is required", + }, + { + name: "markdown miss value", + content: ` +name: "test" +about: "this is about" +body: + - type: "markdown" +`, + wantErr: "body[0](markdown): 'value' is required", + }, + { + name: "markdown invalid value", + content: ` +name: "test" +about: "this is about" +body: + - type: "markdown" + attributes: + value: true +`, + wantErr: "body[0](markdown): 'value' should be a string", + }, + { + name: "markdown empty value", + content: ` +name: "test" +about: "this is about" +body: + - type: "markdown" + attributes: + value: "" +`, + wantErr: "body[0](markdown): 'value' is required", + }, + { + name: "textarea invalid id", + content: ` +name: "test" +about: "this is about" +body: + - type: "textarea" + id: "?" +`, + wantErr: "body[0](textarea): 'id' should contain only alphanumeric, '-' and '_'", + }, + { + name: "textarea miss label", + content: ` +name: "test" +about: "this is about" +body: + - type: "textarea" + id: "1" +`, + wantErr: "body[0](textarea): 'label' is required", + }, + { + name: "textarea conflict id", + content: ` +name: "test" +about: "this is about" +body: + - type: "textarea" + id: "1" + attributes: + label: "a" + - type: "textarea" + id: "1" + attributes: + label: "b" +`, + wantErr: "body[1](textarea): 'id' should be unique", + }, + { + name: "textarea invalid description", + content: ` +name: "test" +about: "this is about" +body: + - type: "textarea" + id: "1" + attributes: + label: "a" + description: true +`, + wantErr: "body[0](textarea): 'description' should be a string", + }, + { + name: "textarea invalid required", + content: ` +name: "test" +about: "this is about" +body: + - type: "textarea" + id: "1" + attributes: + label: "a" + validations: + required: "on" +`, + wantErr: "body[0](textarea): 'required' should be a bool", + }, + { + name: "input invalid description", + content: ` +name: "test" +about: "this is about" +body: + - type: "input" + id: "1" + attributes: + label: "a" + description: true +`, + wantErr: "body[0](input): 'description' should be a string", + }, + { + name: "dropdown invalid description", + content: ` +name: "test" +about: "this is about" +body: + - type: "dropdown" + id: "1" + attributes: + label: "a" + description: true +`, + wantErr: "body[0](dropdown): 'description' should be a string", + }, + { + name: "dropdown invalid multiple", + content: ` +name: "test" +about: "this is about" +body: + - type: "dropdown" + id: "1" + attributes: + label: "a" + multiple: "on" +`, + wantErr: "body[0](dropdown): 'multiple' should be a bool", + }, + { + name: "checkboxes invalid description", + content: ` +name: "test" +about: "this is about" +body: + - type: "checkboxes" + id: "1" + attributes: + label: "a" + description: true +`, + wantErr: "body[0](checkboxes): 'description' should be a string", + }, + { + name: "invalid type", + content: ` +name: "test" +about: "this is about" +body: + - type: "video" + id: "1" + attributes: + label: "a" +`, + wantErr: "body[0](video): unknown type", + }, + { + name: "dropdown miss options", + content: ` +name: "test" +about: "this is about" +body: + - type: "dropdown" + id: "1" + attributes: + label: "a" +`, + wantErr: "body[0](dropdown): 'options' is required and should be a array", + }, + { + name: "dropdown invalid options", + content: ` +name: "test" +about: "this is about" +body: + - type: "dropdown" + id: "1" + attributes: + label: "a" + options: + - "a" + - true +`, + wantErr: "body[0](dropdown), option[1]: should be a string", + }, + { + name: "checkboxes invalid options", + content: ` +name: "test" +about: "this is about" +body: + - type: "checkboxes" + id: "1" + attributes: + label: "a" + options: + - "a" + - true +`, + wantErr: "body[0](checkboxes), option[0]: should be a dictionary", + }, + { + name: "checkboxes option miss label", + content: ` +name: "test" +about: "this is about" +body: + - type: "checkboxes" + id: "1" + attributes: + label: "a" + options: + - required: true +`, + wantErr: "body[0](checkboxes), option[0]: 'label' is required and should be a string", + }, + { + name: "checkboxes option invalid required", + content: ` +name: "test" +about: "this is about" +body: + - type: "checkboxes" + id: "1" + attributes: + label: "a" + options: + - label: "a" + required: "on" +`, + wantErr: "body[0](checkboxes), option[0]: 'required' should be a bool", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + tmpl, err := Unmarshal("test.yaml", []byte(tt.content)) + if err != nil { + t.Fatal(err) + } + if err := Validate(tmpl); (err == nil) != (tt.wantErr == "") || err != nil && err.Error() != tt.wantErr { + t.Errorf("Validate() error = %v, wantErr %q", err, tt.wantErr) + } + }) + } +} diff --git a/modules/structs/issue.go b/modules/structs/issue.go index cf237d2b650df..0ec7a93b40040 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -5,9 +5,7 @@ package structs import ( - "fmt" "path/filepath" - "strings" "time" ) @@ -136,7 +134,7 @@ type IssueFormField struct { type IssueTemplate struct { Name string `json:"name" yaml:"name"` Title string `json:"title" yaml:"title"` - About string `json:"about" yaml:"about"` + About string `json:"about" yaml:"about"` // Using "description" in a template file is compatible Labels []string `json:"labels" yaml:"labels"` Ref string `json:"ref" yaml:"ref"` Content string `json:"content" yaml:"-"` @@ -144,82 +142,6 @@ type IssueTemplate struct { FileName string `json:"file_name" yaml:"-"` } -// Validate checks whether an IssueTemplate is considered valid, and returns the first error -func (it IssueTemplate) Validate() error { - // TODO check the format of id, and more - - errMissField := func(f string) error { - return fmt.Errorf("field '%s' is required", f) - } - - if strings.TrimSpace(it.Name) == "" { - return errMissField("name") - } - if strings.TrimSpace(it.About) == "" { - return errMissField("about") - } - - for idx, field := range it.Fields { - checkStringAttr := func(name string) error { - if attr, ok := field.Attributes[name].(string); !ok || attr == "" { - return fmt.Errorf( - "body[%d]: the '%s' attribute is required and should be string with type %s", - idx, name, field.Type, - ) - } - return nil - } - switch field.Type { - case "markdown": - if err := checkStringAttr("value"); err != nil { - return err - } - case "textarea", "input", "dropdown": - if err := checkStringAttr("label"); err != nil { - return err - } - case "checkboxes": - if err := checkStringAttr("label"); err != nil { - return err - } - options, ok := field.Attributes["options"].([]interface{}) - if !ok { - return fmt.Errorf( - "body[%d]: the '%s' attribute is required and should be array with type %s", - idx, "options", field.Type, - ) - } - for optIdx, option := range options { - opt, ok := option.(map[interface{}]interface{}) - if !ok { - return fmt.Errorf( - "body[%d], option[%d]: should be dictionary with type %s", - idx, optIdx, field.Type, - ) - } - if label, ok := opt["label"].(string); !ok || label == "" { - return fmt.Errorf( - "body[%d], option[%d]: the '%s' is required and should be string with type %s", - idx, optIdx, "label", field.Type, - ) - } - } - - default: - return fmt.Errorf( - "(field #%d '%s'): unknown type '%s'", - idx+1, field.ID, field.Type, - ) - } - } - return nil -} - -// Valid checks whether an IssueTemplate is considered valid, e.g. at least name and about -func (it IssueTemplate) Valid() bool { - return it.Validate() == nil -} - // Type returns the type of IssueTemplate, it could be "md", "yaml" or empty for known func (it IssueTemplate) Type() string { if it.Name == "config.yaml" || it.Name == "config.yml" { diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index 4d6794f4d1ec9..06017f7bbaa3f 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -744,7 +744,7 @@ func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleFiles if err != nil { continue } - if !template.Valid() { + if issue_template.Validate(template) != nil { continue } From fde937f012fc2ced48f271b66c52500fad3dd4ae Mon Sep 17 00:00:00 2001 From: Jason Song Date: Mon, 29 Aug 2022 17:43:52 +0800 Subject: [PATCH 20/44] feat: support is_nummber and regex --- modules/issue/template/template.go | 6 +++++ modules/issue/template/template_test.go | 30 +++++++++++++++++++++++++ templates/repo/issue/fields/input.tmpl | 1 + 3 files changed, 37 insertions(+) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 801feb4db58f0..9705fed5c54de 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -69,6 +69,12 @@ func Validate(template *api.IssueTemplate) error { ); err != nil { return err } + if err := validateBoolItem(position, field.Validations, "is_number"); err != nil { + return err + } + if err := validateStringItem(position, field.Validations, false, "regex"); err != nil { + return err + } case TypeDropdown: if err := validateStringItem(position, field.Attributes, false, "description"); err != nil { return err diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index afc73d98453a3..1293f4d4c64e6 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -150,6 +150,36 @@ body: `, wantErr: "body[0](input): 'description' should be a string", }, + { + name: "input invalid is_number", + content: ` +name: "test" +about: "this is about" +body: + - type: "input" + id: "1" + attributes: + label: "a" + validations: + is_number: "yes" +`, + wantErr: "body[0](input): 'is_number' should be a bool", + }, + { + name: "input invalid regex", + content: ` +name: "test" +about: "this is about" +body: + - type: "input" + id: "1" + attributes: + label: "a" + validations: + regex: true +`, + wantErr: "body[0](input): 'regex' should be a string", + }, { name: "dropdown invalid description", content: ` diff --git a/templates/repo/issue/fields/input.tmpl b/templates/repo/issue/fields/input.tmpl index cf32a64dd2532..0676e72b048a9 100644 --- a/templates/repo/issue/fields/input.tmpl +++ b/templates/repo/issue/fields/input.tmpl @@ -1,4 +1,5 @@
{{template "repo/issue/fields/header" .}} +{{/* TODO: support is_number and regex */}}
From b413dce358544e0ddf3e52da9f1c306cc3e784fd Mon Sep 17 00:00:00 2001 From: Jason Song Date: Mon, 29 Aug 2022 18:40:36 +0800 Subject: [PATCH 21/44] test: fix broken unit tests --- modules/markup/markdown/meta_test.go | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/modules/markup/markdown/meta_test.go b/modules/markup/markdown/meta_test.go index f525777a54c15..939646f8fd872 100644 --- a/modules/markup/markdown/meta_test.go +++ b/modules/markup/markdown/meta_test.go @@ -6,6 +6,7 @@ package markdown import ( "fmt" + "strings" "testing" "code.gitea.io/gitea/modules/structs" @@ -13,6 +14,16 @@ import ( "github.com/stretchr/testify/assert" ) +func validateMetadata(it structs.IssueTemplate) bool { + /* + A legacy to keep the unit tests working. + Copied from the method "func (it IssueTemplate) Valid() bool", the original method has been removed. + Because it becomes quite complicated to validate an issue template which is support yaml form now. + The new way to validate an issue template is to call the Validate in modules/issue/template, + */ + return strings.TrimSpace(it.Name) != "" && strings.TrimSpace(it.About) != "" +} + func TestExtractMetadata(t *testing.T) { t.Run("ValidFrontAndBody", func(t *testing.T) { var meta structs.IssueTemplate @@ -20,7 +31,7 @@ func TestExtractMetadata(t *testing.T) { assert.NoError(t, err) assert.Equal(t, bodyTest, body) assert.Equal(t, metaTest, meta) - assert.True(t, meta.Valid()) + assert.True(t, validateMetadata(meta)) }) t.Run("NoFirstSeparator", func(t *testing.T) { @@ -41,7 +52,7 @@ func TestExtractMetadata(t *testing.T) { assert.NoError(t, err) assert.Equal(t, "", body) assert.Equal(t, metaTest, meta) - assert.True(t, meta.Valid()) + assert.True(t, validateMetadata(meta)) }) } From d764ed8040d8faadb1df3e39f5d70c2a4b5c6f17 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Tue, 30 Aug 2022 10:07:03 +0800 Subject: [PATCH 22/44] fix: ignore empty body of md template --- modules/issue/template/template.go | 73 +++++++++++++++-------------- modules/issue/template/unmarshal.go | 4 +- modules/structs/issue.go | 27 +++++++++-- routers/web/repo/issue.go | 2 +- 4 files changed, 65 insertions(+), 41 deletions(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 9705fed5c54de..2b164c8831f97 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -15,27 +15,32 @@ import ( "gitea.com/go-chi/binding" ) -const ( - TypeMarkdown = "markdown" - TypeTextarea = "textarea" - TypeInput = "input" - TypeDropdown = "dropdown" - TypeCheckboxes = "checkboxes" -) - // Validate checks whether an IssueTemplate is considered valid, and returns the first error func Validate(template *api.IssueTemplate) error { - errRequired := func(name string) error { - return fmt.Errorf("'%s' is required", name) + if err := validateMetadata(template); err != nil { + return err + } + if template.Type() == api.IssueTemplateTypeYaml { + if err := validateYaml(template); err != nil { + return err + } } + return nil +} + +func validateMetadata(template *api.IssueTemplate) error { if strings.TrimSpace(template.Name) == "" { - return errRequired("name") + return fmt.Errorf("'name' is required") } if strings.TrimSpace(template.About) == "" { - return errRequired("about") + return fmt.Errorf("'about' is required") } + return nil +} + +func validateYaml(template *api.IssueTemplate) error { if len(template.Fields) == 0 { - return errRequired("body") + return fmt.Errorf("'body' is required") } ids := map[string]struct{}{} for idx, field := range template.Fields { @@ -48,11 +53,11 @@ func Validate(template *api.IssueTemplate) error { position := newErrorPosition(idx, field.Type) switch field.Type { - case TypeMarkdown: + case api.IssueFormFieldTypeMarkdown: if err := validateStringItem(position, field.Attributes, true, "value"); err != nil { return err } - case TypeTextarea: + case api.IssueFormFieldTypeTextarea: if err := validateStringItem(position, field.Attributes, false, "description", "placeholder", @@ -61,7 +66,7 @@ func Validate(template *api.IssueTemplate) error { ); err != nil { return err } - case TypeInput: + case api.IssueFormFieldTypeInput: if err := validateStringItem(position, field.Attributes, false, "description", "placeholder", @@ -75,7 +80,7 @@ func Validate(template *api.IssueTemplate) error { if err := validateStringItem(position, field.Validations, false, "regex"); err != nil { return err } - case TypeDropdown: + case api.IssueFormFieldTypeDropdown: if err := validateStringItem(position, field.Attributes, false, "description"); err != nil { return err } @@ -85,7 +90,7 @@ func Validate(template *api.IssueTemplate) error { if err := validateOptions(field, idx); err != nil { return err } - case TypeCheckboxes: + case api.IssueFormFieldTypeCheckboxes: if err := validateStringItem(position, field.Attributes, false, "description"); err != nil { return err } @@ -104,7 +109,7 @@ func Validate(template *api.IssueTemplate) error { } func validateLabel(field *api.IssueFormField, idx int) error { - if field.Type == TypeMarkdown { + if field.Type == api.IssueFormFieldTypeMarkdown { // The label is not required for a markdown field return nil } @@ -112,7 +117,7 @@ func validateLabel(field *api.IssueFormField, idx int) error { } func validateRequired(field *api.IssueFormField, idx int) error { - if field.Type == TypeMarkdown || field.Type == TypeCheckboxes { + if field.Type == api.IssueFormFieldTypeMarkdown || field.Type == api.IssueFormFieldTypeCheckboxes { // The label is not required for a markdown or checkboxes field return nil } @@ -120,7 +125,7 @@ func validateRequired(field *api.IssueFormField, idx int) error { } func validateID(field *api.IssueFormField, idx int, ids map[string]struct{}) error { - if field.Type == TypeMarkdown { + if field.Type == api.IssueFormFieldTypeMarkdown { // The ID is not required for a markdown field return nil } @@ -141,7 +146,7 @@ func validateID(field *api.IssueFormField, idx int, ids map[string]struct{}) err } func validateOptions(field *api.IssueFormField, idx int) error { - if field.Type != TypeDropdown && field.Type != TypeCheckboxes { + if field.Type != api.IssueFormFieldTypeDropdown && field.Type != api.IssueFormFieldTypeCheckboxes { return nil } position := newErrorPosition(idx, field.Type) @@ -154,11 +159,11 @@ func validateOptions(field *api.IssueFormField, idx int) error { for optIdx, option := range options { position := newErrorPosition(idx, field.Type, optIdx) switch field.Type { - case TypeDropdown: + case api.IssueFormFieldTypeDropdown: if _, ok := option.(string); !ok { return position.Errorf("should be a string") } - case TypeCheckboxes: + case api.IssueFormFieldTypeCheckboxes: opt, ok := option.(map[interface{}]interface{}) if !ok { return position.Errorf("should be a dictionary") @@ -216,7 +221,7 @@ func (p errorPosition) Errorf(format string, a ...interface{}) error { return fmt.Errorf(string(p)+": "+format, a...) } -func newErrorPosition(fieldIdx int, fieldType string, optionIndex ...int) errorPosition { +func newErrorPosition(fieldIdx int, fieldType api.IssueFormFieldType, optionIndex ...int) errorPosition { ret := fmt.Sprintf("body[%d](%s)", fieldIdx, fieldType) if len(optionIndex) > 0 { ret += fmt.Sprintf(", option[%d]", optionIndex[0]) @@ -248,7 +253,7 @@ type valuedField struct { } func (f *valuedField) WriteTo(builder *strings.Builder) { - if f.Type == TypeMarkdown { + if f.Type == api.IssueFormFieldTypeMarkdown { // markdown blocks do not appear in output return } @@ -260,7 +265,7 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { // write body switch f.Type { - case TypeCheckboxes: + case api.IssueFormFieldTypeCheckboxes: for _, option := range f.Options() { checked := " " if option.IsChecked() { @@ -268,7 +273,7 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { } _, _ = fmt.Fprintf(builder, "- [%s] %s\n", checked, option.Label()) } - case TypeDropdown: + case api.IssueFormFieldTypeDropdown: var checkeds []string for _, option := range f.Options() { if option.IsChecked() { @@ -280,12 +285,12 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { } else { _, _ = fmt.Fprint(builder, blankPlaceholder) } - case TypeInput: + case api.IssueFormFieldTypeInput: if v := f.Value(); v == "" { _, _ = fmt.Fprint(builder, blankPlaceholder) } _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) - case TypeTextarea: + case api.IssueFormFieldTypeTextarea: if v := f.Value(); v == "" { _, _ = fmt.Fprint(builder, blankPlaceholder) } else if render := f.Render(); render != "" { @@ -338,11 +343,11 @@ type valuedOption struct { func (o *valuedOption) Label() string { switch o.field.Type { - case TypeDropdown: + case api.IssueFormFieldTypeDropdown: if label, ok := o.data.(string); ok { return label } - case TypeCheckboxes: + case api.IssueFormFieldTypeCheckboxes: if vs, ok := o.data.(map[interface{}]interface{}); ok { if v, ok := vs["label"].(string); ok { return v @@ -354,7 +359,7 @@ func (o *valuedOption) Label() string { func (o *valuedOption) IsChecked() bool { switch o.field.Type { - case TypeDropdown: + case api.IssueFormFieldTypeDropdown: checks := strings.Split(o.field.Get(fmt.Sprintf("form-field-%s", o.field.ID)), ",") idx := strconv.Itoa(o.index) for _, v := range checks { @@ -363,7 +368,7 @@ func (o *valuedOption) IsChecked() bool { } } return false - case TypeCheckboxes: + case api.IssueFormFieldTypeCheckboxes: return o.field.Get(fmt.Sprintf("form-field-%s-%d", o.field.ID, o.index)) == "on" } return false diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index af80ee397b194..11dcf110d17f8 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -29,7 +29,7 @@ func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { About string `yaml:"description"` }{} - if typ := it.Type(); typ == "md" { + if typ := it.Type(); typ == api.IssueTemplateTypeMarkdown { templateBody, err := markdown.ExtractMetadata(string(content), it) if err != nil { return nil, fmt.Errorf("extract metadata: %w", err) @@ -40,7 +40,7 @@ func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { it.About = compatibleTemplate.About } } - } else if typ == "yaml" { + } else if typ == api.IssueTemplateTypeYaml { if err := yaml.Unmarshal(content, it); err != nil { return nil, fmt.Errorf("yaml unmarshal: %w", err) } diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 0ec7a93b40040..0527c5ee57541 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -120,10 +120,21 @@ type IssueDeadline struct { Deadline *time.Time `json:"due_date"` } +// IssueFormFieldType defines issue form field type +type IssueFormFieldType string + +const ( + IssueFormFieldTypeMarkdown IssueFormFieldType = "markdown" + IssueFormFieldTypeTextarea IssueFormFieldType = "textarea" + IssueFormFieldTypeInput IssueFormFieldType = "input" + IssueFormFieldTypeDropdown IssueFormFieldType = "dropdown" + IssueFormFieldTypeCheckboxes IssueFormFieldType = "checkboxes" +) + // IssueFormField represents a form field // swagger:model type IssueFormField struct { - Type string `json:"type" yaml:"type"` + Type IssueFormFieldType `json:"type" yaml:"type"` ID string `json:"id" yaml:"id"` Attributes map[string]interface{} `json:"attributes" yaml:"attributes"` Validations map[string]interface{} `json:"validations" yaml:"validations"` @@ -142,16 +153,24 @@ type IssueTemplate struct { FileName string `json:"file_name" yaml:"-"` } +// IssueTemplateType defines issue template type +type IssueTemplateType string + +const ( + IssueTemplateTypeMarkdown IssueTemplateType = "md" + IssueTemplateTypeYaml IssueTemplateType = "yaml" +) + // Type returns the type of IssueTemplate, it could be "md", "yaml" or empty for known -func (it IssueTemplate) Type() string { +func (it IssueTemplate) Type() IssueTemplateType { if it.Name == "config.yaml" || it.Name == "config.yml" { // ignore config.yaml which is a special configuration file return "" } if ext := filepath.Ext(it.FileName); ext == ".md" { - return "md" + return IssueTemplateTypeMarkdown } else if ext == ".yaml" || ext == ".yml" { return "yaml" } - return "" + return IssueTemplateTypeYaml } diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index 06017f7bbaa3f..66afcfab93953 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -751,7 +751,7 @@ func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleFiles ctx.Data[issueTemplateTitleKey] = template.Title ctx.Data[ctxDataKey] = template.Content - if template.Type() == "yaml" { + if template.Type() == api.IssueTemplateTypeYaml { ctx.Data["Fields"] = template.Fields ctx.Data["TemplateFile"] = template.FileName } From 793b86a6b2a85e581c298d8d43d1578de3398043 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Tue, 30 Aug 2022 10:20:33 +0800 Subject: [PATCH 23/44] fix: make multiple easymde editors work in one page --- web_src/js/features/comp/EasyMDE.js | 2 +- web_src/js/features/repo-legacy.js | 11 ++++++++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/web_src/js/features/comp/EasyMDE.js b/web_src/js/features/comp/EasyMDE.js index f1b4b0efc398d..015fc3505082b 100644 --- a/web_src/js/features/comp/EasyMDE.js +++ b/web_src/js/features/comp/EasyMDE.js @@ -93,7 +93,7 @@ export async function createCommentEasyMDE(textarea, easyMDEOptions = {}) { cm.execCommand('delCharBefore'); }, }); - attachTribute(inputField, {mentions: true, emoji: true}); + await attachTribute(inputField, {mentions: true, emoji: true}); attachEasyMDEToElements(easyMDE); return easyMDE; } diff --git a/web_src/js/features/repo-legacy.js b/web_src/js/features/repo-legacy.js index 11c97ccfb011c..9d8796b5a6d55 100644 --- a/web_src/js/features/repo-legacy.js +++ b/web_src/js/features/repo-legacy.js @@ -68,9 +68,14 @@ export function initRepoCommentForm() { } (async () => { - const $textarea = $commentForm.find('textarea:not(.review-textarea)'); - const easyMDE = await createCommentEasyMDE($textarea); - initEasyMDEImagePaste(easyMDE, $commentForm.find('.dropzone')); + for (const textarea of $commentForm.find('textarea:not(.review-textarea, .no-easymde)')) { + // Don't initialize EasyMDE for the dormant #edit-content-form + if (textarea.closest('#edit-content-form')) { + continue; + } + const easyMDE = await createCommentEasyMDE(textarea); + initEasyMDEImagePaste(easyMDE, $commentForm.find('.dropzone')); + } })(); initBranchSelector(); From 4ffde84e271024710c19d066fd8b19dcd48c1c8a Mon Sep 17 00:00:00 2001 From: Jason Song Date: Tue, 30 Aug 2022 15:14:04 +0800 Subject: [PATCH 24/44] feat: better UI --- templates/repo/issue/comment_tab.tmpl | 1 + templates/repo/issue/fields/checkboxes.tmpl | 2 +- templates/repo/issue/fields/header.tmpl | 8 ++------ templates/repo/issue/fields/input.tmpl | 4 ++-- 4 files changed, 6 insertions(+), 9 deletions(-) diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index b70433a966431..542a85ca0b85d 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -13,6 +13,7 @@ {{template "repo/issue/fields/checkboxes" .}} {{end}} {{end}} +
{{/* the upload dropzone expects a field above and closes to it, see dropzone.less:9 */}} {{else}}
{{.locale.Tr "write"}} diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index 6dfea77f7c958..72214cc0b8965 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -2,7 +2,7 @@ {{template "repo/issue/fields/header" .}} {{$field := .}} {{range $i, $opt := .Attributes.options}} -
+
diff --git a/templates/repo/issue/fields/header.tmpl b/templates/repo/issue/fields/header.tmpl index 49f20e6e46bd4..fb8511b4f0bd0 100644 --- a/templates/repo/issue/fields/header.tmpl +++ b/templates/repo/issue/fields/header.tmpl @@ -1,10 +1,6 @@ {{if .Attributes.label}} -

{{.Attributes.label}} - {{if .Validations.required}} - * - {{end}} -

+

{{.Attributes.label}}{{if .Validations.required}}{{end}}

{{end}} {{if .Attributes.description}} -
{{RenderMarkdownToHtml .Attributes.description}}
+ {{RenderMarkdownToHtml .Attributes.description}} {{end}} diff --git a/templates/repo/issue/fields/input.tmpl b/templates/repo/issue/fields/input.tmpl index 0676e72b048a9..ba2067ca29ce1 100644 --- a/templates/repo/issue/fields/input.tmpl +++ b/templates/repo/issue/fields/input.tmpl @@ -1,5 +1,5 @@
{{template "repo/issue/fields/header" .}} -{{/* TODO: support is_number and regex */}} - +{{/* TODO: support regex */}} +
From 516ccb40bfbaadfd1e3ed486e61f0307264a94b2 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Tue, 30 Aug 2022 17:11:15 +0800 Subject: [PATCH 25/44] fix: js error in pr form --- templates/repo/issue/fields/textarea.tmpl | 2 +- web_src/js/features/repo-legacy.js | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/templates/repo/issue/fields/textarea.tmpl b/templates/repo/issue/fields/textarea.tmpl index ba521e063b74f..4b5779f49be67 100644 --- a/templates/repo/issue/fields/textarea.tmpl +++ b/templates/repo/issue/fields/textarea.tmpl @@ -1,5 +1,5 @@
{{template "repo/issue/fields/header" .}} {{/*FIXME: preview markdown */}} - +
diff --git a/web_src/js/features/repo-legacy.js b/web_src/js/features/repo-legacy.js index 9d8796b5a6d55..f39ba03e03854 100644 --- a/web_src/js/features/repo-legacy.js +++ b/web_src/js/features/repo-legacy.js @@ -542,7 +542,9 @@ export function initRepository() { const $form = $repoComparePull.find('.pullrequest-form'); const easyMDE = getAttachedEasyMDE($form.find('textarea.edit_area')); $form.show(); - easyMDE.codemirror.refresh(); + if (easyMDE) { + easyMDE.codemirror.refresh(); + } }); } From de06c5239304e35f8ed9366adcdf855628e4f638 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Tue, 30 Aug 2022 18:16:44 +0800 Subject: [PATCH 26/44] chore: generate swagger --- modules/structs/issue.go | 4 ++-- templates/swagger/v1_json.tmpl | 8 ++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 0527c5ee57541..27ec81f7283f7 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -120,7 +120,7 @@ type IssueDeadline struct { Deadline *time.Time `json:"due_date"` } -// IssueFormFieldType defines issue form field type +// IssueFormFieldType defines issue form field type, can be "markdown", "textarea", "input", "dropdown" or "checkboxes" type IssueFormFieldType string const ( @@ -161,7 +161,7 @@ const ( IssueTemplateTypeYaml IssueTemplateType = "yaml" ) -// Type returns the type of IssueTemplate, it could be "md", "yaml" or empty for known +// Type returns the type of IssueTemplate, can be "md", "yaml" or empty for known func (it IssueTemplate) Type() IssueTemplateType { if it.Name == "config.yaml" || it.Name == "config.yml" { // ignore config.yaml which is a special configuration file diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 87852b578c8e4..273b8b1b5ceb7 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -16600,8 +16600,7 @@ "x-go-name": "ID" }, "type": { - "type": "string", - "x-go-name": "Type" + "$ref": "#/definitions/IssueFormFieldType" }, "validations": { "type": "object", @@ -16613,6 +16612,11 @@ }, "x-go-package": "code.gitea.io/gitea/modules/structs" }, + "IssueFormFieldType": { + "type": "string", + "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"", + "x-go-package": "code.gitea.io/gitea/modules/structs" + }, "IssueLabelsOption": { "description": "IssueLabelsOption a collection of labels", "type": "object", From c698b4ebcc424c7bcd36ad88a3c7e346ff8352f1 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Wed, 31 Aug 2022 10:33:00 +0800 Subject: [PATCH 27/44] feat: support regex validation --- templates/repo/issue/fields/input.tmpl | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/templates/repo/issue/fields/input.tmpl b/templates/repo/issue/fields/input.tmpl index ba2067ca29ce1..d73354f6d392d 100644 --- a/templates/repo/issue/fields/input.tmpl +++ b/templates/repo/issue/fields/input.tmpl @@ -1,5 +1,4 @@
{{template "repo/issue/fields/header" .}} -{{/* TODO: support regex */}} - +
From 632b86ae302eafa54c6ca4771575c8a859c9f356 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Wed, 31 Aug 2022 10:56:24 +0800 Subject: [PATCH 28/44] chore: generate swagger --- templates/swagger/v1_json.tmpl | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 273b8b1b5ceb7..63b124bd9e767 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -16590,9 +16590,7 @@ "properties": { "attributes": { "type": "object", - "additionalProperties": { - "type": "object" - }, + "additionalProperties": {}, "x-go-name": "Attributes" }, "id": { @@ -16604,9 +16602,7 @@ }, "validations": { "type": "object", - "additionalProperties": { - "type": "object" - }, + "additionalProperties": {}, "x-go-name": "Validations" } }, From d0d7b0dab2b18ca4743daf9d9cc6b910fd95ecd2 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Wed, 31 Aug 2022 11:23:00 +0800 Subject: [PATCH 29/44] fix: refresh each markdown editor --- web_src/js/features/repo-legacy.js | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/web_src/js/features/repo-legacy.js b/web_src/js/features/repo-legacy.js index f39ba03e03854..2c93ca03424b0 100644 --- a/web_src/js/features/repo-legacy.js +++ b/web_src/js/features/repo-legacy.js @@ -540,11 +540,13 @@ export function initRepository() { $(this).parent().hide(); const $form = $repoComparePull.find('.pullrequest-form'); - const easyMDE = getAttachedEasyMDE($form.find('textarea.edit_area')); $form.show(); - if (easyMDE) { - easyMDE.codemirror.refresh(); - } + $form.find('textarea.edit_area').each(function() { + const easyMDE = getAttachedEasyMDE($(this)); + if (easyMDE) { + easyMDE.codemirror.refresh(); + } + }); }); } From 645176ffcd6e0bb2cc2681e6e037ac4c7149bc2f Mon Sep 17 00:00:00 2001 From: Jason Song Date: Wed, 31 Aug 2022 11:33:21 +0800 Subject: [PATCH 30/44] chore: give up required validation --- templates/repo/issue/fields/dropdown.tmpl | 3 ++- templates/repo/issue/fields/textarea.tmpl | 5 +++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/templates/repo/issue/fields/dropdown.tmpl b/templates/repo/issue/fields/dropdown.tmpl index e9708f7e1e21f..83c2bb4aac89e 100644 --- a/templates/repo/issue/fields/dropdown.tmpl +++ b/templates/repo/issue/fields/dropdown.tmpl @@ -1,7 +1,8 @@
{{template "repo/issue/fields/header" .}} + {{/* FIXME: required validation */}}
- +
diff --git a/templates/repo/issue/fields/textarea.tmpl b/templates/repo/issue/fields/textarea.tmpl index 4b5779f49be67..5ad82e2460846 100644 --- a/templates/repo/issue/fields/textarea.tmpl +++ b/templates/repo/issue/fields/textarea.tmpl @@ -1,5 +1,6 @@
{{template "repo/issue/fields/header" .}} - {{/*FIXME: preview markdown */}} - + {{/* FIXME: preview markdown result */}} + {{/* FIXME: required validation for markdown editor */}} +
From fdd39f4da16bc9c254bc459dccf616bde0b391bf Mon Sep 17 00:00:00 2001 From: Jason Song Date: Wed, 31 Aug 2022 12:59:01 +0800 Subject: [PATCH 31/44] fix: correct issue template candidates --- routers/web/repo/issue.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index 66afcfab93953..74d918e5af250 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -81,8 +81,8 @@ var IssueTemplateCandidates = []string{ ".gitea/issue_template.yaml", ".gitea/issue_template.md", ".github/ISSUE_TEMPLATE.md", + ".github/ISSUE_TEMPLATE.yaml", ".github/ISSUE_TEMPLATE.yml", - ".github/ISSUE_TEMPLATE.md", ".github/issue_template.md", ".github/issue_template.yaml", ".github/issue_template.yml", From a0101e898d167113b5fe5cf2de5c36a2e2940ba5 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Wed, 31 Aug 2022 13:44:09 +0800 Subject: [PATCH 32/44] fix: correct checkboxes style --- templates/repo/issue/fields/checkboxes.tmpl | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index 72214cc0b8965..50b32c1fbf3d8 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -2,9 +2,11 @@ {{template "repo/issue/fields/header" .}} {{$field := .}} {{range $i, $opt := .Attributes.options}} -
- - +
+
+ + +
{{end}}
From 23da624bd2641b876e1bbbd34f4a2d10232640c8 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Wed, 31 Aug 2022 18:02:06 +0800 Subject: [PATCH 33/44] chore: ignore .hugo_build.lock in docs --- docs/.gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/.gitignore b/docs/.gitignore index 9cd1408bd249f..271adbb1da107 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -2,3 +2,6 @@ public/ templates/swagger/v1_json.tmpl themes/ resources/ + +# Temporary lock file while building +/.hugo_build.lock From f0ceaf6710848548ce78cb072257bf4a408f0653 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Wed, 31 Aug 2022 17:50:53 +0800 Subject: [PATCH 34/44] docs: separate out a new doc for merge templates --- .../usage/merge-message-templates.en-us.md | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/content/doc/usage/merge-message-templates.en-us.md diff --git a/docs/content/doc/usage/merge-message-templates.en-us.md b/docs/content/doc/usage/merge-message-templates.en-us.md new file mode 100644 index 0000000000000..c30ac1bfeb40f --- /dev/null +++ b/docs/content/doc/usage/merge-message-templates.en-us.md @@ -0,0 +1,48 @@ +--- +date: "2022-08-31T17:35:40+08:00" +title: "Usage: Merge Message templates" +slug: "merge-message-templates" +weight: 15 +toc: false +draft: false +menu: + sidebar: + parent: "usage" + name: "Merge Message templates" + weight: 15 + identifier: "merge-message-templates" +--- + +# Merge Message templates + +**Table of Contents** + +{{< toc >}} + +## File names + +Possible file names for PR default merge message templates: + +- `.gitea/default_merge_message/MERGE_TEMPLATE.md` +- `.gitea/default_merge_message/REBASE_TEMPLATE.md` +- `.gitea/default_merge_message/REBASE-MERGE_TEMPLATE.md` +- `.gitea/default_merge_message/SQUASH_TEMPLATE.md` +- `.gitea/default_merge_message/MANUALLY-MERGED_TEMPLATE.md` +- `.gitea/default_merge_message/REBASE-UPDATE-ONLY_TEMPLATE.md` + +## Variables + +You can use the following variables enclosed in `${}` inside these templates which follow [os.Expand](https://pkg.go.dev/os#Expand) syntax: + +- BaseRepoOwnerName: Base repository owner name of this pull request +- BaseRepoName: Base repository name of this pull request +- BaseBranch: Base repository target branch name of this pull request +- HeadRepoOwnerName: Head repository owner name of this pull request +- HeadRepoName: Head repository name of this pull request +- HeadBranch: Head repository branch name of this pull request +- PullRequestTitle: Pull request's title +- PullRequestDescription: Pull request's description +- PullRequestPosterName: Pull request's poster name +- PullRequestIndex: Pull request's index number +- PullRequestReference: Pull request's reference char with index number. i.e. #1, !2 +- ClosingIssues: return a string contains all issues which will be closed by this pull request i.e. `close #1, close #2` From be266dd55e02bbf78a853e134d4cd548c97203d0 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Wed, 31 Aug 2022 19:26:20 +0800 Subject: [PATCH 35/44] docs: introduce syntax of yaml template --- .../issue-pull-request-templates.en-us.md | 215 +++++++++++++++--- 1 file changed, 187 insertions(+), 28 deletions(-) diff --git a/docs/content/doc/usage/issue-pull-request-templates.en-us.md b/docs/content/doc/usage/issue-pull-request-templates.en-us.md index 38cbfbf8a5a3c..f1d577e77b83f 100644 --- a/docs/content/doc/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/doc/usage/issue-pull-request-templates.en-us.md @@ -25,51 +25,53 @@ main branch of the repository so that they can autopopulate the form when users creating issues and pull requests. This will cut down on the initial back and forth of getting some clarifying details. +Additionally, the New Issue page URL can be suffixed with `?title=Issue+Title&body=Issue+Text` and the form will be populated with those strings. Those strings will be used instead of the template if there is one. + +## File names + Possible file names for issue templates: - `ISSUE_TEMPLATE.md` +- `ISSUE_TEMPLATE.yaml` +- `ISSUE_TEMPLATE.yml` - `issue_template.md` +- `issue_template.yaml` +- `issue_template.yml` - `.gitea/ISSUE_TEMPLATE.md` +- `.gitea/ISSUE_TEMPLATE.yaml` +- `.gitea/ISSUE_TEMPLATE.yml` +- `.gitea/issue_template.md` +- `.gitea/issue_template.yaml` - `.gitea/issue_template.md` - `.github/ISSUE_TEMPLATE.md` +- `.github/ISSUE_TEMPLATE.yaml` +- `.github/ISSUE_TEMPLATE.yml` - `.github/issue_template.md` +- `.github/issue_template.yaml` +- `.github/issue_template.yml` Possible file names for PR templates: - `PULL_REQUEST_TEMPLATE.md` +- `PULL_REQUEST_TEMPLATE.yaml` +- `PULL_REQUEST_TEMPLATE.yml` - `pull_request_template.md` +- `pull_request_template.yaml` +- `pull_request_template.yml` - `.gitea/PULL_REQUEST_TEMPLATE.md` +- `.gitea/PULL_REQUEST_TEMPLATE.yaml` +- `.gitea/PULL_REQUEST_TEMPLATE.yml` - `.gitea/pull_request_template.md` +- `.gitea/pull_request_template.yaml` +- `.gitea/pull_request_template.yml` - `.github/PULL_REQUEST_TEMPLATE.md` +- `.github/PULL_REQUEST_TEMPLATE.yaml` +- `.github/PULL_REQUEST_TEMPLATE.yml` - `.github/pull_request_template.md` +- `.github/pull_request_template.yaml` +- `.github/pull_request_template.yml` -Possible file names for PR default merge message templates: - -- `.gitea/default_merge_message/MERGE_TEMPLATE.md` -- `.gitea/default_merge_message/REBASE_TEMPLATE.md` -- `.gitea/default_merge_message/REBASE-MERGE_TEMPLATE.md` -- `.gitea/default_merge_message/SQUASH_TEMPLATE.md` -- `.gitea/default_merge_message/MANUALLY-MERGED_TEMPLATE.md` -- `.gitea/default_merge_message/REBASE-UPDATE-ONLY_TEMPLATE.md` - -You can use the following variables enclosed in `${}` inside these templates which follow [os.Expand](https://pkg.go.dev/os#Expand) syntax: - -- BaseRepoOwnerName: Base repository owner name of this pull request -- BaseRepoName: Base repository name of this pull request -- BaseBranch: Base repository target branch name of this pull request -- HeadRepoOwnerName: Head repository owner name of this pull request -- HeadRepoName: Head repository name of this pull request -- HeadBranch: Head repository branch name of this pull request -- PullRequestTitle: Pull request's title -- PullRequestDescription: Pull request's description -- PullRequestPosterName: Pull request's poster name -- PullRequestIndex: Pull request's index number -- PullRequestReference: Pull request's reference char with index number. i.e. #1, !2 -- ClosingIssues: return a string contains all issues which will be closed by this pull request i.e. `close #1, close #2` - -Additionally, the New Issue page URL can be suffixed with `?title=Issue+Title&body=Issue+Text` and the form will be populated with those strings. Those strings will be used instead of the template if there is one. - -## Issue Template Directory +## Directory names Alternatively, users can create multiple issue templates inside a special directory and allow users to choose one that more specifically addresses their problem. @@ -85,7 +87,9 @@ Possible directory names for issue templates: - `.gitlab/ISSUE_TEMPLATE` - `.gitlab/issue_template` -Inside the directory can be multiple markdown (`.md`) issue templates of the form +Inside the directory can be multiple markdown (`.md`) or yaml (`.yaml`/`.yml`) issue templates of the form. + +## Syntax for markdown template ```md --- @@ -108,3 +112,158 @@ In the above example, when a user is presented with the list of issues they can `This template is for testing!`. When submitting an issue with the above example, the issue title would be pre-populated with `[TEST] ` while the issue body would be pre-populated with `This is the template!`. The issue would also be assigned two labels, `bug` and `help needed`, and the issue will have a reference to `main`. + +## Syntax for yaml template + +This example YAML configuration file defines an issue form using several inputs to report a bug. + +```yaml +name: Bug Report +about: File a bug report +title: "[Bug]: " +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - 1.0.2 (Default) + - 1.0.3 (Edge) + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + options: + - label: I agree to follow this project's Code of Conduct + required: true +``` + +### Markdown + +You can use a `markdown` element to display Markdown in your form that provides extra context to the user, but is not submitted. + +Attributes: + +| Key | Description | Required | Type | Default | Valid values | +|-------|--------------------------------------------------------------|----------|--------|---------|--------------| +| value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - | + +### Textarea + +You can use a `textarea` element to add a multi-line text field to your form. Contributors can also attach files in `textarea` fields. + +Attributes: + +| Key | Description | Required | Type | Default | Valid values | +|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|--------|--------------|---------------------------| +| label | A brief description of the expected user input, which is also displayed in the form. | Required | String | - | - | +| description | A description of the text area to provide context or guidance, which is displayed in the form. | Optional | String | Empty String | - | +| placeholder | A semi-opaque placeholder that renders in the text area when empty. | Optional | String | Empty String | - | +| value | Text that is pre-filled in the text area. | Optional | String | - | - | +| render | If a value is provided, submitted text will be formatted into a codeblock. When this key is provided, the text area will not expand for file attachments or Markdown editing. | Optional | String | - | Languages known to Gitea. | + +Validations: + +| Key | Description | Required | Type | Default | Valid values | +|----------|------------------------------------------------------|----------|---------|---------|--------------| +| required | Prevents form submission until element is completed. | Optional | Boolean | false | - | + +### Input + +You can use an `input` element to add a single-line text field to your form. + +Attributes: + +| Key | Description | Required | Type | Default | Valid values | +|-------------|--------------------------------------------------------------------------------------------|----------|--------|--------------|--------------| +| label | A brief description of the expected user input, which is also displayed in the form. | Required | String | - | - | +| description | A description of the field to provide context or guidance, which is displayed in the form. | Optional | String | Empty String | - | +| placeholder | A semi-transparent placeholder that renders in the field when empty. | Optional | String | Empty String | - | +| value | Text that is pre-filled in the field. | Optional | String | - | - | + +Validations: + +| Key | Description | Required | Type | Default | Valid values | +|-----------|--------------------------------------------------------------------------------------------------|----------|---------|---------|--------------------------------------------------------------------------| +| required | Prevents form submission until element is completed. | Optional | Boolean | false | - | +| is_number | Prevents form submission until element is filled with a number. | Optional | Boolean | false | - | +| regex | Prevents form submission until element is filled with a value that match the regular expression. | Optional | String | - | a [regular expression](https://en.wikipedia.org/wiki/Regular_expression) | + +### Dropdown + +You can use a `dropdown` element to add a dropdown menu in your form. + +Attributes: + +| Key | Description | Required | Type | Default | Valid values | +|-------------|-----------------------------------------------------------------------------------------------------|----------|--------------|--------------|--------------| +| label | A brief description of the expected user input, which is displayed in the form. | Required | String | - | - | +| description | A description of the dropdown to provide extra context or guidance, which is displayed in the form. | Optional | String | Empty String | - | +| multiple | Determines if the user can select more than one option. | Optional | Boolean | false | - | +| options | An array of options the user can choose from. Cannot be empty and all choices must be distinct. | Required | String array | - | - | + +Validations: + +| Key | Description | Required | Type | Default | Valid values | +|----------|------------------------------------------------------|----------|---------|---------|--------------| +| required | Prevents form submission until element is completed. | Optional | Boolean | false | - | + +### Checkboxes + +You can use the `checkboxes` element to add a set of checkboxes to your form. + +Attributes: + +| Key | Description | Required | Type | Default | Valid values | +|-------------|-------------------------------------------------------------------------------------------------------|----------|--------|--------------|--------------| +| label | A brief description of the expected user input, which is displayed in the form. | Required | String | - | - | +| description | A description of the set of checkboxes, which is displayed in the form. Supports Markdown formatting. | Optional | String | Empty String | - | +| options | An array of checkboxes that the user can select. For syntax, see below. | Required | Array | - | - | + +For each value in the options array, you can set the following keys. + +| Key | Description | Required | Type | Default | Options | +|----------|------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|---------|---------| +| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | +| required | Prevents form submission until element is completed. | Optional | Boolean | false | - | From 59ce6b90e073b0c4d1b93a83d1bfcc905d99e5df Mon Sep 17 00:00:00 2001 From: Jason Song Date: Thu, 1 Sep 2022 17:19:11 +0800 Subject: [PATCH 36/44] feat: show a alert for invalid templates --- modules/context/repo.go | 28 +++++--- modules/issue/template/template_test.go | 2 +- modules/issue/template/unmarshal.go | 89 ++++++++++++++----------- options/locale/locale_en-US.ini | 2 + options/locale/locale_zh-CN.ini | 2 + routers/web/repo/compare.go | 6 +- routers/web/repo/issue.go | 64 +++++++++++++++--- templates/base/alert.tmpl | 5 ++ templates/repo/diff/compare.tmpl | 8 +++ templates/repo/issue/choose.tmpl | 1 + templates/repo/issue/new.tmpl | 8 +++ web_src/less/_base.less | 3 +- 12 files changed, 159 insertions(+), 59 deletions(-) diff --git a/modules/context/repo.go b/modules/context/repo.go index e011ce8108bc4..6a336c45f7526 100644 --- a/modules/context/repo.go +++ b/modules/context/repo.go @@ -1033,44 +1033,52 @@ func UnitTypes() func(ctx *Context) { } } -// IssueTemplatesFromDefaultBranch checks for issue templates in the repo's default branch +// IssueTemplatesFromDefaultBranch checks for valid issue templates in the repo's default branch, func (ctx *Context) IssueTemplatesFromDefaultBranch() []*api.IssueTemplate { + ret, _ := ctx.IssueTemplatesErrorsFromDefaultBranch() + return ret +} + +// IssueTemplatesErrorsFromDefaultBranch checks for issue templates in the repo's default branch, +// returns valid templates and the errors of invalid template files. +func (ctx *Context) IssueTemplatesErrorsFromDefaultBranch() ([]*api.IssueTemplate, map[string]error) { var issueTemplates []*api.IssueTemplate if ctx.Repo.Repository.IsEmpty { - return issueTemplates + return issueTemplates, nil } if ctx.Repo.Commit == nil { var err error ctx.Repo.Commit, err = ctx.Repo.GitRepo.GetBranchCommit(ctx.Repo.Repository.DefaultBranch) if err != nil { - return issueTemplates + return issueTemplates, nil } } + invalidFiles := map[string]error{} for _, dirName := range IssueTemplateDirCandidates { tree, err := ctx.Repo.Commit.SubTree(dirName) if err != nil { + log.Debug("get sub tree of %s: %v", dirName, err) continue } entries, err := tree.ListEntries() if err != nil { - return issueTemplates + log.Debug("list entries in %s: %v", dirName, err) + return issueTemplates, nil } for _, entry := range entries { if !template.CouldBe(entry.Name()) { continue } - it, err := template.UnmarshalFromEntry(entry, dirName) - if err != nil { - log.Debug("unmarshal template from %s: %v", entry.Name(), err) - } else if err := template.Validate(it); err != nil { - log.Debug("invalid template file %s: %v", entry.Name(), err) + fullName := path.Join(dirName, entry.Name()) + if it, err := template.UnmarshalFromEntry(entry, dirName); err != nil { + invalidFiles[fullName] = err } else { issueTemplates = append(issueTemplates, it) } } } - return issueTemplates + return issueTemplates, invalidFiles } diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index 1293f4d4c64e6..5b757277e74d3 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -314,7 +314,7 @@ body: } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - tmpl, err := Unmarshal("test.yaml", []byte(tt.content)) + tmpl, err := unmarshal("test.yaml", []byte(tt.content)) if err != nil { t.Fatal(err) } diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 11dcf110d17f8..e695d1e1cc664 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -18,53 +18,35 @@ import ( "gopkg.in/yaml.v2" ) -// Unmarshal parses out a template from the content -func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { +// CouldBe indicates a file with the filename could be a template, +// it is a low cost check before further processing. +func CouldBe(filename string) bool { it := &api.IssueTemplate{ FileName: filename, } + return it.Type() != "" +} - // Compatible with treating description as about - compatibleTemplate := &struct { - About string `yaml:"description"` - }{} +// Unmarshal parses out a valid template from the content +func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { + it, err := unmarshal(filename, content) + if err != nil { + return nil, err + } - if typ := it.Type(); typ == api.IssueTemplateTypeMarkdown { - templateBody, err := markdown.ExtractMetadata(string(content), it) - if err != nil { - return nil, fmt.Errorf("extract metadata: %w", err) - } - it.Content = templateBody - if it.About == "" { - if _, err := markdown.ExtractMetadata(string(content), compatibleTemplate); err == nil && compatibleTemplate.About != "" { - it.About = compatibleTemplate.About - } - } - } else if typ == api.IssueTemplateTypeYaml { - if err := yaml.Unmarshal(content, it); err != nil { - return nil, fmt.Errorf("yaml unmarshal: %w", err) - } - if it.About == "" { - if err := yaml.Unmarshal(content, compatibleTemplate); err == nil && compatibleTemplate.About != "" { - it.About = compatibleTemplate.About - } - } - for i, v := range it.Fields { - if v.ID == "" { - v.ID = strconv.Itoa(i) - } - } + if err := Validate(it); err != nil { + return nil, err } return it, nil } -// UnmarshalFromEntry parses out a template from the blob in entry +// UnmarshalFromEntry parses out a valid template from the blob in entry func UnmarshalFromEntry(entry *git.TreeEntry, dir string) (*api.IssueTemplate, error) { return unmarshalFromEntry(entry, filepath.Join(dir, entry.Name())) } -// UnmarshalFromCommit parses out a template from the commit +// UnmarshalFromCommit parses out a valid template from the commit func UnmarshalFromCommit(commit *git.Commit, filename string) (*api.IssueTemplate, error) { entry, err := commit.GetTreeEntryByPath(filename) if err != nil { @@ -73,7 +55,7 @@ func UnmarshalFromCommit(commit *git.Commit, filename string) (*api.IssueTemplat return unmarshalFromEntry(entry, filename) } -// UnmarshalFromRepo parses out a template from the head commit of the branch +// UnmarshalFromRepo parses out a valid template from the head commit of the branch func UnmarshalFromRepo(repo *git.Repository, branch, filename string) (*api.IssueTemplate, error) { commit, err := repo.GetBranchCommit(branch) if err != nil { @@ -102,11 +84,42 @@ func unmarshalFromEntry(entry *git.TreeEntry, filename string) (*api.IssueTempla return Unmarshal(filename, content) } -// CouldBe indicates a file with the filename could be a template, -// it is a low cost check before further processing. -func CouldBe(filename string) bool { +func unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { it := &api.IssueTemplate{ FileName: filename, } - return it.Type() != "" + + // Compatible with treating description as about + compatibleTemplate := &struct { + About string `yaml:"description"` + }{} + + if typ := it.Type(); typ == api.IssueTemplateTypeMarkdown { + templateBody, err := markdown.ExtractMetadata(string(content), it) + if err != nil { + return nil, err + } + it.Content = templateBody + if it.About == "" { + if _, err := markdown.ExtractMetadata(string(content), compatibleTemplate); err == nil && compatibleTemplate.About != "" { + it.About = compatibleTemplate.About + } + } + } else if typ == api.IssueTemplateTypeYaml { + if err := yaml.Unmarshal(content, it); err != nil { + return nil, fmt.Errorf("yaml unmarshal: %w", err) + } + if it.About == "" { + if err := yaml.Unmarshal(content, compatibleTemplate); err == nil && compatibleTemplate.About != "" { + it.About = compatibleTemplate.About + } + } + for i, v := range it.Fields { + if v.ID == "" { + v.ID = strconv.Itoa(i) + } + } + } + + return it, nil } diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index f900e90e7f851..ba647771e30fd 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -1231,6 +1231,8 @@ issues.new.add_reviewer_title = Request review issues.choose.get_started = Get Started issues.choose.blank = Default issues.choose.blank_about = Create an issue from default template. +issues.choose.ignore_invalid_templates = Invalid templates have been ignored +issues.choose.invalid_templates = %v invalid template(s) found issues.no_ref = No Branch/Tag Specified issues.create = Create Issue issues.new_label = New Label diff --git a/options/locale/locale_zh-CN.ini b/options/locale/locale_zh-CN.ini index 997899a900146..e479b28a79047 100644 --- a/options/locale/locale_zh-CN.ini +++ b/options/locale/locale_zh-CN.ini @@ -1229,6 +1229,8 @@ issues.new.add_reviewer_title=请求审核 issues.choose.get_started=开始 issues.choose.blank=默认模板 issues.choose.blank_about=从默认模板创建一个工单。 +issues.choose.ignore_invalid_templates=已忽略无效的模板 +issues.choose.invalid_templates=有 %v 个无效的模板 issues.no_ref=分支/标记未指定 issues.create=创建工单 issues.new_label=创建标签 diff --git a/routers/web/repo/compare.go b/routers/web/repo/compare.go index cdd80f57a7b58..e35af31724fdf 100644 --- a/routers/web/repo/compare.go +++ b/routers/web/repo/compare.go @@ -784,7 +784,11 @@ func CompareDiff(ctx *context.Context) { ctx.Data["IsRepoToolbarCommits"] = true ctx.Data["IsDiffCompare"] = true ctx.Data["RequireTribute"] = true - setTemplateIfExists(ctx, pullRequestTemplateKey, pullRequestTemplateCandidates) + templateErrs := setTemplateIfExists(ctx, pullRequestTemplateKey, pullRequestTemplateCandidates) + + if len(templateErrs) > 0 { + ctx.Flash.Warning(renderErrorOfTemplates(ctx, templateErrs), true) + } // If a template content is set, prepend the "content". In this case that's only // applicable if you have one commit to compare and that commit has a message. diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index 74d918e5af250..06e003bff282d 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -13,6 +13,7 @@ import ( "math/big" "net/http" "net/url" + "sort" "strconv" "strings" "time" @@ -44,6 +45,7 @@ import ( "code.gitea.io/gitea/modules/upload" "code.gitea.io/gitea/modules/util" "code.gitea.io/gitea/modules/web" + "code.gitea.io/gitea/routers/utils" asymkey_service "code.gitea.io/gitea/services/asymkey" comment_service "code.gitea.io/gitea/services/comments" "code.gitea.io/gitea/services/forms" @@ -733,21 +735,28 @@ func RetrieveRepoMetas(ctx *context.Context, repo *repo_model.Repository, isPull return labels } -func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleFiles []string) { +func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleFiles []string) map[string]error { + commit, err := ctx.Repo.GitRepo.GetBranchCommit(ctx.Repo.Repository.DefaultBranch) + if err != nil { + return nil + } + templateCandidates := make([]string, 0, 1+len(possibleFiles)) if t := ctx.FormString("template"); t != "" { templateCandidates = append(templateCandidates, t) } templateCandidates = append(templateCandidates, possibleFiles...) // Append files to the end because they should be fallback + + templateErrs := map[string]error{} for _, filename := range templateCandidates { - template, err := issue_template.UnmarshalFromRepo(ctx.Repo.GitRepo, ctx.Repo.Repository.DefaultBranch, filename) - if err != nil { + if ok, _ := commit.HasFile(filename); !ok { continue } - if issue_template.Validate(template) != nil { + template, err := issue_template.UnmarshalFromCommit(commit, filename) + if err != nil { + templateErrs[filename] = err continue } - ctx.Data[issueTemplateTitleKey] = template.Title ctx.Data[ctxDataKey] = template.Content @@ -779,8 +788,9 @@ func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleFiles ctx.Data["label_ids"] = strings.Join(labelIDs, ",") ctx.Data["Reference"] = template.Ref ctx.Data["RefEndName"] = git.RefEndName(template.Ref) - return + return templateErrs } + return templateErrs } // NewIssue render creating issue page @@ -829,24 +839,62 @@ func NewIssue(ctx *context.Context) { } RetrieveRepoMetas(ctx, ctx.Repo.Repository, false) - setTemplateIfExists(ctx, issueTemplateKey, IssueTemplateCandidates) + + _, templateErrs := ctx.IssueTemplatesErrorsFromDefaultBranch() + if errs := setTemplateIfExists(ctx, issueTemplateKey, IssueTemplateCandidates); len(errs) > 0 { + for k, v := range errs { + templateErrs[k] = v + } + } if ctx.Written() { return } + if len(templateErrs) > 0 { + ctx.Flash.Warning(renderErrorOfTemplates(ctx, templateErrs), true) + } + ctx.Data["HasIssuesOrPullsWritePermission"] = ctx.Repo.CanWrite(unit.TypeIssues) ctx.HTML(http.StatusOK, tplIssueNew) } +func renderErrorOfTemplates(ctx *context.Context, errs map[string]error) string { + var files []string + for k := range errs { + files = append(files, k) + } + sort.Strings(files) // keep the output stable + + var lines []string + for _, file := range files { + lines = append(lines, fmt.Sprintf("%s: %v", file, errs[file])) + } + + flashError, err := ctx.RenderToString(tplAlertDetails, map[string]interface{}{ + "Message": ctx.Tr("repo.issues.choose.ignore_invalid_templates"), + "Summary": ctx.Tr("repo.issues.choose.invalid_templates", len(errs)), + "Details": utils.SanitizeFlashErrorString(strings.Join(lines, "\n")), + }) + if err != nil { + log.Debug("render flash error: %v", err) + flashError = ctx.Tr("repo.issues.choose.ignore_invalid_templates") + } + return flashError +} + // NewIssueChooseTemplate render creating issue from template page func NewIssueChooseTemplate(ctx *context.Context) { ctx.Data["Title"] = ctx.Tr("repo.issues.new") ctx.Data["PageIsIssueList"] = true - issueTemplates := ctx.IssueTemplatesFromDefaultBranch() + issueTemplates, errs := ctx.IssueTemplatesErrorsFromDefaultBranch() ctx.Data["IssueTemplates"] = issueTemplates + if len(errs) > 0 { + ctx.Flash.Warning(renderErrorOfTemplates(ctx, errs), true) + } + if len(issueTemplates) == 0 { // The "issues/new" and "issues/new/choose" share the same query parameters "project" and "milestone", if no template here, just redirect to the "issues/new" page with these parameters. ctx.Redirect(fmt.Sprintf("%s/issues/new?%s", ctx.Repo.Repository.HTMLURL(), ctx.Req.URL.RawQuery), http.StatusSeeOther) diff --git a/templates/base/alert.tmpl b/templates/base/alert.tmpl index cf886f529cac2..b8a04b89a9585 100644 --- a/templates/base/alert.tmpl +++ b/templates/base/alert.tmpl @@ -13,3 +13,8 @@

{{.Flash.InfoMsg | Str2html}}

{{end}} +{{if .Flash.WarningMsg}} +
+

{{.Flash.WarningMsg | Str2html}}

+
+{{end}} diff --git a/templates/repo/diff/compare.tmpl b/templates/repo/diff/compare.tmpl index 5875efaac3a43..e9f2fc3b60bc5 100644 --- a/templates/repo/diff/compare.tmpl +++ b/templates/repo/diff/compare.tmpl @@ -11,6 +11,14 @@ {{.locale.Tr "action.compare_commits_general"}} {{end}} + {{if .Flash.WarningMsg}} + {{/* + There's alreay a importing of alert.tmpl in new_form.tmpl, + but only the negative message will be displayed within forms for some reasons, see semantic.css:10659. + To avoid repeated negative messages, the importing here if for .Flash.WarningMsg only. + */}} + {{template "base/alert" .}} + {{end}} {{$BaseCompareName := $.BaseName -}} {{- $HeadCompareName := $.HeadRepo.OwnerName -}} {{- if and (eq $.BaseName $.HeadRepo.OwnerName) (ne $.Repository.Name $.HeadRepo.Name) -}} diff --git a/templates/repo/issue/choose.tmpl b/templates/repo/issue/choose.tmpl index bbddd6d9a6ce3..609cd48436832 100644 --- a/templates/repo/issue/choose.tmpl +++ b/templates/repo/issue/choose.tmpl @@ -2,6 +2,7 @@
{{template "repo/header" .}}
+ {{template "base/alert" .}}
{{template "repo/issue/navbar" .}}
diff --git a/templates/repo/issue/new.tmpl b/templates/repo/issue/new.tmpl index f8929b375d002..9f46f8fddccc2 100644 --- a/templates/repo/issue/new.tmpl +++ b/templates/repo/issue/new.tmpl @@ -6,6 +6,14 @@ {{template "repo/issue/navbar" .}}
+ {{if .Flash.WarningMsg}} + {{/* + There's alreay a importing of alert.tmpl in new_form.tmpl, + but only the negative message will be displayed within forms for some reasons, see semantic.css:10659. + To avoid repeated negative messages, the importing here if for .Flash.WarningMsg only. + */}} + {{template "base/alert" .}} + {{end}} {{template "repo/issue/new_form" .}}
diff --git a/web_src/less/_base.less b/web_src/less/_base.less index 96c039c3b4322..bed672a35a869 100644 --- a/web_src/less/_base.less +++ b/web_src/less/_base.less @@ -2126,7 +2126,8 @@ table th[data-sortt-desc] { margin-top: inherit; } -.flash-error details code { +.flash-error details code, +.flash-warning details code { display: block; text-align: left; } From a0f3c8edb2e4ee4d5a994eaf4fa3a58e0653d76c Mon Sep 17 00:00:00 2001 From: Jason Song Date: Thu, 1 Sep 2022 18:13:46 +0800 Subject: [PATCH 37/44] test: add case for a valid template --- modules/issue/template/template_test.go | 152 ++++++++++++++++++++++++ 1 file changed, 152 insertions(+) diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index 5b757277e74d3..661c0a50808fc 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -5,7 +5,11 @@ package template import ( + "reflect" "testing" + + "code.gitea.io/gitea/modules/json" + api "code.gitea.io/gitea/modules/structs" ) func TestValidate(t *testing.T) { @@ -323,4 +327,152 @@ body: } }) } + + t.Run("valid", func(t *testing.T) { + content := ` +name: Name +title: Title +about: About +labels: ["label1", "label2"] +ref: Ref +body: + - type: markdown + id: id1 + attributes: + value: Value of the markdown + - type: textarea + id: id2 + attributes: + label: Label of textarea + description: Description of textarea + placeholder: Placeholder of textarea + value: Value of textarea + render: bash + validations: + required: true + - type: input + id: id3 + attributes: + label: Label of input + description: Description of input + placeholder: Placeholder of input + value: Value of input + validations: + required: true + is_number: true + regex: "[a-zA-Z0-9]+" + - type: dropdown + id: id4 + attributes: + label: Label of dropdown + description: Description of dropdown + multiple: true + options: + - Option 1 of dropdown + - Option 2 of dropdown + - Option 3 of dropdown + validations: + required: true + - type: checkboxes + id: id5 + attributes: + label: Label of checkboxes + description: Description of checkboxes + options: + - label: Option 1 of checkboxes + required: true + - label: Option 2 of checkboxes + required: false + - label: Option 3 of checkboxes + required: true +` + want := &api.IssueTemplate{ + Name: "Name", + Title: "Title", + About: "About", + Labels: []string{"label1", "label2"}, + Ref: "Ref", + Fields: []*api.IssueFormField{ + { + Type: "markdown", + ID: "id1", + Attributes: map[string]interface{}{ + "value": "Value of the markdown", + }, + }, + { + Type: "textarea", + ID: "id2", + Attributes: map[string]interface{}{ + "label": "Label of textarea", + "description": "Description of textarea", + "placeholder": "Placeholder of textarea", + "value": "Value of textarea", + "render": "bash", + }, + Validations: map[string]interface{}{ + "required": true, + }, + }, + { + Type: "input", + ID: "id3", + Attributes: map[string]interface{}{ + "label": "Label of input", + "description": "Description of input", + "placeholder": "Placeholder of input", + "value": "Value of input", + }, + Validations: map[string]interface{}{ + "required": true, + "is_number": true, + "regex": "[a-zA-Z0-9]+", + }, + }, + { + Type: "dropdown", + ID: "id4", + Attributes: map[string]interface{}{ + "label": "Label of dropdown", + "description": "Description of dropdown", + "multiple": true, + "options": []interface{}{ + "Option 1 of dropdown", + "Option 2 of dropdown", + "Option 3 of dropdown", + }, + }, + Validations: map[string]interface{}{ + "required": true, + }, + }, + { + Type: "checkboxes", + ID: "id5", + Attributes: map[string]interface{}{ + "label": "Label of checkboxes", + "description": "Description of checkboxes", + "options": []interface{}{ + map[interface{}]interface{}{"label": "Option 1 of checkboxes", "required": true}, + map[interface{}]interface{}{"label": "Option 2 of checkboxes", "required": false}, + map[interface{}]interface{}{"label": "Option 3 of checkboxes", "required": true}, + }, + }, + }, + }, + FileName: "test.yaml", + } + got, err := unmarshal("test.yaml", []byte(content)) + if err != nil { + t.Fatal(err) + } + if err := Validate(got); err != nil { + t.Errorf("Validate() error = %v", err) + } + if !reflect.DeepEqual(want, got) { + jsonWant, _ := json.Marshal(want) + jsonGot, _ := json.Marshal(got) + t.Errorf("want:\n%s\ngot:\n%s", jsonWant, jsonGot) + } + }) } From ebfbb852c124ea9135984404fa0ffb1f0dd315d2 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Fri, 2 Sep 2022 10:12:24 +0800 Subject: [PATCH 38/44] fix: correct attributes of required checkbox --- templates/repo/issue/fields/checkboxes.tmpl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index 50b32c1fbf3d8..b70334681f22f 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -3,8 +3,8 @@ {{$field := .}} {{range $i, $opt := .Attributes.options}}
-
- +
+
From fd14fbe163e27d7b693b90eb68f8cdc2ed1c2f66 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Fri, 2 Sep 2022 10:40:31 +0800 Subject: [PATCH 39/44] fix: add class not-under-easymde for dropzone --- templates/repo/issue/comment_tab.tmpl | 17 +++++++++++------ web_src/less/features/dropzone.less | 6 ++++++ 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index 542a85ca0b85d..5397312cf7586 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -13,7 +13,11 @@ {{template "repo/issue/fields/checkboxes" .}} {{end}} {{end}} -
{{/* the upload dropzone expects a field above and closes to it, see dropzone.less:9 */}} + {{if .IsAttachmentEnabled}} +
+ {{template "repo/upload" .}} +
+ {{end}} {{else}}
{{.locale.Tr "write"}} @@ -29,9 +33,10 @@ {{.locale.Tr "loading"}}
+ {{if .IsAttachmentEnabled}} +
+ {{template "repo/upload" .}} +
+ {{end}} {{end}} -{{if .IsAttachmentEnabled}} -
- {{template "repo/upload" .}} -
-{{end}} + diff --git a/web_src/less/features/dropzone.less b/web_src/less/features/dropzone.less index d31aedff3e1e4..9aee645c1e12c 100644 --- a/web_src/less/features/dropzone.less +++ b/web_src/less/features/dropzone.less @@ -13,6 +13,12 @@ } } +.ui .field.not-under-easymde { + .dropzone { + margin-top: 0; // the `field` above isn't an EasyMDE editor + } +} + .dropzone .dz-button { color: var(--color-text-light) !important; } From e2529ee54478034bb84414572ba3454223f6bc16 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Fri, 2 Sep 2022 12:13:32 +0800 Subject: [PATCH 40/44] fix: use more back-quotes --- modules/issue/template/template.go | 25 +++- modules/issue/template/template_test.go | 167 ++++++++++++++++++++++++ 2 files changed, 187 insertions(+), 5 deletions(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 2b164c8831f97..2d83152528793 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -7,6 +7,7 @@ package template import ( "fmt" "net/url" + "regexp" "strconv" "strings" @@ -286,17 +287,19 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { _, _ = fmt.Fprint(builder, blankPlaceholder) } case api.IssueFormFieldTypeInput: - if v := f.Value(); v == "" { + if value := f.Value(); value == "" { _, _ = fmt.Fprint(builder, blankPlaceholder) + } else { + _, _ = fmt.Fprintf(builder, "%s\n", value) } - _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) case api.IssueFormFieldTypeTextarea: - if v := f.Value(); v == "" { + if value := f.Value(); value == "" { _, _ = fmt.Fprint(builder, blankPlaceholder) } else if render := f.Render(); render != "" { - _, _ = fmt.Fprintf(builder, "```%s\n%s\n```\n", f.Render(), f.Value()) + quotes := minQuotes(value) + _, _ = fmt.Fprintf(builder, "%s%s\n%s\n%s\n", quotes, f.Render(), value, quotes) } else { - _, _ = fmt.Fprintf(builder, "%s\n", f.Value()) + _, _ = fmt.Fprintf(builder, "%s\n", value) } } _, _ = fmt.Fprintln(builder) @@ -373,3 +376,15 @@ func (o *valuedOption) IsChecked() bool { } return false } + +// minQuotes return 3 or more back-quotes. +// If n back-quotes exists, use n+1 back-quotes to quote. +func minQuotes(value string) string { + ret := "```" + for _, v := range regexp.MustCompilePOSIX("^`{3,}").FindAllString(value, -1) { + if len(v) >= len(ret) { + ret = v + "`" + } + } + return ret +} diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index 661c0a50808fc..883e1e0780510 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -5,6 +5,7 @@ package template import ( + "net/url" "reflect" "testing" @@ -476,3 +477,169 @@ body: } }) } + +func TestRenderToMarkdown(t *testing.T) { + type args struct { + template string + values url.Values + } + tests := []struct { + name string + args args + want string + }{ + { + name: "normal", + args: args{ + template: ` +name: Name +title: Title +about: About +labels: ["label1", "label2"] +ref: Ref +body: + - type: markdown + id: id1 + attributes: + value: Value of the markdown + - type: textarea + id: id2 + attributes: + label: Label of textarea + description: Description of textarea + placeholder: Placeholder of textarea + value: Value of textarea + render: bash + validations: + required: true + - type: input + id: id3 + attributes: + label: Label of input + description: Description of input + placeholder: Placeholder of input + value: Value of input + validations: + required: true + is_number: true + regex: "[a-zA-Z0-9]+" + - type: dropdown + id: id4 + attributes: + label: Label of dropdown + description: Description of dropdown + multiple: true + options: + - Option 1 of dropdown + - Option 2 of dropdown + - Option 3 of dropdown + validations: + required: true + - type: checkboxes + id: id5 + attributes: + label: Label of checkboxes + description: Description of checkboxes + options: + - label: Option 1 of checkboxes + required: true + - label: Option 2 of checkboxes + required: false + - label: Option 3 of checkboxes + required: true +`, + values: map[string][]string{ + "form-field-id2": {"Value of id2"}, + "form-field-id3": {"Value of id3"}, + "form-field-id4": {"0,1"}, + "form-field-id5-0": {"on"}, + "form-field-id5-2": {"on"}, + }, + }, + want: `### Label of textarea + +` + "```bash\nValue of id2\n```" + ` + +### Label of input + +Value of id3 + +### Label of dropdown + +Option 1 of dropdown, Option 2 of dropdown + +### Label of checkboxes + +- [x] Option 1 of checkboxes +- [ ] Option 2 of checkboxes +- [x] Option 3 of checkboxes + +`, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + template, err := Unmarshal("test.yaml", []byte(tt.args.template)) + if err != nil { + t.Fatal(err) + } + if got := RenderToMarkdown(template, tt.args.values); got != tt.want { + t.Errorf("RenderToMarkdown() = %v, want %v", got, tt.want) + } + }) + } +} + +func Test_minQuotes(t *testing.T) { + type args struct { + value string + } + tests := []struct { + name string + args args + want string + }{ + { + name: "without quote", + args: args{ + value: "Hello\nWorld", + }, + want: "```", + }, + { + name: "with 1 quote", + args: args{ + value: "Hello\nWorld\n`text`\n", + }, + want: "```", + }, + { + name: "with 3 quotes", + args: args{ + value: "Hello\nWorld\n`text`\n```go\ntext\n```\n", + }, + want: "````", + }, + { + name: "with more quotes", + args: args{ + value: "Hello\nWorld\n`text`\n```go\ntext\n```\n``````````bash\ntext\n``````````\n", + }, + want: "```````````", + }, + { + name: "not leading quotes", + args: args{ + value: "Hello\nWorld`text````go\ntext`````````````bash\ntext``````````\n", + }, + want: "```", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := minQuotes(tt.args.value); got != tt.want { + t.Errorf("minQuotes() = %v, want %v", got, tt.want) + } + }) + } +} From 1f3943cf27f22b6673c021ccdc6a62f913841890 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Fri, 2 Sep 2022 12:53:25 +0800 Subject: [PATCH 41/44] chore: remove translation in zh-CN --- options/locale/locale_zh-CN.ini | 2 -- 1 file changed, 2 deletions(-) diff --git a/options/locale/locale_zh-CN.ini b/options/locale/locale_zh-CN.ini index e479b28a79047..997899a900146 100644 --- a/options/locale/locale_zh-CN.ini +++ b/options/locale/locale_zh-CN.ini @@ -1229,8 +1229,6 @@ issues.new.add_reviewer_title=请求审核 issues.choose.get_started=开始 issues.choose.blank=默认模板 issues.choose.blank_about=从默认模板创建一个工单。 -issues.choose.ignore_invalid_templates=已忽略无效的模板 -issues.choose.invalid_templates=有 %v 个无效的模板 issues.no_ref=分支/标记未指定 issues.create=创建工单 issues.new_label=创建标签 From 233337da3cf3ddb43e6651ac62377b775de80585 Mon Sep 17 00:00:00 2001 From: wxiaoguang Date: Fri, 2 Sep 2022 14:23:40 +0800 Subject: [PATCH 42/44] fix EasyMDE statusbar margin --- templates/repo/issue/comment_tab.tmpl | 2 +- web_src/less/codemirror/base.less | 4 ++++ web_src/less/features/dropzone.less | 7 ------- 3 files changed, 5 insertions(+), 8 deletions(-) diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index 5397312cf7586..5c9a3701965e9 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -14,7 +14,7 @@ {{end}} {{end}} {{if .IsAttachmentEnabled}} -
+
{{template "repo/upload" .}}
{{end}} diff --git a/web_src/less/codemirror/base.less b/web_src/less/codemirror/base.less index 87344574634fd..db0a93f4c74ab 100644 --- a/web_src/less/codemirror/base.less +++ b/web_src/less/codemirror/base.less @@ -1,3 +1,7 @@ +.ui .field:not(:last-child) .EasyMDEContainer .editor-statusbar { + margin-bottom: -1em; // when there is a statusbar, the "margin-bottom: 1em" of the "field" is not needed, because the statusbar is likely a blank line +} + .EasyMDEContainer .CodeMirror { color: var(--color-input-text); background-color: var(--color-input-background); diff --git a/web_src/less/features/dropzone.less b/web_src/less/features/dropzone.less index 9aee645c1e12c..ee7a5f1b65d44 100644 --- a/web_src/less/features/dropzone.less +++ b/web_src/less/features/dropzone.less @@ -6,19 +6,12 @@ padding: 0; border-radius: 4px; min-height: 0; - margin-top: -1em; // we have another `field` above, it's usually an EasyMDE editor with "status bar", so we do not need the space above. .dz-message { margin: 10px 0; } } } -.ui .field.not-under-easymde { - .dropzone { - margin-top: 0; // the `field` above isn't an EasyMDE editor - } -} - .dropzone .dz-button { color: var(--color-text-light) !important; } From 1c3b2e453ffa6c1337cadc2ab8c979086ecf589b Mon Sep 17 00:00:00 2001 From: Jason Song Date: Fri, 2 Sep 2022 14:45:31 +0800 Subject: [PATCH 43/44] fix: remove repeated blocks --- templates/repo/issue/comment_tab.tmpl | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index 5c9a3701965e9..b70433a966431 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -13,11 +13,6 @@ {{template "repo/issue/fields/checkboxes" .}} {{end}} {{end}} - {{if .IsAttachmentEnabled}} -
- {{template "repo/upload" .}} -
- {{end}} {{else}}
{{.locale.Tr "write"}} @@ -33,10 +28,9 @@ {{.locale.Tr "loading"}}
- {{if .IsAttachmentEnabled}} -
- {{template "repo/upload" .}} -
- {{end}} {{end}} - +{{if .IsAttachmentEnabled}} +
+ {{template "repo/upload" .}} +
+{{end}} From 7018c82894b9002975cdde654eadca001c6e2c89 Mon Sep 17 00:00:00 2001 From: Jason Song Date: Fri, 2 Sep 2022 14:47:28 +0800 Subject: [PATCH 44/44] fix: reuse regex for quotes --- modules/issue/template/template.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 2d83152528793..a4c0fb5aa644f 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -377,11 +377,13 @@ func (o *valuedOption) IsChecked() bool { return false } +var minQuotesRegex = regexp.MustCompilePOSIX("^`{3,}") + // minQuotes return 3 or more back-quotes. // If n back-quotes exists, use n+1 back-quotes to quote. func minQuotes(value string) string { ret := "```" - for _, v := range regexp.MustCompilePOSIX("^`{3,}").FindAllString(value, -1) { + for _, v := range minQuotesRegex.FindAllString(value, -1) { if len(v) >= len(ret) { ret = v + "`" }