Post contract size diff to parent PR

.gitlab-ci.yml

@@ -32,6 +32,9 @@ workflow:
     REDISCLI_AUTH:
       vault:                       cicd/gitlab/parity/REDIS_AUTH@kv
       file:                        false
+    GITHUB_TOKEN:
+      vault:                       cicd/gitlab/parity/ink/GITHUB_TOKEN@kv
+      file:                        false
 
 
 .default-refs:                      &default-refs
@@ -77,12 +80,12 @@ workflow:
     - kubernetes-parity-build
 
 
-.if-trigger-ref-is-master:           &if-trigger-ref-is-master
+.if-trigger-ref-valid:            &if-trigger-ref-valid
   before_script:
-    - if [ "$TRGR_REF" == "master" ]; then
-        echo "It makes no sense to compare $REDIS_SIZES_KEY to $REDIS_SIZES_KEY_MASTER."
-        echo "Exiting gracefully."
-        exit 0
+    - if [ "$TRGR_REF" == "master" ] || [ -z "$TRGR_REF" ]; then
+        echo "It makes no sense to compare $REDIS_SIZES_KEY to $REDIS_SIZES_KEY_MASTER.";
+        echo "Exiting gracefully.";
+        exit 0;
       fi
 
 .clone-repo:                       &clone-repo
@@ -101,7 +104,7 @@ workflow:
   - pkill -f "substrate-contracts-node-rand-extension --tmp --dev"
 
 
-# needed vars have to be "exported" on a earlier stage
+# Needed vars have to be "exported" in an earlier stage
 parent-vars:
   stage:                                             declare-vars
   <<:                                                *kubernetes-env
@@ -131,12 +134,12 @@ parent-vars:
     - echo "UPSTREAM_REPO_NAME=${UPSTREAM_REPO_NAME}" | tee -a parent-vars.env
 
     # REDIS_SIZES_KEY (e.g. ink-waterfall::ink::foo-add-feature::sizes)
-    # defines a Redis key name where contract sizes will be stored frpm a upstrem above
+    #   defines a Redis key name where contract sizes will be stored from an upstream above.
     - echo "REDIS_SIZES_KEY=${CI_PROJECT_NAME}::${UPSTREAM_REPO_NAME}::${UPSTREAM_BRANCH_REDIS_KEY}::sizes" | tee -a parent-vars.env
 
     # REDIS_SIZES_KEY_MASTER (e.g. ink-waterfall::ink::master::sizes)
-    #  defines a Redis key name for a upstream's master reference branch. contracts sizes stored there will be used for
-    #  a comparison with contract sizes stored in REDIS_SIZES_KEY
+    #   defines a Redis key name for an upstream's master reference branch.
+    #   contract sizes stored there will be used for a comparison with contract sizes stored in REDIS_SIZES_KEY.
     - echo "REDIS_SIZES_KEY_MASTER=${CI_PROJECT_NAME}::${UPSTREAM_REPO_NAME}::master::sizes" | tee -a parent-vars.env
   artifacts:
     reports:
@@ -174,24 +177,6 @@ polkadot-js-ui-ink-examples:       &polkadot-js-ui-ink-examples
   dependencies:
     - parent-vars
 
-polkadot-js-ui-ink-examples-compare:
-  stage:                           compare-build
-  <<:                              *kubernetes-env
-  <<:                              *vault-secrets
-  # Comparison is made only if a parent (trigger) was created on PRs. Otherwise we would
-  # would be comparing `master` with `master`.
-  #
-  # TODO: While we lack comparison data for master, lets "compare" everything
-  # <<:                              *if-trigger-ref-is-master
-  script:
-    - echo "$REDIS_SIZES_KEY will be compared to $REDIS_SIZES_KEY_MASTER"
-    # Deserialize comparison data
-    - redis-cli -u $GITLAB_REDIS_URI --raw lrange $REDIS_SIZES_KEY 0 -1 | tee $REDIS_SIZES_KEY.csv
-    - redis-cli -u $GITLAB_REDIS_URI --raw lrange $REDIS_SIZES_KEY_MASTER 0 -1 | tee $REDIS_SIZES_KEY_MASTER.csv
-    - cargo install --git https://github.com/HCastano/csv-comparator
-    # TODO [#4]: Post the results of this script on GitHub
-    - csv-comparator $REDIS_SIZES_KEY_MASTER.csv $REDIS_SIZES_KEY.csv | tee contract-size-diff.csv
-
 
 polkadot-js-ui-rand-extension:
   stage:                           test
@@ -204,6 +189,21 @@ polkadot-js-ui-rand-extension:
     - *shutdown-substrate-contracts-node-rand-extension
 
 
+evaluate-ink-examples-size-changes:
+  stage:                           compare-build
+  <<:                              *kubernetes-env
+  <<:                              *vault-secrets
+  # Comparison is made only if a parent (trigger) was created by a PR.
+  # Otherwise we would be comparing `master` with `master`.
+  <<:                              *if-trigger-ref-valid
+  script:
+    # Deserialize comparison data
+    - redis-cli -u $GITLAB_REDIS_URI --raw lrange $REDIS_SIZES_KEY 0 -1 | sort | tee $REDIS_SIZES_KEY.csv
+    - redis-cli -u $GITLAB_REDIS_URI --raw lrange $REDIS_SIZES_KEY_MASTER 0 -1 | sort | tee $REDIS_SIZES_KEY_MASTER.csv
+    - PR_COMMENTS_URL=https://api.github.com/repos/paritytech/ink/issues/${TRGR_REF}/comments
+    - ./.scripts/evaluate-examples-size-changes.sh $REDIS_SIZES_KEY_MASTER.csv $REDIS_SIZES_KEY.csv $PR_COMMENTS_URL
+
+
 build_badge:
   stage:                           compare-build
   rules:

.scripts/evaluate-examples-size-changes.sh

@@ -0,0 +1,77 @@
+#!/bin/bash
+
+# Evaluates size changes of the ink! examples and posts the results
+# as a comment on GitHub.
+#
+# Usage:
+#   ./evaluate-examples-size-changes.sh \
+#     <path_to_baseline.csv> <path_to_size_change.csv> \
+#     <github_url_to_comments_of_pr>
+
+set -eux
+
+BASELINE_FILE=$1
+COMPARISON_FILE=$2
+PR_COMMENTS_URL=$3
+
+echo "$BASELINE_FILE will be compared to $COMPARISON_FILE"
+
+csv-comparator $BASELINE_FILE $COMPARISON_FILE | \
+  sort | \
+  awk -F"," '{printf "`%s`,%.2f K,%.2f K\n", $1, $2, $3}' | \
+  # prepend a plus in front of all positive numbers
+  sed --regexp-extended 's/^([0-9])/,+\1/g' | \
+  sed --regexp-extended 's/,([0-9])/,+\1/g' | \
+  tee pure-contract-size-diff.csv
+
+# Append the original optimized size (i.e. not the delta) to the end of each line
+cat $COMPARISON_FILE | \
+  sort | uniq | \
+  egrep --only-matching ', [0-9]+\.[0-9]+$' | \
+  awk -F", " '{printf ",%.2f K\n", $2}' | \
+  tee total-optimized-size.csv
+
+paste -d "" pure-contract-size-diff.csv total-optimized-size.csv | tee combined.csv
+
+echo " ,Δ Original Size,Δ Optimized Size,Total Optimized Size" | tee contract-size-diff.csv
+cat combined.csv | sed 's/+0.00 K//g' | tee --append contract-size-diff.csv
+csv2md --pretty < contract-size-diff.csv | tee contract-size-diff.md
+
+# Replace `\n` so that it works propely when submitted to the GitHub API.
+# Also align the table text right.
+cat contract-size-diff.md | \
+  sed 's/---|/---:|/g' | \
+  sed --regexp-extended 's/(-+)\:/:\1/' | \
+  sed 's/$/\\n/g' | \
+  tr -d '\n' | \
+  tee contract-size-diff-newlines.md
+COMMENT=$(cat contract-size-diff-newlines.md)
+
+# If there is already a comment by the user `paritytech-ci` in the ink! PR which triggered
+# this run, then we can just edit this comment (using `PATCH` instead of `POST`).
+POSSIBLY_COMMENT_URL=$(curl --silent $PR_COMMENTS_URL | \
+  jq -r ".[] | select(.user.login == \"paritytech-ci\") | .url" | \
+  head -n1
+)
+echo $POSSIBLY_COMMENT_URL
+
+VERB="POST"
+if [ ! -z "$POSSIBLY_COMMENT_URL" ]; then
+   VERB="PATCH";
+   PR_COMMENTS_URL="$POSSIBLY_COMMENT_URL"
+fi
+
+echo $VERB
+echo $PR_COMMENTS_URL
+
+UPDATED=$(TZ='Europe/Berlin' date)
+CC_VERSION=$(cargo-contract --version | egrep --only-matching "cargo-contract [^-]*")
+curl -X ${VERB} ${PR_COMMENTS_URL} \
+    -H "Cookie: logged_in=no" \
+    -H "Authorization: token ${GITHUB_TOKEN}" \
+    -H "Content-Type: application/json; charset=utf-8" \
+    -d $"{ \
+\"body\": \"## 🦑 📈 ink! Example Contracts ‒ Size Change Report 📉 🦑\\n \
+These are the results of building the \`examples/*\` contracts from this branch with \`$CC_VERSION\`. \\n\\n\
+${COMMENT}\n\n[Link to the run](https://gitlab.parity.io/parity/ink-waterfall/-/pipelines/${CI_PIPELINE_ID}) | Last update: ${UPDATED}\" \
+    }"