From a07cf955b2128bb13c508752e8887e7bfa202bce Mon Sep 17 00:00:00 2001
From: derrod <xlnedder@gmail.com>
Date: Sun, 22 May 2022 07:32:09 +0200
Subject: [PATCH] CI: Update service-removal PR description

---
 CI/check-services.py | 51 ++++++++++++++++++++++++++++----------------
 1 file changed, 33 insertions(+), 18 deletions(-)

diff --git a/CI/check-services.py b/CI/check-services.py
index 2ef05e887..628694028 100644
--- a/CI/check-services.py
+++ b/CI/check-services.py
@@ -10,6 +10,7 @@ import zipfile
 from io import BytesIO
 from random import randbytes
 from urllib.parse import urlparse
+from collections import defaultdict
 
 MINIMUM_PURGE_AGE = 9.75 * 24 * 60 * 60  # slightly less than 10 days
 TIMEOUT = 10
@@ -19,10 +20,15 @@ PACKAGE_FILE = 'plugins/rtmp-services/data/package.json'
 CACHE_FILE = 'other/timestamps.json'
 
 DO_NOT_PING = {'jp9000'}
-PR_MESSAGE = '''Automatic PR to remove dead servers
-Created by workflow run: https://github.com/{repository}/actions/runs/{run_id}
+PR_MESSAGE = '''This is an automatically created pull request to remove unresponsive servers and services.
 
-Authors who have modified the affected services: {authors}'''
+| Service | Action Taken | Author(s) |
+| ------- | ------------ | --------- |
+{table}
+
+If you are not responsible for an affected service and want to be excluded from future pings please let us know.
+
+Created by workflow run: https://github.com/{repository}/actions/runs/{run_id}'''
 
 # GQL is great isn't it
 GQL_QUERY = '''{
@@ -154,9 +160,9 @@ def get_last_artifact():
                 return json.loads(zip_ref.read(info.filename))
 
 
-def find_people_to_blame(raw_services: str, servers: list) -> list:
+def find_people_to_blame(raw_services: str, servers: list[tuple[str, str]]) -> dict():
     if not servers:
-        return []
+        return dict()
 
     # Fetch Blame data from github
     s = requests.session()
@@ -173,15 +179,16 @@ def find_people_to_blame(raw_services: str, servers: list) -> list:
             if user := blame['commit']['author']['user']:
                 line_author[i] = user['login']
 
-    authors = set()
+    service_authors = defaultdict(set)
     for i, line in enumerate(raw_services.splitlines()):
         if '"url":' not in line:
             continue
-        for server in servers:
-            if server in line and (author := line_author.get(i)) is not None:
-                authors.add(author)
+        for server, service in servers:
+            if server in line and (author := line_author.get(i)):
+                if author not in DO_NOT_PING:
+                    service_authors[service].add(author)
 
-    return sorted(authors ^ DO_NOT_PING)
+    return service_authors
 
 
 def main():
@@ -214,8 +221,8 @@ def main():
         print('Successfully loaded cache file:', CACHE_FILE)
 
     start_time = int(time.time())
+    affected_services = dict()
     removed_servers = list()
-    removed_something = False
 
     # create temporary new list
     new_services = services.copy()
@@ -253,7 +260,7 @@ def main():
                             f'🗑️ Purging server "{server["url"]}", it has been '
                             f'unresponsive for {round(delta/60/60/24)} days.'
                         )
-                        removed_servers.append(server['url'])
+                        removed_servers.append((server['url'], service['name']))
                         # continuing here means not adding it to the new list, thus dropping it
                         continue
                 else:
@@ -268,11 +275,12 @@ def main():
 
         if (diff := len(service['servers']) - len(new_service['servers'])) > 0:
             print(f'ℹ️ Removed {diff} server(s) from {service["name"]}')
-            removed_something = True
+            affected_services[service['name']] = f'{diff} servers removed'
 
         # remove services with no valid servers
         if not new_service['servers']:
             print(f'💀 Service "{service["name"]}" has no valid servers left, removing!')
+            affected_services[service['name']] = f'Service removed'
             continue
 
         new_services['services'].append(new_service)
@@ -288,7 +296,7 @@ def main():
     else:
         print('Successfully wrote cache file:', CACHE_FILE)
 
-    if removed_something:
+    if removed_servers:
         # increment package version and save that as well
         package['version'] += 1
         package['files'][0]['version'] += 1
@@ -309,17 +317,24 @@ def main():
 
         # try to find authors to ping, this is optional and is allowed to fail
         try:
-            authors = find_people_to_blame(raw_services, removed_servers)
+            service_authors = find_people_to_blame(raw_services, removed_servers)
         except Exception as e:
             print(f'⚠ Could not fetch blame for some reason: {e}')
-            authors = []
+            service_authors = dict()
 
-        # set github outputs
+        # set GitHub outputs
         print(f'::set-output name=make_pr::true')
         msg = PR_MESSAGE.format(
             repository=os.environ['REPOSITORY'],
             run_id=os.environ['WORKFLOW_RUN_ID'],
-            authors=', '.join(f'@{author}' for author in authors),
+            table='\n'.join(
+                '| {name} | {action} | {authors} |'.format(
+                    name=name.replace('|', '\\|'),
+                    action=action,
+                    authors=', '.join(f'@{author}' for author in sorted(service_authors.get(name, []))),
+                )
+                for name, action in sorted(affected_services.items())
+            ),
         )
         print(f'::set-output name=pr_message::{json.dumps(msg)}')
     else: