Skip to content

Force option for either Basic or Advanced Query Builder #632

@edwinmp

Description

@edwinmp

Currently, under the Query Builder sidebar item we have 2 options: Basic Query Builder and Advanced Query Builder. The Basic Query Builder is soon to be deprecated (not sure when), but before that happens, we have to drive up the usage of it's replacement. Simply asking people to use the Advanced QB hasn't yielded results, so we're going to force the choice.

  • Remove the multiple option dropdown for the Query Builder and simply have the Query Builder item.
  • On clicking Query Builder, show a modal that offers the option Basic or Advanced with the Advanced selected by default.
  • For each option selected in the modal above, show some info about each one (to be decided later - just show a description that makes sense for now)
  • Naturally, depending on the selected option, you get redirected to the matching QB

To not make things difficult for our users, we're going to need to give them the option to choose a default QB i.e. a remember my choice kind of thing.

  • Add a preference app & in its models.py file, add a Preference model that inherits from BaseEntity
  • Add the field preferences to the Preference model, a JSONField - give it the default value (from a variable) {"queryBuilder": "advanced"}
  • Add the field global to the Preference model - a boolean field - give it a default value False - this naturally separates global preferences from user preferences. Make sure that in the Django admin, we can filter Preferences by this global field
  • Create an API endpoint for retrieving a user's preferences. Return both the global & user preferences (if any - default {}) - return object in format { global: {}, user: {} }
  • On the same view for retrieving, add one for updating preferences - naturally takes in a JSON object of the update preferences
  • On the FE, fetch these preferences on user login and save them in the local storage
  • When user clicks on Query Builder, check user preferences for preferred query builder - if none, show them the choice modal
  • Add a checkbox in the choice modal for Remember my choice - when checked, update user preferences with the selected option i.e basic or advanced

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions