AI Assistant: Add FeatureControl to Write Brief (#39168)

* add features control to ai-assistant-feature endpoint * check for write brief feature control * fix FeatureControl type * apply feature control checks * changelog * fix type * change default to enabled Committed via a GitHub action: https://github.com/Automattic/jetpack/actions/runs/10639104311 Upstream-Ref: Automattic/jetpack@77b23eb
Automattic · Aug 30, 2024 · 7c19fbb · 7c19fbb
1 parent b23ca1a
commit 7c19fbb
Show file tree

Hide file tree

Showing 19 changed files with 119 additions and 70 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,7 @@ This is an alpha version! The changes listed here are not final.
 - Add retry event for Brief
 - AI Assistant: Add A8c dictionary
 - AI Assistant: add AI Guidelines link to the AI Assistant sidebar panel
+- AI Assistant: Add FeatureControl to Write Brief
 - AI Assistant: Add option to add word to spelling dictionary
 - AI Assistant: Do not mark words starting with special characters as spelling mistakes
 - AI Assistant: Fix flickering when adding word to Breve dictionary

diff --git a/_inc/blocks/editor-beta.asset.php b/_inc/blocks/editor-beta.asset.php
@@ -1 +1 @@
-<?php return array('dependencies' => array('jetpack-script-data', 'lodash', 'moment', 'react', 'react-dom', 'react-jsx-runtime', 'wp-a11y', 'wp-api-fetch', 'wp-blob', 'wp-block-editor', 'wp-block-serialization-default-parser', 'wp-blocks', 'wp-commands', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-date', 'wp-dom-ready', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-escape-html', 'wp-hooks', 'wp-html-entities', 'wp-i18n', 'wp-keycodes', 'wp-media-utils', 'wp-notices', 'wp-plugins', 'wp-polyfill', 'wp-primitives', 'wp-rich-text', 'wp-token-list', 'wp-url', 'wp-viewport', 'wp-widgets', 'wp-wordcount'), 'version' => '085a56f80b46ffafb632');
+<?php return array('dependencies' => array('jetpack-script-data', 'lodash', 'moment', 'react', 'react-dom', 'react-jsx-runtime', 'wp-a11y', 'wp-api-fetch', 'wp-blob', 'wp-block-editor', 'wp-block-serialization-default-parser', 'wp-blocks', 'wp-commands', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-date', 'wp-dom-ready', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-escape-html', 'wp-hooks', 'wp-html-entities', 'wp-i18n', 'wp-keycodes', 'wp-media-utils', 'wp-notices', 'wp-plugins', 'wp-polyfill', 'wp-primitives', 'wp-rich-text', 'wp-token-list', 'wp-url', 'wp-viewport', 'wp-widgets', 'wp-wordcount'), 'version' => '980be369b3a62d973a9c');
diff --git a/_inc/blocks/editor-beta.js b/_inc/blocks/editor-beta.js
diff --git a/_inc/blocks/editor-experimental.asset.php b/_inc/blocks/editor-experimental.asset.php
@@ -1 +1 @@
-<?php return array('dependencies' => array('jetpack-script-data', 'lodash', 'moment', 'react', 'react-dom', 'react-jsx-runtime', 'wp-a11y', 'wp-api-fetch', 'wp-blob', 'wp-block-editor', 'wp-block-serialization-default-parser', 'wp-blocks', 'wp-commands', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-date', 'wp-dom-ready', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-escape-html', 'wp-hooks', 'wp-html-entities', 'wp-i18n', 'wp-keycodes', 'wp-media-utils', 'wp-notices', 'wp-plugins', 'wp-polyfill', 'wp-primitives', 'wp-rich-text', 'wp-token-list', 'wp-url', 'wp-viewport', 'wp-widgets', 'wp-wordcount'), 'version' => 'a303f3034c09a20f7b0e');
+<?php return array('dependencies' => array('jetpack-script-data', 'lodash', 'moment', 'react', 'react-dom', 'react-jsx-runtime', 'wp-a11y', 'wp-api-fetch', 'wp-blob', 'wp-block-editor', 'wp-block-serialization-default-parser', 'wp-blocks', 'wp-commands', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-date', 'wp-dom-ready', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-escape-html', 'wp-hooks', 'wp-html-entities', 'wp-i18n', 'wp-keycodes', 'wp-media-utils', 'wp-notices', 'wp-plugins', 'wp-polyfill', 'wp-primitives', 'wp-rich-text', 'wp-token-list', 'wp-url', 'wp-viewport', 'wp-widgets', 'wp-wordcount'), 'version' => '05c94fb5ccf9e1ab359f');
diff --git a/_inc/blocks/editor-experimental.js b/_inc/blocks/editor-experimental.js
diff --git a/_inc/blocks/editor-no-post-editor.asset.php b/_inc/blocks/editor-no-post-editor.asset.php
@@ -1 +1 @@
-<?php return array('dependencies' => array('jetpack-script-data', 'lodash', 'moment', 'react', 'react-dom', 'react-jsx-runtime', 'wp-api-fetch', 'wp-blob', 'wp-block-editor', 'wp-block-serialization-default-parser', 'wp-blocks', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-date', 'wp-dom-ready', 'wp-editor', 'wp-element', 'wp-escape-html', 'wp-hooks', 'wp-i18n', 'wp-keycodes', 'wp-notices', 'wp-plugins', 'wp-polyfill', 'wp-primitives', 'wp-token-list', 'wp-url', 'wp-viewport', 'wp-widgets'), 'version' => '9c18205166b7ad8a5758');
+<?php return array('dependencies' => array('jetpack-script-data', 'lodash', 'moment', 'react', 'react-dom', 'react-jsx-runtime', 'wp-api-fetch', 'wp-blob', 'wp-block-editor', 'wp-block-serialization-default-parser', 'wp-blocks', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-date', 'wp-dom-ready', 'wp-editor', 'wp-element', 'wp-escape-html', 'wp-hooks', 'wp-i18n', 'wp-keycodes', 'wp-notices', 'wp-plugins', 'wp-polyfill', 'wp-primitives', 'wp-token-list', 'wp-url', 'wp-viewport', 'wp-widgets'), 'version' => '5a88c0af3edcc836077a');
diff --git a/_inc/blocks/editor-no-post-editor.js b/_inc/blocks/editor-no-post-editor.js
diff --git a/_inc/blocks/editor.asset.php b/_inc/blocks/editor.asset.php
@@ -1 +1 @@
-<?php return array('dependencies' => array('jetpack-script-data', 'lodash', 'moment', 'react', 'react-dom', 'react-jsx-runtime', 'wp-a11y', 'wp-api-fetch', 'wp-blob', 'wp-block-editor', 'wp-block-serialization-default-parser', 'wp-blocks', 'wp-commands', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-date', 'wp-dom-ready', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-escape-html', 'wp-hooks', 'wp-html-entities', 'wp-i18n', 'wp-keycodes', 'wp-media-utils', 'wp-notices', 'wp-plugins', 'wp-polyfill', 'wp-primitives', 'wp-rich-text', 'wp-token-list', 'wp-url', 'wp-viewport', 'wp-widgets', 'wp-wordcount'), 'version' => '335ddba900ddd130ffc7');
+<?php return array('dependencies' => array('jetpack-script-data', 'lodash', 'moment', 'react', 'react-dom', 'react-jsx-runtime', 'wp-a11y', 'wp-api-fetch', 'wp-blob', 'wp-block-editor', 'wp-block-serialization-default-parser', 'wp-blocks', 'wp-commands', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-date', 'wp-dom-ready', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-escape-html', 'wp-hooks', 'wp-html-entities', 'wp-i18n', 'wp-keycodes', 'wp-media-utils', 'wp-notices', 'wp-plugins', 'wp-polyfill', 'wp-primitives', 'wp-rich-text', 'wp-token-list', 'wp-url', 'wp-viewport', 'wp-widgets', 'wp-wordcount'), 'version' => '0bf7d90e5efc1480a6e4');
diff --git a/_inc/blocks/editor.js b/_inc/blocks/editor.js
diff --git a/_inc/lib/class-jetpack-ai-helper.php b/_inc/lib/class-jetpack-ai-helper.php
@@ -366,6 +366,17 @@ public static function get_ai_assistance_feature() {
 				}
 			}
 
+			if ( ! class_exists( 'WPCOM\Jetpack_AI\Feature_Control' ) ) {
+				if ( is_readable( WP_CONTENT_DIR . '/lib/jetpack-ai/feature-control.php' ) ) {
+					require_once WP_CONTENT_DIR . '/lib/jetpack-ai/feature-control.php';
+				} else {
+					return new WP_Error(
+						'jetpack_ai_feature_control_not_found',
+						__( 'WPCOM\Jetpack_AI\Feature_Control class not found.', 'jetpack' )
+					);
+				}
+			}
+
 			// Determine the upgrade type
 			$upgrade_type = wpcom_is_vip( $blog_id ) ? 'vip' : 'default';
 
@@ -383,6 +394,7 @@ public static function get_ai_assistance_feature() {
 				'tier-plans'           => WPCOM\Jetpack_AI\Usage\Helper::get_tier_plans_list(),
 				'tier-plans-enabled'   => WPCOM\Jetpack_AI\Usage\Helper::ai_tier_plans_enabled(),
 				'costs'                => WPCOM\Jetpack_AI\Usage\Helper::get_costs(),
+				'features-control'     => WPCOM\Jetpack_AI\Feature_Control::get_features(),
 			);
 		}
 

diff --git a/extensions/plugins/ai-assistant-plugin/components/ai-assistant-plugin-sidebar/index.tsx b/extensions/plugins/ai-assistant-plugin/components/ai-assistant-plugin-sidebar/index.tsx
@@ -23,7 +23,7 @@ import JetpackPluginSidebar from '../../../../shared/jetpack-plugin-sidebar';
 import { PLAN_TYPE_FREE, PLAN_TYPE_UNLIMITED, usePlanType } from '../../../../shared/use-plan-type';
 import { FeaturedImage } from '../ai-image';
 import { Breve, registerBreveHighlights, Highlight } from '../breve';
-import useBreveAvailability from '../breve/hooks/use-breve-availability';
+import { getBreveAvailability, canWriteBriefBeEnabled } from '../breve/utils/get-availability';
 import Feedback from '../feedback';
 import TitleOptimization from '../title-optimization';
 import UsagePanel from '../usage-panel';
@@ -70,7 +70,7 @@ const JetpackAndSettingsContent = ( {
 }: JetpackSettingsContentProps ) => {
 	const { checkoutUrl } = useAICheckout();
 	const { productPageUrl } = useAiProductPage();
-	const isBreveAvailable = useBreveAvailability();
+	const isBreveAvailable = getBreveAvailability();
 
 	const currentTitleOptimizationSectionLabel = __( 'Optimize Publishing', 'jetpack' );
 	const SEOTitleOptimizationSectionLabel = __( 'Optimize Title', 'jetpack' );
@@ -88,7 +88,7 @@ const JetpackAndSettingsContent = ( {
 				</PanelRow>
 			) }
 
-			{ isBreveAvailable && (
+			{ canWriteBriefBeEnabled() && isBreveAvailable && (
 				<PanelRow>
 					<BaseControl label={ __( 'Write Brief with AI (BETA)', 'jetpack' ) }>
 						<Breve />
@@ -153,7 +153,7 @@ export default function AiAssistantPluginSidebar() {
 		useAiFeature();
 	const { checkoutUrl } = useAICheckout();
 	const { tracks } = useAnalytics();
-	const isBreveAvailable = useBreveAvailability();
+	const isBreveAvailable = getBreveAvailability();
 
 	const isViewable = useSelect( select => {
 		const postTypeName = ( select( editorStore ) as typeof EditorSelectors ).getCurrentPostType();

diff --git a/extensions/plugins/ai-assistant-plugin/components/breve/controls.tsx b/extensions/plugins/ai-assistant-plugin/components/breve/controls.tsx
@@ -21,6 +21,7 @@ import React, { useState, useEffect, useCallback } from 'react';
  */
 import features from './features';
 import calculateFleschKincaid from './utils/FleschKincaidUtils';
+import { canWriteBriefFeatureBeEnabled } from './utils/get-availability';
 import { getPostText } from './utils/getPostText';
 import './breve.scss';
 /**
@@ -134,17 +135,20 @@ const Controls = ( { blocks, disabledFeatures } ) => {
 						label={ __( 'Show suggestions', 'jetpack' ) }
 					/>
 					<div className="feature-checkboxes-container">
-						{ features.map( feature => (
-							<CheckboxControl
-								className={ isProofreadEnabled ? '' : 'is-disabled' }
-								disabled={ ! isProofreadEnabled }
-								data-breve-type={ feature.config.name }
-								key={ feature.config.name }
-								label={ feature.config.title }
-								checked={ ! disabledFeatures.includes( feature.config.name ) }
-								onChange={ handleToggleFeature( feature.config.name ) }
-							/>
-						) ) }
+						{ features.map(
+							feature =>
+								canWriteBriefFeatureBeEnabled( feature.config.name ) && (
+									<CheckboxControl
+										className={ isProofreadEnabled ? '' : 'is-disabled' }
+										disabled={ ! isProofreadEnabled }
+										data-breve-type={ feature.config.name }
+										key={ feature.config.name }
+										label={ feature.config.title }
+										checked={ ! disabledFeatures.includes( feature.config.name ) }
+										onChange={ handleToggleFeature( feature.config.name ) }
+									/>
+								)
+						) }
 					</div>
 				</BaseControl>
 			</PanelRow>

diff --git a/extensions/plugins/ai-assistant-plugin/components/breve/hooks/use-breve-availability.ts b/extensions/plugins/ai-assistant-plugin/components/breve/hooks/use-breve-availability.ts
diff --git a/extensions/plugins/ai-assistant-plugin/components/breve/types.ts b/extensions/plugins/ai-assistant-plugin/components/breve/types.ts
@@ -94,6 +94,15 @@ export type BreveDispatch = {
 	} ) => void;
 };
 
+export type PlansSelect = {
+	getAiAssistantFeature: () => {
+		featuresControl: { [ key: string ]: FeatureControl };
+		currentTier?: {
+			value?: number;
+		};
+	};
+};
+
 export type BreveFeatureConfig = {
 	name: string;
 	title: string;
@@ -127,3 +136,9 @@ export type SpellingDictionaryContext = {
 	affix: string;
 	dictionary: string;
 };
+
+export type FeatureControl = {
+	enabled: boolean;
+	'min-jetpack-version': string;
+	[ key: string ]: FeatureControl | boolean | string;
+};
diff --git a/extensions/plugins/ai-assistant-plugin/components/breve/utils/get-availability.ts b/extensions/plugins/ai-assistant-plugin/components/breve/utils/get-availability.ts
@@ -6,11 +6,30 @@ import { select } from '@wordpress/data';
  * Internal dependencies
  */
 import { getFeatureAvailability } from '../../../../../blocks/ai-assistant/lib/utils/get-feature-availability';
+/**
+ * Types
+ */
+import type { FeatureControl, PlansSelect } from '../types';
+
+function getAiAssistantFeature() {
+	const { getAiAssistantFeature: getFeature } = select( 'wordpress-com/plans' ) as PlansSelect;
+
+	return getFeature();
+}
+
+export function getBreveAvailability() {
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	const { currentTier, featuresControl } = getAiAssistantFeature();
+
+	// Disabled remotely.
+	if ( featuresControl?.[ 'write-brief' ]?.enabled === false ) {
+		return false;
+	}
 
-export function getBreveAvailability( _isFreePlan: boolean ) {
 	// Free plan users have access to Breve while it's in beta.
+	// const isFreePlan = currentTier?.value === 0;
 	// TODO: Review this logic when Breve is out of beta.
-	// if ( _isFreePlan ) {
+	// if ( isFreePlan ) {
 	// 	return false;
 	// }
 
@@ -26,4 +45,16 @@ export function getBreveAvailability( _isFreePlan: boolean ) {
 	return getFeatureAvailability( 'ai-proofread-breve' );
 }
 
+export function canWriteBriefBeEnabled() {
+	const { featuresControl } = getAiAssistantFeature();
+
+	return featuresControl?.[ 'write-brief' ]?.enabled !== false;
+}
+
+export function canWriteBriefFeatureBeEnabled( feature: string ) {
+	const { featuresControl } = getAiAssistantFeature();
+
+	return ( featuresControl?.[ 'write-brief' ]?.[ feature ] as FeatureControl )?.enabled !== false;
+}
+
 export default getBreveAvailability;
diff --git a/extensions/plugins/ai-assistant-plugin/components/breve/utils/register-format.ts b/extensions/plugins/ai-assistant-plugin/components/breve/utils/register-format.ts
@@ -11,7 +11,11 @@ import md5 from 'crypto-js/md5';
 import features from '../features';
 import registerEvents from '../features/events';
 import highlight from '../highlight/highlight';
-import getBreveAvailability from '../utils/get-availability';
+import {
+	getBreveAvailability,
+	canWriteBriefBeEnabled,
+	canWriteBriefFeatureBeEnabled,
+} from '../utils/get-availability';
 /**
  * Types
  */
@@ -53,12 +57,12 @@ export function registerBreveHighlight( feature: BreveFeature ) {
 				getReloadFlag,
 			} = select( 'jetpack/ai-breve' ) as BreveSelect;
 
-			const { getAiAssistantFeature } = select( 'wordpress-com/plans' );
-			const isFreePlan = getAiAssistantFeature().currentTier?.value === 0;
+			const canBeEnabled = canWriteBriefBeEnabled();
+			const canFeatureBeEnabled = canWriteBriefFeatureBeEnabled( config.name );
 
 			return {
-				isProofreadEnabled: isProofreadEnabled() && getBreveAvailability( isFreePlan ),
-				isFeatureEnabled: isFeatureEnabled( config.name ),
+				isProofreadEnabled: canBeEnabled && isProofreadEnabled() && getBreveAvailability(),
+				isFeatureEnabled: canFeatureBeEnabled && isFeatureEnabled( config.name ),
 				ignored: getIgnoredSuggestions( { blockId: blockClientId } ),
 				isFeatureDictionaryLoading: isFeatureDictionaryLoading( config.name ),
 				reloadFlag: getReloadFlag(), // Used to force a reload of the highlights

diff --git a/extensions/store/wordpress-com/actions.ts b/extensions/store/wordpress-com/actions.ts
@@ -50,6 +50,7 @@ export function mapAiFeatureResponseToAiFeatureProps(
 		nextTier: response[ 'next-tier' ],
 		tierPlansEnabled: !! response[ 'tier-plans-enabled' ],
 		costs: response.costs,
+		featuresControl: response[ 'features-control' ],
 	};
 }
 

diff --git a/extensions/store/wordpress-com/types.ts b/extensions/store/wordpress-com/types.ts
@@ -83,6 +83,14 @@ export type TierValueProp =
 	| Tier750Props[ 'value' ]
 	| Tier1000Props[ 'value' ];
 
+export type FeatureControl = {
+	enabled: boolean;
+	'min-jetpack-version': string;
+	[ key: string ]: FeatureControl | boolean | string;
+};
+
+export type FeaturesControl = { [ key: string ]: FeatureControl };
+
 export type AiFeatureProps = {
 	hasFeature: boolean;
 	isOverLimit: boolean;
@@ -105,6 +113,7 @@ export type AiFeatureProps = {
 			[ key: string ]: number;
 		};
 	};
+	featuresControl?: FeaturesControl;
 };
 
 // Type used in the `wordpress-com/plans` store.

diff --git a/extensions/types.ts b/extensions/types.ts
@@ -1,7 +1,7 @@
 /**
  * Types for the AI Assistant feature.
  */
-import type { TierProp, UpgradeTypeProp } from './store/wordpress-com/types';
+import type { TierProp, UpgradeTypeProp, FeaturesControl } from './store/wordpress-com/types';
 
 /*
  * `sites/$site/ai-assistant-feature` endpoint response body props
@@ -29,4 +29,5 @@ export type SiteAIAssistantFeatureEndpointResponseProps = {
 			[ key: string ]: number;
 		};
 	};
+	'features-control'?: FeaturesControl;
 };
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<?php return array('dependencies' => array('jetpack-script-data', 'lodash', 'moment', 'react', 'react-dom', 'react-jsx-runtime', 'wp-a11y', 'wp-api-fetch', 'wp-blob', 'wp-block-editor', 'wp-block-serialization-default-parser', 'wp-blocks', 'wp-commands', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-date', 'wp-dom-ready', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-escape-html', 'wp-hooks', 'wp-html-entities', 'wp-i18n', 'wp-keycodes', 'wp-media-utils', 'wp-notices', 'wp-plugins', 'wp-polyfill', 'wp-primitives', 'wp-rich-text', 'wp-token-list', 'wp-url', 'wp-viewport', 'wp-widgets', 'wp-wordcount'), 'version' => '085a56f80b46ffafb632');
		<?php return array('dependencies' => array('jetpack-script-data', 'lodash', 'moment', 'react', 'react-dom', 'react-jsx-runtime', 'wp-a11y', 'wp-api-fetch', 'wp-blob', 'wp-block-editor', 'wp-block-serialization-default-parser', 'wp-blocks', 'wp-commands', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-date', 'wp-dom-ready', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-escape-html', 'wp-hooks', 'wp-html-entities', 'wp-i18n', 'wp-keycodes', 'wp-media-utils', 'wp-notices', 'wp-plugins', 'wp-polyfill', 'wp-primitives', 'wp-rich-text', 'wp-token-list', 'wp-url', 'wp-viewport', 'wp-widgets', 'wp-wordcount'), 'version' => '980be369b3a62d973a9c');