e3b2b13292
* Improve mocking of imported resources in unit tests We have Webpack configured so that, when code imports an image or other resource, the code gets the URL of that image. Jest now matches that behaviour which is needed because React Testing Library would previously throw an error. * Polyfill ResizeObserver in all unit tests * Ensure haveIChannelPermission always returns a boolean value The previous code could sometimes return undefined. While that should behave the same in practice, it can cause React to print prop type warnings * MM-58535 Add region label to LCP metrics * MM-58535 Upgrade web-vitals and add INP attribution * Change new labels to use snake_case * Remove replaceGlobalStore option from renderWithContext I was going to add this in case any tests failed with this option set to false, but after running those tests, that's not the case. I'm going to remove this as an option since it seems more likely than not that anyone using RTL would prefer to have this on.
127 строки
3.8 KiB
Go
127 строки
3.8 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package model
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/blang/semver/v4"
|
|
)
|
|
|
|
type MetricType string
|
|
|
|
const (
|
|
ClientTimeToFirstByte MetricType = "TTFB"
|
|
ClientFirstContentfulPaint MetricType = "FCP"
|
|
ClientLargestContentfulPaint MetricType = "LCP"
|
|
ClientInteractionToNextPaint MetricType = "INP"
|
|
ClientCumulativeLayoutShift MetricType = "CLS"
|
|
ClientLongTasks MetricType = "long_tasks"
|
|
ClientPageLoadDuration MetricType = "page_load"
|
|
ClientChannelSwitchDuration MetricType = "channel_switch"
|
|
ClientTeamSwitchDuration MetricType = "team_switch"
|
|
ClientRHSLoadDuration MetricType = "rhs_load"
|
|
ClientGlobalThreadsLoadDuration MetricType = "global_threads_load"
|
|
|
|
MobileClientLoadDuration MetricType = "mobile_load"
|
|
MobileClientChannelSwitchDuration MetricType = "mobile_channel_switch"
|
|
MobileClientTeamSwitchDuration MetricType = "mobile_team_switch"
|
|
|
|
performanceReportTTLMilliseconds = 300 * 1000 // 300 seconds/5 minutes
|
|
)
|
|
|
|
var (
|
|
performanceReportVersion = semver.MustParse("0.1.0")
|
|
acceptedPlatforms = sliceToMapKey("linux", "macos", "ios", "android", "windows", "other")
|
|
acceptedAgents = sliceToMapKey("desktop", "firefox", "chrome", "safari", "edge", "other")
|
|
|
|
AcceptedInteractions = sliceToMapKey("keyboard", "pointer", "other")
|
|
AcceptedLCPRegions = sliceToMapKey(
|
|
"post",
|
|
"post_textbox",
|
|
"channel_sidebar",
|
|
"team_sidebar",
|
|
"channel_header",
|
|
"global_header",
|
|
"announcement_bar",
|
|
"center_channel",
|
|
"modal_content",
|
|
"other",
|
|
)
|
|
)
|
|
|
|
type MetricSample struct {
|
|
Metric MetricType `json:"metric"`
|
|
Value float64 `json:"value"`
|
|
Timestamp float64 `json:"timestamp,omitempty"`
|
|
Labels map[string]string `json:"labels,omitempty"`
|
|
}
|
|
|
|
func (s *MetricSample) GetLabelValue(name string, acceptedValues map[string]any, defaultValue string) string {
|
|
return processLabel(s.Labels, name, acceptedValues, defaultValue)
|
|
}
|
|
|
|
// PerformanceReport is a set of samples collected from a client
|
|
type PerformanceReport struct {
|
|
Version string `json:"version"`
|
|
ClientID string `json:"client_id"`
|
|
Labels map[string]string `json:"labels"`
|
|
Start float64 `json:"start"`
|
|
End float64 `json:"end"`
|
|
Counters []*MetricSample `json:"counters"`
|
|
Histograms []*MetricSample `json:"histograms"`
|
|
}
|
|
|
|
func (r *PerformanceReport) IsValid() error {
|
|
if r == nil {
|
|
return fmt.Errorf("the report is nil")
|
|
}
|
|
|
|
reportVersion, err := semver.ParseTolerant(r.Version)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if reportVersion.Major != performanceReportVersion.Major || reportVersion.Minor > performanceReportVersion.Minor {
|
|
return fmt.Errorf("report version is not supported: server version: %s, report version: %s", performanceReportVersion.String(), r.Version)
|
|
}
|
|
|
|
if r.Start > r.End {
|
|
return fmt.Errorf("report timestamps are erroneous")
|
|
}
|
|
|
|
now := time.Now().UnixMilli()
|
|
if r.End < float64(now-performanceReportTTLMilliseconds) {
|
|
return fmt.Errorf("report is outdated: %f", r.End)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (r *PerformanceReport) ProcessLabels() map[string]string {
|
|
return map[string]string{
|
|
"platform": processLabel(r.Labels, "platform", acceptedPlatforms, "other"),
|
|
"agent": processLabel(r.Labels, "agent", acceptedAgents, "other"),
|
|
}
|
|
}
|
|
|
|
func processLabel(labels map[string]string, name string, acceptedValues map[string]any, defaultValue string) string {
|
|
// check if the label is specified
|
|
value, ok := labels[name]
|
|
if !ok {
|
|
return defaultValue
|
|
}
|
|
value = strings.ToLower(value)
|
|
|
|
// check if the value is one that we accept
|
|
_, ok = acceptedValues[value]
|
|
if !ok {
|
|
return defaultValue
|
|
}
|
|
|
|
return value
|
|
}
|