Postponed on #3051766: Deprecate and replace jQuery Joyride (for tours)

Problem/Motivation

Tour's API was changed in #3051766: Deprecate and replace jQuery Joyride (for tours), and a BC layer was added. That layer can be removed in Drupal 10. Specifics will be added after #3051766, and the codebase will have @todo items referencing this issue that should be addressed.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

Comments

bnjmnm created an issue. See original summary.

bnjmnm’s picture

Title: Remove shepard shim code from Tour » Remove Shepherd shim code from Tour
andypost’s picture

Status: Active » Needs review
StatusFileSize
new51.08 KB

Initial attempt to clean-up

andypost’s picture

StatusFileSize
new506 bytes
new51.08 KB

fix cs

Status: Needs review » Needs work

The last submitted patch, 5: 3195193-5.patch, failed testing. View results

paulocs’s picture

Assigned: Unassigned » paulocs
paulocs’s picture

Assigned: paulocs » Unassigned
Status: Needs work » Needs review
StatusFileSize
new57.64 KB

Lets see what tests bots will say.

Status: Needs review » Needs work

The last submitted patch, 8: 3195193-8.patch, failed testing. View results

paulocs’s picture

Assigned: Unassigned » paulocs

Let me see if I can fix the errors.

paulocs’s picture

Assigned: paulocs » Unassigned
Status: Needs work » Needs review
StatusFileSize
new57.55 KB
new3.95 KB

New patch.

quietone’s picture

StatusFileSize
new8.5 KB

Just adding diff between #5 and #8

quietone’s picture

+++ b/core/modules/block/config/optional/tour.tour.block-layout.yml
@@ -21,21 +21,21 @@ tips:
+    selector: '.button--small'

Is quoting all these strings necessary? AFAIK, YAML should handle that just fine.

paulocs’s picture

I did not do an investigation to check the motivation but there are some tests that fail when the quotes are not added. And the error complains only of those keys that don't have quotes.
For example the JsonApiUpdatePathTest or the MigrateDrupalUpdateTest that failed in patch #5.

longwave’s picture

+++ b/core/modules/tour/src/TourTipPluginInterface.php
@@ -9,9 +9,6 @@
- * @todo move all methods to TipPluginInterface and deprecate this interface in
- *   https://drupal.org/node/3195193

Not sure we can just remove this comment without doing the deprecation that it suggests?

catch’s picture

Status: Needs review » Needs work

@paulocs could you do a version of the patch without the quoting, just so we can see those test failures in isolation from the rest?

The removal of the @todo in #15 does seem unrelated to the rest of the changes since we're not actually changing anything in that class, although it's better to have an issue without a @todo than vice versa.

andregp’s picture

Status: Needs work » Needs review
StatusFileSize
new49.98 KB
new6.62 KB

Here is a patch without the quotes, expected to fail, as suggested by @cathc .

catch’s picture

Status: Needs review » Needs work
+++ b/core/modules/tour/src/TourTipPluginInterface.php
@@ -9,9 +9,6 @@
  * @see \Drupal\tour\TipPluginBase
  * @see \Drupal\tour\TipPluginManager
  * @see plugin_api
- *
- * @todo move all methods to TipPluginInterface and deprecate this interface in
- *   https://drupal.org/node/3195193
  */
 interface TourTipPluginInterface extends TipPluginInterface {
 

IMO we should go ahead and remove this hunk from the patch - the issue it points to is still open, but given this passes tests without the config changes, looks RTBC to me otherwise.

andregp’s picture

@catch I am a bit confused.
The last patch #17 already removes the comment below from TourTipPluginInterface

+++ b/core/modules/tour/src/TourTipPluginInterface.php
@@ -9,9 +9,6 @@
  * @see \Drupal\tour\TipPluginBase
  * @see \Drupal\tour\TipPluginManager
  * @see plugin_api
- *
- * @todo move all methods to TipPluginInterface and deprecate this interface in
- *   https://drupal.org/node/3195193
  */
 interface TourTipPluginInterface extends TipPluginInterface {

And when you said:

the issue it points to is still open

I think it points to itself. https://drupal.org/node/3195193 is this issue here.

catch’s picture

Hmm OK, I think it is me who's confused.

However this issue isn't deprecating or removing the method on TourTipPluginInterface so I think we should open a follow-up to do that.

andregp’s picture

Status: Needs work » Needs review
StatusFileSize
new49.95 KB
new521 bytes

So I created a follow-up for this issue and updated the link at TourTipPluginInterface.php to point to that issue.

Here is the follow-up #3276336: Move methods from TourTipPluginInterface and deprecate this interface. and the new patch.

andregp’s picture

catch’s picture

Status: Needs review » Reviewed & tested by the community

Thanks looks good now.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 21: 3195193-21.patch, failed testing. View results

catch’s picture

Status: Needs work » Reviewed & tested by the community

Random test failure. Restoring status.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 21: 3195193-21.patch, failed testing. View results

andregp’s picture

Status: Needs work » Reviewed & tested by the community

Another random test failure. Restoring status.

lauriii’s picture

+++ b/core/modules/tour/src/TourTipPluginInterface.php
@@ -11,7 +11,7 @@
+ *   https://drupal.org/i/3261249

Is this the correct issue? That issue was closed as a duplicate for this.

  • lauriii committed f9bb5b8 on 10.0.x
    Issue #3195193 by andregp, paulocs, andypost, quietone, catch: Remove...
lauriii’s picture

Status: Reviewed & tested by the community » Fixed

Updated on commit to reference #3276336: Move methods from TourTipPluginInterface and deprecate this interface..

Committed f9bb5b8 and pushed to 10.0.x. Thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.