Change record status: 
Introduced in branch: 
8.x-1.x
Introduced in version: 
4.2.0
Description: 

What Changed

The ProductSettings event has been deprecated in Acquia Connector 4.2.0 and will be removed in version 5.0.0. This event previously allowed Acquia product modules to inject credential forms into the Acquia Connector settings page.

Deprecation timeline:

  • 4.2.0 - Event marked as deprecated, triggers deprecation notices
  • 5.0.0 - Event will be completely removed

What This Event Did

The ProductSettings event allowed product modules (like Acquia Search, Acquia Lift, etc.) to add their credential configuration forms to the unified Acquia Connector settings page at /admin/config/system/acquia-connector/credentials.

Example usage (now deprecated):

// This pattern is deprecated - DO NOT USE
$event = new ProductSettingsEvent($form, $form_state);
$this->eventDispatcher->dispatch(ProductSettingsEvent::EVENT_NAME, $event);

Why It's Deprecated

With the introduction of the Key module integration and PKS support, product credential management should now be handled through:

  • Key module - Centralized credential storage
  • Individual product configuration - Each product manages its own settings
  • PKS integration - Platform-level credential management

The unified credential form is no longer the recommended pattern.

Migration Path

If your module uses the ProductSettings event:

Use Key Module (Recommended)

  • Create Separate Configuration Form: move your product's credential form to its own configuration page
  • Use Acquia Key provider for your product credentials

Action Required

For module maintainers:

  1. Before Acquia Connector 5.0.0:
    • Remove all uses of ProductSettings event
    • Migrate to Key module or separate configuration forms
    • Update documentation for your module
  2. Test your changes:
    • Verify credential configuration still works
    • Test on Acquia Cloud and local environments
    • Ensure backward compatibility during transition

Deprecation notice appears when:
Your module dispatches or subscribes to the ProductSettings event. Update your code to eliminate these warnings.

Timeline

  • Now (4.2.0) - Deprecation warnings appear, event still functional
  • Future (5.0.0) - Event completely removed, will cause fatal errors if still in use

Recommended: Migrate away from this event as soon as possible.

Benefits of Migration

✅ Modern credential management - Use Key module best practices
✅ Better security - Centralized, encrypted credential storage
✅ Reduced coupling - Products manage their own configuration
✅ Future-proof - Aligned with Drupal and Acquia standards

Impacts: 
Site builders, administrators, editors
Module developers