659073 - Filtering by team member

Status: VERIFIED FIXED

(Mozilla QA :: Case Conductor-Platform, enhancement)

Description

[Carl Meyer (:carljm)]

Filtering searches for any type of object that has team members (test cycles and test runs) by teamMemberId.

Comment 1

[Yishai Cohen]

Carl - Can you decribe the flow? Also, Is there an API change required or is it only UI development item?

Comment 2

[Carl Meyer (:carljm)]

(In reply to comment #1)
> Carl - Can you decribe the flow? 

Sure. On both the view-results panes and the management panes (visible at tcm.oddsites.net/results and tcm.oddsites.net/manage), the UI model is a list/table, sortable by column, and filterable to narrow the viewed items to whichever ones are of interest. 

If you "show advanced filtering" (the basic textbox autocomplete filtering is still waiting on some JS work), you can see the available filters, click on some to activate them, and then click "Update List" to see the filtered list.

The desired flow is simply to be able to add "team member" as a filterable item for those objects that have teams (and environments as well - there's another platform bug open for that).

> Also, Is there an API change required or is it only UI development item?

API change is required; we use the platform's Search API in order to be able to provide these filtered and paginated lists with reasonable bandwidth usage and number of API calls, but currently the Search API does not allow to search by team member ID (or if it does, I'm not aware of how it can be done). To provide the desired filtering without that feature in the Search API would require loading the entire list of objects from the platform every time and making a separate API call for each one to find the team members. This approach is not feasible when lists could become large.

All bugs filed with "TCM-Platform" component are for API changes; UI development has its own Bugzilla component ("TCM"), so there should not be any bugs in this component that are for UI development.

Also, another note that is not (yet) filed as a bug but might be relevant here: from the UI perspective, it would be preferable in general if information such as team members or environment profiles were provided as nested XML/JSON in the basic platform response for objects with teams/environment-profiles, rather than requiring a separate API call per object to fetch team/environment data. When displaying a list of objects with team/environment data, this makes the difference between 1 API call and O(N) API calls. I'll file this as a separate request.

Comment 4

[Vadim]

I don't see the API allowing searches on team members together with a general searches on team dependable objects...especially if the lists can become large....We could allow API to find related test cycles, results etc. for a specific team member...

Comment 5

[Carl Meyer (:carljm)]

(In reply to comment #4)
> I don't see the API allowing searches on team members together with a
> general searches on team dependable objects...especially if the lists can
> become large....We could allow API to find related test cycles, results etc.
> for a specific team member...

Hmm, I'm not clear what the issue is regarding lists becoming large. It's not important that the full team member list appear for each object in the search results, if that's the concern. But it is important that this feature be integrated with the general search API for team-dependable objects, otherwise we lose important integrated search use cases such as "I only want to see active test runs for whom X is a team member" or "I only want to see test runs for cycle Y that X is a team member on."

The UI provides a generalized filtering/searching interface for paginated, sortable lists of each type of object (for instance, https://tcm.oddsites.net/manage/testcycles/). The requested feature is for team-member filtering to integrate into that UI, which requires that it be searchable at the same API endpoint as the general search for each object type.

If there are issues with this, let's discuss them before moving ahead, as from the UI standpoint it may not even be worth implementing this unless it is implemented in an integrated way.

Comment 6

[Vadim]

Implemented additional search parameter to all Team Dependable entities: Product, Test Cycle, test Run

https://localhost/tcm/services/v2/rest/testruns/?teamMemberId=4