Fix #config_target support for the ai_provider_configuration element (#3580935) · Issues · project / ai

Fix #config_target support for the ai_provider_configuration element

>>> [!note] Migrated issue   Reported by: [svendecabooter](https://www.drupal.org/user/35369) Related to !1342 >>> [Tracker] Update Summary: [One-line status update for stakeholders] Short Description: [One-line issue summary for stakeholders] Check-in Date: MM/DD/YYYY Metadata is used by the <a href="https://www.drupalstarforge.ai/" title="AI Tracker">AI Tracker.</a> Docs and additional fields <a href="https://www.drupalstarforge.ai/ai-dashboard/docs" title="AI Issue Tracker Documentation">here</a>. [/Tracker] <h3 id="summary-problem-motivation">Problem/Motivation</h3> The <code>ai_provider_configuration</code> form element <a href="https://www.drupal.org/project/ai/issues/3556181" title="Status: Closed (fixed)">#3556181: Create a form element for selecting providers</a> and the <code>ai.provider_config</code> schema type <a href="https://www.drupal.org/project/ai/issues/3552774" title="Status: Closed (fixed)">#3552774: Create linkable schema for providers</a> were designed to work together. In <a href="https://www.drupal.org/project/ai/issues/3552774" title="Status: Closed (fixed)">#3552774: Create linkable schema for providers</a> <a href="https://www.drupal.org/project/ai/issues/3552774#comment-16391026">comment #15</a>, @marcus_johansson described the intended workflow: <ol> <li>Set up the `ai_provider_configuration` form element in your form.</li> <li>Store the value using the `ai.provider_config` config schema.</li> <li>Load the configured provider using a helper method from the plugin manager.</li> </ol> However, step 2 doesn't work seamlessly because the form element and the schema use different value formats: Form element returns: <div class="codeblock"> <pre><?php [   'provider' => 'openai',   'model' => 'gpt-4.1',   'config' => ['temperature' => 0.7], ] ?></pre></div> Schema expects: <pre>use_default: false provider_id: openai model_id: gpt-4.1 configuration:   temperature: 0.7</pre>This means: <ul> <li>#config_target cannot be used with the ai_provider_configuration element, because ConfigFormBase::storeConfigKeyValueMap() would write the element's value (with provider/model/config keys) directly to config, which doesn't match the ai.provider_config schema (which expects use_default/provider_id/model_id/configuration keys). The element also sets '#default_value' => NULL in its getInfo(), which prevents ConfigFormBase::loadDefaultValuesFromConfig() from auto-populating the value.</li> <li>Every consumer module must manually translate between the two formats in submitForm() and when setting #default_value, adding error-prone boilerplate.</li> </ul> The documentation added in <a href="https://www.drupal.org/project/ai/issues/3556181" title="Status: Closed (fixed)">#3556181: Create a form element for selecting providers</a> (in ai_provider_configuration_element.md) even shows this manual translation in its "Saving to Configuration" example, confirming the gap. <h4 id="summary-steps-reproduce">Steps to reproduce (required for bugs, but not feature requests)</h4> <ol> <li>Create a ConfigFormBase with an ai_provider_configuration element.</li> <li>Try to use #config_target pointing at a config key with type: ai.provider_config.</li> <li>Observe that: <ul> <li>The default value is not auto-populated from config (because getInfo() sets #default_value => NULL).</li> <li>On submit, the wrong key names are written to config (provider instead of provider_id, etc.).</li> <li>The use_default boolean is never set.</li> </ul> </li> </ol> <h3 id="summary-proposed-resolution">Proposed resolution</h3> Add #config_target support to the ai_provider_configuration element by: <ol> <li>Adding a toConfig() static method that translates the element's provider/model/config value to the schema's use_default/provider_id/model_id/configuration format.</li> <li>Adding a fromConfig() static method that does the reverse (for populating #default_value from config).</li> <li>These can be used as the ConfigTarget callable pair, enabling:</li> </ol> <pre>'#config_target' => new ConfigTarget(   'my_module.settings',   'provider_config',   toConfig: [AiProviderConfiguration::class, 'toConfig'],   fromConfig: [AiProviderConfiguration::class, 'fromConfig'], ),</pre>Or another method to achieve the same mapping logic automatically. <h3 id="summary-remaining-tasks">Remaining tasks</h3> <ul> <li>Implement the translation layer or value format change</li> <li>Update the element's getInfo() so #default_value doesn't unconditionally block ConfigFormBase auto-population when #config_target is used</li> <li>Update documentation examples</li> <li>Add test coverage for #config_target usage with the element</li> </ul> <h3 id="summary-ai-usage">AI usage (if applicable)</h3> [ x ] AI Assisted Issue This issue was generated with AI assistance, but was reviewed and refined by the creator. [ x ] AI Generated Code This code was mainly generated by an AI with human guidance, and reviewed, tested, and refined by a human. > Related issue: [Issue #3552774](https://www.drupal.org/node/3552774) > Related issue: [Issue #3580948](https://www.drupal.org/node/3580948) > Related issue: [Issue #3580910](https://www.drupal.org/node/3580910)

issue