Skip to content

Merge skipTour#31

Merged
laoneo merged 6 commits intojoomla-projects:mainfrom
muhme:merge-skipTour
Aug 7, 2024
Merged

Merge skipTour#31
laoneo merged 6 commits intojoomla-projects:mainfrom
muhme:merge-skipTour

Conversation

@muhme
Copy link
Contributor

@muhme muhme commented Aug 1, 2024

For joomla/joomla-cms#43814 there was the new Cypress custom command skipTour developed with #27 to hide forever the welcome tour in Joomla 5.2.

After discussions with @obuisard the functionality from skipTour is merged into already existing cancelTour to have only one command. In detail this commit contains:

  • Deleted the skipTour command to avoid having to differentiate between the use of the cancelTour command for Joomla 5.1 and skipTour for Joomla >= 5.2.
  • Merged the preferably used skip button into cancelTour.
  • Waiting for the start button to handle the problem to wait after page load that the overlay is opened by JavaScript.
  • Using preferably the skip tour button (>= 5.2), only this button doesn't exist, the cancel button (Joomla 5.1) is used.
  • Deleted the 40 seconds timout as cancelTour follows doAdministratorLogin, which ensures page is loaded in checking '<h1>Home Dashboard'. Default 4 secs should be more than enough to open the JavaScript overlay.
  • Updated README.md including screenshot image

Tests

  • Tested with console.log extended version of joomla.js to check which button is clicked and to measure how long the command runs
  • Always based on git clone
  • Intel macOS 14.5 Sonoma
    • Native Apache MySql, Joomla 5.2-dev, gh pr checkout 43814 && composer install && npm ci && changed skipTour to cancelTour in tests/System/integration/install/Installation.cy.js
      • ✅ skip button, 0.5ms
    • Docker based 5.1, only node_modules/joomla-cypress/src/joomla.js with new cancelTour command
      • ✅ cancel button, 1.1ms
    • Docker based 5.2
      • cloned && gh pr checkout 43814 && composer install && npm ci && node_modules/joomla-cypress/src/joomla.js with new cancelTour command && changed skipTour to cancelTour in tests/System/integration/install/Installation.cy.js
      • ✅ skip button, 1.5ms
  • Windows 11 Pro, entry level Intel N95 CPU & Laragon
    • 5.1 only node_modules/joomla-cypress/src/joomla.js with new cancelTour command
      • ✅ cancel button, 1.5ms
    • 5.2 cloned && gh pr checkout 43814 && composer install && npm ci && node_modules/joomla-cypress/src/joomla.js with new cancelTour command && change skipTour to cancelTour in tests/System/integration/install/Installation.cy.js
      • ✅ skip button, 1.5ms

muhme added 6 commits June 19, 2024 09:58
- Deleted the skipTour command to avoid having to differentiate between
  the use of the cancelTour command for Joomla 5.1 and skipTour for Joomla >= 5.2.
- Merged the preferably used skip button into cancelTour.
- Waiting for the start button to handle the problem to wait after page
  load that the overlay is opened by JavaScript.
- Using preferably the skip tour button (>= 5.2), only this button doesn't
  exist, the cancel button (Joomla 5.1) is used.
- Deleted the 40 seconds timout as cancelTour follows doAdministratorLogin,
  which ensures page is loaded in checking '<h1>Home Dashboard'.
  Default 4 secs should be more than enough to open the JavaScript overlay.
- Updated README.md including screenshot image
@laoneo
Copy link
Contributor

laoneo commented Aug 6, 2024

I would remove the screenshot as when Joomla changes the layout, pretty sure we will forget to update it here.

@muhme
Copy link
Contributor Author

muhme commented Aug 6, 2024

I would vote in favour of leaving the screenshot as it is:

  • Speaking about "cancel X-button ... and an additional button Hide Forever" is easier to understand when the picture is on the right
  • The documentation is very text-heavy and a picture relaxes it
  • The screenshot shows the X and Hide Forever buttons, if they change, the implementation probably changes as well and in my opinion any code change needs to be checked what needs to be updated in the documentation

However, if you make simple 👎 I will remove it

@laoneo laoneo merged commit 129b373 into joomla-projects:main Aug 7, 2024
@laoneo
Copy link
Contributor

laoneo commented Aug 7, 2024

Ok, we leave it :-)

@muhme muhme deleted the merge-skipTour branch August 7, 2024 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants