Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 CircleCI
|
1cd3c0e883 |
No files matched your search
+68
-11
@@ -1,14 +1,71 @@
|
||||
version: 2.1
|
||||
setup: true
|
||||
|
||||
orbs:
|
||||
qqq-orb: kingsrook/qqq-orb@0.8
|
||||
qqq-orb: kingsrook/qqq-orb@0.6.8
|
||||
|
||||
commands:
|
||||
configure-package-install:
|
||||
steps:
|
||||
- run:
|
||||
name: Keep package installation unattended
|
||||
command: |
|
||||
# These build machines are discarded after the job.
|
||||
sudo install -d /etc/needrestart/conf.d
|
||||
printf '%s\n' '$nrconf{restart} = "l";' | sudo tee /etc/needrestart/conf.d/99-qqq-ci.conf >/dev/null
|
||||
|
||||
workflows:
|
||||
setup:
|
||||
jobs:
|
||||
- qqq-orb/generate_pipeline:
|
||||
orb_version: '0.8'
|
||||
filters:
|
||||
branches:
|
||||
ignore: automation/qbit-rc-pending
|
||||
tags:
|
||||
only: /^v\d+\.\d+\.\d+$/
|
||||
test_only:
|
||||
jobs:
|
||||
- qqq-orb/mvn_test_only:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
filters:
|
||||
branches:
|
||||
ignore: /(develop|release\/.*|hotfix\/.*)/
|
||||
|
||||
publish_snapshot:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
branch_type: snapshot
|
||||
filters:
|
||||
branches:
|
||||
only: [develop]
|
||||
|
||||
publish_release_candidate:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
branch_type: release_candidate
|
||||
filters:
|
||||
branches:
|
||||
only: [/release\/.*/]
|
||||
|
||||
publish_release:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
branch_type: release
|
||||
filters:
|
||||
branches:
|
||||
ignore: /.*/
|
||||
tags:
|
||||
only: [/^v\d+\.\d+\.\d+$/]
|
||||
|
||||
publish_hotfix_release:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
branch_type: hotfix
|
||||
filters:
|
||||
branches:
|
||||
only: [/hotfix\/.*/]
|
||||
@@ -1,7 +0,0 @@
|
||||
name: build
|
||||
on:
|
||||
push:
|
||||
jobs:
|
||||
maven:
|
||||
uses: self:KofTwentyTwo/ci-workflows/.gitea/workflows/maven.yaml@v1
|
||||
secrets: inherit
|
||||
@@ -1,23 +0,0 @@
|
||||
name: CodeQL
|
||||
'on':
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- develop
|
||||
- release/**
|
||||
- hotfix/**
|
||||
pull_request: {}
|
||||
schedule:
|
||||
- cron: 41 16 * * 0
|
||||
workflow_dispatch: {}
|
||||
permissions:
|
||||
contents: read
|
||||
actions: read
|
||||
security-events: write
|
||||
packages: read
|
||||
concurrency:
|
||||
group: codeql-${{ github.event.pull_request.number || github.ref }}
|
||||
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
|
||||
jobs:
|
||||
analyze:
|
||||
uses: QRun-IO/qqq-orb/.github/workflows/qbit-codeql.yml@c288a8864fe9054f68410e1d78f5863aea4c4d22
|
||||
@@ -1,74 +0,0 @@
|
||||
name: Release candidate
|
||||
'on':
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
dry_run:
|
||||
description: Plan a cut without changing release state
|
||||
type: boolean
|
||||
default: false
|
||||
finalize:
|
||||
description: Retry finalization of an existing cut; do not cut another RC
|
||||
type: boolean
|
||||
default: false
|
||||
recover:
|
||||
description: Recover the same published RC after a deployment timeout; never
|
||||
reupload
|
||||
type: boolean
|
||||
default: false
|
||||
circle_build:
|
||||
description: Original Circle publisher build number (recovery only)
|
||||
type: string
|
||||
default: ''
|
||||
merge_sha:
|
||||
description: Existing cut merge_sha (finalize retry only)
|
||||
type: string
|
||||
default: ''
|
||||
bump_sha:
|
||||
description: Existing cut bump_sha (finalize retry only)
|
||||
type: string
|
||||
default: ''
|
||||
branch:
|
||||
description: Existing cut branch (finalize retry only)
|
||||
type: string
|
||||
default: ''
|
||||
version:
|
||||
description: Existing cut version (finalize retry only)
|
||||
type: string
|
||||
default: ''
|
||||
pull_request:
|
||||
types:
|
||||
- closed
|
||||
branches:
|
||||
- develop
|
||||
repository_dispatch:
|
||||
types:
|
||||
- qbit-rc-published
|
||||
permissions:
|
||||
contents: write
|
||||
actions: read
|
||||
checks: read
|
||||
jobs:
|
||||
release-rc:
|
||||
if: github.event_name == 'workflow_dispatch' || github.event_name == 'repository_dispatch'
|
||||
|| (github.event_name == 'pull_request' && github.event.pull_request.merged
|
||||
== true && github.event.pull_request.base.ref == 'develop' && contains(github.event.pull_request.labels.*.name,
|
||||
'release:rc'))
|
||||
uses: QRun-IO/qqq-orb/.github/workflows/qbit-release-rc.yml@cc30f599e63c8e41629c99d23395bac1adb8bc44
|
||||
with:
|
||||
dry_run: ${{ github.event_name == 'workflow_dispatch' && inputs.dry_run || false
|
||||
}}
|
||||
finalize: ${{ github.event_name == 'repository_dispatch' || (github.event_name
|
||||
== 'workflow_dispatch' && inputs.finalize) }}
|
||||
recover: ${{ github.event_name == 'workflow_dispatch' && inputs.recover || false
|
||||
}}
|
||||
circle_build: ${{ github.event_name == 'workflow_dispatch' && inputs.circle_build
|
||||
|| '' }}
|
||||
merge_sha: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.merge_sha
|
||||
|| inputs.merge_sha || '' }}
|
||||
bump_sha: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.bump_sha
|
||||
|| inputs.bump_sha || '' }}
|
||||
branch: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.branch
|
||||
|| inputs.branch || '' }}
|
||||
version: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.version
|
||||
|| inputs.version || '' }}
|
||||
secrets: inherit
|
||||
-16
@@ -1,16 +0,0 @@
|
||||
profile: qbit
|
||||
orb_version: '0.8'
|
||||
default_branch: develop
|
||||
java_version: '21'
|
||||
browsers: true
|
||||
api_checks: false
|
||||
docs_only: false
|
||||
release_on_main: false
|
||||
release_tag_policy: stable
|
||||
test_branch_policy: non-release
|
||||
publish:
|
||||
snapshot: true
|
||||
release_candidate: true
|
||||
release: true
|
||||
asciidoc: false
|
||||
release_completion: true
|
||||
@@ -4,30 +4,5 @@ All notable changes to this project are documented here. The format follows Keep
|
||||
|
||||
## [0.1.0] - Unreleased
|
||||
|
||||
### Changed
|
||||
- The Performance home is business-only. The provider Setup readout and Recent Runs left the home's widget list (`WebPerfWidgets.HOME`); they are `WebPerfWidgets.ADMIN` (`Setup`, `RecentRuns`), gated to `<base>.admin.hasAccess` and hidden when denied, for a host to place on its Admin area. A new `NotConfigured` widget leads the home: while no Google API key is set it says "Page speed testing is not set up. Ask an admin to add a Google PageSpeed API key." (no config key names), and renders nothing once configured.
|
||||
|
||||
### Fixed
|
||||
- Read the QBit metadata version from the build so release artifacts report their actual version, matching the help bundle.
|
||||
- Use dropdowns for tier, scope, source, strategy, metric, comparator and severity, preserving existing stored values.
|
||||
- Allow manual Tested Pages inserts with a URL. Validate absolute HTTPS URLs and fill in the site, path and Manual source automatically; validate URL edits too.
|
||||
|
||||
### Added
|
||||
- Ship the host-neutral `help/qbit-web-performance.yaml` QBIT bundle, register it with QQQ help bundles, and enforce metadata coverage and live-reference validity with `WebPerfHelpBundleTest`. Keep app and table empty-state help available without Help installed.
|
||||
- Foreign keys for every reference between the QBit's tables (changesets 12-26): findings and reports cascade with their run, comparisons with their site change; optional pointers (likely cause, first and confirmation run, a run's site change) are set to NULL; tested pages and budgets with history cannot be deleted (disable them instead). Rows whose parent is already missing are recorded in `qqq_fk_quarantine`, then nulled or (NOT NULL columns, PostgreSQL) deleted, so the upgrade never fails. Foreign key columns are indexed. A PostgreSQL guardrail test fails when a new reference lacks its constraint.
|
||||
- Every `web_performance_*` table and the Performance app carry help saying what the table is for and how its rows get created (`help/qbit-web-performance.yaml`, applied by `WebPerfHelp`; host help is never overridden). A Setup card at the top of the home lists tested pages, the lab runner, budgets (reference defaults or your own) and Google field data, each with its state and next step, using the runtime's own resolution. `WebPerfTablesGuardrailTest` fails when a table is unused, unexplained or lacks that help; `WebPerfDefaultsChangelogTest` runs the shipped changelog and its seeded budgets through real Liquibase.
|
||||
- `reportRetentionDays` is now enforced: with a value above 0, Lighthouse Reports older than that many days are deleted after a result is stored, in batches, at most once an hour per process (runs, scores and findings stay). It was documented but nothing read it; the default 0 still keeps everything.
|
||||
- Record deploy and external site changes once, queue settled retests, and attribute lab runs to the observed build and CDN stage.
|
||||
- Evaluate enabled lab and URL CrUX budgets; retain breaches, confirmation evidence, automatic recovery and accurate open counts in the standard regression records.
|
||||
- Confirm statistical lab regressions with a median of three, reset baselines on Lighthouse major changes, and detect deterministic category/audit failures.
|
||||
- Add permission-gated Dismiss, Mark resolved and Compare before and after record actions with standard Review/Result summaries.
|
||||
- Store before/after lab medians, sample counts and windows, including measured TTFB; schedule CDN samples before launch and at one and 24 hours after launch.
|
||||
- Raise and resolve optional alerts through QQQ core, with logging fallback when no Alerts QBit is installed.
|
||||
|
||||
### Changed
|
||||
- Pin QQQ 4.1.0-RC.7 for the released help-bundle API.
|
||||
- Use QQQ 4.1.0-RC.6 for the core alerts API; add migration fields for durable evaluation and source-event identity.
|
||||
- Store complete run results atomically and retain confirmation/comparison identities when retrying samples.
|
||||
|
||||
### Previously added
|
||||
- First implementation; see README.md for the tables, permissions and configuration.
|
||||
@@ -13,19 +13,15 @@ Design and owner decisions: QRun-IO/qqq `docs/specs/2026-10-12-web-performance-d
|
||||
|
||||
## Status
|
||||
|
||||
The lab and Google field-data runners, queue, schedules, record actions and performance widgets are implemented. This change adds durable site changes, budget evaluation, confirmed lab regressions and before/after lab comparisons.
|
||||
This is a **skeleton (0.1.0-SNAPSHOT)**. It is local only, and the GitHub repository does not exist yet. It contains:
|
||||
|
||||
- Deploy probes run at startup through the scheduler and every five minutes. New build ids are recorded once per component, and KEY pages are queued after `deploySettleSeconds`. External `ChangeEventSource` events are deduplicated by source registration and their complete event tuple. Keep source registration order stable across restarts. Content events queue enabled pages after `publishSettleSeconds`, because the current SPI does not identify affected target ids.
|
||||
- Each run records the latest observed frontend build, hostname CDN stage and preceding site change when it starts. A rollback to an already recorded build updates its last observation without duplicating its change row.
|
||||
- Enabled LAB budgets match site, tier, target, content table or literal path prefix, plus strategy and metric. Comparators describe acceptable values. Breaches are recorded in Regressions with the budget id; there is no separate budget-check table in the design. The strongest matching severity wins. CRUX budgets evaluate URL p75 snapshots; NO_DATA, errors and origin fallback are never treated as page measurements.
|
||||
- Statistical lab baselines require five successful SCHEDULE, CONFIRM or SITE_AUDIT runs in the preceding 30 days on the same Lighthouse major version. Performance drops of 10 points, LCP increases of both 25% and 500 ms, CLS increases of 0.05, TBT increases of 200 ms, and budget breaches create suspected regressions. Two independent confirmation runs provide a median of three. Category drops of 5 points and newly failing Accessibility, Best Practices or SEO audits confirm immediately. Recovery requires a median of three later runs. Lighthouse major changes record a marker and reset incompatible baselines.
|
||||
- The page's open count includes suspected and confirmed regressions. **Dismiss** and **Mark resolved** require a note and `web_performance.manage.hasAccess`, use standard Review/Result summary lines, and preserve history.
|
||||
- **Compare before and after** uses three successful same-version lab samples on each side of a change, with page, sample counts and actual time windows. It stores Performance, LCP, FCP and measured TTFB when available. Results are also updated after attributed runs complete. CDN HEADERS_ONLY queues three samples per strategy; LIVE queues three at +1 hour and three at +24 hours. Insufficient history produces no invented comparison.
|
||||
- Confirmed regressions raise keyed `webperf.regression` alerts through QQQ core `QAlerts`; recovery, dismissal and manual resolution clear them. `ALERTS` can be disabled. Without an Alerts QBit, core uses its logging sink. No Alerts QBit dependency is required.
|
||||
- the producer and config, with validation and secret redaction
|
||||
- the nine `web_performance_` tables, their lookups and the Performance app
|
||||
- the host-included changelog, including the seeded budgets (D12)
|
||||
- the SPIs: `UrlSource`, `ContentResolver`, `LabRunner`, `DeployProbe`, `RumSource`, `ChangeEventSource`
|
||||
- two implementations that need no Google API key: `SitemapUrlSource` and `HttpBuildIdProbe`, which reads Website-Frontend's `/api/build`
|
||||
|
||||
Evaluation progress and related writes commit together. Retrying an evaluation does not duplicate incidents, and retrying a failed confirmation preserves its sample reference. The additive changelog must be applied before running the new worker. This version requires QQQ **4.1.0-RC.6** for the core alerts API.
|
||||
|
||||
RUM drift and RUM/country before-and-after comparisons remain separate work: the existing `RumSource` exposes fixed daily/28-day aggregates, not arbitrary before/after windows. Enum field metadata and Tested Pages insertion are also outside this change.
|
||||
Not built yet: the PSI and CrUX runners (they need the key), the queue worker, the schedules, the actions, the widgets, and the Alerts qbit producer integration.
|
||||
|
||||
## Install
|
||||
|
||||
@@ -48,17 +44,11 @@ The host owns the database. Include the QBit's changelog from the host's master
|
||||
- include: { file: db/liquibase/qbit-web-performance/web_performance.changelog.sql }
|
||||
```
|
||||
|
||||
## Tested pages and dropdowns
|
||||
|
||||
Add a manual tested page with an absolute HTTPS URL, an optional label, a tier and an enabled flag. The QBit fills in its site key, path and Manual source. URLs cannot contain credentials or fragments; URL edits use the same validation and update the path. Sitemap sync remains available for automatic discovery.
|
||||
|
||||
Tier, Scope, Source, Strategy, Metric, Comparator and Severity use dropdowns with plain labels and the existing stored values. Each table uses its own applicable choices. Existing seeded budgets need no migration.
|
||||
|
||||
## Tables
|
||||
|
||||
| Table | Written by | Notes |
|
||||
|---|---|---|
|
||||
| `web_performance_target` (Tested Pages) | sitemap sync, people | `url`, `label`, `tier` and `enabled` are editable; field-audited |
|
||||
| `web_performance_target` (Tested Pages) | sitemap sync, people | `label`, `tier` and `enabled` are editable; field-audited |
|
||||
| `web_performance_lab_run` (Lab Runs) | the QBit | read-only; one Lighthouse run |
|
||||
| `web_performance_lab_finding` (Findings) | the QBit | read-only; keyed by `(lighthouse_version, audit_id)` |
|
||||
| `web_performance_lab_report` (Lighthouse Reports) | the QBit | read-only; the gzipped PSI response, kept forever by default |
|
||||
@@ -68,22 +58,6 @@ Tier, Scope, Source, Strategy, Metric, Comparator and Severity use dropdowns wit
|
||||
| `web_performance_change_event` (Site Changes) | probes, other QBits | read-only |
|
||||
| `web_performance_comparison` (Before and After) | the QBit | read-only |
|
||||
|
||||
### Starter defaults and empty-state help
|
||||
|
||||
The changelog's changeset 10 seeds 13 reference budgets (Google's "good" thresholds and the Lighthouse category bands); nothing else is seeded. The target table is filled by Sync pages from sitemap, and the lab, finding, report, field, regression, change and comparison tables are filled by the qbit as it runs (empty is a normal start). Every table's help (`help/qbit-web-performance.yaml`, shown on the table screen) says how its rows get created, and the Setup card on the home shows what still needs doing. Budgets with source RUM are not evaluated yet (no real-user source is wired); LAB and CRUX budgets are.
|
||||
|
||||
## Scheduled audit quota
|
||||
|
||||
Set `withMaxRunsPerDay(300)` in the host configuration to reserve headroom below the default 500-run cap. Key-page schedules, full audits and manually queued runs share that daily allowance in the configured time zone. Scheduled requests prioritize page/device pairs never queued before, then those queued least recently. Quota-skipped rows do not advance that rotation, so large sitemaps continue through the remaining pairs on later days instead of repeatedly testing the first pages. Existing queued/running pairs still merge; manual selection keeps its requested order.
|
||||
|
||||
## In-app help
|
||||
|
||||
The QBit registers [`help/qbit-web-performance.yaml`](src/main/resources/help/qbit-web-performance.yaml) with QQQ help bundles (RC.7 or later). Registration is metadata-only; core skips startup synchronization when the host has no `helpContent` table. App and table empty-state help remains available without Help installed.
|
||||
|
||||
To override text, register your own uniquely named `layer: HOST` bundle with entries using the same keys and roles. HOST entries take precedence over QBIT entries; startup synchronization preserves administrator edits. Keep deployment-specific URLs, schedules and content-table actions in the host bundle. The shipped keys use the default metadata names; hosts that rename or namespace objects should provide help matching those names.
|
||||
|
||||
`WebPerfHelpBundleTest` checks owned metadata, live references and summary length with `HelpBundleAssertions`. Run it as part of `./mvnw verify`. The bundle version is the literal Maven project version; update it when changing the project version.
|
||||
|
||||
## Permissions
|
||||
|
||||
Tables and the app use `READ_WRITE_PERMISSIONS` with the base name `web_performance` (configurable), which gives `web_performance.read` and `web_performance.write`. Processes will add `web_performance.test`, `web_performance.manage` and `web_performance.admin` (design §8.1). No table stores a secret.
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# Upgrading
|
||||
|
||||
## Business-only home; admin widgets (unreleased)
|
||||
|
||||
No DDL change. The Setup and Recent Runs widgets are no longer on the Performance home. They are still registered (`webPerformanceSetup`, `webPerformanceRecentRuns`), gated to `web_performance.admin.hasAccess` and hidden without it; add `WebPerfWidgets.ADMIN` (qualified with `config.qualify`) to your Admin app's widgets to keep them. The home gains a `webPerformanceNotConfigured` widget that shows only while no Google API key is set.
|
||||
|
||||
## Table help, Setup card and `reportRetentionDays` (unreleased)
|
||||
|
||||
No DDL change, no new changeset and no host include change. The qbit now fills empty `help` slots on its app and tables (help a host set is kept) and adds a Setup widget to the Performance home. `reportRetentionDays` (default 0, keep forever) is now enforced: set it above 0 only if you want Lighthouse Reports older than that many days deleted.
|
||||
@@ -18,19 +18,16 @@
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
|
||||
<properties>
|
||||
<qqq.version>4.1.0-RC.26</qqq.version> <!-- feeds qbit-build-parent's qqq-bom-pom import -->
|
||||
<revision>0.1.0-SNAPSHOT</revision>
|
||||
<revision>0.1.0-RC.1</revision>
|
||||
<maven.compiler.source>21</maven.compiler.source>
|
||||
<maven.compiler.target>21</maven.compiler.target>
|
||||
<jacoco.version>0.8.15</jacoco.version>
|
||||
<liquibase.version>4.33.0</liquibase.version>
|
||||
<testcontainers.version>1.21.4</testcontainers.version>
|
||||
</properties>
|
||||
|
||||
<parent>
|
||||
<groupId>com.kingsrook</groupId>
|
||||
<artifactId>qbit-build-parent</artifactId>
|
||||
<version>2.2.1</version>
|
||||
<version>2.0.0</version>
|
||||
</parent>
|
||||
|
||||
<groupId>com.kingsrook.qbits</groupId>
|
||||
@@ -85,13 +82,6 @@
|
||||
<version>2.2.220</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<!-- WebPerfDefaultsChangelogTest runs the shipped changelog (with its seeded budgets) through real Liquibase. -->
|
||||
<dependency>
|
||||
<groupId>org.liquibase</groupId>
|
||||
<artifactId>liquibase-core</artifactId>
|
||||
<version>4.33.0</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
<artifactId>junit-jupiter</artifactId>
|
||||
@@ -103,63 +93,10 @@
|
||||
<version>3.27.7</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<!-- The foreign key guardrail runs the changelog with Liquibase on PostgreSQL (Docker). -->
|
||||
<dependency>
|
||||
<groupId>org.liquibase</groupId>
|
||||
<artifactId>liquibase-core</artifactId>
|
||||
<version>${liquibase.version}</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.postgresql</groupId>
|
||||
<artifactId>postgresql</artifactId>
|
||||
<version>42.7.14</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.testcontainers</groupId>
|
||||
<artifactId>postgresql</artifactId>
|
||||
<version>${testcontainers.version}</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.testcontainers</groupId>
|
||||
<artifactId>junit-jupiter</artifactId>
|
||||
<version>${testcontainers.version}</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
<resources>
|
||||
<!-- help bundles carry the artifact version (QQQ help bundle provenance) -->
|
||||
<resource>
|
||||
<directory>src/main/resources</directory>
|
||||
<filtering>true</filtering>
|
||||
<includes>
|
||||
<include>help/*.yaml</include>
|
||||
<include>qbit-web-performance.properties</include>
|
||||
</includes>
|
||||
</resource>
|
||||
<resource>
|
||||
<directory>src/main/resources</directory>
|
||||
<filtering>false</filtering>
|
||||
<excludes>
|
||||
<exclude>help/*.yaml</exclude>
|
||||
<exclude>qbit-web-performance.properties</exclude>
|
||||
</excludes>
|
||||
</resource>
|
||||
</resources>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-surefire-plugin</artifactId>
|
||||
<configuration>
|
||||
<systemPropertyVariables combine.children="append">
|
||||
<qbit.artifactVersion>${project.version}</qbit.artifactVersion>
|
||||
</systemPropertyVariables>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.jacoco</groupId>
|
||||
<artifactId>jacoco-maven-plugin</artifactId>
|
||||
@@ -206,14 +143,14 @@
|
||||
<profiles>
|
||||
<!-- Built against qqq 4.1 (QBitMetaDataProducer). Until qbit-build-parent -->
|
||||
<!-- imports the released 4.1 BOM, this profile is active by default and -->
|
||||
<!-- imports qqq-bom-pom 4.1.0-RC.7 ahead of the parent's 4.0.0 BOM. -->
|
||||
<!-- imports qqq-bom-pom 4.1.0-RC.4 ahead of the parent's 4.0.0 BOM. -->
|
||||
<profile>
|
||||
<id>qqq-snapshot</id>
|
||||
<activation>
|
||||
<activeByDefault>true</activeByDefault>
|
||||
</activation>
|
||||
<properties>
|
||||
<qqq.snapshot.version>4.1.0-RC.26</qqq.snapshot.version>
|
||||
<qqq.snapshot.version>4.1.0-RC.4</qqq.snapshot.version>
|
||||
</properties>
|
||||
<dependencyManagement>
|
||||
<dependencies>
|
||||
|
||||
@@ -21,17 +21,13 @@
|
||||
package com.kingsrook.qbits.webperf;
|
||||
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Properties;
|
||||
import com.kingsrook.qbits.webperf.metadata.WebPerfMetaData;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.logging.QLogger;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerMultiOutput;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.help.bundles.HelpBundles;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitMetaDataProducer;
|
||||
import com.kingsrook.qqq.backend.core.utils.StringUtils;
|
||||
@@ -65,41 +61,13 @@ public class WebPerfQBitProducer implements QBitMetaDataProducer<WebPerfQBitConf
|
||||
|
||||
public static final String GROUP_ID = "com.kingsrook.qbits";
|
||||
public static final String ARTIFACT_ID = "web-performance";
|
||||
public static final String VERSION = loadVersion();
|
||||
public static final String VERSION = "0.1.0";
|
||||
|
||||
private WebPerfQBitConfig qBitConfig;
|
||||
private String namespace;
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Read the artifact version from the Maven-filtered properties resource.
|
||||
*******************************************************************************/
|
||||
private static String loadVersion()
|
||||
{
|
||||
try(InputStream inputStream = WebPerfQBitProducer.class.getClassLoader().getResourceAsStream("qbit-web-performance.properties"))
|
||||
{
|
||||
if(inputStream == null)
|
||||
{
|
||||
throw (new IllegalStateException("Missing qbit-web-performance.properties; build with Maven to generate the artifact version"));
|
||||
}
|
||||
Properties properties = new Properties();
|
||||
properties.load(inputStream);
|
||||
String version = properties.getProperty("version");
|
||||
if(version == null || version.isBlank() || version.contains("${"))
|
||||
{
|
||||
throw (new IllegalStateException("Missing or unfiltered version in qbit-web-performance.properties; build with Maven"));
|
||||
}
|
||||
return (version);
|
||||
}
|
||||
catch(IOException e)
|
||||
{
|
||||
throw (new IllegalStateException("Could not read artifact version from qbit-web-performance.properties", e));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Fluent setter for the config.
|
||||
**
|
||||
@@ -223,9 +191,6 @@ public class WebPerfQBitProducer implements QBitMetaDataProducer<WebPerfQBitConf
|
||||
qInstance.addQBit(getQBitMetaData());
|
||||
new WebPerfRuntime(qBitConfig).addSelfToInstance(qInstance);
|
||||
new WebPerfMetaData(qBitConfig).addTo(qInstance);
|
||||
com.kingsrook.qbits.webperf.metadata.WebPerfHelp.apply(qInstance, qBitConfig);
|
||||
// Registration is metadata-only; core guards startup sync when helpContent is absent.
|
||||
HelpBundles.register(qInstance, "help/qbit-web-performance.yaml");
|
||||
|
||||
LOG.info("Web performance registered", logPair("tablePrefix", qBitConfig.getTableNamePrefix()), logPair("app", qBitConfig.getAppName()),
|
||||
logPair("siteBaseUrl", qBitConfig.getSiteBaseUrl()), logPair("features", qBitConfig.getFeatures()),
|
||||
|
||||
@@ -46,13 +46,7 @@ public class WebPerfRuntime implements QSupplementalInstanceMetaData
|
||||
public static final String NAME_PREFIX = "webPerformance.";
|
||||
public static final String INSTANCE_FIELD = "webPerformanceInstance";
|
||||
|
||||
/** At most one report-retention pass an hour per process; the first one waits so restarts and deploys do not each trigger a pass. */
|
||||
public static final long REPORT_PRUNE_INTERVAL_MILLIS = 60L * 60 * 1000;
|
||||
public static final long REPORT_PRUNE_FIRST_DELAY = 5L * 60 * 1000;
|
||||
|
||||
private final WebPerfQBitConfig config;
|
||||
private final java.util.concurrent.atomic.AtomicLong lastReportPruneMillis = new java.util.concurrent.atomic.AtomicLong(
|
||||
System.currentTimeMillis() - REPORT_PRUNE_INTERVAL_MILLIS + REPORT_PRUNE_FIRST_DELAY);
|
||||
|
||||
|
||||
|
||||
@@ -139,29 +133,6 @@ public class WebPerfRuntime implements QSupplementalInstanceMetaData
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Whether a report-retention pass is due; true for exactly one caller per
|
||||
** hour (shared by every worker of this process).
|
||||
*******************************************************************************/
|
||||
public boolean reportPruneDue()
|
||||
{
|
||||
long now = System.currentTimeMillis();
|
||||
long last = lastReportPruneMillis.get();
|
||||
return (now - last >= REPORT_PRUNE_INTERVAL_MILLIS && lastReportPruneMillis.compareAndSet(last, now));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** For tests: make the next reportPruneDue() true.
|
||||
*******************************************************************************/
|
||||
public void allowReportPruneNow()
|
||||
{
|
||||
lastReportPruneMillis.set(0);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The lab runner: the configured one, else PageSpeed Insights with the
|
||||
** Google API key, else null (no key: lab tests are off).
|
||||
|
||||
@@ -139,53 +139,6 @@ public final class LabResultParser
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Read a reported TTFB subpart from Lighthouse's LCP insight, never savings.
|
||||
*******************************************************************************/
|
||||
public static Integer ttfb(String json)
|
||||
{
|
||||
JSONObject root = new JSONObject(json);
|
||||
JSONObject lhr = root.optJSONObject("lighthouseResult");
|
||||
JSONObject audits = (lhr == null ? root : lhr).optJSONObject("audits");
|
||||
if(audits == null)
|
||||
{
|
||||
return (null);
|
||||
}
|
||||
for(String name : List.of("lcp-phases-insight", "lcp-breakdown-insight"))
|
||||
{
|
||||
JSONObject audit = audits.optJSONObject(name);
|
||||
JSONObject details = audit == null ? null : audit.optJSONObject("details");
|
||||
JSONArray items = details == null ? null : details.optJSONArray("items");
|
||||
if(items != null)
|
||||
{
|
||||
for(int i = 0; i < items.length(); i++)
|
||||
{
|
||||
JSONObject item = items.optJSONObject(i);
|
||||
if(item == null)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
JSONArray subparts = item.optJSONArray("items");
|
||||
if(subparts == null)
|
||||
{
|
||||
subparts = new JSONArray().put(item);
|
||||
}
|
||||
for(int j = 0; j < subparts.length(); j++)
|
||||
{
|
||||
JSONObject part = subparts.optJSONObject(j);
|
||||
if(part != null && "timeToFirstByte".equals(part.optString("subpart")) && part.opt("duration") instanceof Number duration)
|
||||
{
|
||||
return ((int) Math.round(duration.doubleValue()));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return (null);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Parser only.
|
||||
*******************************************************************************/
|
||||
|
||||
@@ -1,113 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* https://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 com.kingsrook.qbits.webperf.metadata;
|
||||
|
||||
|
||||
import java.net.URI;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
import com.kingsrook.qbits.webperf.WebPerfRuntime;
|
||||
import com.kingsrook.qbits.webperf.WebPerfSchema;
|
||||
import com.kingsrook.qqq.backend.core.actions.customizers.AbstractPreInsertCustomizer;
|
||||
import com.kingsrook.qqq.backend.core.actions.customizers.TableCustomizerInterface;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.model.statusmessages.BadInputStatusMessage;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Validate manually entered URLs and derive the fields used by sync and tests.
|
||||
*******************************************************************************/
|
||||
public class TargetCustomizer implements TableCustomizerInterface
|
||||
{
|
||||
/*******************************************************************************
|
||||
** Derive site identity before the unique site/URL check.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public AbstractPreInsertCustomizer.WhenToRun whenToRunPreInsert(InsertInput input, boolean isPreview)
|
||||
{
|
||||
return (AbstractPreInsertCustomizer.WhenToRun.BEFORE_ALL_VALIDATIONS);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Manual pages need only a URL, label, tier and enabled flag from the user.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public List<QRecord> preInsert(InsertInput input, List<QRecord> records, boolean isPreview)
|
||||
{
|
||||
validate(input.getTableName(), records, true);
|
||||
return (records);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Keep URL edits subject to the same validation and refresh their path.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public List<QRecord> preUpdate(UpdateInput input, List<QRecord> records, boolean isPreview, Optional<List<QRecord>> oldRecords)
|
||||
{
|
||||
validate(input.getTableName(), records, false);
|
||||
return (records);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Accept absolute HTTPS URLs without embedded credentials or fragments.
|
||||
*******************************************************************************/
|
||||
private void validate(String tableName, List<QRecord> records, boolean inserting)
|
||||
{
|
||||
String prefix = tableName.substring(0, tableName.length() - WebPerfSchema.TARGET.length());
|
||||
WebPerfRuntime runtime = WebPerfRuntime.of(QContext.getQInstance(), prefix);
|
||||
for(QRecord record : records)
|
||||
{
|
||||
if(!inserting && !record.getValues().containsKey("url"))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
String url = record.getValueString("url");
|
||||
try
|
||||
{
|
||||
URI uri = URI.create(url == null ? "" : url);
|
||||
if(!"https".equalsIgnoreCase(uri.getScheme()) || uri.getHost() == null || uri.getUserInfo() != null || uri.getFragment() != null)
|
||||
{
|
||||
throw (new IllegalArgumentException("Invalid page URL"));
|
||||
}
|
||||
record.setValue("path", uri.getPath().isEmpty() ? "/" : uri.getPath());
|
||||
if(inserting)
|
||||
{
|
||||
record.setValue("siteKey", runtime.service().siteKey());
|
||||
record.setValue("source", "MANUAL");
|
||||
record.setValue("inSitemap", false);
|
||||
}
|
||||
}
|
||||
catch(IllegalArgumentException e)
|
||||
{
|
||||
record.addError(new BadInputStatusMessage("URL must be an absolute HTTPS URL without credentials or a fragment."));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,138 +0,0 @@
|
||||
/*
|
||||
* Copyright 2026 Kingsrook, 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 com.kingsrook.qbits.webperf.metadata;
|
||||
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.Map;
|
||||
import com.fasterxml.jackson.databind.JsonNode;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
|
||||
import com.kingsrook.qbits.webperf.WebPerfQBitConfig;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.help.QHelpContent;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.layout.QAppMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Applies help/qbit-web-performance.yaml (the QQQ help-bundle format) to the
|
||||
** Performance app and its web_performance_* tables: what each table is for and
|
||||
** how its rows get created, shown on the table screen and when it is empty.
|
||||
** Keeps table and app empty-state help available even without the Help tables.
|
||||
** The producer also registers this resource with the core bundle registry.
|
||||
*******************************************************************************/
|
||||
public final class WebPerfHelp
|
||||
{
|
||||
public static final String RESOURCE = "/help/qbit-web-performance.yaml";
|
||||
public static final String SLOT = "help";
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Utility class.
|
||||
*******************************************************************************/
|
||||
private WebPerfHelp()
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The bundle's entries by key, validated (fails startup if malformed).
|
||||
*******************************************************************************/
|
||||
public static Map<String, JsonNode> entries() throws QException
|
||||
{
|
||||
try(InputStream stream = WebPerfHelp.class.getResourceAsStream(RESOURCE))
|
||||
{
|
||||
if(stream == null)
|
||||
{
|
||||
throw (new IOException("missing resource"));
|
||||
}
|
||||
JsonNode bundle = new ObjectMapper(new YAMLFactory()).readTree(stream);
|
||||
if(!"qbit-web-performance".equals(bundle.path("bundle").asText()) || !"QBIT".equals(bundle.path("layer").asText()))
|
||||
{
|
||||
throw (new IOException("invalid bundle header"));
|
||||
}
|
||||
Map<String, JsonNode> entries = new LinkedHashMap<>();
|
||||
for(JsonNode entry : bundle.path("entries"))
|
||||
{
|
||||
String key = entry.path("key").asText();
|
||||
if(!key.endsWith(";slot:help") || !(key.startsWith("table:") || key.startsWith("app:")))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
String summary = entry.path("summary").asText();
|
||||
if(key.isBlank() || summary.isBlank() || summary.length() > 120 || entry.path("content").asText().isBlank() || entries.put(key, entry) != null)
|
||||
{
|
||||
throw (new IOException("invalid or duplicate entry: " + key));
|
||||
}
|
||||
}
|
||||
return (entries);
|
||||
}
|
||||
catch(IOException | RuntimeException e)
|
||||
{
|
||||
throw (new QException("Could not load " + RESOURCE, e));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Apply the help to the app and every web_performance_* table in the instance
|
||||
** (names carry the config's prefix, if any). A host's own help on a table
|
||||
** is kept (the bundle only fills the slot).
|
||||
*******************************************************************************/
|
||||
public static void apply(QInstance qInstance, WebPerfQBitConfig config) throws QException
|
||||
{
|
||||
for(Map.Entry<String, JsonNode> entry : entries().entrySet())
|
||||
{
|
||||
String key = entry.getKey();
|
||||
String name = key.substring(key.indexOf(':') + 1, key.indexOf(';'));
|
||||
if(key.startsWith("table:"))
|
||||
{
|
||||
QTableMetaData table = qInstance.getTable(config.applyPrefix(name.startsWith(WebPerfQBitConfig.DEFAULT_TABLE_PREFIX) ? name.substring(WebPerfQBitConfig.DEFAULT_TABLE_PREFIX.length()) : name));
|
||||
if(table != null && (table.getHelpContent() == null || !table.getHelpContent().containsKey(SLOT)))
|
||||
{
|
||||
table.withHelpContent(SLOT, content(entry.getValue()));
|
||||
}
|
||||
}
|
||||
else if(key.startsWith("app:"))
|
||||
{
|
||||
QAppMetaData app = qInstance.getApp(config.getAppName());
|
||||
if(app != null && (app.getHelpContent() == null || !app.getHelpContent().containsKey(SLOT)))
|
||||
{
|
||||
app.withHelpContent(SLOT, content(entry.getValue()));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Summary as the first paragraph, then the content, as markdown.
|
||||
*******************************************************************************/
|
||||
static QHelpContent content(JsonNode entry)
|
||||
{
|
||||
return (new QHelpContent().withContentAsMarkdown(entry.path("summary").asText().strip() + "\n\n" + entry.path("content").asText().strip()));
|
||||
}
|
||||
|
||||
}
|
||||
@@ -26,37 +26,28 @@ import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import com.kingsrook.qbits.webperf.WebPerfFeature;
|
||||
import com.kingsrook.qbits.webperf.WebPerfQBitConfig;
|
||||
import com.kingsrook.qbits.webperf.WebPerfRuntime;
|
||||
import com.kingsrook.qbits.webperf.WebPerfSchema;
|
||||
import com.kingsrook.qbits.webperf.processes.WebPerfProcesses;
|
||||
import com.kingsrook.qbits.webperf.service.WebPerfEvaluationService;
|
||||
import com.kingsrook.qbits.webperf.widgets.WebPerfWidgets;
|
||||
import com.kingsrook.qqq.backend.core.actions.customizers.TableCustomizers;
|
||||
import com.kingsrook.qqq.backend.core.actions.dashboard.widgets.AbstractWidgetRenderer;
|
||||
import com.kingsrook.qqq.backend.core.alerts.AlertSeverity;
|
||||
import com.kingsrook.qqq.backend.core.alerts.AlertsInstanceMetaData;
|
||||
import com.kingsrook.qqq.backend.core.alerts.QAlertTypeMetaData;
|
||||
import com.kingsrook.qqq.backend.core.instances.QInstanceEnricher;
|
||||
import com.kingsrook.qqq.backend.core.model.dashboard.widgets.WidgetType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.dashboard.QWidgetMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QProcessMetaData;
|
||||
import com.kingsrook.qqq.backend.core.instances.QInstanceEnricher;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.audits.AuditLevel;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.audits.QAuditRules;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.dashboard.QWidgetMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.layout.QAppMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.layout.QAppSection;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.layout.QIcon;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.permissions.DenyBehavior;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.permissions.PermissionLevel;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValue;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSource;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QProcessMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSourceType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.Capability;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QFieldSection;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
@@ -74,7 +65,7 @@ import com.kingsrook.qqq.backend.module.rdbms.model.metadata.RDBMSTableBackendDe
|
||||
** comparisons, change events) are written only by the QBit's processes:
|
||||
** read-only in the UI and not audited.
|
||||
** - Tested pages and budgets are edited by people (enable a page, change a
|
||||
** budget): URLs are validated on insert/edit, and both are field-audited.
|
||||
** budget): only those fields are editable, and both are field-audited.
|
||||
** Regressions change status only through record actions (dismiss,
|
||||
** resolve), so they are read-only in the UI but field-audited.
|
||||
**
|
||||
@@ -107,16 +98,6 @@ public final class WebPerfMetaData
|
||||
*******************************************************************************/
|
||||
public void addTo(QInstance qInstance)
|
||||
{
|
||||
if(config.isOn(WebPerfFeature.ALERTS))
|
||||
{
|
||||
AlertsInstanceMetaData.ofOrWithNew(qInstance).withAlertType(
|
||||
new QAlertTypeMetaData()
|
||||
.withName(WebPerfEvaluationService.ALERT_TYPE)
|
||||
.withLabel("Web performance regression").withSourceQBitName("web-performance")
|
||||
.withDefaultSeverity(AlertSeverity.WARNING)
|
||||
.withSubjectTableName(config.applyPrefix(WebPerfSchema.REGRESSION))
|
||||
.withVisibilityPermission(config.getPermissionBaseName() + ".read"));
|
||||
}
|
||||
for(QTableMetaData table : tables().values())
|
||||
{
|
||||
qInstance.addTable(table);
|
||||
@@ -125,20 +106,16 @@ public final class WebPerfMetaData
|
||||
{
|
||||
qInstance.addPossibleValueSource(QPossibleValueSource.newForTable(config.applyPrefix(base)));
|
||||
}
|
||||
addEnumSources(qInstance);
|
||||
for(QProcessMetaData process : WebPerfProcesses.define(config, qInstance))
|
||||
{
|
||||
qInstance.addProcess(process);
|
||||
}
|
||||
addWidget(qInstance, WebPerfWidgets.NOT_CONFIGURED, "Page Speed Setup", WidgetType.HTML, WebPerfWidgets.NotConfigured.class);
|
||||
qInstance.getWidget(config.qualify(WebPerfWidgets.NOT_CONFIGURED)).setIsCard(false);
|
||||
addAdminWidget(qInstance, WebPerfWidgets.SETUP, "Page Speed Setup (Admin)", WebPerfWidgets.Setup.class);
|
||||
addWidget(qInstance, WebPerfWidgets.SITE_SCORES, "Site Scores", WidgetType.HTML, WebPerfWidgets.SiteScores.class);
|
||||
addWidget(qInstance, WebPerfWidgets.TREND, "Performance Trend", WidgetType.LINE_CHART, WebPerfWidgets.Trend.class);
|
||||
addWidget(qInstance, WebPerfWidgets.SLOWEST_PAGES, "Slowest Pages", WidgetType.HTML, WebPerfWidgets.SlowestPages.class);
|
||||
addWidget(qInstance, WebPerfWidgets.OPPORTUNITIES, "Top Opportunities", WidgetType.HTML, WebPerfWidgets.TopOpportunities.class);
|
||||
addWidget(qInstance, WebPerfWidgets.FIELD_STATUS, "Google Field Data", WidgetType.HTML, WebPerfWidgets.FieldDataStatus.class);
|
||||
addAdminWidget(qInstance, WebPerfWidgets.RECENT_RUNS, "Recent Runs", WebPerfWidgets.RecentRuns.class);
|
||||
addWidget(qInstance, WebPerfWidgets.RECENT_RUNS, "Recent Runs", WidgetType.HTML, WebPerfWidgets.RecentRuns.class);
|
||||
addWidget(qInstance, WebPerfWidgets.RECORD_PANEL, "Performance", WidgetType.HTML, WebPerfWidgets.RecordPanel.class);
|
||||
|
||||
List<String> panelTables = new ArrayList<>(config.getContentTables());
|
||||
@@ -159,88 +136,6 @@ public final class WebPerfMetaData
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Enumerated values retain the stored IDs used by runners and seeded budgets.
|
||||
*******************************************************************************/
|
||||
private void addEnumSources(QInstance qInstance)
|
||||
{
|
||||
addEnumSource(qInstance, "tier",
|
||||
new QPossibleValue<>("KEY", "Key page"),
|
||||
new QPossibleValue<>("STANDARD", "Standard page"));
|
||||
addEnumSource(qInstance, "target_source",
|
||||
new QPossibleValue<>("SITEMAP", "Sitemap"),
|
||||
new QPossibleValue<>("MANUAL", "Manual"),
|
||||
new QPossibleValue<>("CONTENT", "Content"));
|
||||
addEnumSource(qInstance, "strategy",
|
||||
new QPossibleValue<>("MOBILE", "Mobile"),
|
||||
new QPossibleValue<>("DESKTOP", "Desktop"));
|
||||
addEnumSource(qInstance, "strategy_or_form_factor",
|
||||
new QPossibleValue<>("MOBILE", "Mobile"),
|
||||
new QPossibleValue<>("DESKTOP", "Desktop"),
|
||||
new QPossibleValue<>("PHONE", "Phone"),
|
||||
new QPossibleValue<>("TABLET", "Tablet"),
|
||||
new QPossibleValue<>("ALL", "All devices"));
|
||||
addEnumSource(qInstance, "field_source",
|
||||
new QPossibleValue<>("CRUX_API", "CrUX API"),
|
||||
new QPossibleValue<>("CRUX_HISTORY", "CrUX history"),
|
||||
new QPossibleValue<>("PSI", "PageSpeed Insights"));
|
||||
addEnumSource(qInstance, "field_scope",
|
||||
new QPossibleValue<>("URL", "URL"),
|
||||
new QPossibleValue<>("ORIGIN", "Origin"));
|
||||
addEnumSource(qInstance, "budget_scope",
|
||||
new QPossibleValue<>("SITE", "Site"),
|
||||
new QPossibleValue<>("TIER", "Tier"),
|
||||
new QPossibleValue<>("TARGET", "Page"),
|
||||
new QPossibleValue<>("CONTENT_TABLE", "Content table"),
|
||||
new QPossibleValue<>("PATH_PREFIX", "Path prefix"));
|
||||
addEnumSource(qInstance, "measurement_source",
|
||||
new QPossibleValue<>("LAB", "Lab"),
|
||||
new QPossibleValue<>("RUM", "Real users"),
|
||||
new QPossibleValue<>("CRUX", "Google field data"));
|
||||
addEnumSource(qInstance, "comparison_source",
|
||||
new QPossibleValue<>("LAB", "Lab"),
|
||||
new QPossibleValue<>("RUM", "Real users"));
|
||||
addEnumSource(qInstance, "comparison_scope",
|
||||
new QPossibleValue<>("KEY", "Key pages"),
|
||||
new QPossibleValue<>("TARGET", "Page"),
|
||||
new QPossibleValue<>("SITE", "Site"));
|
||||
addEnumSource(qInstance, "change_source",
|
||||
new QPossibleValue<>("PROBE", "Probe"),
|
||||
new QPossibleValue<>("WEBHOOK", "Webhook"),
|
||||
new QPossibleValue<>("QBIT_CDN", "CDN"),
|
||||
new QPossibleValue<>("USER", "User"));
|
||||
addEnumSource(qInstance, "metric",
|
||||
new QPossibleValue<>("LCP", "LCP"),
|
||||
new QPossibleValue<>("INP", "INP"),
|
||||
new QPossibleValue<>("CLS", "CLS"),
|
||||
new QPossibleValue<>("FCP", "FCP"),
|
||||
new QPossibleValue<>("TTFB", "TTFB"),
|
||||
new QPossibleValue<>("TBT", "TBT"),
|
||||
new QPossibleValue<>("PERFORMANCE_SCORE", "Performance score"),
|
||||
new QPossibleValue<>("ACCESSIBILITY_SCORE", "Accessibility score"),
|
||||
new QPossibleValue<>("BEST_PRACTICES_SCORE", "Best practices score"),
|
||||
new QPossibleValue<>("SEO_SCORE", "SEO score"));
|
||||
addEnumSource(qInstance, "comparator",
|
||||
new QPossibleValue<>("<=", "At most"),
|
||||
new QPossibleValue<>(">=", "At least"));
|
||||
addEnumSource(qInstance, "severity",
|
||||
new QPossibleValue<>("WARNING", "Warning"),
|
||||
new QPossibleValue<>("CRITICAL", "Critical"));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Register an install-scoped dropdown with plain labels.
|
||||
*******************************************************************************/
|
||||
private void addEnumSource(QInstance qInstance, String name, QPossibleValue<?>... values)
|
||||
{
|
||||
qInstance.addPossibleValueSource(new QPossibleValueSource().withName(config.applyPrefix(name))
|
||||
.withType(QPossibleValueSourceType.ENUM).withEnumValues(List.of(values)));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A card widget, full width, carrying the install's prefix so its
|
||||
** renderer finds the runtime.
|
||||
@@ -261,20 +156,6 @@ public final class WebPerfMetaData
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A system widget for a host's Admin area (WebPerfWidgets.ADMIN): gated to
|
||||
** "<base>.admin.hasAccess" and HIDDEN, never a locked shell, when denied.
|
||||
*******************************************************************************/
|
||||
private void addAdminWidget(QInstance qInstance, String name, String label, Class<? extends AbstractWidgetRenderer> renderer)
|
||||
{
|
||||
addWidget(qInstance, name, label, WidgetType.HTML, renderer);
|
||||
qInstance.getWidget(config.qualify(name)).setPermissionRules(new QPermissionRules().withLevel(PermissionLevel.HAS_ACCESS_PERMISSION)
|
||||
.withPermissionBaseName(config.getPermissionBaseName() + ".admin")
|
||||
.withDenyBehavior(DenyBehavior.HIDDEN));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The Performance app: its one home (the widgets) and the data tables.
|
||||
** No process is in its nav.
|
||||
@@ -330,11 +211,11 @@ public final class WebPerfMetaData
|
||||
f("siteKey", QFieldType.STRING, "Site").withMaxLength(100),
|
||||
f("url", QFieldType.STRING, "URL").withMaxLength(1000).withIsRequired(true),
|
||||
f("path", QFieldType.STRING, "Path").withMaxLength(500),
|
||||
f("source", QFieldType.STRING, "Source").withPossibleValueSourceName(config.applyPrefix("target_source")).withMaxLength(20),
|
||||
f("source", QFieldType.STRING, "Source").withMaxLength(20),
|
||||
f("contentTable", QFieldType.STRING, "Content Table").withMaxLength(100),
|
||||
f("contentId", QFieldType.LONG, "Content Id"),
|
||||
f("label", QFieldType.STRING, "Label").withMaxLength(200),
|
||||
f("tier", QFieldType.STRING, "Tier").withPossibleValueSourceName(config.applyPrefix("tier")).withMaxLength(20).withDefaultValue("STANDARD"),
|
||||
f("tier", QFieldType.STRING, "Tier").withMaxLength(20).withDefaultValue("STANDARD"),
|
||||
f("enabled", QFieldType.BOOLEAN, "Enabled").withDefaultValue(true),
|
||||
f("inSitemap", QFieldType.BOOLEAN, "In Sitemap"),
|
||||
f("lastSeenInSitemapAt", QFieldType.DATE_TIME, "Last Seen in Sitemap"),
|
||||
@@ -345,9 +226,7 @@ public final class WebPerfMetaData
|
||||
f("openRegressionCount", QFieldType.INTEGER, "Open Regressions")));
|
||||
|
||||
QTableMetaData table = table(WebPerfSchema.TARGET, "Tested Pages", "travel_explore", fields, true,
|
||||
Set.of("url", "label", "tier", "enabled"))
|
||||
.withCustomizer(TableCustomizers.PRE_INSERT_RECORD, new QCodeReference(TargetCustomizer.class))
|
||||
.withCustomizer(TableCustomizers.PRE_UPDATE_RECORD, new QCodeReference(TargetCustomizer.class))
|
||||
Set.of("label", "tier", "enabled"))
|
||||
.withRecordLabelFormatAndFields("%s", "url")
|
||||
.withUniqueKey(new UniqueKey("siteKey", "url"))
|
||||
.withSection(section("page", "Page", "travel_explore", Tier.T1, "id", "url", "label", "tier", "enabled"))
|
||||
@@ -370,7 +249,7 @@ public final class WebPerfMetaData
|
||||
f("targetId", QFieldType.LONG, "Page").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.TARGET)),
|
||||
f("url", QFieldType.STRING, "URL").withMaxLength(1000),
|
||||
f("finalUrl", QFieldType.STRING, "Final URL").withMaxLength(1000),
|
||||
f("strategy", QFieldType.STRING, "Strategy").withPossibleValueSourceName(config.applyPrefix("strategy")).withMaxLength(10),
|
||||
f("strategy", QFieldType.STRING, "Strategy").withMaxLength(10),
|
||||
f("runner", QFieldType.STRING, "Runner").withMaxLength(20),
|
||||
f("triggerType", QFieldType.STRING, "Trigger").withMaxLength(20),
|
||||
f("triggerRef", QFieldType.STRING, "Trigger Reference").withMaxLength(200),
|
||||
@@ -398,10 +277,7 @@ public final class WebPerfMetaData
|
||||
f("lcpElement", QFieldType.STRING, "LCP Element").withMaxLength(300),
|
||||
f("runWarnings", QFieldType.STRING, "Warnings").withMaxLength(2000),
|
||||
f("deploymentId", QFieldType.STRING, "Frontend Build").withMaxLength(64),
|
||||
f("cdnStage", QFieldType.STRING, "CDN Stage").withMaxLength(20),
|
||||
f("ttfbMs", QFieldType.INTEGER, "TTFB (ms)"),
|
||||
f("evaluatedAt", QFieldType.DATE_TIME, "Evaluated"),
|
||||
f("changeEventId", QFieldType.LONG, "Site Change").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.CHANGE_EVENT))));
|
||||
f("cdnStage", QFieldType.STRING, "CDN Stage").withMaxLength(20)));
|
||||
|
||||
return (table(WebPerfSchema.LAB_RUN, "Lab Runs", "speed", fields, false, Set.of())
|
||||
.withRecordLabelFormatAndFields("%s %s", "strategy", "url")
|
||||
@@ -410,7 +286,7 @@ public final class WebPerfMetaData
|
||||
.withSection(section("metrics", "Lab Metrics", "timer", Tier.T2, "fcpMs", "lcpMs", "tbtMs", "cls", "speedIndexMs", "lcpElement"))
|
||||
.withSection(section("details", "Details", "info", Tier.T2, "targetId", "finalUrl", "runner", "triggerRef", "batchId", "notBefore",
|
||||
"queuedAt", "startedAt", "attempts", "httpStatus", "errorMessage", "lighthouseVersion", "chromeUserAgent", "benchmarkIndex",
|
||||
"runWarnings", "deploymentId", "cdnStage", "ttfbMs", "evaluatedAt", "changeEventId"))
|
||||
"runWarnings", "deploymentId", "cdnStage"))
|
||||
.withSection(dates()));
|
||||
}
|
||||
|
||||
@@ -424,7 +300,7 @@ public final class WebPerfMetaData
|
||||
List<QFieldMetaData> fields = withCommon(List.of(
|
||||
f("runId", QFieldType.LONG, "Run").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.LAB_RUN)),
|
||||
f("targetId", QFieldType.LONG, "Page").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.TARGET)),
|
||||
f("strategy", QFieldType.STRING, "Strategy").withPossibleValueSourceName(config.applyPrefix("strategy")).withMaxLength(10),
|
||||
f("strategy", QFieldType.STRING, "Strategy").withMaxLength(10),
|
||||
f("category", QFieldType.STRING, "Category").withMaxLength(20),
|
||||
f("auditId", QFieldType.STRING, "Audit").withMaxLength(100),
|
||||
f("lighthouseVersion", QFieldType.STRING, "Lighthouse Version").withMaxLength(20),
|
||||
@@ -474,8 +350,8 @@ public final class WebPerfMetaData
|
||||
QTableMetaData fieldSnapshot()
|
||||
{
|
||||
List<QFieldMetaData> fields = withCommon(List.of(
|
||||
f("source", QFieldType.STRING, "Source").withPossibleValueSourceName(config.applyPrefix("field_source")).withMaxLength(20),
|
||||
f("scope", QFieldType.STRING, "Scope").withPossibleValueSourceName(config.applyPrefix("field_scope")).withMaxLength(10),
|
||||
f("source", QFieldType.STRING, "Source").withMaxLength(20),
|
||||
f("scope", QFieldType.STRING, "Scope").withMaxLength(10),
|
||||
f("scopeKey", QFieldType.STRING, "URL or Origin").withMaxLength(1000),
|
||||
f("formFactor", QFieldType.STRING, "Form Factor").withMaxLength(10),
|
||||
f("status", QFieldType.STRING, "Status").withMaxLength(10),
|
||||
@@ -487,12 +363,11 @@ public final class WebPerfMetaData
|
||||
f("p75FcpMs", QFieldType.INTEGER, "FCP p75 (ms)"),
|
||||
f("p75TtfbMs", QFieldType.INTEGER, "TTFB p75 (ms)"),
|
||||
f("distributions", QFieldType.TEXT, "Distributions"),
|
||||
f("lastCheckedAt", QFieldType.DATE_TIME, "Last Checked"),
|
||||
f("evaluatedAt", QFieldType.DATE_TIME, "Evaluated")));
|
||||
f("lastCheckedAt", QFieldType.DATE_TIME, "Last Checked")));
|
||||
|
||||
return (table(WebPerfSchema.FIELD_SNAPSHOT, "Google Field Data", "public", fields, false, Set.of())
|
||||
.withRecordLabelFormatAndFields("%s %s", "scopeKey", "formFactor")
|
||||
.withSection(section("snapshot", "Snapshot", "public", Tier.T1, "id", "scopeKey", "scope", "formFactor", "status", "lastCheckedAt", "evaluatedAt"))
|
||||
.withSection(section("snapshot", "Snapshot", "public", Tier.T1, "id", "scopeKey", "scope", "formFactor", "status", "lastCheckedAt"))
|
||||
.withSection(section("p75", "p75 (28 days)", "insights", Tier.T2, "p75LcpMs", "p75InpMs", "p75Cls", "p75FcpMs", "p75TtfbMs",
|
||||
"periodStart", "periodEnd", "source", "distributions"))
|
||||
.withSection(dates()));
|
||||
@@ -507,14 +382,14 @@ public final class WebPerfMetaData
|
||||
{
|
||||
List<QFieldMetaData> fields = withCommon(List.of(
|
||||
f("name", QFieldType.STRING, "Name").withMaxLength(200).withIsRequired(true),
|
||||
f("scope", QFieldType.STRING, "Scope").withPossibleValueSourceName(config.applyPrefix("budget_scope")).withMaxLength(20),
|
||||
f("scope", QFieldType.STRING, "Scope").withMaxLength(20),
|
||||
f("scopeValue", QFieldType.STRING, "Scope Value").withMaxLength(500),
|
||||
f("source", QFieldType.STRING, "Source").withPossibleValueSourceName(config.applyPrefix("measurement_source")).withMaxLength(10),
|
||||
f("strategy", QFieldType.STRING, "Strategy").withPossibleValueSourceName(config.applyPrefix("strategy")).withMaxLength(10),
|
||||
f("metric", QFieldType.STRING, "Metric").withPossibleValueSourceName(config.applyPrefix("metric")).withMaxLength(30),
|
||||
f("comparator", QFieldType.STRING, "Comparator").withPossibleValueSourceName(config.applyPrefix("comparator")).withMaxLength(5),
|
||||
f("source", QFieldType.STRING, "Source").withMaxLength(10),
|
||||
f("strategy", QFieldType.STRING, "Strategy").withMaxLength(10),
|
||||
f("metric", QFieldType.STRING, "Metric").withMaxLength(30),
|
||||
f("comparator", QFieldType.STRING, "Comparator").withMaxLength(5),
|
||||
f("threshold", QFieldType.DECIMAL, "Threshold"),
|
||||
f("severity", QFieldType.STRING, "Severity").withPossibleValueSourceName(config.applyPrefix("severity")).withMaxLength(10),
|
||||
f("severity", QFieldType.STRING, "Severity").withMaxLength(10),
|
||||
f("enabled", QFieldType.BOOLEAN, "Enabled"),
|
||||
f("seeded", QFieldType.BOOLEAN, "Seeded")));
|
||||
|
||||
@@ -537,33 +412,29 @@ public final class WebPerfMetaData
|
||||
f("targetId", QFieldType.LONG, "Page").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.TARGET)),
|
||||
f("contentTable", QFieldType.STRING, "Content Table").withMaxLength(100),
|
||||
f("contentId", QFieldType.LONG, "Content Id"),
|
||||
f("source", QFieldType.STRING, "Source").withPossibleValueSourceName(config.applyPrefix("measurement_source")).withMaxLength(10),
|
||||
f("strategy", QFieldType.STRING, "Strategy or Form Factor").withPossibleValueSourceName(config.applyPrefix("strategy_or_form_factor")).withMaxLength(10),
|
||||
f("metric", QFieldType.STRING, "Metric").withPossibleValueSourceName(config.applyPrefix("metric")).withMaxLength(30),
|
||||
f("source", QFieldType.STRING, "Source").withMaxLength(10),
|
||||
f("strategy", QFieldType.STRING, "Strategy or Form Factor").withMaxLength(10),
|
||||
f("metric", QFieldType.STRING, "Metric").withMaxLength(30),
|
||||
f("baselineValue", QFieldType.DECIMAL, "Baseline"),
|
||||
f("baselineRef", QFieldType.STRING, "Baseline From").withMaxLength(500),
|
||||
f("currentValue", QFieldType.DECIMAL, "Current"),
|
||||
f("currentRef", QFieldType.STRING, "Current From").withMaxLength(500),
|
||||
f("delta", QFieldType.DECIMAL, "Change"),
|
||||
f("budgetId", QFieldType.LONG, "Budget").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.BUDGET)),
|
||||
f("severity", QFieldType.STRING, "Severity").withPossibleValueSourceName(config.applyPrefix("severity")).withMaxLength(10),
|
||||
f("severity", QFieldType.STRING, "Severity").withMaxLength(10),
|
||||
f("status", QFieldType.STRING, "Status").withMaxLength(20),
|
||||
f("causeChangeEventId", QFieldType.LONG, "Likely Cause").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.CHANGE_EVENT)),
|
||||
f("detectedAt", QFieldType.DATE_TIME, "Detected"),
|
||||
f("confirmedAt", QFieldType.DATE_TIME, "Confirmed"),
|
||||
f("resolvedAt", QFieldType.DATE_TIME, "Resolved"),
|
||||
f("resolutionNote", QFieldType.STRING, "Resolution Note").withMaxLength(2000),
|
||||
f("firstRunId", QFieldType.LONG, "First Run").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.LAB_RUN)),
|
||||
f("checkpointRunId", QFieldType.LONG, "Confirmation Run").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.LAB_RUN)),
|
||||
f("lighthouseMajor", QFieldType.STRING, "Lighthouse Major").withMaxLength(20),
|
||||
f("failedAudits", QFieldType.STRING, "Newly Failing Audits").withMaxLength(2000)));
|
||||
f("resolutionNote", QFieldType.STRING, "Resolution Note").withMaxLength(2000)));
|
||||
|
||||
return (table(WebPerfSchema.REGRESSION, "Regressions", "trending_down", fields, true, Set.of())
|
||||
.withRecordLabelFormatAndFields("%s %s", "metric", "status")
|
||||
.withSection(section("regression", "Regression", "trending_down", Tier.T1, "id", "targetId", "metric", "strategy", "baselineValue",
|
||||
"currentValue", "delta", "severity", "status"))
|
||||
.withSection(section("details", "Details", "info", Tier.T2, "source", "contentTable", "contentId", "baselineRef", "currentRef",
|
||||
"budgetId", "causeChangeEventId", "detectedAt", "confirmedAt", "resolvedAt", "resolutionNote", "firstRunId", "checkpointRunId", "lighthouseMajor", "failedAudits"))
|
||||
"budgetId", "causeChangeEventId", "detectedAt", "confirmedAt", "resolvedAt", "resolutionNote"))
|
||||
.withSection(dates()));
|
||||
}
|
||||
|
||||
@@ -580,16 +451,13 @@ public final class WebPerfMetaData
|
||||
f("fromValue", QFieldType.STRING, "From").withMaxLength(200),
|
||||
f("toValue", QFieldType.STRING, "To").withMaxLength(200),
|
||||
f("observedAt", QFieldType.DATE_TIME, "Observed"),
|
||||
f("source", QFieldType.STRING, "Source").withPossibleValueSourceName(config.applyPrefix("change_source")).withMaxLength(20),
|
||||
f("note", QFieldType.STRING, "Note").withMaxLength(2000),
|
||||
f("lastSeenAt", QFieldType.DATE_TIME, "Last Observed"),
|
||||
f("eventKey", QFieldType.STRING, "Source Event Key").withMaxLength(64),
|
||||
f("siteKey", QFieldType.STRING, "Site").withMaxLength(200)));
|
||||
f("source", QFieldType.STRING, "Source").withMaxLength(20),
|
||||
f("note", QFieldType.STRING, "Note").withMaxLength(2000)));
|
||||
|
||||
return (table(WebPerfSchema.CHANGE_EVENT, "Site Changes", "change_circle", fields, false, Set.of())
|
||||
.withRecordLabelFormatAndFields("%s %s", "kind", "toValue")
|
||||
.withSection(section("change", "Change", "change_circle", Tier.T1, "id", "kind", "component", "fromValue", "toValue", "observedAt",
|
||||
"source", "note", "lastSeenAt", "eventKey", "siteKey"))
|
||||
"source", "note"))
|
||||
.withSection(dates()));
|
||||
}
|
||||
|
||||
@@ -602,11 +470,10 @@ public final class WebPerfMetaData
|
||||
{
|
||||
List<QFieldMetaData> fields = withCommon(List.of(
|
||||
f("changeEventId", QFieldType.LONG, "Change").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.CHANGE_EVENT)),
|
||||
f("targetId", QFieldType.LONG, "Page").withPossibleValueSourceName(config.applyPrefix(WebPerfSchema.TARGET)),
|
||||
f("scope", QFieldType.STRING, "Scope").withPossibleValueSourceName(config.applyPrefix("comparison_scope")).withMaxLength(20),
|
||||
f("source", QFieldType.STRING, "Source").withPossibleValueSourceName(config.applyPrefix("comparison_source")).withMaxLength(10),
|
||||
f("strategy", QFieldType.STRING, "Strategy or Form Factor").withPossibleValueSourceName(config.applyPrefix("strategy_or_form_factor")).withMaxLength(10),
|
||||
f("metric", QFieldType.STRING, "Metric").withPossibleValueSourceName(config.applyPrefix("metric")).withMaxLength(30),
|
||||
f("scope", QFieldType.STRING, "Scope").withMaxLength(20),
|
||||
f("source", QFieldType.STRING, "Source").withMaxLength(10),
|
||||
f("strategy", QFieldType.STRING, "Strategy or Form Factor").withMaxLength(10),
|
||||
f("metric", QFieldType.STRING, "Metric").withMaxLength(30),
|
||||
f("segment", QFieldType.STRING, "Segment").withMaxLength(100),
|
||||
f("beforeValue", QFieldType.DECIMAL, "Before"),
|
||||
f("beforeN", QFieldType.INTEGER, "Before n"),
|
||||
@@ -619,7 +486,7 @@ public final class WebPerfMetaData
|
||||
|
||||
return (table(WebPerfSchema.COMPARISON, "Before and After", "compare_arrows", fields, false, Set.of())
|
||||
.withRecordLabelFormatAndFields("%s %s", "metric", "segment")
|
||||
.withSection(section("comparison", "Comparison", "compare_arrows", Tier.T1, "id", "changeEventId", "targetId", "metric", "segment", "beforeValue",
|
||||
.withSection(section("comparison", "Comparison", "compare_arrows", Tier.T1, "id", "changeEventId", "metric", "segment", "beforeValue",
|
||||
"afterValue", "delta", "deltaPct"))
|
||||
.withSection(section("details", "Details", "info", Tier.T2, "scope", "source", "strategy", "beforeN", "beforeWindow", "afterN",
|
||||
"afterWindow"))
|
||||
|
||||
@@ -1,276 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* https://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 com.kingsrook.qbits.webperf.processes;
|
||||
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.time.Instant;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import com.kingsrook.qbits.webperf.WebPerfRuntime;
|
||||
import com.kingsrook.qbits.webperf.service.WebPerfComparisonService;
|
||||
import com.kingsrook.qbits.webperf.service.WebPerfEvaluationService;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLine;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLineInterface;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.Status;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractLoadStep;
|
||||
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractTransformStep;
|
||||
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.ProcessSummaryProviderInterface;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Standard streamed Review/Result actions for regression status and comparisons.
|
||||
*******************************************************************************/
|
||||
public final class RegressionSteps
|
||||
{
|
||||
public static final String NOTE = "resolutionNote";
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Steps only.
|
||||
*******************************************************************************/
|
||||
private RegressionSteps()
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Review open records; closed records are explicitly skipped.
|
||||
*******************************************************************************/
|
||||
public static class Transform extends AbstractTransformStep implements ProcessSummaryProviderInterface
|
||||
{
|
||||
private ProcessSummaryLine change;
|
||||
private final ProcessSummaryLine skip = Lines.line(Status.INFO, "closed regression will be skipped", "closed regressions will be skipped",
|
||||
"closed regression was skipped", "closed regressions were skipped");
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Validate the note and classify this page without writing anything.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public void runOnePage(RunBackendStepInput input, RunBackendStepOutput output) throws QException
|
||||
{
|
||||
String status = input.getValueString(WebPerfProcesses.TRIGGER_FIELD);
|
||||
String note = input.getValueString(NOTE);
|
||||
if(note == null || note.isBlank() || note.length() > 2000)
|
||||
{
|
||||
throw (new QException("Enter a resolution note of 1 to 2000 characters"));
|
||||
}
|
||||
if(change == null)
|
||||
{
|
||||
String verb = "DISMISSED".equals(status) ? "dismissed" : "marked resolved";
|
||||
change = Lines.line(Status.OK, "regression will be " + verb, "regressions will be " + verb,
|
||||
"regression was " + verb, "regressions were " + verb);
|
||||
}
|
||||
for(QRecord record : input.getRecords())
|
||||
{
|
||||
if(List.of("SUSPECTED", "CONFIRMED").contains(record.getValueString("status")))
|
||||
{
|
||||
change.incrementCountAndAddPrimaryKey(record.getValue("id"));
|
||||
output.addRecord(record);
|
||||
}
|
||||
else
|
||||
{
|
||||
skip.incrementCountAndAddPrimaryKey(record.getValue("id"));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Review summary.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean result)
|
||||
{
|
||||
ArrayList<ProcessSummaryLineInterface> lines = new ArrayList<>();
|
||||
if(change != null)
|
||||
{
|
||||
Lines.addAll(lines, change);
|
||||
}
|
||||
Lines.addAll(lines, skip);
|
||||
return (lines);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Apply the requested state under a database lock, rechecking eligibility.
|
||||
*******************************************************************************/
|
||||
public static class Load extends AbstractLoadStep implements ProcessSummaryProviderInterface
|
||||
{
|
||||
private ProcessSummaryLine changed;
|
||||
private final ProcessSummaryLine skipped = Lines.line(Status.INFO, "regression will be skipped", "regressions will be skipped",
|
||||
"regression was already closed", "regressions were already closed");
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Apply one page and report only the rows actually changed.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public void runOnePage(RunBackendStepInput input, RunBackendStepOutput output) throws QException
|
||||
{
|
||||
String status = input.getValueString(WebPerfProcesses.TRIGGER_FIELD);
|
||||
if(changed == null)
|
||||
{
|
||||
String verb = "DISMISSED".equals(status) ? "dismissed" : "marked resolved";
|
||||
changed = Lines.line(Status.OK, "regression will be " + verb, "regressions will be " + verb,
|
||||
"regression was " + verb, "regressions were " + verb);
|
||||
}
|
||||
WebPerfEvaluationService service = new WebPerfEvaluationService(WebPerfRuntime.forInput(input).store());
|
||||
try
|
||||
{
|
||||
for(QRecord record : input.getRecords())
|
||||
{
|
||||
boolean updated = service.finishRegression(record.getValueLong("id"), status, input.getValueString(NOTE), Instant.now());
|
||||
(updated ? changed : skipped).incrementCountAndAddPrimaryKey(record.getValue("id"));
|
||||
}
|
||||
}
|
||||
catch(SQLException | IllegalArgumentException e)
|
||||
{
|
||||
throw (new QException("Could not update the regressions", e));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Result summary.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean result)
|
||||
{
|
||||
ArrayList<ProcessSummaryLineInterface> lines = new ArrayList<>();
|
||||
if(changed != null)
|
||||
{
|
||||
Lines.addAll(lines, changed);
|
||||
}
|
||||
Lines.addAll(lines, skipped);
|
||||
if(getTransformStep() instanceof Transform transform)
|
||||
{
|
||||
Lines.addAll(lines, transform.skip);
|
||||
}
|
||||
return (lines);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Review comparisons using recorded lab history.
|
||||
*******************************************************************************/
|
||||
public static class CompareTransform extends AbstractTransformStep implements ProcessSummaryProviderInterface
|
||||
{
|
||||
private final ProcessSummaryLine changes = Lines.line(Status.OK, "site change will be compared using recorded lab samples",
|
||||
"site changes will be compared using recorded lab samples", "site change was compared", "site changes were compared");
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Pass through a bounded page of selected changes.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public void runOnePage(RunBackendStepInput input, RunBackendStepOutput output) throws QException
|
||||
{
|
||||
for(QRecord record : input.getRecords())
|
||||
{
|
||||
changes.incrementCountAndAddPrimaryKey(record.getValue("id"));
|
||||
output.addRecord(record);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Review summary.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean result)
|
||||
{
|
||||
ArrayList<ProcessSummaryLineInterface> lines = new ArrayList<>();
|
||||
Lines.addAll(lines, changes);
|
||||
return (lines);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Write comparisons when both sides have three comparable measurements.
|
||||
*******************************************************************************/
|
||||
public static class CompareLoad extends AbstractLoadStep implements ProcessSummaryProviderInterface
|
||||
{
|
||||
private final ProcessSummaryLine compared = Lines.line(Status.OK, "comparison will be recorded", "comparisons will be recorded",
|
||||
"comparison was recorded", "comparisons were recorded");
|
||||
private final ProcessSummaryLine insufficient = Lines.line(Status.INFO, "change needs more samples", "changes need more samples",
|
||||
"change had fewer than three comparable samples on each side", "changes had fewer than three comparable samples on each side");
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Compute and persist this page of selected changes.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public void runOnePage(RunBackendStepInput input, RunBackendStepOutput output) throws QException
|
||||
{
|
||||
try
|
||||
{
|
||||
WebPerfComparisonService service = new WebPerfComparisonService(WebPerfRuntime.forInput(input).store());
|
||||
for(QRecord record : input.getRecords())
|
||||
{
|
||||
int count = service.compare(record.getValueLong("id"));
|
||||
compared.incrementCount(count);
|
||||
if(count == 0)
|
||||
{
|
||||
insufficient.incrementCountAndAddPrimaryKey(record.getValue("id"));
|
||||
}
|
||||
}
|
||||
}
|
||||
catch(SQLException e)
|
||||
{
|
||||
throw (new QException("Could not compare the site changes", e));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Result summary, including an honest insufficient-history line.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean result)
|
||||
{
|
||||
ArrayList<ProcessSummaryLineInterface> lines = new ArrayList<>();
|
||||
Lines.addAll(lines, compared, insufficient);
|
||||
return (lines);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -144,23 +144,8 @@ public final class RetryRunsSteps
|
||||
String batch = java.util.UUID.randomUUID().toString();
|
||||
for(QRecord record : input.getRecords())
|
||||
{
|
||||
if(List.of("CONFIRM", "CHANGE_COMPARE").contains(record.getValueString("triggerType")))
|
||||
{
|
||||
try
|
||||
{
|
||||
String status = service.retrySample(record.getValueLong("id"), Instant.now());
|
||||
("QUEUED".equals(status) ? queued : "MERGED".equals(status) ? merged : capped).incrementCount(1);
|
||||
}
|
||||
catch(SQLException e)
|
||||
{
|
||||
throw (new QException("Could not retry the measurement sample", e));
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
requests.add(new WebPerfService.RunRequest(record.getValueLong("targetId"), record.getValueString("url"), record.getValueString("strategy"),
|
||||
"MANUAL", "retry of run " + record.getValue("id"), batch, Instant.now()));
|
||||
}
|
||||
requests.add(new WebPerfService.RunRequest(record.getValueLong("targetId"), record.getValueString("url"), record.getValueString("strategy"),
|
||||
"MANUAL", "retry of run " + record.getValue("id"), batch, Instant.now()));
|
||||
}
|
||||
try
|
||||
{
|
||||
|
||||
@@ -25,7 +25,6 @@ import java.time.Instant;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qbits.webperf.WebPerfRuntime;
|
||||
import com.kingsrook.qbits.webperf.service.WebPerfChangeService;
|
||||
import com.kingsrook.qbits.webperf.service.WebPerfService;
|
||||
import com.kingsrook.qqq.backend.core.actions.processes.BackendStep;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
@@ -55,30 +54,6 @@ public final class ScheduledSteps
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Poll deploy probes and external change sources on the existing scheduler.
|
||||
*******************************************************************************/
|
||||
public static class ProbeChanges implements BackendStep
|
||||
{
|
||||
/*******************************************************************************
|
||||
** Store changes and queue the affected pages.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public void run(RunBackendStepInput input, RunBackendStepOutput output) throws QException
|
||||
{
|
||||
try
|
||||
{
|
||||
new WebPerfChangeService(WebPerfRuntime.forInput(input).store()).poll(Instant.now());
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
throw (new QException("Checking site changes failed", e));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Every minute: run due queued tests.
|
||||
*******************************************************************************/
|
||||
@@ -209,8 +184,7 @@ public final class ScheduledSteps
|
||||
try
|
||||
{
|
||||
WebPerfService service = WebPerfRuntime.forInput(input).service();
|
||||
Instant now = Instant.now();
|
||||
WebPerfService.QueuePlan plan = service.enqueue(service.scheduledRequests(keyOnly, reason, now), now);
|
||||
WebPerfService.QueuePlan plan = service.enqueue(service.requestsFor(service.enabledTargets(keyOnly), "SCHEDULE", reason, Instant.now()), Instant.now());
|
||||
LOG.info("Web performance tests queued", logPair("reason", reason), logPair("queued", plan.queue().size()), logPair("merged", plan.merged().size()),
|
||||
logPair("overCap", plan.overQuota().size()));
|
||||
}
|
||||
|
||||
@@ -37,7 +37,6 @@ import com.kingsrook.qqq.backend.core.model.metadata.permissions.PermissionLevel
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QBackendStepMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QFunctionInputMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QFrontendStepMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QProcessMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.scheduleing.QScheduleMetaData;
|
||||
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractExtractStep;
|
||||
@@ -64,10 +63,6 @@ import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwith
|
||||
*******************************************************************************/
|
||||
public final class WebPerfProcesses
|
||||
{
|
||||
public static final String DISMISS_REGRESSIONS = "DismissRegressions";
|
||||
public static final String RESOLVE_REGRESSIONS = "ResolveRegressions";
|
||||
public static final String COMPARE_CHANGE = "CompareChange";
|
||||
public static final String PROBE_DEPLOYS = "ProbeDeploys";
|
||||
public static final String TEST_PAGE_SPEED = "TestPageSpeed";
|
||||
public static final String RUN_SITE_AUDIT = "RunSiteAudit";
|
||||
public static final String SYNC_TARGETS = "SyncPages";
|
||||
@@ -151,29 +146,6 @@ public final class WebPerfProcesses
|
||||
processes.add(scheduled(config, SCHEDULED_FIELD, "Refresh Google field data (scheduled)", ScheduledSteps.FieldData.class,
|
||||
new QScheduleMetaData().withCronExpression(FIELD_CRON).withCronTimeZoneId("UTC")));
|
||||
}
|
||||
String regressions = config.applyPrefix(WebPerfSchema.REGRESSION);
|
||||
for(String status : List.of("DISMISSED", "RESOLVED"))
|
||||
{
|
||||
boolean dismiss = "DISMISSED".equals(status);
|
||||
QProcessMetaData process = etl(config, dismiss ? DISMISS_REGRESSIONS : RESOLVE_REGRESSIONS, dismiss ? "Dismiss" : "Mark resolved", "done",
|
||||
regressions, regressions, ExtractViaQueryStep.class, RegressionSteps.Transform.class, RegressionSteps.Load.class, status, "manage", 1,
|
||||
"Open regressions will be updated. Closed regressions will be skipped.");
|
||||
process.withStep(0, new QFrontendStepMetaData().withName("note").withLabel("Resolution note")
|
||||
.withFormField(new QFieldMetaData(RegressionSteps.NOTE, QFieldType.STRING).withLabel("Resolution note").withIsRequired(true).withMaxLength(2000)));
|
||||
processes.add(process);
|
||||
}
|
||||
if(config.isOn(WebPerfFeature.CDN_COMPARE))
|
||||
{
|
||||
String changes = config.applyPrefix(WebPerfSchema.CHANGE_EVENT);
|
||||
processes.add(etl(config, COMPARE_CHANGE, "Compare before and after", "compare", changes, config.applyPrefix(WebPerfSchema.COMPARISON),
|
||||
ExtractViaQueryStep.class, RegressionSteps.CompareTransform.class, RegressionSteps.CompareLoad.class, null, "view", 1,
|
||||
"Lab comparisons require three successful samples on each side, on the same Lighthouse major version."));
|
||||
}
|
||||
if(config.isOn(WebPerfFeature.DEPLOY_PROBES) || !config.getChangeEventSources().isEmpty())
|
||||
{
|
||||
processes.add(scheduled(config, PROBE_DEPLOYS, "Check site changes", ScheduledSteps.ProbeChanges.class,
|
||||
new QScheduleMetaData().withRepeatSeconds(300).withInitialDelaySeconds(1)));
|
||||
}
|
||||
return (processes);
|
||||
}
|
||||
|
||||
|
||||
@@ -1,246 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* https://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 com.kingsrook.qbits.webperf.service;
|
||||
|
||||
|
||||
import java.net.URI;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.sql.SQLException;
|
||||
import java.time.Instant;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qbits.webperf.WebPerfFeature;
|
||||
import com.kingsrook.qbits.webperf.WebPerfQBitConfig;
|
||||
import com.kingsrook.qbits.webperf.WebPerfRuntime;
|
||||
import com.kingsrook.qbits.webperf.WebPerfSchema;
|
||||
import com.kingsrook.qbits.webperf.spi.ChangeEventSource;
|
||||
import com.kingsrook.qbits.webperf.spi.DeployProbe;
|
||||
import com.kingsrook.qbits.webperf.store.WebPerfStore;
|
||||
import org.json.JSONArray;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Records source changes and attributes runs to the state observed at start.
|
||||
** All identities and queue writes are durable; polling can safely repeat.
|
||||
*******************************************************************************/
|
||||
public class WebPerfChangeService
|
||||
{
|
||||
private final WebPerfStore store;
|
||||
private final WebPerfQBitConfig config;
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Changes for one installation.
|
||||
*******************************************************************************/
|
||||
public WebPerfChangeService(WebPerfStore store)
|
||||
{
|
||||
this.store = store;
|
||||
this.config = store.getConfig();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Poll configured sources. Failed probes propagate so the schedule retries.
|
||||
*******************************************************************************/
|
||||
public void poll(Instant now) throws Exception
|
||||
{
|
||||
if(config.isOn(WebPerfFeature.DEPLOY_PROBES))
|
||||
{
|
||||
for(DeployProbe probe : config.getDeployProbes())
|
||||
{
|
||||
String build = probe.currentBuildId();
|
||||
if(build != null && !build.isBlank())
|
||||
{
|
||||
String kind = "BACKEND".equalsIgnoreCase(probe.component()) ? "BACKEND_DEPLOY" : "FRONTEND_DEPLOY";
|
||||
Map<String, Object> previous = latest(kind, probe.component(), now);
|
||||
record(new ChangeEventSource.Change(kind, probe.component(), previous == null ? null : (String) previous.get("to_value"), build, now),
|
||||
"PROBE", probe.component() + ":" + build, true);
|
||||
}
|
||||
}
|
||||
}
|
||||
for(int i = 0; i < config.getChangeEventSources().size(); i++)
|
||||
{
|
||||
String sourceKey = "source:" + i;
|
||||
List<Map<String, Object>> last = store.query("SELECT MAX(observed_at) AS observed_at FROM {change_event} WHERE site_key = ? AND note = ?",
|
||||
siteKey(), sourceKey);
|
||||
Instant since = (Instant) last.get(0).get("observed_at");
|
||||
for(ChangeEventSource.Change change : config.getChangeEventSources().get(i).changesSince(since == null ? Instant.EPOCH : since))
|
||||
{
|
||||
if(!"CDN_STAGE".equals(change.kind()) || config.isOn(WebPerfFeature.CDN_COMPARE))
|
||||
{
|
||||
record(change, "CDN_STAGE".equals(change.kind()) ? "QBIT_CDN" : "WEBHOOK", sourceKey, true);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Insert once per build or source event and queue affected pages atomically.
|
||||
** The source SPI has no event id, so its complete tuple is its identity.
|
||||
*******************************************************************************/
|
||||
public long record(ChangeEventSource.Change change, String source, String sourceKey, boolean queue) throws SQLException
|
||||
{
|
||||
String identity = new JSONArray(List.of(siteKey(), source, sourceKey, change.kind(), change.component(), change.toValue(),
|
||||
"PROBE".equals(source) ? "" : change.observedAt().toString(), "PROBE".equals(source) ? "" : String.valueOf(change.fromValue()))).toString();
|
||||
String key = WebPerfService.sha256(identity.getBytes(StandardCharsets.UTF_8));
|
||||
try
|
||||
{
|
||||
return (store.transaction(tx ->
|
||||
{
|
||||
List<Map<String, Object>> existing = tx.query("SELECT id FROM {change_event} WHERE event_key = ?", key);
|
||||
if(!existing.isEmpty())
|
||||
{
|
||||
if("PROBE".equals(source))
|
||||
{
|
||||
tx.update("UPDATE {change_event} SET last_seen_at = ? WHERE id = ? AND (last_seen_at IS NULL OR last_seen_at < ?)",
|
||||
change.observedAt(), existing.get(0).get("id"), change.observedAt());
|
||||
}
|
||||
return (WebPerfStore.asLong(existing.get(0).get("id")));
|
||||
}
|
||||
Map<String, Object> values = new LinkedHashMap<>();
|
||||
values.put("kind", change.kind());
|
||||
values.put("component", change.component());
|
||||
values.put("from_value", change.fromValue());
|
||||
values.put("to_value", change.toValue());
|
||||
values.put("observed_at", change.observedAt());
|
||||
values.put("last_seen_at", change.observedAt());
|
||||
values.put("source", source);
|
||||
values.put("note", sourceKey);
|
||||
values.put("event_key", key);
|
||||
values.put("site_key", siteKey());
|
||||
long id = tx.insert(WebPerfSchema.CHANGE_EVENT, values);
|
||||
if(queue && config.isOn(WebPerfFeature.LAB))
|
||||
{
|
||||
queueChange(tx, id, change);
|
||||
}
|
||||
return (id);
|
||||
}));
|
||||
}
|
||||
catch(SQLException e)
|
||||
{
|
||||
/////////////////////////////////////////////////////////////////////
|
||||
// A competing poll may have committed this exact identity first. //
|
||||
/////////////////////////////////////////////////////////////////////
|
||||
if("23505".equals(e.getSQLState()))
|
||||
{
|
||||
List<Map<String, Object>> existing = store.query("SELECT id FROM {change_event} WHERE event_key = ?", key);
|
||||
if(!existing.isEmpty())
|
||||
{
|
||||
return (WebPerfStore.asLong(existing.get(0).get("id")));
|
||||
}
|
||||
}
|
||||
throw (e);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Page through targets; CDN sampling bypasses the ordinary queue merge.
|
||||
*******************************************************************************/
|
||||
private void queueChange(WebPerfStore tx, long eventId, ChangeEventSource.Change change) throws SQLException
|
||||
{
|
||||
WebPerfService service = new WebPerfService(new WebPerfRuntime(config), tx);
|
||||
boolean cdn = "CDN_STAGE".equals(change.kind());
|
||||
boolean deploy = change.kind().endsWith("DEPLOY");
|
||||
long after = 0;
|
||||
while(true)
|
||||
{
|
||||
List<Map<String, Object>> pages = tx.query("SELECT id, url FROM {target} WHERE site_key = ? AND enabled = TRUE AND id > ?"
|
||||
+ (cdn || deploy ? " AND tier = 'KEY'" : "") + " ORDER BY id FETCH FIRST 100 ROWS ONLY", siteKey(), after);
|
||||
if(pages.isEmpty())
|
||||
{
|
||||
return;
|
||||
}
|
||||
for(Map<String, Object> page : pages)
|
||||
{
|
||||
after = WebPerfStore.asLong(page.get("id"));
|
||||
for(String strategy : config.getStrategies())
|
||||
{
|
||||
if(cdn && ("HEADERS_ONLY".equals(change.toValue()) || "LIVE".equals(change.toValue())))
|
||||
{
|
||||
for(int sample = 0; sample < 3; sample++)
|
||||
{
|
||||
service.enqueueSample(page, strategy, "CHANGE_COMPARE", "change:" + eventId + ":1:" + sample,
|
||||
change.observedAt().plusSeconds("LIVE".equals(change.toValue()) ? 3600 : 0));
|
||||
if("LIVE".equals(change.toValue()))
|
||||
{
|
||||
service.enqueueSample(page, strategy, "CHANGE_COMPARE", "change:" + eventId + ":24:" + sample, change.observedAt().plusSeconds(86400));
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
Instant due = change.observedAt().plusSeconds(deploy ? config.getDeploySettleSeconds() : config.getPublishSettleSeconds());
|
||||
service.enqueue(List.of(new WebPerfService.RunRequest(after, (String) page.get("url"), strategy,
|
||||
deploy ? "DEPLOY" : "PUBLISH", "change:" + eventId, null, due)), change.observedAt());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Latest observed state at a time, optionally for a specific component.
|
||||
*******************************************************************************/
|
||||
public Map<String, Object> latest(String kind, String component, Instant at) throws SQLException
|
||||
{
|
||||
List<Map<String, Object>> rows = component == null
|
||||
? store.query("SELECT * FROM {change_event} WHERE site_key = ? AND kind = ? AND observed_at <= ? ORDER BY last_seen_at DESC, id DESC FETCH FIRST 1 ROWS ONLY",
|
||||
siteKey(), kind, at)
|
||||
: store.query("SELECT * FROM {change_event} WHERE site_key = ? AND kind = ? AND component = ? AND observed_at <= ? ORDER BY last_seen_at DESC, id DESC FETCH FIRST 1 ROWS ONLY",
|
||||
siteKey(), kind, component, at);
|
||||
return (rows.isEmpty() ? null : rows.get(0));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Attribute at execution, not queue time (a deployment may happen meanwhile).
|
||||
*******************************************************************************/
|
||||
public void attribute(long runId, Instant now) throws SQLException
|
||||
{
|
||||
Map<String, Object> build = latest("FRONTEND_DEPLOY", null, now);
|
||||
Map<String, Object> cdn = latest("CDN_STAGE", URI.create(config.getSiteBaseUrl()).getHost(), now);
|
||||
List<Map<String, Object>> cause = store.query("SELECT id FROM {change_event} WHERE site_key = ? AND observed_at <= ? ORDER BY observed_at DESC, id DESC FETCH FIRST 1 ROWS ONLY",
|
||||
siteKey(), now);
|
||||
store.update("UPDATE {lab_run} SET deployment_id = ?, cdn_stage = ?, change_event_id = ? WHERE id = ?",
|
||||
build == null ? null : build.get("to_value"), cdn == null ? null : cdn.get("to_value"), cause.isEmpty() ? null : cause.get(0).get("id"), runId);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Same site identity as the tested pages.
|
||||
*******************************************************************************/
|
||||
String siteKey()
|
||||
{
|
||||
return ("host:" + URI.create(config.getSiteBaseUrl()).getHost().toLowerCase(Locale.ROOT));
|
||||
}
|
||||
}
|
||||
@@ -1,188 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* https://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 com.kingsrook.qbits.webperf.service;
|
||||
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.time.Duration;
|
||||
import java.time.Instant;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qbits.webperf.WebPerfSchema;
|
||||
import com.kingsrook.qbits.webperf.store.WebPerfStore;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Reproducible before/after lab medians, with counts and actual sample windows.
|
||||
** Three successful samples on each side and one Lighthouse major are required.
|
||||
*******************************************************************************/
|
||||
public class WebPerfComparisonService
|
||||
{
|
||||
private final WebPerfStore store;
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Comparisons for one installation.
|
||||
*******************************************************************************/
|
||||
public WebPerfComparisonService(WebPerfStore store)
|
||||
{
|
||||
this.store = store;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Recompute the run's attributed change after its results have been stored.
|
||||
*******************************************************************************/
|
||||
public void compareForRun(Map<String, Object> run) throws SQLException
|
||||
{
|
||||
if(run.get("change_event_id") != null)
|
||||
{
|
||||
List<Map<String, Object>> events = store.query("SELECT * FROM {change_event} WHERE id = ?", run.get("change_event_id"));
|
||||
if(!events.isEmpty())
|
||||
{
|
||||
compareTarget(events.get(0), WebPerfStore.asLong(run.get("target_id")), (String) run.get("strategy"));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Record action: page through enabled targets and compare existing evidence.
|
||||
** Sparse history stays absent instead of being filled with estimated values.
|
||||
*******************************************************************************/
|
||||
public int compare(long eventId) throws SQLException
|
||||
{
|
||||
return (store.transaction(tx ->
|
||||
{
|
||||
Map<String, Object> event = tx.query("SELECT * FROM {change_event} WHERE id = ? FOR UPDATE", eventId).get(0);
|
||||
WebPerfComparisonService service = new WebPerfComparisonService(tx);
|
||||
int count = 0;
|
||||
long after = 0;
|
||||
while(true)
|
||||
{
|
||||
List<Map<String, Object>> pages = tx.query("SELECT id FROM {target} WHERE enabled = TRUE AND site_key = ? AND id > ? ORDER BY id FETCH FIRST 100 ROWS ONLY",
|
||||
event.get("site_key"), after);
|
||||
if(pages.isEmpty())
|
||||
{
|
||||
return (count);
|
||||
}
|
||||
for(Map<String, Object> page : pages)
|
||||
{
|
||||
after = WebPerfStore.asLong(page.get("id"));
|
||||
for(String strategy : store.getConfig().getStrategies())
|
||||
{
|
||||
count += service.compareTarget(event, after, strategy);
|
||||
}
|
||||
}
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Serialize comparison upserts on the change row, shared by all callers.
|
||||
*******************************************************************************/
|
||||
private int compareTarget(Map<String, Object> event, long targetId, String strategy) throws SQLException
|
||||
{
|
||||
store.query("SELECT id FROM {change_event} WHERE id = ? FOR UPDATE", event.get("id"));
|
||||
Instant at = (Instant) event.get("observed_at");
|
||||
List<Map<String, Object>> after = store.query("SELECT * FROM {lab_run} WHERE target_id = ? AND strategy = ? AND status = 'SUCCEEDED'"
|
||||
+ " AND started_at >= ? AND change_event_id = ? ORDER BY completed_at DESC, id DESC FETCH FIRST 3 ROWS ONLY", targetId, strategy, at, event.get("id"));
|
||||
if(after.size() != 3)
|
||||
{
|
||||
return (0);
|
||||
}
|
||||
String major = WebPerfEvaluationService.major(after.get(0));
|
||||
if(after.stream().anyMatch(row -> !major.equals(WebPerfEvaluationService.major(row))))
|
||||
{
|
||||
return (0);
|
||||
}
|
||||
List<Map<String, Object>> before = store.query("SELECT * FROM {lab_run} WHERE target_id = ? AND strategy = ? AND status = 'SUCCEEDED'"
|
||||
+ " AND completed_at < ? AND completed_at >= ? AND (lighthouse_version = ? OR lighthouse_version LIKE ?)"
|
||||
+ " ORDER BY completed_at DESC, id DESC FETCH FIRST 3 ROWS ONLY", targetId, strategy, at, at.minus(Duration.ofDays(30)), major, major + ".%");
|
||||
if(before.size() != 3)
|
||||
{
|
||||
return (0);
|
||||
}
|
||||
int count = 0;
|
||||
for(String metric : List.of("PERFORMANCE_SCORE", "LCP", "FCP", "TTFB"))
|
||||
{
|
||||
String column = WebPerfEvaluationService.LAB_METRICS.get(metric);
|
||||
if(before.stream().anyMatch(row -> row.get(column) == null) || after.stream().anyMatch(row -> row.get(column) == null))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
double beforeValue = WebPerfEvaluationService.median(before, column);
|
||||
double afterValue = WebPerfEvaluationService.median(after, column);
|
||||
double delta = afterValue - beforeValue;
|
||||
Double percentage = beforeValue == 0 ? null : delta * 100 / beforeValue;
|
||||
if(percentage != null && Math.abs(percentage) >= 1000000)
|
||||
{
|
||||
percentage = null;
|
||||
}
|
||||
List<Map<String, Object>> existing = store.query("SELECT id FROM {comparison} WHERE change_event_id = ? AND target_id = ? AND source = 'LAB'"
|
||||
+ " AND strategy = ? AND metric = ? AND segment = 'ALL'", event.get("id"), targetId, strategy, metric);
|
||||
if(existing.isEmpty())
|
||||
{
|
||||
Map<String, Object> row = new LinkedHashMap<>();
|
||||
row.put("change_event_id", event.get("id"));
|
||||
row.put("target_id", targetId);
|
||||
row.put("scope", "TARGET");
|
||||
row.put("source", "LAB");
|
||||
row.put("strategy", strategy);
|
||||
row.put("metric", metric);
|
||||
row.put("segment", "ALL");
|
||||
row.put("before_value", beforeValue);
|
||||
row.put("before_n", 3);
|
||||
row.put("before_window", window(before));
|
||||
row.put("after_value", afterValue);
|
||||
row.put("after_n", 3);
|
||||
row.put("after_window", window(after));
|
||||
row.put("delta", delta);
|
||||
row.put("delta_pct", percentage);
|
||||
store.insert(WebPerfSchema.COMPARISON, row);
|
||||
}
|
||||
else
|
||||
{
|
||||
store.update("UPDATE {comparison} SET before_value = ?, before_n = 3, before_window = ?, after_value = ?, after_n = 3, after_window = ?,"
|
||||
+ " delta = ?, delta_pct = ?, modify_date = ? WHERE id = ?", beforeValue, window(before), afterValue, window(after), delta, percentage,
|
||||
Instant.now(), existing.get(0).get("id"));
|
||||
}
|
||||
count++;
|
||||
}
|
||||
return (count);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The actual sample times, not an implied continuous measurement window.
|
||||
*******************************************************************************/
|
||||
private static String window(List<Map<String, Object>> samples)
|
||||
{
|
||||
return (samples.get(samples.size() - 1).get("completed_at") + " / " + samples.get(0).get("completed_at"));
|
||||
}
|
||||
}
|
||||
@@ -1,611 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* https://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 com.kingsrook.qbits.webperf.service;
|
||||
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.time.Duration;
|
||||
import java.time.Instant;
|
||||
import java.util.ArrayList;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import java.util.Map;
|
||||
import java.util.Objects;
|
||||
import com.kingsrook.qbits.webperf.WebPerfFeature;
|
||||
import com.kingsrook.qbits.webperf.WebPerfRuntime;
|
||||
import com.kingsrook.qbits.webperf.WebPerfSchema;
|
||||
import com.kingsrook.qbits.webperf.spi.ChangeEventSource;
|
||||
import com.kingsrook.qbits.webperf.store.WebPerfStore;
|
||||
import com.kingsrook.qqq.backend.core.alerts.AlertRecordRef;
|
||||
import com.kingsrook.qqq.backend.core.alerts.AlertSeverity;
|
||||
import com.kingsrook.qqq.backend.core.alerts.AlertSignal;
|
||||
import com.kingsrook.qqq.backend.core.alerts.QAlerts;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Budget breaches and confirmed lab regressions, backed by ordinary records.
|
||||
** Target row locks serialize evaluation across workers. Baselines and samples
|
||||
** are bounded, and evaluation progress commits with the resulting records.
|
||||
*******************************************************************************/
|
||||
public class WebPerfEvaluationService
|
||||
{
|
||||
public static final String ALERT_TYPE = "webperf.regression";
|
||||
public static final Map<String, String> LAB_METRICS = Map.of(
|
||||
"PERFORMANCE_SCORE", "score_performance", "ACCESSIBILITY_SCORE", "score_accessibility",
|
||||
"BEST_PRACTICES_SCORE", "score_best_practices", "SEO_SCORE", "score_seo",
|
||||
"LCP", "lcp_ms", "FCP", "fcp_ms", "CLS", "cls", "TBT", "tbt_ms", "TTFB", "ttfb_ms");
|
||||
private final WebPerfStore store;
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Evaluation for one installation.
|
||||
*******************************************************************************/
|
||||
public WebPerfEvaluationService(WebPerfStore store)
|
||||
{
|
||||
this.store = store;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Bounded work per worker tick, including results left by an interrupted tick.
|
||||
*******************************************************************************/
|
||||
public void evaluatePending() throws SQLException
|
||||
{
|
||||
for(Map<String, Object> run : store.query("SELECT id FROM {lab_run} WHERE status = 'SUCCEEDED' AND evaluated_at IS NULL ORDER BY completed_at, id FETCH FIRST 100 ROWS ONLY"))
|
||||
{
|
||||
evaluateLab(WebPerfStore.asLong(run.get("id")));
|
||||
}
|
||||
for(Map<String, Object> field : store.query("SELECT id FROM {field_snapshot} WHERE evaluated_at IS NULL ORDER BY id FETCH FIRST 100 ROWS ONLY"))
|
||||
{
|
||||
evaluateField(WebPerfStore.asLong(field.get("id")));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Evaluate a stored successful result once; publish alerts after commit.
|
||||
*******************************************************************************/
|
||||
public void evaluateLab(long runId) throws SQLException
|
||||
{
|
||||
List<Long> changed = store.transaction(tx ->
|
||||
{
|
||||
List<Map<String, Object>> runs = tx.query("SELECT * FROM {lab_run} WHERE id = ? AND status = 'SUCCEEDED'", runId);
|
||||
if(runs.isEmpty())
|
||||
{
|
||||
return (List.of());
|
||||
}
|
||||
Map<String, Object> run = runs.get(0);
|
||||
List<Map<String, Object>> targets = tx.query("SELECT * FROM {target} WHERE id = ? FOR UPDATE", run.get("target_id"));
|
||||
if(targets.isEmpty() || !tx.query("SELECT id FROM {lab_run} WHERE id = ? AND evaluated_at IS NOT NULL", runId).isEmpty())
|
||||
{
|
||||
return (List.of());
|
||||
}
|
||||
Map<String, Object> target = targets.get(0);
|
||||
WebPerfEvaluationService evaluator = new WebPerfEvaluationService(tx);
|
||||
List<Long> transitions = new ArrayList<>();
|
||||
evaluator.versionChange(run, transitions);
|
||||
List<Map<String, Object>> baseline = evaluator.baseline(run);
|
||||
for(Map.Entry<String, String> metric : LAB_METRICS.entrySet())
|
||||
{
|
||||
if(run.get(metric.getValue()) != null)
|
||||
{
|
||||
evaluator.evaluateMetric(target, run, metric.getKey(), metric.getValue(), baseline, transitions);
|
||||
}
|
||||
}
|
||||
evaluator.updateCount(target.get("id"));
|
||||
if(store.getConfig().isOn(WebPerfFeature.CDN_COMPARE))
|
||||
{
|
||||
new WebPerfComparisonService(tx).compareForRun(run);
|
||||
}
|
||||
tx.update("UPDATE {lab_run} SET evaluated_at = ? WHERE id = ?", Instant.now(), runId);
|
||||
return (transitions);
|
||||
});
|
||||
changed.forEach(this::sendAlert);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** CrUX URL budgets use real p75 values, never NO_DATA, errors or origin
|
||||
** fallback as page measurements. A new collection period can resolve a breach.
|
||||
*******************************************************************************/
|
||||
public void evaluateField(long snapshotId) throws SQLException
|
||||
{
|
||||
List<Long> changed = store.transaction(tx ->
|
||||
{
|
||||
Map<String, Object> field = tx.query("SELECT * FROM {field_snapshot} WHERE id = ? FOR UPDATE", snapshotId).get(0);
|
||||
List<Long> transitions = new ArrayList<>();
|
||||
if(field.get("evaluated_at") != null)
|
||||
{
|
||||
return (transitions);
|
||||
}
|
||||
if("OK".equals(field.get("status")) && "URL".equals(field.get("scope")))
|
||||
{
|
||||
List<Map<String, Object>> targets = tx.query("SELECT * FROM {target} WHERE site_key = ? AND url = ? FOR UPDATE",
|
||||
new WebPerfChangeService(tx).siteKey(), field.get("scope_key"));
|
||||
WebPerfEvaluationService evaluator = new WebPerfEvaluationService(tx);
|
||||
for(Map<String, Object> target : targets)
|
||||
{
|
||||
for(String metric : List.of("LCP", "INP", "CLS", "FCP", "TTFB"))
|
||||
{
|
||||
String column = "p75_" + metric.toLowerCase(Locale.ROOT) + ("CLS".equals(metric) ? "" : "_ms");
|
||||
Double value = WebPerfStore.asDouble(field.get(column));
|
||||
if(value == null)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
String strategy = "PHONE".equals(field.get("form_factor")) ? "MOBILE" : (String) field.get("form_factor");
|
||||
Map<String, Object> budget = evaluator.breachedBudget(target, "CRUX", strategy, metric, value);
|
||||
List<Map<String, Object>> open = tx.query("SELECT * FROM {regression} WHERE target_id = ? AND source = 'CRUX' AND strategy = ? AND metric = ?"
|
||||
+ " AND status = 'CONFIRMED' FETCH FIRST 1 ROWS ONLY", target.get("id"), field.get("form_factor"), metric);
|
||||
Instant at = (Instant) field.get("last_checked_at");
|
||||
if(budget != null && open.isEmpty())
|
||||
{
|
||||
Map<String, Object> row = new LinkedHashMap<>();
|
||||
row.put("target_id", target.get("id"));
|
||||
row.put("content_table", target.get("content_table"));
|
||||
row.put("content_id", target.get("content_id"));
|
||||
row.put("source", "CRUX");
|
||||
row.put("strategy", field.get("form_factor"));
|
||||
row.put("metric", metric);
|
||||
row.put("current_value", value);
|
||||
row.put("current_ref", "field:" + snapshotId);
|
||||
row.put("budget_id", budget.get("id"));
|
||||
row.put("severity", budget.get("severity"));
|
||||
row.put("status", "CONFIRMED");
|
||||
row.put("detected_at", at);
|
||||
row.put("confirmed_at", at);
|
||||
transitions.add(tx.insert(WebPerfSchema.REGRESSION, row));
|
||||
}
|
||||
else if(!open.isEmpty())
|
||||
{
|
||||
Map<String, Object> regression = open.get(0);
|
||||
tx.update("UPDATE {regression} SET current_value = ?, current_ref = ?, modify_date = ? WHERE id = ?",
|
||||
value, "field:" + snapshotId, at, regression.get("id"));
|
||||
if(budget == null)
|
||||
{
|
||||
evaluator.close(regression, "RESOLVED", "Google field data is within its budget", at);
|
||||
transitions.add(WebPerfStore.asLong(regression.get("id")));
|
||||
}
|
||||
}
|
||||
}
|
||||
evaluator.updateCount(target.get("id"));
|
||||
}
|
||||
}
|
||||
tx.update("UPDATE {field_snapshot} SET evaluated_at = ? WHERE id = ?", Instant.now(), snapshotId);
|
||||
return (transitions);
|
||||
});
|
||||
changed.forEach(this::sendAlert);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Five eligible results in the preceding 30 days, excluding the new result.
|
||||
*******************************************************************************/
|
||||
private List<Map<String, Object>> baseline(Map<String, Object> run) throws SQLException
|
||||
{
|
||||
return (store.query("SELECT * FROM {lab_run} WHERE target_id = ? AND strategy = ? AND status = 'SUCCEEDED'"
|
||||
+ " AND trigger_type IN ('SCHEDULE', 'CONFIRM', 'SITE_AUDIT') AND completed_at >= ?"
|
||||
+ " AND (completed_at < ? OR (completed_at = ? AND id < ?)) AND (lighthouse_version = ? OR lighthouse_version LIKE ?)"
|
||||
+ " ORDER BY completed_at DESC, id DESC FETCH FIRST 5 ROWS ONLY", run.get("target_id"), run.get("strategy"),
|
||||
((Instant) run.get("completed_at")).minus(Duration.ofDays(30)), run.get("completed_at"), run.get("completed_at"), run.get("id"),
|
||||
major(run), major(run) + ".%"));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Major-version changes are markers and retire incompatible open baselines.
|
||||
*******************************************************************************/
|
||||
private void versionChange(Map<String, Object> run, List<Long> changed) throws SQLException
|
||||
{
|
||||
List<Map<String, Object>> previous = store.query("SELECT lighthouse_version FROM {lab_run} WHERE target_id = ? AND strategy = ?"
|
||||
+ " AND status = 'SUCCEEDED' AND id < ? ORDER BY id DESC FETCH FIRST 1 ROWS ONLY", run.get("target_id"), run.get("strategy"), run.get("id"));
|
||||
if(!previous.isEmpty() && !major(previous.get(0)).equals(major(run)))
|
||||
{
|
||||
new WebPerfChangeService(store).record(new ChangeEventSource.Change("LIGHTHOUSE_VERSION", "LIGHTHOUSE", major(previous.get(0)), major(run),
|
||||
(Instant) run.get("completed_at")), "PROBE", "lighthouse:" + major(run), false);
|
||||
}
|
||||
for(Map<String, Object> open : store.query("SELECT * FROM {regression} WHERE target_id = ? AND strategy = ? AND source = 'LAB'"
|
||||
+ " AND status IN ('SUSPECTED', 'CONFIRMED') AND lighthouse_major <> ?", run.get("target_id"), run.get("strategy"), major(run)))
|
||||
{
|
||||
close(open, "CONFIRMED".equals(open.get("status")) ? "RESOLVED" : "NOT_CONFIRMED", "Lighthouse major version changed; baseline reset",
|
||||
(Instant) run.get("completed_at"));
|
||||
changed.add(WebPerfStore.asLong(open.get("id")));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Keep a single open row per page, source, strategy and metric. Its baseline
|
||||
** stays fixed through confirmation and recovery rather than drifting.
|
||||
*******************************************************************************/
|
||||
private void evaluateMetric(Map<String, Object> target, Map<String, Object> run, String metric, String column,
|
||||
List<Map<String, Object>> baseline, List<Long> changed) throws SQLException
|
||||
{
|
||||
List<Map<String, Object>> existing = store.query("SELECT * FROM {regression} WHERE target_id = ? AND strategy = ? AND source = 'LAB' AND metric = ?"
|
||||
+ " AND status IN ('SUSPECTED', 'CONFIRMED') FETCH FIRST 1 ROWS ONLY", target.get("id"), run.get("strategy"), metric);
|
||||
if(!existing.isEmpty())
|
||||
{
|
||||
advance(target, run, metric, column, existing.get(0), changed);
|
||||
return;
|
||||
}
|
||||
Double value = WebPerfStore.asDouble(run.get(column));
|
||||
Double reference = baseline.size() == 5 && baseline.stream().allMatch(row -> row.get(column) != null) ? median(baseline, column) : null;
|
||||
Map<String, Object> budget = breachedBudget(target, "LAB", (String) run.get("strategy"), metric, value);
|
||||
List<String> failedAudits = newFailures(run, metric);
|
||||
if(!drift(metric, reference, value) && budget == null && failedAudits.isEmpty())
|
||||
{
|
||||
return;
|
||||
}
|
||||
boolean deterministic = metric.endsWith("_SCORE") && !"PERFORMANCE_SCORE".equals(metric);
|
||||
Instant at = (Instant) run.get("completed_at");
|
||||
Map<String, Object> row = new LinkedHashMap<>();
|
||||
row.put("target_id", target.get("id"));
|
||||
row.put("content_table", target.get("content_table"));
|
||||
row.put("content_id", target.get("content_id"));
|
||||
row.put("source", "LAB");
|
||||
row.put("strategy", run.get("strategy"));
|
||||
row.put("metric", metric);
|
||||
row.put("baseline_value", reference);
|
||||
row.put("baseline_ref", reference == null ? null : refs(baseline));
|
||||
row.put("current_value", value);
|
||||
row.put("current_ref", run.get("id").toString());
|
||||
row.put("delta", reference == null ? null : value - reference);
|
||||
row.put("budget_id", budget == null ? null : budget.get("id"));
|
||||
row.put("severity", budget == null ? "WARNING" : budget.get("severity"));
|
||||
row.put("status", deterministic ? "CONFIRMED" : "SUSPECTED");
|
||||
row.put("detected_at", at);
|
||||
row.put("confirmed_at", deterministic ? at : null);
|
||||
row.put("cause_change_event_id", run.get("change_event_id"));
|
||||
row.put("first_run_id", run.get("id"));
|
||||
row.put("checkpoint_run_id", run.get("id"));
|
||||
row.put("lighthouse_major", major(run));
|
||||
row.put("failed_audits", String.join(",", failedAudits));
|
||||
long id = store.insert(WebPerfSchema.REGRESSION, row);
|
||||
if(deterministic)
|
||||
{
|
||||
changed.add(id);
|
||||
}
|
||||
else
|
||||
{
|
||||
WebPerfService service = new WebPerfService(new WebPerfRuntime(store.getConfig()), store);
|
||||
for(int sample = 0; sample < 2; sample++)
|
||||
{
|
||||
service.enqueueSample(target, (String) run.get("strategy"), "CONFIRM", "confirm:" + run.get("id") + ":" + sample, at);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Confirm with the original plus two explicit samples. Recover only after
|
||||
** three later successful runs on the same major version.
|
||||
*******************************************************************************/
|
||||
private void advance(Map<String, Object> target, Map<String, Object> run, String metric, String column,
|
||||
Map<String, Object> open, List<Long> changed) throws SQLException
|
||||
{
|
||||
boolean suspected = "SUSPECTED".equals(open.get("status"));
|
||||
List<Map<String, Object>> samples = suspected
|
||||
? store.query("SELECT * FROM {lab_run} WHERE target_id = ? AND strategy = ? AND status = 'SUCCEEDED' AND id <= ?"
|
||||
+ " AND (id = ? OR trigger_ref IN (?, ?)) AND (lighthouse_version = ? OR lighthouse_version LIKE ?) ORDER BY id FETCH FIRST 3 ROWS ONLY",
|
||||
target.get("id"), run.get("strategy"), run.get("id"), open.get("first_run_id"), "confirm:" + open.get("first_run_id") + ":0",
|
||||
"confirm:" + open.get("first_run_id") + ":1", major(run), major(run) + ".%")
|
||||
: store.query("SELECT * FROM {lab_run} WHERE target_id = ? AND strategy = ? AND status = 'SUCCEEDED' AND id > ? AND id <= ?"
|
||||
+ " AND (lighthouse_version = ? OR lighthouse_version LIKE ?) ORDER BY id DESC FETCH FIRST 3 ROWS ONLY",
|
||||
target.get("id"), run.get("strategy"), open.get("checkpoint_run_id"), run.get("id"), major(run), major(run) + ".%");
|
||||
if(samples.size() < 3 || samples.stream().anyMatch(row -> row.get(column) == null))
|
||||
{
|
||||
return;
|
||||
}
|
||||
double value = median(samples, column);
|
||||
Double reference = WebPerfStore.asDouble(open.get("baseline_value"));
|
||||
Map<String, Object> budget = breachedBudget(target, "LAB", (String) run.get("strategy"), metric, value);
|
||||
boolean breached = drift(metric, reference, value) || budget != null || auditsStillFail(open, samples);
|
||||
Instant at = (Instant) run.get("completed_at");
|
||||
store.update("UPDATE {regression} SET current_value = ?, current_ref = ?, delta = ?, budget_id = ?, severity = ?, modify_date = ? WHERE id = ?",
|
||||
value, refs(samples), reference == null ? null : value - reference, budget == null ? null : budget.get("id"),
|
||||
budget == null ? "WARNING" : budget.get("severity"), at, open.get("id"));
|
||||
if(suspected && breached)
|
||||
{
|
||||
store.update("UPDATE {regression} SET status = 'CONFIRMED', confirmed_at = ?, checkpoint_run_id = ? WHERE id = ?", at, run.get("id"), open.get("id"));
|
||||
changed.add(WebPerfStore.asLong(open.get("id")));
|
||||
}
|
||||
else if(!breached)
|
||||
{
|
||||
close(open, suspected ? "NOT_CONFIRMED" : "RESOLVED", suspected ? "Median of three did not confirm the regression" : "Recovered: median of three later runs", at);
|
||||
changed.add(WebPerfStore.asLong(open.get("id")));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Match enabled budgets by source, strategy and every supported scope.
|
||||
** The comparator describes acceptable values; a breach is its inverse.
|
||||
*******************************************************************************/
|
||||
public Map<String, Object> breachedBudget(Map<String, Object> target, String source, String strategy, String metric, double value) throws SQLException
|
||||
{
|
||||
Map<String, Object> winner = null;
|
||||
long after = 0;
|
||||
while(true)
|
||||
{
|
||||
List<Map<String, Object>> budgets = store.query("SELECT * FROM {budget} WHERE enabled = TRUE AND source = ? AND metric = ? AND id > ?"
|
||||
+ " AND (strategy IS NULL OR strategy = '' OR strategy = ?) ORDER BY id FETCH FIRST 100 ROWS ONLY", source, metric, after, strategy);
|
||||
if(budgets.isEmpty())
|
||||
{
|
||||
return (winner);
|
||||
}
|
||||
for(Map<String, Object> budget : budgets)
|
||||
{
|
||||
after = WebPerfStore.asLong(budget.get("id"));
|
||||
if(matches(target, budget) && budget.get("threshold") != null && !acceptable(value, (String) budget.get("comparator"), WebPerfStore.asDouble(budget.get("threshold"))))
|
||||
{
|
||||
if(winner == null || "CRITICAL".equals(budget.get("severity")))
|
||||
{
|
||||
winner = budget;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Scope values are literal values, never SQL or wildcard expressions.
|
||||
*******************************************************************************/
|
||||
private static boolean matches(Map<String, Object> target, Map<String, Object> budget)
|
||||
{
|
||||
String value = (String) budget.get("scope_value");
|
||||
return (switch(String.valueOf(budget.get("scope")))
|
||||
{
|
||||
case "SITE" -> value == null || value.isBlank() || value.equals(target.get("site_key"));
|
||||
case "TIER" -> Objects.equals(value, target.get("tier"));
|
||||
case "TARGET" -> Objects.equals(value, String.valueOf(target.get("id")));
|
||||
case "CONTENT_TABLE" -> Objects.equals(value, target.get("content_table"));
|
||||
case "PATH_PREFIX" -> value != null && target.get("path") instanceof String path && path.startsWith(value);
|
||||
default -> false;
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Supported budget comparators. Invalid records fail visibly on evaluation.
|
||||
*******************************************************************************/
|
||||
static boolean acceptable(double value, String comparator, double threshold)
|
||||
{
|
||||
return (switch(String.valueOf(comparator))
|
||||
{
|
||||
case "<=", "LE" -> value <= threshold;
|
||||
case "<", "LT" -> value < threshold;
|
||||
case ">=", "GE" -> value >= threshold;
|
||||
case ">", "GT" -> value > threshold;
|
||||
case "=", "==", "EQ" -> value == threshold;
|
||||
case "!=", "<>", "NE" -> value != threshold;
|
||||
default -> throw new IllegalArgumentException("Unsupported performance budget comparator: " + comparator);
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Design section 6.4: relative and absolute LCP limits must both be met.
|
||||
*******************************************************************************/
|
||||
static boolean drift(String metric, Double baseline, double value)
|
||||
{
|
||||
if(baseline == null)
|
||||
{
|
||||
return (false);
|
||||
}
|
||||
double delta = value - baseline;
|
||||
return (switch(metric)
|
||||
{
|
||||
case "PERFORMANCE_SCORE" -> delta <= -10;
|
||||
case "ACCESSIBILITY_SCORE", "BEST_PRACTICES_SCORE", "SEO_SCORE" -> delta <= -5;
|
||||
case "LCP" -> delta >= 500 && value >= baseline * 1.25;
|
||||
case "CLS" -> delta >= 0.05 - 0.0000001;
|
||||
case "TBT" -> delta >= 200;
|
||||
default -> false;
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Newly failing deterministic audits, compared only within the same major.
|
||||
*******************************************************************************/
|
||||
private List<String> newFailures(Map<String, Object> run, String metric) throws SQLException
|
||||
{
|
||||
if(!metric.endsWith("_SCORE") || "PERFORMANCE_SCORE".equals(metric))
|
||||
{
|
||||
return (List.of());
|
||||
}
|
||||
String category = metric.replace("_SCORE", "");
|
||||
List<Map<String, Object>> previous = store.query("SELECT id FROM {lab_run} WHERE target_id = ? AND strategy = ? AND id < ?"
|
||||
+ " AND status = 'SUCCEEDED' AND (lighthouse_version = ? OR lighthouse_version LIKE ?) ORDER BY id DESC FETCH FIRST 1 ROWS ONLY",
|
||||
run.get("target_id"), run.get("strategy"), run.get("id"), major(run), major(run) + ".%");
|
||||
if(previous.isEmpty())
|
||||
{
|
||||
return (List.of());
|
||||
}
|
||||
return (store.query("SELECT audit_id FROM {lab_finding} f WHERE run_id = ? AND category = ? AND score < 1"
|
||||
+ " AND NOT EXISTS (SELECT 1 FROM {lab_finding} old WHERE old.run_id = ? AND old.audit_id = f.audit_id AND old.score < 1)"
|
||||
+ " ORDER BY audit_id FETCH FIRST 19 ROWS ONLY", run.get("id"), category, previous.get(0).get("id"))
|
||||
.stream().map(row -> (String) row.get("audit_id")).toList());
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** An audit-caused regression recovers when a majority no longer fail it.
|
||||
*******************************************************************************/
|
||||
private boolean auditsStillFail(Map<String, Object> open, List<Map<String, Object>> samples) throws SQLException
|
||||
{
|
||||
String audits = (String) open.get("failed_audits");
|
||||
if(audits == null || audits.isBlank())
|
||||
{
|
||||
return (false);
|
||||
}
|
||||
for(String audit : audits.split(","))
|
||||
{
|
||||
int failed = 0;
|
||||
for(Map<String, Object> sample : samples)
|
||||
{
|
||||
if(!store.query("SELECT id FROM {lab_finding} WHERE run_id = ? AND audit_id = ? AND score < 1 FETCH FIRST 1 ROWS ONLY", sample.get("id"), audit).isEmpty())
|
||||
{
|
||||
failed++;
|
||||
}
|
||||
}
|
||||
if(failed >= 2)
|
||||
{
|
||||
return (true);
|
||||
}
|
||||
}
|
||||
return (false);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Record the terminal state without discarding evidence.
|
||||
*******************************************************************************/
|
||||
private void close(Map<String, Object> regression, String status, String note, Instant at) throws SQLException
|
||||
{
|
||||
store.update("UPDATE {regression} SET status = ?, resolved_at = ?, resolution_note = ?, modify_date = ? WHERE id = ?",
|
||||
status, at, note, at, regression.get("id"));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Record action; rechecks state under the same target lock as evaluation.
|
||||
*******************************************************************************/
|
||||
public boolean finishRegression(long id, String status, String note, Instant at) throws SQLException
|
||||
{
|
||||
if(!List.of("DISMISSED", "RESOLVED").contains(status) || note == null || note.isBlank() || note.length() > 2000)
|
||||
{
|
||||
throw (new IllegalArgumentException("A resolution note of 1 to 2000 characters is required"));
|
||||
}
|
||||
boolean changed = store.transaction(tx ->
|
||||
{
|
||||
List<Map<String, Object>> rows = tx.query("SELECT * FROM {regression} WHERE id = ?", id);
|
||||
if(rows.isEmpty())
|
||||
{
|
||||
return (false);
|
||||
}
|
||||
Map<String, Object> row = rows.get(0);
|
||||
tx.query("SELECT id FROM {target} WHERE id = ? FOR UPDATE", row.get("target_id"));
|
||||
int updated = tx.update("UPDATE {regression} SET status = ?, resolved_at = ?, resolution_note = ?, modify_date = ? WHERE id = ? AND status IN ('SUSPECTED', 'CONFIRMED')",
|
||||
status, at, note, at, id);
|
||||
new WebPerfEvaluationService(tx).updateCount(row.get("target_id"));
|
||||
return (updated == 1);
|
||||
});
|
||||
if(changed)
|
||||
{
|
||||
sendAlert(id);
|
||||
}
|
||||
return (changed);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The list count includes suspected and confirmed open regressions.
|
||||
*******************************************************************************/
|
||||
private void updateCount(Object targetId) throws SQLException
|
||||
{
|
||||
store.update("UPDATE {target} SET open_regression_count = (SELECT COUNT(*) FROM {regression} WHERE target_id = ? AND status IN ('SUSPECTED', 'CONFIRMED')) WHERE id = ?",
|
||||
targetId, targetId);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Optional core producer API; without an Alerts QBit core uses its log sink.
|
||||
*******************************************************************************/
|
||||
private void sendAlert(long id)
|
||||
{
|
||||
if(!store.getConfig().isOn(WebPerfFeature.ALERTS))
|
||||
{
|
||||
return;
|
||||
}
|
||||
try
|
||||
{
|
||||
Map<String, Object> row = store.query("SELECT * FROM {regression} WHERE id = ?", id).get(0);
|
||||
String key = store.getConfig().getTableNamePrefix() + ":" + row.get("target_id") + ":" + row.get("source") + ":" + row.get("strategy") + ":" + row.get("metric");
|
||||
if("CONFIRMED".equals(row.get("status")))
|
||||
{
|
||||
QAlerts.raise(new AlertSignal(ALERT_TYPE).withDedupKey(key).withSeverity(AlertSeverity.valueOf((String) row.get("severity")))
|
||||
.withTitle("Confirmed web performance regression").withSummary(row.get("strategy") + " " + row.get("metric"))
|
||||
.withRecordRef(AlertRecordRef.of(store.getConfig().applyPrefix(WebPerfSchema.REGRESSION), id)));
|
||||
}
|
||||
else if(List.of("RESOLVED", "DISMISSED").contains(row.get("status")))
|
||||
{
|
||||
QAlerts.resolve(ALERT_TYPE, key, "Performance regression " + row.get("status").toString().toLowerCase(Locale.ROOT));
|
||||
}
|
||||
}
|
||||
catch(SQLException e)
|
||||
{
|
||||
throw (new IllegalStateException("Reading a committed performance regression failed", e));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Median of bounded, non-null measurement values.
|
||||
*******************************************************************************/
|
||||
static Double median(List<Map<String, Object>> rows, String column)
|
||||
{
|
||||
List<Double> values = rows.stream().map(row -> WebPerfStore.asDouble(row.get(column))).filter(Objects::nonNull).sorted().toList();
|
||||
int size = values.size();
|
||||
return (size == 0 ? null : size % 2 == 1 ? values.get(size / 2) : (values.get(size / 2 - 1) + values.get(size / 2)) / 2);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Stored ids make a statistical result reproducible.
|
||||
*******************************************************************************/
|
||||
static String refs(List<Map<String, Object>> rows)
|
||||
{
|
||||
return (String.join(",", rows.stream().map(row -> row.get("id").toString()).toList()));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Unknown versions never mix with a known Lighthouse baseline.
|
||||
*******************************************************************************/
|
||||
static String major(Map<String, Object> run)
|
||||
{
|
||||
return (String.valueOf(run.get("lighthouse_version")).split("\\.")[0]);
|
||||
}
|
||||
}
|
||||
@@ -31,8 +31,6 @@ import java.time.Duration;
|
||||
import java.time.Instant;
|
||||
import java.time.ZoneId;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Comparator;
|
||||
import java.util.HashMap;
|
||||
import java.util.HashSet;
|
||||
import java.util.HexFormat;
|
||||
import java.util.LinkedHashMap;
|
||||
@@ -78,9 +76,6 @@ public class WebPerfService
|
||||
/** Statuses that still hold a place in the queue (a new request merges into them). */
|
||||
public static final List<String> OPEN_STATUSES = List.of("QUEUED", "RUNNING");
|
||||
|
||||
static final int REPORT_BATCH = 500;
|
||||
static final int REPORT_MAX_BATCHES = 20;
|
||||
|
||||
private final WebPerfRuntime runtime;
|
||||
private final WebPerfStore store;
|
||||
private final WebPerfQBitConfig config;
|
||||
@@ -210,6 +205,7 @@ public class WebPerfService
|
||||
values.put("enabled", true);
|
||||
values.put("in_sitemap", true);
|
||||
values.put("last_seen_in_sitemap_at", now);
|
||||
values.put("open_regression_count", 0);
|
||||
store.insert(WebPerfSchema.TARGET, values);
|
||||
}
|
||||
for(Long id : plan.seenIds())
|
||||
@@ -307,6 +303,10 @@ public class WebPerfService
|
||||
public QueuePlan planQueue(List<RunRequest> requests, Instant now) throws SQLException
|
||||
{
|
||||
Set<String> open = new HashSet<>();
|
||||
for(Map<String, Object> row : store.query("SELECT target_id, strategy FROM {lab_run} WHERE status IN ('QUEUED', 'RUNNING')"))
|
||||
{
|
||||
open.add(row.get("target_id") + "|" + row.get("strategy"));
|
||||
}
|
||||
int runsToday = runsSince(startOfToday(now));
|
||||
|
||||
List<RunRequest> queue = new ArrayList<>();
|
||||
@@ -315,8 +315,7 @@ public class WebPerfService
|
||||
for(RunRequest request : requests)
|
||||
{
|
||||
String key = request.targetId() + "|" + request.strategy();
|
||||
if(!open.add(key) || !store.query("SELECT id FROM {lab_run} WHERE target_id = ? AND strategy = ? AND status IN ('QUEUED', 'RUNNING') FETCH FIRST 1 ROWS ONLY",
|
||||
request.targetId(), request.strategy()).isEmpty())
|
||||
if(!open.add(key))
|
||||
{
|
||||
merged.add(request);
|
||||
}
|
||||
@@ -360,48 +359,6 @@ public class WebPerfService
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Queue an independent confirmation or comparison sample. Its reference is
|
||||
** stable across retries; deliberate samples must not merge with each other.
|
||||
*******************************************************************************/
|
||||
public String enqueueSample(Map<String, Object> target, String strategy, String trigger, String reference, Instant due) throws SQLException
|
||||
{
|
||||
if(!store.query("SELECT id FROM {lab_run} WHERE target_id = ? AND strategy = ? AND trigger_ref = ? AND status NOT IN ('FAILED', 'RUNTIME_ERROR', 'SKIPPED_QUOTA') FETCH FIRST 1 ROWS ONLY",
|
||||
target.get("id"), strategy, reference).isEmpty())
|
||||
{
|
||||
return ("MERGED");
|
||||
}
|
||||
Instant now = Instant.now();
|
||||
boolean capped = runsSince(startOfToday(now)) >= config.getMaxRunsPerDay();
|
||||
RunRequest request = new RunRequest(WebPerfStore.asLong(target.get("id")), (String) target.get("url"), strategy, trigger, reference, null, due);
|
||||
store.insert(WebPerfSchema.LAB_RUN, runValues(request, capped ? "SKIPPED_QUOTA" : "QUEUED", now,
|
||||
capped ? "Daily run cap reached; use Retry to collect this sample" : null));
|
||||
return (capped ? "SKIPPED_QUOTA" : "QUEUED");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Retry a deliberate sample without losing its confirmation/comparison slot.
|
||||
** Keep the failed row as history; simultaneous retries share the target lock.
|
||||
*******************************************************************************/
|
||||
public String retrySample(long runId, Instant now) throws SQLException
|
||||
{
|
||||
return (store.transaction(tx ->
|
||||
{
|
||||
Map<String, Object> run = tx.query("SELECT * FROM {lab_run} WHERE id = ?", runId).get(0);
|
||||
Map<String, Object> target = tx.query("SELECT id, url FROM {target} WHERE id = ? FOR UPDATE", run.get("target_id")).get(0);
|
||||
if(!List.of("FAILED", "RUNTIME_ERROR", "SKIPPED_QUOTA").contains(run.get("status")))
|
||||
{
|
||||
return ("MERGED");
|
||||
}
|
||||
return (new WebPerfService(runtime, tx).enqueueSample(target, (String) run.get("strategy"), (String) run.get("trigger_type"),
|
||||
(String) run.get("trigger_ref"), now));
|
||||
}));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The column values of a new run.
|
||||
*******************************************************************************/
|
||||
@@ -450,32 +407,6 @@ public class WebPerfService
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Scheduled requests, least recently queued page/strategy first. Quota skips
|
||||
** do not advance the rotation; never-tested pairs precede historical runs.
|
||||
** Manual requests keep the caller's ordering.
|
||||
**
|
||||
** @param keyOnly only KEY pages
|
||||
** @param reason schedule description
|
||||
** @param now earliest start
|
||||
** @return requests ordered fairly across daily quota boundaries
|
||||
** @throws SQLException on a history read failure
|
||||
*******************************************************************************/
|
||||
public List<RunRequest> scheduledRequests(boolean keyOnly, String reason, Instant now) throws SQLException
|
||||
{
|
||||
List<RunRequest> requests = requestsFor(enabledTargets(keyOnly), "SCHEDULE", reason, now);
|
||||
Map<String, Instant> lastQueued = new HashMap<>();
|
||||
for(Map<String, Object> row : store.query("SELECT r.target_id, r.strategy, MAX(r.queued_at) AS last_queued FROM {lab_run} r JOIN {target} t ON t.id = r.target_id WHERE t.site_key = ? AND r.status <> 'SKIPPED_QUOTA' GROUP BY r.target_id, r.strategy", siteKey()))
|
||||
{
|
||||
lastQueued.put(WebPerfStore.asLong(row.get("target_id")) + "|" + row.get("strategy"), (Instant) row.get("last_queued"));
|
||||
}
|
||||
requests.sort(Comparator.comparing(request -> lastQueued.get(request.targetId() + "|" + request.strategy()),
|
||||
Comparator.nullsFirst(Comparator.naturalOrder())));
|
||||
return (requests);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Enabled pages, optionally only the KEY tier.
|
||||
**
|
||||
@@ -529,7 +460,6 @@ public class WebPerfService
|
||||
*******************************************************************************/
|
||||
public int runDue(Instant now) throws Exception
|
||||
{
|
||||
new WebPerfEvaluationService(store).evaluatePending();
|
||||
LabRunner runner = runtime.labRunner();
|
||||
if(runner == null)
|
||||
{
|
||||
@@ -537,7 +467,7 @@ public class WebPerfService
|
||||
return (0);
|
||||
}
|
||||
|
||||
List<Map<String, Object>> due = store.query("SELECT id FROM {lab_run} WHERE status = 'QUEUED' AND not_before <= ? ORDER BY not_before, id FETCH FIRST " + config.getConcurrency() + " ROWS ONLY", now);
|
||||
List<Map<String, Object>> due = store.query("SELECT id FROM {lab_run} WHERE status = 'QUEUED' AND not_before <= ? ORDER BY not_before, id", now);
|
||||
List<Long> claimed = new ArrayList<>();
|
||||
for(Map<String, Object> row : due)
|
||||
{
|
||||
@@ -583,7 +513,6 @@ public class WebPerfService
|
||||
{
|
||||
executor.shutdownNow();
|
||||
}
|
||||
new WebPerfEvaluationService(store).evaluatePending();
|
||||
return (claimed.size());
|
||||
}
|
||||
|
||||
@@ -600,7 +529,6 @@ public class WebPerfService
|
||||
{
|
||||
Map<String, Object> run = store.query("SELECT id, target_id, url, strategy, attempts FROM {lab_run} WHERE id = ?", runId).get(0);
|
||||
int attempts = WebPerfStore.asInt(run.get("attempts")) + 1;
|
||||
new WebPerfChangeService(store).attribute(runId, Instant.now());
|
||||
LabRunner.LabResponse response;
|
||||
try
|
||||
{
|
||||
@@ -639,66 +567,11 @@ public class WebPerfService
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Apply reportRetentionDays: delete Lighthouse Reports older than that many
|
||||
** days (0 keeps them forever). The run, its scores and findings stay; only
|
||||
** the full compressed response goes. Runs after a result is committed (a
|
||||
** failure here never loses a run's evidence), at most once an hour per
|
||||
** process (WebPerfRuntime.reportPruneDue, shared by the workers), in batches
|
||||
** of REPORT_BATCH rows, at most REPORT_MAX_BATCHES per pass. There is no
|
||||
** table for state shared across replicas, so each replica keeps its own
|
||||
** hourly limit; passes are bounded and idempotent, so overlapping replicas
|
||||
** only repeat one cheap query.
|
||||
*******************************************************************************/
|
||||
void pruneReports()
|
||||
{
|
||||
int days = runtime.getConfig().getReportRetentionDays();
|
||||
if(days <= 0 || !runtime.reportPruneDue())
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
java.sql.Timestamp cutoff = WebPerfStore.utc(Instant.now().minus(java.time.Duration.ofDays(days)));
|
||||
for(int batch = 0; batch < REPORT_MAX_BATCHES; batch++)
|
||||
{
|
||||
int deleted = store.update("DELETE FROM {lab_report} WHERE id IN (SELECT id FROM {lab_report} WHERE create_date < ? ORDER BY id FETCH FIRST " + REPORT_BATCH + " ROWS ONLY)", cutoff);
|
||||
if(deleted < REPORT_BATCH)
|
||||
{
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
catch(SQLException | RuntimeException e)
|
||||
{
|
||||
LOG.warn("Could not prune old Lighthouse Reports", e);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Store a successful response: the run's scores and metrics, its findings,
|
||||
** the compressed report, and the page's latest results.
|
||||
*******************************************************************************/
|
||||
private void store(long runId, Map<String, Object> run, int attempts, LabResultParser.ParsedLab parsed, LabRunner.LabResponse response) throws SQLException
|
||||
{
|
||||
store.transaction(tx ->
|
||||
{
|
||||
new WebPerfService(runtime, tx).storeResult(runId, run, attempts, parsed, response);
|
||||
return (null);
|
||||
});
|
||||
pruneReports();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Commit the result, findings, report and latest values as one unit, so an
|
||||
** evaluator never sees a successful run with only some of its evidence.
|
||||
*******************************************************************************/
|
||||
private void storeResult(long runId, Map<String, Object> run, int attempts, LabResultParser.ParsedLab parsed, LabRunner.LabResponse response) throws SQLException
|
||||
{
|
||||
Instant completed = response.completedAt();
|
||||
String status = parsed.runtimeError() == null ? "SUCCEEDED" : "RUNTIME_ERROR";
|
||||
@@ -712,7 +585,6 @@ public class WebPerfService
|
||||
parsed.score("SEO"), parsed.fcpMs(), parsed.lcpMs(), parsed.tbtMs(), parsed.cls(), parsed.speedIndexMs(), parsed.lcpElement(), parsed.runWarnings(),
|
||||
completed, runId);
|
||||
|
||||
store.update("UPDATE {lab_run} SET ttfb_ms = ? WHERE id = ?", LabResultParser.ttfb(response.rawJson()), runId);
|
||||
Long targetId = WebPerfStore.asLong(run.get("target_id"));
|
||||
for(LabResultParser.Finding finding : parsed.findings())
|
||||
{
|
||||
@@ -846,7 +718,6 @@ public class WebPerfService
|
||||
}
|
||||
}
|
||||
}
|
||||
new WebPerfEvaluationService(store).evaluatePending();
|
||||
return (counts);
|
||||
}
|
||||
|
||||
|
||||
@@ -74,86 +74,6 @@ public class WebPerfStore
|
||||
|
||||
private final WebPerfQBitConfig config;
|
||||
private final ConnectionSupplier connections;
|
||||
private Connection transactionConnection;
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Work sharing one database transaction.
|
||||
*******************************************************************************/
|
||||
@FunctionalInterface
|
||||
public interface TransactionWork<T>
|
||||
{
|
||||
/*******************************************************************************
|
||||
** Execute against the transaction's store.
|
||||
*******************************************************************************/
|
||||
T run(WebPerfStore store) throws SQLException;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Commit related writes together; roll back every write on failure.
|
||||
*******************************************************************************/
|
||||
public <T> T transaction(TransactionWork<T> work) throws SQLException
|
||||
{
|
||||
if(transactionConnection != null)
|
||||
{
|
||||
return (work.run(this));
|
||||
}
|
||||
try(Connection connection = connections.get())
|
||||
{
|
||||
boolean autoCommit = connection.getAutoCommit();
|
||||
connection.setAutoCommit(false);
|
||||
WebPerfStore transactional = new WebPerfStore(config, connections);
|
||||
transactional.transactionConnection = connection;
|
||||
try
|
||||
{
|
||||
T result = work.run(transactional);
|
||||
connection.commit();
|
||||
return (result);
|
||||
}
|
||||
catch(SQLException | RuntimeException e)
|
||||
{
|
||||
connection.rollback();
|
||||
throw (e);
|
||||
}
|
||||
finally
|
||||
{
|
||||
connection.setAutoCommit(autoCommit);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Own a connection only outside an enclosing transaction.
|
||||
*******************************************************************************/
|
||||
private ConnectionLease lease() throws SQLException
|
||||
{
|
||||
return (new ConnectionLease(transactionConnection == null ? connections.get() : transactionConnection, transactionConnection == null));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A statement's connection lifetime.
|
||||
*******************************************************************************/
|
||||
private record ConnectionLease(Connection connection, boolean owned) implements AutoCloseable
|
||||
{
|
||||
/*******************************************************************************
|
||||
** Leave an enclosing transaction's connection open.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public void close() throws SQLException
|
||||
{
|
||||
if(owned)
|
||||
{
|
||||
connection.close();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -199,7 +119,7 @@ public class WebPerfStore
|
||||
*******************************************************************************/
|
||||
public int update(String template, Object... params) throws SQLException
|
||||
{
|
||||
try(ConnectionLease lease = lease(); PreparedStatement statement = lease.connection().prepareStatement(sql(template)))
|
||||
try(Connection connection = connections.get(); PreparedStatement statement = connection.prepareStatement(sql(template)))
|
||||
{
|
||||
bind(statement, params);
|
||||
return (statement.executeUpdate());
|
||||
@@ -225,8 +145,8 @@ public class WebPerfStore
|
||||
|
||||
String columns = String.join(", ", row.keySet());
|
||||
String placeholders = String.join(", ", java.util.Collections.nCopies(row.size(), "?"));
|
||||
try(ConnectionLease lease = lease();
|
||||
PreparedStatement statement = lease.connection().prepareStatement("INSERT INTO " + config.applyPrefix(table) + " (" + columns + ") VALUES (" + placeholders + ")",
|
||||
try(Connection connection = connections.get();
|
||||
PreparedStatement statement = connection.prepareStatement("INSERT INTO " + config.applyPrefix(table) + " (" + columns + ") VALUES (" + placeholders + ")",
|
||||
Statement.RETURN_GENERATED_KEYS))
|
||||
{
|
||||
bind(statement, row.values().toArray());
|
||||
@@ -251,7 +171,7 @@ public class WebPerfStore
|
||||
*******************************************************************************/
|
||||
public List<Map<String, Object>> query(String template, Object... params) throws SQLException
|
||||
{
|
||||
try(ConnectionLease lease = lease(); PreparedStatement statement = lease.connection().prepareStatement(sql(template)))
|
||||
try(Connection connection = connections.get(); PreparedStatement statement = connection.prepareStatement(sql(template)))
|
||||
{
|
||||
bind(statement, params);
|
||||
List<Map<String, Object>> rows = new ArrayList<>();
|
||||
|
||||
@@ -1,183 +0,0 @@
|
||||
/*
|
||||
* Copyright 2026 Kingsrook, 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 com.kingsrook.qbits.webperf.widgets;
|
||||
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import com.kingsrook.qbits.webperf.WebPerfFeature;
|
||||
import com.kingsrook.qbits.webperf.WebPerfQBitConfig;
|
||||
import com.kingsrook.qbits.webperf.WebPerfRuntime;
|
||||
import com.kingsrook.qbits.webperf.WebPerfSchema;
|
||||
import com.kingsrook.qbits.webperf.store.WebPerfStore;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** What is set up on the Performance home and what is next: whether pages have
|
||||
** been synced, whether budgets exist (and whether they are only the seeded
|
||||
** defaults), and whether the lab runner and Google field data are configured.
|
||||
** The checks use the runtime's own resolution (WebPerfRuntime.labRunner() and
|
||||
** cruxClient(), the url source), so the card never says "needs setup" for
|
||||
** something the runtime would in fact run.
|
||||
*******************************************************************************/
|
||||
public final class WebPerfSetupStatus
|
||||
{
|
||||
public static final String SET_UP = "Set up";
|
||||
public static final String NEEDS_SETUP = "Needs setup";
|
||||
public static final String DEFAULTS = "Using defaults";
|
||||
public static final String OPTIONAL = "Optional";
|
||||
public static final String OFF = "Off";
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** One line of the card.
|
||||
**
|
||||
** @param name what is being set up
|
||||
** @param state one of the state constants
|
||||
** @param detail what the state is (counts, and the next step)
|
||||
** @param tableName the table to open (prefixed name), or null
|
||||
*******************************************************************************/
|
||||
public record Item(String name, String state, String detail, String tableName)
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Utility class.
|
||||
*******************************************************************************/
|
||||
private WebPerfSetupStatus()
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The card's lines, in setup order.
|
||||
*******************************************************************************/
|
||||
public static List<Item> items(WebPerfRuntime runtime) throws SQLException
|
||||
{
|
||||
WebPerfQBitConfig config = runtime.getConfig();
|
||||
WebPerfStore store = runtime.store();
|
||||
List<Item> items = new ArrayList<>();
|
||||
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
// tested pages: synced from the url source (sitemap) or added by hand //
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
long pages = count(store, "SELECT COUNT(*) AS n FROM {target}");
|
||||
String target = config.applyPrefix(WebPerfSchema.TARGET);
|
||||
if(pages > 0)
|
||||
{
|
||||
items.add(new Item("Tested pages", SET_UP, pages + " page" + (pages == 1 ? "" : "s") + " are tracked.", target));
|
||||
}
|
||||
else if(config.getUrlSource() == null)
|
||||
{
|
||||
items.add(new Item("Tested pages", NEEDS_SETUP, "No pages yet and no page source is configured. Add a page by hand, or have the host set a URL source (the sitemap) in the qbit config.", target));
|
||||
}
|
||||
else
|
||||
{
|
||||
items.add(new Item("Tested pages", NEEDS_SETUP, "No pages yet. Run “Sync pages from sitemap” on Tested Pages.", target));
|
||||
}
|
||||
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
// lab runner: the configured one, else PageSpeed Insights with a key //
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
if(!config.isOn(WebPerfFeature.LAB))
|
||||
{
|
||||
items.add(new Item("Lab tests (Lighthouse)", OFF, "The LAB feature is turned off in the qbit config.", null));
|
||||
}
|
||||
else if(runtime.labRunner() != null)
|
||||
{
|
||||
items.add(new Item("Lab tests (Lighthouse)", SET_UP, "A lab runner is configured. Use “Run site audit” on Tested Pages, or wait for the schedule.", config.applyPrefix(WebPerfSchema.LAB_RUN)));
|
||||
}
|
||||
else
|
||||
{
|
||||
items.add(new Item("Lab tests (Lighthouse)", NEEDS_SETUP, "No Google API key is configured, so lab tests cannot run. The host sets googleApiKey in the qbit config (read from an environment variable).", null));
|
||||
}
|
||||
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
// budgets: the seeded reference budgets, or the admin's own //
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
long budgets = count(store, "SELECT COUNT(*) AS n FROM {budget} WHERE enabled = TRUE");
|
||||
long custom = count(store, "SELECT COUNT(*) AS n FROM {budget} WHERE enabled = TRUE AND (seeded IS NULL OR seeded = FALSE)");
|
||||
String budget = config.applyPrefix(WebPerfSchema.BUDGET);
|
||||
if(budgets == 0)
|
||||
{
|
||||
items.add(new Item("Budgets", NEEDS_SETUP, "No budget is enabled, so nothing is flagged as too slow. Add one, or enable the reference budgets.", budget));
|
||||
}
|
||||
else if(custom == 0)
|
||||
{
|
||||
items.add(new Item("Budgets", DEFAULTS, budgets + " reference budgets (Google's “good” thresholds) are enabled. Edit them or add your own.", budget));
|
||||
}
|
||||
else
|
||||
{
|
||||
items.add(new Item("Budgets", SET_UP, budgets + " budgets are enabled, " + custom + " of them your own.", budget));
|
||||
}
|
||||
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
// Google field data (CrUX) //
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
if(!config.isOn(WebPerfFeature.FIELD_CRUX))
|
||||
{
|
||||
items.add(new Item("Google field data", OFF, "The FIELD_CRUX feature is turned off in the qbit config.", null));
|
||||
}
|
||||
else if(runtime.cruxClient() != null)
|
||||
{
|
||||
items.add(new Item("Google field data", SET_UP, "Checked daily; use “Refresh Google field data” to check now.", config.applyPrefix(WebPerfSchema.FIELD_SNAPSHOT)));
|
||||
}
|
||||
else
|
||||
{
|
||||
items.add(new Item("Google field data", NEEDS_SETUP, "No Google API key is configured, so Google field data is not checked.", null));
|
||||
}
|
||||
|
||||
items.add(new Item("Regressions, changes, comparisons", OPTIONAL, "Filled in by the qbit as tests run and deploys are detected. Nothing to set up.", config.applyPrefix(WebPerfSchema.REGRESSION)));
|
||||
return (items);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The card's HTML.
|
||||
*******************************************************************************/
|
||||
public static String html(WebPerfRuntime runtime) throws SQLException
|
||||
{
|
||||
List<List<String>> rows = new ArrayList<>();
|
||||
for(Item item : items(runtime))
|
||||
{
|
||||
String color = NEEDS_SETUP.equals(item.state()) ? Html.POOR : SET_UP.equals(item.state()) ? Html.GOOD : Html.MEDIUM;
|
||||
rows.add(List.of(
|
||||
item.tableName() == null ? Html.escape(item.name()) : Html.link("/app/" + item.tableName(), item.name()),
|
||||
"<b style=\"color:" + color + "\">" + Html.escape(item.state()) + "</b>",
|
||||
Html.escape(item.detail())));
|
||||
}
|
||||
return (Html.table(List.of("Part", "State", "What is next"), rows));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
private static long count(WebPerfStore store, String sql) throws SQLException
|
||||
{
|
||||
Long n = WebPerfStore.asLong(store.query(sql).get(0).get("n"));
|
||||
return (n == null ? 0 : n);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -58,8 +58,6 @@ import com.kingsrook.qqq.backend.core.model.dashboard.widgets.RawHTML;
|
||||
*******************************************************************************/
|
||||
public final class WebPerfWidgets
|
||||
{
|
||||
public static final String SETUP = "Setup";
|
||||
public static final String NOT_CONFIGURED = "NotConfigured";
|
||||
public static final String SITE_SCORES = "SiteScores";
|
||||
public static final String TREND = "Trend";
|
||||
public static final String SLOWEST_PAGES = "SlowestPages";
|
||||
@@ -68,18 +66,8 @@ public final class WebPerfWidgets
|
||||
public static final String FIELD_STATUS = "FieldDataStatus";
|
||||
public static final String RECORD_PANEL = "RecordPanel";
|
||||
|
||||
/** The business home's widgets, in order. No provider or run-queue detail (standard A-0). */
|
||||
public static final List<String> HOME = List.of(NOT_CONFIGURED, SITE_SCORES, TREND, SLOWEST_PAGES, OPPORTUNITIES, FIELD_STATUS);
|
||||
|
||||
/**
|
||||
* The system widgets (provider setup readout, run queue). Not on the home: a host places them on its
|
||||
* Admin area. Each is gated to "<base>.admin.hasAccess" and hidden (not shown locked) without it.
|
||||
*/
|
||||
public static final List<String> ADMIN = List.of(SETUP, RECENT_RUNS);
|
||||
|
||||
/** The business empty state shown on the home while no Google API key is set. */
|
||||
public static final String NOT_CONFIGURED_TITLE = "Page speed testing is not set up";
|
||||
public static final String NOT_CONFIGURED_BODY = "Ask an admin to add a Google PageSpeed API key.";
|
||||
/** The home widgets, in order. */
|
||||
public static final List<String> HOME = List.of(SITE_SCORES, TREND, SLOWEST_PAGES, OPPORTUNITIES, FIELD_STATUS, RECENT_RUNS);
|
||||
|
||||
static final int TREND_WEEKS = 26;
|
||||
|
||||
@@ -427,54 +415,6 @@ public final class WebPerfWidgets
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Not Configured: the home's business empty state. Shown only while lab tests
|
||||
** cannot run because no Google API key is set; says who can fix it and names
|
||||
** no configuration key. Renders nothing once the provider is configured.
|
||||
*******************************************************************************/
|
||||
public static class NotConfigured extends AbstractWidgetRenderer
|
||||
{
|
||||
/*******************************************************************************
|
||||
** Render.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public RenderWidgetOutput render(RenderWidgetInput input) throws QException
|
||||
{
|
||||
if(runtime(input).labRunner() != null)
|
||||
{
|
||||
return (html(""));
|
||||
}
|
||||
return (html("<div style=\"font-weight:600\">" + Html.escape(NOT_CONFIGURED_TITLE) + "</div>" + Html.muted(NOT_CONFIGURED_BODY)));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Setup: what is configured (pages, lab runner, budgets, field data) and
|
||||
** the next step for each (WebPerfSetupStatus).
|
||||
*******************************************************************************/
|
||||
public static class Setup extends AbstractWidgetRenderer
|
||||
{
|
||||
/*******************************************************************************
|
||||
** Render.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public RenderWidgetOutput render(RenderWidgetInput input) throws QException
|
||||
{
|
||||
try
|
||||
{
|
||||
return (html(WebPerfSetupStatus.html(runtime(input))));
|
||||
}
|
||||
catch(SQLException e)
|
||||
{
|
||||
throw (new QException("Error loading setup status", e));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Field Data Status: what Google's field data (CrUX) says about the site,
|
||||
** honestly NO_DATA when Google has none.
|
||||
|
||||
@@ -261,173 +261,3 @@ SELECT name, scope, scope_value, source, strategy, metric, comparator, threshold
|
||||
UNION ALL SELECT 'Performance at least 50 (KEY pages)', 'TIER', 'KEY', 'LAB', NULL, 'PERFORMANCE_SCORE', '>=', 50, 'CRITICAL'
|
||||
) seeds
|
||||
WHERE NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}budget WHERE seeded = TRUE);
|
||||
|
||||
|
||||
-- changeset qbit-web-performance:11
|
||||
-- comment: Durable evaluation progress, event identity and comparison page identity. Existing history is preserved.
|
||||
ALTER TABLE ${web_performance.tablePrefix}lab_run ADD COLUMN evaluated_at TIMESTAMP WITHOUT TIME ZONE;
|
||||
ALTER TABLE ${web_performance.tablePrefix}lab_run ADD COLUMN change_event_id BIGINT;
|
||||
ALTER TABLE ${web_performance.tablePrefix}regression ADD COLUMN first_run_id BIGINT;
|
||||
ALTER TABLE ${web_performance.tablePrefix}regression ADD COLUMN checkpoint_run_id BIGINT;
|
||||
ALTER TABLE ${web_performance.tablePrefix}regression ADD COLUMN lighthouse_major VARCHAR(20);
|
||||
ALTER TABLE ${web_performance.tablePrefix}change_event ADD COLUMN event_key VARCHAR(64);
|
||||
ALTER TABLE ${web_performance.tablePrefix}change_event ADD COLUMN site_key VARCHAR(200);
|
||||
ALTER TABLE ${web_performance.tablePrefix}comparison ADD COLUMN target_id BIGINT;
|
||||
CREATE UNIQUE INDEX uq_${web_performance.tablePrefix}change_event_key ON ${web_performance.tablePrefix}change_event (event_key);
|
||||
CREATE UNIQUE INDEX uq_${web_performance.tablePrefix}comparison_page ON ${web_performance.tablePrefix}comparison (change_event_id, target_id, source, strategy, metric, segment);
|
||||
CREATE INDEX idx_${web_performance.tablePrefix}lab_evaluation ON ${web_performance.tablePrefix}lab_run (evaluated_at, status, id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}regression ADD COLUMN failed_audits VARCHAR(2000);
|
||||
ALTER TABLE ${web_performance.tablePrefix}lab_run ADD COLUMN ttfb_ms INTEGER;
|
||||
ALTER TABLE ${web_performance.tablePrefix}field_snapshot ADD COLUMN evaluated_at TIMESTAMP WITHOUT TIME ZONE;
|
||||
ALTER TABLE ${web_performance.tablePrefix}change_event ADD COLUMN last_seen_at TIMESTAMP WITHOUT TIME ZONE;
|
||||
|
||||
-- changeset qbit-web-performance:12
|
||||
-- comment: Referential integrity (foreign keys), part 1: every foreign key column leads an index, so a parent delete checks its children by index. The other foreign key columns already lead one (target_id, run_id, change_event_id on comparison).
|
||||
CREATE INDEX IF NOT EXISTS idx_${web_performance.tablePrefix}lab_run_change_event ON ${web_performance.tablePrefix}lab_run (change_event_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_${web_performance.tablePrefix}regression_budget ON ${web_performance.tablePrefix}regression (budget_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_${web_performance.tablePrefix}regression_cause ON ${web_performance.tablePrefix}regression (cause_change_event_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_${web_performance.tablePrefix}regression_first_run ON ${web_performance.tablePrefix}regression (first_run_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_${web_performance.tablePrefix}regression_checkpoint_run ON ${web_performance.tablePrefix}regression (checkpoint_run_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_${web_performance.tablePrefix}comparison_target ON ${web_performance.tablePrefix}comparison (target_id);
|
||||
|
||||
-- Referential integrity (foreign keys), part 2: one changeset per foreign key, named
|
||||
-- fk_<child table>_<column>. Each first records and repairs rows whose parent is
|
||||
-- missing (a nullable column is set to NULL; a NOT NULL row is copied in full to
|
||||
-- qqq_fk_quarantine and deleted, PostgreSQL only), then adds the constraint. Each
|
||||
-- is marked ran when its constraint already exists (a host that added it itself).
|
||||
-- ON DELETE: owned details CASCADE (findings and the report of a run,
|
||||
-- comparisons of a site change); optional pointers SET NULL; tested pages and
|
||||
-- budgets RESTRICT, because history is kept (D8): disable a page or budget instead
|
||||
-- of deleting it.
|
||||
|
||||
-- changeset qbit-web-performance:13
|
||||
-- comment: Lab runs keep their tested page (D8, history is kept): a page with runs cannot be deleted, disable it instead (enabled = false). Orphan target_id values are recorded in qqq_fk_quarantine and set to NULL.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}lab_run_target_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, changeset) SELECT '${web_performance.tablePrefix}lab_run', 'target_id', CAST(c.id AS VARCHAR(100)), CAST(c.target_id AS VARCHAR(100)), 'NULLED', 'qbit-web-performance:13' FROM ${web_performance.tablePrefix}lab_run c WHERE c.target_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}target p WHERE p.id = c.target_id);
|
||||
UPDATE ${web_performance.tablePrefix}lab_run c SET target_id = NULL WHERE c.target_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}target p WHERE p.id = c.target_id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}lab_run ADD CONSTRAINT fk_${web_performance.tablePrefix}lab_run_target_id FOREIGN KEY (target_id) REFERENCES ${web_performance.tablePrefix}target (id) ON DELETE RESTRICT;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}lab_run DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}lab_run_target_id;
|
||||
|
||||
-- changeset qbit-web-performance:14 dbms:postgresql
|
||||
-- comment: Orphan cleanup before fk_${web_performance.tablePrefix}lab_finding_run_id: ${web_performance.tablePrefix}lab_finding rows whose run_id names a missing ${web_performance.tablePrefix}lab_run row are copied in full to qqq_fk_quarantine, then deleted (run_id is NOT NULL).
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}lab_finding_run_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, row_data, changeset) SELECT '${web_performance.tablePrefix}lab_finding', 'run_id', CAST(c.id AS VARCHAR(100)), CAST(c.run_id AS VARCHAR(100)), 'DELETED', row_to_json(c)::text, 'qbit-web-performance:14' FROM ${web_performance.tablePrefix}lab_finding c WHERE c.run_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}lab_run p WHERE p.id = c.run_id);
|
||||
DELETE FROM ${web_performance.tablePrefix}lab_finding c WHERE c.run_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}lab_run p WHERE p.id = c.run_id);
|
||||
-- rollback SELECT 1;
|
||||
|
||||
-- changeset qbit-web-performance:15
|
||||
-- comment: Findings belong to their run: deleting a run deletes its findings.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}lab_finding_run_id'
|
||||
ALTER TABLE ${web_performance.tablePrefix}lab_finding ADD CONSTRAINT fk_${web_performance.tablePrefix}lab_finding_run_id FOREIGN KEY (run_id) REFERENCES ${web_performance.tablePrefix}lab_run (id) ON DELETE CASCADE;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}lab_finding DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}lab_finding_run_id;
|
||||
|
||||
-- changeset qbit-web-performance:16
|
||||
-- comment: A finding's page (copied from its run) is kept like the run's. Orphan target_id values are recorded in qqq_fk_quarantine and set to NULL.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}lab_finding_target_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, changeset) SELECT '${web_performance.tablePrefix}lab_finding', 'target_id', CAST(c.id AS VARCHAR(100)), CAST(c.target_id AS VARCHAR(100)), 'NULLED', 'qbit-web-performance:16' FROM ${web_performance.tablePrefix}lab_finding c WHERE c.target_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}target p WHERE p.id = c.target_id);
|
||||
UPDATE ${web_performance.tablePrefix}lab_finding c SET target_id = NULL WHERE c.target_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}target p WHERE p.id = c.target_id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}lab_finding ADD CONSTRAINT fk_${web_performance.tablePrefix}lab_finding_target_id FOREIGN KEY (target_id) REFERENCES ${web_performance.tablePrefix}target (id) ON DELETE RESTRICT;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}lab_finding DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}lab_finding_target_id;
|
||||
|
||||
-- changeset qbit-web-performance:17 dbms:postgresql
|
||||
-- comment: Orphan cleanup before fk_${web_performance.tablePrefix}lab_report_run_id: ${web_performance.tablePrefix}lab_report rows whose run_id names a missing ${web_performance.tablePrefix}lab_run row are copied in full to qqq_fk_quarantine, then deleted (run_id is NOT NULL).
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}lab_report_run_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, row_data, changeset) SELECT '${web_performance.tablePrefix}lab_report', 'run_id', CAST(c.id AS VARCHAR(100)), CAST(c.run_id AS VARCHAR(100)), 'DELETED', row_to_json(c)::text, 'qbit-web-performance:17' FROM ${web_performance.tablePrefix}lab_report c WHERE c.run_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}lab_run p WHERE p.id = c.run_id);
|
||||
DELETE FROM ${web_performance.tablePrefix}lab_report c WHERE c.run_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}lab_run p WHERE p.id = c.run_id);
|
||||
-- rollback SELECT 1;
|
||||
|
||||
-- changeset qbit-web-performance:18
|
||||
-- comment: The Lighthouse report belongs to its run: deleting a run deletes its report.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}lab_report_run_id'
|
||||
ALTER TABLE ${web_performance.tablePrefix}lab_report ADD CONSTRAINT fk_${web_performance.tablePrefix}lab_report_run_id FOREIGN KEY (run_id) REFERENCES ${web_performance.tablePrefix}lab_run (id) ON DELETE CASCADE;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}lab_report DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}lab_report_run_id;
|
||||
|
||||
-- changeset qbit-web-performance:19
|
||||
-- comment: Regressions keep their page: a page with regressions cannot be deleted, disable it instead. Orphan target_id values are recorded in qqq_fk_quarantine and set to NULL.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}regression_target_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, changeset) SELECT '${web_performance.tablePrefix}regression', 'target_id', CAST(c.id AS VARCHAR(100)), CAST(c.target_id AS VARCHAR(100)), 'NULLED', 'qbit-web-performance:19' FROM ${web_performance.tablePrefix}regression c WHERE c.target_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}target p WHERE p.id = c.target_id);
|
||||
UPDATE ${web_performance.tablePrefix}regression c SET target_id = NULL WHERE c.target_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}target p WHERE p.id = c.target_id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}regression ADD CONSTRAINT fk_${web_performance.tablePrefix}regression_target_id FOREIGN KEY (target_id) REFERENCES ${web_performance.tablePrefix}target (id) ON DELETE RESTRICT;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}regression DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}regression_target_id;
|
||||
|
||||
-- changeset qbit-web-performance:20
|
||||
-- comment: A regression keeps the budget it breached: a budget with regressions cannot be deleted, disable it instead (enabled = false). Orphan budget_id values are recorded in qqq_fk_quarantine and set to NULL.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}regression_budget_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, changeset) SELECT '${web_performance.tablePrefix}regression', 'budget_id', CAST(c.id AS VARCHAR(100)), CAST(c.budget_id AS VARCHAR(100)), 'NULLED', 'qbit-web-performance:20' FROM ${web_performance.tablePrefix}regression c WHERE c.budget_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}budget p WHERE p.id = c.budget_id);
|
||||
UPDATE ${web_performance.tablePrefix}regression c SET budget_id = NULL WHERE c.budget_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}budget p WHERE p.id = c.budget_id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}regression ADD CONSTRAINT fk_${web_performance.tablePrefix}regression_budget_id FOREIGN KEY (budget_id) REFERENCES ${web_performance.tablePrefix}budget (id) ON DELETE RESTRICT;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}regression DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}regression_budget_id;
|
||||
|
||||
-- changeset qbit-web-performance:21
|
||||
-- comment: The likely cause is an optional pointer: deleting the site change clears it. Orphan values are recorded in qqq_fk_quarantine and set to NULL.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}regression_cause_change_event_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, changeset) SELECT '${web_performance.tablePrefix}regression', 'cause_change_event_id', CAST(c.id AS VARCHAR(100)), CAST(c.cause_change_event_id AS VARCHAR(100)), 'NULLED', 'qbit-web-performance:21' FROM ${web_performance.tablePrefix}regression c WHERE c.cause_change_event_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}change_event p WHERE p.id = c.cause_change_event_id);
|
||||
UPDATE ${web_performance.tablePrefix}regression c SET cause_change_event_id = NULL WHERE c.cause_change_event_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}change_event p WHERE p.id = c.cause_change_event_id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}regression ADD CONSTRAINT fk_${web_performance.tablePrefix}regression_cause_change_event_id FOREIGN KEY (cause_change_event_id) REFERENCES ${web_performance.tablePrefix}change_event (id) ON DELETE SET NULL;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}regression DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}regression_cause_change_event_id;
|
||||
|
||||
-- changeset qbit-web-performance:22
|
||||
-- comment: A before-and-after comparison is computed for its site change: deleting the change deletes its comparisons. Orphan values are recorded in qqq_fk_quarantine and set to NULL.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}comparison_change_event_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, changeset) SELECT '${web_performance.tablePrefix}comparison', 'change_event_id', CAST(c.id AS VARCHAR(100)), CAST(c.change_event_id AS VARCHAR(100)), 'NULLED', 'qbit-web-performance:22' FROM ${web_performance.tablePrefix}comparison c WHERE c.change_event_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}change_event p WHERE p.id = c.change_event_id);
|
||||
UPDATE ${web_performance.tablePrefix}comparison c SET change_event_id = NULL WHERE c.change_event_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}change_event p WHERE p.id = c.change_event_id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}comparison ADD CONSTRAINT fk_${web_performance.tablePrefix}comparison_change_event_id FOREIGN KEY (change_event_id) REFERENCES ${web_performance.tablePrefix}change_event (id) ON DELETE CASCADE;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}comparison DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}comparison_change_event_id;
|
||||
|
||||
-- changeset qbit-web-performance:23
|
||||
-- comment: The site change a run was attributed to is an optional pointer: deleting the change clears it. Orphan values are recorded in qqq_fk_quarantine and set to NULL.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}lab_run_change_event_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, changeset) SELECT '${web_performance.tablePrefix}lab_run', 'change_event_id', CAST(c.id AS VARCHAR(100)), CAST(c.change_event_id AS VARCHAR(100)), 'NULLED', 'qbit-web-performance:23' FROM ${web_performance.tablePrefix}lab_run c WHERE c.change_event_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}change_event p WHERE p.id = c.change_event_id);
|
||||
UPDATE ${web_performance.tablePrefix}lab_run c SET change_event_id = NULL WHERE c.change_event_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}change_event p WHERE p.id = c.change_event_id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}lab_run ADD CONSTRAINT fk_${web_performance.tablePrefix}lab_run_change_event_id FOREIGN KEY (change_event_id) REFERENCES ${web_performance.tablePrefix}change_event (id) ON DELETE SET NULL;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}lab_run DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}lab_run_change_event_id;
|
||||
|
||||
-- changeset qbit-web-performance:24
|
||||
-- comment: Evidence pointer to the run that first showed the regression: deleting the run clears it. Orphan values are recorded in qqq_fk_quarantine and set to NULL.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}regression_first_run_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, changeset) SELECT '${web_performance.tablePrefix}regression', 'first_run_id', CAST(c.id AS VARCHAR(100)), CAST(c.first_run_id AS VARCHAR(100)), 'NULLED', 'qbit-web-performance:24' FROM ${web_performance.tablePrefix}regression c WHERE c.first_run_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}lab_run p WHERE p.id = c.first_run_id);
|
||||
UPDATE ${web_performance.tablePrefix}regression c SET first_run_id = NULL WHERE c.first_run_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}lab_run p WHERE p.id = c.first_run_id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}regression ADD CONSTRAINT fk_${web_performance.tablePrefix}regression_first_run_id FOREIGN KEY (first_run_id) REFERENCES ${web_performance.tablePrefix}lab_run (id) ON DELETE SET NULL;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}regression DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}regression_first_run_id;
|
||||
|
||||
-- changeset qbit-web-performance:25
|
||||
-- comment: Evidence pointer to the confirmation run: deleting the run clears it. Orphan values are recorded in qqq_fk_quarantine and set to NULL.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}regression_checkpoint_run_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, changeset) SELECT '${web_performance.tablePrefix}regression', 'checkpoint_run_id', CAST(c.id AS VARCHAR(100)), CAST(c.checkpoint_run_id AS VARCHAR(100)), 'NULLED', 'qbit-web-performance:25' FROM ${web_performance.tablePrefix}regression c WHERE c.checkpoint_run_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}lab_run p WHERE p.id = c.checkpoint_run_id);
|
||||
UPDATE ${web_performance.tablePrefix}regression c SET checkpoint_run_id = NULL WHERE c.checkpoint_run_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}lab_run p WHERE p.id = c.checkpoint_run_id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}regression ADD CONSTRAINT fk_${web_performance.tablePrefix}regression_checkpoint_run_id FOREIGN KEY (checkpoint_run_id) REFERENCES ${web_performance.tablePrefix}lab_run (id) ON DELETE SET NULL;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}regression DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}regression_checkpoint_run_id;
|
||||
|
||||
-- changeset qbit-web-performance:26
|
||||
-- comment: A per-page comparison keeps its page: a page with comparisons cannot be deleted, disable it instead. Orphan target_id values are recorded in qqq_fk_quarantine and set to NULL.
|
||||
-- preconditions onFail:MARK_RAN onError:HALT
|
||||
-- precondition-sql-check expectedResult:0 SELECT COUNT(*) FROM information_schema.table_constraints WHERE LOWER(constraint_name) = 'fk_${web_performance.tablePrefix}comparison_target_id'
|
||||
CREATE TABLE IF NOT EXISTS qqq_fk_quarantine (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, table_name VARCHAR(100) NOT NULL, column_name VARCHAR(100) NOT NULL, row_id VARCHAR(100), missing_parent_id VARCHAR(100), action VARCHAR(20) NOT NULL, row_data TEXT, changeset VARCHAR(200), quarantined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);
|
||||
INSERT INTO qqq_fk_quarantine (table_name, column_name, row_id, missing_parent_id, action, changeset) SELECT '${web_performance.tablePrefix}comparison', 'target_id', CAST(c.id AS VARCHAR(100)), CAST(c.target_id AS VARCHAR(100)), 'NULLED', 'qbit-web-performance:26' FROM ${web_performance.tablePrefix}comparison c WHERE c.target_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}target p WHERE p.id = c.target_id);
|
||||
UPDATE ${web_performance.tablePrefix}comparison c SET target_id = NULL WHERE c.target_id IS NOT NULL AND NOT EXISTS (SELECT 1 FROM ${web_performance.tablePrefix}target p WHERE p.id = c.target_id);
|
||||
ALTER TABLE ${web_performance.tablePrefix}comparison ADD CONSTRAINT fk_${web_performance.tablePrefix}comparison_target_id FOREIGN KEY (target_id) REFERENCES ${web_performance.tablePrefix}target (id) ON DELETE RESTRICT;
|
||||
-- rollback ALTER TABLE ${web_performance.tablePrefix}comparison DROP CONSTRAINT IF EXISTS fk_${web_performance.tablePrefix}comparison_target_id;
|
||||
@@ -1,666 +0,0 @@
|
||||
bundle: qbit-web-performance
|
||||
version: ${project.version}
|
||||
layer: QBIT
|
||||
entries:
|
||||
- key: app:webPerformance;slot:help
|
||||
summary: Page speed tests, Google field data, budgets and regressions for your site.
|
||||
content: |
|
||||
Sync your pages and review your budgets, then run tests. The dashboard shows site scores, trends, slow pages, opportunities and field data. If page speed testing is not set up, it says so and tells you to ask an admin.
|
||||
|
||||
Run **{{label:webPerformanceTestPageSpeed}}** for selected pages or **{{label:webPerformanceRunSiteAudit}}** for all enabled pages. Mobile and desktop are separate runs by default. Your host controls the enabled features, device strategies, daily run limit and scheduler. Without a configured runner, lab tests wait in the queue.
|
||||
|
||||
Review **{{label:web_performance_regression}}** for budget breaches and performance changes. Testing requires the testing permission; syncing pages and refreshing field data require administrator permission.
|
||||
- key: table:web_performance_target;slot:help
|
||||
summary: Every public page that is tested for speed, with its latest scores.
|
||||
content: |
|
||||
**How rows get created:** Sync pages from your URL source, or add an HTTPS URL with New.
|
||||
|
||||
Use this list to choose which pages you test and review their latest scores. **{{label:webPerformanceSyncPages}}** imports URLs from your configured URL source. Pages that disappear from the source are retained with their history. You can also add an HTTPS URL with **New**.
|
||||
|
||||
Edit the URL, friendly label, tier or enabled setting as needed. Disable a page to skip it when queuing tests. Mark important pages as key pages to include them in key-page tests and site scores.
|
||||
|
||||
Use **{{label:webPerformanceTestPageSpeed}}** for selected pages or **{{label:webPerformanceRunSiteAudit}}** for all enabled pages. Results update after successful tests; the Performance section shows the latest results.
|
||||
- key: table:web_performance_target;section:page
|
||||
summary: 'The page address and the settings you can change: label, tier and whether it is tested.'
|
||||
- key: table:web_performance_target;section:latest
|
||||
summary: The most recent successful test scores for this page and how many regressions are open.
|
||||
- key: table:web_performance_target;section:source
|
||||
summary: Where the page came from and which content record it belongs to.
|
||||
- key: table:web_performance_target;section:dates
|
||||
summary: When the record was created and last changed.
|
||||
- key: table:web_performance_target;section:webPerformancePerformance
|
||||
summary: Latest mobile and desktop test results for this page, with a note when a test is waiting.
|
||||
- key: table:web_performance_target;field:siteKey
|
||||
summary: Which site the page belongs to. Filled in automatically.
|
||||
- key: table:web_performance_target;field:url
|
||||
summary: The full address that is tested. Together with the site it is unique.
|
||||
- key: table:web_performance_target;field:path
|
||||
summary: The page address without the domain, such as /contact. Filled in automatically from the URL.
|
||||
- key: table:web_performance_target;field:source
|
||||
summary: How the page was added. Pages from the sitemap show SITEMAP.
|
||||
- key: table:web_performance_target;field:contentTable
|
||||
summary: The kind of content record this page shows, such as a page or blog post, when one could be matched.
|
||||
content: |
|
||||
Your configured URL source can link a page to a content record. Empty when no content record is linked.
|
||||
- key: table:web_performance_target;field:contentId
|
||||
summary: The id of the content record this page shows. Filled in automatically with the content kind.
|
||||
- key: table:web_performance_target;field:label
|
||||
summary: A friendly name for the page, shown in lists and charts instead of the address. Optional.
|
||||
- key: table:web_performance_target;field:tier
|
||||
summary: Choose key pages for frequent tests and site scores, or standard pages for site audits.
|
||||
content: |
|
||||
Choose from {{values:web_performance_tier}}. New pages use **{{default:web_performance_target.tier}}** unless the configured URL source assigns another tier. Scheduled tests require your host to configure a scheduler.
|
||||
- key: table:web_performance_target;field:enabled
|
||||
summary: Turn off to stop testing this page.
|
||||
content: |
|
||||
New pages start enabled. Disabled pages are skipped by the daily tests, the site audit and **{{label:webPerformanceTestPageSpeed}}**.
|
||||
- key: table:web_performance_target;field:inSitemap
|
||||
summary: Whether the page was in the sitemap the last time it was synced.
|
||||
content: |
|
||||
Turned off, not deleted, when a page leaves the sitemap. Its test history stays.
|
||||
- key: table:web_performance_target;field:lastSeenInSitemapAt
|
||||
summary: The last time a sitemap sync found this page listed.
|
||||
- key: table:web_performance_target;field:latestMobilePerformance
|
||||
summary: Performance score (0 to 100) of the latest successful mobile test. Higher is better.
|
||||
- key: table:web_performance_target;field:latestDesktopPerformance
|
||||
summary: Performance score (0 to 100) of the latest successful desktop test. Higher is better.
|
||||
- key: table:web_performance_target;field:latestAccessibility
|
||||
summary: Accessibility score (0 to 100) of the latest successful test. Higher is better.
|
||||
- key: table:web_performance_target;field:latestTestedAt
|
||||
summary: When the latest successful test of this page finished.
|
||||
- key: table:web_performance_target;field:openRegressionCount
|
||||
summary: How many unresolved regressions the page has. Filled in automatically.
|
||||
content: |
|
||||
Counts suspected and confirmed regressions for this page. Review **{{label:web_performance_regression}}** for details.
|
||||
- key: table:web_performance_lab_run;slot:help
|
||||
summary: 'Every Lighthouse test: one page, one device type, from waiting in line to its final result.'
|
||||
content: |
|
||||
**How rows get created:** Queue tests with Test page speed or Run site audit, or let configured schedules queue them.
|
||||
|
||||
Each row is a single test of one page on either mobile or desktop. Runs are created when you use **{{label:webPerformanceTestPageSpeed}}**, **{{label:webPerformanceRunSiteAudit}}**, or configured schedules. With a scheduler, the worker picks up waiting runs every minute by default.
|
||||
|
||||
Scores are 0 to 100. Lab metrics are in milliseconds except **{{label:web_performance_lab_run.cls}}**, which has no unit. If Google is busy or fails, the run is tried up to 3 times in total, waiting 1 minute and then 5 minutes between tries.
|
||||
|
||||
A run that ends as **FAILED**, **RUNTIME_ERROR** or **SKIPPED_QUOTA** can be re-queued with the **{{label:webPerformanceRetryRuns}}** action, which makes a new run and keeps the old one.
|
||||
|
||||
Nothing here can be edited. The full Lighthouse report for each successful run is kept under **{{label:web_performance_lab_report}}**, and its problems are listed under **{{label:web_performance_lab_finding}}**. Lab scores vary a little from run to run, so look at trends rather than single runs.
|
||||
- key: table:web_performance_lab_run;section:run
|
||||
summary: Which page was tested, on which device type, why, and how it ended.
|
||||
- key: table:web_performance_lab_run;section:scores
|
||||
summary: The four Lighthouse category scores, from 0 to 100.
|
||||
- key: table:web_performance_lab_run;section:metrics
|
||||
summary: Measured load times in milliseconds, plus layout shift (no unit).
|
||||
- key: table:web_performance_lab_run;section:details
|
||||
summary: Queue timing, attempts, errors and the test environment.
|
||||
- key: table:web_performance_lab_run;section:dates
|
||||
summary: When the record was created and last changed.
|
||||
- key: table:web_performance_lab_run;field:targetId
|
||||
summary: The tested page this run belongs to.
|
||||
- key: table:web_performance_lab_run;field:url
|
||||
summary: The address that was tested.
|
||||
- key: table:web_performance_lab_run;field:finalUrl
|
||||
summary: The address the page ended up on after any redirects.
|
||||
content: |
|
||||
Filled in from the test result. If it differs from **{{label:web_performance_lab_run.url}}**, the page redirects.
|
||||
- key: table:web_performance_lab_run;field:strategy
|
||||
summary: 'Which device the test simulated: MOBILE (phone) or DESKTOP.'
|
||||
content: |
|
||||
Mobile and desktop are always separate runs.
|
||||
- key: table:web_performance_lab_run;field:runner
|
||||
summary: The service that ran the test. Currently PSI, Google PageSpeed Insights.
|
||||
- key: table:web_performance_lab_run;field:triggerType
|
||||
summary: Why the test was queued.
|
||||
content: |
|
||||
Why the test was queued: MANUAL, SCHEDULE or SITE_AUDIT.
|
||||
|
||||
**MANUAL** means someone used **{{label:webPerformanceTestPageSpeed}}** or **{{label:webPerformanceRetryRuns}}**. **SCHEDULE** is a scheduled key-page test. **SITE_AUDIT** is the site audit of every enabled page.
|
||||
- key: table:web_performance_lab_run;field:triggerRef
|
||||
summary: A short note on what caused the run, such as the action and who used it.
|
||||
- key: table:web_performance_lab_run;field:batchId
|
||||
summary: Identifier shared by runs queued together, such as both devices of one page.
|
||||
- key: table:web_performance_lab_run;field:status
|
||||
summary: Where the run is, from queued through completion, failure or being skipped.
|
||||
content: |
|
||||
Where the run is: QUEUED, RUNNING, SUCCEEDED, RUNTIME_ERROR, FAILED or SKIPPED_QUOTA.
|
||||
|
||||
- **QUEUED**: waiting its turn (or waiting for a retry, or for a Google API key).
|
||||
- **RUNNING**: being tested now.
|
||||
- **SUCCEEDED**: finished with scores.
|
||||
- **RUNTIME_ERROR**: Lighthouse could not test the page; see **{{label:web_performance_lab_run.errorMessage}}**.
|
||||
- **FAILED**: the test failed after its attempts; see **{{label:web_performance_lab_run.errorMessage}}**.
|
||||
- **SKIPPED_QUOTA**: not run because the daily cap was reached. Use **{{label:webPerformanceRetryRuns}}**.
|
||||
- key: table:web_performance_lab_run;field:notBefore
|
||||
summary: The earliest time the run may start. Used for retry waits.
|
||||
- key: table:web_performance_lab_run;field:queuedAt
|
||||
summary: When the run was added to the queue.
|
||||
- key: table:web_performance_lab_run;field:startedAt
|
||||
summary: When the worker last picked the run up.
|
||||
- key: table:web_performance_lab_run;field:completedAt
|
||||
summary: When the run reached its final result.
|
||||
- key: table:web_performance_lab_run;field:attempts
|
||||
summary: How many times the test has been tried. A run is tried at most 3 times.
|
||||
- key: table:web_performance_lab_run;field:httpStatus
|
||||
summary: The HTTP status Google answered with. 200 means the test was returned.
|
||||
- key: table:web_performance_lab_run;field:errorMessage
|
||||
summary: Why the run failed or could not test the page. Empty on success.
|
||||
- key: table:web_performance_lab_run;field:lighthouseVersion
|
||||
summary: The Lighthouse version that scored the page.
|
||||
content: |
|
||||
Scores and audits from different major versions are not directly comparable.
|
||||
- key: table:web_performance_lab_run;field:chromeUserAgent
|
||||
summary: The browser Google used for the test.
|
||||
- key: table:web_performance_lab_run;field:benchmarkIndex
|
||||
summary: Google's measure of how fast the testing machine was at the time.
|
||||
content: |
|
||||
Lower numbers mean a slower machine, which can make scores look worse.
|
||||
- key: table:web_performance_lab_run;field:scorePerformance
|
||||
summary: Lighthouse Performance score, 0 to 100. Higher is better.
|
||||
content: |
|
||||
90 and above is good, 50 to 89 needs improvement and below 50 is poor.
|
||||
- key: table:web_performance_lab_run;field:scoreAccessibility
|
||||
summary: Lighthouse Accessibility score, 0 to 100. Higher is better.
|
||||
- key: table:web_performance_lab_run;field:scoreBestPractices
|
||||
summary: Lighthouse Best Practices score, 0 to 100. Higher is better.
|
||||
- key: table:web_performance_lab_run;field:scoreSeo
|
||||
summary: Lighthouse SEO score, 0 to 100. Higher is better.
|
||||
- key: table:web_performance_lab_run;field:fcpMs
|
||||
summary: 'First Contentful Paint in milliseconds: when anything first appears on screen.'
|
||||
- key: table:web_performance_lab_run;field:lcpMs
|
||||
summary: 'Largest Contentful Paint in milliseconds: when the biggest element on screen has loaded.'
|
||||
content: |
|
||||
Google considers 2,500 ms or less good.
|
||||
- key: table:web_performance_lab_run;field:tbtMs
|
||||
summary: 'Total Blocking Time in milliseconds: how long the page was unresponsive while loading.'
|
||||
- key: table:web_performance_lab_run;field:cls
|
||||
summary: 'Cumulative Layout Shift: how much the page jumps around while loading. No unit.'
|
||||
content: |
|
||||
Google considers 0.1 or less good.
|
||||
- key: table:web_performance_lab_run;field:speedIndexMs
|
||||
summary: 'Speed Index in milliseconds: how quickly the visible part of the page fills in.'
|
||||
- key: table:web_performance_lab_run;field:lcpElement
|
||||
summary: The largest element painted, as a page selector. Useful for finding what to speed up.
|
||||
- key: table:web_performance_lab_run;field:runWarnings
|
||||
summary: Warnings Lighthouse reported about the test itself, joined together.
|
||||
- key: table:web_performance_lab_run;field:deploymentId
|
||||
summary: The observed frontend build associated with this run, when available.
|
||||
content: |
|
||||
Filled from recorded site changes when deployment information is available.
|
||||
- key: table:web_performance_lab_run;field:cdnStage
|
||||
summary: The observed CDN stage associated with this run, when available.
|
||||
content: |
|
||||
Filled from recorded site changes when CDN stage information is available.
|
||||
- key: table:web_performance_lab_finding;slot:help
|
||||
summary: The problems and tips Lighthouse reported for each test, with how much time or data fixing them could save.
|
||||
content: |
|
||||
**How rows get created:** Successful lab tests create findings for audits that did not fully pass.
|
||||
|
||||
Each row is one audit from one run that did not fully pass (scored below 0.9). Use it to find what to fix: sort by **{{label:web_performance_lab_finding.savingsMs}}** or **{{label:web_performance_lab_finding.savingsBytes}}** to see the biggest wins.
|
||||
|
||||
Findings are grouped by **{{label:web_performance_lab_finding.category}}** and **{{label:web_performance_lab_finding.kind}}**. **{{label:web_performance_lab_finding.auditId}}** is Lighthouse's own id for the check. Lighthouse 13 replaced most performance audits with new "insight" audits, so audit ids are kept with the Lighthouse version and should not be compared across major versions.
|
||||
|
||||
Nothing here can be edited. Findings are created when a run succeeds. The **{{label:web_performance_lab_finding.topItems}}** column lists up to five example files or page elements involved.
|
||||
- key: table:web_performance_lab_finding;section:finding
|
||||
summary: What was found, its kind and category, and the estimated saving.
|
||||
- key: table:web_performance_lab_finding;section:details
|
||||
summary: The run and page it came from, the audit id, the raw score and supporting detail.
|
||||
- key: table:web_performance_lab_finding;section:dates
|
||||
summary: When the record was created and last changed.
|
||||
- key: table:web_performance_lab_finding;field:runId
|
||||
summary: The lab run this finding came from.
|
||||
- key: table:web_performance_lab_finding;field:targetId
|
||||
summary: The tested page this finding applies to.
|
||||
- key: table:web_performance_lab_finding;field:strategy
|
||||
summary: 'The device type of the run: MOBILE or DESKTOP.'
|
||||
- key: table:web_performance_lab_finding;field:category
|
||||
summary: Which Lighthouse category the audit belongs to.
|
||||
content: |
|
||||
Which Lighthouse category the audit belongs to: PERFORMANCE, ACCESSIBILITY, BEST_PRACTICES or SEO.
|
||||
- key: table:web_performance_lab_finding;field:auditId
|
||||
summary: Lighthouse's own name for the check, such as a short hyphenated id.
|
||||
content: |
|
||||
Useful for searching Google's documentation. Ids change between Lighthouse major versions.
|
||||
- key: table:web_performance_lab_finding;field:lighthouseVersion
|
||||
summary: The Lighthouse version that produced the finding.
|
||||
- key: table:web_performance_lab_finding;field:kind
|
||||
summary: The type of finding returned by Lighthouse.
|
||||
content: |
|
||||
The type of finding: INSIGHT, OPPORTUNITY, DIAGNOSTIC or FAILED_AUDIT.
|
||||
|
||||
- **INSIGHT**: a performance audit from Lighthouse 13 (audit ids ending in "-insight").
|
||||
- **OPPORTUNITY**: a performance fix with an estimated saving.
|
||||
- **DIAGNOSTIC**: other performance information worth reviewing.
|
||||
- **FAILED_AUDIT**: a failed check in Accessibility, Best Practices or SEO.
|
||||
- key: table:web_performance_lab_finding;field:title
|
||||
summary: The plain-language name of the problem, as Lighthouse words it.
|
||||
- key: table:web_performance_lab_finding;field:score
|
||||
summary: The audit's own score from 0 to 1. Only audits below 0.9 are kept.
|
||||
- key: table:web_performance_lab_finding;field:displayValue
|
||||
summary: A short result Lighthouse shows with the audit, such as a size or time.
|
||||
- key: table:web_performance_lab_finding;field:savingsMs
|
||||
summary: Estimated time saved in milliseconds if this is fixed. Empty when Lighthouse gives no estimate.
|
||||
- key: table:web_performance_lab_finding;field:savingsBytes
|
||||
summary: Estimated data saved in bytes if this is fixed. Empty when Lighthouse gives no estimate.
|
||||
- key: table:web_performance_lab_finding;field:metricSavings
|
||||
summary: Estimated improvement to each metric, as raw Lighthouse data.
|
||||
- key: table:web_performance_lab_finding;field:topItems
|
||||
summary: Up to five example addresses or page elements involved, as a list.
|
||||
- key: table:web_performance_regression;slot:help
|
||||
summary: Drops in speed or breaches of a budget, kept as records to review and resolve.
|
||||
content: |
|
||||
**How rows get created:** Evaluation of lab and field results creates regressions for budget breaches and performance changes.
|
||||
|
||||
Review pages that breached a budget or changed from their baseline. Evaluation creates suspected regressions and uses further evidence to confirm or reject them; recovery can resolve them automatically.
|
||||
|
||||
Use **{{label:webPerformanceResolveRegressions}}** when you have fixed a problem, or **{{label:webPerformanceDismissRegressions}}** to close a report you choose not to act on. Both require a resolution note and management permission. You cannot edit rows directly.
|
||||
|
||||
Check **{{label:web_performance_budget}}** for thresholds and **{{label:web_performance_change_event}}** for possible causes. An empty list can also mean there is not enough test data yet.
|
||||
- key: table:web_performance_regression;section:regression
|
||||
summary: Which page and metric regressed, from what to what, and its severity and status.
|
||||
- key: table:web_performance_regression;section:details
|
||||
summary: Sources of the two values, the budget and likely cause, key dates and any note.
|
||||
- key: table:web_performance_regression;section:dates
|
||||
summary: When the record was created and last changed.
|
||||
- key: table:web_performance_regression;field:targetId
|
||||
summary: The tested page that regressed.
|
||||
- key: table:web_performance_regression;field:contentTable
|
||||
summary: The kind of content record the page shows, when known.
|
||||
- key: table:web_performance_regression;field:contentId
|
||||
summary: The id of the content record the page shows, when known.
|
||||
- key: table:web_performance_regression;field:source
|
||||
summary: 'Where the measurement came from: LAB (Lighthouse), RUM (real visitors) or CRUX (Google field data).'
|
||||
- key: table:web_performance_regression;field:strategy
|
||||
summary: 'The device type: MOBILE or DESKTOP for lab results, or a form factor for field data.'
|
||||
- key: table:web_performance_regression;field:metric
|
||||
summary: Which measurement regressed.
|
||||
content: |
|
||||
Which measurement regressed, such as LCP, CLS or PERFORMANCE_SCORE.
|
||||
- key: table:web_performance_regression;field:baselineValue
|
||||
summary: The earlier, healthy value the current one is compared with.
|
||||
- key: table:web_performance_regression;field:baselineRef
|
||||
summary: Where the baseline value came from, such as a run or date range.
|
||||
- key: table:web_performance_regression;field:currentValue
|
||||
summary: The latest measured value.
|
||||
- key: table:web_performance_regression;field:currentRef
|
||||
summary: Where the current value came from, such as a run or date range.
|
||||
- key: table:web_performance_regression;field:delta
|
||||
summary: 'Current minus baseline. Units follow the metric: milliseconds, score points or no unit for CLS.'
|
||||
- key: table:web_performance_regression;field:budgetId
|
||||
summary: The budget that was breached, if the regression came from one.
|
||||
- key: table:web_performance_regression;field:severity
|
||||
summary: 'How serious it is: WARNING or CRITICAL, taken from the budget.'
|
||||
- key: table:web_performance_regression;field:status
|
||||
summary: Where the regression stands, from suspected through confirmation, resolution or dismissal.
|
||||
content: |
|
||||
Where it stands: SUSPECTED, CONFIRMED, NOT_CONFIRMED, RESOLVED or DISMISSED.
|
||||
|
||||
- **SUSPECTED**: spotted, waiting for re-tests.
|
||||
- **CONFIRMED**: re-tests agreed it is real.
|
||||
- **NOT_CONFIRMED**: re-tests did not reproduce it; the record stays visible.
|
||||
- **RESOLVED**: the value recovered or was fixed.
|
||||
- **DISMISSED**: someone decided to ignore it.
|
||||
- key: table:web_performance_regression;field:causeChangeEventId
|
||||
summary: The site change that most likely caused it, such as a deploy.
|
||||
- key: table:web_performance_regression;field:detectedAt
|
||||
summary: When the regression was first noticed.
|
||||
- key: table:web_performance_regression;field:confirmedAt
|
||||
summary: When a re-test confirmed it.
|
||||
- key: table:web_performance_regression;field:resolvedAt
|
||||
summary: When it was resolved or dismissed.
|
||||
- key: table:web_performance_regression;field:resolutionNote
|
||||
summary: A note on how it was resolved or why it was dismissed.
|
||||
- key: table:web_performance_budget;slot:help
|
||||
summary: The thresholds that define when a speed measurement is good enough, by scope, metric and device type.
|
||||
content: |
|
||||
**How rows get created:** The shipped database changelog adds reference budgets; you can add your own with New.
|
||||
|
||||
Set the limits you want your pages to meet. Choose a scope, measurement source, device type, metric, comparison, threshold and severity. Times use milliseconds, scores use points and layout shift has no unit.
|
||||
|
||||
The shipped database changelog supplies reference budgets. You can edit them, add your own or turn them off with **{{label:web_performance_budget.enabled}}**. Changes are audited.
|
||||
|
||||
Enabled lab and URL Google field-data budgets are evaluated as results arrive. Breaches appear in **{{label:web_performance_regression}}**. Real-user budgets are not evaluated until a real-user source is supported.
|
||||
- key: table:web_performance_budget;section:budget
|
||||
summary: 'The rule itself: the metric, comparison, threshold, severity and whether it is on.'
|
||||
- key: table:web_performance_budget;section:scope
|
||||
summary: 'What the budget applies to: scope, scope value, source and device type.'
|
||||
- key: table:web_performance_budget;section:dates
|
||||
summary: When the record was created and last changed.
|
||||
- key: table:web_performance_budget;field:name
|
||||
summary: A short description of the rule, such as "LCP good (lab, mobile)".
|
||||
- key: table:web_performance_budget;field:scope
|
||||
summary: What the budget covers.
|
||||
content: |
|
||||
Choose the whole site, a tier, a page, a content table or a path prefix. Scope and scope value work together: Site needs no value; Tier takes the stored tier value, such as KEY.
|
||||
- key: table:web_performance_budget;field:scopeValue
|
||||
summary: The specific tier, page, content kind or path the scope points at. Leave empty for the whole site.
|
||||
- key: table:web_performance_budget;field:source
|
||||
summary: 'Which data the budget checks: LAB (Lighthouse), RUM (real visitors) or CRUX (Google field data).'
|
||||
- key: table:web_performance_budget;field:strategy
|
||||
summary: Choose a lab device or field-data form factor; leave empty to apply to all devices.
|
||||
- key: table:web_performance_budget;field:metric
|
||||
summary: The measurement to check against the budget.
|
||||
content: |
|
||||
The measurement to check, such as LCP, CLS, FCP, INP, TTFB or PERFORMANCE_SCORE.
|
||||
|
||||
Lab score metrics are PERFORMANCE_SCORE, ACCESSIBILITY_SCORE, BEST_PRACTICES_SCORE and SEO_SCORE. Times are in milliseconds; CLS has no unit; scores are 0 to 100.
|
||||
- key: table:web_performance_budget;field:comparator
|
||||
summary: Whether the measurement must be at or below the threshold, or at or above it.
|
||||
content: |
|
||||
How to compare: <= means the value must be at or below the threshold, >= at or above.
|
||||
- key: table:web_performance_budget;field:threshold
|
||||
summary: The limit the metric is compared with. Use the metric's own unit, such as milliseconds or score points.
|
||||
- key: table:web_performance_budget;field:severity
|
||||
summary: 'How serious a breach is: WARNING or CRITICAL.'
|
||||
- key: table:web_performance_budget;field:enabled
|
||||
summary: Turn off to ignore this budget without deleting it.
|
||||
- key: table:web_performance_budget;field:seeded
|
||||
summary: On for the reference budgets that shipped with the app. Filled in automatically; you can still edit those
|
||||
rows.
|
||||
- key: table:web_performance_change_event;slot:help
|
||||
summary: Things that may have changed speed, such as a deploy, a CDN change or a note, used as markers on trends.
|
||||
content: |
|
||||
**How rows get created:** Configured probes and change sources record observed changes; lab evaluation also records Lighthouse version changes.
|
||||
|
||||
Review deployments and other observed site changes to understand changes in performance. Configured probes and change sources create these records; repeated observations update the existing event. Lighthouse major-version changes are also recorded.
|
||||
|
||||
You cannot edit these rows directly. Use **{{label:webPerformanceCompareChange}}** to compare measurements around a selected change when comparisons are enabled. See **{{label:web_performance_comparison}}** for the results.
|
||||
- key: table:web_performance_change_event;section:change
|
||||
summary: What changed, in which component, from what to what, and when it was seen.
|
||||
- key: table:web_performance_change_event;section:dates
|
||||
summary: When the record was created and last changed.
|
||||
- key: table:web_performance_change_event;field:kind
|
||||
summary: The type of change that may affect performance.
|
||||
content: |
|
||||
The type of change: FRONTEND_DEPLOY, BACKEND_DEPLOY, CDN_STAGE, LIGHTHOUSE_VERSION or MANUAL.
|
||||
- key: table:web_performance_change_event;field:component
|
||||
summary: The part of the site that changed, such as FRONTEND.
|
||||
- key: table:web_performance_change_event;field:fromValue
|
||||
summary: The value before the change, such as the old build id.
|
||||
- key: table:web_performance_change_event;field:toValue
|
||||
summary: The value after the change, such as the new build id.
|
||||
- key: table:web_performance_change_event;field:observedAt
|
||||
summary: When the change was first noticed.
|
||||
- key: table:web_performance_change_event;field:source
|
||||
summary: What recorded the change.
|
||||
content: |
|
||||
What recorded the change: PROBE (a build check), WEBHOOK, QBIT_CDN (the CDN setup) or USER (a person).
|
||||
- key: table:web_performance_change_event;field:note
|
||||
summary: Free text describing the change.
|
||||
- key: table:web_performance_comparison;slot:help
|
||||
summary: Measurements compared before and after a site change, per metric, device type and segment.
|
||||
content: |
|
||||
**How rows get created:** Run Compare before and after on a site change when enough samples are available.
|
||||
|
||||
Use **{{label:webPerformanceCompareChange}}** on a site change to create before-and-after comparisons. Lab comparisons need at least three successful samples on each side using the same Lighthouse major version.
|
||||
|
||||
Review the metric, device type, sample counts and time windows alongside the before and after values. **{{label:web_performance_comparison.deltaPct}}** shows the percentage change. You cannot edit these results directly; an empty list can mean no comparison has run or there are too few samples.
|
||||
- key: table:web_performance_comparison;section:comparison
|
||||
summary: The change, the metric and segment, the before and after values and how far they moved.
|
||||
- key: table:web_performance_comparison;section:details
|
||||
summary: Scope, data source, device type, sample counts and the time windows compared.
|
||||
- key: table:web_performance_comparison;section:dates
|
||||
summary: When the record was created and last changed.
|
||||
- key: table:web_performance_comparison;field:changeEventId
|
||||
summary: The site change this comparison is around.
|
||||
- key: table:web_performance_comparison;field:scope
|
||||
summary: 'What was compared: SITE, TARGET (one page) or KEY (the key page tier).'
|
||||
- key: table:web_performance_comparison;field:source
|
||||
summary: The measurement source used for the comparison. Lab comparisons are currently implemented.
|
||||
- key: table:web_performance_comparison;field:strategy
|
||||
summary: The device type or form factor compared, such as MOBILE or DESKTOP.
|
||||
- key: table:web_performance_comparison;field:metric
|
||||
summary: The measurement compared.
|
||||
content: |
|
||||
The measurement compared, such as LCP or PERFORMANCE_SCORE.
|
||||
- key: table:web_performance_comparison;field:segment
|
||||
summary: The slice of visitors or pages compared, such as a country. Empty for everything.
|
||||
- key: table:web_performance_comparison;field:beforeValue
|
||||
summary: The value before the change, as a median or 75th percentile.
|
||||
- key: table:web_performance_comparison;field:beforeN
|
||||
summary: How many measurements went into the before value. More samples mean a more reliable number.
|
||||
- key: table:web_performance_comparison;field:beforeWindow
|
||||
summary: The time span of the before measurements.
|
||||
- key: table:web_performance_comparison;field:afterValue
|
||||
summary: The value after the change, as a median or 75th percentile.
|
||||
- key: table:web_performance_comparison;field:afterN
|
||||
summary: How many measurements went into the after value. More samples mean a more reliable number.
|
||||
- key: table:web_performance_comparison;field:afterWindow
|
||||
summary: The time span of the after measurements.
|
||||
- key: table:web_performance_comparison;field:delta
|
||||
summary: After minus before, in the metric's own unit.
|
||||
- key: table:web_performance_comparison;field:deltaPct
|
||||
summary: The same difference as a percentage of the before value.
|
||||
- key: table:web_performance_field_snapshot;slot:help
|
||||
summary: What real Chrome users experienced on the site over the last 28 days, as reported by Google (CrUX).
|
||||
content: |
|
||||
**How rows get created:** Refresh Google field data, manually or through a configured schedule, to store snapshots.
|
||||
|
||||
Google collects speed data from Chrome users and publishes the 75th percentile (p75) of each Core Web Vital over a rolling 28-day period. Each row is one check for the whole site (origin) or one page (URL), and one form factor: ALL, PHONE or DESKTOP.
|
||||
|
||||
If Google has no data (common for low-traffic pages), the row is recorded as **NO_DATA** instead of left out, and re-checking only moves **{{label:web_performance_field_snapshot.lastCheckedAt}}**. Rows with data are stored once per 28-day period.
|
||||
|
||||
With a scheduler configured, data refreshes daily by default, or on demand with **{{label:webPerformanceRefreshFieldData}}** (admin permission). It needs a Google API key. Nothing here can be edited. See also **{{label:web_performance_lab_run}}**, which are lab tests, not real users.
|
||||
- key: table:web_performance_field_snapshot;section:snapshot
|
||||
summary: 'What was checked: the site or page, the form factor, the result and when it was last checked.'
|
||||
- key: table:web_performance_field_snapshot;section:p75
|
||||
summary: The 75th percentile of each Core Web Vital over the 28-day period, plus the period dates.
|
||||
- key: table:web_performance_field_snapshot;section:dates
|
||||
summary: When the record was created and last changed.
|
||||
- key: table:web_performance_field_snapshot;field:source
|
||||
summary: Which Google service provided the data.
|
||||
content: |
|
||||
Which Google service provided the data. Currently CRUX_API.
|
||||
- key: table:web_performance_field_snapshot;field:scope
|
||||
summary: Whether the row covers the whole site (ORIGIN) or a single page (URL).
|
||||
- key: table:web_performance_field_snapshot;field:scopeKey
|
||||
summary: The site origin or the page address that was checked.
|
||||
- key: table:web_performance_field_snapshot;field:formFactor
|
||||
summary: 'The devices covered: ALL, PHONE or DESKTOP.'
|
||||
- key: table:web_performance_field_snapshot;field:status
|
||||
summary: Whether Google returned data for this snapshot.
|
||||
content: |
|
||||
OK when Google returned data, NO_DATA when it had none.
|
||||
- key: table:web_performance_field_snapshot;field:periodStart
|
||||
summary: First day of Google's 28-day collection period. Empty when there is no data.
|
||||
content: |
|
||||
First day of Google's 28-day collection period. Empty for NO_DATA.
|
||||
- key: table:web_performance_field_snapshot;field:periodEnd
|
||||
summary: Last day of Google's 28-day collection period. Empty when there is no data.
|
||||
content: |
|
||||
Last day of Google's 28-day collection period. Empty for NO_DATA.
|
||||
- key: table:web_performance_field_snapshot;field:p75LcpMs
|
||||
summary: Largest Contentful Paint at the 75th percentile, in milliseconds. 2,500 or less is good.
|
||||
- key: table:web_performance_field_snapshot;field:p75InpMs
|
||||
summary: Interaction to Next Paint at the 75th percentile, in milliseconds. 200 or less is good.
|
||||
- key: table:web_performance_field_snapshot;field:p75Cls
|
||||
summary: Cumulative Layout Shift at the 75th percentile, with no unit. 0.1 or less is good.
|
||||
- key: table:web_performance_field_snapshot;field:p75FcpMs
|
||||
summary: First Contentful Paint at the 75th percentile, in milliseconds. 1,800 or less is good.
|
||||
- key: table:web_performance_field_snapshot;field:p75TtfbMs
|
||||
summary: Time to First Byte at the 75th percentile, in milliseconds. 800 or less is good.
|
||||
- key: table:web_performance_field_snapshot;field:distributions
|
||||
summary: How users split between good, needs improvement and poor for each metric, as raw data.
|
||||
- key: table:web_performance_field_snapshot;field:lastCheckedAt
|
||||
summary: The last time Google was asked about this page or site, even if nothing changed.
|
||||
- key: table:web_performance_lab_report;slot:help
|
||||
summary: The complete Lighthouse report of each successful test, kept compressed for later download.
|
||||
content: |
|
||||
**How rows get created:** Successful lab tests store their complete compressed responses here.
|
||||
|
||||
Open a report when you need the complete Lighthouse response behind a run. Each successful run has at most one compressed report. Download and decompress its content to inspect the JSON.
|
||||
|
||||
**{{label:web_performance_lab_report.sha256}}** lets you verify the uncompressed copy. Reports are kept indefinitely by default; your host can configure retention to delete older reports while keeping run scores and findings. You cannot edit reports directly. See **{{label:web_performance_lab_run}}** and **{{label:web_performance_lab_finding}}** for readable results.
|
||||
- key: table:web_performance_lab_report;section:report
|
||||
summary: Which run the report belongs to, its size and checksum, and the downloadable content.
|
||||
- key: table:web_performance_lab_report;section:dates
|
||||
summary: When the record was created and last changed.
|
||||
- key: table:web_performance_lab_report;field:runId
|
||||
summary: The lab run this report belongs to. Each run has at most one.
|
||||
- key: table:web_performance_lab_report;field:content
|
||||
summary: The full report as compressed JSON. Download it to read it in a Lighthouse viewer or a text editor after unzipping.
|
||||
- key: table:web_performance_lab_report;field:bytes
|
||||
summary: The size of the report before compression, in bytes.
|
||||
- key: table:web_performance_lab_report;field:sha256
|
||||
summary: A checksum of the uncompressed report, to verify a copy is complete.
|
||||
- key: process:webPerformanceTestPageSpeed;slot:help
|
||||
summary: Queues Google PageSpeed (Lighthouse) tests for the selected pages, for each configured device strategy.
|
||||
content: |
|
||||
Select tested pages, then run this action. A review screen shows how many runs will be queued before anything is queued.
|
||||
|
||||
- Each configured device strategy creates a separate run; mobile and desktop are enabled by default.
|
||||
- With a scheduler configured, tests run in the background about once a minute by default, and results appear under **{{label:web_performance_lab_run}}** and the Performance dashboard.
|
||||
- If a page already has a waiting run, it is merged rather than queued twice.
|
||||
- Your host configures a daily run cap. Runs over the cap are recorded as skipped; use **{{label:webPerformanceRetryRuns}}** the next day.
|
||||
- Content records with no tested page (a draft, or not in the sitemap) and disabled pages are skipped.
|
||||
- Without a Google API key the runs wait in the queue until one is configured.
|
||||
|
||||
You need the page speed testing permission.
|
||||
- key: process:webPerformanceRunSiteAudit;slot:help
|
||||
summary: Queues a speed test for every enabled tested page, for each configured device strategy.
|
||||
content: |
|
||||
Use it to get a fresh picture of the whole site, for example after a release. The review screen lists the enabled pages that will be tested; disabled pages are left out. Run it from **{{label:web_performance_target}}**.
|
||||
|
||||
Tests then run in the background. A site audit can use much of your configured daily run cap, so avoid running it repeatedly. Runs that do not fit are recorded as skipped and can be re-queued with **{{label:webPerformanceRetryRuns}}**.
|
||||
|
||||
You need the page speed testing permission. See also **{{label:webPerformanceScheduleSiteAudit}}**, which queues a weekly audit by default when a scheduler is configured.
|
||||
- key: process:webPerformanceRetryRuns;slot:help
|
||||
summary: Queues a new test for lab runs that failed, hit an error or were skipped for the daily cap.
|
||||
content: |
|
||||
Select runs in **{{label:web_performance_lab_run}}** and run this action. Only runs that failed, ended with a runtime error or were skipped because of the daily cap are retried; successful and waiting runs are listed as not retried. Each retry is a new run for the same page and device type.
|
||||
|
||||
Transient failures are tried up to three times in total, with one-minute and five-minute waits; use this action for runs that still ended failed or skipped.
|
||||
|
||||
You need the page speed testing permission.
|
||||
- key: process:webPerformanceSyncPages;slot:help
|
||||
summary: Updates tested pages from your configured URL source.
|
||||
content: |
|
||||
Review the pages returned by your configured URL source before applying the changes. New pages are added and enabled; existing pages are kept. Pages that leave the source are marked as absent but retain their history.
|
||||
|
||||
Use this after publishing pages when you want to test them sooner. Automatic syncing requires a configured scheduler. You need web performance administrator permission.
|
||||
- key: process:webPerformanceRefreshFieldData;slot:help
|
||||
summary: Asks Google for its real-user speed data about the site and its tested pages.
|
||||
content: |
|
||||
This queries Google's Chrome User Experience Report for the whole site and for each enabled page, once per device type. Results with no data are stored as no data, because Google only publishes figures for sites and pages with enough Chrome traffic. The review screen shows how many queries will be made without calling Google.
|
||||
|
||||
It also runs automatically when your host configures a scheduler. It needs a Google API key; without one it reports that field data cannot be checked.
|
||||
|
||||
You need the web performance administrator permission. Results show in **{{label:web_performance_field_snapshot}}**.
|
||||
- key: process:webPerformanceRunQueuedTests;slot:help
|
||||
summary: Runs due page-speed tests in the background.
|
||||
content: |
|
||||
With a scheduler configured, the worker checks the queue every minute by default. Transient failures are tried up to three times in total, with one-minute and five-minute waits. You normally do not need to run this yourself.
|
||||
- key: process:webPerformanceScheduleKeyTests;slot:help
|
||||
summary: Queues tests for enabled key pages on the configured schedule.
|
||||
content: |
|
||||
Set a page to the key-page tier to include it. With a scheduler configured, the default is daily in your host's configured time zone. Your host can change the schedule. Runs wait for the queue worker.
|
||||
- key: process:webPerformanceScheduleSiteAudit;slot:help
|
||||
summary: Queues tests for all enabled pages on the configured site-audit schedule.
|
||||
content: |
|
||||
With a scheduler configured, the default site audit runs weekly in your host's configured time zone. Your host can change the schedule. Runs count toward the daily limit; excess runs are recorded as skipped.
|
||||
- key: process:webPerformanceScheduledSync;slot:help
|
||||
summary: Updates tested pages from the configured URL source on a schedule.
|
||||
content: |
|
||||
With a scheduler configured, this runs daily by default. Like **{{label:webPerformanceSyncPages}}**, it adds pages and marks pages that left the source without deleting their history. Your host can change the schedule.
|
||||
- key: process:webPerformanceScheduledFieldData;slot:help
|
||||
summary: Refreshes Google field data on the configured schedule.
|
||||
content: |
|
||||
With a scheduler configured, this runs daily by default. Like **{{label:webPerformanceRefreshFieldData}}**, it checks your origin and enabled pages. It skips the refresh when no field-data client is configured.
|
||||
- key: widget:webPerformanceSiteScores;slot:label
|
||||
summary: Median Lighthouse scores (Performance, Accessibility, Best Practices, SEO) for the key pages, mobile and desktop.
|
||||
- key: widget:webPerformanceTrend;slot:label
|
||||
summary: Weekly median Performance score for mobile and desktop, from the first week with a successful test.
|
||||
- key: widget:webPerformanceSlowestPages;slot:label
|
||||
summary: The ten tested pages with the lowest latest mobile Performance score, with their lab LCP and top finding.
|
||||
- key: widget:webPerformanceTopOpportunities;slot:label
|
||||
summary: The audit findings affecting the most pages in each page's latest test, with the estimated time savings.
|
||||
- key: widget:webPerformanceFieldDataStatus;slot:label
|
||||
summary: Google's real-user LCP, INP, CLS and TTFB for the site over the last 28 days, or why none is available.
|
||||
- key: widget:webPerformanceRecentRuns;slot:label
|
||||
summary: The five most recent page speed test runs with status and scores, and how many runs are waiting.
|
||||
- key: widget:webPerformanceRecordPanel;slot:label
|
||||
summary: This page's latest speed scores for mobile and desktop, key lab metrics, what to fix and a mobile score trend.
|
||||
- key: table:web_performance_lab_run;field:ttfbMs
|
||||
summary: Time to first byte measured by the lab run, in milliseconds.
|
||||
- key: table:web_performance_lab_run;field:evaluatedAt
|
||||
summary: When this run was processed by the regression evaluator; blank until evaluated.
|
||||
- key: table:web_performance_lab_run;field:changeEventId
|
||||
summary: The site change associated with this lab run.
|
||||
content: |
|
||||
See **{{label:web_performance_change_event}}** for the deployment or other change being measured.
|
||||
- key: table:web_performance_regression;field:firstRunId
|
||||
summary: The lab run that first raised this regression.
|
||||
- key: table:web_performance_regression;field:checkpointRunId
|
||||
summary: The lab run used as the latest confirmation checkpoint.
|
||||
content: |
|
||||
Initially the first run; updated when the regression is confirmed. See **{{label:web_performance_lab_run}}** for its measurements.
|
||||
- key: table:web_performance_regression;field:lighthouseMajor
|
||||
summary: The Lighthouse major version used to keep regression comparisons compatible.
|
||||
- key: table:web_performance_regression;field:failedAudits
|
||||
summary: Comma-separated audit identifiers that newly failed when this regression was raised.
|
||||
- key: table:web_performance_change_event;field:lastSeenAt
|
||||
summary: The latest time the change source reported this same event.
|
||||
- key: table:web_performance_change_event;field:eventKey
|
||||
summary: Generated key that prevents repeated observations from creating duplicate change events.
|
||||
- key: table:web_performance_change_event;field:siteKey
|
||||
summary: The configured site this change belongs to.
|
||||
- key: table:web_performance_comparison;field:targetId
|
||||
summary: The page whose measurements are compared before and after the change.
|
||||
- key: table:web_performance_field_snapshot;field:evaluatedAt
|
||||
summary: When this field-data snapshot was processed by the regression evaluator.
|
||||
- key: process:webPerformanceDismissRegressions;slot:help
|
||||
summary: Dismiss selected open regressions with a required resolution note.
|
||||
content: |
|
||||
Review the preview before continuing. Closed regressions are skipped. Use **{{label:webPerformanceResolveRegressions}}** when the problem has been fixed.
|
||||
- key: process:webPerformanceResolveRegressions;slot:help
|
||||
summary: Mark selected open regressions resolved with a required resolution note.
|
||||
content: |
|
||||
Review the preview before continuing. Closed regressions are skipped; this records your decision without running another page-speed test.
|
||||
- key: process:webPerformanceCompareChange;slot:help
|
||||
summary: Compare page performance before and after selected site changes.
|
||||
content: |
|
||||
Creates **{{label:web_performance_comparison}}** records. Lab comparisons need at least three successful samples on each side using the same Lighthouse major version.
|
||||
- key: process:webPerformanceProbeDeploys;slot:help
|
||||
summary: Check configured sources for deployments and other site changes.
|
||||
content: |
|
||||
The scheduled check records observations in **{{label:web_performance_change_event}}**. Repeated observations update the existing event instead of creating duplicates.
|
||||
- key: widget:webPerformanceSetup;slot:label
|
||||
summary: Admin only. Check your tested pages, lab runner, budgets and field-data setup, with the next step for each.
|
||||
- key: widget:webPerformanceNotConfigured;slot:label
|
||||
summary: Says when page speed testing is not set up and who can fix it.
|
||||
- key: possibleValueSource:web_performance_target;slot:help
|
||||
summary: Choose a tested page.
|
||||
- key: possibleValueSource:web_performance_lab_run;slot:help
|
||||
summary: Choose a lab test run.
|
||||
- key: possibleValueSource:web_performance_budget;slot:help
|
||||
summary: Choose a performance budget.
|
||||
- key: possibleValueSource:web_performance_change_event;slot:help
|
||||
summary: Choose an observed site change.
|
||||
- key: possibleValueSource:web_performance_regression;slot:help
|
||||
summary: Choose a performance regression.
|
||||
- key: possibleValueSource:web_performance_tier;slot:help
|
||||
summary: Choose how frequently a page should be tested.
|
||||
- key: possibleValueSource:web_performance_target_source;slot:help
|
||||
summary: How a tested page was discovered.
|
||||
- key: possibleValueSource:web_performance_strategy;slot:help
|
||||
summary: Choose a device strategy for lab testing.
|
||||
- key: possibleValueSource:web_performance_strategy_or_form_factor;slot:help
|
||||
summary: Choose a lab device strategy or field-data form factor.
|
||||
- key: possibleValueSource:web_performance_field_source;slot:help
|
||||
summary: The Google service that supplied field data.
|
||||
- key: possibleValueSource:web_performance_field_scope;slot:help
|
||||
summary: Choose field data for one page or an entire origin.
|
||||
- key: possibleValueSource:web_performance_budget_scope;slot:help
|
||||
summary: Choose which pages a budget applies to.
|
||||
- key: possibleValueSource:web_performance_measurement_source;slot:help
|
||||
summary: Choose the source of performance measurements.
|
||||
- key: possibleValueSource:web_performance_comparison_source;slot:help
|
||||
summary: Choose the source of before-and-after measurements.
|
||||
- key: possibleValueSource:web_performance_comparison_scope;slot:help
|
||||
summary: Choose which pages to compare.
|
||||
- key: possibleValueSource:web_performance_change_source;slot:help
|
||||
summary: How a site change was reported.
|
||||
- key: possibleValueSource:web_performance_metric;slot:help
|
||||
summary: Choose the performance measurement to evaluate.
|
||||
- key: possibleValueSource:web_performance_comparator;slot:help
|
||||
summary: Choose whether a value must be at most or at least the threshold.
|
||||
- key: possibleValueSource:web_performance_severity;slot:help
|
||||
summary: Choose how serious a budget breach is.
|
||||
@@ -1 +0,0 @@
|
||||
version=${project.version}
|
||||
@@ -1,139 +0,0 @@
|
||||
/*
|
||||
* Copyright 2026 Kingsrook, 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 com.kingsrook.qbits.webperf;
|
||||
|
||||
|
||||
import java.sql.Connection;
|
||||
import java.sql.DriverManager;
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.Statement;
|
||||
import liquibase.Liquibase;
|
||||
import liquibase.database.Database;
|
||||
import liquibase.database.DatabaseFactory;
|
||||
import liquibase.database.jvm.JdbcConnection;
|
||||
import liquibase.resource.ClassLoaderResourceAccessor;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The shipped changelog, run through real Liquibase on H2 (PostgreSQL mode):
|
||||
** it creates the nine tables, changeset 10 seeds the reference budgets, a
|
||||
** second update runs nothing, and the seed statement run again inserts nothing
|
||||
** and keeps an administrator's edit.
|
||||
*******************************************************************************/
|
||||
class WebPerfDefaultsChangelogTest
|
||||
{
|
||||
private static final String PREFIX = "web_performance_";
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void seededBudgetsThroughRealLiquibase_idempotent_andKeepEdits() throws Exception
|
||||
{
|
||||
try(Connection connection = connect())
|
||||
{
|
||||
update();
|
||||
assertThat(count(connection, "SELECT COUNT(*) FROM " + PREFIX + "budget")).isEqualTo(13);
|
||||
assertThat(count(connection, "SELECT COUNT(*) FROM " + PREFIX + "budget WHERE seeded = TRUE AND enabled = TRUE")).isEqualTo(13);
|
||||
for(String base : WebPerfSchema.TABLES)
|
||||
{
|
||||
assertThat(count(connection, "SELECT COUNT(*) FROM " + PREFIX + base)).as(base + " is queryable").isGreaterThanOrEqualTo(0);
|
||||
}
|
||||
int changesets = count(connection, "SELECT COUNT(*) FROM DATABASECHANGELOG");
|
||||
|
||||
////////////////////////////////////////////////////////////////
|
||||
// a second update has nothing to run //
|
||||
////////////////////////////////////////////////////////////////
|
||||
update();
|
||||
assertThat(count(connection, "SELECT COUNT(*) FROM DATABASECHANGELOG")).isEqualTo(changesets);
|
||||
assertThat(count(connection, "SELECT COUNT(*) FROM " + PREFIX + "budget")).isEqualTo(13);
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////
|
||||
// an admin edits a seed; the seed statement (changeset 10) is run again: //
|
||||
// nothing is inserted and the edit survives //
|
||||
////////////////////////////////////////////////////////////////////////////
|
||||
try(Statement statement = connection.createStatement())
|
||||
{
|
||||
statement.execute("UPDATE " + PREFIX + "budget SET threshold = 3000 WHERE name = 'LCP good (lab, mobile)'");
|
||||
statement.execute(seedStatement());
|
||||
}
|
||||
assertThat(count(connection, "SELECT COUNT(*) FROM " + PREFIX + "budget")).isEqualTo(13);
|
||||
assertThat(count(connection, "SELECT COUNT(*) FROM " + PREFIX + "budget WHERE name = 'LCP good (lab, mobile)' AND threshold = 3000")).isEqualTo(1);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The INSERT of changeset 10, with the prefix filled in.
|
||||
*******************************************************************************/
|
||||
private static String seedStatement() throws Exception
|
||||
{
|
||||
String script;
|
||||
try(java.io.InputStream in = WebPerfDefaultsChangelogTest.class.getClassLoader().getResourceAsStream(WebPerfSchema.CHANGELOG))
|
||||
{
|
||||
script = new String(in.readAllBytes(), java.nio.charset.StandardCharsets.UTF_8);
|
||||
}
|
||||
String seed = script.substring(script.indexOf("-- changeset qbit-web-performance:10"), script.indexOf("-- changeset qbit-web-performance:11"));
|
||||
seed = seed.substring(seed.indexOf("INSERT INTO")).trim().replaceAll(";$", "");
|
||||
return (seed.replace("${" + WebPerfSchema.CHANGELOG_PREFIX_PROPERTY + "}", PREFIX));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A connection to the shared in-memory database.
|
||||
*******************************************************************************/
|
||||
private static Connection connect() throws Exception
|
||||
{
|
||||
return (DriverManager.getConnection("jdbc:h2:mem:wpdefaults;MODE=PostgreSQL;DB_CLOSE_DELAY=-1", "sa", ""));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** One real Liquibase update on its own connection (Liquibase closes it).
|
||||
*******************************************************************************/
|
||||
private static void update() throws Exception
|
||||
{
|
||||
Database database = DatabaseFactory.getInstance().findCorrectDatabaseImplementation(new JdbcConnection(connect()));
|
||||
try(Liquibase liquibase = new Liquibase(WebPerfSchema.CHANGELOG, new ClassLoaderResourceAccessor(), database))
|
||||
{
|
||||
liquibase.setChangeLogParameter(WebPerfSchema.CHANGELOG_PREFIX_PROPERTY, PREFIX);
|
||||
liquibase.update("");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
private static int count(Connection connection, String sql) throws Exception
|
||||
{
|
||||
try(Statement statement = connection.createStatement(); ResultSet resultSet = statement.executeQuery(sql))
|
||||
{
|
||||
resultSet.next();
|
||||
return (resultSet.getInt(1));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,251 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* https://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 com.kingsrook.qbits.webperf;
|
||||
|
||||
|
||||
import java.sql.Connection;
|
||||
import java.sql.DriverManager;
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.Statement;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.joins.QJoinMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import liquibase.Contexts;
|
||||
import liquibase.LabelExpression;
|
||||
import liquibase.Liquibase;
|
||||
import liquibase.database.Database;
|
||||
import liquibase.database.DatabaseFactory;
|
||||
import liquibase.database.jvm.JdbcConnection;
|
||||
import liquibase.resource.ClassLoaderResourceAccessor;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.testcontainers.containers.PostgreSQLContainer;
|
||||
import org.testcontainers.junit.jupiter.Container;
|
||||
import org.testcontainers.junit.jupiter.Testcontainers;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Referential integrity on PostgreSQL (the production database), with the
|
||||
** changelog run by Liquibase as a host runs it:
|
||||
**
|
||||
** - every table possible-value field that names one of the QBit's tables,
|
||||
** and every join, has a database foreign key (or an exemption with a
|
||||
** reason), so a new reference cannot be added without its constraint;
|
||||
** - rows whose parent is missing when the constraints are added are recorded
|
||||
** in qqq_fk_quarantine and repaired (nulled, or deleted with a full copy),
|
||||
** so the upgrade never fails on existing data;
|
||||
** - the foreign key changesets are no-ops on a database that already has the
|
||||
** constraints (a host that added them itself).
|
||||
**
|
||||
** Skipped when Docker is not available.
|
||||
*******************************************************************************/
|
||||
@Testcontainers(disabledWithoutDocker = true)
|
||||
class WebPerfForeignKeyTest
|
||||
{
|
||||
private static final String PREFIX = "web_performance_";
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// references that are deliberately not foreign keys: "child.column" -> //
|
||||
// reason. None today (content_table + content_id is polymorphic, and has //
|
||||
// no possible-value source). //
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
private static final Map<String, String> EXEMPT = Map.of();
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// the changesets before the foreign keys (1-11) //
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
private static final int CHANGESETS_BEFORE_FOREIGN_KEYS = 11;
|
||||
|
||||
@Container
|
||||
private static final PostgreSQLContainer<?> POSTGRES = new PostgreSQLContainer<>("postgres:17-alpine");
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Orphans are quarantined, every reference gets its constraint, and a
|
||||
** re-run of the foreign key changesets changes nothing.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testEveryReferenceHasAForeignKey() throws Exception
|
||||
{
|
||||
try(Connection connection = DriverManager.getConnection(POSTGRES.getJdbcUrl(), POSTGRES.getUsername(), POSTGRES.getPassword());
|
||||
Statement statement = connection.createStatement())
|
||||
{
|
||||
statement.execute("DROP SCHEMA public CASCADE");
|
||||
statement.execute("CREATE SCHEMA public");
|
||||
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
// an existing install with rows whose parents are gone //
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
migrate(connection, CHANGESETS_BEFORE_FOREIGN_KEYS);
|
||||
statement.execute("INSERT INTO web_performance_target (id, url) VALUES (1, 'https://www.example.com/')");
|
||||
statement.execute("INSERT INTO web_performance_lab_run (id, target_id) VALUES (1, 1), (2, 404)");
|
||||
statement.execute("INSERT INTO web_performance_lab_finding (id, run_id, target_id) VALUES (1, 1, 1), (2, 404, 1)");
|
||||
statement.execute("INSERT INTO web_performance_lab_report (id, run_id) VALUES (1, 404)");
|
||||
statement.execute("INSERT INTO web_performance_regression (id, target_id, budget_id, first_run_id) VALUES (1, 1, 404, 404)");
|
||||
|
||||
migrate(connection, null);
|
||||
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
// every reference the meta-data declares has its constraint //
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
Map<String, String> foreignKeys = foreignKeys(statement);
|
||||
List<String> missing = new ArrayList<>();
|
||||
for(String reference : references())
|
||||
{
|
||||
if(!foreignKeys.containsKey(reference) && !EXEMPT.containsKey(reference))
|
||||
{
|
||||
missing.add(reference);
|
||||
}
|
||||
}
|
||||
assertThat(missing).as("references without a foreign key (add one to the changelog, or an exemption with a reason)").isEmpty();
|
||||
assertThat(foreignKeys).containsEntry("web_performance_lab_finding.run_id", "web_performance_lab_run CASCADE")
|
||||
.containsEntry("web_performance_lab_run.target_id", "web_performance_target RESTRICT")
|
||||
.containsEntry("web_performance_regression.cause_change_event_id", "web_performance_change_event SET NULL");
|
||||
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
// the orphans were recorded, then nulled or deleted //
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
assertThat(rows(statement, "SELECT table_name || '.' || column_name || ' ' || row_id || '->' || missing_parent_id || ' ' || action || ' ' || (row_data IS NOT NULL) FROM qqq_fk_quarantine"))
|
||||
.containsExactlyInAnyOrder(
|
||||
"web_performance_lab_run.target_id 2->404 NULLED false",
|
||||
"web_performance_lab_finding.run_id 2->404 DELETED true",
|
||||
"web_performance_lab_report.run_id 1->404 DELETED true",
|
||||
"web_performance_regression.budget_id 1->404 NULLED false",
|
||||
"web_performance_regression.first_run_id 1->404 NULLED false");
|
||||
assertThat(rows(statement, "SELECT id || ' ' || COALESCE(CAST(target_id AS TEXT), '-') FROM web_performance_lab_run")).containsExactlyInAnyOrder("1 1", "2 -");
|
||||
assertThat(rows(statement, "SELECT CAST(id AS TEXT) FROM web_performance_lab_finding")).containsExactly("1");
|
||||
assertThat(rows(statement, "SELECT CAST(id AS TEXT) FROM web_performance_lab_report")).isEmpty();
|
||||
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
// a host that already has the constraints: the changesets are marked //
|
||||
// ran and change nothing //
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
statement.execute("DELETE FROM databasechangelog WHERE CAST(SUBSTRING(id FROM '[0-9]+$') AS INTEGER) > " + CHANGESETS_BEFORE_FOREIGN_KEYS);
|
||||
migrate(connection, null);
|
||||
assertThat(foreignKeys(statement)).isEqualTo(foreignKeys);
|
||||
assertThat(rows(statement, "SELECT CAST(COUNT(*) AS TEXT) FROM qqq_fk_quarantine")).containsExactly("5");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Run the changelog (all of it, or the first n changesets).
|
||||
*******************************************************************************/
|
||||
private static void migrate(Connection connection, Integer count) throws Exception
|
||||
{
|
||||
Database database = DatabaseFactory.getInstance().findCorrectDatabaseImplementation(new JdbcConnection(connection));
|
||||
Liquibase liquibase = new Liquibase(WebPerfSchema.CHANGELOG, new ClassLoaderResourceAccessor(), database);
|
||||
liquibase.setChangeLogParameter(WebPerfSchema.CHANGELOG_PREFIX_PROPERTY, PREFIX);
|
||||
if(count == null)
|
||||
{
|
||||
liquibase.update(new Contexts(), new LabelExpression());
|
||||
}
|
||||
else
|
||||
{
|
||||
liquibase.update(count, new Contexts(), new LabelExpression());
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** "child.column" for every table possible-value field and join of the QBit.
|
||||
*******************************************************************************/
|
||||
private static List<String> references() throws Exception
|
||||
{
|
||||
QInstance qInstance = WebPerfTestSupport.newInstance();
|
||||
new WebPerfQBitProducer().withQBitConfig(WebPerfTestSupport.config().withTableNamePrefix(PREFIX)).produce(qInstance);
|
||||
|
||||
List<String> references = new ArrayList<>();
|
||||
for(QTableMetaData table : qInstance.getTables().values())
|
||||
{
|
||||
for(QFieldMetaData field : table.getFields().values())
|
||||
{
|
||||
if(field.getPossibleValueSourceName() != null && qInstance.getTable(field.getPossibleValueSourceName()) != null)
|
||||
{
|
||||
references.add(table.getName() + "." + field.getBackendName());
|
||||
}
|
||||
}
|
||||
}
|
||||
for(QJoinMetaData join : qInstance.getJoins().values())
|
||||
{
|
||||
/////////////////////////////////////////////////////////////////////
|
||||
// the referencing side is the one whose field is not its key //
|
||||
/////////////////////////////////////////////////////////////////////
|
||||
QTableMetaData left = qInstance.getTable(join.getLeftTable());
|
||||
QTableMetaData right = qInstance.getTable(join.getRightTable());
|
||||
join.getJoinOns().forEach(on -> references.add(on.getRightField().equals(right.getPrimaryKeyField())
|
||||
? left.getName() + "." + left.getField(on.getLeftField()).getBackendName()
|
||||
: right.getName() + "." + right.getField(on.getRightField()).getBackendName()));
|
||||
}
|
||||
assertThat(references).as("the QBit's references").hasSizeGreaterThanOrEqualTo(12);
|
||||
return (references);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** "child.column" -> "parent RULE" for every foreign key in the database.
|
||||
*******************************************************************************/
|
||||
private static Map<String, String> foreignKeys(Statement statement) throws Exception
|
||||
{
|
||||
Map<String, String> foreignKeys = new HashMap<>();
|
||||
try(ResultSet resultSet = statement.executeQuery("""
|
||||
SELECT tc.table_name || '.' || kcu.column_name, ccu.table_name || ' ' || rc.delete_rule
|
||||
FROM information_schema.table_constraints tc
|
||||
JOIN information_schema.key_column_usage kcu ON kcu.constraint_name = tc.constraint_name
|
||||
JOIN information_schema.referential_constraints rc ON rc.constraint_name = tc.constraint_name
|
||||
JOIN information_schema.constraint_column_usage ccu ON ccu.constraint_name = tc.constraint_name
|
||||
WHERE tc.constraint_type = 'FOREIGN KEY'"""))
|
||||
{
|
||||
while(resultSet.next())
|
||||
{
|
||||
foreignKeys.put(resultSet.getString(1), resultSet.getString(2));
|
||||
}
|
||||
}
|
||||
return (foreignKeys);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The first column of each row of a query, as text.
|
||||
*******************************************************************************/
|
||||
private static List<String> rows(Statement statement, String sql) throws Exception
|
||||
{
|
||||
List<String> rows = new ArrayList<>();
|
||||
try(ResultSet resultSet = statement.executeQuery(sql))
|
||||
{
|
||||
while(resultSet.next())
|
||||
{
|
||||
rows.add(resultSet.getString(1));
|
||||
}
|
||||
}
|
||||
return (rows);
|
||||
}
|
||||
}
|
||||
@@ -1,67 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* https://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 com.kingsrook.qbits.webperf;
|
||||
|
||||
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.help.bundles.HelpBundleEntry;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.help.bundles.HelpBundles;
|
||||
import com.kingsrook.qqq.backend.core.testing.HelpBundleAssertions;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Validate the shipped bundle against the QBit's own metadata, without a host.
|
||||
*******************************************************************************/
|
||||
class WebPerfHelpBundleTest
|
||||
{
|
||||
/*******************************************************************************
|
||||
** All default features are present; registration needs no helpContent table.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void bundleCoversOwnedMetadata() throws Exception
|
||||
{
|
||||
QInstance qInstance = WebPerfTestSupport.newInstance();
|
||||
new WebPerfQBitProducer().withQBitConfig(WebPerfTestSupport.config()).produce(qInstance);
|
||||
|
||||
assertThat(qInstance.getTable("helpContent")).isNull();
|
||||
assertThat(HelpBundles.of(qInstance).getBundles()).singleElement()
|
||||
.satisfies(bundle ->
|
||||
{
|
||||
assertThat(bundle.getId()).isEqualTo("qbit-web-performance");
|
||||
assertThat(System.getProperty("qbit.artifactVersion")).isNotBlank();
|
||||
assertThat(bundle.getVersion()).isEqualTo(System.getProperty("qbit.artifactVersion"))
|
||||
.isEqualTo(WebPerfQBitProducer.VERSION);
|
||||
});
|
||||
HelpBundleAssertions.forInstance(qInstance)
|
||||
.bundles("help/qbit-web-performance.yaml")
|
||||
.owning(target -> target.name().startsWith("web_performance_") || target.name().startsWith("webPerformance"))
|
||||
.assertComplete();
|
||||
|
||||
// RC.7 validates supplied widget and lookup keys, but does not require their coverage.
|
||||
var keys = HelpBundles.of(qInstance).getBundles().get(0).getEntries().stream().map(HelpBundleEntry::getKey).toList();
|
||||
qInstance.getWidgets().keySet().stream().filter(name -> name.startsWith("webPerformance"))
|
||||
.forEach(name -> assertThat(keys).contains("widget:" + name + ";slot:label"));
|
||||
qInstance.getPossibleValueSources().keySet().stream().filter(name -> name.startsWith("web_performance_"))
|
||||
.forEach(name -> assertThat(keys).contains("possibleValueSource:" + name + ";slot:help"));
|
||||
}
|
||||
}
|
||||
@@ -86,71 +86,6 @@ class WebPerfP1Test
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The business home has no provider setup readout and no run-queue widget;
|
||||
** those are the admin-placeable list.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testHomeIsBusinessOnly()
|
||||
{
|
||||
List<String> home = qInstance.getApp(config.getAppName()).getWidgets();
|
||||
assertThat(home).doesNotContain(config.qualify(WebPerfWidgets.SETUP), config.qualify(WebPerfWidgets.RECENT_RUNS));
|
||||
assertThat(WebPerfWidgets.HOME).doesNotContain(WebPerfWidgets.SETUP, WebPerfWidgets.RECENT_RUNS);
|
||||
assertThat(WebPerfWidgets.ADMIN).containsExactly(WebPerfWidgets.SETUP, WebPerfWidgets.RECENT_RUNS);
|
||||
assertThat(home).contains(config.qualify(WebPerfWidgets.SITE_SCORES), config.qualify(WebPerfWidgets.TREND), config.qualify(WebPerfWidgets.SLOWEST_PAGES),
|
||||
config.qualify(WebPerfWidgets.OPPORTUNITIES), config.qualify(WebPerfWidgets.FIELD_STATUS));
|
||||
for(String name : WebPerfWidgets.ADMIN)
|
||||
{
|
||||
assertThat(qInstance.getWidget(config.qualify(name))).as(name + " is still defined for a host to place").isNotNull();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Unconfigured: a business empty state naming no config key. Configured:
|
||||
** nothing at all.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testNotConfiguredEmptyState() throws Exception
|
||||
{
|
||||
assertThat(html(WebPerfWidgets.NOT_CONFIGURED, Map.of())).as("configured shows nothing").isEmpty();
|
||||
|
||||
config.withLabRunner(null).withCruxClient(null);
|
||||
String card = html(WebPerfWidgets.NOT_CONFIGURED, Map.of());
|
||||
assertThat(card).contains("Page speed testing is not set up").contains("Ask an admin to add a Google PageSpeed API key.");
|
||||
assertThat(card).doesNotContain("googleApiKey").doesNotContain("qbit config").doesNotContain("environment variable");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The admin widgets render for an admin, and are hidden (permission denied
|
||||
** under enforcement) for a session without the admin permission.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testAdminWidgetsAdminOnly() throws Exception
|
||||
{
|
||||
for(String name : WebPerfWidgets.ADMIN)
|
||||
{
|
||||
assertThat(html(name, Map.of())).as(name + " for an admin").isNotEmpty();
|
||||
}
|
||||
|
||||
WebPerfTestSupport.login(qInstance, "web_performance.read", "web_performance.write", "web_performance.view.hasAccess");
|
||||
for(String name : WebPerfWidgets.ADMIN)
|
||||
{
|
||||
assertThat(qInstance.getWidget(config.qualify(name)).getPermissionRules().getDenyBehavior()).isEqualTo(com.kingsrook.qqq.backend.core.model.metadata.permissions.DenyBehavior.HIDDEN);
|
||||
RenderWidgetInput input = new RenderWidgetInput().withWidgetMetaData(qInstance.getWidget(config.qualify(name)));
|
||||
input.setPermissionEnforcement(com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement.ENFORCE);
|
||||
org.junit.jupiter.api.Assertions.assertThrows(com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException.class,
|
||||
() -> new RenderWidgetAction().execute(input), name + " must not render without admin");
|
||||
assertThat(com.kingsrook.qqq.backend.core.actions.permissions.PermissionsHelper.hasWidgetPermission(input, config.qualify(name))).isFalse();
|
||||
}
|
||||
assertThat(html(WebPerfWidgets.SITE_SCORES, Map.of())).as("business widgets still render").isNotEmpty();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** An instance with a content table "page", the QBit wired to it, and the
|
||||
** local Google stand-in.
|
||||
@@ -271,135 +206,6 @@ class WebPerfP1Test
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** An odd daily cap rotates individual device strategies, not just pages.
|
||||
** Skipped rows and repeated scheduling must not starve the remaining pairs.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void scheduledQuotaRotatesPagesAndStrategies() throws Exception
|
||||
{
|
||||
config.withMaxRunsPerDay(3);
|
||||
Instant dayOne = Instant.parse("2026-10-19T12:00:00Z");
|
||||
WebPerfService service = service();
|
||||
service.applySync(service.planSync(sitemap), dayOne);
|
||||
WebPerfService.QueuePlan first = service.enqueue(service.scheduledRequests(false, "audit", dayOne), dayOne);
|
||||
assertEquals(3, first.queue().size());
|
||||
assertEquals(3, first.overQuota().size());
|
||||
assertEquals(0, service.enqueue(service.scheduledRequests(false, "audit", dayOne), dayOne).queue().size());
|
||||
store().update("UPDATE {lab_run} SET status = 'SUCCEEDED' WHERE status = 'QUEUED'");
|
||||
|
||||
Instant dayTwo = dayOne.plusSeconds(86400);
|
||||
WebPerfService.QueuePlan second = service.enqueue(service.scheduledRequests(false, "audit", dayTwo), dayTwo);
|
||||
assertEquals(3, second.queue().size());
|
||||
List<String> firstPairs = first.queue().stream().map(run -> run.targetId() + "|" + run.strategy()).toList();
|
||||
assertThat(second.queue().stream().map(run -> run.targetId() + "|" + run.strategy()).toList())
|
||||
.doesNotContainAnyElementsOf(firstPairs);
|
||||
assertEquals(6, store().query("SELECT DISTINCT target_id, strategy FROM {lab_run} WHERE status <> 'SKIPPED_QUOTA'").size());
|
||||
assertThat(service.scheduledRequests(true, "key pages", dayTwo)).hasSize(2)
|
||||
.allSatisfy(run -> assertEquals(SITE + "/", run.url()));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Manual and key-page runs consume the same allowance as the full audit.
|
||||
** Persisted history rotates the remaining pairs after a service restart.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void scheduledQuotaSharesAllowanceAndSurvivesRestart() throws Exception
|
||||
{
|
||||
config.withMaxRunsPerDay(3);
|
||||
Instant day = Instant.parse("2026-10-19T12:00:00Z");
|
||||
WebPerfService service = service();
|
||||
service.applySync(service.planSync(sitemap), day);
|
||||
List<WebPerfService.RunRequest> manual = service.requestsFor(service.enabledTargets(false), "MANUAL", "selected page", day);
|
||||
assertEquals(1, service.enqueue(List.of(manual.get(3)), day).queue().size());
|
||||
assertEquals(2, service.enqueue(service.scheduledRequests(true, "key pages", day), day).queue().size());
|
||||
assertEquals(0, service.enqueue(service.scheduledRequests(false, "audit", day), day).queue().size());
|
||||
store().update("UPDATE {lab_run} SET status = 'SUCCEEDED' WHERE status = 'QUEUED'");
|
||||
|
||||
List<String> rotated = new ArrayList<>();
|
||||
for(int nextDay = 1; nextDay <= 3; nextDay++)
|
||||
{
|
||||
Instant now = day.plusSeconds(86400L * nextDay);
|
||||
WebPerfService restarted = new WebPerfService(new WebPerfRuntime(config), store());
|
||||
assertEquals(2, restarted.enqueue(restarted.scheduledRequests(true, "key pages", now), now).queue().size());
|
||||
WebPerfService.QueuePlan audit = restarted.enqueue(restarted.scheduledRequests(false, "audit", now), now);
|
||||
assertEquals(1, audit.queue().size());
|
||||
assertEquals(2, audit.merged().size());
|
||||
WebPerfService.RunRequest queued = audit.queue().get(0);
|
||||
assertThat(queued.url()).isNotEqualTo(SITE + "/");
|
||||
rotated.add(queued.targetId() + "|" + queued.strategy());
|
||||
store().update("UPDATE {lab_run} SET status = 'SUCCEEDED' WHERE status = 'QUEUED'");
|
||||
}
|
||||
assertThat(rotated).doesNotHaveDuplicates();
|
||||
assertEquals(6, store().query("SELECT DISTINCT target_id, strategy FROM {lab_run} WHERE status <> 'SKIPPED_QUOTA'").size());
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The Setup card reports pages, budgets, the lab runner and field data from
|
||||
** the runtime's own resolution, with the next step for each.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testSetupCard() throws Exception
|
||||
{
|
||||
String card = html(WebPerfWidgets.SETUP, Map.of());
|
||||
assertThat(card).contains("Needs setup").contains("Sync pages from sitemap").contains("Using defaults").contains("13 reference budgets");
|
||||
assertThat(card).as("a configured runner and CrUX client count as set up").contains("A lab runner is configured").contains("Checked daily");
|
||||
|
||||
WebPerfService service = service();
|
||||
service.applySync(service.planSync(List.of(SITE + "/")), Instant.now());
|
||||
store().update("INSERT INTO {budget} (name, scope, source, metric, comparator, threshold, severity, enabled, seeded) VALUES ('mine', 'SITE', 'LAB', 'LCP', '<=', 2000, 'WARNING', TRUE, FALSE)");
|
||||
card = html(WebPerfWidgets.SETUP, Map.of());
|
||||
assertThat(card).contains("1 page").contains("14 budgets are enabled, 1 of them your own");
|
||||
|
||||
store().update("UPDATE {budget} SET enabled = FALSE");
|
||||
assertThat(html(WebPerfWidgets.SETUP, Map.of())).contains("No budget is enabled");
|
||||
|
||||
config.withLabRunner(null).withCruxClient(null);
|
||||
assertThat(html(WebPerfWidgets.SETUP, Map.of())).contains("No Google API key is configured, so lab tests cannot run").contains("Google field data is not checked");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** reportRetentionDays deletes old Lighthouse Reports when a run stores its
|
||||
** own, and 0 (the default) keeps them forever.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testReportRetention() throws Exception
|
||||
{
|
||||
for(int days : new int[] { 0, 30 })
|
||||
{
|
||||
store().update("DELETE FROM {lab_report}");
|
||||
store().update("DELETE FROM {lab_finding}");
|
||||
store().update("DELETE FROM {lab_run}");
|
||||
store().update("DELETE FROM {budget}");
|
||||
config.withReportRetentionDays(days);
|
||||
google.respond(new FixtureServer.Response(200, FixtureServer.fixture("psi-kof22-home-mobile.json")));
|
||||
long oldRunId = store().insert("lab_run", new java.util.LinkedHashMap<>(Map.of("status", "FAILED")));
|
||||
store().insert("lab_report", new java.util.LinkedHashMap<>(Map.of("run_id", oldRunId, "bytes", 1,
|
||||
"create_date", Instant.now().minus(java.time.Duration.ofDays(40)))));
|
||||
WebPerfRuntime.of(qInstance, "web_performance_").allowReportPruneNow();
|
||||
WebPerfService service = service();
|
||||
service.applySync(service.planSync(List.of(SITE + "/")), Instant.now());
|
||||
service.enqueue(service.requestsFor(service.enabledTargets(false), "MANUAL", "test", Instant.now()), Instant.now());
|
||||
assertEquals(2, service.runDue(Instant.now()));
|
||||
|
||||
assertEquals(2, store().query("SELECT id FROM {lab_run} WHERE status = 'SUCCEEDED'").size(), "runs are untouched by pruning");
|
||||
assertThat(store().query("SELECT id FROM {lab_finding}")).as("findings are untouched by pruning").hasSizeGreaterThan(5);
|
||||
long old = store().query("SELECT id FROM {lab_report} WHERE run_id = ?", oldRunId).size();
|
||||
long fresh = store().query("SELECT id FROM {lab_report} WHERE run_id <> ?", oldRunId).size();
|
||||
assertEquals(2, fresh, "the new reports are kept");
|
||||
assertEquals(days == 0 ? 1 : 0, old, "retention " + days + " days");
|
||||
}
|
||||
assertThat(new WebPerfRuntime(config).reportPruneDue()).as("a new process does not prune right away").isFalse();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The worker runs a test, stores scores, findings, the report and the
|
||||
** page's latest results.
|
||||
@@ -407,7 +213,6 @@ class WebPerfP1Test
|
||||
@Test
|
||||
void testWorkerSuccess() throws Exception
|
||||
{
|
||||
store().update("UPDATE {budget} SET enabled = FALSE");
|
||||
google.respond(new FixtureServer.Response(200, FixtureServer.fixture("psi-kof22-home-mobile.json")));
|
||||
WebPerfService service = service();
|
||||
service.applySync(service.planSync(List.of(SITE + "/")), Instant.now());
|
||||
@@ -514,7 +319,6 @@ class WebPerfP1Test
|
||||
@Test
|
||||
void testActions() throws Exception
|
||||
{
|
||||
store().update("UPDATE {budget} SET enabled = FALSE");
|
||||
RunProcessOutput sync = run(WebPerfProcesses.SYNC_TARGETS);
|
||||
assertThat(summary(sync)).anyMatch(l -> l.contains("3") && l.contains("added"));
|
||||
assertEquals(3, store().query("SELECT id FROM {target}").size());
|
||||
|
||||
@@ -23,16 +23,12 @@ package com.kingsrook.qbits.webperf;
|
||||
|
||||
import java.util.EnumSet;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qbits.webperf.sources.HttpBuildIdProbe;
|
||||
import com.kingsrook.qbits.webperf.sources.SitemapUrlSource;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.instances.QInstanceValidator;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSource;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSourceType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.audits.AuditLevel;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.layout.QAppMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.layout.QAppSection;
|
||||
@@ -74,9 +70,6 @@ class WebPerfQBitProducerTest
|
||||
@Test
|
||||
void testRegistersIntoAFreshInstance() throws Exception
|
||||
{
|
||||
assertThat(System.getProperty("qbit.artifactVersion")).isNotBlank();
|
||||
assertThat(WebPerfQBitProducer.VERSION).isEqualTo(System.getProperty("qbit.artifactVersion"));
|
||||
assertThat(new WebPerfQBitProducer().getQBitMetaData().getVersion()).isEqualTo(WebPerfQBitProducer.VERSION);
|
||||
QInstance qInstance = WebPerfTestSupport.newInstance();
|
||||
new WebPerfQBitProducer().withQBitConfig(WebPerfTestSupport.config()
|
||||
.withUrlSource(new SitemapUrlSource("https://www.example.com/sitemap.xml"))
|
||||
@@ -117,53 +110,6 @@ class WebPerfQBitProducerTest
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Every enum field resolves to an install-scoped ENUM with stable stored IDs.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testEnumFields() throws Exception
|
||||
{
|
||||
QInstance instance = WebPerfTestSupport.newInstance();
|
||||
new WebPerfQBitProducer().withQBitConfig(WebPerfTestSupport.config().withTableNamePrefix("perf_")).produce(instance);
|
||||
Map<String, List<String>> expected = Map.ofEntries(
|
||||
Map.entry("tier", List.of("KEY", "STANDARD")),
|
||||
Map.entry("target_source", List.of("SITEMAP", "MANUAL", "CONTENT")),
|
||||
Map.entry("strategy", List.of("MOBILE", "DESKTOP")),
|
||||
Map.entry("strategy_or_form_factor", List.of("MOBILE", "DESKTOP", "PHONE", "TABLET", "ALL")),
|
||||
Map.entry("field_source", List.of("CRUX_API", "CRUX_HISTORY", "PSI")),
|
||||
Map.entry("field_scope", List.of("URL", "ORIGIN")),
|
||||
Map.entry("budget_scope", List.of("SITE", "TIER", "TARGET", "CONTENT_TABLE", "PATH_PREFIX")),
|
||||
Map.entry("measurement_source", List.of("LAB", "RUM", "CRUX")),
|
||||
Map.entry("comparison_source", List.of("LAB", "RUM")),
|
||||
Map.entry("comparison_scope", List.of("KEY", "TARGET", "SITE")),
|
||||
Map.entry("change_source", List.of("PROBE", "WEBHOOK", "QBIT_CDN", "USER")),
|
||||
Map.entry("metric", List.of("LCP", "INP", "CLS", "FCP", "TTFB", "TBT", "PERFORMANCE_SCORE", "ACCESSIBILITY_SCORE", "BEST_PRACTICES_SCORE", "SEO_SCORE")),
|
||||
Map.entry("comparator", List.of("<=", ">=")),
|
||||
Map.entry("severity", List.of("WARNING", "CRITICAL")));
|
||||
int count = 0;
|
||||
for(QTableMetaData table : instance.getTables().values())
|
||||
{
|
||||
for(QFieldMetaData field : table.getFields().values())
|
||||
{
|
||||
if(List.of("tier", "scope", "source", "strategy", "metric", "comparator", "severity").contains(field.getName()))
|
||||
{
|
||||
count++;
|
||||
assertThat(field.getPossibleValueSourceName()).as(table.getName() + "." + field.getName()).startsWith("perf_");
|
||||
QPossibleValueSource source = instance.getPossibleValueSource(field.getPossibleValueSourceName());
|
||||
assertEquals(QPossibleValueSourceType.ENUM, source.getType());
|
||||
assertThat(source.getEnumValues()).extracting(v -> (String) v.getId()).containsExactlyElementsOf(expected.get(source.getName().substring(5)));
|
||||
assertThat(source.getEnumValues()).allMatch(v -> v.getLabel() != null && !v.getLabel().isBlank());
|
||||
}
|
||||
}
|
||||
}
|
||||
assertEquals(21, count);
|
||||
assertEquals("Key page", instance.getPossibleValueSource("perf_tier").getEnumValues().get(0).getLabel());
|
||||
assertTrue(instance.getTable("perf_target").getField("url").getIsEditable());
|
||||
assertTrue(instance.getTable("perf_target").isCapabilityEnabled(instance.getBackend(WebPerfTestSupport.BACKEND), Capability.TABLE_INSERT));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The app nests under a host parent app (kof22: CMS, D5).
|
||||
*******************************************************************************/
|
||||
|
||||
@@ -1,828 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* https://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 com.kingsrook.qbits.webperf;
|
||||
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.time.Instant;
|
||||
import java.time.LocalDate;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.concurrent.Executors;
|
||||
import com.kingsrook.qbits.webperf.lab.LabResultParser;
|
||||
import com.kingsrook.qbits.webperf.processes.RegressionSteps;
|
||||
import com.kingsrook.qbits.webperf.processes.WebPerfProcesses;
|
||||
import com.kingsrook.qbits.webperf.service.WebPerfChangeService;
|
||||
import com.kingsrook.qbits.webperf.service.WebPerfComparisonService;
|
||||
import com.kingsrook.qbits.webperf.service.WebPerfEvaluationService;
|
||||
import com.kingsrook.qbits.webperf.service.WebPerfService;
|
||||
import com.kingsrook.qbits.webperf.spi.ChangeEventSource;
|
||||
import com.kingsrook.qbits.webperf.spi.DeployProbe;
|
||||
import com.kingsrook.qbits.webperf.spi.LabRunner;
|
||||
import com.kingsrook.qbits.webperf.store.WebPerfStore;
|
||||
import com.kingsrook.qqq.backend.core.actions.processes.QProcessCallback;
|
||||
import com.kingsrook.qqq.backend.core.actions.processes.RunProcessAction;
|
||||
import com.kingsrook.qqq.backend.core.alerts.AlertResolution;
|
||||
import com.kingsrook.qqq.backend.core.alerts.AlertSignal;
|
||||
import com.kingsrook.qqq.backend.core.alerts.AlertSinkInterface;
|
||||
import com.kingsrook.qqq.backend.core.alerts.AlertsInstanceMetaData;
|
||||
import com.kingsrook.qqq.backend.core.alerts.QAlerts;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunProcessInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunProcessOutput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
|
||||
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.StreamedETLWithFrontendProcess;
|
||||
import org.json.JSONObject;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** P2 behavior on H2, with fake probes and runner and real QQQ record actions.
|
||||
*******************************************************************************/
|
||||
public class WebPerfRegressionTest
|
||||
{
|
||||
private static final Instant START = Instant.parse("2026-10-01T12:00:00Z");
|
||||
private QInstance instance;
|
||||
private WebPerfQBitConfig config;
|
||||
private WebPerfStore store;
|
||||
private WebPerfEvaluationService evaluator;
|
||||
private long target;
|
||||
private int sequence;
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Fresh tables; disable reference budgets to isolate statistical rules.
|
||||
*******************************************************************************/
|
||||
@BeforeEach
|
||||
void setUp() throws Exception
|
||||
{
|
||||
instance = WebPerfTestSupport.newInstance();
|
||||
config = WebPerfTestSupport.config().withStrategies(List.of("MOBILE")).withMinSpacingMillis(0).withConcurrency(2);
|
||||
new WebPerfQBitProducer().withQBitConfig(config).produce(instance);
|
||||
WebPerfTestSupport.applyChangelog(instance, config.getTableNamePrefix());
|
||||
WebPerfTestSupport.login(instance, "web_performance.read", "web_performance.write", "web_performance.manage.hasAccess",
|
||||
"web_performance.view.hasAccess", "web_performance.admin.hasAccess", "web_performance.test.hasAccess");
|
||||
store = new WebPerfRuntime(config).store(instance);
|
||||
evaluator = new WebPerfEvaluationService(store);
|
||||
store.update("UPDATE {budget} SET enabled = FALSE");
|
||||
WebPerfService service = new WebPerfRuntime(config).service();
|
||||
service.applySync(service.planSync(List.of("https://www.example.com/")), START);
|
||||
target = WebPerfStore.asLong(store.query("SELECT id FROM {target}").get(0).get("id"));
|
||||
store.update("UPDATE {target} SET tier = 'KEY', content_table = 'page', content_id = 7 WHERE id = ?", target);
|
||||
RecordingSink.signals.clear();
|
||||
RecordingSink.resolutions.clear();
|
||||
AlertsInstanceMetaData.ofOrWithNew(instance).withSink(new QCodeReference(RecordingSink.class));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Release this test's context.
|
||||
*******************************************************************************/
|
||||
@AfterEach
|
||||
void tearDown()
|
||||
{
|
||||
QContext.clear();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Suspect, two confirmations, one alert, then three recovery samples.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void confirmsAndRecoversWithoutDuplicates() throws Exception
|
||||
{
|
||||
baseline();
|
||||
long change = change("FRONTEND_DEPLOY", "FRONTEND", "build-2", START.plusSeconds(6));
|
||||
long first = measurement(70, "SCHEDULE", "13.1", Map.of("change_event_id", change));
|
||||
evaluator.evaluateLab(first);
|
||||
assertThat(regression().get("status")).isEqualTo("SUSPECTED");
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE trigger_type = 'CONFIRM'")).hasSize(2);
|
||||
assertThat(RecordingSink.signals).isEmpty();
|
||||
assertThat(openCount()).isEqualTo(1);
|
||||
completeConfirmations(first, 72, 71);
|
||||
assertThat(regression().get("status")).isEqualTo("CONFIRMED");
|
||||
assertThat(WebPerfStore.asDouble(regression().get("current_value"))).isEqualTo(71);
|
||||
assertThat(regression().get("baseline_ref")).isEqualTo("5,4,3,2,1");
|
||||
assertThat(WebPerfStore.asLong(regression().get("cause_change_event_id"))).isEqualTo(change);
|
||||
evaluator.evaluateLab(first);
|
||||
assertThat(store.query("SELECT * FROM {regression}")).hasSize(1);
|
||||
assertThat(RecordingSink.signals).hasSize(1);
|
||||
evaluate(96);
|
||||
evaluate(95);
|
||||
assertThat(regression().get("status")).isEqualTo("CONFIRMED");
|
||||
evaluate(94);
|
||||
assertThat(regression().get("status")).isEqualTo("RESOLVED");
|
||||
assertThat(openCount()).isZero();
|
||||
assertThat(RecordingSink.resolutions).hasSize(1);
|
||||
assertThat(RecordingSink.signals.get(0).getDedupKey()).isEqualTo(RecordingSink.resolutions.get(0).getDedupKey());
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Lab noise stays visible as not confirmed, with no alert.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void rejectsNoise() throws Exception
|
||||
{
|
||||
baseline();
|
||||
long first = evaluate(70);
|
||||
completeConfirmations(first, 96, 95);
|
||||
assertThat(regression().get("status")).isEqualTo("NOT_CONFIRMED");
|
||||
assertThat(openCount()).isZero();
|
||||
assertThat(RecordingSink.signals).isEmpty();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Baselines require five eligible recent results on the same major version.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void boundsBaselineHistory() throws Exception
|
||||
{
|
||||
for(int i = 0; i < 4; i++)
|
||||
{
|
||||
measurement(96, "SCHEDULE", "13.0", Map.of());
|
||||
}
|
||||
measurement(96, "MANUAL", "13.0", Map.of());
|
||||
measurement(96, "SCHEDULE", "12.9", Map.of());
|
||||
long old = measurement(96, "SCHEDULE", "13.0", Map.of());
|
||||
store.update("UPDATE {lab_run} SET completed_at = ? WHERE id = ?", START.minusSeconds(31 * 86400L), old);
|
||||
evaluate(70);
|
||||
assertThat(store.query("SELECT * FROM {regression}")).isEmpty();
|
||||
measurement(96, "SITE_AUDIT", "13.1", Map.of());
|
||||
evaluate(60);
|
||||
assertThat(regression().get("status")).isEqualTo("SUSPECTED");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A major-version change records a marker and retires incompatible baselines.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void resetsAtMajorVersionChange() throws Exception
|
||||
{
|
||||
baseline();
|
||||
long first = evaluate(70);
|
||||
completeConfirmations(first, 71, 72);
|
||||
evaluator.evaluateLab(measurement(60, "SCHEDULE", "14.0", Map.of()));
|
||||
assertThat(regression().get("status")).isEqualTo("RESOLVED");
|
||||
assertThat(regression().get("resolution_note")).isEqualTo("Lighthouse major version changed; baseline reset");
|
||||
assertThat(store.query("SELECT * FROM {change_event} WHERE kind = 'LIGHTHOUSE_VERSION'")).hasSize(1);
|
||||
assertThat(store.query("SELECT * FROM {regression}")).hasSize(1);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Relative and absolute thresholds; deterministic categories confirm now.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void appliesMetricThresholds() throws Exception
|
||||
{
|
||||
baseline();
|
||||
evaluator.evaluateLab(measurement(95, "MANUAL", "13.0", Map.of("lcp_ms", 2499, "cls", 0.049, "tbt_ms", 199)));
|
||||
assertThat(store.query("SELECT * FROM {regression}")).isEmpty();
|
||||
evaluator.evaluateLab(measurement(95, "MANUAL", "13.0", Map.of("lcp_ms", 2500, "cls", 0.05, "tbt_ms", 200,
|
||||
"score_accessibility", 95, "score_best_practices", 95, "score_seo", 95)));
|
||||
assertThat(store.query("SELECT * FROM {regression} WHERE status = 'SUSPECTED'")).hasSize(3);
|
||||
assertThat(store.query("SELECT * FROM {regression} WHERE status = 'CONFIRMED'")).hasSize(3);
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE trigger_type = 'CONFIRM'")).hasSize(2);
|
||||
assertThat(RecordingSink.signals).hasSize(3);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A newly failing audit is actionable even if the rounded score is unchanged.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void newlyFailingAuditConfirms() throws Exception
|
||||
{
|
||||
baseline();
|
||||
long run = measurement(96, "MANUAL", "13.0", Map.of());
|
||||
store.insert(WebPerfSchema.LAB_FINDING, Map.of("run_id", run, "target_id", target, "strategy", "MOBILE",
|
||||
"category", "SEO", "audit_id", "robots-txt", "kind", "FAILED_AUDIT", "score", 0));
|
||||
evaluator.evaluateLab(run);
|
||||
assertThat(regression().get("status")).isEqualTo("CONFIRMED");
|
||||
assertThat(regression().get("failed_audits")).isEqualTo("robots-txt");
|
||||
evaluate(96);
|
||||
evaluate(96);
|
||||
evaluate(96);
|
||||
assertThat(regression().get("status")).isEqualTo("RESOLVED");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Every scope and comparator, with source, strategy and severity matching.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void matchesBudgetScopesComparatorsAndSeverity() throws Exception
|
||||
{
|
||||
Map<String, Object> page = store.query("SELECT * FROM {target}").get(0);
|
||||
for(String scope : List.of("SITE", "TIER", "TARGET", "CONTENT_TABLE", "PATH_PREFIX"))
|
||||
{
|
||||
String value = switch(scope)
|
||||
{
|
||||
case "SITE" -> "host:www.example.com";
|
||||
case "TIER" -> "KEY";
|
||||
case "TARGET" -> String.valueOf(target);
|
||||
case "CONTENT_TABLE" -> "page";
|
||||
default -> "/";
|
||||
};
|
||||
long id = budget(scope, value, "LAB", "MOBILE", "LCP", "<=", 2500, "WARNING");
|
||||
assertThat(evaluator.breachedBudget(page, "LAB", "MOBILE", "LCP", 2500)).isNull();
|
||||
assertThat(evaluator.breachedBudget(page, "LAB", "MOBILE", "LCP", 2501)).isNotNull();
|
||||
assertThat(evaluator.breachedBudget(page, "LAB", "DESKTOP", "LCP", 2501)).isNull();
|
||||
assertThat(evaluator.breachedBudget(page, "CRUX", "MOBILE", "LCP", 2501)).isNull();
|
||||
store.update("UPDATE {budget} SET scope_value = 'unmatched' WHERE id = ?", id);
|
||||
assertThat(evaluator.breachedBudget(page, "LAB", "MOBILE", "LCP", 2501)).isNull();
|
||||
store.update("UPDATE {budget} SET enabled = FALSE WHERE id = ?", id);
|
||||
}
|
||||
for(String comparator : List.of("<", ">", ">=", "=", "!=", "<=", "==", "<>", "LE", "GE", "LT", "GT", "EQ", "NE"))
|
||||
{
|
||||
long id = budget("SITE", "", "LAB", null, "LCP", comparator, 10, "WARNING");
|
||||
for(double value : List.of(9.0, 10.0, 11.0))
|
||||
{
|
||||
boolean acceptable = switch(comparator)
|
||||
{
|
||||
case "<", "LT" -> value < 10;
|
||||
case ">", "GT" -> value > 10;
|
||||
case ">=", "GE" -> value >= 10;
|
||||
case "<=", "LE" -> value <= 10;
|
||||
case "=", "==", "EQ" -> value == 10;
|
||||
default -> value != 10;
|
||||
};
|
||||
assertThat(evaluator.breachedBudget(page, "LAB", "MOBILE", "LCP", value) == null).isEqualTo(acceptable);
|
||||
}
|
||||
store.update("UPDATE {budget} SET enabled = FALSE WHERE id = ?", id);
|
||||
}
|
||||
budget("TIER", "KEY", "LAB", null, "PERFORMANCE_SCORE", ">=", 90, "WARNING");
|
||||
long critical = budget("TIER", "KEY", "LAB", null, "PERFORMANCE_SCORE", ">=", 50, "CRITICAL");
|
||||
long first = evaluate(40);
|
||||
assertThat(WebPerfStore.asLong(regression().get("budget_id"))).isEqualTo(critical);
|
||||
completeConfirmations(first, 40, 41);
|
||||
assertThat(regression().get("severity")).isEqualTo("CRITICAL");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** CrUX URL budgets use real values, never absent data or origin fallbacks.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void evaluatesCruxUrlBudgets() throws Exception
|
||||
{
|
||||
budget("SITE", "", "CRUX", "MOBILE", "LCP", "<=", 2500, "WARNING");
|
||||
long first = field("URL", "OK", 3000, 1);
|
||||
evaluator.evaluateField(first);
|
||||
evaluator.evaluateField(first);
|
||||
assertThat(regression().get("source")).isEqualTo("CRUX");
|
||||
assertThat(regression().get("status")).isEqualTo("CONFIRMED");
|
||||
evaluator.evaluateField(field("URL", "NO_DATA", null, 2));
|
||||
evaluator.evaluateField(field("ORIGIN", "OK", 1000, 3));
|
||||
assertThat(regression().get("status")).isEqualTo("CONFIRMED");
|
||||
evaluator.evaluateField(field("URL", "OK", 2000, 4));
|
||||
assertThat(regression().get("status")).isEqualTo("RESOLVED");
|
||||
assertThat(openCount()).isZero();
|
||||
assertThat(RecordingSink.signals).hasSize(1);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Poll replay, settle delays and attribution through the real queue worker.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void pollsAndAttributesWorkerResults() throws Exception
|
||||
{
|
||||
MutableProbe probe = new MutableProbe();
|
||||
config.withDeployProbe(probe).withLabRunner(new FakeRunner());
|
||||
ChangeEventSource.Change cdn = new ChangeEventSource.Change("CDN_STAGE", "www.example.com", "OFF", "HEADERS_ONLY", START);
|
||||
ChangeEventSource.Change content = new ChangeEventSource.Change("CONTENT", "page:7", "old", "new", START.plusSeconds(1));
|
||||
config.withChangeEventSource(since -> List.of(cdn, content));
|
||||
WebPerfChangeService changes = new WebPerfChangeService(store);
|
||||
changes.poll(START.plusSeconds(2));
|
||||
changes.poll(START.plusSeconds(3));
|
||||
assertThat(store.query("SELECT * FROM {change_event}")).hasSize(3);
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE trigger_type = 'CHANGE_COMPARE'")).hasSize(3);
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE trigger_type = 'DEPLOY'").get(0).get("not_before")).isEqualTo(START.plusSeconds(302));
|
||||
new WebPerfRuntime(config).service().runDue(Instant.now());
|
||||
List<Map<String, Object>> done = store.query("SELECT * FROM {lab_run} WHERE status = 'SUCCEEDED'");
|
||||
assertThat(done).hasSize(2);
|
||||
assertThat(done).allSatisfy(row ->
|
||||
{
|
||||
assertThat(row.get("deployment_id")).isEqualTo("build-1");
|
||||
assertThat(row.get("cdn_stage")).isEqualTo("HEADERS_ONLY");
|
||||
assertThat(row.get("evaluated_at")).isNotNull();
|
||||
});
|
||||
probe.build = "build-2";
|
||||
changes.poll(Instant.now());
|
||||
assertThat(store.query("SELECT * FROM {change_event} WHERE kind = 'FRONTEND_DEPLOY'")).hasSize(2);
|
||||
probe.build = null;
|
||||
changes.poll(Instant.now());
|
||||
assertThat(store.query("SELECT * FROM {change_event} WHERE kind = 'FRONTEND_DEPLOY'")).hasSize(2);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Three samples on each side create reproducible, idempotent comparisons.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void recordsComparisonsWithCountsAndWindows() throws Exception
|
||||
{
|
||||
for(int i = 0; i < 3; i++)
|
||||
{
|
||||
measurement(90, "CHANGE_COMPARE", "13.0", Map.of("lcp_ms", 3000, "fcp_ms", 2000, "ttfb_ms", 900));
|
||||
}
|
||||
long event = change("CDN_STAGE", "www.example.com", "LIVE", START.plusSeconds(4));
|
||||
sequence = 4;
|
||||
for(int i = 0; i < 3; i++)
|
||||
{
|
||||
long id = measurement(96, "CHANGE_COMPARE", "13.1", Map.of("change_event_id", event, "lcp_ms", 2000, "fcp_ms", 1500, "ttfb_ms", 600));
|
||||
evaluator.evaluateLab(id);
|
||||
assertThat(store.query("SELECT * FROM {comparison}")).hasSize(i == 2 ? 4 : 0);
|
||||
}
|
||||
assertThat(new WebPerfComparisonService(store).compare(event)).isEqualTo(4);
|
||||
assertThat(store.query("SELECT * FROM {comparison}")).hasSize(4);
|
||||
Map<String, Object> lcp = store.query("SELECT * FROM {comparison} WHERE metric = 'LCP'").get(0);
|
||||
assertThat(WebPerfStore.asDouble(lcp.get("delta"))).isEqualTo(-1000);
|
||||
assertThat(WebPerfStore.asInt(lcp.get("before_n"))).isEqualTo(3);
|
||||
assertThat(WebPerfStore.asInt(lcp.get("after_n"))).isEqualTo(3);
|
||||
assertThat(lcp.get("before_window").toString()).contains(START.plusSeconds(1).toString());
|
||||
assertThat(runAction(WebPerfProcesses.COMPARE_CHANGE, Map.of()).getException()).isEmpty();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Real ETL actions require a note and manage permission, and retain history.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void actionsRequireNotesAndPermissions() throws Exception
|
||||
{
|
||||
budget("SITE", "", "LAB", null, "SEO_SCORE", ">=", 100, "WARNING");
|
||||
evaluator.evaluateLab(measurement(96, "MANUAL", "13.0", Map.of("score_seo", 90)));
|
||||
long id = WebPerfStore.asLong(regression().get("id"));
|
||||
assertThrows(com.kingsrook.qqq.backend.core.exceptions.QException.class, () -> runAction(WebPerfProcesses.DISMISS_REGRESSIONS, Map.of()));
|
||||
assertThat(regression().get("status")).isEqualTo("CONFIRMED");
|
||||
WebPerfTestSupport.login(instance, "web_performance.read", "web_performance.write");
|
||||
assertThrows(com.kingsrook.qqq.backend.core.exceptions.QException.class, () -> runAction(WebPerfProcesses.DISMISS_REGRESSIONS, Map.of(RegressionSteps.NOTE, "Expected change")));
|
||||
assertThat(regression().get("status")).isEqualTo("CONFIRMED");
|
||||
WebPerfTestSupport.login(instance, "web_performance.read", "web_performance.write", "web_performance.manage.hasAccess");
|
||||
RunProcessOutput result = runAction(WebPerfProcesses.DISMISS_REGRESSIONS, Map.of(RegressionSteps.NOTE, "Expected change"));
|
||||
assertThat(result.getException()).isEmpty();
|
||||
assertThat(result.getValues().get(StreamedETLWithFrontendProcess.FIELD_PROCESS_SUMMARY)).isNotNull();
|
||||
assertThat(regression().get("status")).isEqualTo("DISMISSED");
|
||||
assertThat(regression().get("resolution_note")).isEqualTo("Expected change");
|
||||
assertThat(openCount()).isZero();
|
||||
assertThat(evaluator.finishRegression(id, "RESOLVED", "Already closed", START)).isFalse();
|
||||
evaluator.evaluateLab(measurement(96, "MANUAL", "13.0", Map.of("score_seo", 90)));
|
||||
assertThat(runAction(WebPerfProcesses.RESOLVE_REGRESSIONS, Map.of(RegressionSteps.NOTE, "Fixed externally")).getException()).isEmpty();
|
||||
assertThat(store.query("SELECT * FROM {regression} WHERE status = 'RESOLVED'")).hasSize(1);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Target locking prevents concurrent duplicate incidents; failed writes roll back.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void serializesEvaluationAndRollsBack() throws Exception
|
||||
{
|
||||
baseline();
|
||||
long id = measurement(70, "SCHEDULE", "13.0", Map.of());
|
||||
try(var executor = Executors.newFixedThreadPool(2))
|
||||
{
|
||||
var first = executor.submit(() ->
|
||||
{
|
||||
evaluator.evaluateLab(id);
|
||||
return (null);
|
||||
});
|
||||
var second = executor.submit(() ->
|
||||
{
|
||||
evaluator.evaluateLab(id);
|
||||
return (null);
|
||||
});
|
||||
first.get();
|
||||
second.get();
|
||||
}
|
||||
assertThat(store.query("SELECT * FROM {regression}")).hasSize(1);
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE trigger_type = 'CONFIRM'")).hasSize(2);
|
||||
assertThrows(java.sql.SQLException.class, () -> store.transaction(tx ->
|
||||
{
|
||||
tx.update("UPDATE {target} SET label = 'must roll back' WHERE id = ?", target);
|
||||
tx.update("UPDATE no_such_table SET id = 1");
|
||||
return (null);
|
||||
}));
|
||||
assertThat(store.query("SELECT label FROM {target}").get(0).get("label")).isNotEqualTo("must roll back");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Core falls back to logging without an Alerts QBit; feature gating works.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void alertsAreOptional() throws Exception
|
||||
{
|
||||
AlertsInstanceMetaData.ofOrWithNew(instance).withSink(null);
|
||||
long failures = QAlerts.getProducerFailureCount();
|
||||
budget("SITE", "", "LAB", null, "SEO_SCORE", ">=", 100, "WARNING");
|
||||
evaluator.evaluateLab(measurement(96, "MANUAL", "13.0", Map.of("score_seo", 90)));
|
||||
assertThat(QAlerts.getProducerFailureCount()).isEqualTo(failures);
|
||||
config.getFeatures().remove(WebPerfFeature.ALERTS);
|
||||
evaluator.finishRegression(WebPerfStore.asLong(regression().get("id")), "RESOLVED", "Done", START);
|
||||
assertThat(RecordingSink.signals).isEmpty();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** TTFB comes from a measured subpart and is null when not reported.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void parsesMeasuredTtfbOnly()
|
||||
{
|
||||
assertThat(LabResultParser.ttfb("{\"audits\":{}}")).isNull();
|
||||
assertThat(LabResultParser.ttfb("{\"audits\":{\"lcp-phases-insight\":{\"details\":{\"items\":[{\"subpart\":\"timeToFirstByte\",\"duration\":321.4}]}}}}")).isEqualTo(321);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Quota skips remain visible, and retry preserves each deliberate sample slot.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void retriesCappedConfirmationSamples() throws Exception
|
||||
{
|
||||
baseline();
|
||||
config.withMaxRunsPerDay(1);
|
||||
long first = evaluate(70);
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE status = 'SKIPPED_QUOTA'")).hasSize(1);
|
||||
config.withMaxRunsPerDay(500);
|
||||
assertThat(runAction(WebPerfProcesses.RETRY_RUNS, Map.of()).getException()).isEmpty();
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE status = 'QUEUED' AND trigger_type = 'CONFIRM'")).hasSize(2);
|
||||
assertThat(runAction(WebPerfProcesses.RETRY_RUNS, Map.of()).getException()).isEmpty();
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE status = 'QUEUED' AND trigger_type = 'CONFIRM'")).hasSize(2);
|
||||
store.update("UPDATE {lab_run} SET status = 'SUCCEEDED', completed_at = ?, lighthouse_version = '13.0', score_performance = 70 WHERE status = 'QUEUED'",
|
||||
START.plusSeconds(10));
|
||||
evaluator.evaluatePending();
|
||||
assertThat(regression().get("status")).isEqualTo("CONFIRMED");
|
||||
assertThat(WebPerfStore.asLong(regression().get("first_run_id"))).isEqualTo(first);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Existing seeded budgets are evaluated even before enough baseline exists.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void seededBudgetsWorkWithoutBaseline() throws Exception
|
||||
{
|
||||
store.update("UPDATE {budget} SET enabled = TRUE WHERE seeded = TRUE");
|
||||
long first = evaluate(40);
|
||||
assertThat(regression().get("status")).isEqualTo("SUSPECTED");
|
||||
assertThat(regression().get("baseline_value")).isNull();
|
||||
assertThat(regression().get("severity")).isEqualTo("CRITICAL");
|
||||
completeConfirmations(first, 40, 40);
|
||||
assertThat(regression().get("status")).isEqualTo("CONFIRMED");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Build replays are idempotent even after a rollback to an earlier build.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void attributesRollbackAndQueuesBothCdnWindows() throws Exception
|
||||
{
|
||||
MutableProbe probe = new MutableProbe();
|
||||
config.withDeployProbe(probe);
|
||||
WebPerfChangeService changes = new WebPerfChangeService(store);
|
||||
changes.poll(START);
|
||||
probe.build = "build-2";
|
||||
changes.poll(START.plusSeconds(1));
|
||||
probe.build = "build-1";
|
||||
changes.poll(START.plusSeconds(2));
|
||||
long run = measurement(96, "MANUAL", "13.0", Map.of());
|
||||
changes.attribute(run, START.plusSeconds(3));
|
||||
assertThat(store.query("SELECT deployment_id FROM {lab_run} WHERE id = ?", run).get(0).get("deployment_id")).isEqualTo("build-1");
|
||||
assertThat(store.query("SELECT * FROM {change_event}")).hasSize(2);
|
||||
ChangeEventSource.Change cdn = new ChangeEventSource.Change("CDN_STAGE", "www.example.com", "HEADERS_ONLY", "LIVE", START.plusSeconds(4));
|
||||
config.withChangeEventSource(since -> List.of(cdn));
|
||||
changes.poll(START.plusSeconds(4));
|
||||
changes.poll(START.plusSeconds(5));
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE trigger_type = 'CHANGE_COMPARE'")).hasSize(6);
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE trigger_type = 'CHANGE_COMPARE' AND not_before = ?", START.plusSeconds(3604))).hasSize(3);
|
||||
assertThat(store.query("SELECT * FROM {lab_run} WHERE trigger_type = 'CHANGE_COMPARE' AND not_before = ?", START.plusSeconds(86404))).hasSize(3);
|
||||
assertThat(runAction(WebPerfProcesses.PROBE_DEPLOYS, Map.of()).getException()).isEmpty();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Five clean baseline measurements.
|
||||
*******************************************************************************/
|
||||
private void baseline() throws Exception
|
||||
{
|
||||
for(int i = 0; i < 5; i++)
|
||||
{
|
||||
measurement(96, "SCHEDULE", "13.0", Map.of());
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Store a deterministic successful measurement, with no network access.
|
||||
*******************************************************************************/
|
||||
private long measurement(int score, String trigger, String version, Map<String, Object> extra) throws Exception
|
||||
{
|
||||
Instant time = START.plusSeconds(++sequence);
|
||||
Map<String, Object> row = new LinkedHashMap<>();
|
||||
row.put("target_id", target);
|
||||
row.put("url", "https://www.example.com/");
|
||||
row.put("strategy", "MOBILE");
|
||||
row.put("status", "SUCCEEDED");
|
||||
row.put("trigger_type", trigger);
|
||||
row.put("lighthouse_version", version);
|
||||
row.put("started_at", time);
|
||||
row.put("completed_at", time);
|
||||
row.put("queued_at", time);
|
||||
row.put("score_performance", score);
|
||||
row.put("score_accessibility", 100);
|
||||
row.put("score_best_practices", 100);
|
||||
row.put("score_seo", 100);
|
||||
row.put("lcp_ms", 2000);
|
||||
row.put("fcp_ms", 1000);
|
||||
row.put("tbt_ms", 0);
|
||||
row.put("cls", 0);
|
||||
row.putAll(extra);
|
||||
return (store.insert(WebPerfSchema.LAB_RUN, row));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Store and evaluate the next performance measurement.
|
||||
*******************************************************************************/
|
||||
private long evaluate(int score) throws Exception
|
||||
{
|
||||
long id = measurement(score, "SCHEDULE", "13.0", Map.of());
|
||||
evaluator.evaluateLab(id);
|
||||
return (id);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Complete the independently queued confirmation samples.
|
||||
*******************************************************************************/
|
||||
private void completeConfirmations(long first, int score1, int score2) throws Exception
|
||||
{
|
||||
int index = 0;
|
||||
for(Map<String, Object> row : store.query("SELECT id FROM {lab_run} WHERE trigger_ref IN (?, ?) ORDER BY id", "confirm:" + first + ":0", "confirm:" + first + ":1"))
|
||||
{
|
||||
store.update("UPDATE {lab_run} SET status = 'SUCCEEDED', completed_at = ?, lighthouse_version = '13.0', score_performance = ? WHERE id = ?",
|
||||
START.plusSeconds(++sequence), index++ == 0 ? score1 : score2, row.get("id"));
|
||||
evaluator.evaluateLab(WebPerfStore.asLong(row.get("id")));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** One editable budget.
|
||||
*******************************************************************************/
|
||||
private long budget(String scope, String scopeValue, String source, String strategy, String metric, String comparator, double threshold, String severity) throws Exception
|
||||
{
|
||||
Map<String, Object> row = new LinkedHashMap<>();
|
||||
row.put("name", "Test budget");
|
||||
row.put("scope", scope);
|
||||
row.put("scope_value", scopeValue);
|
||||
row.put("source", source);
|
||||
row.put("strategy", strategy);
|
||||
row.put("metric", metric);
|
||||
row.put("comparator", comparator);
|
||||
row.put("threshold", threshold);
|
||||
row.put("severity", severity);
|
||||
row.put("enabled", true);
|
||||
return (store.insert(WebPerfSchema.BUDGET, row));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A source event without automatic queueing for fixtures.
|
||||
*******************************************************************************/
|
||||
private long change(String kind, String component, String value, Instant time) throws Exception
|
||||
{
|
||||
return (new WebPerfChangeService(store).record(new ChangeEventSource.Change(kind, component, "before", value, time), "WEBHOOK", "test", false));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A real or unavailable CrUX collection period.
|
||||
*******************************************************************************/
|
||||
private long field(String scope, String status, Integer lcp, int day) throws Exception
|
||||
{
|
||||
Map<String, Object> row = new LinkedHashMap<>();
|
||||
row.put("source", "CRUX_API");
|
||||
row.put("scope", scope);
|
||||
row.put("scope_key", "https://www.example.com/");
|
||||
row.put("form_factor", "PHONE");
|
||||
row.put("status", status);
|
||||
row.put("p75_lcp_ms", lcp);
|
||||
row.put("period_end", LocalDate.of(2026, 10, day));
|
||||
row.put("last_checked_at", START.plusSeconds(day));
|
||||
return (store.insert(WebPerfSchema.FIELD_SNAPSHOT, row));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The first incident, retained through status changes.
|
||||
*******************************************************************************/
|
||||
private Map<String, Object> regression() throws Exception
|
||||
{
|
||||
return (store.query("SELECT * FROM {regression} ORDER BY id").get(0));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The count shown in Tested Pages.
|
||||
*******************************************************************************/
|
||||
private int openCount() throws Exception
|
||||
{
|
||||
return (WebPerfStore.asInt(store.query("SELECT open_regression_count FROM {target} WHERE id = ?", target).get(0).get("open_regression_count")));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Run the actual ETL process, following the existing frontend-skip convention.
|
||||
*******************************************************************************/
|
||||
private RunProcessOutput runAction(String name, Map<String, Serializable> values) throws Exception
|
||||
{
|
||||
RunProcessInput input = new RunProcessInput();
|
||||
input.setPermissionEnforcement(com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement.ENFORCE);
|
||||
input.setProcessName(config.qualify(name));
|
||||
input.setValues(new HashMap<>(values));
|
||||
input.setFrontendStepBehavior(RunProcessInput.FrontendStepBehavior.SKIP);
|
||||
input.setCallback(new QProcessCallback()
|
||||
{
|
||||
/*******************************************************************************
|
||||
** Select this test's records.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public QQueryFilter getQueryFilter()
|
||||
{
|
||||
return (new QQueryFilter());
|
||||
}
|
||||
});
|
||||
return (new RunProcessAction().execute(input));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Core alert sink, without any Alerts QBit dependency.
|
||||
*******************************************************************************/
|
||||
public static class RecordingSink implements AlertSinkInterface
|
||||
{
|
||||
static final List<AlertSignal> signals = new ArrayList<>();
|
||||
static final List<AlertResolution> resolutions = new ArrayList<>();
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Capture a raise.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public void raise(AlertSignal signal)
|
||||
{
|
||||
signals.add(signal);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Capture a resolution.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public void resolve(AlertResolution resolution)
|
||||
{
|
||||
resolutions.add(resolution);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** This producer does not emit heartbeats.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public void heartbeat(String key, Instant at)
|
||||
{
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A probe controlled by the test.
|
||||
*******************************************************************************/
|
||||
private static class MutableProbe implements DeployProbe
|
||||
{
|
||||
String build = "build-1";
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Frontend component.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public String component()
|
||||
{
|
||||
return ("FRONTEND");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Build id without transport.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public String currentBuildId()
|
||||
{
|
||||
return (build);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** A minimal Lighthouse runner without transport.
|
||||
*******************************************************************************/
|
||||
private static class FakeRunner implements LabRunner
|
||||
{
|
||||
/*******************************************************************************
|
||||
** Stored runner name.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public String name()
|
||||
{
|
||||
return ("TEST");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Return a successful response.
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
public LabResponse run(LabRequest request)
|
||||
{
|
||||
JSONObject body = new JSONObject().put("lighthouseVersion", "13.0").put("finalUrl", request.url())
|
||||
.put("categories", new JSONObject().put("performance", new JSONObject().put("score", 0.96)))
|
||||
.put("audits", new JSONObject());
|
||||
return (new LabResponse(200, body.toString(), Instant.now()));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -31,9 +31,6 @@ import java.util.Locale;
|
||||
import java.util.Set;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.UpdateAction;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateOutput;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertOutput;
|
||||
@@ -44,7 +41,6 @@ import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSource;
|
||||
import com.kingsrook.qqq.backend.module.rdbms.jdbc.ConnectionManager;
|
||||
import com.kingsrook.qqq.backend.module.rdbms.model.metadata.RDBMSBackendMetaData;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
@@ -134,18 +130,6 @@ class WebPerfSchemaTest
|
||||
assertEquals(13, budgets.size());
|
||||
assertThat(budgets).allMatch(r -> Boolean.TRUE.equals(r.getValueBoolean("seeded")) && Boolean.TRUE.equals(r.getValueBoolean("enabled")));
|
||||
|
||||
for(QRecord budget : budgets)
|
||||
{
|
||||
for(String field : List.of("scope", "source", "strategy", "metric", "comparator", "severity"))
|
||||
{
|
||||
if(budget.getValue(field) != null)
|
||||
{
|
||||
QPossibleValueSource source = qInstance.getPossibleValueSource(qInstance.getTable("web_performance_budget").getField(field).getPossibleValueSourceName());
|
||||
assertThat(source.getEnumValues()).extracting(v -> (String) v.getId()).contains(budget.getValueString(field));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
QRecord inp = budgets.stream().filter(r -> "INP good (real users, p75)".equals(r.getValueString("name"))).findFirst().orElseThrow();
|
||||
assertEquals("RUM", inp.getValueString("source"));
|
||||
assertEquals(0, new BigDecimal("200").compareTo(inp.getValueBigDecimal("threshold")));
|
||||
@@ -167,68 +151,16 @@ class WebPerfSchemaTest
|
||||
{
|
||||
installed("perf_");
|
||||
InsertOutput output = new InsertAction().execute(new InsertInput("perf_target").withRecords(List.of(
|
||||
new QRecord().withValue("url", "https://www.example.com/about").withValue("label", "About")
|
||||
.withValue("tier", "KEY").withValue("enabled", true))));
|
||||
new QRecord().withValue("siteKey", "site:1").withValue("url", "https://www.example.com/about").withValue("path", "/about")
|
||||
.withValue("source", "MANUAL").withValue("tier", "KEY").withValue("enabled", true))));
|
||||
assertThat(output.getRecords().get(0).getErrors()).isEmpty();
|
||||
|
||||
QRecord stored = new QueryAction().execute(new QueryInput("perf_target").withFilter(new QQueryFilter())).getRecords().get(0);
|
||||
assertEquals("https://www.example.com/about", stored.getValueString("url"));
|
||||
assertEquals("KEY", stored.getValueString("tier"));
|
||||
assertEquals("host:www.example.com", stored.getValueString("siteKey"));
|
||||
assertEquals("/about", stored.getValueString("path"));
|
||||
assertEquals("MANUAL", stored.getValueString("source"));
|
||||
assertEquals(false, stored.getValueBoolean("inSitemap"));
|
||||
|
||||
InsertOutput duplicate = new InsertAction().execute(new InsertInput("perf_target").withRecords(List.of(
|
||||
new QRecord().withValue("siteKey", "site:1").withValue("url", "https://www.example.com/about"))));
|
||||
assertThat(duplicate.getRecords().get(0).getErrors()).isNotEmpty();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Invalid manual URLs return a clear error and never become tested pages.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testManualPageUrlValidation() throws Exception
|
||||
{
|
||||
installed("perf_");
|
||||
for(String url : List.of("", "/about", "http://www.example.com/about", "https:///about", "https://user:pass@example.com/", "https://www.example.com/#section", "not a URL"))
|
||||
{
|
||||
InsertOutput output = new InsertAction().execute(new InsertInput("perf_target").withRecords(List.of(new QRecord().withValue("url", url))));
|
||||
assertThat(output.getRecords().get(0).getErrors()).isNotEmpty();
|
||||
assertThat(output.getRecords().get(0).getErrors().toString()).contains("absolute HTTPS URL");
|
||||
}
|
||||
assertThat(new QueryAction().execute(new QueryInput("perf_target").withFilter(new QQueryFilter())).getRecords()).isEmpty();
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Editing a URL refreshes its path; invalid edits leave the stored URL intact.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testManualPageUrlUpdates() throws Exception
|
||||
{
|
||||
installed("perf_");
|
||||
QRecord inserted = new InsertAction().execute(new InsertInput("perf_target").withRecords(List.of(
|
||||
new QRecord().withValue("url", "https://www.example.com")))).getRecords().get(0);
|
||||
assertThat(inserted.getErrors()).isEmpty();
|
||||
assertEquals("/", inserted.getValueString("path"));
|
||||
UpdateOutput valid = new UpdateAction().execute(new UpdateInput("perf_target").withRecords(List.of(
|
||||
new QRecord().withValue("id", inserted.getValue("id")).withValue("url", "https://www.example.com/new"))));
|
||||
assertThat(valid.getRecords().get(0).getErrors()).isEmpty();
|
||||
UpdateOutput invalid = new UpdateAction().execute(new UpdateInput("perf_target").withRecords(List.of(
|
||||
new QRecord().withValue("id", inserted.getValue("id")).withValue("url", "/bad"))));
|
||||
assertThat(invalid.getRecords().get(0).getErrors()).isNotEmpty();
|
||||
UpdateOutput labelOnly = new UpdateAction().execute(new UpdateInput("perf_target").withRecords(List.of(
|
||||
new QRecord().withValue("id", inserted.getValue("id")).withValue("label", "New page"))));
|
||||
assertThat(labelOnly.getRecords().get(0).getErrors()).isEmpty();
|
||||
QRecord stored = new QueryAction().execute(new QueryInput("perf_target").withFilter(new QQueryFilter())).getRecords().get(0);
|
||||
assertEquals("https://www.example.com/new", stored.getValueString("url"));
|
||||
assertEquals("/new", stored.getValueString("path"));
|
||||
assertEquals("New page", stored.getValueString("label"));
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,185 +0,0 @@
|
||||
/*
|
||||
* Copyright 2026 Kingsrook, 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 com.kingsrook.qbits.webperf;
|
||||
|
||||
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import java.util.Map;
|
||||
import java.util.regex.Pattern;
|
||||
import java.util.stream.Stream;
|
||||
import com.kingsrook.qbits.webperf.metadata.WebPerfHelp;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.help.QHelpContent;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Guardrail (owner requirement 2026-10-14: "all tables should be populated and
|
||||
** the qbit should be fully using them"). For every web_performance_* table:
|
||||
** - runtime code (not just its metadata or the home widgets) reads or writes
|
||||
** it, so no table exists only on paper;
|
||||
** - it is either seeded by the shipped changelog or listed in STARTS_EMPTY
|
||||
** with why it starts empty;
|
||||
** - it has bundle help that says what it is for and how its rows get created.
|
||||
** A new table fails this test until it is wired, seeded or explained.
|
||||
*******************************************************************************/
|
||||
class WebPerfTablesGuardrailTest
|
||||
{
|
||||
private static final Path MAIN = Path.of("src", "main", "java", "com", "kingsrook", "qbits", "webperf");
|
||||
|
||||
/*******************************************************************************
|
||||
** Tables the shipped changelog seeds (WebPerfDefaultsChangelogTest proves it).
|
||||
*******************************************************************************/
|
||||
static final Map<String, String> SEEDED = Map.of(
|
||||
"budget", "changeset 10: Google's good thresholds and the Lighthouse category bands");
|
||||
|
||||
/*******************************************************************************
|
||||
** Tables that legitimately start empty, and where their rows come from.
|
||||
*******************************************************************************/
|
||||
static final Map<String, String> STARTS_EMPTY = Map.of(
|
||||
"target", "synced from the sitemap (Sync pages from sitemap) or added by hand; the page list is host content",
|
||||
"lab_run", "runtime: every queued or finished Lighthouse test",
|
||||
"lab_finding", "runtime: findings of each successful lab run",
|
||||
"lab_report", "runtime: the full response of each successful lab run",
|
||||
"field_snapshot", "runtime: Google field data checks",
|
||||
"regression", "runtime: a budget is broken or a score drifts (empty is healthy)",
|
||||
"change_event", "runtime: a deploy or content change is detected (needs a probe or source)",
|
||||
"comparison", "runtime: Compare before and after on a change event");
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
@AfterEach
|
||||
void tearDown()
|
||||
{
|
||||
QContext.clear();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Every table is used by runtime code.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void everyTableIsUsedAtRuntime() throws Exception
|
||||
{
|
||||
List<String> runtimeSource;
|
||||
try(Stream<Path> files = Files.walk(MAIN))
|
||||
{
|
||||
runtimeSource = files.filter(p -> p.toString().endsWith(".java"))
|
||||
.filter(p -> !p.startsWith(MAIN.resolve("metadata")) && !p.startsWith(MAIN.resolve("widgets")))
|
||||
.map(WebPerfTablesGuardrailTest::read).toList();
|
||||
}
|
||||
for(String base : WebPerfSchema.TABLES)
|
||||
{
|
||||
Pattern use = Pattern.compile("\\{" + base + "\\}|WebPerfSchema\\." + base.toUpperCase(Locale.ROOT) + "\\b");
|
||||
assertThat(runtimeSource.stream().anyMatch(source -> use.matcher(source).find()))
|
||||
.as(base + " must be read or written by runtime code, not only declared").isTrue();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Every table is seeded or explained.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void everyTableIsSeededOrExplained() throws Exception
|
||||
{
|
||||
String changelog = Files.readString(Path.of("src", "main", "resources", WebPerfSchema.CHANGELOG), StandardCharsets.UTF_8);
|
||||
for(String base : WebPerfSchema.TABLES)
|
||||
{
|
||||
boolean seeded = SEEDED.containsKey(base);
|
||||
assertThat(seeded || STARTS_EMPTY.containsKey(base)).as(base + " must be seeded or listed in STARTS_EMPTY").isTrue();
|
||||
assertThat(seeded && STARTS_EMPTY.containsKey(base)).as(base + " cannot be both").isFalse();
|
||||
assertThat(changelog.contains("INSERT INTO ${web_performance.tablePrefix}" + base + " ")).as(base + " seeded iff the changelog inserts it").isEqualTo(seeded);
|
||||
}
|
||||
assertThat(WebPerfSchema.TABLES).containsAll(SEEDED.keySet()).containsAll(STARTS_EMPTY.keySet());
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Every table and the app have bundle help that says how rows get created.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void everyTableHasEmptyStateHelp() throws Exception
|
||||
{
|
||||
QInstance qInstance = WebPerfTestSupport.newInstance();
|
||||
new WebPerfQBitProducer().withQBitConfig(WebPerfTestSupport.config()).produce(qInstance);
|
||||
WebPerfQBitConfig config = WebPerfTestSupport.config();
|
||||
|
||||
assertThat(WebPerfHelp.entries()).allSatisfy((key, entry) -> assertThat(entry.path("summary").asText().length()).as(key).isLessThanOrEqualTo(120));
|
||||
for(String base : WebPerfSchema.TABLES)
|
||||
{
|
||||
QTableMetaData table = qInstance.getTable(config.applyPrefix(base));
|
||||
List<QHelpContent> help = table.getHelpContent() == null ? null : table.getHelpContent().get(WebPerfHelp.SLOT);
|
||||
assertThat(help).as(base + " table help").isNotEmpty();
|
||||
assertThat(help.get(0).getContent()).as(base + " help says how rows get created").contains("How rows get created");
|
||||
}
|
||||
assertThat(qInstance.getApp(config.getAppName()).getHelpContent()).containsKey(WebPerfHelp.SLOT);
|
||||
assertThat(WebPerfHelp.entries()).hasSize(WebPerfSchema.TABLES.size() + 1);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Help a host already wrote is kept; the bundle only fills empty slots.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void hostHelpIsNotOverridden() throws Exception
|
||||
{
|
||||
QInstance qInstance = WebPerfTestSupport.newInstance();
|
||||
WebPerfQBitConfig config = WebPerfTestSupport.config();
|
||||
new WebPerfQBitProducer().withQBitConfig(config).produce(qInstance);
|
||||
QTableMetaData table = qInstance.getTable(config.applyPrefix(WebPerfSchema.BUDGET));
|
||||
table.getHelpContent().remove(WebPerfHelp.SLOT);
|
||||
table.withHelpContent(WebPerfHelp.SLOT, new QHelpContent("host words"));
|
||||
|
||||
WebPerfHelp.apply(qInstance, config);
|
||||
|
||||
assertThat(table.getHelpContent().get(WebPerfHelp.SLOT).get(0).getContent()).isEqualTo("host words");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
private static String read(Path path)
|
||||
{
|
||||
try
|
||||
{
|
||||
return (Files.readString(path, StandardCharsets.UTF_8));
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
throw (new IllegalStateException(e));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -127,18 +127,9 @@ public final class WebPerfTestSupport
|
||||
|
||||
List<String> statements = new ArrayList<>();
|
||||
StringBuilder current = new StringBuilder();
|
||||
boolean skip = false;
|
||||
for(String line : script.split("\n"))
|
||||
{
|
||||
//////////////////////////////////////////////////////////////////////
|
||||
// a changeset limited to other databases (the dbms:postgresql //
|
||||
// orphan cleanup) is skipped, as Liquibase skips it on H2 //
|
||||
//////////////////////////////////////////////////////////////////////
|
||||
if(line.startsWith("-- changeset "))
|
||||
{
|
||||
skip = line.contains(" dbms:") && !line.contains("h2");
|
||||
}
|
||||
if(skip || line.trim().startsWith("--"))
|
||||
if(line.trim().startsWith("--"))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user