Block Editor Tracking: Track convert to template part and detach blocks from template part actions #53592

david-szabo97 · 2021-06-10T13:15:23Z

Changes proposed in this Pull Request

Track "Template Part" Block -> Toolbar more menu -> "Detach blocks from template part" action
Track any block -> Toolbar more menu -> "Make template part" action
Make sure replaceBlocks isn't tracked after "Make template part"

NOTE: The #53598 PR is a prerequisite for this PR.

We are firing both events twice. One with block_names property and one without it. We do this to ensure the event is tracked all the time. The event fired with block_names property will fail if there are way too many blocks involved. URL length of the request becomes too long and the browser fails to deliver it.

Testing instructions

Follow steps to enable tracking debugging at PCYsg-nrf-p2
Open Site Editor
Select a Paragraph block
Click on 3 dots (Options) in the toolbar menu
Click on "Make Template Part"
Confirm wpcom_block_editor_convert_to_template_part event is fired twice. One without block_names and one with block_names property.
Confirm replaceBlocks is triggered, but no events are tracked
Select the template part you just created
Click on 3 dots (Options) in the toolbar menu
Click on "Detach blocks from template part"
Confim wpcom_block_editor_template_part_detach_blocks event is fired twice. One without block_names and one with block_names property.
Confirm replaceBlocks is triggered, but no events are tracked (subscriber system utilized here)

Related to #53410

matticbot · 2021-06-10T13:16:19Z

This PR does not affect the size of JS and CSS bundles shipped to the user's browser.

Generated by performance advisor bot at iscalypsofastyet.com.

matticbot · 2021-06-10T17:25:40Z

Link to Calypso live: https://calypso.live?image=registry.a8c.com/calypso/app:build-9874
Link to Jetpack Cloud live: https://calypso.live?image=registry.a8c.com/calypso/app:build-9874&env=jetpack

Addison-Stavlo

This is working great in testing.

I wonder if we should add any extra properties to this event. 🤔

variation_slug probably makes sense to determine if they are creating/detaching a header, footer, or other in this way.
Im not sure if any information about the blocks being converted or detached might make sense here. Number of blocks? a flattened list of block names? Im not certain but maybe @kurt213 and/or @ianstewart have ideas here?

Addison-Stavlo · 2021-06-11T14:48:05Z

apps/wpcom-block-editor/src/wpcom/features/tracking.js

+
+	registerDelegateEventSubscriber(
+		'wpcom-block-editor-template-part-detach-blocks',
+		'before',


Noting it seems that for this case it doesn't really matter if this is 'before' or 'after', although it seems good to have this flexibility in general! 🎉 Its great that we can add extra handlers when we want, and of course the big thing here is being able to track on capture as well!

ianstewart · 2021-06-14T21:08:56Z

a flattened list of block names?

I could see this being useful in the future for design purposes if it could be pulled with a data request. Could be used to design better patterns.

kurt213 · 2021-06-18T15:05:39Z

variation_slug

👍 . I'm not too familiar with all the possible variations for this, but this level of detail would be helpful.

a flattened list of block names?

👍 This would be helpful. It wouldn't be something that can easily be analysed in something like Tracks, but as @ianstewart mentioned, a data request, custom SQL query or a transformation pipeline into Looker could make use of this level of granularity.

Addison-Stavlo · 2021-06-18T16:58:38Z

I'm not too familiar with all the possible variations for this, but this level of detail would be helpful.

Basically just "header", "footer", or "general" at this point in time.

david-szabo97 · 2021-06-18T18:12:12Z

a flattened list of block names?

👍 This would be helpful. It wouldn't be something that can easily be analysed in something like Tracks, but as @ianstewart mentioned, a data request, custom SQL query or a transformation pipeline into Looker could make use of this level of granularity.

@kurt213 AFAIK, arrays aren't supported by Tracks. Should join the list of block names using comma (comma separated list) or turn it into a JSON?

matticbot · 2021-06-18T18:15:09Z

This PR modifies the release build for wpcom-block-editor

To test your changes on WordPress.com, run install-plugin.sh wpcom-block-editor add/track-template-part-convert-detach-blocks on your sandbox.

To deploy your changes after merging, see the documentation: PCYsg-l4k-p2

matticbot · 2021-07-05T14:39:00Z

This PR modifies the release build for notifications

To test your changes on WordPress.com, run install-plugin.sh notifications add/track-template-part-convert-detach-blocks on your sandbox.

To deploy your changes after merging, see the documentation: PCYsg-elI-p2

matticbot · 2021-07-05T14:39:26Z

This PR modifies the release build for editing-toolkit

To test your changes on WordPress.com, run install-plugin.sh editing-toolkit add/track-template-part-convert-detach-blocks on your sandbox.

To deploy your changes after merging, see the documentation: PCYsg-mMA-p2

Addison-Stavlo

This is working well! I think we will needs some tests here or in a follow up?

Addison-Stavlo · 2021-07-06T15:05:38Z

apps/wpcom-block-editor/src/wpcom/features/tracking.js

+		// We fire the event with and without the block names. We do this to
+		// make sure the event is tracked all the time. The block names
+		// might become a string that's too long and as a result it will
+		// fail because of URL length browser limitations.
+		tracksRecordEvent( 'wpcom_block_editor_convert_to_template_part', {
+			variation_slug: record.area,
+		} );
 		tracksRecordEvent( 'wpcom_block_editor_convert_to_template_part', {
 			variation_slug: record.area,
+			block_names: getFlattenedBlockNames( convertedParentBlocks ).join( ',' ),


Im not in love with the idea of sending two events... but given the slack discussions that seems like it makes sense for now!

Yeah... sending two events is a bit gross. But I'm not sure how we could limit the length of the block_names property. Since the URL length will vary based on other properties too.

...m-block-editor/src/wpcom/features/tracking/wpcom-block-editor-template-part-detach-blocks.js

apps/wpcom-block-editor/src/wpcom/features/utils.js

Addison-Stavlo

Functionality and tests work great!

a8ci18n · 2021-07-08T14:16:31Z

This Pull Request is now available for translation here: https://translate.wordpress.com/deliverables/6157542

Thank you @david-szabo97 for including a screenshot in the description! This is really helpful for our translators.

Addison-Stavlo · 2021-07-09T15:47:38Z

apps/wpcom-block-editor/src/wpcom/features/tracking.js

+		() => {
+			ignoreNextReplaceBlocksAction = true;
+		}
+	);


It seems this is bleeding into other events that may be triggered by the same selector, as we did not check the conditions here as we did for firing the event.

#54415 should fix

a8ci18n · 2021-07-15T11:28:30Z

Translation for this Pull Request has now been finished.

david-szabo97 self-assigned this Jun 10, 2021

david-szabo97 force-pushed the add/track-template-part-convert-detach-blocks branch from 9f50a6d to 2bcf92f Compare June 10, 2021 17:22

david-szabo97 changed the base branch from trunk to add/tracking-delegate-event-tracking-subscribers June 10, 2021 17:23

david-szabo97 mentioned this pull request Jun 10, 2021

Block Editor Tracking: Add event subscribers system and add capture event listener #53598

Merged

david-szabo97 marked this pull request as ready for review June 10, 2021 17:35

david-szabo97 requested a review from Addison-Stavlo June 10, 2021 17:36

matticbot added the [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. label Jun 10, 2021

david-szabo97 force-pushed the add/track-template-part-convert-detach-blocks branch from bfcb32f to b8b5d4a Compare June 10, 2021 18:49

Addison-Stavlo mentioned this pull request Jun 10, 2021

Full Site Editing: Stats (Tracking Issue) #53410

Closed

24 tasks

Addison-Stavlo reviewed Jun 11, 2021

View reviewed changes

david-szabo97 requested review from kurt213 and ianstewart June 11, 2021 13:47

Addison-Stavlo reviewed Jun 11, 2021

View reviewed changes

david-szabo97 force-pushed the add/track-template-part-convert-detach-blocks branch from b8b5d4a to ec5c8b2 Compare June 14, 2021 08:45

david-szabo97 requested a review from Copons June 16, 2021 11:27

david-szabo97 force-pushed the add/tracking-delegate-event-tracking-subscribers branch from 6d9ca0a to 6165158 Compare June 16, 2021 12:21

Base automatically changed from add/tracking-delegate-event-tracking-subscribers to trunk June 16, 2021 13:57

kurt213 mentioned this pull request Jun 18, 2021

Site Editor Tracking - Add events for convert/detach template part. #53519

Open

david-szabo97 force-pushed the add/track-template-part-convert-detach-blocks branch from ec5c8b2 to 340b641 Compare June 18, 2021 18:07

Addison-Stavlo mentioned this pull request Jun 28, 2021

Site Editor Tracking - Template Part creation / replacement flows. #54093

Merged

david-szabo97 force-pushed the add/track-template-part-convert-detach-blocks branch from 30364fc to 0123066 Compare July 5, 2021 14:47

david-szabo97 requested a review from Addison-Stavlo July 6, 2021 10:49

Addison-Stavlo reviewed Jul 6, 2021

View reviewed changes

david-szabo97 requested review from scinos, WunderBart and a team as code owners July 6, 2021 16:30

david-szabo97 force-pushed the add/track-template-part-convert-detach-blocks branch from 21e71a2 to 79c9033 Compare July 7, 2021 07:35

Addison-Stavlo reviewed Jul 7, 2021

View reviewed changes

...m-block-editor/src/wpcom/features/tracking/wpcom-block-editor-template-part-detach-blocks.js Outdated Show resolved Hide resolved

apps/wpcom-block-editor/src/wpcom/features/utils.js Outdated Show resolved Hide resolved

david-szabo97 added 13 commits July 8, 2021 12:29

Track template part detach blocks

a4121b6

Track convert to template part

92610ef

Remove detach tracking

e575a97

Track template part detach blocks

16a7580

Change to capture

d2c4f82

Add variation_slug event property

03b2ba2

Add block_names property

e22838c

Add tests

d7b0190

Extract locators and fix mobile

998e60d

Assert block replace events

97175bb

Fix block names order

dcf9744

Add template_part_id property

e33204c

Assert must have properties

1b869c6

david-szabo97 force-pushed the add/track-template-part-convert-detach-blocks branch from f05363f to 1b869c6 Compare July 8, 2021 10:30

Merge trackSaveEntityRecord functions

d9320f2

Addison-Stavlo approved these changes Jul 8, 2021

View reviewed changes

david-szabo97 merged commit 8fc73cf into trunk Jul 8, 2021

david-szabo97 deleted the add/track-template-part-convert-detach-blocks branch July 8, 2021 13:29

github-actions bot removed the [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. label Jul 8, 2021

Addison-Stavlo mentioned this pull request Jul 9, 2021

editor tracks - fix replace blocks flow not triggering insert event #54415

Merged

Addison-Stavlo reviewed Jul 9, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Block Editor Tracking: Track convert to template part and detach blocks from template part actions #53592

Block Editor Tracking: Track convert to template part and detach blocks from template part actions #53592

david-szabo97 commented Jun 10, 2021 •

edited by Addison-Stavlo

Loading

matticbot commented Jun 10, 2021

matticbot commented Jun 10, 2021 •

edited

Loading

Addison-Stavlo left a comment

Addison-Stavlo Jun 11, 2021

ianstewart commented Jun 14, 2021

kurt213 commented Jun 18, 2021

Addison-Stavlo commented Jun 18, 2021

david-szabo97 commented Jun 18, 2021

matticbot commented Jun 18, 2021

matticbot commented Jul 5, 2021

matticbot commented Jul 5, 2021

Addison-Stavlo left a comment

Addison-Stavlo Jul 6, 2021

david-szabo97 Jul 6, 2021

Addison-Stavlo left a comment

a8ci18n commented Jul 8, 2021 •

edited

Loading

Addison-Stavlo Jul 9, 2021 •

edited

Loading

a8ci18n commented Jul 15, 2021

Block Editor Tracking: Track convert to template part and detach blocks from template part actions #53592

Block Editor Tracking: Track convert to template part and detach blocks from template part actions #53592

Conversation

david-szabo97 commented Jun 10, 2021 • edited by Addison-Stavlo Loading

Changes proposed in this Pull Request

Testing instructions

matticbot commented Jun 10, 2021

matticbot commented Jun 10, 2021 • edited Loading

Addison-Stavlo left a comment

Choose a reason for hiding this comment

Addison-Stavlo Jun 11, 2021

Choose a reason for hiding this comment

ianstewart commented Jun 14, 2021

kurt213 commented Jun 18, 2021

Addison-Stavlo commented Jun 18, 2021

david-szabo97 commented Jun 18, 2021

matticbot commented Jun 18, 2021

matticbot commented Jul 5, 2021

matticbot commented Jul 5, 2021

Addison-Stavlo left a comment

Choose a reason for hiding this comment

Addison-Stavlo Jul 6, 2021

Choose a reason for hiding this comment

david-szabo97 Jul 6, 2021

Choose a reason for hiding this comment

Addison-Stavlo left a comment

Choose a reason for hiding this comment

a8ci18n commented Jul 8, 2021 • edited Loading

Addison-Stavlo Jul 9, 2021 • edited Loading

Choose a reason for hiding this comment

a8ci18n commented Jul 15, 2021

david-szabo97 commented Jun 10, 2021 •

edited by Addison-Stavlo

Loading

matticbot commented Jun 10, 2021 •

edited

Loading

a8ci18n commented Jul 8, 2021 •

edited

Loading

Addison-Stavlo Jul 9, 2021 •

edited

Loading