Jira App-Entwicklung: JQL verarbeiten ohne Kopfschmerzen

Die Herausforderung

In vielen Projekten haben wir Kundenanforderungen, die mit den normalen Bordmitteln von Jira nicht mehr zu erfüllen sind. Häufig ist die einfachste Lösung, selbst ein kleines Add-on zu implementieren. Eine solche Anforderung, die wir kürzlich umsetzen mussten ist, die Projekte herauszufinden, in denen ein Agile Board angezeigt wird:

Vorbereitungen

Um überhaupt mal an den JQL-Filter zu kommen, benötigt man zwei Services, den RapidViewService und den SearchRequestManager:

List<RapidView> boards = rapidViewService.getRapidViews(adminUser).get();
 
for (RapidView board : boards) {
    SearchRequest filter = searchRequestManager.getSearchRequestById(board.getSavedFilterId());
    <... hier fahren wir weiter ...>
}

Erster Versuch

Der erste naive Anlauf in so einem Fall ist normalerweise, den String zu nehmen und mit Vergleichsoperationen nach project zu suchen.

String jql = filter.getQuery().getQueryString();
 
if(jql.contains("project =")) {
    "..."
}

Dieser Ansatz funktioniert, ist aber relativ aufwändig:

1. Überprüfen, ob project im String vorkommt

2. Position des nachgestellten Arguments finden (Name des Projektes)

3. Ende des Projektnamens finden

4. mit substring den Projektnamen extrahieren

Dazu kommen noch diverse Sonderfälle, die behandelt werden müssen, unter anderem:

• Ist nach dem Vergleichsoperator = noch ein Leerzeichen? Oder zwei? Oder ein Tabulator?

• Ist der Projektname in Anführungszeichen? Oder ein Projektkey ohne Anführungszeichen

• project in (key1, key2, …) muss auch berücksichtigt werden

Und, nicht zuletzt, wir verlieren die Typsicherheit, die Java und JQL bieten.

Zweiter Versuch

Betrachtet man im obigen Code die Klasse SearchRequest genauer, sieht man, dass getQuery() nicht direkt den String zurückgibt, sondern ein Objekt der Klasse Query. Diese Klasse selbst ist noch nicht besonders interessant, wer schon einmal in seinem Java Code Suchanfragen an Jira gemacht hat, kennt sie schon. Interessant ist die Methode, getWhereClause() und das Clause-Objekt, dass sie zurückgibt. Leider ist die Google-Suche nicht gerade ergiebig mit Dokumentation und Beispielen. Nach ein bisschen Experimentieren ergab sich aber dann die folgende Lösung:

Clause Visitor

Ein JQL Filter kann mit der Methode accept(ClauseVisitor<R> visitor) verarbeitet werden. Der Parameter deutet schon darauf hin, dass das Besucher-Entwurfsmuster verwendet wird. Die abstrakte Klasse ClauseVisitor kann gleich als anonyme Klasse implementiert werden:

Clause jqlClause = filter.getQuery().getWhereClause();
 
jqlClause.accept(new ClauseVisitor<Object>() {
    @Override
    public Object visit(AndClause ac) {
        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
    }
 
    @Override
    public Object visit(NotClause nc) {
        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
    }
 
    @Override
    public Object visit(OrClause oc) {
        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
    }
 
    @Override
    public Object visit(TerminalClause tc) {
        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
    }
 
    @Override
    public Object visit(WasClause wc) {
        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
    }
 
    @Override
    public Object visit(ChangedClause cc) {
        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
    }
});

Für diese Anforderung sind wir prinzipiell an der TerminalClause interessiert:

@Override
public Object visit(TerminalClause tc) {
    if (tc.getName().equals("project")) {
        System.out.println("Found Project " + tc.getOperand().getDisplayString());
    }
    return null;
}

Das deckt z.B. folgenden Filter ab:

project = DEMO ORDER BY Rank ASC

Der folgende Filter geht aber noch nicht:

project = DEMO AND assignee = demouser ORDER BY Rank ASC

Dafür müssen die beiden Subklauseln der AND-Klausel ausgewertet werden. Damit man nicht auf eine oder zwei Ebenen eingeschränkt ist, macht man am besten gleich eine rekursive Funktion daraus:

private void checkClause(Clause clause) {
    clause.accept(new ClauseVisitor<Object>() {
        @Override
        public Object visit(AndClause ac) {
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
            return null;
        }
 
        @Override
        public Object visit(NotClause nc) {
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
 
            return null;
        }
 
        @Override
        public Object visit(OrClause oc) {
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
 
            return null;
        }
 
        @Override
        public Object visit(TerminalClause tc) {
            if (tc.getName().equals("project")) {
                System.out.println("Found Project " + tc.getOperand().getDisplayString());
            }
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
            return null;
        }
 
        @Override
        public Object visit(WasClause wc) {
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
            return null;
        }
 
        @Override
        public Object visit(ChangedClause cc) {
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
            return null;
        }
    });
}

Bitte beachten, dass zur Vollständigkeit auch die NOT-Klauseln hier mitverarbeitet werden. Das gibt unter Umständen nicht das gewünschte Resultat.

Operand Visitor

Der bisherige Code deckt den Fall project = key ab. Nicht berücksichtigt sind Queries wie project in (key1, key2). Dafür braucht es einen zweiten Visitor, der die Operanden prüft. Da auch die Operanden verschachtelt sein können, legen wir diesen Visitor auch gleich als rekursive Funktion aus:

private List<String> checkOperand(Operand op) {
    op.accept(new OperandVisitor<Object>() {
        @Override
        public Object visit(EmptyOperand eo) {
            return null;
        }
 
        @Override
        public Object visit(FunctionOperand fo) {
            return null;
        }
 
        @Override
        public Object visit(MultiValueOperand mvo) {
            for (Operand o : mvo.getValues()) {
                checkOperand(o);
            }
            return null;
        }
 
        @Override
        public Object visit(SingleValueOperand svo) {
            System.out.println("Found Project " + svo.getStringValue());
 
            return null;
        }
    });
}

Die Methode für die TerminalClause im ClauseVisitor muss auch noch einmal angepasst werden:

@Override
public Object visit(TerminalClause tc) {
    if (tc.getName().equals("project")) {
        checkOperand(tc.getOperand());
    }
    if (clause.getClauses().size() > 0) {
        for (Clause c : clause.getClauses()) {
            checkClause(c);
        }
    }
    return null;
}

Fertiger Code

Hier noch einmal der fertige Code zur Übersicht:

private void checkClause(Clause clause) {
    clause.accept(new ClauseVisitor<Object>() {
        @Override
        public Object visit(AndClause ac) {
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
            return null;
        }
 
        @Override
        public Object visit(NotClause nc) {
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
 
            return null;
        }
 
        @Override
        public Object visit(OrClause oc) {
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
 
            return null;
        }
 
        @Override
        public Object visit(TerminalClause tc) {
            if (tc.getName().equals("project")) {
                checkOperand(tc.getOperand());
            }
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
            return null;
        }
 
        @Override
        public Object visit(WasClause wc) {
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
            return null;
        }
 
        @Override
        public Object visit(ChangedClause cc) {
            if (clause.getClauses().size() > 0) {
                for (Clause c : clause.getClauses()) {
                    checkClause(c);
                }
            }
            return null;
        }
    });
}
 
private List<String> checkOperand(Operand op) {
    op.accept(new OperandVisitor<Object>() {
        @Override
        public Object visit(EmptyOperand eo) {
            return null;
        }
 
        @Override
        public Object visit(FunctionOperand fo) {
            return null;
        }
 
        @Override
        public Object visit(MultiValueOperand mvo) {
            for (Operand o : mvo.getValues()) {
                checkOperand(o);
            }
            return null;
        }
 
        @Override
        public Object visit(SingleValueOperand svo) {
            System.out.println("Found Project " + svo.getStringValue());
 
            return null;
        }
    });
}

Fazit

Zugegeben, der Visitor-Code ist ein bisschen gewöhnungsbedürftig, und die Dokumentation zu diesen Klassen und Interfaces ist eher spärlich. Dafür haben wir nun zwei Methoden, die leicht an andere Bedürfnisse anpassbar sind. Sie sind typsicher, also kann uns die Entwicklungsumgebung unterstützen und der Compiler vor Fehlern bewahren, und sie ersparen uns, die Oben erwähnten Sonderfälle zu behandeln.

Klassendokumentationen

https://docs.atlassian.com/software/jira/docs/api/7.6.1/com/atlassian/query/Query.html https://docs.atlassian.com/software/jira/docs/api/7.6.1/com/atlassian/query/clause/Clause.html

Haben Sie Fragen oder Anregungen zum diesem Blog-Beitrag? Dürfen wir Sie unterstützen? Schreiben Sie uns auf hallo@zuara.ch oder rufen Sie uns an: 031 302 60 00.