Require organization in method (decidim#14683)

Co-authored-by: Fran Bolívar <francisco.bolivar@nazaries.com>
Co-authored-by: Andrés Pereira de Lucena <andreslucena@users.noreply.github.com>

Author: 3 people

RELEASE_NOTES.md

@@ -56,7 +56,27 @@ You can read more about this change on PR [\#XXXX](https://github.com/decidim/de
 
 ## 5. Changes in APIs
 
-### 5.1. [[TITLE OF THE CHANGE]]
+### 5.1. Require organization in nicknamize method
+
+In order to avoid potential performance issues, we have changed the `nicknamize` method by requiring the organization as a parameter.
+
+If you have used code as such:
+
+```ruby
+# We were including the organization in an optional scope
+Decidim::UserBaseEntity.nicknamize(nickname, decidim_organization_id: user.decidim_organization_id)
+```
+
+You need to change it, to something like:
+
+```ruby
+# Now the organization is the required second parameter of the method
+Decidim::UserBaseEntity.nicknamize(nickname, user.decidim_organization_id)
+```
+
+You can read more about this change on PR [#14669](https://github.com/decidim/decidim/pull/14669).
+
+### 5.2. [[TITLE OF THE CHANGE]]
 
 In order to [[REASONING (e.g. improve the maintenance of the code base)]] we have changed...
 

decidim-admin/app/controllers/decidim/admin/impersonations_controller.rb

@@ -99,7 +99,7 @@ def new_managed_user
           managed: true,
           name: params.dig(:impersonate_user, :name)
         ) do |u|
-          u.nickname = Decidim::UserBaseEntity.nicknamize(u.name, organization: current_organization)
+          u.nickname = Decidim::UserBaseEntity.nicknamize(u.name, current_organization.id)
           u.admin = false
           u.tos_agreement = true
         end

decidim-conferences/app/commands/decidim/conferences/admin/invite_user_to_join_conference.rb

@@ -79,7 +79,7 @@ def invite_user
             end
           else
             user.name = form.name
-            user.nickname = UserBaseEntity.nicknamize(user.name, organization: user.organization)
+            user.nickname = UserBaseEntity.nicknamize(user.name, user.decidim_organization_id)
             invite_user_to_sign_up
             create_invitation!
           end

decidim-core/app/commands/decidim/invite_user.rb

@@ -41,7 +41,7 @@ def invite_user
       @user = Decidim::User.new(
         name: form.name,
         email: form.email.downcase,
-        nickname: UserBaseEntity.nicknamize(form.name, organization: form.organization),
+        nickname: UserBaseEntity.nicknamize(form.name, form.organization.id),
         organization: form.organization,
         admin: form.role == "admin",
         roles: form.role == "admin" ? [] : [form.role].compact

decidim-core/app/forms/decidim/omniauth_registration_form.rb

@@ -25,7 +25,7 @@ def self.create_signature(provider, uid)
     end
 
     def normalized_nickname
-      UserBaseEntity.nicknamize(nickname || name, organization: current_organization)
+      UserBaseEntity.nicknamize(nickname || name, current_organization.id)
     end
   end
 end

decidim-core/app/forms/decidim/registration_form.rb

@@ -37,7 +37,7 @@ def email_unique_in_organization
     end
 
     def generate_nickname(name, organization)
-      Decidim::UserBaseEntity.nicknamize(name, organization:)
+      Decidim::UserBaseEntity.nicknamize(name, organization.id)
     end
 
     def valid_users

decidim-core/db/migrate/20171212103803_create_unique_nicknames.rb

@@ -11,7 +11,7 @@ def up
     add_column :decidim_users, :nickname, :string, limit: 20
 
     User.where.not(name: nil).find_each do |user|
-      user.update!(nickname: UserBaseEntity.nicknamize(user.name, decidim_organization_id: user.decidim_organization_id))
+      user.update!(nickname: UserBaseEntity.nicknamize(user.name, user.decidim_organization_id))
     end
 
     add_index :decidim_users,

decidim-core/db/migrate/20180221101934_fix_nickname_index.rb

@@ -11,7 +11,7 @@ def change
     User.where(nickname: nil)
         .where(deleted_at: nil)
         .where(managed: false)
-        .find_each { |u| u.update(nickname: UserBaseEntity.nicknamize(u.name, decidim_organization_id: u.decidim_organization_id)) }
+        .find_each { |u| u.update(nickname: UserBaseEntity.nicknamize(u.name, u.decidim_organization_id)) }
 
     # rubocop:disable Rails/SkipsModelValidations
     User.where(nickname: nil).update_all("nickname = ''")

decidim-core/db/migrate/20180706104107_add_nickname_to_managed_users.rb

@@ -7,7 +7,7 @@ class User < ApplicationRecord
 
   def up
     User.where(managed: true, nickname: nil).includes(:organization).find_each do |user|
-      user.nickname = UserBaseEntity.nicknamize(user.name, organization: user.organization)
+      user.nickname = UserBaseEntity.nicknamize(user.name, user.decidim_organization_id)
       user.save
     end
   end

decidim-core/db/migrate/20181001124950_move_users_groups_to_users_table.rb

@@ -64,7 +64,7 @@ def change
         verified_at: old_user_group.verified_at
       }
       new_attributes = clean_attributes.merge(
-        nickname: UserBaseEntity.nicknamize(clean_attributes["name"]),
+        nickname: UserBaseEntity.nicknamize(clean_attributes["name"], old_user_group.decidim_organization_id),
         extended_data:
       )
       new_user_group = NewUserGroup.create!(new_attributes)