Uploaded image for project: 'PUBLIC - Liferay Portal Community Edition'
  1. PUBLIC - Liferay Portal Community Edition
  2. LPS-125851

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

    Details

      Description

      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) 

      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. Default value: 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

      • 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  
      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  
      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  
       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  
      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  
       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  
       
      • 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  
      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)  
      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  
      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  
      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  
       
      • 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  
       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)  
       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  
       5. There will be a Field to enter the API Key in the "SITE SCOPE" section Low  
       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. Default value: 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 (default) and the Desktop value and both can be selected
      Low  
       
      • 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  
      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  
       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  
       
      • 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  
      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  
       
      • 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  

       

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              carlos.brichete Carlos Brichete Báez
              Reporter:
              julia.molano Julia Molano
              Engineering Assignee:
              Alejandro Tardín
              Recent user:
              Rubén Heras
              Participants of an Issue:
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:

                  Packages

                  Version Package
                  Master