grafana/pkg/plugins/manager/loader/angulardetector/angulardetector.go

package angulardetector

import (
	"bytes"
	"regexp"

	"github.com/grafana/grafana/pkg/plugins"
)

var (
	_ detector = &containsBytesDetector{}
	_ detector = &regexDetector{}
)

// detector implements a check to see if a plugin uses Angular.
type detector interface {
	// Detect takes the content of a moduleJs file and returns true if the plugin is using Angular.
	Detect(moduleJs []byte) bool
}

// containsBytesDetector is a detector that returns true if module.js contains the "pattern" string.
type containsBytesDetector struct {
	pattern []byte
}

// Detect returns true if moduleJs contains the byte slice d.pattern.
func (d *containsBytesDetector) Detect(moduleJs []byte) bool {
	return bytes.Contains(moduleJs, d.pattern)
}

// regexDetector is a detector that returns true if the module.js content matches a regular expression.
type regexDetector struct {
	regex *regexp.Regexp
}

// Detect returns true if moduleJs matches the regular expression d.regex.
func (d *regexDetector) Detect(moduleJs []byte) bool {
	return d.regex.Match(moduleJs)
}

// Inspector can inspect a module.js and determine if it's an Angular plugin or not.
type Inspector interface {
	// Inspect open module.js and checks if the plugin is using Angular by matching against its source code.
	// It returns true if module.js matches against any of the detectors in angularDetectors.
	Inspect(p *plugins.Plugin) (bool, error)
}