[META] Remove all usages of drupal_static() & drupal_static_reset()

This isn't a task unto itself per se, I think, but rather a side-effect of other work. Eg, the menu system needs to be turned into a proper set of objects (after routing it ripped out), and the statics eliminated as part of that. Simply creating objects somewhere that hold statics instead of them being inside functions buys us nothing.

HEAD has 93 calls to drupal_static()

Most of them in legacy procedural code that is actively being converted into service classes right now. In essence, those calls should "magically vanish" ;-)

However, for some strange reason, some drupal_static()s were taken over as-is into object-oriented code that is clean otherwise. For example, Drupal\Core\Cache\DatabaseBackend still maintains the state of cache tags via drupal_static().

In any case, these drupal_static()s (1) prevent us from properly using and leveraging the kernel and (2) harm tests.

Spoke with @alexpott in IRC, he said this did not qualify for a beta or release blocker, but agreed it should be a beta target.

The database backend should get fixed by #918538: Decouple cache tags from cache bins (it should have been converted to a static property of the class initially, but better to fix it properly in that issue).

static does not work because static survives test tearDown(), I tried that :)

changed issue summary to better reflect how to do the replacement.

@alexpott in IRC, he said this did not qualify for a beta or release blocker, but agreed it should be a beta target.

So how this issue fits into 8.0.x?

There's not really anything that can be done in itself here. There are 68 references to drupal_static() left in the code base. This is compared to 191 in Drupal 7.

During the 8.x cycle, we'll be able to move more code to classes/services, which will mean less drupal_static() calls, leaving procedural wrappers in for bc.

Then once core isn't using it, drupal_static() can be deprecated, then removed for 9.0.x.

Would it make sense to mark it deprecated now, slated for 9.x removal, so that contrib authors know to stop using it?

No I think we need to only mark things @deprecated when there is active work to replace them with a definite alternative. A lot of things got marked deprecated in the 8.x cycle without a viable replacement, most infamously url() and l(), and that led to nasty surprises later on. So when there are no uses of drupal_static() in core, or if all the usages are only in functions that are marked @deprecated themselves, let's mark it, but not before.

This issue was marked as a beta target for the 8.0.x beta, but is not applicable as an 8.1.x beta target, so untagging.

Added #3035288: Deprecate theme_get_setting() as child issue.

Added #3035297: Don't use drupal_static in AutoIncrementingTestItem.

Trying to revive this META. Fixing title, IS. Will open child issues.

Adding new child issues.

Added #3035343: Deprecate drupal_attach_tabledrag(). Move its logic in Table form element, #3035345: Remove usage of drupal_static_reset() from ContentTranslationOperationsTest and identifying more.

Adding #3035347: Remove usage of drupal_static_reset() from ContentTranslationTestBase, #3035349: Remove usage of drupal_static_reset() from EntityReferenceFieldTranslatedReferenceViewTest.

Added #3035352: [PP-1] Deprecate file_get_file_references(). Move the logic to file.usage service.

Adding #3035361: Remove usages of drupal_static() & drupal_static_reset() from file_test.module.

Adding #2536594: Add a FilterFormatRepository providing methods to load filter formats.

Added #3035376: Remove usage of drupal_static() from GetFilenameTest.

Adding #2081585: [META] Modernize the History module.

Added #3035518: Convert ImageEffectsTest & ToolkitTest into Kernel tests.

New child: #3036010: Fold drupal_get_updaters() into Updater class, deprecate drupal_get_updaters()

Another static should gone in #2908886: Split off schema management out of schema.inc

Added #3036962: Remove usage of drupal_static() from install_profile_info().

Added #3036982: Deprecate locale_translation_get_projects() and locale_translation_clear_cache_projects().

Added #2660338: locale_get_plural call in PluralTranslatableString is wrong.

New child: #3037054: Deprecate drupal_static_reset() without @trigger_error()

Added #3037031: Convert locale.compare.inc to a service.

Added #3037156: Locale import history service. Deprecate locale_translation_get_file_history(), locale_translation_update_file_history(), locale_translation_file_history_delete().

Added #3037202: Remove drupal_static() from node_mark().

Added #3038908: Deprecate node_access_view_all_nodes(). Move its functionality in NodeAccessControlHandlerInterface.

Added #2171397: Move options_allowed_values() to a method somewhere ?.

Added #2044435: Convert pager.inc to a service.

Added #3038963: Remove the usage of drupal_static() from search_dirty().

Added #2083123: Shortcut cleanup: Remove duplicated code and deprecate legacy functions.

Added #3038971: Move system_get_module_admin_tasks() into a service and deprecate it.

Added #3039039: Deprecate some procedural functions in taxonomy.module.

Added #3039051: Remove useless static cache reset and route rebuilding from TaxonomyTranslationTestTrait(s) & TaxonomyTermViewTest.

Added #3039055: Remove useless reset of taxonomy_term_count_nodes static cache.

Added #3039074: Remove drupal_static() from _update_manager_(unique_identifier|extract_directory|cache_directory).

Added #2340341: Move template_preprocess, _template_preprocess_default_variables into services.

Added #3039081: Remove reset of user_role static cache in UserRoleAdminTest::testRoleWeightOrdering().

Added #3039248: Deprecate views_ui_contextual_links_suppress(), views_ui_contextual_links_suppress_push(), views_ui_contextual_links_suppress_pop().

The inventory is over. There are still few cases that are falling in the scope of #3037054: Deprecate drupal_static_reset() without @trigger_error().

Updating the list by moving the finished issues to a new section.

We should wait with deprecations until we have a decision in #3047289: Standardize how we implement in-memory caches.

#2044435: Convert pager.inc to a service moved to fixed.

Replaced #3038963: Remove the usage of drupal_static() from search_dirty() with #3075703: Move search text processing to a service.

Updated the list.

#3039039: Deprecate some procedural functions in taxonomy.module is fixed.

#3035352: [PP-1] Deprecate file_get_file_references(). Move the logic to file.usage service is fixed.

Reverting wrong IS change.

#3037202: Remove drupal_static() from node_mark() is fixed.

#2412669: Remove drupal_static from BookManager is fixed.

I wanted to note that from reviewing a few related core/contrib isues like #2488458: remove calls to drupal_static(), I think we may be regressing on functionality that drupal_static() gave us.

I maintain Tome, a static site generator for Drupal, and one of the performance enhancements in that module is to perform multiple Drupal requests in one bootstrap (PHP process). Between requests, Tome performs a variety of operations to try to clear things in memory that were related to a previous request, and as a part of that calls drupal_static_reset(). See https://git.drupalcode.org/project/tome/-/blob/8.x-1.x/modules/tome_stat... for the full gory details. A goal of mine in the future is to contribute core patches for everything there that doesn't already use drupal_static() to use MemoryCache . For example I just found that \Drupal\views\Plugin\views\row\RssFields::render uses "static" where it should use drupal_static() or MemoryCache.

If core or contrib migrates usages of drupal_static() to storing things in protected variables or going back to using "static", it will make things a lot harder for me. Can we make sure that the guidance is to move to MemoryCache, not to come up with custom "cache in memory" implementations?

That's being discussed in #3047289: Standardize how we implement in-memory caches, we might even want to postpone this on that issue?

I agree with waiting until there is a standard replacement for drupal_static() which provides equivalent functionality and can be easily employed to replace the original API calls.

I'm really startled to observe that a lot of commits have been made replacing drupal_static() with plain PHP static! To my mind that is counter-productive and achieves nothing more than the removal of useful functionality.

I think those commits ought to be revisited once a new API is available so that they can be refitted with the new standard.

Per #86, setting this to Postponed pending #3047289: Standardize how we implement in-memory caches.

(And once that is resolved, the previous changes made for this issue ought to be reviewed.)