From 2fb8505ada810fce8b01ff01e4e510a0a50aaa76 Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Tue, 30 Aug 2022 18:11:31 +0200
Subject: [PATCH] tooling: Cache some GitHub api results

[skip ci]
---
 script/github_pr_errors | 39 ++++++++++++++++++++++++++++++++++-----
 1 file changed, 34 insertions(+), 5 deletions(-)

diff --git a/script/github_pr_errors b/script/github_pr_errors
index 576846f0d19..f986238410e 100755
--- a/script/github_pr_errors
+++ b/script/github_pr_errors
@@ -9,6 +9,9 @@ require 'json'
 require 'rest-client'
 require 'pry'
 
+GITHUB_API_OPENPROJECT_PREFIX = "https://api.github.com/repos/opf/openproject"
+RAILS_ROOT = Pathname.new(__dir__).dirname
+
 # current branch
 branch_name = `git rev-parse --abbrev-ref HEAD`.strip
 
@@ -23,7 +26,7 @@ def get_http(path)
     if path.start_with?('http')
       path
     else
-      "https://api.github.com/repos/opf/openproject/#{path}"
+      "#{GITHUB_API_OPENPROJECT_PREFIX}/#{path}"
     end
 
   response = RestClient::Request.new(
@@ -43,12 +46,39 @@ def get_json(path)
   JSON.parse(get_http(path))
 end
 
+def get_cached_json(path)
+  unique_name = path
+    .gsub(/\?.*$/, '') # remove query parameter
+    .gsub(/^#{GITHUB_API_OPENPROJECT_PREFIX}\/?/, '') # remove https://.../
+    .gsub(/\W/, '_') # transform non alphanum chars
+  cached(unique_name) { get_json(path) }
+end
+
 def commit_message(workflow_run)
-  get_json("commits/#{workflow_run['head_sha']}?per_page=1")
+  get_cached_json("commits/#{workflow_run['head_sha']}?per_page=1")
     .then { |commit_response| commit_response["commit"]["message"] }
     .then { |message| message.split("\n", 2).first }
 end
 
+def get_log(job)
+  cached("job_#{job['id']}.log") do
+    get_http("actions/jobs/#{job['id']}/logs")
+  end
+end
+
+def cached(unique_name)
+  cached_file = RAILS_ROOT.join("tmp/github_pr_errors/#{unique_name}")
+  if cached_file.file?
+    content = cached_file.read
+    content.start_with?("---") ? YAML::load(content) : content
+  else
+    content = yield
+    cached_file.dirname.mkpath
+    cached_file.write(content.is_a?(String) ? content : YAML::dump(content))
+    content
+  end
+end
+
 warn "Looking for the last 'Test suite' workflow run in branch #{branch_name}"
 
 response = get_json "actions/runs?branch=#{CGI.escape(branch_name)}"
@@ -65,14 +95,13 @@ warn "  Commit SHA: #{last_test_action['head_sha']}"
 warn "  Commit message: #{commit_message(last_test_action)}"
 
 errors = []
-get_json(last_test_action['jobs_url'])
+get_cached_json(last_test_action['jobs_url'])
   .then { |jobs_response| jobs_response['jobs'] }
   .select { _1['conclusion'] == 'failure' }
   .sort_by { _1['name'] }
   .each { warn "  #{_1['name']}: #{_1['conclusion']}" }
   .each do |job|
-    log = get_http "actions/jobs/#{job['id']}/logs"
-    log.scan(/^\S+ rspec (\S+) #.+$/) do |match|
+    get_log(job).scan(/^\S+ rspec (\S+) #.+$/) do |match|
       errors << match
     end
   end