Skip to content

feat(#751): extensible settings — track handled keys, add filter, support github_pat #752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chubes4 merged 1 commit into from
Mar 9, 2026
Merged

feat(#751): extensible settings — track handled keys, add filter, support github_pat #752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 74 additions & 1 deletion inc/Abilities/SettingsAbilities.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,14 @@ private function registerUpdateSettings(): void {
'time_limit' => array( 'type' => 'integer' ),
),
),
'github_pat' => array(
'type' => 'string',
'description' => 'GitHub Personal Access Token for GitHub integration.',
),
'github_default_repo' => array(
'type' => 'string',
'description' => 'Default GitHub repository in owner/repo format.',
),
'network_settings' => array(
'type' => 'object',
'description' => 'Network-wide defaults (multisite). Keys: default_provider, default_model, agent_models.',
Expand Down Expand Up @@ -381,58 +389,71 @@ public function executeGetSettings( array $input ): array {

public function executeUpdateSettings( array $input ): array {
$all_settings = get_option( 'datamachine_settings', array() );
$handled_keys = array();

if ( isset( $input['cleanup_job_data_on_failure'] ) ) {
$all_settings['cleanup_job_data_on_failure'] = (bool) $input['cleanup_job_data_on_failure'];
$handled_keys[] = 'cleanup_job_data_on_failure';
}

if ( isset( $input['file_retention_days'] ) ) {
$days = absint( $input['file_retention_days'] );
$all_settings['file_retention_days'] = max( 1, min( 90, $days ) );
$handled_keys[] = 'file_retention_days';
}

if ( isset( $input['chat_retention_days'] ) ) {
$days = absint( $input['chat_retention_days'] );
$all_settings['chat_retention_days'] = max( 1, min( 365, $days ) );
$handled_keys[] = 'chat_retention_days';
}

if ( isset( $input['chat_ai_titles_enabled'] ) ) {
$all_settings['chat_ai_titles_enabled'] = (bool) $input['chat_ai_titles_enabled'];
$handled_keys[] = 'chat_ai_titles_enabled';
}

if ( isset( $input['alt_text_auto_generate_enabled'] ) ) {
$all_settings['alt_text_auto_generate_enabled'] = (bool) $input['alt_text_auto_generate_enabled'];
$handled_keys[] = 'alt_text_auto_generate_enabled';
}

if ( isset( $input['problem_flow_threshold'] ) ) {
$threshold = absint( $input['problem_flow_threshold'] );
$all_settings['problem_flow_threshold'] = max( 1, min( 10, $threshold ) );
$handled_keys[] = 'problem_flow_threshold';
}

if ( isset( $input['flows_per_page'] ) ) {
$flows_per_page = absint( $input['flows_per_page'] );
$all_settings['flows_per_page'] = max( 5, min( 100, $flows_per_page ) );
$handled_keys[] = 'flows_per_page';
}

if ( isset( $input['jobs_per_page'] ) ) {
$jobs_per_page = absint( $input['jobs_per_page'] );
$all_settings['jobs_per_page'] = max( 5, min( 100, $jobs_per_page ) );
$handled_keys[] = 'jobs_per_page';
}

if ( isset( $input['site_context_enabled'] ) ) {
$all_settings['site_context_enabled'] = (bool) $input['site_context_enabled'];
$handled_keys[] = 'site_context_enabled';
}

if ( isset( $input['daily_memory_enabled'] ) ) {
$all_settings['daily_memory_enabled'] = (bool) $input['daily_memory_enabled'];
$handled_keys[] = 'daily_memory_enabled';
}

if ( isset( $input['default_provider'] ) ) {
$all_settings['default_provider'] = sanitize_text_field( $input['default_provider'] );
$handled_keys[] = 'default_provider';
}

if ( isset( $input['default_model'] ) ) {
$all_settings['default_model'] = sanitize_text_field( $input['default_model'] );
$handled_keys[] = 'default_model';
}

if ( isset( $input['agent_models'] ) && is_array( $input['agent_models'] ) ) {
Expand All @@ -447,11 +468,13 @@ public function executeUpdateSettings( array $input ): array {
}
}
$all_settings['agent_models'] = $agent_models;
$handled_keys[] = 'agent_models';
}

if ( isset( $input['max_turns'] ) ) {
$turns = absint( $input['max_turns'] );
$all_settings['max_turns'] = max( 1, min( 50, $turns ) );
$handled_keys[] = 'max_turns';
}

if ( isset( $input['disabled_tools'] ) ) {
Expand All @@ -461,6 +484,7 @@ public function executeUpdateSettings( array $input ): array {
$all_settings['disabled_tools'][ sanitize_key( $tool_id ) ] = true;
}
}
$handled_keys[] = 'disabled_tools';
}

if ( isset( $input['ai_provider_keys'] ) && is_array( $input['ai_provider_keys'] ) ) {
Expand All @@ -477,6 +501,7 @@ public function executeUpdateSettings( array $input ): array {
}
}
apply_filters( 'chubes_ai_provider_api_keys', $current_keys );
$handled_keys[] = 'ai_provider_keys';
}

// Queue tuning settings for Action Scheduler
Expand All @@ -499,6 +524,18 @@ public function executeUpdateSettings( array $input ): array {
}

$all_settings['queue_tuning'] = $tuning;
$handled_keys[] = 'queue_tuning';
}

// GitHub integration settings.
if ( isset( $input['github_pat'] ) ) {
$all_settings['github_pat'] = sanitize_text_field( $input['github_pat'] );
$handled_keys[] = 'github_pat';
}

if ( isset( $input['github_default_repo'] ) ) {
$all_settings['github_default_repo'] = sanitize_text_field( $input['github_default_repo'] );
$handled_keys[] = 'github_default_repo';
}

// Network-wide defaults (requires super admin on multisite).
Expand Down Expand Up @@ -532,15 +569,51 @@ public function executeUpdateSettings( array $input ): array {
NetworkSettings::update( $network_values );
}
}
$handled_keys[] = 'network_settings';
}

/**
* Filter to allow extensions to handle their own settings keys.
*
* Extensions can modify $all_settings for keys they own and add
* those keys to $handled_keys so the CLI knows they were processed.
*
* @since 0.40.0
*
* @param array $all_settings Current settings array (will be saved to DB).
* @param array $input Raw input from the settings update request.
* @param array $handled_keys Keys already handled by core.
* @return array Associative array with 'settings' and 'handled_keys'.
*/
$filtered = apply_filters(
'datamachine_update_settings',
array(
'settings' => $all_settings,
'handled_keys' => $handled_keys,
),
$input
);

$all_settings = $filtered['settings'] ?? $all_settings;
$handled_keys = $filtered['handled_keys'] ?? $handled_keys;

update_option( 'datamachine_settings', $all_settings );
PluginSettings::clearCache();

return array(
// Identify unhandled keys so callers know if something was ignored.
$input_keys = array_keys( $input );
$unhandled = array_diff( $input_keys, $handled_keys );

$result = array(
'success' => true,
'message' => __( 'Settings saved successfully.', 'data-machine' ),
);

if ( ! empty( $unhandled ) ) {
$result['unhandled_keys'] = array_values( $unhandled );
}

return $result;
}

public function executeGetSchedulingIntervals( array $input ): array {
Expand Down
4 changes: 4 additions & 0 deletions inc/Cli/Commands/SettingsCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,10 @@ public function set( array $args, array $assoc_args ): void {
}

if ( $result['success'] ?? false ) {
$unhandled = $result['unhandled_keys'] ?? array();
if ( in_array( $key, $unhandled, true ) ) {
WP_CLI::error( "Setting '{$key}' is not a recognized setting key. It was not saved." );
}
WP_CLI::success( "Updated '{$key}': " . $this->format_value( $old_value ) . ' → ' . $this->format_value( $value ) );
} elseif ( $old_value === $value ) {
WP_CLI::warning( "Setting '{$key}' already has value: " . $this->format_value( $value ) );
Expand Down
73 changes: 73 additions & 0 deletions tests/Unit/Abilities/SettingsAbilitiesTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,79 @@ public function test_update_handler_defaults_returns_error_for_unknown_handler()
$this->assertStringContainsString( 'not found', $result['error'] );
}

public function test_update_settings_handles_github_pat(): void {
$result = $this->settings_abilities->executeUpdateSettings(
array( 'github_pat' => 'ghp_test123' )
);

$this->assertTrue( $result['success'] );
$this->assertArrayNotHasKey( 'unhandled_keys', $result );

$updated_settings = get_option( 'datamachine_settings', array() );
$this->assertSame( 'ghp_test123', $updated_settings['github_pat'] );
}

public function test_update_settings_handles_github_default_repo(): void {
$result = $this->settings_abilities->executeUpdateSettings(
array( 'github_default_repo' => 'Extra-Chill/data-machine' )
);

$this->assertTrue( $result['success'] );
$this->assertArrayNotHasKey( 'unhandled_keys', $result );

$updated_settings = get_option( 'datamachine_settings', array() );
$this->assertSame( 'Extra-Chill/data-machine', $updated_settings['github_default_repo'] );
}

public function test_update_settings_reports_unhandled_keys(): void {
$result = $this->settings_abilities->executeUpdateSettings(
array( 'totally_fake_key' => 'some_value' )
);

$this->assertTrue( $result['success'] );
$this->assertArrayHasKey( 'unhandled_keys', $result );
$this->assertContains( 'totally_fake_key', $result['unhandled_keys'] );
}

public function test_update_settings_no_unhandled_keys_for_known_settings(): void {
$result = $this->settings_abilities->executeUpdateSettings(
array(
'default_model' => 'gpt-4o',
'default_provider' => 'openai',
)
);

$this->assertTrue( $result['success'] );
$this->assertArrayNotHasKey( 'unhandled_keys', $result );
}

public function test_update_settings_extensible_via_filter(): void {
add_filter(
'datamachine_update_settings',
function ( $data, $input ) {
if ( isset( $input['custom_extension_key'] ) ) {
$data['settings']['custom_extension_key'] = sanitize_text_field( $input['custom_extension_key'] );
$data['handled_keys'][] = 'custom_extension_key';
}
return $data;
},
10,
2
);

$result = $this->settings_abilities->executeUpdateSettings(
array( 'custom_extension_key' => 'extension_value' )
);

$this->assertTrue( $result['success'] );
$this->assertArrayNotHasKey( 'unhandled_keys', $result );

$updated_settings = get_option( 'datamachine_settings', array() );
$this->assertSame( 'extension_value', $updated_settings['custom_extension_key'] );

remove_all_filters( 'datamachine_update_settings' );
}

public function test_permission_callback(): void {
wp_set_current_user( 0 );
add_filter( 'datamachine_cli_bypass_permissions', '__return_false' );
Expand Down
Loading