Skip to content

Combine desktop and mobile for "Missing one" chart #1461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions backend/pkg/httpserver/list_aggregated_feature_support.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,17 @@ func (s *Server) ListAggregatedFeatureSupport(
var err error
matchingMobileBrowser, err := getDesktopsMobileProduct(request.Browser)
if err != nil {
return backend.ListAggregatedFeatureSupport400JSONResponse{
Code: 400,
if errors.Is(err, ErrNoMatchingMobileBrowser) {
return backend.ListAggregatedFeatureSupport400JSONResponse{
Code: 400,
Message: err.Error(),
}, nil
}

return backend.ListAggregatedFeatureSupport500JSONResponse{
Code: 500,
Message: err.Error(),
}, err
}, nil
}
targetMobileBrowser = (*string)(&matchingMobileBrowser)
}
Expand Down
24 changes: 19 additions & 5 deletions backend/pkg/httpserver/list_missing_one_implementation_counts.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,28 @@ func (s *Server) ListMissingOneImplementationCounts(
if found {
return cachedResponse, nil
}
otherBrowsers := make([]string, len(request.Params.Browser))
for i := 0; i < len(request.Params.Browser); i++ {
otherBrowsers[i] = string(request.Params.Browser[i])

browserParams, err := PrepareMissingOneBrowserParams(
request.Browser, request.Params.Browser, request.Params.IncludeBaselineMobileBrowsers != nil)
if err != nil {
if errors.Is(err, ErrNoMatchingMobileBrowser) {
return backend.ListMissingOneImplementationCounts400JSONResponse{
Code: 400,
Message: err.Error(),
}, nil
}

return backend.ListMissingOneImplementationCounts500JSONResponse{
Code: 500,
Message: err.Error(),
}, nil
}

page, err := s.wptMetricsStorer.ListMissingOneImplCounts(
ctx,
string(request.Browser),
otherBrowsers,
browserParams.targetBrowser,
browserParams.targetMobileBrowser,
browserParams.otherBrowsers,
request.Params.StartAt.Time,
request.Params.EndAt.Time,
getPageSizeOrDefault(request.Params.PageSize),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,15 @@ func TestListMissingOneImplementationCounts(t *testing.T) {
{
name: "Success Case - no optional params - use defaults",
mockConfig: &MockListMissingOneImplCountsConfig{
expectedTargetBrowser: "chrome",
expectedOtherBrowsers: []string{"edge", "firefox", "safari"},
expectedStartAt: time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC),
expectedEndAt: time.Date(2000, time.January, 10, 0, 0, 0, 0, time.UTC),
expectedPageSize: 100,
expectedPageToken: nil,
pageToken: nil,
err: nil,
expectedTargetBrowser: "chrome",
expectedTargetMobileBrowser: nil,
expectedOtherBrowsers: []string{"edge", "firefox", "safari"},
expectedStartAt: time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC),
expectedEndAt: time.Date(2000, time.January, 10, 0, 0, 0, 0, time.UTC),
expectedPageSize: 100,
expectedPageToken: nil,
pageToken: nil,
err: nil,
page: &backend.BrowserReleaseFeatureMetricsPage{
Metadata: &backend.PageMetadata{
NextPageToken: nil,
Expand Down Expand Up @@ -143,13 +144,14 @@ func TestListMissingOneImplementationCounts(t *testing.T) {
{
name: "Success Case - include optional params",
mockConfig: &MockListMissingOneImplCountsConfig{
expectedTargetBrowser: "chrome",
expectedOtherBrowsers: []string{"edge", "firefox", "safari"},
expectedStartAt: time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC),
expectedEndAt: time.Date(2000, time.January, 10, 0, 0, 0, 0, time.UTC),
expectedPageSize: 50,
expectedPageToken: inputPageToken,
err: nil,
expectedTargetBrowser: "chrome",
expectedTargetMobileBrowser: valuePtr("chrome_android"),
expectedOtherBrowsers: []string{"firefox", "firefox_android", "safari", "safari_ios"},
expectedStartAt: time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC),
expectedEndAt: time.Date(2000, time.January, 10, 0, 0, 0, 0, time.UTC),
expectedPageSize: 50,
expectedPageToken: inputPageToken,
err: nil,
page: &backend.BrowserReleaseFeatureMetricsPage{
Metadata: &backend.PageMetadata{
NextPageToken: nextPageToken,
Expand All @@ -171,7 +173,7 @@ func TestListMissingOneImplementationCounts(t *testing.T) {
{
Key: `ListMissingOneImplementationCounts-{"browser":"chrome","Params":{"startAt":"2000-01-01",` +
`"endAt":"2000-01-10","page_token":"input-token",` +
`"page_size":50,"browser":["edge","firefox","safari"]}}`,
`"page_size":50,"include_baseline_mobile_browsers":true,"browser":["firefox","safari"]}}`,
Value: nil,
Err: cachetypes.ErrCachedDataNotFound,
},
Expand All @@ -180,7 +182,7 @@ func TestListMissingOneImplementationCounts(t *testing.T) {
{
Key: `ListMissingOneImplementationCounts-{"browser":"chrome","Params":{"startAt":"2000-01-01",` +
`"endAt":"2000-01-10","page_token":"input-token",` +
`"page_size":50,"browser":["edge","firefox","safari"]}}`,
`"page_size":50,"include_baseline_mobile_browsers":true,"browser":["firefox","safari"]}}`,
Value: []byte(
`{"data":[{"count":10,"timestamp":"2000-01-10T00:00:00Z"},` +
`{"count":9,"timestamp":"2000-01-09T00:00:00Z"}],` +
Expand Down Expand Up @@ -208,7 +210,7 @@ func TestListMissingOneImplementationCounts(t *testing.T) {
}`),
request: httptest.NewRequest(http.MethodGet,
"/v1/stats/features/browsers/chrome/missing_one_implementation_counts?"+
"browser=edge&browser=firefox&browser=safari&"+
"browser=firefox&browser=safari&include_baseline_mobile_browsers=true&"+
"startAt=2000-01-01&endAt=2000-01-10&page_size=50&page_token="+*inputPageToken, nil),
},
{
Expand Down Expand Up @@ -253,15 +255,16 @@ func TestListMissingOneImplementationCounts(t *testing.T) {
{
name: "500 case",
mockConfig: &MockListMissingOneImplCountsConfig{
expectedTargetBrowser: "chrome",
expectedOtherBrowsers: []string{"edge", "firefox", "safari"},
expectedStartAt: time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC),
expectedEndAt: time.Date(2000, time.January, 10, 0, 0, 0, 0, time.UTC),
expectedPageSize: 100,
expectedPageToken: nil,
page: nil,
pageToken: nil,
err: errTest,
expectedTargetBrowser: "chrome",
expectedTargetMobileBrowser: nil,
expectedOtherBrowsers: []string{"edge", "firefox", "safari"},
expectedStartAt: time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC),
expectedEndAt: time.Date(2000, time.January, 10, 0, 0, 0, 0, time.UTC),
expectedPageSize: 100,
expectedPageToken: nil,
page: nil,
pageToken: nil,
err: errTest,
},
expectedGetCalls: []*ExpectedGetCall{
{
Expand All @@ -283,15 +286,16 @@ func TestListMissingOneImplementationCounts(t *testing.T) {
{
name: "400 case - invalid page token",
mockConfig: &MockListMissingOneImplCountsConfig{
expectedTargetBrowser: "chrome",
expectedOtherBrowsers: []string{"edge", "firefox", "safari"},
expectedStartAt: time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC),
expectedEndAt: time.Date(2000, time.January, 10, 0, 0, 0, 0, time.UTC),
expectedPageSize: 100,
expectedPageToken: badPageToken,
page: nil,
pageToken: nil,
err: backendtypes.ErrInvalidPageToken,
expectedTargetBrowser: "chrome",
expectedTargetMobileBrowser: nil,
expectedOtherBrowsers: []string{"edge", "firefox", "safari"},
expectedStartAt: time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC),
expectedEndAt: time.Date(2000, time.January, 10, 0, 0, 0, 0, time.UTC),
expectedPageSize: 100,
expectedPageToken: badPageToken,
page: nil,
pageToken: nil,
err: backendtypes.ErrInvalidPageToken,
},
expectedGetCalls: []*ExpectedGetCall{
{
Expand All @@ -309,6 +313,27 @@ func TestListMissingOneImplementationCounts(t *testing.T) {
"browser=edge&browser=firefox&browser=safari&"+
"startAt=2000-01-01&endAt=2000-01-10&page_token"+*badPageToken, nil),
},
{
name: "400 case - no matching mobile browser",
mockConfig: nil,
expectedGetCalls: []*ExpectedGetCall{
{
Key: `ListMissingOneImplementationCounts-{"browser":"edge","Params":{"startAt":"2000-01-01",` +
`"endAt":"2000-01-10","include_baseline_mobile_browsers":true,` +
`"browser":["chrome","firefox","safari"]}}`,
Value: nil,
Err: cachetypes.ErrCachedDataNotFound,
},
},
expectedCacheCalls: nil,
expectedCallCount: 0,
expectedResponse: testJSONResponse(400,
`{"code":400,"message":"browser does not have a matching mobile browser"}`),
request: httptest.NewRequest(http.MethodGet,
"/v1/stats/features/browsers/edge/missing_one_implementation_counts?"+
"browser=chrome&browser=firefox&browser=safari&"+
"startAt=2000-01-01&endAt=2000-01-10&include_baseline_mobile_browsers=true", nil),
},
}

for _, tc := range testCases {
Expand Down
88 changes: 83 additions & 5 deletions backend/pkg/httpserver/list_missing_one_implementation_features.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,98 @@ import (
"github.com/GoogleChrome/webstatus.dev/lib/gen/openapi/backend"
)

type MissingOneBrowserParams struct {
targetBrowser string
targetMobileBrowser *string
otherBrowsers []string
}

// GetDesktopsMobileProduct returns the mobile version of the given desktop browser.
func GetDesktopsMobileProduct(browser backend.BrowserPathParam) (backend.BrowserPathParam, error) {
switch browser {
case backend.Chrome:
return backend.ChromeAndroid, nil
case backend.Firefox:
return backend.FirefoxAndroid, nil
case backend.Safari:
return backend.SafariIos, nil
case backend.Edge, backend.ChromeAndroid, backend.FirefoxAndroid, backend.SafariIos:
return backend.BrowserPathParam(""), ErrNoMatchingMobileBrowser
}

return backend.BrowserPathParam(""), ErrNoMatchingMobileBrowser
}

// PrepareMissingOneBrowserParams takes the raw request arguments for "missing in one browser" requests
// and formats them.
func PrepareMissingOneBrowserParams(
targetBrowserParam backend.BrowserPathParam,
otherBrowsersParam []backend.BrowserPathParam,
includeMobileBrowsers bool,
) (*MissingOneBrowserParams, error) {
var otherBrowsers []string
var targetMobileBrowser *string
if includeMobileBrowsers {
var err error
matchingMobileBrowser, err := getDesktopsMobileProduct(targetBrowserParam)
if err != nil {
return nil, err
}
targetMobileBrowser = (*string)(&matchingMobileBrowser)

// Other browsers will include their mobile equivalents, so we'll need twice the size.
otherBrowsers = make([]string, len(otherBrowsersParam)*2)
var matchingMobileOtherBrowser backend.BrowserPathParam
for i := range otherBrowsersParam {
otherBrowsers[i*2] = string(otherBrowsersParam[i])
matchingMobileOtherBrowser, err = getDesktopsMobileProduct(otherBrowsersParam[i])
if err != nil {
return nil, err
}
otherBrowsers[i*2+1] = string(matchingMobileOtherBrowser)
}
} else {
otherBrowsers = make([]string, len(otherBrowsersParam))
for i := range otherBrowsersParam {
otherBrowsers[i] = string(otherBrowsersParam[i])
}
}

return &MissingOneBrowserParams{
targetBrowser: string(targetBrowserParam),
targetMobileBrowser: targetMobileBrowser,
otherBrowsers: otherBrowsers,
}, nil
}

// ListMissingOneImplementationFeatures implements backend.StrictServerInterface.
// nolint: ireturn // Signature generated from openapi
func (s *Server) ListMissingOneImplementationFeatures(
ctx context.Context,
request backend.ListMissingOneImplementationFeaturesRequestObject) (
backend.ListMissingOneImplementationFeaturesResponseObject, error) {
otherBrowsers := make([]string, len(request.Params.Browser))
for i := 0; i < len(request.Params.Browser); i++ {
otherBrowsers[i] = string(request.Params.Browser[i])

browserParams, err := PrepareMissingOneBrowserParams(
request.Browser, request.Params.Browser, request.Params.IncludeBaselineMobileBrowsers != nil)
if err != nil {
if errors.Is(err, ErrNoMatchingMobileBrowser) {
return backend.ListMissingOneImplementationFeatures400JSONResponse{
Code: 400,
Message: err.Error(),
}, nil
}

return backend.ListMissingOneImplementationFeatures500JSONResponse{
Code: 500,
Message: err.Error(),
}, nil
}

page, err := s.wptMetricsStorer.ListMissingOneImplementationFeatures(
ctx,
string(request.Browser),
otherBrowsers,
browserParams.targetBrowser,
browserParams.targetMobileBrowser,
browserParams.otherBrowsers,
request.Date.Time,
getPageSizeOrDefault(request.Params.PageSize),
request.Params.PageToken,
Expand Down
Loading