Migrate custom status to use term_meta

dist/modules/custom-status/custom-status-configure.asset.php

@@ -1 +1 @@
-<?php return array('dependencies' => array('react', 'react-dom', 'wp-api-fetch', 'wp-components', 'wp-compose', 'wp-dom-ready', 'wp-element', 'wp-i18n', 'wp-primitives'), 'version' => '292b80686f7e56a2b457');
+<?php return array('dependencies' => array('react', 'react-dom', 'wp-api-fetch', 'wp-components', 'wp-compose', 'wp-dom-ready', 'wp-element', 'wp-i18n', 'wp-primitives'), 'version' => 'e53bfd4765be1e980144');

modules/custom-status/lib/components/metadata-select-form-token-field.js

@@ -0,0 +1,123 @@
+import { BaseControl, FormTokenField } from '@wordpress/components';
+import { debounce } from '@wordpress/compose';
+import { useEffect, useMemo, useState } from '@wordpress/element';
+/**
+ * Custom status component
+ * @param object props
+ */
+export default function MetadataSelectFormTokenField( {
+	requiredMetadatas,
+	editorialMetadatas,
+	onMetadatasChanged,
+	help,
+	...formTokenFieldProps
+} ) {
+	const [ metadataSearch, setMetadataSearch ] = useState( '' );
+	const debouncedSetMetadataSearch = debounce( setMetadataSearch, 200 );
+	const [ searchedMetadatas, setSearchedMetadatas ] = useState( [] );
+
+	const [ selectedMetadataTokens, setSelectedMetadataTokens ] = useState(
+		// Map login strings to TokenItem objects
+		requiredMetadatas.map( requiredMetadata => ( {
+			title: requiredMetadata.name,
+			value: requiredMetadata.name,
+			requiredMetadata,
+		} ) )
+	);
+
+	useEffect( () => {
+		if (
+			metadataSearch.trim().length === 0 ||
+			! editorialMetadatas ||
+			editorialMetadatas.length === 0
+		) {
+			return;
+		}
+
+		const matchedMetadatas = editorialMetadatas.filter( metadata =>
+			metadata.name.toLowerCase().includes( metadataSearch.toLowerCase() )
+		);
+
+		setSearchedMetadatas( matchedMetadatas );
+	}, [ editorialMetadatas, metadataSearch ] );
+
+	const suggestions = useMemo( () => {
+		let metadatasToSuggest = searchedMetadatas;
+
+		if ( searchedMetadatas.length > 0 && requiredMetadatas.length > 0 ) {
+			// Remove already-selected editorial metadatas from suggestions
+			const selectedMetadataMap = {};
+			requiredMetadatas.forEach( metadata => {
+				selectedMetadataMap[ metadata.id ] = true;
+			} );
+
+			metadatasToSuggest = searchedMetadatas.filter(
+				metadata => ! ( metadata.term_id in selectedMetadataMap )
+			);
+		}
+
+		return metadatasToSuggest.map( metadata => {
+			return `${ metadata.name }`;
+		} );
+	}, [ searchedMetadatas, requiredMetadatas ] );
+
+	const handleOnChange = selectedTokens => {
+		const proccessedTokens = [];
+		selectedTokens.forEach( token => {
+			if ( typeof token === 'string' || token instanceof String ) {
+				// This is an unprocessed token that represents a string representation of
+				// a metadata selected from the dropdown. Convert it to a TokenItem object.
+				const metadata = searchedMetadatas.find( metadata => metadata.name === token );
+
+				if ( metadata !== undefined ) {
+					proccessedTokens.push( convertMetadataToToken( metadata ) );
+				}
+			} else {
+				// This token has already been processed into a TokenItem.
+				proccessedTokens.push( token );
+			}
+			return token;
+		} );
+
+		setSelectedMetadataTokens( proccessedTokens );
+
+		const metadatas = proccessedTokens.map( token => token.metadata );
+		onMetadatasChanged( metadatas );
+	};
+
+	return (
+		<>
+			<FormTokenField
+				{ ...formTokenFieldProps }
+				onChange={ handleOnChange }
+				onInputChange={ debouncedSetMetadataSearch }
+				suggestions={ suggestions }
+				value={ selectedMetadataTokens }
+				// Remove "Separate with commas or the Enter key" text that doesn't apply here
+				__experimentalShowHowTo={ false }
+				// Auto-select first match, so that it's possible to press <Enter> and immediately choose it
+				__experimentalAutoSelectFirstMatch={ true }
+			/>
+
+			{ /* <FormTokenField> doesn't support help text. Provide a BaseControl with the help text instead. */ }
+			{ help && <BaseControl help={ help }></BaseControl> }
+		</>
+	);
+}
+
+/**
+ * Given a metadata object, convert it to a TokenItem object.
+ * @param object metadata
+ */
+const convertMetadataToToken = metadata => {
+	return {
+		// In a TokenItem, the "title" is an HTML title displayed on hover
+		title: metadata.name,
+
+		// The "value" is what's shown in the UI
+		value: metadata.name,
+
+		// Store the metadata with this token so we can pass it to the parent component easily
+		metadata,
+	};
+};

modules/custom-status/lib/components/modals/create-edit-custom-status-modal.js

@@ -1,33 +1,62 @@
 import apiFetch from '@wordpress/api-fetch';
 import {
-	Card,
 	Button,
+	Card,
+	CardBody,
+	__experimentalDivider as Divider,
+	__experimentalHStack as HStack,
 	Modal,
 	TextControl,
 	TextareaControl,
-	Tooltip,
 	ToggleControl,
-	__experimentalDivider as Divider,
-	__experimentalHStack as HStack,
-	CardBody,
+	Tooltip,
 } from '@wordpress/components';
 import { useState } from '@wordpress/element';
 import { __, sprintf } from '@wordpress/i18n';
 
 import ErrorNotice from '../../../../shared/js/components/error-notice';
+import MetadataSelectFormTokenField from '../metadata-select-form-token-field';
 import UserSelectFormTokenField from '../user-select-form-token-field';
 
-export default function CreateEditCustomStatusModal( { customStatus, onCancel, onSuccess } ) {
+export default function CreateEditCustomStatusModal( {
+	customStatus,
+	editorialMetadatas,
+	onCancel,
+	onSuccess,
+} ) {
 	// Custom status properties
 	const [ name, setName ] = useState( customStatus?.name || '' );
 	const [ description, setDescription ] = useState( customStatus?.description || '' );
-	const [ requiredUsers, setRequiredUsers ] = useState( customStatus?.required_users || [] );
+	const [ requiredUsers, setRequiredUsers ] = useState( customStatus?.meta?.required_users || [] );
+
+	// Taxonomy conflicts arise if this is done server side, so this transient field is only set here.
+	const [ requiredMetadatas, setRequiredMetadatas ] = useState( () => {
+		if (
+			customStatus?.meta?.required_metadata_ids &&
+			customStatus?.meta?.required_metadata_ids.length > 0 &&
+			editorialMetadatas.length > 0
+		) {
+			// Get the required metadata fields from the custom status meta and find the corresponding editorial metadata.
+			const required_metadatas = customStatus.meta.required_metadata_ids.map( metadata => {
+				return editorialMetadatas.find(
+					editorialMetadata => editorialMetadata.term_id === metadata
+				);
+			} );
+
+			// Filter out any undefined values.
+			return required_metadatas.filter( metadata => metadata );
+		}
+
+		return [];
+	} );
+
+	const [ metadatas, setMetadatas ] = useState( editorialMetadatas );
 
 	// Modal properties
 	const [ error, setError ] = useState( null );
 	const [ isRequesting, setIsRequesting ] = useState( false );
 	const [ isRestrictedSectionVisible, setIsRestrictedSectionVisible ] = useState(
-		requiredUsers.length > 0
+		requiredUsers.length > 0 || requiredMetadatas.length > 0
 	);
 
 	let titleText;
@@ -43,6 +72,9 @@ export default function CreateEditCustomStatusModal( { customStatus, onCancel, o
 		if ( isRestrictedSectionVisible ) {
 			const userIds = requiredUsers.map( user => user.id );
 			data.required_user_ids = userIds;
+
+			const metadataIds = requiredMetadatas.map( metadata => metadata.term_id );
+			data.required_metadata_ids = metadataIds;
 		}
 
 		try {
@@ -96,7 +128,7 @@ export default function CreateEditCustomStatusModal( { customStatus, onCancel, o
 			<ToggleControl
 				label={ __( 'This status is restricted', 'vip-workflow' ) }
 				help={ __(
-					'Require a specific user or role to advance to the next status.',
+					'Require a specific user or editorial metadata field to advance to the next status.',
 					'vip-workflow'
 				) }
 				checked={ isRestrictedSectionVisible }
@@ -113,6 +145,16 @@ export default function CreateEditCustomStatusModal( { customStatus, onCancel, o
 								requiredUsers={ requiredUsers }
 								onUsersChanged={ setRequiredUsers }
 							/>
+							<MetadataSelectFormTokenField
+								label={ __( 'Required metadata fields', 'vip-workflow' ) }
+								help={ __(
+									'These editorial metadata fields are required to advance this status.',
+									'vip-workflow'
+								) }
+								editorialMetadatas={ metadatas }
+								requiredMetadatas={ requiredMetadatas }
+								onMetadatasChanged={ setRequiredMetadatas }
+							/>
 						</CardBody>
 					</Card>
 				</>

modules/custom-status/lib/components/workflow-manager.js

@@ -4,17 +4,19 @@ import { Button, Flex, __experimentalHeading as Heading, Tooltip } from '@wordpr
 import { useState } from '@wordpress/element';
 import { __, sprintf } from '@wordpress/i18n';
 
-import DraggableCustomStatus from './draggable-custom-status';
-import CreateEditCustomStatusModal from './modals/create-edit-custom-status-modal';
 import ErrorNotice from '../../../shared/js/components/error-notice';
 import ConfirmDeleteModal from '../../../shared/js/components/modals/confirm-delete-modal';
 import SuccessNotice from '../../../shared/js/components/success-notice';
+import DraggableCustomStatus from './draggable-custom-status';
+import CreateEditCustomStatusModal from './modals/create-edit-custom-status-modal';
 
-export default function WorkflowManager( { customStatuses } ) {
+export default function WorkflowManager( { customStatuses, editorialMetadatas } ) {
 	const [ success, setSuccess ] = useState( null );
 	const [ error, setError ] = useState( null );
 
 	const [ statuses, setStatuses ] = useState( customStatuses );
+	const [ metadatas, setMetadatas ] = useState( editorialMetadatas );
+
 	const [ status, setStatus ] = useState( null );
 
 	const [ isConfirmingDelete, setIsConfirmingDelete ] = useState( false );
@@ -82,6 +84,7 @@ export default function WorkflowManager( { customStatuses } ) {
 	const createEditModal = (
 		<CreateEditCustomStatusModal
 			customStatus={ status }
+			editorialMetadatas={ metadatas }
 			onCancel={ () => setIsCreateEditModalVisible( false ) }
 			onSuccess={ handleSuccess }
 		/>

modules/custom-status/lib/custom-status-configure.js

@@ -11,7 +11,10 @@ domReady( () => {
 	if ( workflowManagerRoot ) {
 		const root = createRoot( workflowManagerRoot );
 		root.render(
-			<WorkflowManager customStatuses={ VW_CUSTOM_STATUS_CONFIGURE.custom_statuses } />
+			<WorkflowManager
+				customStatuses={ VW_CUSTOM_STATUS_CONFIGURE.custom_statuses }
+				editorialMetadatas={ VW_CUSTOM_STATUS_CONFIGURE.editorial_metadatas }
+			/>
 		);
 	}
 } );

modules/custom-status/meta/position-handler.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * class PositionHandler
+ *
+ * This class serves as a handler for the position of a custom status.
+ */
+
+namespace VIPWorkflow\Modules\CustomStatus\Meta;
+
+use VIPWorkflow\Modules\Custom_Status;
+use VIPWorkflow\Modules\Shared\PHP\MetaCleanupUtilities;
+use WP_Term;
+
+class PositionHandler {
+
+	public static function init(): void {
+		// Add the position to the custom status
+		add_filter( 'vw_register_custom_status_meta', [ __CLASS__, 'add_position' ], 10, 2 );
+
+		// Remove the position on a status
+		add_action( 'vw_delete_custom_status_meta', [ __CLASS__, 'delete_position' ], 10, 1 );
+	}
+
+	/**
+	 * Add the position to the custom status
+	 *
+	 * @param array $term_meta The meta keys for the custom status
+	 * @param WP_Term $custom_status The custom status term
+	 * @return array The updated meta keys
+	 */
+	public static function add_position( array $term_meta, WP_Term $custom_status ): array {
+		$position = MetaCleanupUtilities::get_int( $custom_status->term_id, Custom_Status::METADATA_POSITION_KEY );
+
+		$term_meta[ Custom_Status::METADATA_POSITION_KEY ] = $position;
+
+		return $term_meta;
+	}
+
+	/**
+	 * Delete the position on a status
+	 *
+	 * @param integer $term_id The term ID of the status
+	 * @return void
+	 */
+	public static function delete_position( int $term_id ): void {
+		delete_term_meta( $term_id, Custom_Status::METADATA_POSITION_KEY );
+	}
+}
+
+PositionHandler::init();

modules/custom-status/meta/required-metadata-id-handler.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * class RequiredMetadataIdHandler
+ *
+ * Cleans up editorial metadata IDs that are required on a custom status, and should be cleaned up once they are deleted.
+ */
+
+namespace VIPWorkflow\Modules\CustomStatus\Meta;
+
+use VIPWorkflow\Modules\Custom_Status;
+use VIPWorkflow\VIP_Workflow;
+use VIPWorkflow\Modules\Shared\PHP\MetaCleanupUtilities;
+
+use WP_Term;
+
+class RequiredMetadataIdHandler {
+
+	public static function init(): void {
+		// Add the required metadata IDs to the custom status
+		add_filter( 'vw_register_custom_status_meta', [ __CLASS__, 'add_required_metadata_ids' ], 10, 2 );
+
+		// Remove the required metadata fields on a status
+		add_action( 'vw_delete_custom_status_meta', [ __CLASS__, 'delete_required_metadata' ], 10, 1 );
+
+		// Remove deleted metadata fields from required metadata fields
+		add_action( 'vw_editorial_metadata_term_deleted', [ __CLASS__, 'remove_deleted_metadata_from_required_metadata' ], 10, 1 );
+	}
+
+	/**
+	 * Add the required metadata IDs to the custom status
+	 *
+	 * @param array $term_meta The meta keys for the custom status
+	 * @param WP_Term $custom_status The custom status term
+	 * @return array The updated meta keys
+	 */
+	public static function add_required_metadata_ids( array $term_meta, WP_Term $custom_status ): array {
+		$metadata_ids = MetaCleanupUtilities::get_array( $custom_status->term_id, Custom_Status::METADATA_REQ_EDITORIAL_IDS_KEY );
+
+		$term_meta[ Custom_Status::METADATA_REQ_EDITORIAL_IDS_KEY ] = $metadata_ids;
+
+		return $term_meta;
+	}
+
+	/**
+	 * Delete the required metadata fields on a status
+	 *
+	 * @param integer $term_id The term ID of the status
+	 * @return void
+	 */
+	public static function delete_required_metadata( int $term_id ): void {
+		delete_term_meta( $term_id, Custom_Status::METADATA_REQ_EDITORIAL_IDS_KEY );
+	}
+
+	/**
+	 * Remove the delete metadata from the required metadata fields on a status
+	 *
+	 * @param integer $meta_id The meta ID that was deleted
+	 * @return void
+	 */
+	public static function remove_deleted_metadata_from_required_metadata( int $deleted_meta_id ): void {
+		$custom_statuses = VIP_Workflow::instance()->custom_status->get_custom_statuses();
+
+		MetaCleanupUtilities::cleanup_id( $custom_statuses, $deleted_meta_id, /* id_to_replace */ null, Custom_Status::METADATA_REQ_EDITORIAL_IDS_KEY );
+	}
+}
+
+RequiredMetadataIdHandler::init();