Skip to content
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.

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

Implement dependency resolution for services #6484

Merged
merged 16 commits into from
Aug 4, 2021
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
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
17 changes: 9 additions & 8 deletions .phpstorm.meta.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@
'admin.onboarding_menu' => \AmpProject\AmpWP\Admin\OnboardingWizardSubmenu::class,
'admin.onboarding_wizard' => \AmpProject\AmpWP\Admin\OnboardingWizardSubmenuPage::class,
'admin.options_menu' => \AmpProject\AmpWP\Admin\OptionsMenu::class,
'admin.polyfills' => \AmpProject\AmpWP\Admin\Polyfills::class,
'admin.paired_browsing' => \AmpProject\AmpWP\Admin\PairedBrowsing::class,
'admin.validation_counts' => \AmpProject\AmpWP\Admin\ValidationCounts::class,
'admin.plugin_row_meta' => \AmpProject\AmpWP\Admin\PluginRowMeta::class,
'admin.polyfills' => \AmpProject\AmpWP\Admin\Polyfills::class,
'admin.validation_counts' => \AmpProject\AmpWP\Admin\ValidationCounts::class,
'amp_slug_customization_watcher' => \AmpProject\AmpWP\AmpSlugCustomizationWatcher::class,
'background_task_deactivator' => \AmpProject\AmpWP\BackgroundTask\BackgroundTaskDeactivator::class,
'cli.command_namespace' => \AmpProject\AmpWP\CliCli\CommandNamespaceRegistration::class,
'cli.optimizer_command' => \AmpProject\AmpWP\CliCli\OptimizerCommand::class,
'cli.transformer_command' => \AmpProject\AmpWP\CliCli\TransformerCommand::class,
Expand All @@ -33,26 +34,26 @@
'editor.editor_support' => \AmpProject\AmpWP\Editor\EditorSupport::class,
'extra_theme_and_plugin_headers' => \AmpProject\AmpWP\ExtraThemeAndPluginHeaders::class,
'injector' => \AmpProject\AmpWP\Infrastructure\Injector::class,
'loading_error' => \AmpProject\AmpWP\LoadingError::class,
'mobile_redirection' => \AmpProject\AmpWP\MobileRedirection::class,
'obsolete_block_attribute_remover' => \AmpProject\AmpWP\ObsoleteBlockAttributeRemover::class,
'optimizer' => \AmpProject\AmpWP\Optimizer\OptimizerService::class,
'optimizer.hero_candidate_filtering' => \AmpProject\AmpWP\Optimizer\HeroCandidateFiltering::class,
'paired_routing' => \AmpProject\AmpWP\PairedRouting::class,
'paired_url' => \AmpProject\AmpWP\PairedUrl::class,
'plugin_activation_notice' => \AmpProject\AmpWP\Admin\PluginActivationNotice::class,
'plugin_registry' => \AmpProject\AmpWP\PluginRegistry::class,
'plugin_suppression' => \AmpProject\AmpWP\PluginSuppression::class,
'reader_theme_loader' => \AmpProject\AmpWP\ReaderThemeLoader::class,
'reader_theme_support_features' => \AmpProject\AmpWP\ReaderThemeSupportFeatures::class,
'rest.options_controller' => \AmpProject\AmpWP\OptionsRESTController::class,
'rest.validation_counts_controller' => \AmpProject\AmpWP\Validation\ValidationCountsRestController::class,
'save_post_validation_event' => \AmpProject\AmpWP\Validation\SavePostValidationEvent::class,
'server_timing' => \AmpProject\AmpWP\Instrumentation\ServerTiming::class,
'site_health_integration' => \AmpProject\AmpWP\Admin\SiteHealth::class,
'validated_url_stylesheet_gc' => \AmpProject\AmpWP\BackgroundTask\ValidatedUrlStylesheetDataGarbageCollection::class,
'url_validation_cron' => \AmpProject\AmpWP\Validation\URLValidationCron::class,
'save_post_validation_event' => \AmpProject\AmpWP\Validation\SavePostValidationEvent::class,
'background_task_deactivator' => \AmpProject\AmpWP\BackgroundTask\BackgroundTaskDeactivator::class,
'paired_routing' => \AmpProject\AmpWP\PairedRouting::class,
'paired_url' => \AmpProject\AmpWP\PairedUrl::class,
'loading_error' => \AmpProject\AmpWP\LoadingError::class,
'url_validation_rest_controller' => \AmpProject\AmpWP\Validation\URLValidationRESTController::class,
'validated_url_stylesheet_gc' => \AmpProject\AmpWP\BackgroundTask\ValidatedUrlStylesheetDataGarbageCollection::class,
] )
);

Expand Down
5 changes: 0 additions & 5 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
# See documentation at https://docs.codecov.io/docs/codecovyml-reference

codecov:
notify:
# Wait for Jest & PHPUnit $ Behat reports before notifying
after_n_builds: 3

Comment on lines -3 to -7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this no longer needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codecov waits for all 3 coverage reports before posting the summary for the PR; problem is that we are now skipping some PR checks which means it's no longer guaranteed 3 coverage reports will be uploaded, so Codecov will be waiting for reports that it will potentially never receive.

coverage:
status:
# Patch-level coverage (how well is the PR tested)
Expand Down
14 changes: 13 additions & 1 deletion src/Admin/PairedBrowsing.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use AMP_Validation_Manager;
use AMP_Validated_URL_Post_Type;
use AmpProject\AmpWP\Infrastructure\Conditional;
use AmpProject\AmpWP\Infrastructure\HasRequirements;
use AmpProject\AmpWP\Infrastructure\Registerable;
use AmpProject\AmpWP\Infrastructure\Service;
use AmpProject\AmpWP\Option;
Expand All @@ -29,7 +30,7 @@
* @since 2.1
* @internal
*/
final class PairedBrowsing implements Service, Registerable, Conditional {
final class PairedBrowsing implements Service, Registerable, Conditional, HasRequirements {

/**
* Query var for requests to open the app.
Expand Down Expand Up @@ -73,6 +74,17 @@ public static function is_needed() {
);
}

/**
* Get the list of service IDs required for this service to be registered.
*
* @return string[] List of required services.
*/
public static function get_requirements() {
return [
'dependency_support',
];
}

/**
* PairedBrowsing constructor.
*
Expand Down
14 changes: 13 additions & 1 deletion src/Admin/Polyfills.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

use AmpProject\AmpWP\Infrastructure\Conditional;
use AmpProject\AmpWP\Infrastructure\Delayed;
use AmpProject\AmpWP\Infrastructure\HasRequirements;
use AmpProject\AmpWP\Infrastructure\Registerable;
use AmpProject\AmpWP\Infrastructure\Service;
use AmpProject\AmpWP\Services;
Expand All @@ -23,7 +24,7 @@
* @since 2.0
* @internal
*/
final class Polyfills implements Conditional, Delayed, Service, Registerable {
final class Polyfills implements Conditional, Delayed, Service, Registerable, HasRequirements {

/**
* Get the action to use for registering the service.
Expand All @@ -43,6 +44,17 @@ public static function is_needed() {
return ! Services::get( 'dependency_support' )->has_support();
}

/**
* Get the list of service IDs required for this service to be registered.
*
* @return string[] List of required services.
*/
public static function get_requirements() {
return [
'dependency_support',
];
}

/**
* Runs on instantiation.
*/
Expand Down
15 changes: 14 additions & 1 deletion src/Admin/ValidationCounts.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

use AmpProject\AmpWP\Infrastructure\Conditional;
use AmpProject\AmpWP\Infrastructure\Delayed;
use AmpProject\AmpWP\Infrastructure\HasRequirements;
use AmpProject\AmpWP\Infrastructure\Registerable;
use AmpProject\AmpWP\Infrastructure\Service;
use AmpProject\AmpWP\Services;
Expand All @@ -20,7 +21,7 @@
* @since 2.1
* @internal
*/
final class ValidationCounts implements Service, Registerable, Conditional, Delayed {
final class ValidationCounts implements Service, Registerable, Conditional, Delayed, HasRequirements {

/**
* Assets handle.
Expand All @@ -38,6 +39,18 @@ public static function get_registration_action() {
return 'admin_enqueue_scripts';
}

/**
* Get the list of service IDs required for this service to be registered.
*
* @return string[] List of required services.
*/
public static function get_requirements() {
return [
'dependency_support',
'dev_tools.user_access',
];
}

/**
* Check whether the conditional object is currently needed.
*
Expand Down
20 changes: 10 additions & 10 deletions src/AmpWpPlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,23 +67,24 @@ final class AmpWpPlugin extends ServiceBasedPlugin {
* @var string[]
*/
const SERVICES = [
'dependency_support' => DependencySupport::class, // Needs to be registered first as other services depend on it.
'admin.analytics_menu' => Admin\AnalyticsOptionsSubmenu::class,
'admin.google_fonts' => Admin\GoogleFonts::class,
'admin.onboarding_menu' => Admin\OnboardingWizardSubmenu::class,
'admin.onboarding_wizard' => Admin\OnboardingWizardSubmenuPage::class,
'admin.options_menu' => Admin\OptionsMenu::class,
'admin.polyfills' => Admin\Polyfills::class,
'admin.paired_browsing' => Admin\PairedBrowsing::class,
'admin.validation_counts' => Admin\ValidationCounts::class,
'admin.plugin_row_meta' => Admin\PluginRowMeta::class,
'admin.polyfills' => Admin\Polyfills::class,
'admin.validation_counts' => Admin\ValidationCounts::class,
'amp_slug_customization_watcher' => AmpSlugCustomizationWatcher::class,
'background_task_deactivator' => BackgroundTaskDeactivator::class,
'cli.command_namespace' => Cli\CommandNamespaceRegistration::class,
'cli.optimizer_command' => Cli\OptimizerCommand::class,
'cli.transformer_command' => Cli\TransformerCommand::class,
'cli.validation_command' => Cli\ValidationCommand::class,
'css_transient_cache.ajax_handler' => Admin\ReenableCssTransientCachingAjaxAction::class,
'css_transient_cache.monitor' => BackgroundTask\MonitorCssTransientCaching::class,
'dependency_support' => DependencySupport::class,
'dev_tools.block_sources' => DevTools\BlockSources::class,
'dev_tools.callback_reflection' => DevTools\CallbackReflection::class,
'dev_tools.error_page' => DevTools\ErrorPage::class,
Expand All @@ -92,27 +93,26 @@ final class AmpWpPlugin extends ServiceBasedPlugin {
'dev_tools.user_access' => DevTools\UserAccess::class,
'editor.editor_support' => Editor\EditorSupport::class,
'extra_theme_and_plugin_headers' => ExtraThemeAndPluginHeaders::class,
'loading_error' => LoadingError::class,
'mobile_redirection' => MobileRedirection::class,
'obsolete_block_attribute_remover' => ObsoleteBlockAttributeRemover::class,
'optimizer' => OptimizerService::class,
'optimizer.hero_candidate_filtering' => HeroCandidateFiltering::class,
'paired_routing' => PairedRouting::class,
'paired_url' => PairedUrl::class,
'plugin_activation_notice' => Admin\PluginActivationNotice::class,
'plugin_registry' => PluginRegistry::class,
'plugin_suppression' => PluginSuppression::class,
'reader_theme_loader' => ReaderThemeLoader::class,
'reader_theme_support_features' => ReaderThemeSupportFeatures::class,
'rest.options_controller' => OptionsRESTController::class,
'rest.validation_counts_controller' => Validation\ValidationCountsRestController::class,
'save_post_validation_event' => SavePostValidationEvent::class,
'server_timing' => Instrumentation\ServerTiming::class,
'site_health_integration' => Admin\SiteHealth::class,
'validated_url_stylesheet_gc' => BackgroundTask\ValidatedUrlStylesheetDataGarbageCollection::class,
'url_validation_rest_controller' => Validation\URLValidationRESTController::class,
'url_validation_cron' => URLValidationCron::class,
'save_post_validation_event' => SavePostValidationEvent::class,
'background_task_deactivator' => BackgroundTaskDeactivator::class,
'paired_routing' => PairedRouting::class,
'paired_url' => PairedUrl::class,
'loading_error' => LoadingError::class,
'url_validation_rest_controller' => Validation\URLValidationRESTController::class,
'validated_url_stylesheet_gc' => BackgroundTask\ValidatedUrlStylesheetDataGarbageCollection::class,
];

/**
Expand Down
27 changes: 27 additions & 0 deletions src/Infrastructure/HasRequirements.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php
/**
* Interface HasRequirements.
*
* @package AmpProject\AmpWP
*/

namespace AmpProject\AmpWP\Infrastructure;

/**
* Something that requires other services to be registered before it can be registered.
*
* A class marked as having requirements can return the list of services it requires
* to be available before it can be registered.
*
* @since 2.2
* @internal
*/
interface HasRequirements {

/**
* Get the list of service IDs required for this service to be registered.
*
* @return string[] List of required services.
*/
public static function get_requirements();
}
Loading