highlight.go

package graphqlbackend

import (
	"context"
	"html/template"

	"github.com/gogo/protobuf/jsonpb"

	"github.com/sourcegraph/sourcegraph/cmd/frontend/internal/highlight"
	"github.com/sourcegraph/sourcegraph/internal/gosyntect"
	"github.com/sourcegraph/sourcegraph/internal/search/result"
)

type highlightedRangeResolver struct {
	inner result.HighlightedRange
}

func (h highlightedRangeResolver) Line() int32      { return h.inner.Line }
func (h highlightedRangeResolver) Character() int32 { return h.inner.Character }
func (h highlightedRangeResolver) Length() int32    { return h.inner.Length }

type highlightedStringResolver struct {
	inner result.HighlightedString
}

func (s *highlightedStringResolver) Value() string { return s.inner.Value }
func (s *highlightedStringResolver) Highlights() []highlightedRangeResolver {
	res := make([]highlightedRangeResolver, len(s.inner.Highlights))
	for i, hl := range s.inner.Highlights {
		res[i] = highlightedRangeResolver{hl}
	}
	return res
}

type HighlightArgs struct {
	DisableTimeout     bool
	IsLightTheme       *bool
	HighlightLongLines bool
	Format             string
}

type highlightedFileResolver struct {
	aborted  bool
	response *highlight.HighlightedCode
}

func (h *highlightedFileResolver) Aborted() bool { return h.aborted }
func (h *highlightedFileResolver) HTML() string {
	html, err := h.response.HTML()
	if err != nil {
		return ""
	}

	return string(html)
}
func (h *highlightedFileResolver) LSIF() string {
	if h.response == nil {
		return "{}"
	}

	marshaller := &jsonpb.Marshaler{
		EnumsAsInts:  true,
		EmitDefaults: false,
	}

	// TODO(tjdevries): We could probably serialize the error, but it wouldn't do anything for now.
	lsif, err := marshaller.MarshalToString(h.response.LSIF())
	if err != nil {
		return "{}"
	}

	return lsif
}
func (h *highlightedFileResolver) LineRanges(args *struct{ Ranges []highlight.LineRange }) ([][]string, error) {
	if h.response != nil && h.response.LSIF() != nil {
		return h.response.LinesForRanges(args.Ranges)
	}

	return highlight.SplitLineRanges(template.HTML(h.HTML()), args.Ranges)
}

func highlightContent(ctx context.Context, args *HighlightArgs, content, path string, metadata highlight.Metadata) (*highlightedFileResolver, error) {
	var (
		result          = &highlightedFileResolver{}
		err             error
		simulateTimeout = metadata.RepoName == "github.com/sourcegraph/AlwaysHighlightTimeoutTest"
	)

	response, aborted, err := highlight.Code(ctx, highlight.Params{
		Content:            []byte(content),
		Filepath:           path,
		DisableTimeout:     args.DisableTimeout,
		HighlightLongLines: args.HighlightLongLines,
		SimulateTimeout:    simulateTimeout,
		Metadata:           metadata,
		Format:             gosyntect.GetResponseFormat(args.Format),
	})

	result.aborted = aborted
	result.response = response

	if err != nil {
		return nil, err
	}

	return result, nil
}