Replace non-test usages of \Drupal::currentUser() with IoC injection

Changed \Drupal::currentUser() with the current_user service.

I was trying to inject the AccountProxyInterface in __constructor function of some class but got some error like this.

It would be very helpful if anyone can suggest me the right approach to resolve it.

@codersukanta, Thanks for working on this.

issue is not just replacing \Drupal::currentUser() with \Drupal::service('current_user') , but

It's to replace \Drupal::currentUser() and \Drupal::service('current_user') with IoC injection where possible.

Kindly see the Parent issue for more info.

Kindly review a patch.

@Hardik_Patel_12 I reviewed the patch and found some changes:

1. In BookAdminEditForm no need to inject the service you can simply use $this->currentUser() method that is already defined in Parent class FormBase.
2. ContentTranslationHandler is pending for Ioc injection. You have to simply use $this->currentUser->id() in getDefaultOwnerId() method.
3. FormTestVerticalTabsForm is also pending for Ioc injection, simply use $this->currentUser()->hasPermission('access vertical_tab_test tabs') in buildForm() method.

Points covered as suggested in #7 are as below.Following points are covered as suggested in #7

1. In BookAdminEditForm using $this->currentUser() method that is already defined in Parent class FormBase.
2. No need to replace \Drupal::currentUser() call with $this->currentUser() in getDefaultOwnerId() method because its a static method.
3. In FormTestVerticalTabsForm using $this->currentUser() in buildForm() method.

Kindly review a new patch.

@Hardik_Patel_12 thanks to clarifying. The patch #9 LGTM. Tested on local and it is working as expected, moving to RTBC.

+++ b/core/modules/comment/src/Plugin/views/field/NodeNewComments.php
@@ -66,12 +74,15 @@ public function usesGroupBy() {
+   * @param \Drupal\Core\Session\AccountInterface $current_user
+   *   The current user.
    */
-  public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $database, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager) {
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $database, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, AccountInterface $current_user) {
...
+    $this->currentUser = $current_user;

For BC in case someone has extended this in contrib we need to do the deprecation dance - i.e. allow the current user to be null and then use \Drupal service if it is and do @trigger_error(message, E_USER_DEPRECATED) - which means we need a change record too.

Adding change record and deprecation error also. Kindly review a new patch.

@Hardik_Patel_12 change records cannot be published until the issue is committed.

@kim.pepper , i am un-publishing change record thanks for your suggestion.

Attaching related issue.

I think there are a few more instances that can be injected:

grep -nri '\Drupal::currentUser()' core | grep -v .module | grep -vi test | grep -v .api.php | grep -v authorize.php

core//lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsWidgetBase.php:116:        ->getSettableOptions(\Drupal::currentUser());
core//lib/Drupal/Core/Form/FormBuilder.php:1415:      $this->currentUser = \Drupal::currentUser();
core//lib/Drupal/Core/TempStore/SharedTempStoreFactory.php:79:      $owner = \Drupal::currentUser()->id() ?: session_id();
core//modules/jsonapi/src/Context/FieldResolver.php:731:    $filter_access_results = $this->moduleHandler->invokeAll('jsonapi_entity_field_filter_access', [$field_definition, \Drupal::currentUser()]);
core//modules/locale/src/LocaleLookup.php:115:      $user = \Drupal::currentUser();

Re #17 I think some of these are going to be tricky.

core//lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsWidgetBase.php:116:        ->getSettableOptions(\Drupal::currentUser());

This is an abstract base class that doesn't yet implement create(), I think this is doable but with a careful BC layer? There are already concrete implementations that do have services injected with create(), so they would need BC too?

core//lib/Drupal/Core/Form/FormBuilder.php:1415:      $this->currentUser = \Drupal::currentUser();

This has a safeguard first in case the service doesn't exist, not sure why it was done this way - forms are used in the installer, is this too early for the current user service?

core//lib/Drupal/Core/TempStore/SharedTempStoreFactory.php:79:      $owner = \Drupal::currentUser()->id() ?: session_id();

This is also doable but would need a BC layer for the constructor.

core//modules/jsonapi/src/Context/FieldResolver.php:731:    $filter_access_results = $this->moduleHandler->invokeAll('jsonapi_entity_field_filter_access', [$field_definition, \Drupal::currentUser()]);

This would also need a BC layer.

core//modules/locale/src/LocaleLookup.php:115:      $user = \Drupal::currentUser();

This class is instantiated directly rather than being a service or using a factory, so I don't know if or how we can handle the case of BC for existing callers. I guess we can just use a similar null check in the constructor?