Add a task to fix locale issues by microstudi · Pull Request #6510 · decidim/decidim

microstudi · 2020-09-09T16:55:05Z

🎩 What? Why?

In certain cases is necessary to manipulate locales of an organization through the database. This adds a new task namespace and some commands to solve common issues.
It also provides a new documentation file explaining the usage.

📋 Subtasks

Add documentation regarding the feature

mrcasals

Nice! I left a few suggestions

mrcasals · 2020-09-09T17:09:57Z

decidim-core/lib/tasks/decidim_locales_tasks.rake

+    desc "Rebuild the search index"
+    task rebuild_search: :environment do
+      Decidim::SearchableResource.destroy_all
+      Decidim::Searchable.searchable_resources.pluck(0).each do |resource|


Suggested change

Decidim::Searchable.searchable_resources.pluck(0).each do |resource|

Decidim::Searchable.searchable_resources.keys.each do |resource|

docs/advanced/fixing_locales.md

mrcasals · 2020-09-09T17:11:29Z

docs/advanced/fixing_locales.md

+bundle exec rake decidim:locales:sync_all
+```
+
+Run this task if you want have changed your `config/initializers/decidim.rb` `available_locales` or `default_locale` and you want to modify all the organizations so they have the same settings.


Suggested change

Run this task if you want have changed your `config/initializers/decidim.rb` `available_locales` or `default_locale` and you want to modify all the organizations so they have the same settings.

Run this task if you want to have changed `available_locales` or `default_locale` in your `config/initializers/decidim.rb` and you want to modify all the organizations so they have the same settings.

In here I've rephrase it.

mrcasals

Looks good to me!

mrcasals · 2020-09-10T07:36:03Z

decidim-core/lib/tasks/decidim_locales_tasks.rake

+    task rebuild_search: :environment do
+      Decidim::SearchableResource.destroy_all
+      Decidim::Searchable.searchable_resources.keys.each do |resource|
+        resource.constantize.all.each(&:try_update_index_for_search_resource)


Suggested change

resource.constantize.all.each(&:try_update_index_for_search_resource)

resource.constantize.find_each(&:try_update_index_for_search_resource)

This is more performant, memory-wise, as it loads the resources in chunks instead of all of them at the same time.

Also, the Decidim::Searchable.searchable_resources has the classes as values. I'm not sure if you're constantizing for some specific reason, but the whole block could be changed to this:

Decidim::Searchable.searchable_resources.values.each do |searchable_klass| searchable_klass.find_each(&:try_update_index_for_search_resource) end

oh, I don't even remember. I guess I saw the key and my brain executed a return!
Thanks for your insights! I'll make the changes!

If you prefer, you can just ignore these lastc hangees and keep only the find_each suggestion 😄

No, I like it. I'll continue in the afternoon, I have a busy morning.
Thinking out loud, we could add a task to add or remove a language from an organization and perform all the associated task for that organization.

microstudi · 2020-09-10T16:15:52Z

@mrcasals in the end, I've refactored a little to show more information when performing the task. Also changed some docs that where wrong. The result of both commands looks like this:

Decidim.available_locales is :es, :en, :ca:

mrcasals · 2020-09-14T06:53:37Z

@microstudi nice!! Good job!

I've restarted a teest run that failede, looked like some Ruby setup problem

Leusev

Looks fantastic for me @microstudi
Liked the idea about what you pointed out about to add some new tasks in order to add or remove a new language, since it is not a rare thing and it has also been requested on some occasion...
Thanks for your job 😄

Extracted from #6510

* Add a task to fix locale issues * spell fixes * print more information on the console and optimize code

Extracted from #6510

@ahukkanen

* Remove Markdown doc * Add documentation with Antora (AsciiDoc format - .adoc) Adds sections: * configure * customize * develop * install * services Also adds: * a README explaining the relationship with the documentation repository available in https://github.com/decidim/documentation * antora metadata file so we can build these sections in the same website * Fix Antora name for docs * Rename advanced pages to Concerns * Add Authorizations customize from module's README * Move 'add_authorizable_action' to 'permissions' * Move 'adding_fixtures_aka_dummy_content' to 'components' * Move 'how_to_create_a_module' to 'components' * Remove 'upgrading', now it's in 'update' * Install guide: fix error in 'whatever' gem (it's 'whenever') * Install guide: fix error in RAILS_ENV order in commands * Install guide: fix command for open_data export * Install guide: fix link to Contribution guide * Develop guide: add example apps * Architecture docs Add first version of c4model diagrams with PlantUML * https://c4model.com/ * https://plantuml.com/ * https://github.com/RicardoNiepel/C4-PlantUML * Add some explanation of modules types (with Components link) * Configure: ENV VARS and Initializer This moves ENV VARS configuration docs to its own page. We also create a new page for explaining Decidim's initializer settings (config/initializer/decidim.rb). For the moment is mostly a copy paste with nice formating, but the idea is to expand it. * Sync "Make maps actually configurable" by @ahukkanen Extracted from #6340 * Sync "Templates module" by @verarojman Extracted from #6247 * Sync "Configure Decidim Bulletin Board" by @leio10 Extracted from #6420 * Sync "Add a task to fix locale issues" by @microstudi Extracted from #6510 * Update versions in SECURITY.adoc * Convert CONTRIBUTING.md to AsciiDoc * Convert README.md to AsciiDoc * Clarify CONTRIBUTING and links to docs site * Remove Markdown linter CI * Sync "Update documentation for `decidim` OAuth social provider" by @tramuntanal Extracted from #6607 * Sync "Generate changelog entries" by @tramuntanal Extracted from #6794 * Fix link in oauth.adoc * Sync "Improve moderation panel" by @beagleknight Extracted from #6677 * Removes trailing whitespaces Co-authored-by: Oliver Valls <199462+tramuntanal@users.noreply.github.com>

Add a task to fix locale issues

de4c046

microstudi requested review from mrcasals and tramuntanal September 9, 2020 16:55

mrcasals previously approved these changes Sep 9, 2020

View reviewed changes

spell fixes

f47c02b

microstudi dismissed mrcasals’s stale review via f47c02b September 9, 2020 17:24

mrcasals previously approved these changes Sep 10, 2020

View reviewed changes

mrcasals reviewed Sep 10, 2020

View reviewed changes

print more information on the console and optimize code

6fe4bab

microstudi dismissed mrcasals’s stale review via 6fe4bab September 10, 2020 16:09

Leusev self-requested a review September 25, 2020 10:19

Leusev self-assigned this Sep 25, 2020

Leusev added in-review module: core team: documentation labels Sep 25, 2020

Leusev approved these changes Sep 25, 2020

View reviewed changes

Leusev merged commit 6731a77 into develop Sep 29, 2020

Leusev deleted the feature/fix-locales-tasks branch September 29, 2020 07:15

Leusev mentioned this pull request Oct 6, 2020

Convert technical docs to Antora #6526

Merged

1 task

andreslucena added a commit that referenced this pull request Oct 6, 2020

Sync "Add a task to fix locale issues" by @microstudi

d31e42c

Extracted from #6510

roxanaopr pushed a commit to i-need-another-coffee/decidim that referenced this pull request Oct 15, 2020

Add a task to fix locale issues (decidim#6510)

63a8ef0

* Add a task to fix locale issues * spell fixes * print more information on the console and optimize code

andreslucena added a commit that referenced this pull request Nov 19, 2020

Sync "Add a task to fix locale issues" by @microstudi

396d9b3

Extracted from #6510

	Decidim::Searchable.searchable_resources.pluck(0).each do \|resource\|
	Decidim::Searchable.searchable_resources.keys.each do \|resource\|

	Run this task if you want have changed your `config/initializers/decidim.rb` `available_locales` or `default_locale` and you want to modify all the organizations so they have the same settings.
	Run this task if you want to have changed `available_locales` or `default_locale` in your `config/initializers/decidim.rb` and you want to modify all the organizations so they have the same settings.

	resource.constantize.all.each(&:try_update_index_for_search_resource)
	resource.constantize.find_each(&:try_update_index_for_search_resource)

Uh oh!

Conversation

microstudi commented Sep 9, 2020

🎩 What? Why?

📋 Subtasks

Uh oh!

mrcasals left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrcasals left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

microstudi commented Sep 10, 2020

Uh oh!

mrcasals commented Sep 14, 2020

Uh oh!

Leusev left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants