mistic100 / mistic100/jQuery-QueryBuilder

Error in .on('rulesChanged.queryBuilder') function when calling getRules

Open
#833 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
JavaScript
Stars
1.7k
Forks
544
PR merge metrics
No merged PRs in 30d

Description

Plugin initializes normally, and can load previously saved rules at initialization without problem.

I've added an auto-save feature using the "rulesChanged.queryBuilder API Event as follows:

$('#queryBuilder').on('rulesChanged.queryBuilder', function(evt) {
        const blockRules = $('#queryBuilder').queryBuilder('getRules')
        console.log('Rule Changed!', blockRules)
        if (blockRules) {
            //Save the rule
            //saveRules function here
        }
    })

The problem arises if I try to clear or change the ruleset on an already initialized queryBuilder:

$('#queryBuilder').queryBuilder('clear')

or

$('#queryBuilder').queryBuilder('setRules', rules, true)

Either of the calls above will trigger the rulesChanged event, resulting in the getRules method crashing with the error:

/node_modules/jQuery-QueryBuilder/dist/js/query-builder.js:1697 Uncaught TypeError: Cannot read property 'each' of null at parse (/node_modules/jQuery-QueryBuilder/dist/js/query-builder.js:1697) at QueryBuilder.validate (/node_modules/jQuery-QueryBuilder/dist/js/query-builder.js:1749) at QueryBuilder.getRules (/node_modules/jQuery-QueryBuilder/dist/js/query-builder.js:1779)

I can probably work around it by adding an ugly try/catch or using beforeClear to destroy the listener and rebuild it again, but there really should be an integrated solution.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the rulesChanged.queryBuilder handler and trace the getRules call through dist/js/query-builder.js at parse, validate, and getRules, using the reported error at line 1697 as the entry point. Reproduce the issue with clear and setRules(..., true) after initialization; done means those operations can trigger rulesChanged without getRules crashing.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, jquery
Domain
frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.