File: process_perf_results.py

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (982 lines) | stat: -rwxr-xr-x 37,817 bytes parent folder | download | duplicates (5)
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
#!/usr/bin/env vpython3
# Copyright 2018 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

from __future__ import absolute_import
from __future__ import print_function

import argparse
import collections
import json
import logging
import multiprocessing
import os
import shutil
import sys
import tempfile
import time
from typing import Any, Dict, Optional
import uuid

from core import path_util

path_util.AddTelemetryToPath()

from core import bot_platforms
from core import results_merger
from core import upload_results_to_perf_dashboard
import cross_device_test_config
import json_util
import six

logging.basicConfig(
    level=logging.INFO,
    format='(%(levelname)s) %(asctime)s pid=%(process)d'
           '  %(module)s.%(funcName)s:%(lineno)d  %(message)s')

path_util.AddAndroidPylibToPath()
path_util.AddBuildUtilToPath()

try:
  from lib.common import google_storage_helper  # pylint: disable=import-error
  from pylib.utils import logdog_helper
except ImportError:
  pass


RESULTS_URL = 'https://chromeperf.appspot.com'

# Until we are migrated to LUCI, we will be utilizing a hard
# coded master name based on what is passed in in the build properties.
# See crbug.com/801289 for more details.
MACHINE_GROUP_JSON_FILE = os.path.join(
      path_util.GetChromiumSrcDir(), 'tools', 'perf', 'core',
      'perf_dashboard_machine_group_mapping.json')

JSON_CONTENT_TYPE = 'application/json'

# Cache of what data format (ChartJSON, Histograms, etc.) each results file is
# in so that only one disk read is required when checking the format multiple
# times.
_data_format_cache = {}
DATA_FORMAT_GTEST = 'gtest'
DATA_FORMAT_CHARTJSON = 'chartjson'
DATA_FORMAT_HISTOGRAMS = 'histograms'
DATA_FORMAT_UNKNOWN = 'unknown'


def _GetMachineGroup(build_properties):
  machine_group = None
  if build_properties.get('perf_dashboard_machine_group', False):
    # Once luci migration is complete this will exist as a property
    # in the build properties
    machine_group =  build_properties['perf_dashboard_machine_group']
  else:
    builder_group_mapping = {}
    with open(MACHINE_GROUP_JSON_FILE) as fp:
      builder_group_mapping = json.load(fp)
      if build_properties.get('builder_group', False):
        legacy_builder_group = build_properties['builder_group']
      else:
        # TODO(crbug.com/40159248): remove reference to mastername.
        legacy_builder_group = build_properties['mastername']
      if builder_group_mapping.get(legacy_builder_group):
        machine_group = builder_group_mapping[legacy_builder_group]
  if not machine_group:
    raise ValueError(
        'Must set perf_dashboard_machine_group or have a valid '
        'mapping in '
        'src/tools/perf/core/perf_dashboard_machine_group_mapping.json. '
        'See bit.ly/perf-dashboard-machine-group for more details')
  return machine_group


def _upload_perf_results(json_to_upload, name, configuration_name,
    build_properties, output_json_file):
  """Upload the contents of result JSON(s) to the perf dashboard."""
  args = [
      '--buildername',
      build_properties['buildername'],
      '--buildnumber',
      str(build_properties['buildnumber']),
      '--name',
      name,
      '--configuration-name',
      configuration_name,
      '--results-file',
      json_to_upload,
      '--results-url',
      RESULTS_URL,
      '--got-revision-cp',
      build_properties['got_revision_cp'],
      '--got-v8-revision',
      build_properties['got_v8_revision'],
      '--got-webrtc-revision',
      build_properties['got_webrtc_revision'],
      '--output-json-file',
      output_json_file,
      '--perf-dashboard-machine-group',
      _GetMachineGroup(build_properties),
  ]
  buildbucket = build_properties.get('buildbucket', {})
  if isinstance(buildbucket, six.string_types):
    buildbucket = json.loads(buildbucket)

  if 'build' in buildbucket:
    args += [
      '--project', buildbucket['build'].get('project'),
      '--buildbucket', buildbucket['build'].get('bucket'),
    ]

  if build_properties.get('got_revision'):
    args.append('--git-revision')
    args.append(build_properties['got_revision'])
  if _is_histogram(json_to_upload):
    args.append('--send-as-histograms')

  #TODO(crbug.com/40127249): log this in top level
  logging.info('upload_results_to_perf_dashboard: %s.' % args)

  # Duplicate part of the results upload to staging.
  if (configuration_name == 'linux-perf-fyi'
      and name == 'system_health.common_desktop'):
    try:
      RESULTS_URL_STAGE = 'https://chromeperf-stage.uc.r.appspot.com'
      staging_args = [(s if s != RESULTS_URL else RESULTS_URL_STAGE)
                      for s in args]
      result = upload_results_to_perf_dashboard.main(staging_args)
      logging.info('Uploaded results to staging. Return value: %d', result)
    except Exception as e:
      logging.info('Failed to upload results to staging: %s', str(e))

  return upload_results_to_perf_dashboard.main(args)


def _is_histogram(json_file):
  return _determine_data_format(json_file) == DATA_FORMAT_HISTOGRAMS


def _is_gtest(json_file):
  return _determine_data_format(json_file) == DATA_FORMAT_GTEST


def _determine_data_format(json_file):
  if json_file not in _data_format_cache:
    with open(json_file, 'rb') as f:
      data = json.load(f)
      if isinstance(data, list):
        _data_format_cache[json_file] = DATA_FORMAT_HISTOGRAMS
      elif isinstance(data, dict):
        if 'charts' in data:
          _data_format_cache[json_file] = DATA_FORMAT_CHARTJSON
        else:
          _data_format_cache[json_file] = DATA_FORMAT_GTEST
      else:
        _data_format_cache[json_file] = DATA_FORMAT_UNKNOWN
      return _data_format_cache[json_file]
    _data_format_cache[json_file] = DATA_FORMAT_UNKNOWN
  return _data_format_cache[json_file]


def _merge_json_output(output_json,
                       jsons_to_merge,
                       extra_links,
                       test_cross_device=False):
  """Merges the contents of one or more results JSONs.

  Args:
    output_json: A path to a JSON file to which the merged results should be
      written.
    jsons_to_merge: A list of JSON files that should be merged.
    extra_links: a (key, value) map in which keys are the human-readable strings
      which describe the data, and value is logdog url that contain the data.
  """
  begin_time = time.time()
  merged_results = results_merger.merge_test_results(jsons_to_merge,
                                                     test_cross_device)

  # Only append the perf results links if present
  # b/5382232 - changed from links to additional_links so that the links are
  # retained, but not propagated to the presentation layers in recipe.
  if extra_links:
    merged_results['additional_links'] = extra_links

  with open(output_json, 'w') as f:
    json.dump(merged_results, f)

  end_time = time.time()
  print_duration('Merging json test results', begin_time, end_time)
  return 0


def _handle_perf_json_test_results(
    benchmark_directory_map, test_results_list):
  """Checks the test_results.json under each folder:

  1. mark the benchmark 'enabled' if tests results are found
  2. add the json content to a list for non-ref.
  """
  begin_time = time.time()
  benchmark_enabled_map = {}
  for benchmark_name, directories in benchmark_directory_map.items():
    for directory in directories:
      # Obtain the test name we are running
      is_ref = '.reference' in benchmark_name
      enabled = True
      try:
        with open(os.path.join(directory, 'test_results.json')) as json_data:
          json_results = json.load(json_data)
          if not json_results:
            # Output is null meaning the test didn't produce any results.
            # Want to output an error and continue loading the rest of the
            # test results.
            logging.warning(
                'No results produced for %s, skipping upload' % directory)
            continue
          if json_results.get('version') == 3:
            # Non-telemetry tests don't have written json results but
            # if they are executing then they are enabled and will generate
            # chartjson results.
            if not bool(json_results.get('tests')):
              enabled = False
          if not is_ref:
            # We don't need to upload reference build data to the
            # flakiness dashboard since we don't monitor the ref build
            test_results_list.append(json_results)
      except IOError as e:
        # TODO(crbug.com/40615891): Figure out how to surface these errors.
        # Should we have a non-zero exit code if we error out?
        logging.error('Failed to obtain test results for %s: %s',
                      benchmark_name, e)
        continue
      if not enabled:
        # We don't upload disabled benchmarks or tests that are run
        # as a smoke test
        logging.info(
            'Benchmark %s ran no tests on at least one shard' % benchmark_name)
        continue
      benchmark_enabled_map[benchmark_name] = True

  end_time = time.time()
  print_duration('Analyzing perf json test results', begin_time, end_time)
  return benchmark_enabled_map


def _generate_unique_logdog_filename(name_prefix):
  return name_prefix + '_' + str(uuid.uuid4())


def _handle_perf_logs(benchmark_directory_map, extra_links):
  """ Upload benchmark logs to logdog and add a page entry for them. """
  begin_time = time.time()
  benchmark_logs_links = collections.defaultdict(list)

  for benchmark_name, directories in benchmark_directory_map.items():
    for directory in directories:
      benchmark_log_file = os.path.join(directory, 'benchmark_log.txt')
      if os.path.exists(benchmark_log_file):
        with open(benchmark_log_file) as f:
          uploaded_link = logdog_helper.text(
              name=_generate_unique_logdog_filename(benchmark_name),
              data=f.read())
          benchmark_logs_links[benchmark_name].append(uploaded_link)

  logdog_file_name = _generate_unique_logdog_filename('Benchmarks_Logs')
  logdog_stream = logdog_helper.text(
      logdog_file_name, json.dumps(benchmark_logs_links, sort_keys=True,
                                   indent=4, separators=(',', ': ')),
      content_type=JSON_CONTENT_TYPE)
  extra_links['Benchmarks logs'] = logdog_stream
  end_time = time.time()
  print_duration('Generating perf log streams', begin_time, end_time)


def _handle_benchmarks_shard_map(benchmarks_shard_map_file, extra_links):
  begin_time = time.time()
  with open(benchmarks_shard_map_file) as f:
    benchmarks_shard_data = f.read()
    logdog_file_name = _generate_unique_logdog_filename('Benchmarks_Shard_Map')
    logdog_stream = logdog_helper.text(logdog_file_name,
                                       benchmarks_shard_data,
                                       content_type=JSON_CONTENT_TYPE)
    extra_links['Benchmarks shard map'] = logdog_stream
  end_time = time.time()
  print_duration('Generating benchmark shard map stream', begin_time, end_time)


def _get_benchmark_name(directory):
  return os.path.basename(directory).replace(" benchmark", "")


def _scan_output_dir(task_output_dir):
  benchmark_directory_map = {}
  benchmarks_shard_map_file = None

  directory_list = [
      f for f in os.listdir(task_output_dir)
      if not os.path.isfile(os.path.join(task_output_dir, f))
  ]
  benchmark_directory_list = []
  for directory in directory_list:
    for f in os.listdir(os.path.join(task_output_dir, directory)):
      path = os.path.join(task_output_dir, directory, f)
      if os.path.isdir(path):
        benchmark_directory_list.append(path)
      elif path.endswith('benchmarks_shard_map.json'):
        benchmarks_shard_map_file = path
  # Now create a map of benchmark name to the list of directories
  # the lists were written to.
  for directory in benchmark_directory_list:
    benchmark_name = _get_benchmark_name(directory)
    if benchmark_name in benchmark_directory_map:
      benchmark_directory_map[benchmark_name].append(directory)
    else:
      benchmark_directory_map[benchmark_name] = [directory]

  return benchmark_directory_map, benchmarks_shard_map_file


def process_perf_results(output_json,
                         configuration_name,
                         build_properties,
                         task_output_dir,
                         smoke_test_mode,
                         output_results_dir,
                         lightweight=False,
                         skip_perf=False,
                         upload_skia_json=False):
  """Process perf results.

  Consists of merging the json-test-format output, uploading the perf test
  output (chartjson and histogram), and store the benchmark logs in logdog.

  Each directory in the task_output_dir represents one benchmark
  that was run. Within this directory, there is a subdirectory with the name
  of the benchmark that was run. In that subdirectory, there is a
  perftest-output.json file containing the performance results in histogram
  or dashboard json format and an output.json file containing the json test
  results for the benchmark.

  Returns:
    (return_code, upload_results_map):
      return_code is 0 if the whole operation is successful, non zero otherwise.
      benchmark_upload_result_map: the dictionary that describe which benchmarks
        were successfully uploaded.
  """
  handle_perf = not lightweight or not skip_perf
  handle_non_perf = not lightweight or skip_perf
  logging.info('lightweight mode: %r; handle_perf: %r; handle_non_perf: %r' %
               (lightweight, handle_perf, handle_non_perf))

  begin_time = time.time()
  return_code = 0
  benchmark_upload_result_map = {}

  benchmark_directory_map, benchmarks_shard_map_file = _scan_output_dir(
      task_output_dir)

  test_results_list = []
  extra_links = {}

  if handle_non_perf:
    # First, upload benchmarks shard map to logdog and add a page
    # entry for it in extra_links.
    if benchmarks_shard_map_file:
      _handle_benchmarks_shard_map(benchmarks_shard_map_file, extra_links)

    # Second, upload all the benchmark logs to logdog and add a page entry for
    # those links in extra_links.
    _handle_perf_logs(benchmark_directory_map, extra_links)

  # Then try to obtain the list of json test results to merge
  # and determine the status of each benchmark.
  benchmark_enabled_map = _handle_perf_json_test_results(
      benchmark_directory_map, test_results_list)

  build_properties_map = json.loads(build_properties)
  if not configuration_name:
    # we are deprecating perf-id crbug.com/817823
    configuration_name = build_properties_map['buildername']

  # The calibration project is paused and the experiments of adding device id,
  # which currently broken, is removed for now.
  # _update_perf_results_for_calibration(benchmarks_shard_map_file,
  #                                      benchmark_enabled_map,
  #                                      benchmark_directory_map,
  #                                      configuration_name)
  if not smoke_test_mode and handle_perf:
    try:
      return_code, benchmark_upload_result_map = _handle_perf_results(
          benchmark_enabled_map, benchmark_directory_map, configuration_name,
          build_properties_map, extra_links, output_results_dir,
          upload_skia_json)
    except Exception:
      logging.exception('Error handling perf results jsons')
      return_code = 1

  if handle_non_perf:
    # Finally, merge all test results json, add the extra links and write out to
    # output location
    try:
      _merge_json_output(
          output_json, test_results_list, extra_links,
          configuration_name in cross_device_test_config.TARGET_DEVICES)
    except Exception:
      logging.exception('Error handling test results jsons.')

  end_time = time.time()
  print_duration('Total process_perf_results', begin_time, end_time)
  return return_code, benchmark_upload_result_map


def _merge_chartjson_results(chartjson_dicts):
  merged_results = chartjson_dicts[0]
  for chartjson_dict in chartjson_dicts[1:]:
    for key in chartjson_dict:
      if key == 'charts':
        for add_key in chartjson_dict[key]:
          merged_results[key][add_key] = chartjson_dict[key][add_key]
  return merged_results


def _merge_histogram_results(histogram_lists):
  merged_results = []
  for histogram_list in histogram_lists:
    merged_results += histogram_list

  return merged_results


def _merge_perf_results(benchmark_name, results_filename, directories):
  begin_time = time.time()
  collected_results = []
  for directory in directories:
    filename = os.path.join(directory, 'perf_results.json')
    try:
      with open(filename) as pf:
        collected_results.append(json.load(pf))
    except IOError as e:
      # TODO(crbug.com/40615891): Figure out how to surface these errors. Should
      # we have a non-zero exit code if we error out?
      logging.error('Failed to obtain perf results from %s: %s',
                    directory, e)
  if not collected_results:
    logging.error('Failed to obtain any perf results from %s.',
                  benchmark_name)
    return

  # Assuming that multiple shards will only be chartjson or histogram set
  # Non-telemetry benchmarks only ever run on one shard
  merged_results = []
  if isinstance(collected_results[0], dict):
    merged_results = _merge_chartjson_results(collected_results)
  elif isinstance(collected_results[0], list):
    merged_results =_merge_histogram_results(collected_results)

  with open(results_filename, 'w') as rf:
    json.dump(merged_results, rf)

  end_time = time.time()
  print_duration(('%s results merging' % (benchmark_name)),
                 begin_time, end_time)


def _upload_individual(benchmark_name, directories, configuration_name,
                       build_properties, output_json_file, upload_skia_json):
  """Uploads individual benchmark.

  Args:
    benchmark_name: The name of the benchmark.
    directories: The directories to upload.
    configuration_name: The configuration name.
    build_properties: The build properties.
    output_json_file: The output json file.
    upload_skia_json: Whether to upload skia json.

  Returns:
    A tuple of (benchmark_name, upload_return_code, logdog_dict)
  """
  base_benchmark_name = benchmark_name.replace('.reference', '')
  logdog_dict = {}
  logdog_dict[base_benchmark_name] = {}
  tmpfile_dir = tempfile.mkdtemp()
  try:
    upload_begin_time = time.time()
    # There are potentially multiple directores with results, re-write and
    # merge them if necessary
    if len(directories) > 1:
      merge_perf_dir = os.path.join(
          os.path.abspath(tmpfile_dir), benchmark_name)
      if not os.path.exists(merge_perf_dir):
        os.makedirs(merge_perf_dir)
      results_filename = os.path.join(
          merge_perf_dir, 'merged_perf_results.json')
      _merge_perf_results(benchmark_name, results_filename, directories)
    else:
      # It was only written to one shard, use that shards data
      results_filename = os.path.join(directories[0], 'perf_results.json')

    results_size_in_mib = os.path.getsize(results_filename) / (2 ** 20)
    logging.info('Uploading perf results from %s benchmark (size %s Mib)' %
          (benchmark_name, results_size_in_mib))
    upload_return_code = _upload_perf_results(results_filename, benchmark_name,
                                              configuration_name,
                                              build_properties,
                                              output_json_file)
    upload_end_time = time.time()
    print_duration(('%s upload time' % (benchmark_name)), upload_begin_time,
                   upload_end_time)
    logdog_dict[base_benchmark_name]['upload_failed'] = (
        'True' if upload_return_code else 'False')
    if upload_skia_json:
      upload_return_code += _upload_skia_json(benchmark_name,
                                              configuration_name,
                                              results_filename, tmpfile_dir,
                                              build_properties,
                                              logdog_dict[base_benchmark_name])

    return (benchmark_name, upload_return_code == 0, logdog_dict)
  finally:
    shutil.rmtree(tmpfile_dir)


def _process_skia_json(
    results_filename: str,
    builder_details: json_util.PerfBuilderDetails,
    benchmark_name: str) -> Optional[Dict[Any, Any]]:
  """Converts result2 json to skia json.

  Args:
    results_filename: The filename of the results.
    builder_details: The perf builder details.
    benchmark_name: The name of the benchmark.

  Returns:
    The skia json data if successful, None otherwise.
  """
  util = json_util.JsonUtil(generate_synthetic_measurements=True)
  process_begin_time = time.time()
  with open(results_filename) as pf:
    util.add(json.load(pf))
  try:
    skia_json_data = util.process(builder_details=builder_details,
                                  benchmark_name=benchmark_name)
    process_end_time = time.time()
    print_duration(('%s skia json processing time' % (builder_details.bot)),
                   process_begin_time, process_end_time)
    return skia_json_data
  except ValueError:
    logging.exception('Error processing perf results jsons')
    return None


def _upload_skia_json(benchmark_name: str,
                      configuration_name: str,
                      results_filename: str,
                      tmpfile_dir:str,
                      build_properties: Dict[str, Any],
                      logdog_benchmark_dict: Dict[str, Any]) -> int:
  """Converts result2 json to skia json and uploads to gcs.

  Args:
    benchmark_name: The name of the benchmark.
    configuration_name: The configuration name.
    results_filename: The filename of the results.
    tmpfile_dir: The directory to store the skia json.
    build_properties: The build properties.
    logdog_benchmark_dict: The logdog dictionary entry to report errors.
  Returns:
    0 if the conversion and upload is successful, 1 otherwise.
  """
  builder_details = json_util.perf_builder_details_from_build_properties(
      properties=build_properties,
      configuration_name=configuration_name,
      machine_group=_GetMachineGroup(build_properties))
  skia_json_data = _process_skia_json(
      results_filename, builder_details, benchmark_name)
  if json_util.is_empty(skia_json_data):
    logdog_benchmark_dict['skia_json_empty'] = 'True'  # skip upload.
    logdog_benchmark_dict['skia_json_upload_skipped'] = 'True'
    return 1
  skia_results_filename = os.path.join(tmpfile_dir, 'skia_results.json')
  with open(skia_results_filename, 'w') as f:
    json.dump(skia_json_data, f)
  # Upload skia json to gcs via depot_tools/upload_to_google_storage.py
  # TODO(crbug.com/318738818): Remove the experiment_only flag once the
  # experiment is done.
  bucket_names = json_util.gcs_buckets_from_builder_name(
      builder_name=build_properties['buildername'],
      master_name=_GetMachineGroup(build_properties),
      public_copy_to_experiment=True)
  logging.info('Uploading skia json to buckets: %s', bucket_names)
  for bucket_name in bucket_names:
    dest = google_storage_helper.unique_name(
          'skia_results_%s_%s_%s' % (benchmark_name,
                                     build_properties['buildername'],
                                     build_properties['buildnumber']),
          suffix='.json')
    gcs_prefix_path = json_util.get_gcs_prefix_path(
        build_properties=build_properties,
        builder_details= builder_details,
        benchmark_name=benchmark_name,
        given_datetime=None,
        filename=dest)
    # Check for whether to upload to internal or external bucket based on the
    # builder name.
    try:
      upload_begin_time = time.time()
      google_storage_helper.upload(
        name=gcs_prefix_path,
        filepath=skia_results_filename,
        bucket=bucket_name,
        content_type='application/json',
        authenticated_link=True)
      upload_end_time = time.time()
      print_duration(('%s skia json upload time' % (benchmark_name)),
                     upload_begin_time, upload_end_time)
      logdog_benchmark_dict['skia_json_upload_failed'] = 'False'
    except FileNotFoundError:
      logging.exception('Command not found:')
      logdog_benchmark_dict['skia_json_upload_failed'] = 'True'
      return 1
    except OSError:
      logging.exception('An OS error occurred:')
      logdog_benchmark_dict['skia_json_upload_failed'] = 'True'
      return 1
    except Exception:
      logging.exception('A generic error occurred:')
      logdog_benchmark_dict['skia_json_upload_failed'] = 'True'
      return 1
  return 0


def _upload_individual_benchmark(params):
  try:
    return _upload_individual(*params)
  except Exception:
    benchmark_name = params[0]
    base_benchmark_name = benchmark_name.replace('.reference', '')
    upload_succeed = False
    logging.exception('Error uploading perf result of %s' % benchmark_name)
    return benchmark_name, upload_succeed, {
        base_benchmark_name: {
            'upload_failed': 'True'
        }
    }


def _GetCpuCount(log=True):
  try:
    cpu_count = multiprocessing.cpu_count()
    if sys.platform == 'win32':
      # TODO(crbug.com/40755900) - we can't use more than 56
      # cores on Windows or Python3 may hang.
      cpu_count = min(cpu_count, 56)
    return cpu_count
  except NotImplementedError:
    if log:
      logging.warning(
          'Failed to get a CPU count for this bot. See crbug.com/947035.')
    # TODO(crbug.com/41450490): This is currently set to 4 since the mac masters
    # only have 4 cores. Once we move to all-linux, this can be increased or
    # we can even delete this whole function and use multiprocessing.cpu_count()
    # directly.
    return 4


def _load_shard_id_from_test_results(directory):
  shard_id = None
  test_json_path = os.path.join(directory, 'test_results.json')
  try:
    with open(test_json_path) as f:
      test_json = json.load(f)
      all_results = test_json['tests']
      for _, benchmark_results in all_results.items():
        for _, measurement_result in benchmark_results.items():
          shard_id = measurement_result['shard']
          break
  except IOError as e:
    logging.error('Failed to open test_results.json from %s: %s',
                  test_json_path, e)
  except KeyError as e:
    logging.error('Failed to locate results in test_results.json: %s', e)
  return shard_id


def _find_device_id_by_shard_id(benchmarks_shard_map_file, shard_id):
  try:
    with open(benchmarks_shard_map_file) as f:
      shard_map_json = json.load(f)
      device_id = shard_map_json['extra_infos']['bot #%s' % shard_id]
  except KeyError as e:
    logging.error('Failed to locate device name in shard map: %s', e)
  return device_id


def _update_perf_json_with_summary_on_device_id(directory, device_id):
  perf_json_path = os.path.join(directory, 'perf_results.json')
  try:
    with open(perf_json_path, 'r') as f:
      perf_json = json.load(f)
  except IOError as e:
    logging.error('Failed to open perf_results.json from %s: %s',
                  perf_json_path, e)
  summary_key_guid = str(uuid.uuid4())
  summary_key_generic_set = {
      'values': ['device_id'],
      'guid': summary_key_guid,
      'type': 'GenericSet'
  }
  perf_json.insert(0, summary_key_generic_set)
  logging.info('Inserted summary key generic set for perf result in %s: %s',
               directory, summary_key_generic_set)
  stories_guids = set()
  for entry in perf_json:
    if 'diagnostics' in entry:
      entry['diagnostics']['summaryKeys'] = summary_key_guid
      stories_guids.add(entry['diagnostics']['stories'])
  for entry in perf_json:
    if 'guid' in entry and entry['guid'] in stories_guids:
      entry['values'].append(device_id)
  try:
    with open(perf_json_path, 'w') as f:
      json.dump(perf_json, f)
  except IOError as e:
    logging.error('Failed to writing perf_results.json to %s: %s',
                  perf_json_path, e)
  logging.info('Finished adding device id %s in perf result.', device_id)


def _should_add_device_id_in_perf_result(builder_name):
  # We should always add device id in calibration builders.
  # For testing purpose, adding fyi as well for faster turnaround, because
  # calibration builders run every 24 hours.
  return any(builder_name == p.name
             for p in bot_platforms.CALIBRATION_PLATFORMS) or (
                 builder_name == 'android-pixel2-perf-fyi')


def _update_perf_results_for_calibration(benchmarks_shard_map_file,
                                         benchmark_enabled_map,
                                         benchmark_directory_map,
                                         configuration_name):
  if not _should_add_device_id_in_perf_result(configuration_name):
    return
  logging.info('Updating perf results for %s.', configuration_name)
  for benchmark_name, directories in benchmark_directory_map.items():
    if not benchmark_enabled_map.get(benchmark_name, False):
      continue
    for directory in directories:
      shard_id = _load_shard_id_from_test_results(directory)
      device_id = _find_device_id_by_shard_id(benchmarks_shard_map_file,
                                              shard_id)
      _update_perf_json_with_summary_on_device_id(directory, device_id)


def _handle_perf_results(benchmark_enabled_map,
                         benchmark_directory_map,
                         configuration_name,
                         build_properties,
                         extra_links,
                         output_results_dir,
                         upload_skia_json=False):
  """
    Upload perf results to the perf dashboard.

    This method also upload the perf results to logdog and augment it to
    |extra_links|.

    Returns:
      (return_code, benchmark_upload_result_map)
      return_code is 0 if this upload to perf dashboard successfully, 1
        otherwise.
       benchmark_upload_result_map is a dictionary describes which benchmark
        was successfully uploaded.
  """
  begin_time = time.time()
  # Upload all eligible benchmarks to the perf dashboard
  results_dict = {}

  invocations = []
  for benchmark_name, directories in benchmark_directory_map.items():
    if not benchmark_enabled_map.get(benchmark_name, False):
      continue
    # Create a place to write the perf results that you will write out to
    # logdog.
    output_json_file = os.path.join(
        output_results_dir, (str(uuid.uuid4()) + benchmark_name))
    results_dict[benchmark_name] = output_json_file
    #TODO(crbug.com/40127249): pass final arguments instead of build properties
    # and configuration_name
    invocations.append((benchmark_name, directories, configuration_name,
                        build_properties, output_json_file, upload_skia_json))

  # Kick off the uploads in multiple processes
  # crbug.com/1035930: We are hitting HTTP Response 429. Limit ourselves
  # to 2 processes to avoid this error. Uncomment the following code once
  # the problem is fixed on the dashboard side.
  # pool = multiprocessing.Pool(_GetCpuCount())
  pool = multiprocessing.Pool(2)
  upload_result_timeout = False
  try:
    async_result = pool.map_async(
        _upload_individual_benchmark, invocations)
    # TODO(crbug.com/40620578): What timeout is reasonable?
    results = async_result.get(timeout=4000)
  except multiprocessing.TimeoutError:
    upload_result_timeout = True
    logging.error('Timeout uploading benchmarks to perf dashboard in parallel')
    results = []
    for benchmark_name in benchmark_directory_map:
      results.append((benchmark_name, False, {}))
  finally:
    pool.terminate()

  # Keep a mapping of benchmarks to their upload results
  benchmark_upload_result_map = {}
  logdog_dict = {}
  for r in results:
    benchmark_upload_result_map[r[0]] = r[1]
    # Because each benchmark has its own logdog_dict, update will not overwrite
    # the existing keys.
    logdog_dict.update(r[2])

  upload_failures_counter = 0
  logdog_label = 'Results Dashboard'
  for benchmark_name, output_file in results_dict.items():
    upload_succeed = benchmark_upload_result_map[benchmark_name]
    if not upload_succeed:
      upload_failures_counter += 1
    is_reference = '.reference' in benchmark_name
    _write_perf_data_to_logfile(
      benchmark_name, output_file,
      configuration_name, build_properties, logdog_dict,
      is_reference, upload_failure=not upload_succeed)

  logdog_file_name = _generate_unique_logdog_filename('Results_Dashboard_')
  logdog_stream = logdog_helper.text(logdog_file_name,
      json.dumps(dict(logdog_dict), sort_keys=True,
                  indent=4, separators=(',', ': ')),
      content_type=JSON_CONTENT_TYPE)
  if upload_failures_counter > 0:
    logdog_label += (' %s merge script perf data upload failures' %
                      upload_failures_counter)
  extra_links[logdog_label] = logdog_stream
  end_time = time.time()
  print_duration('Uploading results to perf dashboard', begin_time, end_time)
  if upload_result_timeout or upload_failures_counter > 0:
    return 1, benchmark_upload_result_map
  return 0, benchmark_upload_result_map


def _write_perf_data_to_logfile(benchmark_name, output_file,
    configuration_name, build_properties,
    logdog_dict, is_ref, upload_failure):
  viewer_url = None
  # logdog file to write perf results to
  if os.path.exists(output_file):
    results = None
    with open(output_file) as f:
      try:
        results = json.load(f)
      except ValueError:
        logging.error('Error parsing perf results JSON for benchmark  %s' %
              benchmark_name)
    if results:
      output_json_file = logdog_helper.open_text(benchmark_name)
      if output_json_file:
        viewer_url = output_json_file.get_viewer_url()
        try:
          json.dump(results, output_json_file, indent=4, separators=(',', ': '))
        except ValueError as e:
          logging.error('ValueError: "%s" while dumping output to logdog' % e)
        finally:
          output_json_file.close()
      else:
        logging.warning('Could not open output JSON file for benchmark %s' %
                        benchmark_name)
  else:
    logging.warning("Perf results JSON file doesn't exist for benchmark %s" %
          benchmark_name)

  base_benchmark_name = benchmark_name.replace('.reference', '')

  if base_benchmark_name not in logdog_dict:
    logdog_dict[base_benchmark_name] = {}

  # add links for the perf results and the dashboard url to
  # the logs section of buildbot
  if is_ref:
    if viewer_url:
      logdog_dict[base_benchmark_name]['perf_results_ref'] = viewer_url
    if upload_failure:
      logdog_dict[base_benchmark_name]['ref_upload_failed'] = 'True'
  else:
    logdog_dict[base_benchmark_name]['dashboard_url'] = (
        upload_results_to_perf_dashboard.GetDashboardUrl(
            benchmark_name,
            configuration_name, RESULTS_URL,
            build_properties['got_revision_cp'],
            _GetMachineGroup(build_properties)))
    if viewer_url:
      logdog_dict[base_benchmark_name]['perf_results'] = viewer_url
    if upload_failure:
      logdog_dict[base_benchmark_name]['upload_failed'] = 'True'


def print_duration(step, start, end):
  logging.info('Duration of %s: %d seconds' % (step, end - start))


def main():
  """ See collect_task.collect_task for more on the merge script API. """
  logging.info(sys.argv)
  parser = argparse.ArgumentParser()
  # configuration-name (previously perf-id) is the name of bot the tests run on
  # For example, buildbot-test is the name of the android-go-perf bot
  # configuration-name and results-url are set in the json file which is going
  # away tools/perf/core/chromium.perf.fyi.extras.json
  parser.add_argument('--configuration-name', help=argparse.SUPPRESS)

  parser.add_argument('--build-properties', help=argparse.SUPPRESS)
  parser.add_argument('--summary-json', help=argparse.SUPPRESS)
  parser.add_argument('--task-output-dir', help=argparse.SUPPRESS)
  parser.add_argument('-o', '--output-json', required=True,
                      help=argparse.SUPPRESS)
  parser.add_argument(
      '--skip-perf',
      action='store_true',
      help='In lightweight mode, using --skip-perf will skip the performance'
      ' data handling.')
  parser.add_argument(
      '--lightweight',
      action='store_true',
      help='Choose the lightweight mode in which the perf result handling'
      ' is performed on a separate VM.')
  parser.add_argument('json_files', nargs='*', help=argparse.SUPPRESS)
  parser.add_argument('--smoke-test-mode', action='store_true',
                      help='This test should be run in smoke test mode'
                      ' meaning it does not upload to the perf dashboard')
  parser.add_argument('--upload-skia-json',
                      action='store_true',
                      help='Upload skia formatted json to the gcs directly')

  args = parser.parse_args()

  output_results_dir = tempfile.mkdtemp('outputresults')
  try:
    return_code, _ = process_perf_results(
        args.output_json, args.configuration_name, args.build_properties,
        args.task_output_dir, args.smoke_test_mode, output_results_dir,
        args.lightweight, args.skip_perf, args.upload_skia_json)
    return return_code
  finally:
    # crbug/1378275. In some cases, the temp dir could be deleted. Add a
    # check to avoid FileNotFoundError.
    if os.path.exists(output_results_dir):
      shutil.rmtree(output_results_dir)


if __name__ == '__main__':
  sys.exit(main())