Create MVP UI for imports when background queue processing is taking place #25041
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
(Standard links)
|
eaee6b3 to
f748a01
Compare
colemanw
reviewed
Nov 25, 2022
Comment on lines
4
to
13
| var target = '#crm-import-progress'; | ||
| var url = CRM.vars.civiimport.url; | ||
| // Load the snippet into the container | ||
| CRM.loadPage(url, { | ||
| target: target, | ||
| block: false | ||
| }) | ||
| window.setInterval(function() { | ||
| CRM.$(target).crmSnippet('refresh'); | ||
| }, 1000); |
There was a problem hiding this comment.
JS code needs to be enclosed otherwise variables are in the global scope.
Suggested change
| var target = '#crm-import-progress'; | |
| var url = CRM.vars.civiimport.url; | |
| // Load the snippet into the container | |
| CRM.loadPage(url, { | |
| target: target, | |
| block: false | |
| }) | |
| window.setInterval(function() { | |
| CRM.$(target).crmSnippet('refresh'); | |
| }, 1000); | |
| CRM.$(function($) { | |
| var target = '#crm-import-progress'; | |
| var url = CRM.vars.civiimport.url; | |
| // Load the snippet into the container | |
| CRM.loadPage(url, { | |
| target: target, | |
| block: false | |
| }); | |
| window.setInterval(function() { | |
| $(target).crmSnippet('refresh'); | |
| }, 1000); | |
| }); |
There was a problem hiding this comment.
thanks @colemanw - I fixed this & retested it & it worked :-)
f748a01 to
342dde3
Compare
colemanw
reviewed
Nov 25, 2022
| block: false | ||
| }) | ||
| window.setInterval(function () { | ||
| CRM.$(target).crmSnippet('refresh'); |
There was a problem hiding this comment.
This is a lot of hits on the server. Best skip if the user isn't paying attention...
Suggested change
| CRM.$(target).crmSnippet('refresh'); | |
| if (document.hasFocus()) { | |
| CRM.$(target).crmSnippet('refresh'); | |
| } |
There was a problem hiding this comment.
ohh - good idea
342dde3 to
c4e1f8b
Compare
This gives us a usable monitoring page for imports, without having to plan out a solution that covers all potential use cases. It should be a quick way to get this functionality operational
c4e1f8b to
ccb52b0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Create acceptable UI for imports when background queue processing is taking place
BackGround queue processing requires three things
enable civi-import core extension
the setting to be enabled - eg.
drush @dmaster cvapi Setting.create enableBackgroundQueue=1a job to run in the background processing the queue. In build-kit environments running
coworker runfrom the site directory will generally workThe result of this is that the Import will run in the background and the user does not have to keep the browser tab open
Before
There is a placeholder screen
After
Technical Details
I decided to do an import-specific version of this in the import extension to avoid having to figure out larger issues around this & also to provide a space where the experience could be tailored to imports. This approach made removing this last blocker more manageable.
I think there is a lot of scope to improve wording but I left that out of scope for this commit. The main thing we probably want to communicate is that they can close the browser, bookmark the page & come back
Comments
The csv I used for testing is in this ext - https://github.com/eileenmcnaughton/testdata/tree/master/csvs