[discuss] SOAP API: add method for searching within issues #560

mhabrnal · 2014-12-10T13:22:26Z

Add method 'mc_search_issues' to SOAP API. Filter is in JSON format.
It is also possible to filter by custom fields.

The example of filter with 'os' == "CentOS" and custom field 'abrt_hash' == "hash_content":

{"abrt_hash":"hash_content", "os":"CenstOS"}

Signed-off-by: Matej Habrnal mhabrnal@redhat.com

vboctor · 2014-12-13T07:58:08Z

Thanks @mhabrnal for your contribution. There are few high level questions:

See Allow retrieving multiple/complex configs #528 for discussion about use of json. I haven't closed on this with @rombert
We will probably need a bit of documentation on expected json input in the developer manual if we go with json.
For custom fields, we typically prefix them with "custom_" when referencing them from a field list. So in your example, it would be "custom_abrt_hash".

vboctor · 2014-12-13T08:00:12Z

api/soap/mantisconnect.wsdl

+<message name="mc_search_issuesRequest">
+  <part name="username" type="xsd:string" />
+  <part name="password" type="xsd:string" />
+  <part name="project_id" type="xsd:integer" />


Do we want to support project_id here as a first class parameter and within the filter itself? In the advanced filter case we may have even multiple projects within the filter. We can keep this, but should document the behavior.

How about making it project_ids and therefore and integer array?

mhabrnal · 2014-12-15T16:44:28Z

Hi @vboctor, thank you for the quick response and good points for the patch.

project_id as a method parameter - I used the project_id as a method parameter because the other filtering methods in SOAP API used a similar scheme. In the case we will use this method doesn't matter if the project_id will be as a method parameter or as a part of the filter [1]. If it be better (for other users) to have possibility to search within all project (project_id will be part of the filter), i'll do it :)
custom_ prefix - ok
code formating - ok
JSON format of the filter - If I write a document with a few examples of how to create JSON filter, can the filter be in JSON format?

[1] https://github.com/abrt/libreport/wiki/MantisBT

rombert · 2014-12-16T12:00:04Z

@mhabrnal - thanks for the contribution! I'll settle on commenting on the high-level stuff, basically the WSDL, to make sure we agree on that first.

I actually started implementing this myself, but ran out of steam some time ago. You can see the status at that time at https://github.com/rombert/mantisbt/compare/soap-custom-filters . I don't think it can be ported as-is, but can serve as another reference.

rombert · 2014-12-16T12:03:05Z

@mhabrnal , @vboctor - I still think wrapping JSON in XML is not the way to go . I would prefer building a set of fields which are known to work and use that. Would we lose any functionality by going this route ?

mhabrnal · 2014-12-18T17:38:45Z

To ensure proper functionality of ABRT MantisBT reporter we need to search only by 'Category', 'Project', 'OS Version' and custom field 'abrt_hash'. So we need a possibility to search by custom fields too. Anyway i think it's better to create searching method which can search by all possible parameters.

I liked the idea of JSON custom filters format because it's easy to implement it and it's easy to understand how it works and how to create it :)

@rombert - Thanks for inspiration :)

This version is without JSON format in filter. I have defined a new types (FilterSearchData, IntegerArray, FilterCustomField and FilterCustomFieldArray). Is possible to search within more then one project at the same time. Signed-off-by: Matej Habrnal <mhabrnal@redhat.com>

mhabrnal · 2015-01-23T15:48:15Z

Hi @vboctor, @rombert, The first version of the abrt mantis reporter is finished https://github.com/abrt/libreport/pull/313, so I had a time to work on the feedback from you and i have created a new version of the searching SOAP API method.

Signed-off-by: Matej Habrnal <mhabrnal@redhat.com>

mc_filter_search_issue_ids() - returns the array of issue ids. mc_issues_get() - given an integer array returns array of issue data. mc_issues_get_header() - given an integer array returns array of issue header data. Fixes #8657 Signed-off-by: Matej Habrnal <mhabrnal@redhat.com>

Signed-off-by: Matej Habrnal <mhabrnal@redhat.com>

mc_filter_search_issue_ids() mc_filter_search_issues() mc_filter_search_issue_headers() mc_issues_get() mc_issues_get_header() Signed-off-by: Matej Habrnal <mhabrnal@redhat.com>

vboctor · 2015-01-24T23:43:34Z

api/soap/mantisconnect.wsdl

+   <xsd:element name="category" type="tns:StringArray" minOccurs="0"/>
+   <xsd:element name="severity_id" type="tns:IntegerArray" minOccurs="0"/>
+   <xsd:element name="status_id" type="tns:IntegerArray" minOccurs="0"/>
+   <xsd:element name="priority_id" type="tns:StringArray" minOccurs="0"/>


Why is priority_id a StringArray?

vboctor · 2015-01-25T00:12:53Z

@mhabrnal this is so close. I've done a more thorough and think this is almost ready to go in. I would love to see this make it into the 1.3 release. So let's address these comments and get it in. It will be a great addition.

mhabrnal · 2015-01-25T22:46:18Z

@vboctor I made adjustments according to your comments. I hope it will be according to your suggestions.

mhabrnal · 2015-01-26T12:37:35Z

@vboctor i added those three methods.

vboctor · 2015-01-26T12:38:36Z

api/soap/mantisconnect.wsdl

@@ -288,6 +330,19 @@
   <xsd:element name="require_closed" type="xsd:boolean" minOccurs="0"/>
  </xsd:all>
 </xsd:complexType>
+ <xsd:complexType name="FilterCustomField">
+  <xsd:all>
+   <xsd:element name="field" type="tns:ObjectRef" minOccurs="0"/>


Should this have minOccurs="1"?

You are right.

vboctor · 2015-01-26T12:48:47Z

It would be great if we can add some tests for these methods since we rely on such tests to validate the SOAP APIs.

mhabrnal · 2015-01-26T16:55:47Z

ok, i'll try to write some tests tomorrow.

mhabrnal · 2015-01-28T17:07:00Z

@vboctor i added the tests.

vboctor · 2015-01-28T17:17:47Z

I think this is ready once the two minor comments are addressed. I will merge it right away then. Assuming TravisCI gives the thumbs up too :)

mhabrnal · 2015-01-29T10:42:58Z

@vboctor i addressed the comments. i hope it is right now.

vboctor · 2015-01-29T15:14:45Z

@mhabrnal Did you revert to an older snapshot of the code somehow? I can only see 2 commits.

mhabrnal · 2015-01-29T15:27:47Z

@vboctor i don't think so. I see 5 commits here.

mhabrnal · 2015-01-29T15:41:57Z

@vboctor i reverted commits sometime. Mostly when the tests failed, but never to an older snapshot. On my branch are 5 commits too (see https://github.com/mhabrnal/mantisbt/commits/master).

rombert · 2015-01-29T15:58:02Z

api/soap/mantisconnect.wsdl

+ <xsd:complexType name="FilterSearchData">
+  <xsd:all>
+   <xsd:element name="project_id" type="tns:IntegerArray" minOccurs="0"/>
+   <xsd:element name="search" type="xsd:string" minOccurs="0"/>


Do we want a more self-explanatory term than search? E.g. text_search, full_text_search or similar

In the web mantisbt filter UI is it named as search so i used the same name.

rombert · 2015-01-29T16:01:51Z

This looks great! I made a couple of cosmetic comments, but nothing which should block merging this PR in its current state. We can decide to address them in follow-up changes if needed.

Also tested generation of Java stubs from the new WSDL and it looks good.

mhabrnal · 2015-02-02T13:22:58Z

@vboctor @rombert, please let me know, which of the comments i have to addressed. i'll send a patch ASAP :)

rombert · 2015-02-02T13:24:02Z

From my POV there is nothing to address for this PR to be merged

On Mon, Feb 2, 2015 at 3:22 PM, Matěj Habrnál notifications@github.com
wrote:

@vboctor https://github.com/vboctor @rombert
https://github.com/rombert, please let me know, which of the comments i
have to addressed. i'll send a patch ASAP :)

—
Reply to this email directly or view it on GitHub
#560 (comment).

http://robert.muntea.nu/

Fixes #8657: SOAP API support for custom filters

vboctor · 2015-02-03T04:34:29Z

Thanks @mhabrnal for your contribution. It is great to have this feature implemented, we wanted to get to it for a while. Hopefully we work together further in the future.

mhabrnal changed the title ~~SOAP API: add method for searching within issues~~ [discuss] SOAP API: add method for searching within issues Dec 10, 2014

vboctor reviewed Dec 13, 2014
View reviewed changes

mhabrnal force-pushed the master branch from 52f2bed to 4f4da6a Compare January 23, 2015 15:39

Matej Habrnal added 4 commits January 23, 2015 19:56

SOAP API: minor fixes

46daf17

Signed-off-by: Matej Habrnal <mhabrnal@redhat.com>

SOAP API: minor fixes

7b9e604

Signed-off-by: Matej Habrnal <mhabrnal@redhat.com>

test SOAP API: added tests for new SOAP API methods

8ae4b6a

mc_filter_search_issue_ids() mc_filter_search_issues() mc_filter_search_issue_headers() mc_issues_get() mc_issues_get_header() Signed-off-by: Matej Habrnal <mhabrnal@redhat.com>

vboctor reviewed Jan 24, 2015
View reviewed changes

mhabrnal force-pushed the master branch 3 times, most recently from a11034b to 764fad6 Compare January 25, 2015 22:29

mhabrnal force-pushed the master branch from e7e0caf to 7246f4e Compare January 26, 2015 11:57

vboctor reviewed Jan 26, 2015
View reviewed changes

mhabrnal force-pushed the master branch from 85ddec0 to 7b9e604 Compare January 28, 2015 16:50

mhabrnal force-pushed the master branch 3 times, most recently from aff6e01 to 8ae4b6a Compare January 29, 2015 10:36

rombert reviewed Jan 29, 2015
View reviewed changes

vboctor added a commit that referenced this pull request Feb 3, 2015

Merge pull request #560 from mhabrnal/master

615f609

Fixes #8657: SOAP API support for custom filters

vboctor merged commit 615f609 into mantisbt:master Feb 3, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[discuss] SOAP API: add method for searching within issues #560

[discuss] SOAP API: add method for searching within issues #560

mhabrnal commented Dec 10, 2014

vboctor commented Dec 13, 2014

vboctor Dec 13, 2014

rombert Dec 16, 2014

mhabrnal commented Dec 15, 2014

rombert commented Dec 16, 2014

rombert commented Dec 16, 2014

mhabrnal commented Dec 18, 2014

mhabrnal commented Jan 23, 2015

vboctor Jan 24, 2015

vboctor commented Jan 25, 2015

mhabrnal commented Jan 25, 2015

mhabrnal commented Jan 26, 2015

vboctor Jan 26, 2015

mhabrnal Jan 26, 2015

vboctor commented Jan 26, 2015

mhabrnal commented Jan 26, 2015

mhabrnal commented Jan 28, 2015

vboctor commented Jan 28, 2015

mhabrnal commented Jan 29, 2015

vboctor commented Jan 29, 2015

mhabrnal commented Jan 29, 2015

mhabrnal commented Jan 29, 2015

rombert Jan 29, 2015

mhabrnal Jan 29, 2015

rombert commented Jan 29, 2015

mhabrnal commented Feb 2, 2015

rombert commented Feb 2, 2015

vboctor commented Feb 3, 2015

[discuss] SOAP API: add method for searching within issues #560

[discuss] SOAP API: add method for searching within issues #560

Conversation

mhabrnal commented Dec 10, 2014

vboctor commented Dec 13, 2014

vboctor Dec 13, 2014

Choose a reason for hiding this comment

rombert Dec 16, 2014

Choose a reason for hiding this comment

mhabrnal commented Dec 15, 2014

rombert commented Dec 16, 2014

rombert commented Dec 16, 2014

mhabrnal commented Dec 18, 2014

mhabrnal commented Jan 23, 2015

vboctor Jan 24, 2015

Choose a reason for hiding this comment

vboctor commented Jan 25, 2015

mhabrnal commented Jan 25, 2015

mhabrnal commented Jan 26, 2015

vboctor Jan 26, 2015

Choose a reason for hiding this comment

mhabrnal Jan 26, 2015

Choose a reason for hiding this comment

vboctor commented Jan 26, 2015

mhabrnal commented Jan 26, 2015

mhabrnal commented Jan 28, 2015

vboctor commented Jan 28, 2015

mhabrnal commented Jan 29, 2015

vboctor commented Jan 29, 2015

mhabrnal commented Jan 29, 2015

mhabrnal commented Jan 29, 2015

rombert Jan 29, 2015

Choose a reason for hiding this comment

mhabrnal Jan 29, 2015

Choose a reason for hiding this comment

rombert commented Jan 29, 2015

mhabrnal commented Feb 2, 2015

rombert commented Feb 2, 2015

vboctor commented Feb 3, 2015