-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathapp.py
1005 lines (886 loc) · 33.3 KB
/
app.py
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import json
import re
from collections import namedtuple
from itertools import chain
from gevent import (
monkey,
)
monkey.patch_all()
import gevent
import datetime
from email.utils import (
parsedate,
)
from functools import (
partial,
wraps,
)
import logging
import os
import signal
import sys
import urllib.parse
import uuid
import requests
from flask import (
Flask,
Response,
abort,
redirect,
render_template,
request,
url_for,
)
from gevent.pywsgi import (
WSGIServer,
)
from jinja2 import (
Environment,
FileSystemLoader,
)
import sentry_sdk
from sentry_sdk.integrations.flask import FlaskIntegration
import urllib3
from werkzeug.middleware.proxy_fix import (
ProxyFix,
)
from app_aws import (
aws_head,
aws_s3_request,
aws_select_post_body_csv,
aws_select_post_body_json,
aws_select_convert_records_to_csv,
aws_select_convert_records_to_json,
aws_select_parse_result,
aws_list_folders,
)
from app_logging import (
ASIMFormatter,
)
RE_VERSION_FORMAT = re.compile(
r'^(?P<version>v(?P<major>\d+)(?:\.(?P<minor>\d+)(?:\.(?P<patch>\d+))?)?|latest)$'
)
def proxy_app(
logger,
port,
aws_access_key_id,
aws_secret_access_key,
endpoint_url,
region_name,
ga_tracking_id,
ga4_api_secret,
ga4_measurement_id,
):
parsed_endpoint = urllib.parse.urlsplit(endpoint_url)
PoolClass = (
urllib3.HTTPConnectionPool
if parsed_endpoint.scheme == 'http'
else urllib3.HTTPSConnectionPool
)
http = PoolClass(parsed_endpoint.hostname, port=parsed_endpoint.port, maxsize=1000)
proxied_request_headers = [
'range',
]
proxied_response_codes = [
200,
206,
404,
]
proxied_response_headers = [
'accept-ranges',
'content-length',
'date',
'etag',
'last-modified',
'content-range',
]
signed_s3_request = partial(
aws_s3_request,
parsed_endpoint,
http,
aws_access_key_id,
aws_secret_access_key,
region_name,
)
html_template_environment = Environment(
loader=FileSystemLoader('./templates'), autoescape=True
)
def start():
server.serve_forever()
def stop():
server.stop()
def track_analytics(handler):
"""Decorator to send analytics data to google in the background."""
def _send_to_ua(requester_ip, request_url, request_headers):
logger.info('Sending to Google Analytics (UA) %s...', request_url)
requests.post(
os.environ.get(
'GA_ENDPOINT', 'https://www.google-analytics.com/collect'
),
data={
'v': '1',
'tid': ga_tracking_id,
'cid': str(uuid.uuid4()),
't': 'pageview',
'uip': requester_ip,
'aip': '1',
'dl': request_url,
'ds': 'public-data-api',
'dr': request_headers.get('referer', ''),
'ua': request_headers.get('user-agent', ''),
},
)
def _send_to_ga4(request_url, request_headers):
logger.info('Sending to Google Analytics 4 (GA4) %s...', request_url)
requests.post(
'https://www.google-analytics.com/mp/collect',
params={
'api_secret': ga4_api_secret,
'measurement_id': ga4_measurement_id,
},
json={
'client_id': str(uuid.uuid4()),
'events': [{
'name': 'page_view',
'params': {
'session_id': str(uuid.uuid4()),
'engagement_time_msec': '100',
'page_location': request_url,
'page_title': 'Data API',
'user_agent': request_headers.get('user-agent', ''),
'referrer': request_headers.get('referer', ''),
}
}],
},
)
@wraps(handler)
def send(*args, **kwargs):
if ga_tracking_id:
gevent.spawn(_send_to_ua, request.remote_addr, request.url, request.headers)
if ga4_api_secret and ga4_measurement_id:
gevent.spawn(_send_to_ga4, request.url, request.headers)
return handler(*args, **kwargs)
return send
def validate_and_redirect_version(handler):
"""Reads the version from the URL path, validates that it's either `latest` or a
(simple) SemVer version.
If not, 404s.
If it's `latest`, scrapes S3 for the latest version of the dataset and redirects to it.
If no key exists, 404s.
If it's a major or minor version, scrapes S3 for the latest (constrained) version and
redirects to it.
If no matching key exists, 404s.
If it's a patch version, passes directly through to the underlying function.
"""
@wraps(handler)
def handler_with_validation(*args, **kwargs):
match = RE_VERSION_FORMAT.match(request.view_args['version'])
if not match:
abort(404)
version, major, minor, patch = [
match.group(g) for g in ('version', 'major', 'minor', 'patch')
]
if major and minor and patch:
return handler(*args, **kwargs)
if version == 'latest':
def predicate(_):
return True
elif major and not minor and not patch:
def predicate(path):
v_major_str, _, _ = path.split('.')
return v_major_str[1:] == str(major)
else:
def predicate(path):
v_major_str, minor_str, _ = path.split('.')
return v_major_str[1:] == str(major) and minor_str == str(minor)
def semver_key(path):
v_major_str, minor_str, patch_str = path.split('.')
return (int(v_major_str[1:]), int(minor_str), int(patch_str))
folders = aws_list_folders(
signed_s3_request, prefix=request.view_args['dataset_id'] + '/'
)
matching_folders = filter(predicate, folders)
latest_matching_version = max(
matching_folders, default=None, key=semver_key
)
if latest_matching_version is None:
return 'Dataset not found', 404
# It doesn't look like it's possible to return a redirect with the query string that
# has the _exact_ bytes that were received by the server in all cases. If a client
# sends non-URL-encoded UTF-8 in the query string, the below results (via code in
# Werkzeug) in returning a redirect to a URL with the equivalent URL-encoded string.
query_string = (
(b'?' + request.query_string) if request.query_string else b''
).decode('utf-8')
updated_view_args = {
**request.view_args,
'version': latest_matching_version,
'_external': True,
}
return redirect(
url_for(request.endpoint, **updated_view_args) + query_string
)
return handler_with_validation
def validate_format(ensure_formats):
def validate_format_handler(handler):
@wraps(handler)
def handler_with_validation(*args, **kwargs):
try:
_format = request.args['format']
except KeyError:
return 'The query string must have a "format" term', 400
if _format not in ensure_formats:
return (
f'The query string "format" term must be one of "{ensure_formats}"',
400,
)
return handler(*args, **kwargs)
return handler_with_validation
return validate_format_handler
def _proxy(s3_key, query_s3_select, aws_select_parse_result_for_query, headers):
method, body, params, parse_response = (
(
'POST',
query_s3_select,
(('select', ''), ('select-type', '2')),
aws_select_parse_result_for_query,
)
if query_s3_select is not None
else (
'GET',
b'',
(),
lambda x, _: x,
)
)
pre_auth_headers = tuple(
((key, headers[key]) for key in proxied_request_headers if key in headers)
)
response = signed_s3_request(method, s3_key, pre_auth_headers, params, body)
logger.debug('Response: %s', response)
return (
parse_response(response.stream(65536, decode_content=False), 65536),
response,
)
def _generate_downstream_response(
body_generator, response, content_type, download_filename, content_encoding=None
):
allow_proxy = response.status in proxied_response_codes
logger.debug('Allowing proxy: %s', allow_proxy)
response_headers_no_content_type = tuple(
(
(key, response.headers[key])
for key in proxied_response_headers
if key in response.headers
)
)
download_headers = (
(('content-disposition', f'attachment; filename="{download_filename}"'),)
if 'download' in request.args
else ()
)
encoding_headers = (
(('content-encoding', content_encoding),) if content_encoding else ()
)
response_headers = (
response_headers_no_content_type
+ (('content-type', content_type),)
+ download_headers
+ encoding_headers
)
if not allow_proxy:
# Make sure we fetch all response bytes, so the connection can be re-used.
# There are not likely to be many, since it would just be an error message
# from S3 at most
for _ in response.stream(65536, decode_content=False):
pass
raise Exception(f'Unexpected code from S3: {response.status}')
downstream_response = Response(
body_generator,
status=response.status,
headers=response_headers,
)
downstream_response.call_on_close(response.release_conn)
return downstream_response
def _convert_csvw_to_html(dataset_id, version, body_generator):
csvw = json.loads(b''.join(body_generator))
csvw_with_id = {
**csvw,
'tables': [
{
**table,
'_id': table['url'].split('/')[1],
'_html_id': f"{table['url'].split('/')[0][:-1]}--{table['url'].split('/')[1]}",
'_table_or_report': table['url'].split('/')[0][:-1],
}
for table in csvw['tables']
],
}
table_head_status_headers = [
(
table['_html_id'],
aws_head(
signed_s3_request,
f'{dataset_id}/{version}/'
+ f'{table["_table_or_report"]}s/{table["_id"]}/data.csv',
),
)
for table in csvw_with_id['tables']
]
table_sizes = {
table_html_id: headers['content-length']
for table_html_id, (_, headers) in table_head_status_headers
}
filter_urls = {
table['_html_id']: url_for(
f'filter_{table["_table_or_report"]}_rows',
dataset_id=dataset_id,
version=version,
table=table['_id'],
)
for table in csvw_with_id['tables']
}
# Our extension to CSVW supports multiple databases for a dataset, but we only support the
# one in the API, to make a dataset more self contained in a single file
databases = csvw.get('dit:databases', [])
database_sizes = (
[
aws_head(signed_s3_request, f'{dataset_id}/{version}/data.sqlite')[1][
'content-length'
]
]
if databases
else []
)
return html_template_environment.get_template('metadata.html').render(
version=version,
version_published_at=max(
(
datetime.datetime(*parsedate(headers['last-modified'])[:6])
for _, (_, headers) in table_head_status_headers
)
),
csvw=csvw_with_id,
databases=databases,
database_sizes=database_sizes,
filter_urls=filter_urls,
metadata_download_url=url_for(
'proxy_metadata', dataset_id=dataset_id, version=version
)
+ '?format=csvw&download',
table_sizes=table_sizes,
)
@track_analytics
@validate_format(('json',))
def list_all_datasets():
folders = aws_list_folders(signed_s3_request)
versions = {
'datasets': [
{'id': dataset} for dataset in folders if dataset != 'healthcheck'
]
}
return Response(
json.dumps(versions), headers={'content-type': 'text/json'}, status=200
)
@track_analytics
@validate_format(('data.json',))
def get_metadata_for_dataset(dataset_id):
logger.debug('Attempt to fetch data.json: %s %s', request, dataset_id)
s3_key = f'{dataset_id}/data.json'
body_generator, response = _proxy(s3_key, None, None, request.headers)
return _generate_downstream_response(
body_generator,
response,
'text/json',
'{dataset_id}--data.json',
)
@track_analytics
@validate_format(('json',))
def list_versions_for_dataset(dataset_id):
def semver_key(path):
v_major_str, minor_str, patch_str = path.split('.')
return (int(v_major_str[1:]), int(minor_str), int(patch_str))
folders = aws_list_folders(signed_s3_request, prefix=dataset_id + '/')
sorted_versions = sorted(folders, key=semver_key, reverse=True)
versions = {'versions': [{'id': version} for version in sorted_versions]}
return Response(
json.dumps(versions), headers={'content-type': 'text/json'}, status=200
)
@track_analytics
@validate_and_redirect_version
@validate_format(('json',))
def list_tables_for_dataset_version(dataset_id, version):
folders = aws_list_folders(
signed_s3_request, prefix=f'{dataset_id}/{version}/tables/'
)
tables = {'tables': [{'id': table} for table in folders]}
return Response(
json.dumps(tables), headers={'content-type': 'text/json'}, status=200
)
@track_analytics
@validate_and_redirect_version
@validate_format(('json',))
def list_reports_for_dataset_version(dataset_id, version):
folders = aws_list_folders(
signed_s3_request, prefix=f'{dataset_id}/{version}/reports/'
)
reports = {'reports': [{'id': report} for report in folders]}
return Response(
json.dumps(reports), headers={'content-type': 'text/json'}, status=200
)
@track_analytics
@validate_and_redirect_version
@validate_format(
(
'json',
'sqlite',
'ods',
)
)
def proxy_data(dataset_id, version):
_format = request.args['format']
logger.debug('Attempt to proxy: %s %s %s', request, dataset_id, version)
s3_query = request.args.get('query-s3-select')
accepted_encodings = (
request.headers.get('accept-encoding', '').replace(' ', '').split(',')
)
attempt_gzip = (
'gzip' in accepted_encodings
and s3_query is None
and _format in ('json', 'sqlite')
)
base_s3_key = f'{dataset_id}/{version}/data.{_format}'
key_content_encodings = (
()
+ (((base_s3_key + '.gz', 'gzip'),) if attempt_gzip else ())
+ ((base_s3_key, None),)
)
for s3_key, content_encoding in key_content_encodings:
body_generator, response = _proxy(
s3_key,
aws_select_post_body_json(s3_query) if s3_query is not None else None,
partial(aws_select_parse_result, aws_select_convert_records_to_json)
if s3_query is not None
else None,
request.headers,
)
if response.status in (200, 206):
break
for _ in response.stream(65536, decode_content=False):
pass
else:
if response.status == 404:
abort(404)
else:
raise Exception(f'Unexpected code from S3: {response.status}')
download_filename = f'{dataset_id}--{version}.{_format}'
content_type = (
'application/vnd.oasis.opendocument.spreadsheet'
if _format == 'ods'
else 'application/vnd.sqlite3'
if _format == 'sqlite'
else 'application/json'
)
return _generate_downstream_response(
body_generator,
response,
content_type,
download_filename,
content_encoding=content_encoding,
)
@track_analytics
@validate_and_redirect_version
@validate_format(
(
'csv',
'ods',
'parquet',
)
)
def proxy_table(dataset_id, version, table):
return proxy_table_or_report(
'table', dataset_id, version, table, request.args['format']
)
@track_analytics
@validate_and_redirect_version
@validate_format(
(
'csv',
'ods',
'parquet',
)
)
def proxy_report(dataset_id, version, table):
return proxy_table_or_report(
'report', dataset_id, version, table, request.args['format']
)
def proxy_table_or_report(table_or_report, dataset_id, version, table, _format):
logger.debug(
'Attempt to proxy: %s %s %s %s %s %s',
table_or_report,
request,
dataset_id,
version,
table,
format,
)
header_row = None
s3_key = f'{dataset_id}/{version}/{table_or_report}s/{table}/data.{_format}'
if 'query-simple' in request.args:
_, columns, filterable_columns = _get_table_metadata(
dataset_id, version, table
)
filters = {
c.name: request.args.get(c.name)
for c in filterable_columns
if request.args.get(c.name)
}
select_columns = request.args.getlist('_columns') or [
c.name for c in columns
]
select_clause = ','.join([f's.{c}' for c in select_columns])
join_term = "','"
where_clause = (
' and '.join(
[
f"s.{name} in ('{join_term.join(value.split(','))}')"
for name, value in filters.items()
]
)
or None
)
s3_query = f'SELECT {select_clause} FROM s3object s'
if where_clause:
s3_query += f' WHERE {where_clause}'
header_row = [f"{','.join(select_columns)}\n".encode('utf-8')]
else:
s3_query = request.args.get('query-s3-select')
gzip_encode = (
'accept-encoding' in request.headers
and 'gzip'
in request.headers.get('accept-encoding', '').replace(' ', '').split(',')
and s3_query is None
and _format == 'csv'
)
content_encoding = 'gzip' if gzip_encode else None
body_generator, response = _proxy(
s3_key + ('.gz' if gzip_encode else ''),
aws_select_post_body_csv(s3_query) if s3_query is not None else None,
partial(aws_select_parse_result, aws_select_convert_records_to_csv)
if s3_query is not None
else None,
request.headers,
)
if response.status == 404 and gzip_encode:
for _ in response.stream(65536, decode_content=False):
pass
body_generator, response = _proxy(
s3_key,
aws_select_post_body_csv(s3_query) if s3_query is not None else None,
partial(aws_select_parse_result, aws_select_convert_records_to_csv)
if s3_query is not None
else None,
request.headers,
)
content_encoding = None
if header_row:
body_generator = chain(header_row, body_generator)
download_filename = (
f'{dataset_id}--{version}--{table}.{_format}'
if table_or_report == 'table'
else f'{dataset_id}--{version}--report--{table}.{_format}'
)
content_type = (
'text/csv'
if _format == 'csv'
else 'application/vnd.apache.parquet'
if _format == 'parquet'
else 'application/vnd.oasis.opendocument.spreadsheet'
)
return _generate_downstream_response(
body_generator,
response,
content_type,
download_filename,
content_encoding=content_encoding,
)
Column = namedtuple('Column', ['name', 'description', 'filterable'])
def _get_table_metadata(dataset_id, version, table):
s3_key = f'{dataset_id}/{version}/metadata--csvw.json'
body_generator, _ = _proxy(s3_key, None, None, request.headers)
metadata_tables = json.loads(b''.join(body_generator))['tables']
metadata_table = next(
filter(lambda x: x['url'].split('/')[1] == table, metadata_tables), None
)
columns = [
Column(x['name'], x['dc:description'], x['dit:filterable'])
for x in metadata_table['tableSchema']['columns']
]
filterable_columns = [c for c in columns if c.filterable]
return metadata_table, columns, filterable_columns
@track_analytics
@validate_and_redirect_version
def filter_table_rows(dataset_id, version, table):
return filter_table_or_report_rows('table', dataset_id, version, table)
@track_analytics
@validate_and_redirect_version
def filter_report_rows(dataset_id, version, table):
return filter_table_or_report_rows('report', dataset_id, version, table)
def filter_table_or_report_rows(table_or_report, dataset_id, version, table):
metadata_table, _, filterable_columns = _get_table_metadata(
dataset_id, version, table
)
filters = {
c.name: request.args.get(c.name)
for c in filterable_columns
if request.args.get(c.name)
}
return html_template_environment.get_template('filter_rows.html').render(
reset_url=url_for(
f'filter_{table_or_report}_rows',
dataset_id=dataset_id,
version=version,
table=table,
),
submit_url=url_for(
f'filter_{table_or_report}_columns',
dataset_id=dataset_id,
version=version,
table=table,
),
filterable_columns=filterable_columns,
filters=filters,
table_name=metadata_table['dc:title'],
)
@track_analytics
@validate_and_redirect_version
def filter_table_columns(dataset_id, version, table):
return filter_table_or_report_columns('table', dataset_id, version, table)
@track_analytics
@validate_and_redirect_version
def filter_report_columns(dataset_id, version, table):
return filter_table_or_report_columns('report', dataset_id, version, table)
def filter_table_or_report_columns(table_or_report, dataset_id, version, table):
metadata_table, columns, filterable_columns = _get_table_metadata(
dataset_id, version, table
)
filters = {
c.name: request.args.get(c.name)
for c in filterable_columns
if request.args.get(c.name)
}
return html_template_environment.get_template('filter_columns.html').render(
back_url=url_for(
f'filter_{table_or_report}_rows',
dataset_id=dataset_id,
version=version,
table=table,
**filters,
),
submit_url=url_for(
f'proxy_{table_or_report}',
dataset_id=dataset_id,
version=version,
table=table,
),
filters=filters,
columns=columns,
table_name=metadata_table['dc:title'],
)
@track_analytics
@validate_and_redirect_version
@validate_format(('csvw', 'html'))
def proxy_metadata(dataset_id, version):
logger.debug('Attempt to proxy: %s %s %s', request, dataset_id, version)
s3_key = f'{dataset_id}/{version}/metadata--csvw.json'
body_generator, response = _proxy(s3_key, None, None, request.headers)
def _csvw():
download_filename = f'{dataset_id}--{version}--metadata--csvw.json'
content_type = 'application/csvm+json'
return _generate_downstream_response(
body_generator, response, content_type, download_filename
)
def _html():
download_filename = f'{dataset_id}--{version}--metadata.html'
content_type = 'text/html'
return _generate_downstream_response(
_convert_csvw_to_html(dataset_id, version, body_generator),
response,
content_type,
download_filename,
)
return _csvw() if request.args['format'] == 'csvw' else _html()
def healthcheck():
"""
Healthcheck checks S3 bucket, `healthcheck` as dataset_id and v0.0.1 as version
containing json string {'status': 'OK'}
"""
s3_key = 'healthcheck/v0.0.1/data.json'
body_generator, s3_response = _proxy(s3_key, None, None, request.headers)
body_bytes = b''.join(chunk for chunk in body_generator)
body_json = json.loads(body_bytes.decode('utf-8'))
# v1 healthcheck format
ok_status = body_json.get('status')
# v2 healthcheck format
if isinstance(ok_status, list):
ok_status = ok_status[0].get('id')
if s3_response.status == 200 and ok_status:
pingdom_xml = """<?xml version="1.0" encoding="UTF-8"?>
<pingdom_http_custom_check>
<status>OK</status>
</pingdom_http_custom_check>\n"""
return Response(
pingdom_xml,
headers={
'content-type': 'text/xml',
'cache-control': 'no-cache, no-store, must-revalidate',
},
status=200,
)
return Response(status=503)
@track_analytics
def docs():
"""
Documentation homepage
"""
context = {
'department_name': os.environ.get('DOCS_DEPARTMENT_NAME'),
'service_name': os.environ.get('DOCS_SERVICE_NAME'),
'github_repo_url': os.environ.get('DOCS_GITHUB_REPO_URL'),
'base_url': request.base_url.rstrip('/'),
'dataset': os.environ.get('DOCS_SAMPLE_DATASET', 'uk-tariff-2021-01-01'),
'version': os.environ.get('DOCS_SAMPLE_VERSION', 'v2.1.0'),
'latest_version': os.environ.get('DOCS_SAMPLE_LATEST_VERSION', 'v2.1.2'),
'table_name': os.environ.get('DOCS_SAMPLE_TABLE_NAME', 'commodities'),
'sample_dataset_with_report': (
os.environ.get(
'DOCS_SAMPLE_DATASET_WITH_REPORT_DATASET_ID', 'uk-trade-quotas'
)
),
'sample_dataset_with_report_version': (
os.environ.get('DOCS_SAMPLE_DATASET_WITH_REPORT_VERSION', 'v1.0.0')
),
'sample_dataset_with_report_report_name': (
os.environ.get(
'DOCS_SAMPLE_DATASET_WITH_REPORT_REPORT_ID',
'quotas-including-current-volumes',
)
),
'security_email': os.environ.get('DOCS_SECURITY_EMAIL'),
}
return render_template('docs.html', **context)
@track_analytics
def accessibility_statement():
"""
Documentation homepage
"""
context = {
'department_name': os.environ.get('DOCS_DEPARTMENT_NAME'),
'service_name': os.environ.get('DOCS_SERVICE_NAME'),
'base_url': request.base_url.rstrip('/'),
}
return render_template('accessibility_statement.html', **context)
app = Flask('app')
# If some paths are behind the IP filter, then num_proxies will be higher, because it
# means requests go through the routing system twice. However, num_proxies is only
# used for the IP sent to Google Analytics, so we can cope with it being wrong for
# pre-release datasets
app.wsgi_app = ProxyFix(app.wsgi_app, x_proto=1, x_for=3)
@app.after_request
def _add_headers(resp):
resp.headers['access-control-allow-origin'] = '*'
if urllib.parse.urlsplit(request.base_url).path != '/':
resp.headers['x-robots-tag'] = 'no-index, no-follow'
return resp
app.add_url_rule('/v1/datasets', view_func=list_all_datasets)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/metadata',
view_func=get_metadata_for_dataset,
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions', view_func=list_versions_for_dataset
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions/<string:version>/tables',
view_func=list_tables_for_dataset_version,
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions/<string:version>/reports',
view_func=list_reports_for_dataset_version,
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions/<string:version>/tables/<string:table>/data',
view_func=proxy_table,
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions/<string:version>/reports/<string:table>/data',
view_func=proxy_report,
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions/<string:version>/tables/<string:table>'
'/filter/rows',
view_func=filter_table_rows,
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions/<string:version>/reports/<string:table>'
'/filter/rows',
view_func=filter_report_rows,
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions/<string:version>/tables/<string:table>'
'/filter/columns',
view_func=filter_table_columns,
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions/<string:version>/reports/<string:table>'
'/filter/columns',
view_func=filter_report_columns,
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions/<string:version>/data',
view_func=proxy_data,
)
app.add_url_rule(
'/v1/datasets/<string:dataset_id>/versions/<string:version>/metadata',
view_func=proxy_metadata,
)
app.add_url_rule('/pingdom/ping.xml', 'healthcheck', view_func=healthcheck)
app.add_url_rule('/', 'docs', view_func=docs)
app.add_url_rule('/accessibility_statement', view_func=accessibility_statement)
server = WSGIServer(('0.0.0.0', port), app, log=app.logger)
return start, stop
def main():
logger = logging.getLogger()
logger.setLevel(logging.INFO)
handler = logging.StreamHandler(sys.stdout)
handler.setFormatter(ASIMFormatter())
logger.addHandler(handler)
start, stop = proxy_app(
logger,
int(os.environ['PORT']),
os.environ['READONLY_AWS_ACCESS_KEY_ID'],
os.environ['READONLY_AWS_SECRET_ACCESS_KEY'],
os.environ['AWS_S3_ENDPOINT'],
os.environ['AWS_S3_REGION'],
os.environ.get('GA_TRACKING_ID'),
os.environ.get('GA4_API_SECRET'),
os.environ.get('GA4_MEASUREMENT_ID'),
)
if os.environ.get('SENTRY_DSN'):
sentry_sdk.init( # pylint: disable=abstract-class-instantiated
dsn=os.environ['SENTRY_DSN'],
integrations=[FlaskIntegration()],
# Session tracking makes graceful shutdown difficult since it starts a thread but there
# is no quick way to kill it
auto_session_tracking=False,
enable_tracing=True,
)
gevent.signal_handler(signal.SIGTERM, stop)
start()
sentry_client = sentry_sdk.Hub.current.client
if sentry_client is not None:
sentry_client.close(timeout=2.0)
gevent.get_hub().join()