[pp-1] Deprecate locale_translation_get_projects() and locale_translation_clear_cache_projects()

Please remove composer changes from patch

+++ b/core/modules/locale/tests/src/Functional/LocaleUpdateTest.php
@@ -328,7 +328,7 @@ public function testEnableUninstallModule() {
+    $projects = $this->container->get('locale.project')->getProjects();

+++ b/core/modules/locale/tests/src/Kernel/LocaleTranslationProjectsTest.php
@@ -42,22 +42,22 @@ protected function setUp() {
+    $this->assertIdentical($expected, $this->container->get('locale.project')->getProjects());
...
+    $this->assertEqual($expected, $this->container->get('locale.project')->getProjects());
...
+    $this->assertEqual($expected, $this->container->get('locale.project')->getProjects());

please use \Drupal::service(), as there's no conclusion on this yet, this is recommended way to prevent issues on container rebuild in tests

Related discussion #2066993: Use magic methods to sync container property to \Drupal::getContainer in functional tests

1. +++ b/core/includes/install.core.inc
   @@ -1792,11 +1792,13 @@ function _install_prepare_import($langcodes, $server_pattern) {
   -          \Drupal::service('locale.project')->set($data['name'], $data);
   +          /** @var \Drupal\locale\LocaleProjectStorageInterface $locale_project_storage */
   +          $locale_project_storage = \Drupal::service('locale.project');
   +          $locale_project_storage->set($data['name'], $data);
              module_load_include('compare.inc', 'locale');
              // Reset project information static cache so that it uses the data
              // set above.
   -          locale_translation_clear_cache_projects();
   +          $locale_project_storage->resetCache();
   
   +++ b/core/modules/locale/locale.compare.inc
   @@ -80,10 +83,10 @@ function locale_translation_build_projects() {
   -    \Drupal::service('locale.project')->set($project->name, $data);
   +    $locale_project_storage->set($project->name, $data);
    
        // Invalidate the cache of translatable projects.
   -    locale_translation_clear_cache_projects();
   +    $locale_project_storage->resetCache();
   
   +++ b/core/modules/locale/tests/src/Kernel/LocaleTranslationProjectsTest.php
   @@ -42,22 +42,22 @@ protected function setUp() {
        $this->projectStorage->set('bar', []);
   -    locale_translation_clear_cache_projects();
   +    \Drupal::service('locale.project')->resetCache();
   

   btw reset cache only used when some data is set, so probably this method could be no-op and reset cache inside set()

2. +++ b/core/modules/locale/locale.translation.inc
   @@ -50,40 +50,27 @@
   + * @deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use
   ...
   +  @trigger_error('locale_translation_get_projects() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use \Drupal\locale\LocaleProjectStorageInterface::getProjects() instead. See https://www.drupal.org/node/3036986.', E_USER_DEPRECATED);
   ...
   + * @deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use
   ...
   +  @trigger_error('locale_translation_clear_cache_projects() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use \Drupal\locale\LocaleProjectStorageInterface::resetCache() instead. See https://www.drupal.org/node/3036986.', E_USER_DEPRECATED);
   
   +++ b/core/modules/locale/tests/src/Unit/LocaleProjectStorageTest.php
   @@ -0,0 +1,46 @@
   +   * @expectedDeprecation locale_translation_get_projects() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use \Drupal\locale\LocaleProjectStorageInterface::getProjects() instead. See https://www.drupal.org/node/3036986.
   ...
   +   * @expectedDeprecation locale_translation_clear_cache_projects() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use \Drupal\locale\LocaleProjectStorageInterface::resetCache() instead. See https://www.drupal.org/node/3036986.
   

   should be 8.8.0 now

+++ b/core/modules/locale/src/LocaleProjectStorage.php
@@ -166,4 +176,32 @@ public function getAll() {
+  public function getProjects(array $limit_to_projects = NULL) {
...
+      if ($row_count == 0) {
+        module_load_include('compare.inc', 'locale');
+        // At least the core project should be in the database, so we build the
+        // data if none are found.
+        locale_translation_build_projects();

Let's move it to private|protected method cos this will be refactored soon and makes this class unit testable

Move part which using to load inc file for constant and function

"deprecated in Drupal 8.8.0 " should be incremented to 9.1.0" and also changed to "and will be removed from Drupal 10". Kindly review a new patch.

Solving test case.

Probably this is great place for memory cache

The conversion to service methods is a good step. But in my opinion this patch makes it too complicated by mixing non-essential refactoring into it.

1. +++ b/core/includes/bootstrap.inc
   @@ -614,6 +614,12 @@ function &drupal_static($name, $default_value = NULL, $reset = FALSE) {
   +      @trigger_error("Using drupal_static_reset() with 'locale_translation_get_projects' as parameter is deprecated in Drupal 9.1.0 and will be removed in Drupal 10.0.0. See https://www.drupal.org/node/3036986.", E_USER_DEPRECATED);
   

   For this and other deprecation messages, Drupal version should be updated. Also the message pattern should follow https://www.drupal.org/project/coding_standards/issues/3024461.

2. +++ b/core/includes/install.core.inc
   @@ -1781,11 +1781,10 @@ function _install_prepare_import($langcodes, $server_pattern) {
   -          \Drupal::service('locale.project')->set($data['name'], $data);
   +          /** @var \Drupal\locale\LocaleProjectStorageInterface $locale_project_storage */
   +          $locale_project_storage = \Drupal::service('locale.project');
   +          $locale_project_storage->set($data['name'], $data);
   

   This refactoring is personal preference. Keep this refactoring out of this issue, it makes the patch harder to review.

3. +++ b/core/modules/locale/locale.compare.inc
   @@ -46,8 +46,11 @@ function locale_translation_build_projects() {
   +  /** @var \Drupal\locale\LocaleProjectStorageInterface $locale_project_storage */
   +  $locale_project_storage = \Drupal::service('locale.project');
   +
      // Mark all previous projects as disabled and store new project data.
   -  \Drupal::service('locale.project')->disableAll();
   +  $locale_project_storage->disableAll();
    
   

   This refactoring is personal preference. Keep it out of this issue, it makes review harder.

4. +++ b/core/modules/locale/locale.compare.inc
   @@ -80,10 +83,7 @@ function locale_translation_build_projects() {
   -    \Drupal::service('locale.project')->set($project->name, $data);
   

   Ditto

5. +++ b/core/modules/locale/src/LocaleProjectStorage.php
   @@ -98,6 +105,7 @@ public function setMultiple(array $data) {
   +    $this->cacheAsObjects = [];
   

   I'd rather see this replaced by a ::clearObjectCache() method. That will tell _why_ this line is there.

6. +++ b/core/modules/locale/src/LocaleProjectStorage.php
   @@ -166,4 +176,32 @@ public function getAll() {
   +      $this->cacheAsObjects = array_map(function ($project) {
   +        return (object) $project;
   +      }, $this->getAll());
   +    }
   

   This issue is not the place for this refactoring. It makes the issue more difficult to refactor.

7. +++ b/core/modules/locale/src/LocaleProjectStorage.php
   @@ -166,4 +176,32 @@ public function getAll() {
   +    // Limit to passed list, if case.
   +    if ($limit_to_projects) {
   +      return array_intersect_key($this->cacheAsObjects, array_flip($limit_to_projects));
   

   The comment and the variable name have changed. Do not refactor in this issue, it makes it harder to review.

8. +++ b/core/modules/locale/src/LocaleProjectStorageInterface.php
   @@ -99,4 +99,17 @@ public function resetCache();
   +   *
   +   * @param array|null $limit_to_projects
   +   *   (optional) If passed, the result will be filtered on this list.
   +   *
   +   * @return array
   +   *   Array of project data for translation update.
   +   *
   +   * @see locale_translation_build_projects()
   +   */
   +  public function getProjects(array $limit_to_projects = NULL);
   +
   

   A part of the comment got removed, the param description was changed, function signature (default value) was changed. This makes the patch harder to review.

Added reroll of patch #20 for Drupal 9.3.x.

Need to work on custom commands fails also.

Here I have tried to address the custom command fails of patch #26.

Also tried to address #25.1, 2, 3, and 4 points of comment #25.

Still needs work for remaining points.

I think this should be closed as a duplicate in favor of the newer one.

Usually we'd update the older one with more history, but I think there is a need to do the full file in one go since there are circular dependencies.

I'll just postpone this for now.

Thank you everyone for working on this. I'm going to close this as a duplicate since I think the other one will likely get in first.

All closed issues now grant credit and I've taken care of adding credit for contributions here thanks!

Typically we would use the older issue but somehow I missed this one when I searched and the other is nearly RTBC