/ps-update command

jonico · jonico · commit b58710ba6e93 · 2021-11-30T07:37:06.000-08:00
diff --git a/.github/workflows/issue-ops-ps-commands.yml b/.github/workflows/issue-ops-ps-commands.yml
@@ -7,7 +7,7 @@ on:
 jobs:
   prechecks:
     name: Permission pre-check
-    if: github.event.issue.pull_request != null && (startsWith(github.event.comment.body, '/ps-merge') || startsWith(github.event.comment.body, '/ps-create'))
+    if: github.event.issue.pull_request != null && (startsWith(github.event.comment.body, '/ps-merge') || startsWith(github.event.comment.body, '/ps-create') || startsWith(github.event.comment.body, '/ps-update'))
     outputs:
       ref: ${{steps.prechecks.outputs.ref}}
       eyes: ${{steps.prechecks.outputs.eyes}}
@@ -515,3 +515,204 @@ jobs:
               comment_id: ${{github.event.comment.id}},
               reaction_id: ${{needs.prechecks.outputs.eyes}}
             })
+
+  act-on-ps-update-request:
+      name: "/ps-update - click here ..."
+      if: startsWith(github.event.comment.body, '/ps-update')
+      needs: [prechecks]
+      runs-on: ubuntu-latest
+      steps:
+        - name: Validating command and associated PS env
+          id: validate_params
+          env:
+            REF: ${{ needs.prechecks.outputs.ref }}
+            comment: ${{ github.event.comment.body }}
+          uses: actions/github-script@v3
+          with:
+            github-token: ${{ secrets.GITHUB_TOKEN }}
+            script: |
+              const { REF, comment } = process.env;
+
+              // check if comment starts with '/ps-update' and is only followed by whitespaces
+              const regexCommandWithoutParameters = /^\/ps-update\s*$/
+
+              // check if comment starts with '/ps-update' and is followed by a valid DDL
+              const regexCommandWithDDL = /^\/ps-update\s+"([^"]*)"\s*$/
+
+              BRANCH_NAME = REF
+              DDL_STATEMENTS = ""
+              DDL_UPDATED = ""
+
+              // check which of the two regexes above matches the comment, override BRANCH_NAME and DDL_STATEMENTS if present, error if none of the above matches
+              if (regexCommandWithoutParameters.test(comment)) {
+                console.log("/ps-update command without parameters")
+              } else if (regexCommandWithDDL.test(comment)) {
+                console.log("/ps-update command with DDL")
+                DDL_STATEMENTS = comment.match(regexCommandWithDDL)[1]
+                DDL_UPDATED = "and database schema"
+              } else {
+                message = 'Invalid command, please use \`/ps-update`, or \`/ps-update "<DDL>"\`.'
+                core.setOutput('error', message)
+                throw new Error(message)
+              }
+              
+              core.info("DB branch name: " + BRANCH_NAME)
+              core.setOutput('BRANCH_NAME',  BRANCH_NAME)
+              core.info("DDL statements: " + DDL_STATEMENTS)
+              core.setOutput('DDL_STATEMENTS',  DDL_STATEMENTS)
+
+              const ps_env_name = '.pscale/ps-env-' + REF + ".sh"
+              // check whether file ps_env_name exists in the repo and given ref
+              try {
+                const response = await github.repos.getContent({
+                  ...context.repo,
+                  path: ps_env_name,
+                  ref: REF
+                })
+              } catch (error) {
+                // check error code
+                if (error.status !== 404) {
+                  throw error
+                } else {
+                  message = 'Script ' + ps_env_name + ' does not exists, please use \`/ps-create <branch> "<DDL>"\` to create a DB branch first.'
+                  core.setOutput('error', message)
+                  throw new Error(message)
+                }
+              }
+              
+              const log_url = `${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/actions/runs/${process.env.GITHUB_RUN_ID}`
+              
+              const commentBody = `\
+              👋 __${context.actor}__, updating information ${DDL_UPDATED} of DB branch __${BRANCH_NAME}__ and Git branch __${REF}__ now ...
+              
+              You can watch the progress and authorize access [here](${log_url}).
+              `;
+              
+              await github.issues.createComment({
+                ...context.repo,
+                issue_number: context.issue.number,
+                body: commentBody
+              })
+
+        - name: Checkout
+          uses: actions/checkout@v2
+          with:
+            ref: ${{ needs.prechecks.outputs.ref }}
+
+        - name: Update DB branch (info) - if asked, please click on displayed link to authenticate
+          id: update-db-branch
+          timeout-minutes: 3
+          env:
+            PLANETSCALE_SERVICE_TOKEN_NAME: ${{secrets.PLANETSCALE_SERVICE_TOKEN_NAME}}
+            PLANETSCALE_SERVICE_TOKEN: ${{secrets.PLANETSCALE_SERVICE_TOKEN}}
+            REF: ${{ needs.prechecks.outputs.ref }}
+            ORG_NAME: ${{secrets.ORG_NAME}}
+            GITHUB_USER: ${{github.actor}}
+            DDL_STATEMENTS: ${{ steps.validate_params.outputs.DDL_STATEMENTS }}
+            BRANCH_NAME: ${{ steps.validate_params.outputs.BRANCH_NAME }}
+          run: . .pscale/ps-env-${REF}.sh && ./update-db-branch.sh "$BRANCH_NAME" "$DDL_STATEMENTS" "$DEPLOY_REQUEST_NUMBER"
+
+        - name: Database branch and DR update succeeded
+          id: ps-update-succeeded
+          if: success()
+          uses: actions/github-script@v3
+          env:
+            DEPLOY_REQUEST_URL: ${{ steps.update-db-branch.outputs.DEPLOY_REQUEST_URL }}
+            BRANCH_NAME: ${{ steps.update-db-branch.outputs.BRANCH_NAME }}
+            BRANCH_URL: ${{ steps.update-db-branch.outputs.BRANCH_URL }}
+            DB_NAME: ${{ steps.update-db-branch.outputs.DB_NAME }}
+            ORG_NAME: ${{ steps.update-db-branch.ORG_NAME }}
+            DDL_STATEMENTS: ${{ steps.validate_params.outputs.DDL_STATEMENTS }}
+            BRANCH_DIFF: ${{ steps.update-db-branch.outputs.BRANCH_DIFF }}
+          with:
+            github-token: ${{ secrets.GITHUB_TOKEN }}
+            script: |
+              const { DEPLOY_REQUEST_URL, BRANCH_NAME, BRANCH_URL, DB_NAME, ORG_NAME, DDL_STATEMENTS, BRANCH_DIFF } = process.env;
+              const log_url = `${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/actions/runs/${process.env.GITHUB_RUN_ID}`
+              
+              const commentBody = `\
+              ### Updated database branch (info) successfully :tada:
+
+              * :seedling: __DB-Branch__: [${BRANCH_NAME}](${BRANCH_URL})
+              * :train2: [Deploy request](${DEPLOY_REQUEST_URL})
+
+              <details>
+              <summary>:scroll: Added DDL-Statements:</summary>
+              
+              \`\`\`
+              ${DDL_STATEMENTS}
+              \`\`\`
+
+              </details>
+
+              <details>
+              <summary>📖 Calculated schema changes:</summary>
+              
+              \`\`\`
+              ${BRANCH_DIFF}
+              \`\`\`
+
+              </details>
+              
+              `;
+              
+              github.issues.createComment({
+                ...context.repo,
+                issue_number: ${{ github.event.issue.number }},
+                body: commentBody
+              });
+
+              await github.reactions.createForIssueComment({
+                ...context.repo,
+                comment_id: ${{github.event.comment.id}},
+                content: '+1'
+              })
+
+              await github.reactions.deleteForIssueComment({
+                ...context.repo,
+                comment_id: ${{github.event.comment.id}},
+                reaction_id: ${{needs.prechecks.outputs.eyes}}
+              })
+
+        - name: /ps-update failed
+          id: ps-update-failed
+          if: cancelled() || failure()
+          uses: actions/github-script@v3
+          env:
+            REF: ${{ needs.prechecks.outputs.ref }}
+            message: ${{steps.validate_params.outputs.error}}
+            DEPLOY_REQUEST_URL: ${{ steps.update-db-branch.outputs.DEPLOY_REQUEST_URL }}
+            BRANCH_NAME: ${{ steps.update-db-branch.outputs.BRANCH_NAME }}
+            BRANCH_URL: ${{ steps.update-db-branch.outputs.BRANCH_URL }}
+            DB_NAME: ${{ steps.update-db-branch.outputs.DB_NAME }}
+            ORG_NAME: ${{ steps.update-db-branch.ORG_NAME }}
+          with:
+            github-token: ${{ secrets.GITHUB_TOKEN }}
+            script: |              
+              const { REF, message, DEPLOY_REQUEST_URL, BRANCH_NAME, BRANCH_URL, DB_NAME, ORG_NAME } = process.env;
+              const log_url = `${process.env.GITHUB_SERVER_URL}/${context.repo.owner}/${context.repo.repo}/actions/runs/${process.env.GITHUB_RUN_ID}`
+
+              if (message === null || message === '') {
+                errorMessage = `Updating failed for branch __${REF}__ :cry:. [View error logs](${log_url}).`
+              } else {
+                errorMessage = message
+              }
+
+              github.issues.createComment({
+                  ...context.repo,
+                  issue_number: ${{ github.event.issue.number }},
+                  body: errorMessage
+                })
+
+
+              await github.reactions.createForIssueComment({
+                ...context.repo,
+                comment_id: ${{github.event.comment.id}},
+                content: '-1'
+              })
+
+              await github.reactions.deleteForIssueComment({
+                ...context.repo,
+                comment_id: ${{github.event.comment.id}},
+                reaction_id: ${{needs.prechecks.outputs.eyes}}
+              })
diff --git a/ps-create-helper-functions.sh b/ps-create-helper-functions.sh
@@ -77,10 +77,14 @@ function create-diff-for-ci {
     local deploy_request="https://app.planetscale.com/${ORG_NAME}/${DB_NAME}/deploy-requests/${deploy_request_number}"
     local BRANCH_DIFF="Diff could not be generated for deploy request $deploy_request"
 
-    local raw_output=`pscale deploy-request diff "$DB_NAME" "$deploy_request_number" --org "$ORG_NAME" --format=json | jq .[].raw`
+    # read shell output line by line and assign to variable
+    while read -r line; do
+        raw_output="$raw_output\n$line"
+    done < <(pscale deploy-request diff "$DB_NAME" "$deploy_request_number" --org "$ORG_NAME" --format=json | jq .[].raw)
+
     
     if [ $? -ne 0 ]; then
-        BRANCH_DIFF="$BRANCH_DIFF : $raw_output"
+        BRANCH_DIFF="$BRANCH_DIFF : ${raw_output}"
     else
         BRANCH_DIFF=$raw_output
     fi
diff --git a/update-db-branch.sh b/update-db-branch.sh
@@ -0,0 +1,16 @@
+#!/bin/bash
+
+. use-pscale-docker-image.sh
+
+. authenticate-ps.sh
+
+BRANCH_NAME="$1"
+DDL_STATEMENTS="$2"
+DEPLOY_REQUEST_NUMBER="$3"
+
+
+. set-db-and-org-and-branch-name.sh
+
+. ps-create-helper-functions.sh
+create-schema-change "$DB_NAME" "$BRANCH_NAME" "$ORG_NAME" "$DDL_STATEMENTS"
+create-diff-for-ci "$DB_NAME" "$ORG_NAME" "$DEPLOY_REQUEST_NUMBER"
