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

pkg/clientconfiguration/conf.go

@@ -0,0 +1,64 @@
+// 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.
+
+package clientconfiguration
+
+import (
+	"github.com/livekit/protocol/codecs/mime"
+	"github.com/livekit/protocol/livekit"
+	"github.com/livekit/protocol/utils/must"
+)
+
+// StaticConfigurations list specific device-side limitations that should be disabled at a global level
+var StaticConfigurations = []ConfigurationItem{
+	// {
+	// 	Match:         must.Get(NewScriptMatch(`c.protocol <= 5 || c.browser == "firefox"`)),
+	// 	Configuration: &livekit.ClientConfiguration{ResumeConnection: livekit.ClientConfigSetting_DISABLED},
+	// 	Merge:         false,
+	// },
+	{
+		Match: must.Get(NewScriptMatch(`c.browser == "safari"`)),
+		Configuration: &livekit.ClientConfiguration{
+			DisabledCodecs: &livekit.DisabledCodecs{
+				Codecs: []*livekit.Codec{
+					{Mime: mime.MimeTypeAV1.String()},
+				},
+			},
+		},
+		Merge: true,
+	},
+	{
+		Match: must.Get(NewScriptMatch(`c.browser == "safari" && c.browser_version > "18.3"`)),
+		Configuration: &livekit.ClientConfiguration{
+			DisabledCodecs: &livekit.DisabledCodecs{
+				Publish: []*livekit.Codec{
+					{Mime: mime.MimeTypeVP9.String()},
+				},
+			},
+		},
+		Merge: true,
+	},
+	{
+		Match: must.Get(NewScriptMatch(`(c.device_model == "xiaomi 2201117ti" && c.os == "android") ||
+		  ((c.browser == "firefox" || c.browser == "firefox mobile") && (c.os == "linux" || c.os == "android"))`)),
+		Configuration: &livekit.ClientConfiguration{
+			DisabledCodecs: &livekit.DisabledCodecs{
+				Publish: []*livekit.Codec{
+					{Mime: mime.MimeTypeH264.String()},
+				},
+			},
+		},
+		Merge: false,
+	},
+}

pkg/clientconfiguration/conf_test.go

@@ -0,0 +1,134 @@
+// 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.
+
+package clientconfiguration
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/livekit/protocol/livekit"
+	"github.com/livekit/protocol/utils/must"
+)
+
+func TestScriptMatchConfiguration(t *testing.T) {
+	t.Run("no merge", func(t *testing.T) {
+		confs := []ConfigurationItem{
+			{
+				Match: must.Get(NewScriptMatch(`c.protocol > 5 && c.browser != "firefox"`)),
+				Configuration: &livekit.ClientConfiguration{
+					ResumeConnection: livekit.ClientConfigSetting_ENABLED,
+				},
+			},
+		}
+
+		cm := NewStaticClientConfigurationManager(confs)
+
+		conf := cm.GetConfiguration(&livekit.ClientInfo{Protocol: 4})
+		require.Nil(t, conf)
+
+		conf = cm.GetConfiguration(&livekit.ClientInfo{Protocol: 6, Browser: "firefox"})
+		require.Nil(t, conf)
+
+		conf = cm.GetConfiguration(&livekit.ClientInfo{Protocol: 6, Browser: "chrome"})
+		require.Equal(t, conf.ResumeConnection, livekit.ClientConfigSetting_ENABLED)
+	})
+
+	t.Run("merge", func(t *testing.T) {
+		confs := []ConfigurationItem{
+			{
+				Match: must.Get(NewScriptMatch(`c.protocol > 5 && c.browser != "firefox"`)),
+				Configuration: &livekit.ClientConfiguration{
+					ResumeConnection: livekit.ClientConfigSetting_ENABLED,
+				},
+				Merge: true,
+			},
+			{
+				Match: must.Get(NewScriptMatch(`c.sdk == "android"`)),
+				Configuration: &livekit.ClientConfiguration{
+					Video: &livekit.VideoConfiguration{
+						HardwareEncoder: livekit.ClientConfigSetting_DISABLED,
+					},
+				},
+				Merge: true,
+			},
+		}
+
+		cm := NewStaticClientConfigurationManager(confs)
+
+		conf := cm.GetConfiguration(&livekit.ClientInfo{Protocol: 4})
+		require.Nil(t, conf)
+
+		conf = cm.GetConfiguration(&livekit.ClientInfo{Protocol: 6, Browser: "firefox"})
+		require.Nil(t, conf)
+
+		conf = cm.GetConfiguration(&livekit.ClientInfo{Protocol: 6, Browser: "chrome", Sdk: 3})
+		require.Equal(t, conf.ResumeConnection, livekit.ClientConfigSetting_ENABLED)
+		require.Equal(t, conf.Video.HardwareEncoder, livekit.ClientConfigSetting_DISABLED)
+	})
+}
+
+func TestScriptMatch(t *testing.T) {
+	client := &livekit.ClientInfo{
+		Protocol:       6,
+		Browser:        "chrome",
+		Sdk:            3, // android
+		DeviceModel:    "12345",
+		BrowserVersion: "13.2",
+		Version:        "2.17.1",
+	}
+
+	type testcase struct {
+		name   string
+		expr   string
+		result bool
+		err    bool
+	}
+
+	cases := []testcase{
+		{name: "simple match", expr: `c.protocol > 5`, result: true},
+		{name: "invalid expr", expr: `cc.protocol > 5`, err: true},
+		{name: "unexist field", expr: `c.protocols > 5`, err: true},
+		{name: "combined condition", expr: `c.protocol > 5 && (c.sdk=="android" || c.sdk=="ios")`, result: true},
+		{name: "combined condition2", expr: `(c.device_model == "xiaomi 2201117ti" && c.os == "android") || ((c.browser == "firefox" || c.browser == "firefox mobile") && (c.os == "linux" || c.os == "android"))`, result: false},
+		{name: "string lesser", expr: `c.browser_version < "11.3"`, result: false},
+		{name: "string lesser eq", expr: `c.browser_version <= "13.2"`, result: true},
+		{name: "string greater", expr: `c.browser_version > "11.3"`, result: true},
+		{name: "string greater eq", expr: `c.browser_version >= "13.2"`, result: true},
+		{name: "semantic lesser", expr: `c.version < "2.16.10"`, result: false},
+		{name: "semantic lesser eq", expr: `c.version <= "2.17.1"`, result: true},
+		{name: "semantic greater", expr: `c.version > "2.16.10"`, result: true},
+		{name: "semantic greater eq", expr: `c.version >= "2.17.1"`, result: true},
+	}
+
+	for _, c := range cases {
+		t.Run(c.name, func(t *testing.T) {
+			match, err := NewScriptMatch(c.expr)
+			if err != nil {
+				if !c.err {
+					require.NoError(t, err)
+				}
+				return
+			}
+			m, err := match.Match(client)
+			if c.err {
+				require.Error(t, err)
+			} else {
+				require.Equal(t, c.result, m)
+			}
+		})
+
+	}
+}

pkg/clientconfiguration/match.go

@@ -0,0 +1,177 @@
+// 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.
+
+package clientconfiguration
+
+import (
+	"errors"
+	"fmt"
+	"strings"
+
+	"github.com/d5/tengo/v2"
+	"github.com/d5/tengo/v2/token"
+	"golang.org/x/mod/semver"
+
+	"github.com/livekit/protocol/livekit"
+)
+
+type Match interface {
+	Match(clientInfo *livekit.ClientInfo) (bool, error)
+}
+
+type ScriptMatch struct {
+	compiled *tengo.Compiled
+}
+
+func NewScriptMatch(expr string) (*ScriptMatch, error) {
+	script := tengo.NewScript(fmt.Appendf(nil, "__res__ := (%s)", expr))
+	if err := script.Add("c", &clientObject{}); err != nil {
+		return nil, err
+	}
+	compiled, err := script.Compile()
+	if err != nil {
+		return nil, err
+	}
+	return &ScriptMatch{compiled}, nil
+}
+
+// use result of eval script expression for match.
+// expression examples:
+// protocol bigger than 5 : c.protocol > 5
+// browser if firefox: c.browser == "firefox"
+// combined rule : c.protocol > 5 && c.browser == "firefox"
+func (m *ScriptMatch) Match(clientInfo *livekit.ClientInfo) (bool, error) {
+	clone := m.compiled.Clone()
+	if err := clone.Set("c", &clientObject{info: clientInfo}); err != nil {
+		return false, err
+	}
+	if err := clone.Run(); err != nil {
+		return false, err
+	}
+
+	res := clone.Get("__res__").Value()
+	if val, ok := res.(bool); ok {
+		return val, nil
+	}
+	return false, errors.New("invalid match expression result")
+}
+
+// ------------------------------------------------
+
+type clientObject struct {
+	tengo.ObjectImpl
+	info *livekit.ClientInfo
+}
+
+func (c *clientObject) TypeName() string {
+	return "clientObject"
+}
+
+func (c *clientObject) String() string {
+	return c.info.String()
+}
+
+func (c *clientObject) IndexGet(index tengo.Object) (res tengo.Object, err error) {
+	field, ok := index.(*tengo.String)
+	if !ok {
+		return nil, tengo.ErrInvalidIndexType
+	}
+
+	switch field.Value {
+	case "sdk":
+		return &tengo.String{Value: strings.ToLower(c.info.Sdk.String())}, nil
+	case "version":
+		return &ruleSdkVersion{sdkVersion: c.info.Version}, nil
+	case "protocol":
+		return &tengo.Int{Value: int64(c.info.Protocol)}, nil
+	case "os":
+		return &tengo.String{Value: strings.ToLower(c.info.Os)}, nil
+	case "os_version":
+		return &tengo.String{Value: c.info.OsVersion}, nil
+	case "device_model":
+		return &tengo.String{Value: strings.ToLower(c.info.DeviceModel)}, nil
+	case "browser":
+		return &tengo.String{Value: strings.ToLower(c.info.Browser)}, nil
+	case "browser_version":
+		return &ruleSdkVersion{sdkVersion: c.info.BrowserVersion}, nil
+	case "address":
+		return &tengo.String{Value: c.info.Address}, nil
+	}
+	return &tengo.Undefined{}, nil
+}
+
+// ------------------------------------------
+
+type ruleSdkVersion struct {
+	tengo.ObjectImpl
+	sdkVersion string
+}
+
+func (r *ruleSdkVersion) TypeName() string {
+	return "sdkVersion"
+}
+
+func (r *ruleSdkVersion) String() string {
+	return r.sdkVersion
+}
+
+func (r *ruleSdkVersion) BinaryOp(op token.Token, rhs tengo.Object) (tengo.Object, error) {
+	if rhs, ok := rhs.(*tengo.String); ok {
+		cmp := r.compare(rhs.Value)
+
+		isMatch := false
+		switch op {
+		case token.Greater:
+			isMatch = cmp > 0
+		case token.GreaterEq:
+			isMatch = cmp >= 0
+		case token.Less:
+			isMatch = cmp < 0
+		case token.LessEq:
+			isMatch = cmp <= 0
+		default:
+			return nil, tengo.ErrInvalidOperator
+		}
+
+		if isMatch {
+			return tengo.TrueValue, nil
+		}
+		return tengo.FalseValue, nil
+	}
+
+	return nil, tengo.ErrInvalidOperator
+}
+
+func (r *ruleSdkVersion) Equals(rhs tengo.Object) bool {
+	if rhs, ok := rhs.(*tengo.String); ok {
+		return r.compare(rhs.Value) == 0
+	}
+
+	return false
+}
+
+func (r *ruleSdkVersion) compare(rhsSdkVersion string) int {
+	if !semver.IsValid("v"+r.sdkVersion) || !semver.IsValid("v"+rhsSdkVersion) {
+		// if not valid semver, do string compare
+		switch {
+		case r.sdkVersion < rhsSdkVersion:
+			return -1
+		case r.sdkVersion > rhsSdkVersion:
+			return 1
+		}
+	} else {
+		return semver.Compare("v"+r.sdkVersion, "v"+rhsSdkVersion)
+	}
+	return 0
+}

pkg/clientconfiguration/staticconfiguration.go

@@ -0,0 +1,71 @@
+// 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.
+
+package clientconfiguration
+
+import (
+	"google.golang.org/protobuf/proto"
+
+	"github.com/livekit/livekit-server/pkg/utils"
+	"github.com/livekit/protocol/livekit"
+	"github.com/livekit/protocol/logger"
+	protoutils "github.com/livekit/protocol/utils"
+)
+
+type ConfigurationItem struct {
+	Match
+	Configuration *livekit.ClientConfiguration
+	Merge         bool
+}
+
+type StaticClientConfigurationManager struct {
+	confs []ConfigurationItem
+}
+
+func NewStaticClientConfigurationManager(confs []ConfigurationItem) *StaticClientConfigurationManager {
+	return &StaticClientConfigurationManager{confs: confs}
+}
+
+func (s *StaticClientConfigurationManager) GetConfiguration(clientInfo *livekit.ClientInfo) *livekit.ClientConfiguration {
+	var matchedConf []*livekit.ClientConfiguration
+	for _, c := range s.confs {
+		matched, err := c.Match.Match(clientInfo)
+		if err != nil {
+			logger.Errorw("matchrule failed", err,
+				"clientInfo", logger.Proto(utils.ClientInfoWithoutAddress(clientInfo)),
+			)
+			continue
+		}
+		if !matched {
+			continue
+		}
+		if !c.Merge {
+			return c.Configuration
+		}
+		matchedConf = append(matchedConf, c.Configuration)
+	}
+
+	var conf *livekit.ClientConfiguration
+	for k, v := range matchedConf {
+		if k == 0 {
+			conf = protoutils.CloneProto(matchedConf[0])
+		} else {
+			// TODO : there is a problem use protobuf merge, we don't have flag to indicate 'no value',
+			// don't override default behavior or other configuration's field. So a bool value = false or
+			// a int value = 0 will override same field in other configuration
+			proto.Merge(conf, v)
+		}
+	}
+	return conf
+}

pkg/clientconfiguration/types.go

@@ -0,0 +1,23 @@
+// 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.
+
+package clientconfiguration
+
+import (
+	"github.com/livekit/protocol/livekit"
+)
+
+type ClientConfigurationManager interface {
+	GetConfiguration(clientInfo *livekit.ClientInfo) *livekit.ClientConfiguration
+}