Allow testing tags in non-production environments

[aaemnnosttv]

Feature Description

In #2054, we added a guard to prevent module tags from being placed in non-production environments to tracking page views, displaying ads, etc in such environments. There are however cases where it makes sense for a developer to want these tags to be rendered in a local/development/staging environment in order to test integration with them (e.g. custom Analytics events).

With this in mind, we should allow for a developer to disable/bypass the environment type guard for tags.

---

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• The Tag_Production_Guard tag guard should be replaced with a new Tag_Environment_Type_Guard which works similar to the current production guard, but allows for flexibility in the environments it disables tags for
• Like today, if the wp_get_environment_type function does not exist, it should continue to return true
• A new filter should be invoked to allow filtering the allowed environment types:
  • googlesitekit_allowed_tag_environment_types which filters an array of valid environment types which should initially be only production as today
• The can_activate method should return true if the current environment type is in the filtered array
• The Tag_Production_Guard class should be removed and its usage replaced with the new Tag_Environment_Type_Guard

Implementation Brief

• Copy the Tag_Production_Guard class to a new class named Tag_Environment_Type_Guard. It should implement the same Guard_Interface.
• Within the can_activate() method, use apply_filters() with the hook name to be googlesitekit_allowed_tag_environment_types. Pass an array with the value production as the value to filter.
• Implement the remaining points within the AC which provide enough detail.

Test Coverage

• Rework the existing tests within Tag_Production_GuardTest to test the newly created filter.

QA Brief

• There is nothing specific to be tested for these changes. However, we must ensure that all the tags are added while setting up the modules in the production environment.

QA:Eng

• Add the following filter and ensure the tags are being added while setting up the modules in the development environment.

add_filter(
	'googlesitekit_allowed_tag_environment_types',
	function ( $allowed_environments ) {
		$allowed_environments[] = 'development';
		return $allowed_environments;
	}
);

Changelog entry

• Update tag placement functionality to allow using tags in non-production environments.

[aaemnnosttv]

cc: @felixarntz

[eugene-manuilov]

IB ✔️

[mohitwp]

QA Update ⚠️

@hussain-t @aaemnnosttv

Can you please provide more information in QAB. Like,where I can find these tags and are you referring to GA tags ?

[hussain-t]

@mohitwp, yes, you have to verify whether the GA and GTM tags are added as how it works today.

[mohitwp]

QA update ✅

Verified:

• Verified GA, GTM and AdSense tags.
• Compared the latest release and dev branch.
• On dev branches, tags are added same as latest release branch.

Note : Added QA:Eng label as mentioned in QAB.

[jimmymadon]

QA: Eng ✅

• Set the WP_ENVIRONMENT_TYPE to 'development'. Verified that no tag snippets (other than AdSense meta tag snippet which is not using the Tag_Environment_Type_Guard) are added to the site.

• Added the filter as per the QAB to Plugin.php's register() method. Verified that Analytics, GTM and AdSense snippets are inserted.