Merge pull request #74 from foomo/feature/remove-pwa

Remove Deprecated PWA Category

Author: smartinov

README.md

@@ -64,7 +64,7 @@ Or via JSON which adds additional parameters
 // URL can't be invalid
 // Strategy can only be mobile/desktop
 // If strategy is not specified, both desktop & mobile will be used
-// Categories can be any of accessibility/best-practices/performance/pwa/seo
+// Categories can be any of accessibility/best-practices/performance/seo
 // If categories are not specified, all categories will be used
 // Parameters are passed down to google pagespeed api
 
@@ -86,7 +86,7 @@ Configuration of targets can be done via docker and via prometheus
 |------------------|----------------------|-----------------------------------------------|----------------------------------------------------------------------|----------|
 | -api-key         | PAGESPEED_API_KEY    | sets the google API key used for pagespeed                        |                                                  | False    |
 | -targets         | PAGESPEED_TARGETS    | comma separated list of targets to measure                        |                                                  | False    |
-| -categories      | PAGESPEED_CATEGORIES | comma separated list of categories to check                       | accessibility,best-practices,performance,pwa,seo | False    |
+| -categories      | PAGESPEED_CATEGORIES | comma separated list of categories to check                       | accessibility,best-practices,performance,seo | False    |
 | -t               | NONE                 | multi-value target array (check docker comp)                      |                                                  | False    |
 | -listener        | PAGESPEED_LISTENER   | sets the listener address for the exporters                       | :9271                                            | False    |
 | -parallel        | PAGESPEED_PARALLEL   | sets the execution of targets to be parallel                      | false                                            | False    |
@@ -145,7 +145,7 @@ or
 $ docker run -p "9271:9271" --rm \
     --env PAGESPEED_API_KEY={KEY} \
     --env PAGESPEED_TARGETS=https://google.com,https://prometheus.io \
-    --env PAGESPEED_CATEGORIES=accessibility,pwa \
+    --env PAGESPEED_CATEGORIES=accessibility,seo \
     foomo/pagespeed_exporter
 ```
 

collector/collector.go

@@ -177,7 +177,6 @@ func collectLighthouseResults(prefix string, cats []string, lhr *pagespeedonline
 	categories := map[string]*pagespeedonline.LighthouseCategoryV5{
 		CategoryPerformance:   lhr.Categories.Performance,
 		CategoryAccessibility: lhr.Categories.Accessibility,
-		CategoryPWA:           lhr.Categories.Pwa,
 		CategoryBestPractices: lhr.Categories.BestPractices,
 		CategorySEO:           lhr.Categories.Seo,
 	}

collector/model.go

@@ -15,7 +15,6 @@ const (
 	CategoryAccessibility = "accessibility"
 	CategoryBestPractices = "best-practices"
 	CategorySEO           = "seo"
-	CategoryPWA           = "pwa"
 	CategoryPerformance   = "performance"
 
 	Namespace = "pagespeed"
@@ -32,7 +31,6 @@ var availableCategories = map[string]bool{
 	CategoryAccessibility: true,
 	CategoryBestPractices: true,
 	CategorySEO:           true,
-	CategoryPWA:           true,
 	CategoryPerformance:   true,
 }
 

collector/model_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 func TestCalculateScrapeRequests(t *testing.T) {
-	allCategories := []string{"accessibility", "best-practices", "performance", "pwa", "seo"}
+	allCategories := []string{"accessibility", "best-practices", "performance", "seo"}
 
 	tests := []struct {
 		name       string
@@ -27,9 +27,9 @@ func TestCalculateScrapeRequests(t *testing.T) {
 			{Url: "http://test2.com", Strategy: StrategyDesktop, Categories: allCategories},
 			{Url: "http://test2.com", Strategy: StrategyMobile, Categories: allCategories},
 		}},
-		{"single with categories", []string{"http://test.com"}, []string{"accessibility", "pwa"}, []ScrapeRequest{
-			{Url: "http://test.com", Strategy: StrategyDesktop, Categories: []string{"accessibility", "pwa"}},
-			{Url: "http://test.com", Strategy: StrategyMobile, Categories: []string{"accessibility", "pwa"}},
+		{"single with categories", []string{"http://test.com"}, []string{"accessibility", "seo"}, []ScrapeRequest{
+			{Url: "http://test.com", Strategy: StrategyDesktop, Categories: []string{"accessibility", "seo"}},
+			{Url: "http://test.com", Strategy: StrategyMobile, Categories: []string{"accessibility", "seo"}},
 		}},
 		{"multiple with categories", []string{"http://test.com", "http://test2.com"}, []string{"best-practices"}, []ScrapeRequest{
 			{Url: "http://test.com", Strategy: StrategyDesktop, Categories: []string{"best-practices"}},
@@ -51,14 +51,14 @@ func TestCalculateScrapeRequests(t *testing.T) {
 				},
 			}},
 		{"json with category",
-			[]string{`{"url":"http://test.com","strategy":"desktop","campaign":"campaign","source":"source","locale":"locale", "categories":["pwa"]}`}, nil, []ScrapeRequest{
+			[]string{`{"url":"http://test.com","strategy":"desktop","campaign":"campaign","source":"source","locale":"locale", "categories":["seo"]}`}, nil, []ScrapeRequest{
 				{
 					Url:        "http://test.com",
 					Strategy:   StrategyDesktop,
 					Campaign:   "campaign",
 					Source:     "source",
 					Locale:     "locale",
-					Categories: []string{"pwa"},
+					Categories: []string{"seo"},
 				},
 			}},
 		{"json with wrong category",
@@ -92,7 +92,7 @@ func TestCalculateScrapeRequests(t *testing.T) {
 }
 
 func TestPopulateCategories(t *testing.T) {
-	allCategories := []string{"accessibility", "best-practices", "performance", "pwa", "seo"}
+	allCategories := []string{"accessibility", "best-practices", "performance", "seo"}
 
 	tests := []struct {
 		msg  string
@@ -121,9 +121,9 @@ func TestPopulateCategories(t *testing.T) {
 		{
 			"input categories are set in request",
 			&ScrapeRequest{},
-			[]string{"best-practices", "pancake", "pwa"},
+			[]string{"best-practices", "pancake", "seo"},
 			&ScrapeRequest{
-				Categories: []string{"best-practices", "pancake", "pwa"},
+				Categories: []string{"best-practices", "pancake", "seo"},
 			},
 		},
 	}

collector/scrape.go

@@ -118,7 +118,6 @@ func (pss pagespeedScrapeService) scrape(request ScrapeRequest) (scrape *ScrapeR
 	if err != nil {
 		return nil, errors.Wrap(err, "could not initialize pagespeed service")
 	}
-
 	call := service.Pagespeedapi.Runpagespeed(request.Url)
 	call.Category(request.Categories...)
 	call.Strategy(string(request.Strategy))

example/grafana/provisioning/dashboards/pagespeed.json

@@ -309,93 +309,6 @@
       "transparent": true,
       "type": "gauge"
     },
-    {
-      "datasource": {
-        "type": "prometheus",
-        "uid": "${DS_PROMETHEUS}"
-      },
-      "description": "Lighthouse returns a Progressive Web App (PWA) score between 0 and 100. 0 is the worst possible score, and 100 is the best.\n\nThe PWA audits are based on the Baseline PWA Checklist, which lists 14 requirements. Lighthouse has automated audits for 11 of the 14 requirements. The remaining 3 can only be tested manually. Each of the 11 automated PWA audits are weighted equally, so each one contributes approximately 9 points to your PWA score.",
-      "fieldConfig": {
-        "defaults": {
-          "color": {
-            "mode": "thresholds"
-          },
-          "mappings": [
-            {
-              "options": {
-                "match": "null",
-                "result": {
-                  "text": "N/A"
-                }
-              },
-              "type": "special"
-            }
-          ],
-          "max": 100,
-          "min": 0,
-          "thresholds": {
-            "mode": "absolute",
-            "steps": [
-              {
-                "color": "#d44a3a",
-                "value": null
-              },
-              {
-                "color": "rgba(237, 129, 40, 0.89)",
-                "value": 50
-              },
-              {
-                "color": "#299c46",
-                "value": 90
-              }
-            ]
-          },
-          "unit": "none"
-        },
-        "overrides": []
-      },
-      "gridPos": {
-        "h": 4,
-        "w": 4,
-        "x": 12,
-        "y": 1
-      },
-      "id": 13,
-      "maxDataPoints": 100,
-      "options": {
-        "minVizHeight": 75,
-        "minVizWidth": 75,
-        "orientation": "horizontal",
-        "reduceOptions": {
-          "calcs": [
-            "lastNotNull"
-          ],
-          "fields": "",
-          "values": false
-        },
-        "showThresholdLabels": false,
-        "showThresholdMarkers": true,
-        "sizing": "auto"
-      },
-      "pluginVersion": "10.4.3",
-      "repeatDirection": "h",
-      "targets": [
-        {
-          "datasource": {
-            "type": "prometheus",
-            "uid": "${DS_PROMETHEUS}"
-          },
-          "expr": "pagespeed_lighthouse_category_score{host=\"$host\",path=\"$path\",strategy=\"$strategy\",category=\"pwa\"} * 100",
-          "format": "time_series",
-          "intervalFactor": 1,
-          "legendFormat": "",
-          "refId": "A"
-        }
-      ],
-      "title": "PWA Score",
-      "transparent": true,
-      "type": "gauge"
-    },
     {
       "datasource": {
         "type": "prometheus",

pagespeed_exporter.go

@@ -94,7 +94,7 @@ func parseFlags() {
 	flag.StringVar(&pushGatewayUrl, "pushGatewayUrl", getenv("PUSHGATEWAY_URL", ""), "sets the push gateway to send the metrics. leave empty to ignore it")
 	flag.StringVar(&pushGatewayJob, "pushGatewayJob", getenv("PUSHGATEWAY_JOB", "pagespeed_exporter"), "sets push gateway job name")
 	targetsFlag := flag.String("targets", getenv("PAGESPEED_TARGETS", ""), "comma separated list of targets to measure")
-	categoriesFlag := flag.String("categories", getenv("PAGESPEED_CATEGORIES", "accessibility,best-practices,performance,pwa,seo"), "comma separated list of categories. overridden by categories in JSON targets")
+	categoriesFlag := flag.String("categories", getenv("PAGESPEED_CATEGORIES", "accessibility,best-practices,performance,seo"), "comma separated list of categories. overridden by categories in JSON targets")
 	flag.Var(&targets, "t", "multiple argument parameters")
 	flag.Parse()