init

2026-01-30 11:49:04 +03:00
commit f8bb05a652
48 changed files with 9538 additions and 0 deletions
@@ -0,0 +1 @@
+bin
@@ -0,0 +1,82 @@
+# Include custome targets and environment variables here
+default: all
+
+# If there's no MM_RUDDER_PLUGINS_PROD, add DEV data
+RUDDER_WRITE_KEY = ""
+ifdef MM_RUDDER_PLUGINS_PROD
+	RUDDER_WRITE_KEY = $(MM_RUDDER_PLUGINS_PROD)
+endif
+
+BUILD_DATE = $(shell date -u)
+BUILD_HASH = $(shell git rev-parse HEAD)
+BUILD_HASH_SHORT = $(shell git rev-parse --short HEAD)
+LDFLAGS += -X "plugin.buildHash=$(BUILD_HASH)"
+LDFLAGS+= -X "plugin.isDebug=$(MM_DEBUG)"
+LDFLAGS += -X "plugin.rudderWriteKey=$(MM_RUDDER_CALLS_PROD)"
+LDFLAGS += -X "plugin.rudderDataplaneURL=$(MM_RUDDER_DATAPLANE_URL)"
+GO_BUILD_FLAGS += -ldflags '$(LDFLAGS)'
+GO_TEST_FLAGS += -ldflags '$(LDFLAGS)'
+
+MM_SERVER_PATH ?= ${PWD}/../mattermost-server
+export MM_SERVER_PATH
+
+## Generates mock golang interfaces for testing
+.PHONY: mock
+mock:
+ifneq ($(HAS_SERVER),)
+	go install github.com/golang/mock/mockgen@v1.6.0
+	mockgen -destination server/mocks/mock_proxy/mock_expand_getter.go git.wilix.dev/loop/loop-plugin-starter-template/server/proxy ExpandGetter
+	mockgen -destination server/mocks/mock_upstream/mock_upstream.go git.wilix.dev/loop/loop-plugin-starter-template/upstream Upstream
+	mockgen -destination server/mocks/mock_store/mock_appstore.go git.wilix.dev/loop/loop-plugin-starter-template/server/store AppStore
+	mockgen -destination server/mocks/mock_store/mock_session.go git.wilix.dev/loop/loop-plugin-starter-template/server/store SessionStore
+endif
+
+## Generates mock golang interfaces for testing
+.PHONY: clean_mock
+clean_mock:
+ifneq ($(HAS_SERVER),)
+	rm -rf ./server/mocks
+endif
+
+## Run Go REST API system tests
+.PHONY: test-rest-api
+test-rest-api: dist
+	@echo Running REST API tests
+ifneq ($(RUN),)
+	PLUGIN_BUNDLE=$(shell pwd)/dist/$(BUNDLE_NAME) $(GO) test -v $(GO_TEST_FLAGS) ./test/restapitest --run $(RUN)
+else
+	PLUGIN_BUNDLE=$(shell pwd)/dist/$(BUNDLE_NAME) $(GO) test -v $(GO_TEST_FLAGS) ./test/restapitest
+endif
+
+
+## Extract new translation messages
+.PHONY: i18n-extract-server
+i18n-extract-server:
+	@goi18n extract -format json -outdir assets/i18n/ server/ utils/ apps/ cmd/ upstream/
+	@for x in assets/i18n/active.*.json; do echo $$x | sed 's/active/translate/' | sed 's/^/touch /' | bash; done
+	@goi18n merge -format json -outdir assets/i18n/ assets/i18n/active.*.json
+	@echo "Please update your assets/i18n/translate.*.json files and execute \"make i18n-merge-server\""
+	@echo "If you don't want to change any locale file, simply remove the assets/i18n/translate.??.json file before calling \"make i18n-merge-server\""
+	@echo "If you want to add a new language (for example french), simply run \"touch assets/i18n/active.fr.json\" and then run the \"make i18n-extract-server\" again"
+
+## Merge translated messages
+.PHONY: i18n-merge-server
+i18n-merge-server:
+	@goi18n merge -format json -outdir assets/i18n/ assets/i18n/active.*.json assets/i18n/translate.*.json
+	@rm -f assets/i18n/translate.*.json
+	@echo "Translations merged, please verify your "git diff" before you submit the changes"
+
+## Run a simple Mattermost Server
+.PHONY: dev_server
+dev_server:
+	cd dev && docker-compose up mattermost db
+
+## Run the hello-world app
+.PHONY: run-example-hello-4000
+run-example-hello-4000:
+	cd test/hello-world && go run .
+
+## Run the test app
+.PHONY: run-test-app-8081
+run-test-app-8081:
+	cd test/app && go run .
@@ -0,0 +1,219 @@
+// Copyright (c) 2023-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/mattermost/mattermost/server/public/model"
+	"github.com/pkg/errors"
+)
+
+const pluginIDGoFileTemplate = `// This file is automatically generated. Do not modify it manually.
+
+package main
+
+import (
+	"encoding/json"
+	"strings"
+
+	"github.com/mattermost/mattermost/server/public/model"
+)
+
+var manifest *model.Manifest
+
+const manifestStr = ` + "`" + `
+%s
+` + "`" + `
+
+func init() {
+	_ = json.NewDecoder(strings.NewReader(manifestStr)).Decode(&manifest)
+}
+`
+
+const pluginIDJSFileTemplate = `// This file is automatically generated. Do not modify it manually.
+
+const manifest = JSON.parse(` + "`" + `
+%s
+` + "`" + `);
+
+export default manifest;
+`
+
+// These build-time vars are read from shell commands and populated in ../setup.mk
+var (
+	BuildHashShort  string
+	BuildTagLatest  string
+	BuildTagCurrent string
+)
+
+func main() {
+	if len(os.Args) <= 1 {
+		panic("no cmd specified")
+	}
+
+	manifest, err := findManifest()
+	if err != nil {
+		panic("failed to find manifest: " + err.Error())
+	}
+
+	cmd := os.Args[1]
+	switch cmd {
+	case "id":
+		dumpPluginID(manifest)
+
+	case "version":
+		dumpPluginVersion(manifest)
+
+	case "has_server":
+		if manifest.HasServer() {
+			fmt.Printf("true")
+		}
+
+	case "has_webapp":
+		if manifest.HasWebapp() {
+			fmt.Printf("true")
+		}
+
+	case "apply":
+		if err := applyManifest(manifest); err != nil {
+			panic("failed to apply manifest: " + err.Error())
+		}
+
+	case "dist":
+		if err := distManifest(manifest); err != nil {
+			panic("failed to write manifest to dist directory: " + err.Error())
+		}
+
+	case "check":
+		if err := manifest.IsValid(); err != nil {
+			panic("failed to check manifest: " + err.Error())
+		}
+
+	default:
+		panic("unrecognized command: " + cmd)
+	}
+}
+
+func findManifest() (*model.Manifest, error) {
+	_, manifestFilePath, err := model.FindManifest(".")
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to find manifest in current working directory")
+	}
+	manifestFile, err := os.Open(manifestFilePath)
+	if err != nil {
+		return nil, errors.Wrapf(err, "failed to open %s", manifestFilePath)
+	}
+	defer manifestFile.Close()
+
+	// Re-decode the manifest, disallowing unknown fields. When we write the manifest back out,
+	// we don't want to accidentally clobber anything we won't preserve.
+	var manifest model.Manifest
+	decoder := json.NewDecoder(manifestFile)
+	decoder.DisallowUnknownFields()
+	if err = decoder.Decode(&manifest); err != nil {
+		return nil, errors.Wrap(err, "failed to parse manifest")
+	}
+
+	// If no version is listed in the manifest, generate one based on the state of the current
+	// commit, and use the first version we find (to prevent causing errors)
+	if manifest.Version == "" {
+		var version string
+		tags := strings.Fields(BuildTagCurrent)
+		for _, t := range tags {
+			if strings.HasPrefix(t, "v") {
+				version = t
+				break
+			}
+		}
+		if version == "" {
+			if BuildTagLatest != "" {
+				version = BuildTagLatest + "+" + BuildHashShort
+			} else {
+				version = "v0.0.0+" + BuildHashShort
+			}
+		}
+		manifest.Version = strings.TrimPrefix(version, "v")
+	}
+
+	// If no release notes specified, generate one from the latest tag, if present.
+	if manifest.ReleaseNotesURL == "" && BuildTagLatest != "" {
+		manifest.ReleaseNotesURL = manifest.HomepageURL + "releases/tag/" + BuildTagLatest
+	}
+
+	return &manifest, nil
+}
+
+// dumpPluginId writes the plugin id from the given manifest to standard out
+func dumpPluginID(manifest *model.Manifest) {
+	fmt.Printf("%s", manifest.Id)
+}
+
+// dumpPluginVersion writes the plugin version from the given manifest to standard out
+func dumpPluginVersion(manifest *model.Manifest) {
+	fmt.Printf("%s", manifest.Version)
+}
+
+// applyManifest propagates the plugin_id into the server and webapp folders, as necessary
+func applyManifest(manifest *model.Manifest) error {
+	if manifest.HasServer() {
+		// generate JSON representation of Manifest.
+		manifestBytes, err := json.MarshalIndent(manifest, "", "  ")
+		if err != nil {
+			return err
+		}
+		manifestStr := string(manifestBytes)
+
+		// write generated code to file by using Go file template.
+		if err := os.WriteFile(
+			"server/manifest.go",
+			[]byte(fmt.Sprintf(pluginIDGoFileTemplate, manifestStr)),
+			0600,
+		); err != nil {
+			return errors.Wrap(err, "failed to write server/manifest.go")
+		}
+	}
+
+	if manifest.HasWebapp() {
+		// generate JSON representation of Manifest.
+		// JSON is very similar and compatible with JS's object literals. so, what we do here
+		// is actually JS code generation.
+		manifestBytes, err := json.MarshalIndent(manifest, "", "    ")
+		if err != nil {
+			return err
+		}
+		manifestStr := string(manifestBytes)
+
+		// Escape newlines
+		manifestStr = strings.ReplaceAll(manifestStr, `\n`, `\\n`)
+
+		// write generated code to file by using JS file template.
+		if err := os.WriteFile(
+			"webapp/src/manifest.ts",
+			[]byte(fmt.Sprintf(pluginIDJSFileTemplate, manifestStr)),
+			0600,
+		); err != nil {
+			return errors.Wrap(err, "failed to open webapp/src/manifest.ts")
+		}
+	}
+
+	return nil
+}
+
+// distManifest writes the manifest file to the dist directory
+func distManifest(manifest *model.Manifest) error {
+	manifestBytes, err := json.MarshalIndent(manifest, "", "    ")
+	if err != nil {
+		return err
+	}
+
+	if err := os.WriteFile(fmt.Sprintf("dist/%s/plugin.json", manifest.Id), manifestBytes, 0600); err != nil {
+		return errors.Wrap(err, "failed to write plugin.json")
+	}
+
+	return nil
+}
@@ -0,0 +1,180 @@
+// main handles deployment of the plugin to a development server using the Client4 API.
+package main
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"log"
+	"net"
+	"os"
+	"time"
+
+	"github.com/mattermost/mattermost/server/public/model"
+)
+
+const commandTimeout = 120 * time.Second
+
+const helpText = `
+Usage:
+    pluginctl deploy <plugin id> <bundle path>
+    pluginctl disable <plugin id>
+    pluginctl enable <plugin id>
+    pluginctl reset <plugin id>
+`
+
+func main() {
+	err := pluginctl()
+	if err != nil {
+		fmt.Printf("Failed: %s\n", err.Error())
+		fmt.Print(helpText)
+		os.Exit(1)
+	}
+}
+
+func pluginctl() error {
+	if len(os.Args) < 3 {
+		return errors.New("invalid number of arguments")
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), commandTimeout)
+	defer cancel()
+
+	client, err := getClient(ctx)
+	if err != nil {
+		return err
+	}
+
+	switch os.Args[1] {
+	case "deploy":
+		if len(os.Args) < 4 {
+			return errors.New("invalid number of arguments")
+		}
+		return deploy(ctx, client, os.Args[2], os.Args[3])
+	case "disable":
+		return disablePlugin(ctx, client, os.Args[2])
+	case "enable":
+		return enablePlugin(ctx, client, os.Args[2])
+	case "reset":
+		return resetPlugin(ctx, client, os.Args[2])
+	default:
+		return errors.New("invalid second argument")
+	}
+}
+
+func getClient(ctx context.Context) (*model.Client4, error) {
+	socketPath := os.Getenv("MM_LOCALSOCKETPATH")
+	if socketPath == "" {
+		socketPath = model.LocalModeSocketPath
+	}
+
+	client, connected := getUnixClient(socketPath)
+	if connected {
+		log.Printf("Connecting using local mode over %s", socketPath)
+		return client, nil
+	}
+
+	if os.Getenv("MM_LOCALSOCKETPATH") != "" {
+		log.Printf("No socket found at %s for local mode deployment. Attempting to authenticate with credentials.", socketPath)
+	}
+
+	siteURL := os.Getenv("MM_SERVICESETTINGS_SITEURL")
+	adminToken := os.Getenv("MM_ADMIN_TOKEN")
+	adminUsername := os.Getenv("MM_ADMIN_USERNAME")
+	adminPassword := os.Getenv("MM_ADMIN_PASSWORD")
+
+	if siteURL == "" {
+		return nil, errors.New("MM_SERVICESETTINGS_SITEURL is not set")
+	}
+
+	client = model.NewAPIv4Client(siteURL)
+
+	if adminToken != "" {
+		log.Printf("Authenticating using token against %s.", siteURL)
+		client.SetToken(adminToken)
+		return client, nil
+	}
+
+	if adminUsername != "" && adminPassword != "" {
+		client := model.NewAPIv4Client(siteURL)
+		log.Printf("Authenticating as %s against %s.", adminUsername, siteURL)
+		_, _, err := client.Login(ctx, adminUsername, adminPassword)
+		if err != nil {
+			return nil, fmt.Errorf("failed to login as %s: %w", adminUsername, err)
+		}
+
+		return client, nil
+	}
+
+	return nil, errors.New("one of MM_ADMIN_TOKEN or MM_ADMIN_USERNAME/MM_ADMIN_PASSWORD must be defined")
+}
+
+func getUnixClient(socketPath string) (*model.Client4, bool) {
+	_, err := net.Dial("unix", socketPath)
+	if err != nil {
+		return nil, false
+	}
+
+	return model.NewAPIv4SocketClient(socketPath), true
+}
+
+// deploy attempts to upload and enable a plugin via the Client4 API.
+// It will fail if plugin uploads are disabled.
+func deploy(ctx context.Context, client *model.Client4, pluginID, bundlePath string) error {
+	pluginBundle, err := os.Open(bundlePath)
+	if err != nil {
+		return fmt.Errorf("failed to open %s: %w", bundlePath, err)
+	}
+	defer pluginBundle.Close()
+
+	log.Print("Uploading plugin via API.")
+	_, _, err = client.UploadPluginForced(ctx, pluginBundle)
+	if err != nil {
+		return fmt.Errorf("failed to upload plugin bundle: %s", err.Error())
+	}
+
+	log.Print("Enabling plugin.")
+	_, err = client.EnablePlugin(ctx, pluginID)
+	if err != nil {
+		return fmt.Errorf("failed to enable plugin: %s", err.Error())
+	}
+
+	return nil
+}
+
+// disablePlugin attempts to disable the plugin via the Client4 API.
+func disablePlugin(ctx context.Context, client *model.Client4, pluginID string) error {
+	log.Print("Disabling plugin.")
+	_, err := client.DisablePlugin(ctx, pluginID)
+	if err != nil {
+		return fmt.Errorf("failed to disable plugin: %w", err)
+	}
+
+	return nil
+}
+
+// enablePlugin attempts to enable the plugin via the Client4 API.
+func enablePlugin(ctx context.Context, client *model.Client4, pluginID string) error {
+	log.Print("Enabling plugin.")
+	_, err := client.EnablePlugin(ctx, pluginID)
+	if err != nil {
+		return fmt.Errorf("failed to enable plugin: %w", err)
+	}
+
+	return nil
+}
+
+// resetPlugin attempts to reset the plugin via the Client4 API.
+func resetPlugin(ctx context.Context, client *model.Client4, pluginID string) error {
+	err := disablePlugin(ctx, client, pluginID)
+	if err != nil {
+		return err
+	}
+
+	err = enablePlugin(ctx, client, pluginID)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
@@ -0,0 +1,45 @@
+# Ensure that go is installed. Note that this is independent of whether or not a server is being
+# built, since the build script itself uses go.
+ifeq ($(GO),)
+    $(error "go is not available: see https://golang.org/doc/install")
+endif
+
+# Ensure that the build tools are compiled. Go's caching makes this quick.
+$(shell cd build/manifest && $(GO) build -o ../bin/manifest)
+
+# Ensure that the deployment tools are compiled. Go's caching makes this quick.
+$(shell cd build/pluginctl && $(GO) build -o ../bin/pluginctl)
+
+# Extract the plugin id from the manifest.
+PLUGIN_ID ?= $(shell build/bin/manifest id)
+ifeq ($(PLUGIN_ID),)
+    $(error "Cannot parse id from $(MANIFEST_FILE)")
+endif
+
+# Extract the plugin version from the manifest.
+PLUGIN_VERSION ?= $(shell build/bin/manifest version)
+ifeq ($(PLUGIN_VERSION),)
+    $(error "Cannot parse version from $(MANIFEST_FILE)")
+endif
+
+# Determine if a server is defined in the manifest.
+HAS_SERVER ?= $(shell build/bin/manifest has_server)
+
+# Determine if a webapp is defined in the manifest.
+HAS_WEBAPP ?= $(shell build/bin/manifest has_webapp)
+
+# Determine if a /public folder is in use
+HAS_PUBLIC ?= $(wildcard public/.)
+
+# Determine if the mattermost-utilities repo is present
+HAS_MM_UTILITIES ?= $(wildcard $(MM_UTILITIES_DIR)/.)
+
+# Store the current path for later use
+PWD ?= $(shell pwd)
+
+# Ensure that npm (and thus node) is installed.
+ifneq ($(HAS_WEBAPP),)
+ifeq ($(NPM),)
+    $(error "npm is not available: see https://www.npmjs.com/get-npm")
+endif
+endif