stash

core/inventory/api_v2.py

@@ -39,13 +39,61 @@ class ItemViewSet(viewsets.ModelViewSet):
 
 def filter_items(items, query):
     query_tokens = query.split(' ')
+    matches = []
     for item in items:
         value = 0
+        if "I#" + str(item.id) in query:
+            value += 12
+            matches.append(
+                {'type': 'item_id', 'text': f'is exactly {item.id} and matched "I#{item.id}"'})
+        elif "#" + str(item.id) in query:
+            value += 11
+            matches.append(
+                {'type': 'item_id', 'text': f'is exactly {item.id} and matched "#{item.id}"'})
+        elif str(item.id) in query:
+            value += 10
+            matches.append({'type': 'item_id', 'text': f'is exactly {item.id}'})
+        for issue in item.related_issues:
+            if "T#" + issue.short_uuid() in query:
+                value += 8
+                matches.append({'type': 'ticket_uuid',
+                                'text': f'is exactly {issue.short_uuid()} and matched "T#{issue.short_uuid()}"'})
+            elif "#" + issue.short_uuid() in query:
+                value += 5
+                matches.append({'type': 'ticket_uuid',
+                                'text': f'is exactly {issue.short_uuid()} and matched "#{issue.short_uuid()}"'})
+            elif issue.short_uuid() in query:
+                value += 3
+                matches.append({'type': 'ticket_uuid', 'text': f'is exactly {issue.short_uuid()}'})
+            if "T#" + str(issue.id) in query:
+                value += 8
+                matches.append({'type': 'ticket_id', 'text': f'is exactly {issue.id} and matched "T#{issue.id}"'})
+            elif "#" + str(issue.id) in query:
+                value += 5
+                matches.append({'type': 'ticket_id', 'text': f'is exactly {issue.id} and matched "#{issue.id}"'})
+            elif str(issue.id) in query:
+                value += 3
+                matches.append({'type': 'ticket_id', 'text': f'is exactly {issue.id}'})
+            for comment in issue.comments.all():
+                for token in query_tokens:
+                    if token in comment.comment:
+                        value += 1
+                        matches.append({'type': 'ticket_comment', 'text': f'contains {token}'})
+            for token in query_tokens:
+                if token in issue.name:
+                    value += 1
+                    matches.append({'type': 'ticket_name', 'text': f'contains {token}'})
         for token in query_tokens:
             if token in item.description:
                 value += 1
+                matches.append({'type': 'item_description', 'text': f'contains {token}'})
+        for comment in item.comments.all():
+            for token in query_tokens:
+                if token in comment.comment:
+                    value += 1
+                    matches.append({'type': 'comment', 'text': f'contains {token}'})
         if value > 0:
-            yield {'search_score': value, 'item': item}
+            yield {'search_score': value, 'item': item, 'search_matches': matches}
 
 
 @api_view(['GET'])

core/inventory/serializers.py

@@ -137,10 +137,12 @@ class ItemSerializer(BasicItemSerializer):
 
 class SearchResultSerializer(serializers.Serializer):
     search_score = serializers.IntegerField()
+    search_matches = serializers.ListField(child=serializers.DictField())
     item = ItemSerializer()
 
     def to_representation(self, instance):
-        return {**ItemSerializer(instance['item']).data, 'search_score': instance['search_score']}
+        return {**ItemSerializer(instance['item']).data, 'search_score': instance['search_score'],
+                'search_matches': instance['search_matches']}
 
     class Meta:
         model = Item

core/requirements.dev.txt

@@ -34,6 +34,7 @@ drf-yasg==1.21.7
 frozenlist==1.4.1
 h11==0.14.0
 hyperlink==21.0.0
+hypothesis==6.124.2
 idna==3.4
 incremental==22.10.0
 inflection==0.5.1

core/tickets/api_v2.py

@@ -144,37 +144,70 @@ def add_comment(request, pk):
 
 def filter_issues(issues, query):
     query_tokens = query.lower().split(' ')
+    matches = []
     for issue in issues:
         value = 0
-        if issue.short_uuid() in query:
+        if "T#" + issue.short_uuid() in query:
+            value += 12
+            matches.append(
+                {'type': 'ticket_uuid', 'text': f'is exactly {issue.short_uuid()} and matched "T#{issue.short_uuid()}"'})
+        elif "#" + issue.short_uuid() in query:
+            value += 11
+            matches.append(
+                {'type': 'ticket_uuid', 'text': f'is exactly {issue.short_uuid()} and matched "#{issue.short_uuid()}"'})
+        elif issue.short_uuid() in query:
             value += 10
+            matches.append({'type': 'ticket_uuid', 'text': f'is exactly {issue.short_uuid()}'})
         if "T#" + str(issue.id) in query:
             value += 10
+            matches.append({'type': 'ticket_id', 'text': f'is exactly {issue.id} and matched "T#{issue.id}"'})
         elif "#" + str(issue.id) in query:
-            value += 9
+            value += 7
+            matches.append({'type': 'ticket_id', 'text': f'is exactly {issue.id} and matched "#{issue.id}"'})
+        elif str(issue.id) in query:
+            value += 4
+            matches.append({'type': 'ticket_id', 'text': f'is exactly {issue.id}'})
         for item in issue.related_items:
             if "I#" + str(item.id) in query:
                 value += 8
+                matches.append({'type': 'item_id', 'text': f'is exactly {item.id} and matched "I#{item.id}"'})
             elif "#" + str(item.id) in query:
                 value += 5
+                matches.append({'type': 'item_id', 'text': f'is exactly {item.id} and matched "#{item.id}"'})
+            elif str(item.id) in query:
+                value += 3
+                matches.append({'type': 'item_id', 'text': f'is exactly {item.id}'})
             for token in query_tokens:
                 if token in item.description.lower():
                     value += 1
+                    matches.append({'type': 'item_description', 'text': f'contains {token}'})
+            for comment in item.comments.all():
+                for token in query_tokens:
+                    if token in comment.comment.lower():
+                        value += 1
+                        matches.append({'type': 'item_comment', 'text': f'contains {token}'})
         for token in query_tokens:
             if token in issue.name.lower():
                 value += 1
+                matches.append({'type': 'ticket_name', 'text': f'contains {token}'})
         for comment in issue.comments.all():
             for token in query_tokens:
                 if token in comment.comment.lower():
                     value += 1
+                    matches.append({'type': 'ticket_comment', 'text': f'contains {token}'})
         for email in issue.emails.all():
             for token in query_tokens:
                 if token in email.subject.lower():
                     value += 1
+                    matches.append({'type': 'email_subject', 'text': f'contains {token}'})
                 if token in email.body.lower():
                     value += 1
+                    matches.append({'type': 'email_body', 'text': f'contains {token}'})
+                if token in email.sender.lower():
+                    value += 1
+                    matches.append({'type': 'email_sender', 'text': f'contains {token}'})
         if value > 0:
-            yield {'search_score': value, 'issue': issue}
+            yield {'search_score': value, 'issue': issue, 'search_matches': matches}
 
 
 @api_view(['GET'])

core/tickets/serializers.py

@@ -139,10 +139,12 @@ class IssueSerializer(BasicIssueSerializer):
 
 class SearchResultSerializer(serializers.Serializer):
     search_score = serializers.IntegerField()
+    search_matches = serializers.ListField(child=serializers.DictField())
     issue = IssueSerializer()
 
     def to_representation(self, instance):
-        return {**IssueSerializer(instance['issue']).data, 'search_score': instance['search_score']}
+        return {**IssueSerializer(instance['issue']).data, 'search_score': instance['search_score'],
+                'search_matches': instance['search_matches']}
 
     class Meta:
         model = IssueThread

core/tickets/tests/v2/test_tickets.py

@@ -4,6 +4,7 @@ from django.test import TestCase, Client
 
 from authentication.models import ExtendedUser
 from inventory.models import Event, Container, Item
+from inventory.models import Comment as ItemComment
 from mail.models import Email, EmailAttachment
 from tickets.models import IssueThread, StateChange, Comment, ItemRelation, Assignment
 from django.contrib.auth.models import Permission
@@ -407,16 +408,16 @@ class IssueSearchTest(TestCase):
         mail1 = Email.objects.create(
             subject='test',
             body='test aBc',
-            sender='test',
+            sender='bar@test',
-            recipient='test',
+            recipient='2@test',
             issue_thread=issue,
             timestamp=now,
         )
         mail2 = Email.objects.create(
-            subject='test',
+            subject='Re: test',
             body='test',
-            sender='test',
+            sender='2@test',
-            recipient='test',
+            recipient='1@test',
             issue_thread=issue,
             in_reply_to=mail1.reference,
             timestamp=now + timedelta(seconds=2),
@@ -436,6 +437,11 @@ class IssueSearchTest(TestCase):
             item=self.item,
             timestamp=now + timedelta(seconds=5),
         )
+        item_comment = ItemComment.objects.create(
+            item=self.item,
+            comment="baz",
+            timestamp=now + timedelta(seconds=6),
+        )
         search_query = b64encode(b'abC').decode('utf-8')
         response = self.client.get(f'/api/2/{self.event.slug}/tickets/{search_query}/')
         self.assertEqual(200, response.status_code)
@@ -465,3 +471,21 @@ class IssueSearchTest(TestCase):
         self.assertGreater(score3, score2)
         self.assertGreater(score2, score1)
         self.assertGreater(score1, 0)
+
+        search_query = b64encode(b'foo').decode('utf-8')
+        response = self.client.get(f'/api/2/{self.event.slug}/tickets/{search_query}/')
+        self.assertEqual(200, response.status_code)
+        self.assertEqual(1, len(response.json()))
+        self.assertEqual(issue.id, response.json()[0]['id'])
+
+        search_query = b64encode(b'bar').decode('utf-8')
+        response = self.client.get(f'/api/2/{self.event.slug}/tickets/{search_query}/')
+        self.assertEqual(200, response.status_code)
+        self.assertEqual(1, len(response.json()))
+        self.assertEqual(issue.id, response.json()[0]['id'])
+
+        search_query = b64encode(b'baz').decode('utf-8')
+        response = self.client.get(f'/api/2/{self.event.slug}/tickets/{search_query}/')
+        self.assertEqual(200, response.status_code)
+        self.assertEqual(1, len(response.json()))
+        self.assertEqual(issue.id, response.json()[0]['id'])