-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ListMissingOneImplCounts spanner method (#876)
This is the spanner method that will power the missing one implementation graph. It uses the pre calculated results from the BrowserFeatureSupportEvents table. Features: - It allows the caller to pass in arbitrary set of browsers to compare against. - It has a string pagination token that is decoded and used to continue paging for results - It returns the results in DESC order of the Release Date This method is similar to: 1. the [ListMetricsForFeatureIDBrowserAndChannel](https://github.com/GoogleChrome/webstatus.dev/blob/dd754efe5e2fa27cc80542fbacd41886e765b7ba/lib/gcpspanner/wpt_run_feature_metric.go#L418-L494) method used to get the results for the WPT metrics that power the chart on the feature detail, and 2. the [ListBrowserFeatureCountMetric](https://github.com/GoogleChrome/webstatus.dev/blob/dd754efe5e2fa27cc80542fbacd41886e765b7ba/lib/gcpspanner/browser_feature_count.go#L38C18-L105) method used to get the results for the feature count that power the chart on the stats page This PR is a split up of https://github.com/GoogleChrome/webstatus.dev/compare/missing-one-impl-count-db?expand=1 Fixes #864 Depends on #872
- Loading branch information
1 parent
d4efa85
commit 346acf3
Showing
2 changed files
with
892 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,224 @@ | ||
// Copyright 2024 Google LLC | ||
// | ||
// 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 gcpspanner | ||
|
||
import ( | ||
"context" | ||
"errors" | ||
"fmt" | ||
"time" | ||
|
||
"cloud.google.com/go/spanner" | ||
"google.golang.org/api/iterator" | ||
) | ||
|
||
func init() { | ||
missingOneImplTemplate = NewQueryTemplate(missingOneImplCountRawTemplate) | ||
} | ||
|
||
// nolint: gochecknoglobals // WONTFIX. Compile the template once at startup. Startup fails if invalid. | ||
var ( | ||
// missingOneImplTemplate is the compiled version of missingOneImplCountRawTemplate. | ||
missingOneImplTemplate BaseQueryTemplate | ||
) | ||
|
||
// MissingOneImplCountPage contains the details for the missing one implementation count request. | ||
type MissingOneImplCountPage struct { | ||
NextPageToken *string | ||
Metrics []MissingOneImplCount | ||
} | ||
|
||
// spannerMissingOneImplCount is a wrapper for the missing one implementation count. | ||
type spannerMissingOneImplCount struct { | ||
MissingOneImplCount | ||
} | ||
|
||
// MissingOneImplCount contains information regarding the count of features implemented in all other browsers but not | ||
// in the target browser. | ||
type MissingOneImplCount struct { | ||
EventReleaseDate time.Time `spanner:"EventReleaseDate"` | ||
Count int64 `spanner:"Count"` | ||
} | ||
|
||
// missingOneImplCursor: Represents a point for resuming queries based on the last | ||
// browser release date. Useful for pagination. | ||
type missingOneImplCursor struct { | ||
ReleaseDate time.Time `json:"release_date"` | ||
} | ||
|
||
// decodeMissingOneImplCursor provides a wrapper around the generic decodeCursor. | ||
func decodeMissingOneImplCursor(cursor string) (*missingOneImplCursor, error) { | ||
return decodeCursor[missingOneImplCursor](cursor) | ||
} | ||
|
||
// encodeMissingOneImplCursor provides a wrapper around the generic encodeCursor. | ||
func encodeMissingOneImplCursor(releaseDate time.Time) string { | ||
return encodeCursor(missingOneImplCursor{ | ||
ReleaseDate: releaseDate, | ||
}) | ||
} | ||
|
||
const missingOneImplCountRawTemplate = ` | ||
SELECT releases.EventReleaseDate, | ||
( | ||
SELECT COUNT(DISTINCT wf.ID) | ||
FROM WebFeatures wf | ||
LEFT JOIN BrowserFeatureSupportEvents bfse | ||
ON wf.ID = bfse.WebFeatureID | ||
AND bfse.TargetBrowserName = @targetBrowserParam | ||
AND bfse.EventReleaseDate = releases.EventReleaseDate | ||
AND bfse.SupportStatus = 'unsupported' -- Added condition | ||
WHERE bfse.WebFeatureID IS NOT NULL -- Feature is unsupported by the target browser | ||
AND {{range $browser := .OtherBrowserParamNames}} | ||
EXISTS ( | ||
SELECT 1 | ||
FROM BrowserFeatureSupportEvents bfse_other | ||
WHERE bfse_other.WebFeatureID = wf.ID | ||
AND bfse_other.SupportStatus = 'supported' | ||
AND bfse_other.TargetBrowserName = @{{ $browser }} | ||
AND bfse_other.EventReleaseDate = releases.EventReleaseDate | ||
) | ||
AND | ||
{{end}} | ||
1=1 | ||
) AS Count | ||
FROM ( | ||
SELECT DISTINCT EventReleaseDate | ||
FROM BrowserFeatureSupportEvents | ||
WHERE TargetBrowserName = @targetBrowserParam | ||
AND EventBrowserName IN UNNEST(@allBrowsersParam) | ||
) releases | ||
WHERE releases.EventReleaseDate >= @startAt | ||
AND releases.EventReleaseDate < @endAt | ||
{{if .ReleaseDateParam }} | ||
AND releases.EventReleaseDate < @{{ .ReleaseDateParam }} | ||
{{end}} | ||
ORDER BY releases.EventReleaseDate DESC | ||
LIMIT @limit; | ||
` | ||
|
||
type missingOneImplTemplateData struct { | ||
OtherBrowserParamNames []string | ||
ReleaseDateParam string | ||
} | ||
|
||
func buildMissingOneImplTemplate( | ||
cursor *missingOneImplCursor, | ||
targetBrowser string, | ||
otherBrowsers []string, | ||
startAt time.Time, | ||
endAt time.Time, | ||
pageSize int, | ||
) spanner.Statement { | ||
params := map[string]interface{}{} | ||
allBrowsers := make([]string, len(otherBrowsers)+1) | ||
copy(allBrowsers, otherBrowsers) | ||
allBrowsers[len(allBrowsers)-1] = targetBrowser | ||
params["targetBrowserParam"] = targetBrowser | ||
params["allBrowsersParam"] = allBrowsers | ||
otherBrowsersParamNames := make([]string, 0, len(otherBrowsers)) | ||
for i := range otherBrowsers { | ||
paramName := fmt.Sprintf("otherBrowser%d", i) | ||
params[paramName] = otherBrowsers[i] | ||
otherBrowsersParamNames = append(otherBrowsersParamNames, paramName) | ||
} | ||
params["limit"] = pageSize | ||
|
||
releaseDateParamName := "" | ||
if cursor != nil { | ||
releaseDateParamName = "releaseDateCursor" | ||
params[releaseDateParamName] = cursor.ReleaseDate | ||
} | ||
|
||
params["startAt"] = startAt | ||
params["endAt"] = endAt | ||
|
||
tmplData := missingOneImplTemplateData{ | ||
OtherBrowserParamNames: otherBrowsersParamNames, | ||
ReleaseDateParam: releaseDateParamName, | ||
} | ||
sql := missingOneImplTemplate.Execute(tmplData) | ||
stmt := spanner.NewStatement(sql) | ||
stmt.Params = params | ||
|
||
return stmt | ||
} | ||
|
||
func (c *Client) ListMissingOneImplCounts( | ||
ctx context.Context, | ||
targetBrowser string, | ||
otherBrowsers []string, | ||
startAt time.Time, | ||
endAt time.Time, | ||
pageSize int, | ||
pageToken *string, | ||
) (*MissingOneImplCountPage, error) { | ||
|
||
var cursor *missingOneImplCursor | ||
var err error | ||
if pageToken != nil { | ||
cursor, err = decodeMissingOneImplCursor(*pageToken) | ||
if err != nil { | ||
return nil, errors.Join(ErrInternalQueryFailure, err) | ||
} | ||
} | ||
|
||
txn := c.ReadOnlyTransaction() | ||
defer txn.Close() | ||
|
||
stmt := buildMissingOneImplTemplate( | ||
cursor, | ||
targetBrowser, | ||
otherBrowsers, | ||
startAt, | ||
endAt, | ||
pageSize, | ||
) | ||
|
||
it := txn.Query(ctx, stmt) | ||
defer it.Stop() | ||
|
||
var results []MissingOneImplCount | ||
for { | ||
row, err := it.Next() | ||
if errors.Is(err, iterator.Done) { | ||
break | ||
} | ||
if err != nil { | ||
return nil, err | ||
} | ||
var result spannerMissingOneImplCount | ||
if err := row.ToStruct(&result); err != nil { | ||
return nil, err | ||
} | ||
actualResult := MissingOneImplCount{ | ||
EventReleaseDate: result.EventReleaseDate, | ||
Count: result.Count, | ||
} | ||
results = append(results, actualResult) | ||
} | ||
|
||
page := MissingOneImplCountPage{ | ||
Metrics: results, | ||
NextPageToken: nil, | ||
} | ||
|
||
if len(results) == pageSize { | ||
token := encodeMissingOneImplCursor(results[len(results)-1].EventReleaseDate) | ||
page.NextPageToken = &token | ||
} | ||
|
||
return &page, nil | ||
} |
Oops, something went wrong.