Social: Refactor Social Note settings to use core (#41153)

gmjuhasz · web-flow · commit aa40ce3cd631 · 2025-01-21T13:04:00.000+01:00
* Register settings with core

* Update store to use core settings api

* changelog

* Remove deprecated code

* Fix some tests

* Fix constant issue

* Cast pricing_page option to int as before

* Remove boolean castings

* Remove casting

* Fix TS errors

* Address comments on function names
diff --git a/projects/js-packages/publicize-components/changelog/refactor-social-note-settings-core b/projects/js-packages/publicize-components/changelog/refactor-social-note-settings-core
@@ -0,0 +1,4 @@
+Significance: minor
+Type: changed
+
+Refactored Social Note settings to use core
diff --git a/projects/js-packages/publicize-components/src/social-store/actions/index.ts b/projects/js-packages/publicize-components/src/social-store/actions/index.ts
@@ -1,6 +1,8 @@
 import * as connectionData from './connection-data';
+import * as pricingPageSettings from './pricing-page';
 import * as shareStatus from './share-status';
 import * as sigActions from './social-image-generator';
+import * as socialNoteSettings from './social-notes';
 import * as socialPluginSettings from './social-plugin-settings';
 import * as utmActions from './utm-settings';
 
@@ -9,6 +11,8 @@ const actions = {
 	...connectionData,
 	...sigActions,
 	...utmActions,
+	...socialNoteSettings,
+	...pricingPageSettings,
 	...socialPluginSettings,
 };
 
diff --git a/projects/js-packages/publicize-components/src/social-store/actions/pricing-page.ts b/projects/js-packages/publicize-components/src/social-store/actions/pricing-page.ts
@@ -0,0 +1,16 @@
+import { store as coreStore } from '@wordpress/core-data';
+import { SHOW_PRICING_PAGE_KEY } from '../constants';
+
+/**
+ * Sets the Show Pricing Page enabled status.
+ *
+ * @param  isEnabled - The new enabled status.
+ * @return {Function} A thunk.
+ */
+export function setShowPricingPage( isEnabled: boolean ) {
+	return async function ( { registry } ) {
+		const { saveSite } = registry.dispatch( coreStore );
+
+		await saveSite( { [ SHOW_PRICING_PAGE_KEY ]: isEnabled } );
+	};
+}
diff --git a/projects/js-packages/publicize-components/src/social-store/actions/social-notes.ts b/projects/js-packages/publicize-components/src/social-store/actions/social-notes.ts
@@ -0,0 +1,33 @@
+import { store as coreStore } from '@wordpress/core-data';
+import { SOCIAL_NOTES_CONFIG_KEY, SOCIAL_NOTES_ENABLED_KEY } from '../constants';
+import { SocialNotesConfig } from '../types';
+
+/**
+ * Sets the Social Notes enabled status.
+ *
+ * @param  isEnabled - The new enabled status.
+ *
+ * @return {Function} A thunk.
+ */
+export function toggleSocialNotes( isEnabled: boolean ) {
+	return async function ( { registry } ) {
+		const { saveSite } = registry.dispatch( coreStore );
+
+		await saveSite( { [ SOCIAL_NOTES_ENABLED_KEY ]: isEnabled } );
+	};
+}
+
+/**
+ * Updates the Social Notes Config
+ *
+ * @param {Partial< SocialNotesConfig >} data - The data to save.
+ *
+ * @return {Function} A thunk.
+ */
+export function updateSocialNotesConfig( data: Partial< SocialNotesConfig > ) {
+	return async function ( { registry } ) {
+		const { saveSite } = registry.dispatch( coreStore );
+
+		await saveSite( { [ SOCIAL_NOTES_CONFIG_KEY ]: data } );
+	};
+}
diff --git a/projects/js-packages/publicize-components/src/social-store/constants.ts b/projects/js-packages/publicize-components/src/social-store/constants.ts
@@ -1,2 +1,6 @@
+// See projects/packages/publicize/src/jetpack-social-settings/class-settings.php
 export const SIG_SETTINGS_KEY = 'jetpack_social_image_generator_settings';
 export const UTM_ENABLED_KEY = 'jetpack_social_utm_settings';
+export const SOCIAL_NOTES_ENABLED_KEY = 'jetpack-social-note';
+export const SOCIAL_NOTES_CONFIG_KEY = 'jetpack_social_notes_config';
+export const SHOW_PRICING_PAGE_KEY = 'jetpack-social_show_pricing_page';
diff --git a/projects/js-packages/publicize-components/src/social-store/selectors/index.ts b/projects/js-packages/publicize-components/src/social-store/selectors/index.ts
@@ -1,8 +1,10 @@
 import { store as coreStore } from '@wordpress/core-data';
 import { createRegistrySelector } from '@wordpress/data';
 import * as connectionDataSelectors from './connection-data';
+import * as pricingPageSelectors from './pricing-page';
 import * as shareStatusSelectors from './share-status';
 import * as sigSelectors from './social-image-generator';
+import * as socialNoteSelectors from './social-notes';
 import * as socialPluginSelectors from './social-plugin-settings';
 import * as utmSelectors from './utm-settings';
 
@@ -19,6 +21,8 @@ const selectors = {
 	isSavingSiteSettings,
 	...sigSelectors,
 	...utmSelectors,
+	...socialNoteSelectors,
+	...pricingPageSelectors,
 	...socialPluginSelectors,
 };
 
diff --git a/projects/js-packages/publicize-components/src/social-store/selectors/pricing-page.ts b/projects/js-packages/publicize-components/src/social-store/selectors/pricing-page.ts
@@ -0,0 +1,19 @@
+import { store as coreStore } from '@wordpress/core-data';
+import { createRegistrySelector } from '@wordpress/data';
+import { getSocialScriptData } from '../../utils';
+import { SHOW_PRICING_PAGE_KEY } from '../constants';
+
+/**
+ * Returns the Show Pricing Page enabled status for the current site.
+ */
+export const shouldShowPricingPage = createRegistrySelector( select => () => {
+	const { getSite } = select( coreStore );
+
+	const settings = getSite( undefined, { _fields: SHOW_PRICING_PAGE_KEY } );
+
+	// If the settings are not available in the store yet, use the default settings.
+	return (
+		settings?.[ SHOW_PRICING_PAGE_KEY ] ??
+		getSocialScriptData().settings?.socialPlugin?.show_pricing_page
+	);
+} );
diff --git a/projects/js-packages/publicize-components/src/social-store/selectors/social-notes.ts b/projects/js-packages/publicize-components/src/social-store/selectors/social-notes.ts
@@ -0,0 +1,37 @@
+import { store as coreStore } from '@wordpress/core-data';
+import { createRegistrySelector } from '@wordpress/data';
+import { getSocialScriptData } from '../../utils';
+import { SOCIAL_NOTES_CONFIG_KEY, SOCIAL_NOTES_ENABLED_KEY } from '../constants';
+
+/**
+ * Returns if Social Notes are enabled for the current site.
+ */
+export const isSocialNotesEnabled = createRegistrySelector( select => () => {
+	const { getSite } = select( coreStore );
+
+	const settings = getSite( undefined, {
+		_fields: SOCIAL_NOTES_ENABLED_KEY,
+	} );
+	// If the settings are not available in the store yet, use the default settings.
+	return (
+		settings?.[ SOCIAL_NOTES_ENABLED_KEY ] ??
+		getSocialScriptData().settings?.socialPlugin?.social_notes_enabled
+	);
+} );
+
+/**
+ * Returns the Social Notes Config for the current site.
+ */
+export const getSocialNotesConfig = createRegistrySelector( select => () => {
+	const { getSite } = select( coreStore );
+
+	const settings = getSite( undefined, {
+		_fields: SOCIAL_NOTES_CONFIG_KEY,
+	} );
+
+	// If the settings are not available in the store yet, use the default settings.
+	return (
+		settings?.[ SOCIAL_NOTES_CONFIG_KEY ] ??
+		getSocialScriptData().settings?.socialPlugin?.social_notes_config
+	);
+} );
diff --git a/projects/js-packages/publicize-components/src/social-store/types.ts b/projects/js-packages/publicize-components/src/social-store/types.ts
@@ -132,6 +132,11 @@ export type UtmSettingsConfig = {
 	enabled: boolean;
 };
 
+export type SocialNotesConfig = {
+	append_link: boolean;
+	link_format: 'full_url' | 'shortlink' | 'permashortcitation';
+};
+
 export type SocialPluginSettings = {
 	publicize_active: boolean;
 	show_pricing_page: boolean;
@@ -145,4 +150,7 @@ export type SocialPluginSettings = {
 export type SocialSettingsFields = {
 	jetpack_social_image_generator_settings: SocialImageGeneratorConfig;
 	jetpack_social_utm_settings: UtmSettingsConfig;
+	[ 'jetpack-social-note' ]: boolean;
+	jetpack_social_notes_config: SocialNotesConfig;
+	[ 'jetpack-social_show_pricing_page' ]: boolean;
 };
diff --git a/projects/packages/publicize/changelog/refactor-social-note-settings-core b/projects/packages/publicize/changelog/refactor-social-note-settings-core
@@ -0,0 +1,4 @@
+Significance: minor
+Type: changed
+
+Refactored Social Note settings to use core
diff --git a/projects/packages/publicize/src/jetpack-social-settings/class-settings.php b/projects/packages/publicize/src/jetpack-social-settings/class-settings.php
@@ -16,6 +16,8 @@
  * This class is used to get and update Jetpack_Social_Settings.
  * Currently supported features:
  *      - Social Image Generator
+ *      - UTM Settings
+ *      - Social Notes
  */
 class Settings {
 	/**
@@ -37,6 +39,17 @@ class Settings {
 		'enabled' => false,
 	);
 
+	const NOTES_CONFIG = 'notes_config';
+
+	const DEFAULT_NOTES_CONFIG = array(
+		'append_link' => true,
+	);
+
+	// Legacy named options.
+	const JETPACK_SOCIAL_NOTE_CPT_ENABLED   = 'jetpack-social-note';
+	const JETPACK_SOCIAL_SHOW_PRICING_PAGE  = 'jetpack-social_show_pricing_page';
+	const NOTES_FLUSH_REWRITE_RULES_FLUSHED = 'jetpack_social_rewrite_rules_flushed';
+
 	/**
 	 * Feature flags. Each item has 3 keys because of the naming conventions:
 	 * - flag_name: The name of the feature flag for the option check.
@@ -154,6 +167,58 @@ public function register_settings() {
 			)
 		);
 
+		register_setting(
+			'jetpack_social',
+			self::JETPACK_SOCIAL_SHOW_PRICING_PAGE,
+			array(
+				'type'         => 'boolean',
+				'default'      => true,
+				'show_in_rest' => array(
+					'schema' => array(
+						'type' => 'boolean',
+					),
+				),
+			)
+		);
+
+		register_setting(
+			'jetpack_social',
+			self::JETPACK_SOCIAL_NOTE_CPT_ENABLED,
+			array(
+				'type'         => 'boolean',
+				'default'      => false,
+				'show_in_rest' => array(
+					'schema' => array(
+						'type' => 'boolean',
+					),
+				),
+			)
+		);
+
+		register_setting(
+			'jetpack_social',
+			self::OPTION_PREFIX . self::NOTES_CONFIG,
+			array(
+				'type'         => 'object',
+				'default'      => self::DEFAULT_NOTES_CONFIG,
+				'show_in_rest' => array(
+					'schema' => array(
+						'type'       => 'object',
+						'context'    => array( 'view', 'edit' ),
+						'properties' => array(
+							'append_link' => array(
+								'type' => 'boolean',
+							),
+							'link_format' => array(
+								'type' => 'string',
+								'enum' => array( 'full_url', 'shortlink', 'permashortcitation' ),
+							),
+						),
+					),
+				),
+			)
+		);
+
 		add_filter( 'rest_pre_update_setting', array( $this, 'update_settings' ), 10, 3 );
 	}
 
@@ -175,6 +240,24 @@ public function get_utm_settings() {
 		return get_option( self::OPTION_PREFIX . self::UTM_SETTINGS, self::DEFAULT_UTM_SETTINGS );
 	}
 
+	/**
+	 * Get the social notes config.
+	 *
+	 * @return array The social notes config.
+	 */
+	public function get_social_notes_config() {
+		return get_option( self::OPTION_PREFIX . self::NOTES_CONFIG, self::DEFAULT_NOTES_CONFIG );
+	}
+
+	/**
+	 * Get if the social notes feature is enabled.
+	 *
+	 * @return bool
+	 */
+	public function is_social_notes_enabled() {
+		return get_option( self::JETPACK_SOCIAL_NOTE_CPT_ENABLED, false );
+	}
+
 	/**
 	 * Get the current settings.
 	 *
@@ -253,10 +336,12 @@ public function get_initial_state() {
 	 */
 	public function update_settings( $updated, $name, $value ) {
 
+		// Social Image Generator.
 		if ( self::OPTION_PREFIX . self::IMAGE_GENERATOR_SETTINGS === $name ) {
 			return $this->update_social_image_generator_settings( $value );
 		}
 
+		// UTM Settings.
 		if ( self::OPTION_PREFIX . self::UTM_SETTINGS === $name ) {
 			$current_utm_settings = $this->get_utm_settings();
 
@@ -267,6 +352,22 @@ public function update_settings( $updated, $name, $value ) {
 			return update_option( self::OPTION_PREFIX . self::UTM_SETTINGS, array_replace_recursive( $current_utm_settings, $value ) );
 		}
 
+		// Social Notes.
+		if ( self::JETPACK_SOCIAL_NOTE_CPT_ENABLED === $name ) {
+			// Delete this option, so the rules get flushed in maybe_flush_rewrite_rules when the CPT is registered.
+			delete_option( self::NOTES_FLUSH_REWRITE_RULES_FLUSHED );
+			return update_option( self::JETPACK_SOCIAL_NOTE_CPT_ENABLED, (bool) $value );
+		}
+		if ( self::OPTION_PREFIX . self::NOTES_CONFIG === $name ) {
+			$old_config = $this->get_social_notes_config();
+			$new_config = array_merge( $old_config, $value );
+			return update_option( self::OPTION_PREFIX . self::NOTES_CONFIG, $new_config );
+		}
+
+		if ( self::JETPACK_SOCIAL_SHOW_PRICING_PAGE === $name ) {
+			return update_option( self::JETPACK_SOCIAL_SHOW_PRICING_PAGE, (int) $value );
+		}
+
 		return $updated;
 	}
 
diff --git a/projects/plugins/social/changelog/refactor-social-note-settings-core b/projects/plugins/social/changelog/refactor-social-note-settings-core
@@ -0,0 +1,4 @@
+Significance: minor
+Type: changed
+
+Refactored Social Note settings to use core
diff --git a/projects/plugins/social/src/class-jetpack-social.php b/projects/plugins/social/src/class-jetpack-social.php
@@ -245,14 +245,14 @@ public function set_social_admin_script_data( $data ) {
 
 		if ( $this->is_connected() ) {
 
-			$note = new Automattic\Jetpack\Social\Note();
+			$jetpack_social_settings = new Automattic\Jetpack\Publicize\Jetpack_Social_Settings\Settings();
 
 			$data['settings']['socialPlugin'] = array_merge(
 				$data['settings']['socialPlugin'],
 				array(
 					'show_pricing_page'    => self::should_show_pricing_page(),
-					'social_notes_enabled' => $note->enabled(),
-					'social_notes_config'  => $note->get_config(),
+					'social_notes_enabled' => $jetpack_social_settings->is_social_notes_enabled(),
+					'social_notes_config'  => $jetpack_social_settings->get_social_notes_config(),
 				)
 			);
 		}
@@ -284,8 +284,6 @@ public function initial_state() {
 			$jetpack_social_settings = new Automattic\Jetpack\Publicize\Jetpack_Social_Settings\Settings();
 			$initial_state           = $jetpack_social_settings->get_initial_state();
 
-			$note = new Automattic\Jetpack\Social\Note();
-
 			$state = array_merge(
 				$state,
 				array(
@@ -296,8 +294,8 @@ public function initial_state() {
 						'isEnhancedPublishingEnabled'    => $publicize->has_enhanced_publishing_feature(),
 						'dismissedNotices'               => Dismissed_Notices::get_dismissed_notices(),
 						'supportedAdditionalConnections' => $publicize->get_supported_additional_connections(),
-						'social_notes_enabled'           => $note->enabled(),
-						'social_notes_config'            => $note->get_config(),
+						'social_notes_enabled'           => $jetpack_social_settings->is_social_notes_enabled(),
+						'social_notes_config'            => $jetpack_social_settings->get_social_notes_config(),
 					),
 					'sharesData'      => $publicize->get_publicize_shares_info( Jetpack_Options::get_option( 'id' ) ),
 				),
diff --git a/projects/plugins/social/src/class-note.php b/projects/plugins/social/src/class-note.php
diff --git a/projects/plugins/social/src/class-rest-settings-controller.php b/projects/plugins/social/src/class-rest-settings-controller.php
diff --git a/projects/plugins/social/src/js/components/admin-page/index.jsx b/projects/plugins/social/src/js/components/admin-page/index.jsx
diff --git a/projects/plugins/social/src/js/components/pricing-page/index.js b/projects/plugins/social/src/js/components/pricing-page/index.js
diff --git a/projects/plugins/social/src/js/components/social-notes-toggle/index.tsx b/projects/plugins/social/src/js/components/social-notes-toggle/index.tsx
diff --git a/projects/plugins/social/tests/php/test-class-jetpack-social.php b/projects/plugins/social/tests/php/test-class-jetpack-social.php
