API_RDcode/swagger_server/controllers/query_controller.py at master · Orphanet/API_RDcode · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
import elasticsearch
import yaml
from flask import make_response


def handle_query(es, index, query, size=1):
    """
    Fetch the ES query and handle a first layer of error

    :param es: elasticsearch instance see elasticsearch module
    :param index: elasticsearch index name (handle wildcard)
    :param query: elasticsearch valid query
    :param size: optional number of responses to return
    :return: elasticsearch response object on success or error string
    """
    try:
        response = es.search(index=index, body=query, size=size)
        # print(response)
    except elasticsearch.exceptions.NotFoundError:
        response = ("Server Error: Index not found", 404)
        # print(response)
    except elasticsearch.exceptions.ConnectionError:
        response = ("Elasticsearch node unavailable", 503)
    except elasticsearch.exceptions.TransportError:
        response = ("Elasticsearch node unavailable", 503)
    return response


def init_scroll_query(es, index, query, size, scroll_timeout):
    """
    Init a scrollable ES query and handle a first layer of error

    :param es: elasticsearch instance see elasticsearch module
    :param index: elasticsearch index name (handle wildcard)
    :param query: elasticsearch valid query
    :param size: optional number of responses to return
    :param scroll_timeout: duration of scroll instance between calls
    :return: elasticsearch response object on success or error string
    """
    try:
        response = es.search(index=index, body=query, size=size, scroll=scroll_timeout)
        # print(response)
    except elasticsearch.exceptions.NotFoundError:
        response = ("Server Error: Index not found", 404)
        # print(response)
    except elasticsearch.exceptions.ConnectionError:
        response = ("Elasticsearch node unavailable", 503)
    return response


def next_scroll_query(es, sid, scroll_timeout):
    """
    Fetch a scrollable ES query and handle a first layer of error

    :param es: elasticsearch instance see elasticsearch module
    :param sid: scroll index return by previous call
    :param scroll_timeout: duration of scroll instance between calls
    :return: elasticsearch response object on success or error string
    """
    try:
        response = es.scroll(scroll_id=sid, scroll=scroll_timeout)
        # print(response)
    except elasticsearch.exceptions.NotFoundError:
        response = ("Server Error: Index not found", 404)
        # print(response)
    except elasticsearch.exceptions.ConnectionError:
        response = ("Elasticsearch node unavailable", 503)
    return response


def single_res(es, index, query):
    """
    When the query return a single object
    Handle the query with ES then perform error verification related to the response

    :param es: elasticsearch instance see elasticsearch module
    :param index: elasticsearch index name (handle wildcard)
    :param query: elasticsearch valid query
    :return: single dictionary on success or string error code
    """
    response = handle_query(es, index, query)
    if isinstance(response, str) or isinstance(response, tuple):
        # ES node related error comes out as tuple or string
        pass
    else:
        try:
            response = response["hits"]["hits"][0]["_source"]
        except KeyError:
            response = ("Query not found", 404)
            # print(response)
        except IndexError:
            response = ("Query not found", 404)
            # print(response)
    return response


def multiple_res(es, index, query, size):
    """
    When the query can return a reasonable (N << 10000) number of object (ES limit = 10000)
    Handle the query with ES then perform error verification related to the response

    :param es: elasticsearch instance see elasticsearch module
    :param index: elasticsearch index name (handle wildcard)
    :param query: elasticsearch valid query
    :param size: number of responses to return
    :return: list of dictionary on success or string error code
    """
    response = handle_query(es, index, query, size=size)
    if isinstance(response, str) or isinstance(response, tuple):
        # ES node related error comes out as tuple or string
        pass
    else:
        try:
            response = [elem["_source"] for elem in response["hits"]["hits"]]
        except KeyError:
            response = ("Query not found", 404)
            # print(response)
        except IndexError:
            response = ("Query not found", 404)
            # print(response)
        if isinstance(response, list) and not response:
            response = ("Query not found", 404)
    return response


def uncapped_res(es, index, query, size, scroll_timeout):
    """
    When the query can return more object than the ES limit (10000)
    Handle the query with ES then perform error verification related to the response

    :param es: elasticsearch instance see elasticsearch module
    :param index: elasticsearch index name (handle wildcard)
    :param query: elasticsearch valid query
    :param size: number of responses to return
    :param scroll_timeout: duration of scroll instance between calls
    :return: list of dictionary on success or string error code
    """
    # Initialize the scroll query
    response = init_scroll_query(es, index, query, size, scroll_timeout)

    if isinstance(response, str) or isinstance(response, tuple):
        # ES node related error comes out as tuple or string
        return response
    else:
        # granted "response" is not itself an error, it may be missing an scroll ID for other unknown reason
        try:
            sid = response["_scroll_id"]
        except KeyError:
            response = ("Unknown error", 500)
            return response
        try:
            data = [elem["_source"] for elem in response["hits"]["hits"]]
        except KeyError:
            data = ("Query not found", 404)
            # print(response)
        except IndexError:
            data = ("Query not found", 404)
            # print(response)
        # while new_data_size >0 more data can be fetched, initialize with true
        new_data_size = True
        while new_data_size:
            response = next_scroll_query(es, sid, scroll_timeout)
            try:
                sid = response["_scroll_id"]
            except KeyError:
                response = ("Unknown error", 500)
                return response
            try:
                new_data = [elem["_source"] for elem in response["hits"]["hits"]]
                new_data_size = len(new_data)
                # end of scrolling if new_data_size = 0
                data += new_data
            except KeyError:
                data = ("Query not found", 404)
                # print(response)
            except IndexError:
                data = ("Query not found", 404)
                # print(response)
        # remove this scroll from the elasticsearch server without delay
        es.clear_scroll(scroll_id=sid)
    return data


def if_yaml(mime_type, response):
    if mime_type == "application/yaml":
        response = make_response(yaml.dump(response), 200)
        response.mimetype = "application/yaml"
    return response