Files
Piik/internal/server/config/config_test.go
T
AAA 799d6efb4a fix: improve sharing recovery and UI feedback
## Problem and outcome / 问题与结果

Browser sharing can remain connected to a local encoding transport that never becomes usable, leaving viewers without frames. This phase bounds that startup at eight seconds and restores ordinary encoding through the existing failure path. It also keeps ready App services running after a browser-open failure, preserves user presentation/playback choices, and aligns room feedback, illustrated hints, metrics and documentation.

部分环境下,本机编码连接一直无法建立会让观众收不到画面。本轮在八秒后进入现有降级流程,同时修复客户端启动移交、播放状态和前端反馈的一致性问题,并更新官网与中英文教程。

Closes #399.

Related: #396. The release contains relevant startup/error-handling repairs, but the reporting machine has not been retested. Keep this issue open for a current-build result. #401 (optional Windows capture-border hiding) remains deferred.

Release / 发布版本:**v1.3.1**.

## Release notes

### 中文

- 客户端记住上次确认的启动模式;启动移交保留已保存的语言、纯视觉模式和主题选择。
- 系统浏览器未能自动打开时,客户端继续运行,并在终端保留页面地址、重试入口和具体错误。
- 改善浏览器共享画面的启动兜底,避免 App 媒体因短暂信令中断被误判为失败。
- 音轨变化保持现有视频与观众的本机暂停状态;连接恢复和暂停恢复不再重复播放电视开机动画。
- 修复昵称编辑及长昵称查看,减少重复的角色提示,统一人物选择和连接状态的区别。
- 完善房间准入、密码和邀请说明;复制反馈对应当前链接及当前操作,避免迟到结果覆盖新反馈。
- 修正采集参数、统计单位与采样区间的展示,未知参数不再用配置上限代替。
- 统一提示漫画、状态图标与动效,改善选源器还焦、键盘操作、剧场布局和触控目标尺寸。
- 服务端默认支持 20 位观众,可在配置中设为 1–20 位,房主不占观众名额。
- 更新官网、教程入口和中英文说明,清理过时预览及失用代码。

兼容说明:使用旧版 App 连接更新后的站点时,站点会优先保留自己的显示偏好。如需更改语言或主题,请在进入后的页面调整。

### English

- Remember the last confirmed App launch mode and preserve saved language, visual-mode and theme choices during launch handoff.
- Keep the App running if the system browser fails to open, with the page address, retry action and error details available in the terminal.
- Improve the browser sharing startup fallback and avoid treating brief signaling outages as App media failures.
- Keep existing video and local pause state when audio tracks change. Reconnecting and resuming no longer replay the television startup animation over the picture.
- Fix nickname editing and full-name access, remove redundant role hints, and distinguish participant selection from connection state.
- Clarify room access, passwords and invitations. Copy feedback now belongs to the current link and operation, so late results cannot replace newer feedback.
- Correct capture details, metric units and observation intervals. Unknown capture values are no longer replaced with configured ceilings.
- Align illustrated hints, status icons and motion. Improve source-picker focus, keyboard operation, theater layout and touch targets.
- Default the Server to 20 viewers, configurable from 1 to 20. The host does not count toward that limit.
- Update the website, guide links and bilingual instructions, and remove obsolete previews and unused code.

Compatibility: when an older App connects to an updated Site, the Site keeps its saved presentation preferences. Change language or theme on the destination page when using an older launcher.

## Verification / 验证

Non-publishing [CI candidate run 34919320511](https://github.com/TNTcraftHIM/Piik/actions/runs/34919320511) passed Go core, race, Web checks, Server/container verification and all three native App package checks at source 188376e8. Subsequent commits only update deployment documentation, status and TODO; documentation/hygiene checks passed. Product inputs are unchanged.

- `npm run check`: TypeScript, 64 test files / 854 tests, and the Web production build passed.
- `npm run check:client-core`: final Go source passed tests, formatting, vet and core target builds. Windows capture compilation and geometry checks passed earlier in this phase; later edits did not change native capture.
- Website build, documentation checks, repository hygiene and diff checks passed. Existing documentation-size and bundle-size warnings remain.
- Actual browser flows covered sharing, source changes, pause/resume, late audio, brief signaling loss, invitation/copy feedback, entry preferences, source-picker focus, and narrow layouts.
- A local three-viewer P2P relay check covered quality-report expiry, recovery and cleanup without interrupting video. A controlled browser-helper failure returning `0xc0000005` left the real App launcher and Local service available.
- Homepage checks covered Chinese/English, light/dark preferences and inline-film open/close after removing the separate-page entry.

Limits: no new reporter-machine confirmation for #396 or the Windows URL-handler crash; physical Safari/mobile, macOS/Linux capture and wider public-network/endurance coverage remain deferred. Formal release artifacts will be built from the approved squash-merge revision. Hero-loop controls and video-adjacent tooltip placement remain open design items in TODO.

## Impact / 影响

Compatible patch; signaling, Native control and capture contracts are unchanged. Older App launch handoff keeps the updated Site's saved presentation preferences. The Server's default viewer limit is corrected to 20; an explicit 1–20 configuration remains valid.

Service updates retain persisted room authority but restart active media sessions. Deploy the verified immutable Server artifact through the existing bounded health/recovery process. Public Demo remains open and P2P-only; deployment does not enable SFU or change infrastructure/configuration.
2026-09-15 10:13:29 +08:00

548 lines
22 KiB
Go

package config
import (
"fmt"
"maps"
"os"
"path/filepath"
"reflect"
"slices"
"strconv"
"strings"
"testing"
"github.com/TNTcraftHIM/Piik/internal/server/protocol"
)
// Ported from tests/server-config.test.ts.
// env merges the given maps, later keys winning, so a case can extend a base.
func env(parts ...map[string]string) map[string]string {
merged := map[string]string{}
for _, part := range parts {
maps.Copy(merged, part)
}
return merged
}
var productionBase = map[string]string{
"PIIK_ENV": "production",
"PUBLIC_BASE_URL": "https://share.test",
"SITE_ACCESS_PASSWORD": "host-password-12",
"STUN_URLS": "stun:stun.test:3478",
}
func stunList(count int, prefix string) string {
urls := make([]string, 0, count)
for index := range count {
urls = append(urls, fmt.Sprintf("stun:%s-%d.test:3478", prefix, index))
}
return strings.Join(urls, ",")
}
func mustLoad(t *testing.T, environment map[string]string) Config {
t.Helper()
config, err := Load(environment)
if err != nil {
t.Fatalf("Load: unexpected error %v", err)
}
return config
}
func TestLoadDevelopmentDefaults(t *testing.T) {
config := mustLoad(t, map[string]string{"PIIK_ENV": "development", "PORT": "9123"})
if config.Env != EnvironmentDevelopment {
t.Errorf("Env = %q", config.Env)
}
if config.ListenHost != "0.0.0.0" {
t.Errorf("ListenHost = %q", config.ListenHost)
}
if got := config.PublicBaseURL.String(); got != "http://localhost:9123/" {
t.Errorf("PublicBaseURL = %q", got)
}
want := map[string]struct{}{"http://localhost:9123": {}}
if !reflect.DeepEqual(config.AllowedOrigins, want) {
t.Errorf("AllowedOrigins = %v", config.AllowedOrigins)
}
defaultDatabasePath, err := filepath.Abs("rooms.sqlite")
if err != nil {
t.Fatal(err)
}
if config.RoomDatabasePath != defaultDatabasePath {
t.Errorf("RoomDatabasePath = %q", config.RoomDatabasePath)
}
if len(config.STUNURLs) != 0 {
t.Errorf("STUNURLs = %v", config.STUNURLs)
}
if len(config.STUNListenAddresses) != 0 {
t.Errorf("STUNListenAddresses = %v", config.STUNListenAddresses)
}
if config.NATPredictionEnabled {
t.Error("NATPredictionEnabled = true")
}
if config.NATPredictionSTUNURLs != nil {
t.Errorf("NATPredictionSTUNURLs = %v, want nil (TS left it undefined)", config.NATPredictionSTUNURLs)
}
if config.MaxViewersPerRoom != 20 {
t.Errorf("MaxViewersPerRoom = %d", config.MaxViewersPerRoom)
}
if config.EndpointMediaCopyCapacity != 2 {
t.Errorf("EndpointMediaCopyCapacity = %d", config.EndpointMediaCopyCapacity)
}
if config.SFU != nil {
t.Errorf("SFU = %+v", config.SFU)
}
if config.SiteAccessPassword != "" {
t.Error("SiteAccessPassword is set")
}
}
func TestLoadProductionAllowsAnUnsetOrEmptySiteAccessPassword(t *testing.T) {
for _, name := range []string{"unset", "empty"} {
t.Run(name, func(t *testing.T) {
environment := env(productionBase, map[string]string{"SITE_ACCESS_PASSWORD": ""})
if name == "unset" {
delete(environment, "SITE_ACCESS_PASSWORD")
}
configuration := mustLoad(t, environment)
if configuration.Env != EnvironmentProduction || configuration.SiteAccessPassword != "" {
t.Fatal("expected a production site without an access password")
}
})
}
}
func TestLoadPreservesTheChosenSiteAccessPassword(t *testing.T) {
for _, base := range []map[string]string{nil, productionBase} {
for _, password := range []string{"", "x", "中文", " ", " 中文 +& ", strings.Repeat("x", 256)} {
configuration := mustLoad(t, env(base, map[string]string{"SITE_ACCESS_PASSWORD": password}))
if configuration.SiteAccessPassword != password {
t.Fatal("site password changed")
}
}
}
}
func TestLoadRoomStorage(t *testing.T) {
directory := t.TempDir()
t.Chdir(directory)
for _, base := range []map[string]string{nil, productionBase} {
for _, override := range []map[string]string{nil,
{"ROOM_DATABASE_PATH": ""}, {"ROOM_DATABASE_PATH": " \t"},
{"ROOM_DATABASE_PATH": ":memory:"},
} {
configuration := mustLoad(t, env(base, override))
want := filepath.Join(directory, "rooms.sqlite")
if override["ROOM_DATABASE_PATH"] == ":memory:" {
want = ""
}
if configuration.RoomDatabasePath != want {
t.Errorf("Load(%v): RoomDatabasePath = %q, want %q", override, configuration.RoomDatabasePath, want)
}
}
}
entries, err := os.ReadDir(directory)
if err != nil || len(entries) != 0 {
t.Fatalf("configuration loading created runtime files: %v, %v", entries, err)
}
}
func TestLoadSFU(t *testing.T) {
config := mustLoad(t, map[string]string{
"LISTEN_HOST": "127.0.0.1",
"SFU_UDP_PORT": " 7882 ",
"SFU_LISTEN_HOST": " 192.0.2.5 ",
"SFU_PUBLIC_IP": " 198.51.100.5 ",
})
want := SFUConfig{
ListenHost: "192.0.2.5",
Port: 7882,
PublicIP: "198.51.100.5",
}
if config.SFU == nil || *config.SFU != want {
t.Errorf("SFU = %+v, want %+v", config.SFU, want)
}
}
func TestLoadSFUOptional(t *testing.T) {
for _, values := range []map[string]string{
nil,
{"SFU_UDP_PORT": ""},
{"SFU_UDP_PORT": " "},
{"SFU_LISTEN_HOST": "192.0.2.5", "SFU_PUBLIC_IP": "198.51.100.5"},
} {
if config := mustLoad(t, values); config.SFU != nil {
t.Errorf("SFU = %+v without an enabled port", config.SFU)
}
}
for _, port := range []int{1, 7882, maxPort} {
config := mustLoad(t, env(productionBase, map[string]string{
"SFU_UDP_PORT": strconv.Itoa(port),
}))
want := SFUConfig{ListenHost: "0.0.0.0", Port: port}
if config.SFU == nil || *config.SFU != want {
t.Errorf("SFU = %+v, want %+v", config.SFU, want)
}
}
}
func TestLoadAccepts(t *testing.T) {
developmentPath, err := filepath.Abs(filepath.Join("state", "rooms.sqlite"))
if err != nil {
t.Fatalf("Abs: %v", err)
}
productionPath, err := filepath.Abs(filepath.Join("production-state", "rooms.sqlite"))
if err != nil {
t.Fatalf("Abs: %v", err)
}
cases := []struct {
name string
env map[string]string
check func(*testing.T, Config)
}{
{"default viewer limit", map[string]string{}, func(t *testing.T, c Config) {
if c.MaxViewersPerRoom != 20 {
t.Errorf("MaxViewersPerRoom = %d", c.MaxViewersPerRoom)
}
}},
{"viewer limit lower boundary", map[string]string{"MAX_VIEWERS_PER_ROOM": "1"},
func(t *testing.T, c Config) {
if c.MaxViewersPerRoom != 1 {
t.Errorf("MaxViewersPerRoom = %d", c.MaxViewersPerRoom)
}
}},
{"viewer limit ceiling",
map[string]string{"MAX_VIEWERS_PER_ROOM": strconv.Itoa(protocol.MaxViewersPerRoomLimit)},
func(t *testing.T, c Config) {
if c.MaxViewersPerRoom != protocol.MaxViewersPerRoomLimit {
t.Errorf("MaxViewersPerRoom = %d", c.MaxViewersPerRoom)
}
}},
{"copy capacity 1", map[string]string{"ENDPOINT_MEDIA_COPY_CAPACITY": "1"},
func(t *testing.T, c Config) {
if c.EndpointMediaCopyCapacity != 1 {
t.Errorf("EndpointMediaCopyCapacity = %d", c.EndpointMediaCopyCapacity)
}
}},
{"copy capacity 2", map[string]string{"ENDPOINT_MEDIA_COPY_CAPACITY": "2"},
func(t *testing.T, c Config) {
if c.EndpointMediaCopyCapacity != 2 {
t.Errorf("EndpointMediaCopyCapacity = %d", c.EndpointMediaCopyCapacity)
}
}},
{"copy capacity 3", map[string]string{"ENDPOINT_MEDIA_COPY_CAPACITY": "3"},
func(t *testing.T, c Config) {
if c.EndpointMediaCopyCapacity != 3 {
t.Errorf("EndpointMediaCopyCapacity = %d", c.EndpointMediaCopyCapacity)
}
}},
{"explicit loopback listen host", map[string]string{"LISTEN_HOST": " 127.0.0.1 "},
func(t *testing.T, c Config) {
if c.ListenHost != "127.0.0.1" {
t.Errorf("ListenHost = %q", c.ListenHost)
}
}},
{"production STUN", productionBase, func(t *testing.T, c Config) {
if !slices.Equal(c.STUNURLs, []string{"stun:stun.test:3478"}) {
t.Errorf("STUNURLs = %v", c.STUNURLs)
}
if !slices.Equal(c.STUNListenAddresses, []string{"0.0.0.0:3478"}) {
t.Errorf("STUNListenAddresses = %v", c.STUNListenAddresses)
}
}},
{"independent STUN bind host", env(productionBase, map[string]string{
"LISTEN_HOST": "127.0.0.1", "STUN_LISTEN_HOST": " 192.0.2.5 ",
"NAT_PREDICTION_ENABLED": "true",
}), func(t *testing.T, c Config) {
if !slices.Equal(c.STUNListenAddresses, []string{
"192.0.2.5:3478", "192.0.2.5:3479", "192.0.2.5:3480",
}) || !slices.Equal(c.STUNURLs, []string{"stun:stun.test:3478"}) {
t.Fatalf("binding and advertisement were coupled: %+v", c)
}
}},
{"production site access password",
env(productionBase, map[string]string{"SITE_ACCESS_PASSWORD": "easy-key"}),
func(t *testing.T, c Config) {
if c.SiteAccessPassword != "easy-key" {
t.Errorf("SiteAccessPassword = %q", c.SiteAccessPassword)
}
}},
{"uppercase STUN scheme and IPv6 host", map[string]string{"STUN_URLS": "STUN:[2001:db8::1]:3478"},
func(t *testing.T, c Config) {
if !slices.Equal(c.STUNURLs, []string{"STUN:[2001:db8::1]:3478"}) {
t.Errorf("STUNURLs = %v", c.STUNURLs)
}
}},
{"NAT prediction with a base listener", map[string]string{
"STUN_URLS": "stun:share.test:3478",
"NAT_PREDICTION_ENABLED": "true",
}, func(t *testing.T, c Config) {
if !c.NATPredictionEnabled {
t.Error("NATPredictionEnabled = false")
}
}},
{"file-backed room authority in development",
map[string]string{"ROOM_DATABASE_PATH": " " + developmentPath + " "},
func(t *testing.T, c Config) {
if c.RoomDatabasePath != developmentPath {
t.Errorf("RoomDatabasePath = %q", c.RoomDatabasePath)
}
}},
{"file-backed room authority in production",
env(productionBase, map[string]string{"ROOM_DATABASE_PATH": productionPath}),
func(t *testing.T, c Config) {
if c.RoomDatabasePath != productionPath {
t.Errorf("RoomDatabasePath = %q", c.RoomDatabasePath)
}
}},
{"allowed origins are normalised",
map[string]string{"ALLOWED_ORIGINS": " https://Example.com:443/path , http://a.test:80 "},
func(t *testing.T, c Config) {
want := map[string]struct{}{"https://example.com": {}, "http://a.test": {}}
if !reflect.DeepEqual(c.AllowedOrigins, want) {
t.Errorf("AllowedOrigins = %v", c.AllowedOrigins)
}
}},
// Number(string) coercion, which the TS parsers inherited.
{"port with surrounding whitespace", map[string]string{"PORT": " 9123 "},
func(t *testing.T, c Config) {
if c.Port != 9123 {
t.Errorf("Port = %d", c.Port)
}
}},
{"hexadecimal port", map[string]string{"PORT": "0x1F5B"}, func(t *testing.T, c Config) {
if c.Port != 8027 {
t.Errorf("Port = %d", c.Port)
}
}},
}
for _, testCase := range cases {
t.Run(testCase.name, func(t *testing.T) {
testCase.check(t, mustLoad(t, testCase.env))
})
}
}
func TestLoadRejects(t *testing.T) {
cases := []struct {
name string
env map[string]string
want string
}{
{"SFU port zero", map[string]string{"SFU_UDP_PORT": "0"},
"SFU_UDP_PORT must be a positive integer"},
{"SFU port negative", map[string]string{"SFU_UDP_PORT": "-1"},
"SFU_UDP_PORT must be a positive integer"},
{"SFU port fractional", map[string]string{"SFU_UDP_PORT": "7882.5"},
"SFU_UDP_PORT must be a positive integer"},
{"SFU port not a number", map[string]string{"SFU_UDP_PORT": "media"},
"SFU_UDP_PORT must be a positive integer"},
{"SFU port above UDP ceiling", map[string]string{"SFU_UDP_PORT": "65536"},
"SFU_UDP_PORT must be between 1 and 65535"},
{"SFU bind hostname", map[string]string{"SFU_UDP_PORT": "7882", "SFU_LISTEN_HOST": "sfu.test"},
"SFU_LISTEN_HOST must be an IPv4 address"},
{"SFU bind IPv6", map[string]string{"SFU_UDP_PORT": "7882", "SFU_LISTEN_HOST": "::1"},
"SFU_LISTEN_HOST must be an IPv4 address"},
{"SFU bind mapped IPv6", map[string]string{"SFU_UDP_PORT": "7882", "SFU_LISTEN_HOST": "::ffff:192.0.2.5"},
"SFU_LISTEN_HOST must be an IPv4 address"},
{"SFU public hostname", map[string]string{"SFU_UDP_PORT": "7882", "SFU_PUBLIC_IP": "sfu.test"},
"SFU_PUBLIC_IP must be an IPv4 address"},
{"SFU public IPv6", map[string]string{"SFU_UDP_PORT": "7882", "SFU_PUBLIC_IP": "2001:db8::5"},
"SFU_PUBLIC_IP must be an IPv4 address"},
{"SFU public mapped IPv6", map[string]string{"SFU_UDP_PORT": "7882", "SFU_PUBLIC_IP": "::ffff:198.51.100.5"},
"SFU_PUBLIC_IP must be an IPv4 address"},
// Bounded integers.
{"viewer limit above ceiling",
map[string]string{"MAX_VIEWERS_PER_ROOM": strconv.Itoa(protocol.MaxViewersPerRoomLimit + 1)},
"MAX_VIEWERS_PER_ROOM must be between 1 and 20"},
{"viewer limit zero", map[string]string{"MAX_VIEWERS_PER_ROOM": "0"},
"MAX_VIEWERS_PER_ROOM must be a positive integer"},
{"fractional viewer limit", map[string]string{"MAX_VIEWERS_PER_ROOM": "1.5"},
"MAX_VIEWERS_PER_ROOM must be a positive integer"},
{"copy capacity zero", map[string]string{"ENDPOINT_MEDIA_COPY_CAPACITY": "0"},
"ENDPOINT_MEDIA_COPY_CAPACITY must be a positive integer"},
{"copy capacity above ceiling", map[string]string{"ENDPOINT_MEDIA_COPY_CAPACITY": "4"},
"ENDPOINT_MEDIA_COPY_CAPACITY must be between 1 and 3"},
{"fractional copy capacity", map[string]string{"ENDPOINT_MEDIA_COPY_CAPACITY": "1.5"},
"ENDPOINT_MEDIA_COPY_CAPACITY must be a positive integer"},
{"port zero", map[string]string{"PORT": "0"}, "PORT must be a positive integer"},
{"port not a number", map[string]string{"PORT": "eight"}, "PORT must be a positive integer"},
{"port above the TCP ceiling", map[string]string{"PORT": "65536"}, "PORT must be at most 65535"},
// Public base URL.
{"public base URL credentials", map[string]string{"PUBLIC_BASE_URL": "https://user:pass@share.test"},
"PUBLIC_BASE_URL must be an origin"},
{"public base URL path", map[string]string{"PUBLIC_BASE_URL": "https://share.test/path"},
"PUBLIC_BASE_URL must be an origin"},
{"public base URL query", map[string]string{"PUBLIC_BASE_URL": "https://share.test?query=1"},
"PUBLIC_BASE_URL must be an origin"},
{"public base URL fragment", map[string]string{"PUBLIC_BASE_URL": "https://share.test#fragment"},
"PUBLIC_BASE_URL must be an origin"},
{"public base URL scheme", map[string]string{"PUBLIC_BASE_URL": "ftp://share.test"},
"PUBLIC_BASE_URL must use http or https"},
{"blank public base URL", map[string]string{"PUBLIC_BASE_URL": ""},
"PUBLIC_BASE_URL must be a valid http or https origin"},
{"plaintext public base URL in production", env(productionBase, map[string]string{
"PUBLIC_BASE_URL": "http://share.test",
}), "PUBLIC_BASE_URL must use https in production"},
// Allowed origins.
{"allowed origin scheme", map[string]string{"ALLOWED_ORIGINS": "ftp://share.test"},
"Allowed origins must use http or https"},
{"unparsable allowed origin", map[string]string{"ALLOWED_ORIGINS": "share.test"},
"Allowed origins must be valid http or https URLs"},
{"empty allowed origin entry", map[string]string{"ALLOWED_ORIGINS": "https://a.test,,https://b.test"},
"ALLOWED_ORIGINS contains an empty URL"},
// Production requirements.
{"production without STUN", map[string]string{
"PIIK_ENV": "production", "PUBLIC_BASE_URL": "https://share.test",
"SITE_ACCESS_PASSWORD": "host-password-12",
}, "STUN is required in production"},
// STUN lists.
{"STUN path", map[string]string{"STUN_URLS": "stun:stun.test/path"},
"STUN_URLS contains an invalid STUN URL"},
{"STUN hostname is not a local bind address", map[string]string{
"STUN_URLS": "stun:stun.test:3478", "STUN_LISTEN_HOST": "stun.test",
}, "STUN_LISTEN_HOST must be an IPv4 address"},
{"STUN IPv6 listener is unsupported", map[string]string{
"STUN_URLS": "stun:stun.test:3478", "STUN_LISTEN_HOST": "::1",
}, "STUN_LISTEN_HOST must be an IPv4 address"},
{"STUN query", map[string]string{"STUN_URLS": "stun:stun.test?transport=udp"},
"STUN_URLS contains an invalid STUN URL"},
{"STUN fragment", map[string]string{"STUN_URLS": "stun:stun.test#fragment"},
"STUN_URLS contains an invalid STUN URL"},
{"STUN without authority", map[string]string{"STUN_URLS": "stun:"},
"STUN_URLS contains an invalid STUN URL"},
{"STUN with an empty port", map[string]string{"STUN_URLS": "stun:stun.test:"},
"STUN_URLS contains an invalid STUN URL"},
{"STUN port zero", map[string]string{"STUN_URLS": "stun:stun.test:0"},
"STUN_URLS contains an invalid STUN URL"},
{"STUN userinfo", map[string]string{"STUN_URLS": "stun:user@stun.test:3478"},
"STUN_URLS contains an invalid STUN URL"},
{"TURN scheme", map[string]string{"STUN_URLS": "turn:turn.test:3478"},
"STUN_URLS contains an invalid STUN URL"},
{"STUNS scheme", map[string]string{"STUN_URLS": "stuns:stun.test:5349"},
"STUN_URLS contains an invalid STUN URL"},
{"empty STUN entry", map[string]string{"STUN_URLS": "stun:a.test:3478,,stun:b.test:3478"},
"STUN_URLS contains an empty URL"},
{"too many STUN URLs", map[string]string{"STUN_URLS": stunList(9, "stun")},
"STUN_URLS must contain at most 8 URLs"},
{"no NAT prediction slots", map[string]string{
"STUN_URLS": stunList(7, "ordinary"), "NAT_PREDICTION_ENABLED": "true",
}, "STUN_URLS must contain at most 6 URLs when NAT_PREDICTION_ENABLED=true"},
// NAT prediction.
{"NAT prediction without STUN", map[string]string{"NAT_PREDICTION_ENABLED": "true"},
"NAT_PREDICTION_ENABLED requires a STUN_URLS entry on UDP 3478"},
{"NAT prediction off the base port", map[string]string{
"STUN_URLS": "stun:share.test:5349", "NAT_PREDICTION_ENABLED": "true",
}, "NAT_PREDICTION_ENABLED requires a STUN_URLS entry on UDP 3478"},
{"NAT prediction not a boolean", map[string]string{"NAT_PREDICTION_ENABLED": "sometimes"},
"NAT_PREDICTION_ENABLED must be true or false"},
// Room database path.
{"room database path with a NUL", map[string]string{"ROOM_DATABASE_PATH": "rooms\x00.sqlite"},
"ROOM_DATABASE_PATH must be an absolute file path"},
{"bare room database file name", map[string]string{"ROOM_DATABASE_PATH": "rooms.sqlite"},
"ROOM_DATABASE_PATH must be an absolute file path"},
{"relative room database path", map[string]string{"ROOM_DATABASE_PATH": "./state/rooms.sqlite"},
"ROOM_DATABASE_PATH must be an absolute file path"},
// Runtime environment (DECISIONS D8).
{"NODE_ENV is removed", map[string]string{"NODE_ENV": "production"},
"NODE_ENV is no longer supported; use PIIK_ENV"},
{"blank NODE_ENV is removed", map[string]string{"NODE_ENV": ""},
"NODE_ENV is no longer supported; use PIIK_ENV"},
{"test environment is gone", map[string]string{"PIIK_ENV": "test"},
"PIIK_ENV must be development or production"},
{"blank environment", map[string]string{"PIIK_ENV": ""},
"PIIK_ENV must be development or production"},
// Removed variables carrying their own replacement.
{"removed relay downstream setting", map[string]string{"MAX_PEER_RELAY_DOWNSTREAM_EDGES": "2"},
"MAX_PEER_RELAY_DOWNSTREAM_EDGES is no longer supported; use ENDPOINT_MEDIA_COPY_CAPACITY"},
{"removed room rollout setting", map[string]string{"PEER_ASSISTED_ROOM_IDS": "1"},
"PEER_ASSISTED_ROOM_IDS is no longer supported; peer-assisted media applies to every room"},
{"removed peer-assisted toggle", map[string]string{"PEER_ASSISTED_MEDIA": "true"},
"PEER_ASSISTED_MEDIA is no longer supported; peer-assisted media is always enabled"},
{"removed room TTL", map[string]string{"ROOM_TTL_SECONDS": ""},
"ROOM_TTL_SECONDS is no longer supported; rooms do not expire"},
{"removed room lease", map[string]string{"ROOM_LEASE_SECONDS": "86400"},
"ROOM_LEASE_SECONDS is no longer supported; rooms do not expire"},
{"blank removed room lease", map[string]string{"ROOM_LEASE_SECONDS": ""},
"ROOM_LEASE_SECONDS is no longer supported; rooms do not expire"},
{"removed access password", map[string]string{"ACCESS_PASSWORD": "legacy-password"},
"ACCESS_PASSWORD is no longer supported; use SITE_ACCESS_PASSWORD"},
{"blank access password", map[string]string{"ACCESS_PASSWORD": ""},
"ACCESS_PASSWORD is no longer supported; use SITE_ACCESS_PASSWORD"},
{"removed host admission password", map[string]string{"HOST_ADMISSION_PASSWORD": "legacy-password"},
"HOST_ADMISSION_PASSWORD is no longer supported; use SITE_ACCESS_PASSWORD"},
{"blank host admission password", map[string]string{"HOST_ADMISSION_PASSWORD": ""},
"HOST_ADMISSION_PASSWORD is no longer supported; use SITE_ACCESS_PASSWORD"},
}
for _, testCase := range cases {
t.Run(testCase.name, func(t *testing.T) {
_, err := Load(testCase.env)
if err == nil {
t.Fatalf("Load: want error containing %q", testCase.want)
}
if !strings.Contains(err.Error(), testCase.want) {
t.Errorf("Load: error %q, want it to contain %q", err, testCase.want)
}
})
}
}
// TestLoadRejectsRemovedTurnVariables covers the ten TURN names that share the
// default reason, blank included.
func TestLoadRejectsRemovedTurnVariables(t *testing.T) {
names := []string{
"TURN_URLS", "TURN_SHARED_SECRET", "TURN_CREDENTIAL_TTL_SECONDS",
"PEER_ICE_TURN_URLS", "PEER_ICE_TURN_SHARED_SECRET",
"PEER_ICE_TURN_CREDENTIAL_TTL_SECONDS", "SELECTED_EDGE_TURN_URLS",
"SELECTED_EDGE_TURN_SHARED_SECRET", "SELECTED_EDGE_TURN_CREDENTIAL_TTL_SECONDS",
"SELECTED_EDGE_TURN_ALLOCATION_CAPACITY",
}
for _, name := range names {
t.Run(name, func(t *testing.T) {
_, err := Load(map[string]string{name: ""})
want := name + " is no longer supported; ordinary ICE accepts STUN_URLS only"
if err == nil || err.Error() != want {
t.Errorf("Load: error %v, want %q", err, want)
}
})
}
}
func TestOrigin(t *testing.T) {
cases := []struct{ raw, scheme, alternative, want string }{
{"https://Example.com:443/", "http", "https", "https://example.com"},
{"http://Example.com:80", "http", "https", "http://example.com"},
{"https://share.test:0443", "http", "https", "https://share.test"},
{"http://localhost:9123", "http", "https", "http://localhost:9123"},
{"https://[2001:DB8::1]:8443", "http", "https", "https://[2001:db8::1]:8443"},
{"http://[::1]:7880", "http", "https", "http://[::1]:7880"},
}
for _, testCase := range cases {
t.Run(testCase.raw, func(t *testing.T) {
parsed, err := parseOriginURL(testCase.raw, "TEST", testCase.scheme, testCase.alternative)
if err != nil {
t.Fatalf("parseOriginURL: %v", err)
}
if got := Origin(parsed); got != testCase.want {
t.Errorf("Origin = %q, want %q", got, testCase.want)
}
if got := parsed.String(); got != testCase.want+"/" {
t.Errorf("String = %q, want %q", got, testCase.want+"/")
}
})
}
}