Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add web vital metrics #836

Merged
merged 19 commits into from
Mar 29, 2023
Merged

Add web vital metrics #836

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
9372a00
Add the downloaded web vital js library
ankur22 Mar 23, 2023
840cc51
Refactor to use helper gojaValueExists
ankur22 Mar 23, 2023
ebce769
Add error to the method signatures
ankur22 Mar 23, 2023
519211a
Add implementation to page.evaluateOnNewDocument
ankur22 Mar 23, 2023
206f1fb
Add method on bCtx so page can apply init scripts
ankur22 Mar 23, 2023
e06b4d1
Add binding which will be used for web vitals
ankur22 Mar 23, 2023
af0baf4
Refactor NewBrowserContext to return error
ankur22 Mar 23, 2023
ff51716
Update to add web vital script via AddInitScript
ankur22 Mar 23, 2023
688616e
Add web vital init script
ankur22 Mar 23, 2023
90f9a53
Add the web vital metrics to the metrics registry
ankur22 Mar 27, 2023
a6bfe60
Add parse & emit of web vital metrics
ankur22 Mar 27, 2023
bd370fa
Remove first contentful paint cdp metric
ankur22 Mar 27, 2023
2ade4fb
Refactor error formatting
ankur22 Mar 28, 2023
3e7471c
Refactor the binding function name
ankur22 Mar 28, 2023
09a4050
Add a comment on why CLS uses the default metric
ankur22 Mar 28, 2023
54c094d
Remove the import of the wv module
ankur22 Mar 28, 2023
e4d42e3
Add test to check web vital scripts added
ankur22 Mar 28, 2023
65ab80a
Add custom metric sample chan in tests
ankur22 Mar 28, 2023
2eb7085
Add a web vital integration test
ankur22 Mar 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions common/browser_context.go
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The downside is that we will need to manually update this library, and users who do not update to latest k6 binary will be working with an outdated version of the library.

It's better to fixate on a single version rather than breaking our code when the original webvital js lib gets updated. So, to me, it's an upside :)

Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"time"

"github.com/grafana/xk6-browser/api"
"github.com/grafana/xk6-browser/common/js"
"github.com/grafana/xk6-browser/k6error"
"github.com/grafana/xk6-browser/k6ext"
"github.com/grafana/xk6-browser/log"
Expand Down Expand Up @@ -64,6 +65,8 @@ func NewBrowserContext(
b.GrantPermissions(opts.Permissions, nil)
}

b.evaluateOnNewDocumentSources = append(b.evaluateOnNewDocumentSources, js.WebVitalIIFEScript)

return &b
}

Expand Down
12 changes: 12 additions & 0 deletions common/js/web_vital.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package js

import (
_ "embed"
)

// WebVitalIIFEScript was downloaded from
// https://unpkg.com/web-vitals@3/dist/web-vitals.iife.js.
// Repo: https://github.com/GoogleChrome/web-vitals
//
//go:embed web_vital_iife.js
var WebVitalIIFEScript string
1 change: 1 addition & 0 deletions common/js/web_vital_iife.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.