internal/reviews/display.go - oscar - Git at Google

 // Copyright 2024 The Go Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.

 package reviews

 import (
 	"bytes"
 	"context"
 	"encoding/json"
 	"errors"
 	"fmt"
 	"html/template"
 	"io"
 	"log/slog"
 	"net/http"
 	"strings"

 	"golang.org/x/oscar/internal/filter"
 )

 // Display is an HTTP handler function that displays the
 // changes to review.
 func Display(ctx context.Context, lg *slog.Logger, doc template.HTML, defaultCategoriesJSON, endpoint string, cps []ChangePreds, w http.ResponseWriter, r *http.Request) {
 	if len(cps) == 0 {
 		io.WriteString(w, reportNoData)
 		return
 	}

 	userFilter := r.FormValue("filter")
 	filterFn, err := makeFilter(userFilter)
 	if err != nil {
 		http.Error(w, fmt.Sprintf("invalid filter: %v", err), http.StatusBadRequest)
 		return
 	}

 	categoriesJSON := r.FormValue("categories")
 	if categoriesJSON == "" {
 		categoriesJSON = defaultCategoriesJSON
 	}

 	var categoryDefs []categoryDef
 	if categoriesJSON != "" {
 		if err := json.Unmarshal([]byte(categoriesJSON), &categoryDefs); err != nil {
 			http.Error(w, fmt.Sprintf("can't unmarshal JSON categories %q: %v", categoriesJSON, err), http.StatusBadRequest)
 			return
 		}
 	}

 	if len(categoryDefs) == 0 {
 		categoryDefs = []categoryDef{
 			{
 				Name:   "",
 				Doc:    "",
 				Filter: "",
 			},
 		}
 	} else {
 		categoryDefs = append(categoryDefs,
 			categoryDef{
 				Name:   "Remainder",
 				Doc:    "CLs not matched by earlier categories",
 				Filter: "",
 			},
 		)
 	}

 	categoryFilters := make([]func(context.Context, ChangePreds) bool, 0, len(categoryDefs))
 	for _, catDef := range categoryDefs {
 		fn, err := makeFilter(catDef.Filter)
 		if err != nil {
 			http.Error(w, fmt.Sprintf("invalid category filter %q: %v", catDef.Filter, err), http.StatusBadRequest)
 			return
 		}
 		categoryFilters = append(categoryFilters, fn)
 	}

 	categories := make([]category, 0, len(categoryDefs))
 	for _, catDef := range categoryDefs {
 		categories = append(categories, category{
 			Name: catDef.Name,
 			Doc:  catDef.Doc,
 		})
 	}

 	for _, v := range cps {
 		if filterFn != nil && !filterFn(ctx, v) {
 			continue
 		}

 		for i := range categories {
 			if categoryFilters[i] == nil || categoryFilters[i](ctx, v) {
 				categories[i].Changes = append(categories[i].Changes, CP{v})
 				break
 			}
 		}
 	}

 	var jsonBuf bytes.Buffer
 	if len(categoriesJSON) > 0 {
 		if err := json.Indent(&jsonBuf, []byte(categoriesJSON), "", "  "); err != nil {
 			lg.Error("reviews.Display: json.Indent failure", "input", categoriesJSON, "err", err)
 		}
 	}

 	data := &displayType{
 		Endpoint:       endpoint,
 		Doc:            doc,
 		Filter:         userFilter,
 		Categories:     categories,
 		CategoriesJSON: jsonBuf.String(),
 	}
 	if err := displayTemplate.Execute(w, data); err != nil {
 		lg.Error("reviews.Display: template execution failed", "err", err)
 	}
 }

 // makeFilter turns the user-specific filter string into a filter function.
 // This returns nil if there is nothing to filter.
 func makeFilter(s string) (func(context.Context, ChangePreds) bool, error) {
 	if s == "" {
 		return nil, nil
 	}
 	expr, err := filter.ParseFilter(s)
 	if err != nil {
 		return nil, err
 	}
 	ev, problems := filter.Evaluator[ChangePreds](expr, nil)
 	if len(problems) > 0 {
 		return nil, errors.New(strings.Join(problems, "\n"))
 	}
 	fn := func(ctx context.Context, cp ChangePreds) bool {
 		return ev(ctx, cp)
 	}
 	return fn, nil
 }

 // categoryDef is a category definition.
 // This is a name, documentation, and a predicate.
 type categoryDef struct {
 	Name   string `json:"name,omitempty"`
 	Doc    string `json:"doc,omitempty"`
 	Filter string `json:"filter,omitempty"`
 }

 // reportNoData is the HTML that we report if we have not finished
 // applying predicates to changes.
 const reportNoData = `
 <!DOCTYPE html>
 <html lang="en">
 <meta http-equiv="refresh" content="30">
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1">
   <head>
     <title>Collecting Data...</title>
   </head>
   <body>
     <h1>Please wait</h1>
     Still collecting data to report...
   </body>
 </html>
 `

 // displayTemplate is used to display the changes.
 var displayTemplate = template.Must(template.New("display").Parse(displayHTML))

 // displayType is the type expected by displayHTML and displayTemplate.
 type displayType struct {
 	Ctx            context.Context
 	Endpoint       string        // Relative URL being served.
 	Doc            template.HTML // Documentation string.
 	Filter         string        // Filter value.
 	Categories     []category    // Changes grouped by category.
 	CategoriesJSON string        // Category definitions as JSON string.
 }

 // category is a group of changes.
 type category struct {
 	Name    string // Name of category.
 	Doc     string // Documentation for category.
 	Changes []CP   // List of changes with predicates.
 }

 // CP is a list of changes. This is not just ChangePreds
 // because we give the template a FormattedLastUpdate method.
 type CP struct {
 	ChangePreds
 }

 // FormattedLastUpdate returns the time of the last update as YYYY-MM-DD.
 func (cp *CP) FormattedLastUpdate(ctx context.Context) string {
 	return cp.Change.Updated(ctx).Format("2006-01-02")
 }

 // displayHTML is the web page we display. This is HTML template source.
 // Loosely copied from golang.org/x/build/devapp/template/reviews.tmpl.
 const displayHTML = `
 <!DOCTYPE html>
 <html lang="en">
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <style>
 * {
   box-sizing: border-box;
   margin: 0;
   padding: 0;
 }
 body {
   font: 13px system-ui, sans-serif;
   padding: 1rem;
 }
 h2 {
   margin: 1em 0 .35em;
 }
 h3:first-of-type {
   padding: 0
 }
 a:link,
 a:visited {
   color: #00c;
 }
 header {
   border-bottom: 1px solid #666;
   margin-bottom: 10px;
   padding-bottom: 10px;
 }
 .header-subtitle {
   color: #666;
   font-size: .9em;
 }
 .categoryname {
   padding: 1em 0;
   font-size: 1.5em;
   font-weight: bold;
 }
 .categorydoc {
   color: #666;
   font-size: .9em;
 }
 .row {
   border-bottom: 1px solid #f1f2f3;
   display: flex;
   padding: .5em 0;
   white-space: nowrap;
 }
 .date {
   min-width: 6rem;
 }
 .owner {
   min-width: 10rem;
   max-width: 10rem;
   overflow: hidden;
   text-overflow: ellipsis;
   padding-right: 1em;
 }
 .predicates {
   margin-left: 6rem;
   font-size: .9em;
 }
 .highscore {
   color: #fff;
   display: inline-block;
   border-radius: 2px;
   padding: 2px 5px;
   text-decoration: none;
   background-color: #2e7d32;
 }
 .posscore {
   color: #000;
   display: inline-block;
   border-radius: 2px;
   padding: 2px 5px;
   text-decoration: none;
   background-color: #dcedc8;
 }
 .negscore {
   color: #000;
   display: inline-block;
   border-radius: 2px;
   padding: 2px 5px;
   text-decoration: none;
   background-color: #fdaeb7;
 }
 .lowscore {
   color: #fff;
   display: inline-block;
   border-radius: 2px;
   padding: 2px 5px;
   text-decoration: none;
   background-color: #b71c1c;
 }
 .zeroscore {
   color: #000;
   display: inline-block;
   border-radius: 2px;
   padding: 2px 5px;
   text-decoration: none;
   background-color: #e0e0e0;
 }
 .icons,
 .number {
   flex-shrink: 0;
 }
 .icons {
   height: 20px;
   margin-right: 1.5em;
   text-align: right;
   width: 12em;
 }
 .number {
   margin-right: 1.5em;
   text-align: right;
   width: 6ch;
 }
 .subject {
   overflow: hidden;
   text-overflow: ellipsis;
 }
 [hidden] {
   display: none;
 }
 </style>
   <head>
     <title>Open Go Code Reviews</title>
   </head>
   <body>
     <header>
       <strong>Open changes</strong>
       <div class="header-subtitle">
         {{.Doc}}
       </div>
       <div class="header-subtitle">
         <a href="https://go.googlesource.com/oscar/+/master/internal/reviews/display.go">Source code</a>
       </div>
     </header>
     <form id="form" action="{{.Endpoint}}" method="GET">
       <div class="filter">
 	<span>
 	  <label for="filter">Filter</label>
 	  <input id="filter" type="text" size=75 name="filter" value="{{.Filter}}"/>
 	</span>
       </div>
       <div class="header-subtitle">
         Sample filters: "Russ Cox" / Change.Author.Name:"rsc" / Change.Subject:"runtime" / Predicates.Name:hasUnresolvedComments / Change.Created > "2024-01-01"
       </div>
       {{$ctx := .Ctx}}
       {{range $category := .Categories}}
 	{{if eq (len .Changes) 0}}{{continue}}{{end}}
 	<div class="categoryname">{{.Name}}</div>
 	<div class="categorydoc">{{.Doc}}</div>
 	{{range $change := .Changes}}
 	  <div class="row">
 	    <span class="date">{{.FormattedLastUpdate $ctx}}</span>
 	    <span class="owner">{{with $author := .Change.Author $ctx}}{{$author.DisplayName $ctx}}{{end}}</span>
 	    <a class="number" href="https://go.dev/cl/{{.Change.ID $ctx}}" target="_blank">{{.Change.ID $ctx}}</a>
 	    <span class="subject">{{.Change.Subject $ctx}}</span>
 	    <span class="predicates">
 	      {{range $pred := .Predicates}}
 		{{if ge .Score 10}}
 		  <span class="highscore">
 		{{else if gt .Score 0}}
 		  <span class="posscore">
 		{{else if le .Score -10}}
 		  <span class="lowscore">
 		{{else if lt .Score 0}}
 		  <span class="negscore">
 		{{else}}
 		  <span class="zeroscore">
 		{{end}}
 		{{.Name}}
 		</span>
 	      {{end}}
 	    </span>
 	  </div>
 	{{end}}
       {{end}}
       <div class="categories">
 	<span>
 	  <label for="categories">Categories</label>
 	  <textarea id="categories" name="categories" rows="9", cols="80">{{.CategoriesJSON}}</textarea>
 	</span>
       </div>
     </form>
   </body>
 </html>
 `
	// Copyright 2024 The Go Authors. All rights reserved.
	// Use of this source code is governed by a BSD-style
	// license that can be found in the LICENSE file.

	package reviews

	import (
	"bytes"
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"html/template"
	"io"
	"log/slog"
	"net/http"
	"strings"

	"golang.org/x/oscar/internal/filter"
	)

	// Display is an HTTP handler function that displays the
	// changes to review.
	func Display(ctx context.Context, lg slog.Logger, doc template.HTML, defaultCategoriesJSON, endpoint string, cps []ChangePreds, w http.ResponseWriter, r http.Request) {
	if len(cps) == 0 {
	io.WriteString(w, reportNoData)
	return
	}

	userFilter := r.FormValue("filter")
	filterFn, err := makeFilter(userFilter)
	if err != nil {
	http.Error(w, fmt.Sprintf("invalid filter: %v", err), http.StatusBadRequest)
	return
	}

	categoriesJSON := r.FormValue("categories")
	if categoriesJSON == "" {
	categoriesJSON = defaultCategoriesJSON
	}

	var categoryDefs []categoryDef
	if categoriesJSON != "" {
	if err := json.Unmarshal([]byte(categoriesJSON), &categoryDefs); err != nil {
	http.Error(w, fmt.Sprintf("can't unmarshal JSON categories %q: %v", categoriesJSON, err), http.StatusBadRequest)
	return
	}
	}

	if len(categoryDefs) == 0 {
	categoryDefs = []categoryDef{
	{
	Name: "",
	Doc: "",
	Filter: "",
	},
	}
	} else {
	categoryDefs = append(categoryDefs,
	categoryDef{
	Name: "Remainder",
	Doc: "CLs not matched by earlier categories",
	Filter: "",
	},
	)
	}

	categoryFilters := make([]func(context.Context, ChangePreds) bool, 0, len(categoryDefs))
	for _, catDef := range categoryDefs {
	fn, err := makeFilter(catDef.Filter)
	if err != nil {
	http.Error(w, fmt.Sprintf("invalid category filter %q: %v", catDef.Filter, err), http.StatusBadRequest)
	return
	}
	categoryFilters = append(categoryFilters, fn)
	}

	categories := make([]category, 0, len(categoryDefs))
	for _, catDef := range categoryDefs {
	categories = append(categories, category{
	Name: catDef.Name,
	Doc: catDef.Doc,
	})
	}

	for _, v := range cps {
	if filterFn != nil && !filterFn(ctx, v) {
	continue
	}

	for i := range categories {
	if categoryFilters[i] == nil \|\| categoryFilters[i](ctx, v) {
	categories[i].Changes = append(categories[i].Changes, CP{v})
	break
	}
	}
	}

	var jsonBuf bytes.Buffer
	if len(categoriesJSON) > 0 {
	if err := json.Indent(&jsonBuf, []byte(categoriesJSON), "", " "); err != nil {
	lg.Error("reviews.Display: json.Indent failure", "input", categoriesJSON, "err", err)
	}
	}

	data := &displayType{
	Endpoint: endpoint,
	Doc: doc,
	Filter: userFilter,
	Categories: categories,
	CategoriesJSON: jsonBuf.String(),
	}
	if err := displayTemplate.Execute(w, data); err != nil {
	lg.Error("reviews.Display: template execution failed", "err", err)
	}
	}

	// makeFilter turns the user-specific filter string into a filter function.
	// This returns nil if there is nothing to filter.
	func makeFilter(s string) (func(context.Context, ChangePreds) bool, error) {
	if s == "" {
	return nil, nil
	}
	expr, err := filter.ParseFilter(s)
	if err != nil {
	return nil, err
	}
	ev, problems := filter.Evaluator[ChangePreds](expr, nil)
	if len(problems) > 0 {
	return nil, errors.New(strings.Join(problems, "\n"))
	}
	fn := func(ctx context.Context, cp ChangePreds) bool {
	return ev(ctx, cp)
	}
	return fn, nil
	}

	// categoryDef is a category definition.
	// This is a name, documentation, and a predicate.
	type categoryDef struct {
	Name string `json:"name,omitempty"`
	Doc string `json:"doc,omitempty"`
	Filter string `json:"filter,omitempty"`
	}

	// reportNoData is the HTML that we report if we have not finished
	// applying predicates to changes.
	const reportNoData = `
	<!DOCTYPE html>
	<html lang="en">
	<meta http-equiv="refresh" content="30">
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<head>
	<title>Collecting Data...</title>
	</head>
	<body>
	<h1>Please wait</h1>
	Still collecting data to report...
	</body>
	</html>
	`

	// displayTemplate is used to display the changes.
	var displayTemplate = template.Must(template.New("display").Parse(displayHTML))

	// displayType is the type expected by displayHTML and displayTemplate.
	type displayType struct {
	Ctx context.Context
	Endpoint string // Relative URL being served.
	Doc template.HTML // Documentation string.
	Filter string // Filter value.
	Categories []category // Changes grouped by category.
	CategoriesJSON string // Category definitions as JSON string.
	}

	// category is a group of changes.
	type category struct {
	Name string // Name of category.
	Doc string // Documentation for category.
	Changes []CP // List of changes with predicates.
	}

	// CP is a list of changes. This is not just ChangePreds
	// because we give the template a FormattedLastUpdate method.
	type CP struct {
	ChangePreds
	}

	// FormattedLastUpdate returns the time of the last update as YYYY-MM-DD.
	func (cp *CP) FormattedLastUpdate(ctx context.Context) string {
	return cp.Change.Updated(ctx).Format("2006-01-02")
	}

	// displayHTML is the web page we display. This is HTML template source.
	// Loosely copied from golang.org/x/build/devapp/template/reviews.tmpl.
	const displayHTML = `
	<!DOCTYPE html>
	<html lang="en">
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<style>
	* {
	box-sizing: border-box;
	margin: 0;
	padding: 0;
	}
	body {
	font: 13px system-ui, sans-serif;
	padding: 1rem;
	}
	h2 {
	margin: 1em 0 .35em;
	}
	h3:first-of-type {
	padding: 0
	}
	a:link,
	a:visited {
	color: #00c;
	}
	header {
	border-bottom: 1px solid #666;
	margin-bottom: 10px;
	padding-bottom: 10px;
	}
	.header-subtitle {
	color: #666;
	font-size: .9em;
	}
	.categoryname {
	padding: 1em 0;
	font-size: 1.5em;
	font-weight: bold;
	}
	.categorydoc {
	color: #666;
	font-size: .9em;
	}
	.row {
	border-bottom: 1px solid #f1f2f3;
	display: flex;
	padding: .5em 0;
	white-space: nowrap;
	}
	.date {
	min-width: 6rem;
	}
	.owner {
	min-width: 10rem;
	max-width: 10rem;
	overflow: hidden;
	text-overflow: ellipsis;
	padding-right: 1em;
	}
	.predicates {
	margin-left: 6rem;
	font-size: .9em;
	}
	.highscore {
	color: #fff;
	display: inline-block;
	border-radius: 2px;
	padding: 2px 5px;
	text-decoration: none;
	background-color: #2e7d32;
	}
	.posscore {
	color: #000;
	display: inline-block;
	border-radius: 2px;
	padding: 2px 5px;
	text-decoration: none;
	background-color: #dcedc8;
	}
	.negscore {
	color: #000;
	display: inline-block;
	border-radius: 2px;
	padding: 2px 5px;
	text-decoration: none;
	background-color: #fdaeb7;
	}
	.lowscore {
	color: #fff;
	display: inline-block;
	border-radius: 2px;
	padding: 2px 5px;
	text-decoration: none;
	background-color: #b71c1c;
	}
	.zeroscore {
	color: #000;
	display: inline-block;
	border-radius: 2px;
	padding: 2px 5px;
	text-decoration: none;
	background-color: #e0e0e0;
	}
	.icons,
	.number {
	flex-shrink: 0;
	}
	.icons {
	height: 20px;
	margin-right: 1.5em;
	text-align: right;
	width: 12em;
	}
	.number {
	margin-right: 1.5em;
	text-align: right;
	width: 6ch;
	}
	.subject {
	overflow: hidden;
	text-overflow: ellipsis;
	}
	[hidden] {
	display: none;
	}
	</style>
	<head>
	<title>Open Go Code Reviews</title>
	</head>
	<body>
	<header>
	<strong>Open changes</strong>
	<div class="header-subtitle">
	{{.Doc}}
	</div>
	<div class="header-subtitle">
	<a href="https://go.googlesource.com/oscar/+/master/internal/reviews/display.go">Source code</a>
	</div>
	</header>
	<form id="form" action="{{.Endpoint}}" method="GET">
	<div class="filter">
	<span>
	<label for="filter">Filter</label>
	<input id="filter" type="text" size=75 name="filter" value="{{.Filter}}"/>
	</span>
	</div>
	<div class="header-subtitle">
	Sample filters: "Russ Cox" / Change.Author.Name:"rsc" / Change.Subject:"runtime" / Predicates.Name:hasUnresolvedComments / Change.Created > "2024-01-01"
	</div>
	{{$ctx := .Ctx}}
	{{range $category := .Categories}}
	{{if eq (len .Changes) 0}}{{continue}}{{end}}
	<div class="categoryname">{{.Name}}</div>
	<div class="categorydoc">{{.Doc}}</div>
	{{range $change := .Changes}}
	<div class="row">
	<span class="date">{{.FormattedLastUpdate $ctx}}</span>
	<span class="owner">{{with $author := .Change.Author $ctx}}{{$author.DisplayName $ctx}}{{end}}</span>
	<a class="number" href="https://go.dev/cl/{{.Change.ID $ctx}}" target="_blank">{{.Change.ID $ctx}}</a>
	<span class="subject">{{.Change.Subject $ctx}}</span>
	<span class="predicates">
	{{range $pred := .Predicates}}
	{{if ge .Score 10}}
	<span class="highscore">
	{{else if gt .Score 0}}
	<span class="posscore">
	{{else if le .Score -10}}
	<span class="lowscore">
	{{else if lt .Score 0}}
	<span class="negscore">
	{{else}}
	<span class="zeroscore">
	{{end}}
	{{.Name}}
	</span>
	{{end}}
	</span>
	</div>
	{{end}}
	{{end}}
	<div class="categories">
	<span>
	<label for="categories">Categories</label>
	<textarea id="categories" name="categories" rows="9", cols="80">{{.CategoriesJSON}}</textarea>
	</span>
	</div>
	</form>
	</body>
	</html>
	`