Files
upstream-mattermost/server/channels/app/user_agent_test.go
upstream-mirror 240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)
2026-09-16 00:29:55 +05:00

418 lines
16 KiB
Go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
package app
import (
"testing"
"github.com/avct/uasurfer"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/mattermost/mattermost/server/public/model"
)
type testUserAgent struct {
Name string
UserAgent string
ExpectedPlatformName string
ExpectedOSName string
ExpectedBrowserName string
ExpectedBrowserVersion string
}
var testUserAgents = []testUserAgent{
{
Name: "Mozilla 40.1",
UserAgent: "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:40.0) Gecko/20100101 Firefox/40.1",
ExpectedPlatformName: "Windows",
ExpectedOSName: "Windows 7",
ExpectedBrowserName: "Firefox",
ExpectedBrowserVersion: "40.1",
},
{
Name: "Chrome 60",
UserAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.90 Safari/537.36",
ExpectedPlatformName: "Macintosh",
ExpectedOSName: "Mac OS",
ExpectedBrowserName: "Chrome",
ExpectedBrowserVersion: "60.0.3112",
},
{
Name: "Chrome Mobile",
UserAgent: "Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.113 Mobile Safari/537.36",
ExpectedPlatformName: "Android",
ExpectedOSName: "Android",
ExpectedBrowserName: "Chrome",
ExpectedBrowserVersion: "60.0.3112",
},
{
Name: "MM Classic App",
UserAgent: "Mozilla/5.0 (Linux; Android 8.0.0; Nexus 5X Build/OPR6.170623.013; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/61.0.3163.81 Mobile Safari/537.36 Web-Atoms-Mobile-WebView",
ExpectedPlatformName: "Android",
ExpectedOSName: "Android",
ExpectedBrowserName: "Chrome",
ExpectedBrowserVersion: "61.0.3163",
},
{
Name: "mmctl",
UserAgent: "mmctl/5.20.0 (linux)",
ExpectedPlatformName: "Linux",
ExpectedOSName: "Linux",
ExpectedBrowserName: "mmctl",
ExpectedBrowserVersion: "5.20.0",
},
{
Name: "MM App 3.7.1",
UserAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Mattermost/3.7.1 Chrome/56.0.2924.87 Electron/1.6.11 Safari/537.36",
ExpectedPlatformName: "Macintosh",
ExpectedOSName: "Mac OS",
ExpectedBrowserName: "Desktop App",
ExpectedBrowserVersion: "3.7.1",
},
{
Name: "Franz 4.0.4",
UserAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Franz/4.0.4 Chrome/52.0.2743.82 Electron/1.3.1 Safari/537.36",
ExpectedPlatformName: "Macintosh",
ExpectedOSName: "Mac OS",
ExpectedBrowserName: "Desktop App",
ExpectedBrowserVersion: "4.0.4",
},
{
Name: "Edge 14",
UserAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.79 Safari/537.36 Edge/14.14393",
ExpectedPlatformName: "Windows",
ExpectedOSName: "Windows 10",
ExpectedBrowserName: "Edge",
ExpectedBrowserVersion: "14.14393",
},
{
Name: "Internet Explorer 9",
UserAgent: "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 7.1; Trident/5.0",
ExpectedPlatformName: "Windows",
ExpectedOSName: "Windows",
ExpectedBrowserName: "Internet Explorer",
ExpectedBrowserVersion: "9.0",
},
{
Name: "Internet Explorer 11",
UserAgent: "Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; rv:11.0) like Gecko",
ExpectedPlatformName: "Windows",
ExpectedOSName: "Windows 10",
ExpectedBrowserName: "Internet Explorer",
ExpectedBrowserVersion: "11.0",
},
{
Name: "Internet Explorer 11 2",
UserAgent: "Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; .NET4.0C; .NET4.0E; .NET CLR 2.0.50727; .NET CLR 3.0.30729; .NET CLR 3.5.30729; Zoom 3.6.0; rv:11.0) like Gecko",
ExpectedPlatformName: "Windows",
ExpectedOSName: "Windows 10",
ExpectedBrowserName: "Internet Explorer",
ExpectedBrowserVersion: "11.0",
},
{
Name: "Internet Explorer 11 (Compatibility Mode) 1",
UserAgent: "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 10.0; WOW64; Trident/7.0; .NET4.0C; .NET4.0E; .NET CLR 2.0.50727; .NET CLR 3.0.30729; .NET CLR 3.5.30729; .NET CLR 1.1.4322; InfoPath.3; Zoom 3.6.0)",
ExpectedPlatformName: "Windows",
ExpectedOSName: "Windows 10",
ExpectedBrowserName: "Internet Explorer",
ExpectedBrowserVersion: "7.0",
},
{
Name: "Internet Explorer 11 (Compatibility Mode) 2",
UserAgent: "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 10.0; WOW64; Trident/7.0; .NET4.0C; .NET4.0E; .NET CLR 2.0.50727; .NET CLR 3.0.30729; .NET CLR 3.5.30729; Zoom 3.6.0)",
ExpectedPlatformName: "Windows",
ExpectedOSName: "Windows 10",
ExpectedBrowserName: "Internet Explorer",
ExpectedBrowserVersion: "7.0",
},
{
Name: "Safari 9",
UserAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/604.1.38 (KHTML, like Gecko) Version/11.0 Safari/604.1.38",
ExpectedPlatformName: "Macintosh",
ExpectedOSName: "Mac OS",
ExpectedBrowserName: "Safari",
ExpectedBrowserVersion: "11.0",
},
{
Name: "Safari 8",
UserAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_4) AppleWebKit/600.7.12 (KHTML, like Gecko) Version/8.0.7 Safari/600.7.12",
ExpectedPlatformName: "Macintosh",
ExpectedOSName: "Mac OS",
ExpectedBrowserName: "Safari",
ExpectedBrowserVersion: "8.0.7",
},
{
Name: "Safari Mobile",
UserAgent: "Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B137 Safari/601.1",
ExpectedPlatformName: "iPhone",
ExpectedOSName: "iOS",
ExpectedBrowserName: "Safari",
ExpectedBrowserVersion: "9.0",
},
{
Name: "Mobile App",
UserAgent: "Mattermost Mobile/2.7.0+482 (Android; 13; sdk_gphone64_arm64)",
ExpectedPlatformName: "Android",
ExpectedOSName: "Android",
ExpectedBrowserName: "Mobile App",
ExpectedBrowserVersion: "2.7.0+482",
},
{
Name: "Mobile App (long version, truncated)",
UserAgent: "Mattermost Mobile/233.234441.341234223421341234529099823109834440981234+abcdef3214eafeabc3242331129857301afesfffff1930a84e4bd2348fe129ac1309bd929dca3419af934bfe3089fcd (Android; 13; sdk_gphone64_arm64)",
ExpectedPlatformName: "Android",
ExpectedOSName: "Android",
ExpectedBrowserName: "Mobile App",
ExpectedBrowserVersion: "233.234441.341234223421341234529099823109834440981234+abcdef3214eafeabc3242331129857301afesfffff1930a84e4bd2348fe129ac1309bd929d",
},
{
Name: "Firefox (Mac)",
UserAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:132.0) Gecko/20100101 Firefox/132.0",
ExpectedPlatformName: "Macintosh",
ExpectedOSName: "Mac OS",
ExpectedBrowserName: "Firefox",
ExpectedBrowserVersion: "132.0",
},
{
Name: "Desktop App (Mac)",
UserAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.6478.127 Electron/31.2.1 Safari/537.36 Mattermost/5.9.0",
ExpectedPlatformName: "Macintosh",
ExpectedOSName: "Mac OS",
ExpectedBrowserName: "Desktop App",
ExpectedBrowserVersion: "5.9.0",
},
{
Name: "Mobile App (Android, Samsung Galaxy Fold Z)",
UserAgent: "Mattermost Mobile/2.20.0+6000556 (samsung/q4qcsx/q4q:14/UP1A.231005.007/F936WVLU4FXE3:user/release-keys; 14; SM-F936W)",
ExpectedPlatformName: "Android",
ExpectedOSName: "Android",
ExpectedBrowserName: "Mobile App",
ExpectedBrowserVersion: "2.20.0+6000556",
},
{
Name: "Chrome (Android)",
UserAgent: "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Mobile Safari/537.36",
ExpectedPlatformName: "Android",
ExpectedOSName: "Android",
ExpectedBrowserName: "Chrome",
ExpectedBrowserVersion: "129.0",
},
{
Name: "Chrome (Chrome OS)",
UserAgent: "Mozilla/5.0 (X11; CrOS x86_64 14541.0.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36",
ExpectedPlatformName: "Linux",
ExpectedOSName: "Chrome OS",
ExpectedBrowserName: "Chrome",
ExpectedBrowserVersion: "129.0",
},
{
Name: "Firefox (Linux desktop)",
UserAgent: "Mozilla/5.0 (X11; Linux x86_64; rv:132.0) Gecko/20100101 Firefox/132.0",
ExpectedPlatformName: "Linux",
ExpectedOSName: "Linux",
ExpectedBrowserName: "Firefox",
ExpectedBrowserVersion: "132.0",
},
{
Name: "Desktop App (Linux)",
UserAgent: "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.6478.127 Electron/31.2.1 Safari/537.36 Mattermost/5.9.0",
ExpectedPlatformName: "Linux",
ExpectedOSName: "Linux",
ExpectedBrowserName: "Desktop App",
ExpectedBrowserVersion: "5.9.0",
},
{
Name: "iOS App (iPhone 13)",
UserAgent: "Mattermost Mobile/2.20.0+556 (iOS; 17.5.1; iPhone 13)",
ExpectedPlatformName: "iPhone",
ExpectedOSName: "iOS",
ExpectedBrowserName: "Mobile App",
ExpectedBrowserVersion: "2.20.0+556",
},
{
Name: "Safari (iPhone 13)",
UserAgent: "Mozilla/5.0 (iPhone; CPU iPhone OS 17_5_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.5 Mobile/15E148 Safari/604.1",
ExpectedPlatformName: "iPhone",
ExpectedOSName: "iOS",
ExpectedBrowserName: "Safari",
ExpectedBrowserVersion: "17.5",
},
{
Name: "iOS App (iPad 11 Pro)",
UserAgent: "Mattermost Mobile/2.21.0+567 (iPadOS; 17.6.1; iPad Pro (11-inch) (1st generation))",
ExpectedPlatformName: "iPad",
ExpectedOSName: "iOS",
ExpectedBrowserName: "Mobile App",
ExpectedBrowserVersion: "2.21.0+567",
},
{
Name: "Safari (iPad 11 Pro, default)",
UserAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.6 Safari/605.1.15",
ExpectedPlatformName: "Macintosh", // iPad pretends to be a desktop Mac by default
ExpectedOSName: "Mac OS",
ExpectedBrowserName: "Safari",
ExpectedBrowserVersion: "17.6",
},
{
Name: "Safari (iPad 11 Pro, requesting mobile site)",
UserAgent: "Mozilla/5.0 (iPad; CPU OS 17_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.6 Mobile/15E148 Safari/604.1",
ExpectedPlatformName: "iPad",
ExpectedOSName: "iOS",
ExpectedBrowserName: "Safari",
ExpectedBrowserVersion: "17.6",
},
// MM-67274: User agents with empty version strings should not panic
{
Name: "Mobile App (no version)",
UserAgent: "Mattermost Mobile/",
ExpectedPlatformName: "Android",
ExpectedOSName: "Android",
ExpectedBrowserName: "Mobile App",
ExpectedBrowserVersion: "0.0",
},
{
Name: "Desktop App (no version)",
UserAgent: "Mattermost/",
ExpectedPlatformName: "Unknown",
ExpectedOSName: "",
ExpectedBrowserName: "Desktop App",
ExpectedBrowserVersion: "0.0",
},
{
Name: "mmctl (no version)",
UserAgent: "mmctl/",
ExpectedPlatformName: "Unknown",
ExpectedOSName: "",
ExpectedBrowserName: "mmctl",
ExpectedBrowserVersion: "0.0",
},
{
Name: "Franz (no version)",
UserAgent: "Franz/",
ExpectedPlatformName: "Unknown",
ExpectedOSName: "",
ExpectedBrowserName: "Unknown",
ExpectedBrowserVersion: "0.0",
},
}
func TestGetPlatformName(t *testing.T) {
mainHelper.Parallel(t)
for _, tc := range testUserAgents {
t.Run(tc.Name, func(t *testing.T) {
ua := uasurfer.Parse(tc.UserAgent)
actual := getPlatformName(ua, tc.UserAgent)
assert.Equal(t, tc.ExpectedPlatformName, actual)
})
}
}
// user_agent_platform is a select, so a platform name the server derives but the
// schema does not offer can neither be stored on a session nor picked in an
// access policy rule.
func TestPlatformNamesAreSelectableSessionAttributeValues(t *testing.T) {
mainHelper.Parallel(t)
derived := []string{platformNameAndroid}
for _, name := range platformNames {
derived = append(derived, name)
}
var field *model.PropertyField
for _, f := range model.SessionAttributeSystemFields(model.NewId()) {
if f.Name == model.SessionAttributesPropertyFieldUserAgentPlatform {
field = f
break
}
}
require.NotNil(t, field)
options, err := model.NewPropertyOptionsFromFieldAttrs[*model.PluginPropertyOption](field.Attrs[model.PropertyFieldAttributeOptions])
require.NoError(t, err)
offered := make([]string, 0, len(options))
for _, option := range options {
offered = append(offered, option.GetName())
}
assert.ElementsMatch(t, derived, offered)
// derived only covers the names getPlatformName looks up, not the ones it
// returns directly.
for _, tc := range testUserAgents {
name := getPlatformName(uasurfer.Parse(tc.UserAgent), tc.UserAgent)
assert.True(t, model.IsValidSessionAttributeValue(field, name), "%q is not a selectable value", name)
}
}
func TestGetOSName(t *testing.T) {
mainHelper.Parallel(t)
for _, tc := range testUserAgents {
t.Run(tc.Name, func(t *testing.T) {
ua := uasurfer.Parse(tc.UserAgent)
actual := getOSName(ua, tc.UserAgent)
assert.Equal(t, tc.ExpectedOSName, actual)
})
}
}
func TestGetBrowserName(t *testing.T) {
mainHelper.Parallel(t)
for _, tc := range testUserAgents {
t.Run(tc.Name, func(t *testing.T) {
ua := uasurfer.Parse(tc.UserAgent)
actual := getBrowserName(ua, tc.UserAgent)
assert.Equal(t, tc.ExpectedBrowserName, actual)
})
}
}
func TestGetBrowserVersion(t *testing.T) {
mainHelper.Parallel(t)
for _, tc := range testUserAgents {
t.Run(tc.Name, func(t *testing.T) {
ua := uasurfer.Parse(tc.UserAgent)
actual := getBrowserVersion(ua, tc.UserAgent)
assert.Equal(t, tc.ExpectedBrowserVersion, actual)
})
}
}
func TestGetDesktopAppVersion(t *testing.T) {
tests := []struct {
ua string
version string
ok bool
}{
{"Mattermost/5.0.0", "5.0.0", true},
{"Mattermost/5.3.1 Chrome/110.0.5481.177", "5.3.1", true},
{"Mozilla/5.0 ... Mattermost/5.9.0", "5.9.0", true},
{"Mattermost/5.0.0-alpha", "5.0.0-alpha", true},
{"Mattermost/6.0.0-rc.1 Electron/31.2.1", "6.0.0-rc.1", true},
{"Mattermost Mobile/1.2.3", "", false},
{"Mozilla/5.0 Chrome/120.0.0", "", false},
{"Mattermost/", "", false},
{"", "", false},
{" ", "", false},
{"Mattermost", "", false},
{"Mattermost 5.0.0", "", false},
{"Mattermost/ \t", "", false},
{"MATTERMOST/5.0.0", "", false},
{"mattermost/5.0.0", "", false},
{"mmctl/1.2.3", "", false},
{"Franz/4.0.4 Chrome/52.0.2743.82 Electron/1.3.1", "", false},
{"MattermostMobile/1.0", "", false},
{"SomeMattermost/2.0.0", "", false},
{"Chrome/120.0.0 SomeMattermost/2.0.0", "", false},
}
for _, tt := range tests {
t.Run(tt.ua, func(t *testing.T) {
version, ok := GetDesktopAppVersion(tt.ua)
assert.Equal(t, tt.ok, ok)
assert.Equal(t, tt.version, version)
})
}
}