← All changes | core/experiments/manager.php +108 -12 4.3.0 → trunk View file →

		@@ -89,8 +89,10 @@
89	89	}
90	90
91	91	$this->features[ $options['name'] ] = $experimental_data;
92	92
	93	+ $this->resolve_registered_dependants( $options['name'], $experimental_data );
	94	+
93	95	if ( $experimental_data['mutable'] && is_admin() ) {
94	96	$feature_option_key = $this->get_feature_option_key( $options['name'] );
95	97
96	98	$on_state_change_callback = function( $old_state, $new_state ) use ( $experimental_data, $feature_option_key ) {
		@@ -249,9 +251,11 @@
249	251	*
250	252	* @since 3.1.0
251	253	* @access public
252	254	*
253		- * @param string $feature_name
	255	+ * @param string $feature_name Experiment feature name.
	256	+ * @param bool $check_dependencies When true, also require dependency experiments to be active.
	257	+ * Missing dependencies always fail closed. Hidden dependencies are treated as satisfied.
254	258	*
255	259	* @return bool
256	260	*/
257	261	public function is_feature_active( $feature_name, $check_dependencies = false ) {
		@@ -260,11 +264,36 @@
260	264	if ( ! $feature || self::STATE_ACTIVE !== $this->get_feature_actual_state( $feature ) ) {
261	265	return false;
262	266	}
263	267
264		- if ( $check_dependencies && isset( $feature['dependencies'] ) && is_array( $feature['dependencies'] ) ) {
	268	+ if ( isset( $feature['dependencies'] ) && is_array( $feature['dependencies'] ) ) {
265	269	foreach ( $feature['dependencies'] as $dependency ) {
266	270	$dependent_feature = $this->get_features( $dependency->get_name() );
	271	+
	272	+ // A dependency that Core still does not ship can never be verified as active.
	273	+ // Non existing dependencies are re-resolved first to cover later registrations.
	274	+ if ( $dependency instanceof Non_Existing_Dependency && ! $dependent_feature ) {
	275	+ return false;
	276	+ }
	277	+
	278	+ if ( ! $dependent_feature ) {
	279	+ // A Core experiment dependency that no longer resolves fails closed.
	280	+ // Class dependencies are not experiment names and stay exempt.
	281	+ if ( $dependency instanceof Wrap_Core_Dependency ) {
	282	+ return false;
	283	+ }
	284	+
	285	+ continue;
	286	+ }
	287	+
	288	+ if ( ! $check_dependencies ) {
	289	+ continue;
	290	+ }
	291	+
	292	+ if ( ! empty( $dependent_feature[ static::TYPE_HIDDEN ] ) ) {
	293	+ continue;
	294	+ }
	295	+
267	296	$feature_state = self::STATE_ACTIVE === $this->get_feature_actual_state( $dependent_feature );
268	297
269	298	if ( ! $feature_state ) {
270	299	return false;
		@@ -779,20 +808,41 @@
779	808	}
780	809
781	810	// Validate if the current feature dependency is available.
782	811	foreach ( $feature['dependencies'] as $dependency ) {
	812	+ if ( $dependency instanceof Non_Existing_Dependency ) {
	813	+ $this->warn_removed_or_hidden_dependency(
	814	+ sprintf(
	815	+ 'The feature `%s` has a dependency `%s` that is not available in Core.',
	816	+ esc_html( $feature['name'] ),
	817	+ esc_html( $dependency->get_name() )
	818	+ )
	819	+ );
	820	+ continue;
	821	+ }
	822	+
783	823	$dependency_feature = $this->get_features( $dependency->get_name() );
784	824
785	825	if ( ! $dependency_feature ) {
786		- $rollback( $feature_option_key, self::STATE_INACTIVE );
	826	+ $this->warn_removed_or_hidden_dependency(
	827	+ sprintf(
	828	+ 'The feature `%s` has a dependency `%s` that is not available in Core.',
	829	+ esc_html( $feature['name'] ),
	830	+ esc_html( $dependency->get_name() )
	831	+ )
	832	+ );
	833	+ continue;
	834	+ }
787	835
788		- throw new Exceptions\Dependency_Exception(
	836	+ if ( $this->is_removed_or_hidden_dependency( $dependency_feature ) ) {
	837	+ $this->warn_removed_or_hidden_dependency(
789	838	sprintf(
790		- 'The feature `%s` has a dependency `%s` that is not available.',
	839	+ 'The feature `%1$s` depends on hidden experiment `%2$s`.',
791	840	esc_html( $feature['name'] ),
792		- esc_html( $dependency->get_name() )
	841	+ esc_html( $dependency_feature['name'] )
793	842	)
794	843	);
	844	+ continue;
795	845	}
796	846
797	847	$dependency_state = $this->get_feature_actual_state( $dependency_feature );
798	848
		@@ -945,10 +995,8 @@
945	995
946	996	/**
947	997	* @param array $experimental_data
948	998	* @return array
949		- *
950		- * @throws Exceptions\Dependency_Exception If the feature dependency is not initialized or depends on a hidden experiment.
951	999	*/
952	1000	private function initialize_feature_dependencies( array $experimental_data ): array {
953	1001	foreach ( $experimental_data['dependencies'] as $key => $dependency ) {
954	1002	$feature = $this->get_features( $dependency );
		@@ -953,20 +1001,28 @@
953	1001	foreach ( $experimental_data['dependencies'] as $key => $dependency ) {
954	1002	$feature = $this->get_features( $dependency );
955	1003
956	1004	if ( ! isset( $feature ) ) {
957		- // since we must validate the state of each dependency, we have to make sure that dependencies are initialized in the correct order, otherwise, error.
958		- throw new Exceptions\Dependency_Exception(
	1005	+ $this->warn_removed_or_hidden_dependency(
959	1006	sprintf(
960		- 'Feature %s cannot be initialized before dependency feature: %s.',
	1007	+ 'Feature %1$s depends on experiment %2$s that is not registered in Core.',
961	1008	esc_html( $experimental_data['name'] ),
962	1009	esc_html( $dependency )
963	1010	)
964	1011	);
	1012	+
	1013	+ $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, null );
	1014	+ continue;
965	1015	}
966	1016
967	1017	if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) {
968		- throw new Exceptions\Dependency_Exception( 'Depending on a hidden experiment is not allowed.' );
	1018	+ $this->warn_removed_or_hidden_dependency(
	1019	+ sprintf(
	1020	+ 'Feature %1$s depends on hidden experiment %2$s.',
	1021	+ esc_html( $experimental_data['name'] ),
	1022	+ esc_html( $dependency )
	1023	+ )
	1024	+ );
969	1025	}
970	1026
971	1027	$experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature );
972	1028	$experimental_data = $this->set_feature_default_state_to_match_dependencies( $feature, $experimental_data );
		@@ -972,8 +1028,48 @@
972	1028	$experimental_data = $this->set_feature_default_state_to_match_dependencies( $feature, $experimental_data );
973	1029	}
974	1030
975	1031	return $experimental_data;
	1032	+ }
	1033	+
	1034	+ private function is_removed_or_hidden_dependency( $dependency_feature ): bool {
	1035	+ if ( ! $dependency_feature ) {
	1036	+ return true;
	1037	+ }
	1038	+
	1039	+ return ! empty( $dependency_feature[ static::TYPE_HIDDEN ] );
	1040	+ }
	1041	+
	1042	+ /**
	1043	+ * Re-resolve non existing dependency placeholders of dependants that were
	1044	+ * registered before this feature existed.
	1045	+ *
	1046	+ * @param string $feature_name Newly registered feature name.
	1047	+ * @param array $feature_data Newly registered feature data.
	1048	+ */
	1049	+ private function resolve_registered_dependants( string $feature_name, array $feature_data ): void {
	1050	+ foreach ( $this->features as $name => $registered_feature ) {
	1051	+ if ( $name === $feature_name || empty( $registered_feature['dependencies'] ) || ! is_array( $registered_feature['dependencies'] ) ) {
	1052	+ continue;
	1053	+ }
	1054	+
	1055	+ foreach ( $registered_feature['dependencies'] as $key => $dependency ) {
	1056	+ if ( ! ( $dependency instanceof Non_Existing_Dependency ) || $dependency->get_name() !== $feature_name ) {
	1057	+ continue;
	1058	+ }
	1059	+
	1060	+ $this->features[ $name ]['dependencies'][ $key ] = $this->create_dependency_class( $feature_name, $feature_data );
	1061	+ }
	1062	+ }
	1063	+ }
	1064	+
	1065	+ private function warn_removed_or_hidden_dependency( string $message ): void {
	1066	+ if ( ! defined( 'WP_DEBUG' ) || ! WP_DEBUG ) {
	1067	+ return;
	1068	+ }
	1069	+
	1070	+ // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Developer notice; message is escaped.
	1071	+ _doing_it_wrong( __METHOD__, esc_html( $message ), ELEMENTOR_VERSION );
976	1072	}
977	1073
978	1074	/**
979	1075	* @param array $feature