Schema: Refactor plugin code generation (#58901)

* wip * wip * almost there.. * wip - change so it can run. * treelist is working. * support CODEGEN_VERIFY env variable * use log.fatal * comment out old PluginTreeList code generation * cleanup * rename corelist package files * fix makefile * move pkg/codegen/pluggen.go to pkg/plugins/codegen * copy and refactor files to pkg/plugins/codegen * use pkg/plugins/codegen instead of pkg/codegen for core plugins code gen * remove unneeded files * remove unused code to resolve linting errors * adapters first hack * added flattener * add back ignore build tags to go generate file * cleaned up the code a bit. * seems to work, needs to do some refactoring of the GoTypesJenns and TSTypesJenny. * one more step, going to get upstream changes in this branch. * working but need to run import tmpl in jenny_schemapath to have the proper imports. * added header to generated files. * added missing jenny. * preventing plugins with multiple decls/schemas to insert multiple lines in corelist. * fixed so we use Slot type from kindsys to detect if its group. * adding a go jenny that only runs if the plugin has a backend. * added version object to generated ts. * generating the ts types with the same output as prior to this refactoring. * removed code that is replaced by the jenny pattern. * removed the go code that isn't used anymore. * removed some more unused code and renamed pluggen to util_ts * fixed linting issue. * removed unused vars. * use a jenny list postprocessor for header injection * moved decl and decl_parser to pfs. * removed the pre-pended header in the gotypes jenny since it is done in the postprocess. * moved decl to pfs. * removed unused template. Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2022-12-02 08:22:28 +01:00
parent 0c560b8b0d
commit 7f92f1df00
28 changed files with 644 additions and 646 deletions
@@ -0,0 +1,100 @@
+package codegen
+
+import (
+	"bytes"
+	"fmt"
+	"path"
+	"path/filepath"
+	"strings"
+
+	"github.com/grafana/codejen"
+	"github.com/grafana/grafana/pkg/plugins/pfs"
+)
+
+const prefix = "github.com/grafana/grafana/public/app/plugins"
+
+// PluginTreeListJenny creates a [codejen.ManyToOne] that produces Go code
+// for loading a [pfs.TreeList] given [*kindsys.PluginDecl] as inputs.
+func PluginTreeListJenny() codejen.ManyToOne[*pfs.PluginDecl] {
+	outputFile := filepath.Join("pkg", "plugins", "pfs", "corelist", "corelist_load_gen.go")
+
+	return &ptlJenny{
+		outputFile: outputFile,
+		plugins:    make(map[string]bool, 0),
+	}
+}
+
+type ptlJenny struct {
+	outputFile string
+	plugins    map[string]bool
+}
+
+func (j *ptlJenny) JennyName() string {
+	return "PluginTreeListJenny"
+}
+
+func (j *ptlJenny) Generate(decls ...*pfs.PluginDecl) (*codejen.File, error) {
+	buf := new(bytes.Buffer)
+	vars := templateVars_plugin_registry{
+		Plugins: make([]struct {
+			PkgName, Path, ImportPath string
+			NoAlias                   bool
+		}, 0, len(decls)),
+	}
+
+	type tpl struct {
+		PkgName, Path, ImportPath string
+		NoAlias                   bool
+	}
+
+	for _, decl := range decls {
+		meta := decl.PluginMeta
+
+		if _, exists := j.plugins[meta.Id]; exists {
+			continue
+		}
+
+		pluginId := j.sanitizePluginId(meta.Id)
+		vars.Plugins = append(vars.Plugins, tpl{
+			PkgName:    pluginId,
+			NoAlias:    pluginId != filepath.Base(decl.PluginPath),
+			ImportPath: filepath.ToSlash(filepath.Join(prefix, decl.PluginPath)),
+			Path:       path.Join(append(strings.Split(prefix, "/")[3:], decl.PluginPath)...),
+		})
+
+		j.plugins[meta.Id] = true
+	}
+
+	if err := tmpls.Lookup("plugin_registry.tmpl").Execute(buf, vars); err != nil {
+		return nil, fmt.Errorf("failed executing plugin registry template: %w", err)
+	}
+
+	byt, err := postprocessGoFile(genGoFile{
+		path: j.outputFile,
+		in:   buf.Bytes(),
+	})
+	if err != nil {
+		return nil, fmt.Errorf("error postprocessing plugin registry: %w", err)
+	}
+
+	return codejen.NewFile(j.outputFile, byt, j), nil
+}
+
+func (j *ptlJenny) sanitizePluginId(s string) string {
+	return strings.Map(func(r rune) rune {
+		switch {
+		case r >= 'a' && r <= 'z':
+			fallthrough
+		case r >= 'A' && r <= 'Z':
+			fallthrough
+		case r >= '0' && r <= '9':
+			fallthrough
+		case r == '_':
+			return r
+		case r == '-':
+			return '_'
+		default:
+			return -1
+		}
+	}, s)
+}