-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add config_source field to data sources config
- Added a field `config_source` which would denote where the data source config is coming from - code or storage (stored in wp_options). - Added a DataSourceConfigManager class to abstract cruds for data sources managed in various sources.
- Loading branch information
1 parent
64af67d
commit abc47af
Showing
9 changed files
with
200 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace RemoteDataBlocks\Config\DataSource; | ||
|
|
||
| use RemoteDataBlocks\Editor\BlockManagement\ConfigStore; | ||
| use RemoteDataBlocks\WpdbStorage\DataSourceCrud; | ||
| use WP_Error; | ||
|
|
||
| class DataSourceConfigManager { | ||
| public const CONFIG_SOURCE_CODE = 'code'; | ||
| public const CONFIG_SOURCE_STORAGE = 'storage'; | ||
| public const MUTABLE_CONFIG_SOURCES = [ self::CONFIG_SOURCE_STORAGE ]; | ||
|
|
||
| private static function get_all_from_storage(): array { | ||
| return array_map( | ||
| fn ( array $config ) => array_merge( $config, [ 'config_source' => self::CONFIG_SOURCE_STORAGE ] ), | ||
| DataSourceCrud::get_configs() | ||
| ); | ||
| } | ||
|
|
||
| private static function get_all_from_code(): array { | ||
| return array_map( | ||
| fn ( array $config ) => array_merge( $config, [ 'config_source' => self::CONFIG_SOURCE_CODE ] ), | ||
| ConfigStore::get_data_sources_as_array() | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Get all data sources from all origins. | ||
| * | ||
| * @return array<array{ | ||
| * uuid?: string, | ||
| * service: string, | ||
| * service_config: array<string, mixed>, | ||
| * config_source: string, | ||
| * __metadata?: array{ | ||
| * created_at: string, | ||
| * updated_at: string | ||
| * } | ||
| * }> | ||
| */ | ||
| public static function get_all(): array { | ||
| $code_configured = self::get_all_from_code(); | ||
| $storage_configured = self::get_all_from_storage(); | ||
|
|
||
| /** | ||
| * Quick and dirty de-duplication of data sources. If the data source does | ||
| * not have a UUID (because it is registered in code), we generate an | ||
| * identifier based on the display name and service name. | ||
| * | ||
| * Storage configured data sources take precedence over code configured ones | ||
| * here due to the ordering of the two arrays passed to array_reduce. | ||
| */ | ||
| return array_values( array_reduce( | ||
| array_merge( $code_configured, $storage_configured ), | ||
| function ( array $acc, array $item ) { | ||
| $identifier = $item['uuid'] ?? md5( sprintf( '%s_%s', $item['service_config']['display_name'], $item['service'] ) ); | ||
| $acc[ $identifier ] = $item; | ||
| return $acc; | ||
| }, | ||
| [] | ||
| ) ); | ||
| } | ||
|
|
||
| /** | ||
| * Get a data source by its UUID. | ||
| * | ||
| * @param string $uuid The UUID of the data source to get. | ||
| * @return array{ | ||
| * uuid: string, | ||
| * service: string, | ||
| * service_config: array<string, mixed>, | ||
| * config_source: string, | ||
| * __metadata?: array{ | ||
| * created_at: string, | ||
| * updated_at: string | ||
| * } | ||
| * }|WP_Error | ||
| */ | ||
| public static function get( string $uuid ): array|WP_Error { | ||
| // Currently only storage-configured data sources are supported. | ||
| $from_storage = DataSourceCrud::get_config_by_uuid( $uuid ); | ||
|
|
||
| if ( is_wp_error( $from_storage ) ) { | ||
| return new WP_Error( | ||
| 'data_source_not_found', | ||
| __( 'Data source not found', 'remote-data-blocks' ), | ||
| [ 'status' => 404 ] | ||
| ); | ||
| } | ||
|
|
||
| return array_merge( $from_storage, [ 'config_source' => self::CONFIG_SOURCE_STORAGE ] ); | ||
| } | ||
|
|
||
| /** | ||
| * Create a new data source. | ||
| * | ||
| * @param array $config The configuration for the new data source. | ||
| * @return array{ | ||
| * uuid: string, | ||
| * service: string, | ||
| * service_config: array<string, mixed>, | ||
| * config_source: string, | ||
| * __metadata: array{ | ||
| * created_at: string, | ||
| * updated_at: string | ||
| * } | ||
| * }|WP_Error | ||
| */ | ||
| public static function create( array $config ): array|WP_Error { | ||
| $result = DataSourceCrud::create_config( $config ); | ||
| if ( is_wp_error( $result ) ) { | ||
| return $result; | ||
| } | ||
|
|
||
| return array_merge( $result, [ 'config_source' => self::CONFIG_SOURCE_STORAGE ] ); | ||
| } | ||
|
|
||
| /** | ||
| * Update a data source. | ||
| * | ||
| * @param string $uuid The UUID of the data source to update. | ||
| * @param array $config The new configuration for the data source. | ||
| * @return array{ | ||
| * uuid: string, | ||
| * service: string, | ||
| * service_config: array<string, mixed>, | ||
| * config_source: string, | ||
| * __metadata: array{ | ||
| * created_at: string, | ||
| * updated_at: string | ||
| * } | ||
| * }|WP_Error | ||
| */ | ||
| public static function update( string $uuid, array $config ): array|WP_Error { | ||
| if ( isset( $config['config_source'] ) && ! in_array( $config['config_source'], self::MUTABLE_CONFIG_SOURCES, true ) ) { | ||
| /** | ||
| * Only storage-configured data sources are mutable. | ||
| */ | ||
| return new WP_Error( | ||
| 'cannot_update_config', | ||
| __( 'Cannot update a data source with this config_source', 'remote-data-blocks' ), | ||
| [ 'status' => 400 ] | ||
| ); | ||
| } | ||
|
|
||
| $result = DataSourceCrud::update_config_by_uuid( $uuid, $config ); | ||
| if ( is_wp_error( $result ) ) { | ||
| return $result; | ||
| } | ||
|
|
||
| return array_merge( $result, [ 'config_source' => self::CONFIG_SOURCE_STORAGE ] ); | ||
| } | ||
|
|
||
| /** | ||
| * Delete a data source. | ||
| * | ||
| * @param string $uuid The UUID of the data source to delete. | ||
| * @return true|WP_Error True on success, WP_Error on failure. | ||
| */ | ||
| public static function delete( string $uuid ): bool|WP_Error { | ||
| return DataSourceCrud::delete_config_by_uuid( $uuid ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters