Redmine query parameters

[CaptainQuirk]

:dart: Goals

• Provide a mechanism to filter issues

:panda_face: Implementation

• Support a query configuration value to filter issues

:notebook_with_decorative_cover: Documentation

• document the use of the query setting and how it overrides other configuration value
• link to redmine issues api documentation

[CaptainQuirk]

I also saw that a suite of github actions failed on my branch : https://github.com/ralphbean/bugwarrior/actions/runs/2031120214. I used pytest locally and got a 0 exit code (and a bunch of warnings about distutils version classes being deprecated, due to the fact that python is installed with homebrew on my Linux Mint)

[ryneeverett]

It's not clear to me that there is any need for an if/else clause here. Couldn't we continue passing the limit and assigned_to_id parameters in args even with additional query parameters in the url?

[CaptainQuirk]

How should I handle the query setting which is a partial query string, then ? Due to its partial nature, I'm not sure I could parse it into a dict easily.

[CaptainQuirk]

Maybe your thought was to both append the string value of the query setting to the url variable while also filling the arg dict ?

[ryneeverett]

Maybe your thought was to both append the string value of the query setting to the url variable while also filling the arg dict ?

Yes, that was my thought and I think it's the best route unless there is some reason it doesn't work.

How should I handle the query setting which is a partial query string, then ? Due to its partial nature, I'm not sure I could parse it into a dict easily.

I actually think it is fairly easy to parse a query string into a dict with urlparse.parse_qs.

However, if for some reason we're forced to choose between strings and dicts, I think it would be more reliable to serialize the limit and and assigned_to_id like you did than to parse the user's query string which is just another opportunity for error. However, I'd want to serialize it every time, not just when query != '', so we still wouldn't need the else clause. We want to minimize logical branching. Make sense?

[CaptainQuirk]

I actually think it is fairly easy to parse a query string into a dict with urlparse.parse_qs.

A full blown query string, maybe, but something like project_id=10&status_id=15 with no leading & or ?, I'm not sure.

So to wrap it up :

• Try to add the append the given query setting to the url, keeping the assigned_to_id and limit parameters in the arg dict
• If it does not work, serialize limit, serialize assigned_to_id if only_if_assigned is set and append the query, if it is not the empty string

That should indeed reduce the branching !

[ryneeverett]

I think we could completely remove the branching by appending query even if it is an empty string because I believe a trailing ampersand is acceptable.

[CaptainQuirk]

That should do it now !