snapshot of https://github.com/livekit/livekit.git @ 08c5433449c106943231037d0b892895f6e92d3b (2026-09-15)

magefile.go

@@ -0,0 +1,221 @@
+// Copyright 2023 LiveKit, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//go:build mage
+// +build mage
+
+package main
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"os"
+	"os/exec"
+	"strings"
+
+	"github.com/magefile/mage/mg"
+
+	"github.com/livekit/livekit-server/version"
+	"github.com/livekit/mageutil"
+	_ "github.com/livekit/psrpc"
+)
+
+const (
+	goChecksumFile = ".checksumgo"
+	imageName      = "livekit/livekit-server"
+)
+
+// Default target to run when none is specified
+// If not set, running mage will list available targets
+var (
+	Default     = Build
+	checksummer = mageutil.NewChecksummer(".", goChecksumFile, ".go", ".mod")
+)
+
+func init() {
+	checksummer.IgnoredPaths = []string{
+		"pkg/service/wire_gen.go",
+		"pkg/rtc/types/typesfakes",
+	}
+}
+
+// downloads module deps at the versions pinned in go.mod
+//
+// Code generators are not installed here: they run as `go run <pkg>` from their
+// //go:generate directives (see pkg/service/wire_gen.go and the counterfeiter
+// directives under pkg/), so they always execute at the version go.mod pins and
+// Renovate keeps them current alongside every other module.
+func Deps() error {
+	return mageutil.Run(context.Background(), "go mod download")
+}
+
+// builds LiveKit server
+func Build() error {
+	mg.Deps(generateWire)
+	if !checksummer.IsChanged() {
+		fmt.Println("up to date")
+		return nil
+	}
+
+	fmt.Println("building...")
+	if err := os.MkdirAll("bin", 0755); err != nil {
+		return err
+	}
+	if err := mageutil.RunDir(context.Background(), "cmd/server", "go build -o ../../bin/livekit-server"); err != nil {
+		return err
+	}
+
+	checksummer.WriteChecksum()
+	return nil
+}
+
+// builds binary that runs on linux
+func BuildLinux() error {
+	mg.Deps(generateWire)
+	if !checksummer.IsChanged() {
+		fmt.Println("up to date")
+		return nil
+	}
+
+	fmt.Println("building...")
+	if err := os.MkdirAll("bin", 0755); err != nil {
+		return err
+	}
+	buildArch := os.Getenv("GOARCH")
+	if len(buildArch) == 0 {
+		buildArch = "amd64"
+	}
+	cmd := mageutil.CommandDir(context.Background(), "cmd/server", "go build -buildvcs=false -o ../../bin/livekit-server-" + buildArch)
+	cmd.Env = []string{
+		"GOOS=linux",
+		"GOARCH=" + buildArch,
+		"HOME=" + os.Getenv("HOME"),
+		"GOPATH=" + os.Getenv("GOPATH"),
+	}
+	if err := cmd.Run(); err != nil {
+		return err
+	}
+
+	checksummer.WriteChecksum()
+	return nil
+}
+
+func Deadlock() error {
+	ctx := context.Background()
+	if err := mageutil.Run(ctx, "go get github.com/sasha-s/go-deadlock"); err != nil {
+		return err
+	}
+	if err := mageutil.Pipe("grep -rl sync.Mutex ./pkg", "xargs sed -i  -e s/sync.Mutex/deadlock.Mutex/g"); err != nil {
+		return err
+	}
+	if err := mageutil.Pipe("grep -rl sync.RWMutex ./pkg", "xargs sed -i  -e s/sync.RWMutex/deadlock.RWMutex/g"); err != nil {
+		return err
+	}
+	if err := mageutil.Pipe("grep -rl deadlock.Mutex\\|deadlock.RWMutex ./pkg", "xargs go tool goimports -w"); err != nil {
+		return err
+	}
+	if err := mageutil.Run(ctx, "go mod tidy"); err != nil {
+		return err
+	}
+	return nil
+}
+
+func Sync() error {
+	if err := mageutil.Pipe("grep -rl deadlock.Mutex ./pkg", "xargs sed -i  -e s/deadlock.Mutex/sync.Mutex/g"); err != nil {
+		return err
+	}
+	if err := mageutil.Pipe("grep -rl deadlock.RWMutex ./pkg", "xargs sed -i  -e s/deadlock.RWMutex/sync.RWMutex/g"); err != nil {
+		return err
+	}
+	if err := mageutil.Pipe("grep -rl sync.Mutex\\|sync.RWMutex ./pkg", "xargs go tool goimports -w"); err != nil {
+		return err
+	}
+	if err := mageutil.Run(context.Background(), "go mod tidy"); err != nil {
+		return err
+	}
+	return nil
+}
+
+// builds and publish snapshot docker image
+func PublishDocker() error {
+	// don't publish snapshot versions as latest or minor version
+	if !strings.Contains(version.Version, "SNAPSHOT") {
+		return errors.New("Cannot publish non-snapshot versions")
+	}
+
+	versionImg := fmt.Sprintf("%s:v%s", imageName, version.Version)
+	cmd := exec.Command("docker", "buildx", "build",
+		"--push", "--platform", "linux/amd64,linux/arm64",
+		"--tag", versionImg,
+		".")
+	mageutil.ConnectStd(cmd)
+	if err := cmd.Run(); err != nil {
+		return err
+	}
+	return nil
+}
+
+// run unit tests, skipping integration
+func Test() error {
+	mg.Deps(generateWire, setULimit)
+	return mageutil.Run(context.Background(), "go test -short ./... -count=1")
+}
+
+// run all tests including integration
+func TestAll() error {
+	mg.Deps(generateWire, setULimit)
+	return mageutil.Run(context.Background(), "go test ./... -count=1 -timeout=4m -v")
+}
+
+// runs the SDK test server (cmd/test-server) in the foreground
+func TestServer() error {
+	return mageutil.Run(context.Background(), "go run ./cmd/test-server")
+}
+
+// runs golangci-lint
+func Lint() error {
+	if _, err := exec.LookPath("golangci-lint"); err != nil {
+		return errors.New("golangci-lint is not installed, install instructions: https://golangci-lint.run/docs/welcome/install/")
+	}
+	return mageutil.Run(context.Background(), "golangci-lint run ./...")
+}
+
+// cleans up builds
+func Clean() {
+	fmt.Println("cleaning...")
+	os.RemoveAll("bin")
+	os.Remove(goChecksumFile)
+}
+
+// regenerate code
+func Generate() error {
+	mg.Deps(generateWire)
+
+	fmt.Println("generating...")
+	return mageutil.Run(context.Background(), "go generate ./...")
+}
+
+// code generation for wiring
+func generateWire() error {
+	if !checksummer.IsChanged() {
+		return nil
+	}
+
+	fmt.Println("wiring...")
+
+	// Matches the //go:generate directive in pkg/service/wire_gen.go, so running
+	// wire here and running `go generate ./...` produce the same output.
+	return mageutil.RunDir(context.Background(), "pkg/service", "go run github.com/google/wire/cmd/wire")
+}