As a system admin, I want to configure PageSpeed from system settings

• Type: Story
• Status: Closed
• Priority: Minor
• Resolution: Completed
• Affects Version/s: None
• Fix Version/s: 7.4.2 CE GA3, 7.4.13 DXP GA1, Master
• Component/s: SEO Tools > Page Audit
• Labels:
  • d_21_02
  • fc_21_06
  • pt-app-security-review
• Epic/Theme:
  • Page_Audit
• Epic Link: tango-config-Page-audit
• Sprint: TANGO | #53 DIS | Jan22-Feb05, TANGO | #54 DIS | Feb05-Feb19, TANGO | #55 DIS | Feb19-Mar05, TANGO | #56 DIS | Mar05-Mar19, TANGO | #61 DEV | May14-Jun04, TANGO | #62 DEV | Jun04-Jun25, TANGO | #63 DEV | Jun25-Jul16
• Git Pull Request: https://github.com/liferay-tango/liferay-portal/pull/1272

Motivation

With this story, we want to build PageSpeed API configuration at system level. 

Design

https://www.figma.com/file/MjnodYRWIJfT2toNjK8WnR/LPS-128382-configure-Page-Speed?node-id=1%3A1975

Technical Requirements

Configuration panel will be in: System settings > Pages > System Scope / Virtual Instance Scope / Site Scope sections

SYSTEM SCOPE:

2. There will be a check: Enable Google Page Speed Insights. It will be checked by default.

2.1. There will be help text: Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.

2.2. When the check is disabled, the Page Audit icon won't be visible from the view mode of the pages (see LPS-119068) in all sites of all Instances.

2.3. When the check is disabled, the "Google PageSpeed Insights" tab won't be visible in the "VIRTUAL INSTANCE SCOPE" section

2.4. When the check is disabled, the "Google PageSpeed Insights" tab won't be visible from the "SITE SCOPE" section

 

VIRTUAL INSTANCE SCOPE SECTION:

3. There will be a check: Enable Google Page Speed Insights. It will be checked by default.

3.1. There will be help text: Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.

3.2. When the check is disabled, the Page Audit icon won't be visible from the view mode of the pages (see LPS-119068) in all sites of the current Instance.

3.3. When the check is disabled, the "Google PageSpeed Insights" tab won't be visible in the Site settings of any of the sites of the current Instance.

3.4. Even if the check is disabled, the "Google PageSpeed Insights" tab will be visible from the "SITE SCOPE" section

SITE SCOPE SECTION:

4. There will be a check: Enable Google Page Speed Insights. It will be checked by default.
4.1. There will be a help text: Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.

4.2. When the check is disabled, the Page Audit icon won't be visible from the view mode of the pages (see LPS-119068) in all sites in all Instances.

4.3. Even if the check is disabled, the "Google PageSpeed Insights" tab will be visible from the Site settings of any of the sites in the instance, and it will be unchecked for all those sites

5. There will be a Field to enter the API Key (format: AIzaSyAq-oKsvIhlYHdk1UXCFy63h74ECIgbgbE) 

• Label: API Key
• Help text: Get your API Key at https://developers.google.com/speed/docs/insights/v5/get-started 

NOTE: The value in this field will be inherited by all instances

6. There will be a field for setting specific timeout:

• Label: Timeout Interval. 
• Help text (under the field): Define the time (in milliseconds) before a PageSpeed Insights request times out. 
• Default value: 30000 millisecs

7. There will be a field for specifying the "strategy" parameter for the API:

• Label: Preferred Strategy
• Help text: Select what kind of device you want to audit for. Mobile strategy includes additional checks. Selected strategy will be applied to all page audits.
• Dropdown to select Mobile or Desktop. It will be set as Mobile.

NOTE.- If the field is kept void, then the default value (desktop) will apply. Additional checks for mobile are: Small Tap Targets, Incorrect Aspect

• Cache enablement will be tackled in LPS-128387

• System settings values are overwritten by Instance values for a particular instance, but the feature has to be enabled in the system level for the instance settings to show it.

Acceptance Criteria

Requirements	Acceptance Criteria	Test Strategy	Covered by frontend / backend test? (Yes/No)
1.  Configuration panel will be in: System settings > Pages > System Scope / Virtual Instance Scope / Site Scope sections	Given the System settings page When the users click on Content > Pages Then they can see the tab Google PageSpeed Insights under System / Instance / Site Scope	Low	NO
2. There will be a check: Enable Google Page Speed Insights. It will be checked by default. 2.1. There will be a subtitle / help text: Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.	Given the Google PageSpeed Insights settings tab in the System Scope section Then there's a check: Enable Google PageSpeed Insights, it is checked by default and there is a help text: Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.	Low	YES
2.2. When the check is disabled, the Page Audit icon won't be visible from the view mode of the pages (see LPS-119068) in all sites of all Instances.	Given the Google PageSpeed settings tab in the System Scope section When the Enable Google PageSpeed Insights check is unchecked Then the Page Audit icon won't be visible from the view mode of the pages (see LPS-119068) in all sites of all Instances.	Low	NO
2.3. When the check is disabled, the "Google PageSpeed Insights" tab won't be visible in the "VIRTUAL INSTANCE SCOPE" section	Given the Google PageSpeed settings tab in the System Scope section When the Enable Google PageSpeed Insights check is unchecked Then the "Google PageSpeed Insights" tab isn't visible in the "VIRTUAL INSTANCE SCOPE" section	Medium	NO
2.4. When the check is disabled, the "Google PageSpeed Insights" tab won't be visible from the "SITE SCOPE" section	Given the Google PageSpeed settings tab in the System Scope section When the Enable Google PageSpeed Insights check is unchecked Then the "Google PageSpeed Insights" tab isn't visible in the "SITE SCOPE" section	Medium	NO
3. There will be a check: Enable Google Page Speed Insights. It will be checked by default. 3.1. There will be help text: Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.	Given the Google PageSpeed Insights settings tab in the Virtual Instance Scope section Then there's a check: Enable Google PageSpeed Insights, it is checked by default.	Low	YES
	Given the Google PageSpeed Insights settings tab in the Virtual Instance Scope section Then there's a check: Enable Google PageSpeed Insights,  there is a help text: Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.	Low	NO
3.2. When the check is disabled, the Page Audit icon won't be visible from the view mode of the pages (see LPS-119068) in all sites of the current Instance.	Given the Google PageSpeed settings tab in the Virtual Instance Scope section When the Enable Google PageSpeed Insights check is unchecked Then the Page Audit icon won't be visible from the view mode of the pages (see LPS-119068) in all sites of the current Instance.	Low (already tested)	NO
3.3. When the check is disabled, the "Google PageSpeed Insights" tab won't be visible in the Site settings of any of the sites of the current Instance.	Given the Google PageSpeed settings tab in the Virtual Instance Scope section When the Enable Google PageSpeed Insights check is unchecked Then the "Google PageSpeed Insights" tab isn't visible in the Site settings of any of the sites of the current Instance.	Medium	NO
3.4. Even if the check is disabled, the "Google PageSpeed Insights" tab will be visible from the "SITE SCOPE" section	Given the Google PageSpeed settings tab in the Virtual Instance Scope section When the Enable Google PageSpeed Insights check is unchecked Then the "Google PageSpeed Insights" tab is visible in the "SITE SCOPE" section	Medium	NO
4. There will be a check: Enable Google Page Speed Insights. It will be checked by default. 4.1. There will be a help text: Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.	Given the Google PageSpeed Insights settings tab in the "SITE SCOPE" section Then there's a check: Enable Google PageSpeed Insights, it is checked by default.	Low	YES
	Given the Google PageSpeed Insights settings tab in the "SITE SCOPE" section Then there's a check: Enable Google PageSpeed Insights, there is a help text: Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.	Low	NO
4.2. When the check is disabled, the Page Audit icon won't be visible from the view mode of the pages (see LPS-119068) in all sites in all Instances.	Given the Google PageSpeed settings tab in the "SITE SCOPE" section When the Enable Google PageSpeed Insights check is unchecked Then the Page Audit icon won't be visible from the view mode of the pages (see LPS-119068) in all sites in all Instances.	Low (already tested)	NO
4.3. Even if the check is disabled, the "Google PageSpeed Insights" tab will be visible from the Site settings of any of the sites in the instance, and it will be unchecked for all those sites	Given the Google PageSpeed settings tab in the "SITE SCOPE" section When the Enable Google PageSpeed Insights check is unchecked Then the "Google PageSpeed Insights" tab is visible from the Site settings of any of the sites in the instance, and it is unchecked for all those sites	Medium	NO
5. There will be a Field to enter the API Key in the "SITE SCOPE" section	Given the Google PageSpeed Insights settings tab in the  "SITE SCOPE" section Then there's a field to enter the API Key with a help text: Get your API Key at https://developers.google.com/speed/docs/insights/v5/get-started	Low	NO
6. There will be a check for setting specific timeout: * Label: Timeout Interval.  * Help text (under the field): Define the time (in milliseconds) before a PageSpeed Insights request times out.  Default value: 30000 millisecs	Given the Google PageSpeed Insights settings tab in the Virtual Instance Scope section Then there's a field "Timeout Interval"  it shows 30000 ms as default value	Low
	Given the Google PageSpeed Insights settings tab in the Virtual Instance Scope section Then there's a field "Timeout Interval"  the help text says Define the time (in milliseconds) before a PageSpeed Insights request times out.	Low
7. There will be a field for specifying the "strategy" parameter for the API: Label: Preferred Strategy  Help text: Select what kind of device you want to audit for. Mobile strategy includes additional checks. Selected strategy will be applied to all page audits.  Dropdown to select Mobile or Desktop. It will be set as Mobile.	Given the Google PageSpeed Insights settings tab in the Site Scope section Then there's a field for specifying the Preferred Strategy, the dropdown shows Mobile and the Desktop value and both can be selected, but it is set as Mobile	Low	NO
	Given the Google PageSpeed Insights settings tab in the Site Scope section Then there's a field for specifying the Preferred Strategy, there's a help text: Select what kind of device you want to audit for. Mobile strategy includes additional checks. Selected strategy will be applied to all page audits.	Low	NO
NOTE.- If the field is kept void, then the default value (desktop) will apply.	Given the preferred strategy dropdown in the Site Scope section When the value is void ("Choose an option") Then the call is made for Google Page Speed default value - desktop	Medium	NO
NOTE.- Additional checks for mobile are: Small Tap Targets, Incorrect Aspect Ratios and Illegible font sizes.	Given the preferred strategy dropdown in the Site Scope section When the value is Mobile Then additional checks: Small Tap Targets, Incorrect Aspect Ratios and Illegible font sizes are retrieved	High	NO
	Given the preferred strategy dropdown in the Site Scope section When the value is Desktop Then additional checks: Small Tap Targets, Incorrect Aspect Ratios and Illegible font sizes are NOT retrieved	High	NO
All values in the Site Scope section are inherited by all sites	Given any value in the Site Scope section Then all sites shows the same value by default (also void fields)	Critical	NO
	Given any value in the Site Scope section When that value has been overwritten in any of the sites Then the value in the site prevails over any changes in the System Settings Site Scope section	Critical	NO