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

As an instance admin, I want to configure PageSpeed from Instance Settings

    Details

      Description

      Motivation

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

      Design

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

      Technical Requirements

      VIRTUAL INSTANCE SCOPE SECTION

      1. Configuration panel will be in: Instance Settings > Pages > New tab "Google PageSpeed Insights" 

      NOTE: Provided that the option is enabled from System Settings

      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.

      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 in that Instance.

      2.3. When the check is disabled, the "Google PageSpeed Insights" tab won't be visible in the " SITE SCOPE" section > bug opened for this requirement: LPS-135167

      2.4. When the check is disabled, the "Google PageSpeed Insights" tab won't be visible from the Site settings of any of the sites in the instance

      3. Field to enter the API Key (format: AIzaSyAq-oKsvIhlYHdk1UXCFy63h74ECIgbgbE) 

      4. 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

      5. 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

      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 subtitle / 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 that Instance.

      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 and set as default in all sites under the instance

      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 Ratios and Illegible font sizes.

      • 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.
      • Instance settings values overwrite System values for that 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: Instance Settings > Pages > New tab "Google PageSpeed Insights" 
      • Given the Instance settings page
      • When the users click on Content > Pages
      • Then they can see the tab Google PageSpeed Insights 
      Low   NO
      2. There will be a check: Enable Google Page Speed Insights. It will be checked by default.
      2.3. 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, and 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, and the Virtual Instance Scope section
      • Then 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) of any of the sites in the 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) of any of the sites in the instance
      Medium  NO 
       2.3. When the check is disabled, the "Google PageSpeed Insights" tab won't be visible in 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 won't be visible in the " SITE SCOPE" section
      Medium   NO
      2.4. When the check is disabled, the "Google PageSpeed Insights" tab won't be visible from the Site settings of any of the sites in the 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 won't be visible from the Site settings of any of the sites in the instance
      Medium   NO
      4. There will be a check in the Site Scope section: Enable Google Page Speed Insights. It will be checked by default.
      4.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 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 is a help text: Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them
      Low  YES
       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 any of the sites in that Instance.
      • 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 any of the sites in that Instance. 
      Low 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: Low   NO
      4. 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" to enter a specific value for timeout, it shows 30000 millisecs as default value and the help text says Define the time (in milliseconds) before a PageSpeed Insights request times out. 
          NO
       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 by default, the Desktop value can also be selected and 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
      All values in the Instance Settings Site scope section are inherited by all sites in the instance
      • Given any value in the Instance settings Site scope section
      • Then all sites shows the same value (also void fields)
      Critical   NO
       
      • Given any value in the Instance settings Site scope section
      • When the same value has been overwritten in any of the sites
      • Then the value in the site prevails over any changes in the Instance settings 
      Critical   NO
      The Instance level settings will be visible provided that the option is enabled from System Settings
      • Given the PageSpeed Insights settings in the System Settings
      • When Google PageSpeed Insights is not enabled (unchecked)
      • Then the tab Google PageSpeed Insights is not visible from Instance settings
      High  NO 

       

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              carlos.brichete Carlos Brichete Báez
              Reporter:
              julia.molano Julia Molano
              Engineering Assignee:
              Julia Molano
              Recent user:
              Luiz Queiroz
              Participants of an Issue:
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Packages

                  Version Package
                  7.4.2 CE GA3 DXP 7,4
                  Master