Fix flaky spec in autocomplete by alecslupu · Pull Request #13901 · decidim/decidim

alecslupu · 2025-01-22T19:02:29Z

🎩 What? Why?

While running the specs, we noticed that from time to time, we get some random failures on spec/lib/map/autocomplete_spec.rb.

While investigating, i have reached in Decidim::Map::Autocoplete::FormBuilder module, where the method geocoding_field can return a plain text field if the autocomplete utility is not properly configured.

decidim/decidim-core/lib/decidim/map/autocomplete.rb

Lines 85 to 106 in 878c512

    
           def geocoding_field(attribute, options = {}, geocoding_options = {}) 
        
             @autocomplete_utility ||= Decidim::Map.autocomplete( 
        
               organization: @template.current_organization 
        
             ) 
        
             return text_field(attribute, options) unless @autocomplete_utility 
        
             # Decidim::Map::Autocomplete::Builder 
        
             builder = @autocomplete_utility.create_builder( 
        
               @template, 
        
               geocoding_options 
        
             ) 
        
             options = merge_geocoding_options(attribute, options) 
        
             field(attribute, options) do |opts| 
        
               builder.geocoding_field( 
        
                 @object_name, 
        
                 attribute, 
        
                 opts 
        
               ) 
        
             end 
        
           end

Testing

This is kind of a test that is impossible to test locally, by just running the file, as the issue is being generated by runtime map configuration that is not coming from this file.
You can see in the pipeline that the spec has not been failing for 10 times while i have tested. ( please note the pipeline was still marked as failing as at the same time the download flacky spec kicked in, and i did not bother to fix )

📷 Screenshots

Please add screenshots of the changes you are proposing

♥️ Thank you!

andreslucena · 2025-01-23T08:09:22Z

Attempt - decidim-core/lib/decidim/map/autocomplete.rb

alecslupu · 2025-01-23T08:28:23Z

Attempt - decidim-core/lib/decidim/map/autocomplete.rb

andreslucena

I see lots of failures, but they come from the DownloadYourData feature, so we can ignore them:

* develop: (30 commits) Change hardcoded english in seeds (#13917) Allow importing accountability results from a Proposals component (#13817) Remove user interests (#13910) Move remaining categories from some resources to taxonomies (#13838) Fix translation issue on import projects mailer (#13894) Update DownloadYourData exports for decidim-debates (#13895) Allow admins to publish the questions' answers in surveys (#13786) Fix flaky spec in autocomplete (#13901) Refine taxonomy filters (part 2) (#13725) Fix single attachment with title (#13795) Fix incorrect breadcrumb encoding on mobile and tablet (#13891) Add string for unpublish survey admin log message (#13890) Fix ux meeting date location (#13872) New Crowdin updates (#13767) Fix deleted user error in schema (#13681) Remove assembly types from user interaction (#13881) Remove participatory process types from user interaction (#13880) Lock concurrent-ruby to 1.3.4 (#13879) Fix taxonomy serialization for export/imports (#13857) Adjust form upload label changes (#13836) ...

* Identify the Flacky spec * Attempt to fix the map * Revert logging * Fix geocoding

alecslupu added flaky spec type: fix PRs that implement a fix for a bug labels Jan 22, 2025

github-actions bot added the module: core label Jan 22, 2025

github-actions bot previously approved these changes Jan 22, 2025

View reviewed changes

Identify the Flacky spec

cd2d6e6

alecslupu dismissed github-actions[bot]’s stale review via cd2d6e6 January 22, 2025 19:25

alecslupu force-pushed the fix/attempt-to-fix-flaky branch from da154f3 to cd2d6e6 Compare January 22, 2025 19:25

github-actions bot previously approved these changes Jan 22, 2025

View reviewed changes

Attempt to fix the map

080bcb5

alecslupu dismissed github-actions[bot]’s stale review via 080bcb5 January 22, 2025 20:17

github-actions bot previously approved these changes Jan 22, 2025

View reviewed changes

Revert logging

ddc83ef

alecslupu dismissed github-actions[bot]’s stale review via ddc83ef January 22, 2025 20:29

github-actions bot previously approved these changes Jan 22, 2025

View reviewed changes

Fix geocoding

c71678a

alecslupu dismissed github-actions[bot]’s stale review via c71678a January 22, 2025 21:25

github-actions bot approved these changes Jan 22, 2025

View reviewed changes

alecslupu changed the title ~~Identify the Flacky spec~~ Flacky spec on autocomplete Jan 23, 2025

alecslupu marked this pull request as ready for review January 23, 2025 08:29

alecslupu requested a review from andreslucena January 23, 2025 08:29

alecslupu assigned andreslucena Jan 23, 2025

alecslupu changed the title ~~Flacky spec on autocomplete~~ Fix Flacky spec on autocomplete Jan 23, 2025

andreslucena changed the title ~~Fix Flacky spec on autocomplete~~ Fix flaky spec in autocomplete Jan 23, 2025

andreslucena approved these changes Jan 23, 2025

View reviewed changes

andreslucena merged commit b5c745f into develop Jan 23, 2025

andreslucena deleted the fix/attempt-to-fix-flaky branch January 23, 2025 10:50

alecslupu added release: v0.28 Issues or PRs that need to be tackled for v0.28 release: v0.29 Issues or PRs that need to be tackled for v0.29 labels Jan 23, 2025

This was referenced Jan 23, 2025

Backport 'Fix flaky spec in autocomplete' to v0.28 #13913

Merged

Backport 'Fix flaky spec in autocomplete' to v0.29 #13914

Merged

antopalidi pushed a commit to openpoke/decidim that referenced this pull request Feb 12, 2025

Fix flaky spec in autocomplete (decidim#13901)

8314bd0

* Identify the Flacky spec * Attempt to fix the map * Revert logging * Fix geocoding

andreslucena pushed a commit that referenced this pull request Mar 3, 2025

Fix flaky spec in autocomplete (#13901)

e7cb9d6

* Identify the Flacky spec * Attempt to fix the map * Revert logging * Fix geocoding

ahukkanen mentioned this pull request Mar 27, 2025

Improve the map specs in order to avoid random failures (deprecated) #14406

Closed

andreslucena mentioned this pull request May 12, 2025

Improve the map specs in order to avoid random failures #14679

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix flaky spec in autocomplete#13901

Fix flaky spec in autocomplete#13901
andreslucena merged 4 commits intodevelopfrom
fix/attempt-to-fix-flaky

alecslupu commented Jan 22, 2025 •

edited

Loading

Uh oh!

andreslucena commented Jan 23, 2025

Uh oh!

alecslupu commented Jan 23, 2025 •

edited

Loading

Uh oh!

andreslucena left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	def geocoding_field(attribute, options = {}, geocoding_options = {})
	@autocomplete_utility \|\|= Decidim::Map.autocomplete(
	organization: @template.current_organization
	)
	return text_field(attribute, options) unless @autocomplete_utility

	# Decidim::Map::Autocomplete::Builder
	builder = @autocomplete_utility.create_builder(
	@template,
	geocoding_options
	)

	options = merge_geocoding_options(attribute, options)

	field(attribute, options) do \|opts\|
	builder.geocoding_field(
	@object_name,
	attribute,
	opts
	)
	end
	end

Uh oh!

Conversation

alecslupu commented Jan 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎩 What? Why?

Testing

📷 Screenshots

Uh oh!

andreslucena commented Jan 23, 2025

Uh oh!

alecslupu commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andreslucena left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

alecslupu commented Jan 22, 2025 •

edited

Loading

alecslupu commented Jan 23, 2025 •

edited

Loading