Adding /ps-attach issue ops command

jonico · jonico · commit 1fffa71de7ab · 2022-01-17T10:47:00.000+01:00
diff --git a/.github/workflows/issue-ops-ps-commands.yml b/.github/workflows/issue-ops-ps-commands.yml
@@ -11,7 +11,7 @@ env:
 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') || startsWith(github.event.comment.body, '/ps-update') || startsWith(github.event.comment.body, '/ps-approve') || startsWith(github.event.comment.body, '/ps-delete'))
+    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') || startsWith(github.event.comment.body, '/ps-approve') || startsWith(github.event.comment.body, '/ps-delete') || startsWith(github.event.comment.body, '/ps-attach'))
     outputs:
       ref: ${{steps.prechecks.outputs.ref}}
       eyes: ${{steps.prechecks.outputs.eyes}}
@@ -236,7 +236,7 @@ jobs:
         
             const commentBody = `\
             ### Schema changes merged successfully :tada:
-
+                          
             * :seedling: __DB-Branch__: [${BRANCH_NAME}](${BRANCH_URL})
             * :train2: [Deploy request](${DEPLOY_REQUEST_URL})
 
@@ -447,7 +447,7 @@ jobs:
         working-directory: ${{env.pscale_base_directory}}/cli-helper-scripts/
         run: |
           mkdir -p ../env/
-          envsubst < ps-env-template.sh > ../env/ps-env-${BRANCH_NAME}.sh
+          envsubst < ps-env-template.sh > ../env/ps-env-${REF}.sh
           chmod a+x ../env/ps-env-${REF}.sh
 
       - name: Commit changes
@@ -1092,3 +1092,220 @@ jobs:
                 comment_id: ${{github.event.comment.id}},
                 reaction_id: ${{needs.prechecks.outputs.eyes}}
               })
+
+  act-on-ps-attach-request:
+    name: "/ps-attach - click here ..."
+    if: startsWith(github.event.comment.body, '/ps-attach')
+    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 }}
+          baseDirectory: ${{env.pscale_base_directory}}
+        uses: actions/github-script@v3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const { REF, comment, baseDirectory } = process.env;
+            deployRequestURL = orgName = dbName = branchName = deployRequestNumber = attachedEntity = "";
+
+            // check if comment starts with '/ps-attach' and is followed by a PlanetScale deployment URL in the form of 'https://app.planetscale.com/organization/database/deploy-requests/deployrequest-id'
+            // extract the deploy request number, and the organization name and database name from the URL
+            const regexpDeployRequest = /\/ps-attach\s+(https:\/\/app\.planetscale\.com\/([^\/]+)\/([^\/]+)\/deploy-requests\/([0-9]+))/;
+
+            // check if comment starts with '/ps-attach' and is followed by a PlanetScale branch URL in the form of 'https://app.planetscale.com/organization/database/branch-name'
+            const regexpBranch = /\/ps-attach\s+(https:\/\/app\.planetscale\.com\/([^\/]+)\/([^\/]+)\/([^\/]+))/;
+
+            // test comment with regexp for deploy request
+            if (regexpDeployRequest.test(comment)) {
+              const match = comment.match(regexpDeployRequest);
+              [, deployRequestURL, orgName, dbName, deployRequestNumber] = match;
+              attachedEntity = "deploy request ___" + deployRequestURL + "___";
+            } else if (regexpBranch.test(comment)) {
+              const match = comment.match(regexpBranch);
+              [, branchURL, orgName, dbName, branchName] = match;
+              attachedEntity = "DB branch ___" + branchName + "___";
+            } else {
+              message = `Invalid command. Please use the following format: \`/ps-attach https://app.planetscale.com/organization/database/deploy-requests/deployrequest-number\` or \`/ps-attach https://app.planetscale.com/organization/database/branch-name\``
+              core.setOutput('error', message);
+              throw new Error(message);
+            }
+            
+            core.setOutput('DEPLOY_REQUEST_URL', deployRequestURL);
+            core.setOutput('ORG_NAME', orgName);
+            core.setOutput('DB_NAME', dbName);
+            core.setOutput('DEPLOY_REQUEST_NUMBER', deployRequestNumber);
+            core.setOutput('BRANCH_NAME', branchName);
+
+            const ps_env_name = baseDirectory + '/env/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
+              })
+              if (response.data.content) {
+                message = 'Script \`' + ps_env_name + '\` already exists, please use \`/ps-update "<DDL>"\` to update existing env.'
+                core.setOutput('error', message)
+                throw new Error(message)
+              }
+            } catch (error) {
+              // check error code and rethrow if not 404
+              if (error.status !== 404) {
+                throw error
+              }
+            }
+            
+            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}__, attaching ${attachedEntity} to 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: Retrieve info on attached PS objects - if asked, please click on displayed link to authenticate
+        id: retrieve-attached-info
+        timeout-minutes: 3
+        env:
+          REF: ${{needs.prechecks.outputs.ref}}
+          PLANETSCALE_SERVICE_TOKEN_NAME: ${{secrets.PLANETSCALE_SERVICE_TOKEN_NAME}}
+          PLANETSCALE_SERVICE_TOKEN: ${{secrets.PLANETSCALE_SERVICE_TOKEN}}
+          DB_NAME: ${{steps.validate_params.outputs.DB_NAME}}
+          ORG_NAME: ${{steps.validate_params.outputs.ORG_NAME}}
+          DEPLOY_REQUEST_URL: ${{steps.validate_params.outputs.DEPLOY_REQUEST_URL}}
+          DEPLOY_REQUEST_NUMBER: ${{steps.validate_params.outputs.DEPLOY_REQUEST_NUMBER}}
+          BRANCH_NAME: ${{steps.validate_params.outputs.BRANCH_NAME}}
+        working-directory: ${{env.pscale_base_directory}}/cli-helper-scripts/
+        run: | 
+          if [ -z "$DEPLOY_REQUEST_NUMBER" ]; then
+            ./retrieve-branch-info.sh "$DB_NAME" "$ORG_NAME" "$BRANCH_NAME"
+          else
+            ./retrieve-deploy-request-info.sh "$DB_NAME" "$ORG_NAME" "$DEPLOY_REQUEST_NUMBER"
+          fi
+
+      - name: Write information about associated PS database entities
+        env:
+          REF: ${{ needs.prechecks.outputs.ref }}
+          BRANCH_NAME: ${{ steps.retrieve-attached-info.outputs.BRANCH_NAME }} 
+          DB_NAME: ${{ steps.retrieve-attached-info.outputs.DB_NAME }}
+          ORG_NAME: ${{ steps.retrieve-attached-info.outputs.ORG_NAME }}
+          DEPLOY_REQUEST_NUMBER: ${{ steps.retrieve-attached-info.outputs.DEPLOY_REQUEST_NUMBER }}
+          DEPLOY_REQUEST_URL: ${{ steps.retrieve-attached-info.outputs.DEPLOY_REQUEST_URL }}
+          BRANCH_URL: ${{ steps.retrieve-attached-info.outputs.BRANCH_URL }}
+        working-directory: ${{env.pscale_base_directory}}/cli-helper-scripts/
+        run: |
+          mkdir -p ../env/
+          envsubst < ps-env-template.sh > ../env/ps-env-${REF}.sh
+          chmod a+x ../env/ps-env-${REF}.sh
+          
+      - name: Commit changes
+        uses: elstudio/actions-js-build/commit@v4
+        with:
+          commitMessage: Attach PS environment to branch ${{ steps.retrieve-attached-info.outputs.BRANCH_NAME }}
+
+      - name: PS Attach Deploy Request succeeded
+        id: ps-attach-succeeded
+        if: success()
+        uses: actions/github-script@v3
+        env:
+          DEPLOY_REQUEST_URL: ${{ steps.retrieve-attached-info.outputs.DEPLOY_REQUEST_URL }}
+          BRANCH_NAME: ${{ steps.retrieve-attached-info.outputs.BRANCH_NAME }}
+          BRANCH_URL: ${{ steps.retrieve-attached-info.outputs.BRANCH_URL }}
+          DB_NAME: ${{ steps.retrieve-attached-info.outputs.DB_NAME }}
+          ORG_NAME: ${{ steps.retrieve-attached-info.ORG_NAME }}
+          BRANCH_DIFF: ${{ steps.retrieve-attached-info.outputs.BRANCH_DIFF }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const { DEPLOY_REQUEST_URL, BRANCH_NAME, BRANCH_URL, DB_NAME, ORG_NAME, 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 = `\
+            ### Deploy request and DB branch attached successfully :tada:
+
+            * :seedling: __DB-Branch__: [${BRANCH_NAME}](${BRANCH_URL})
+            * :train2: [Deploy request](${DEPLOY_REQUEST_URL})
+            * :lock: __Branch connection info__: [One-time link](${{ steps.retrieve-attached-info.outputs.CONNECTION_STRING_LINK }})
+
+            <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-attach failed
+        id: ps-attach-failed
+        if: cancelled() || failure()
+        uses: actions/github-script@v3
+        env:
+          REF: ${{ needs.prechecks.outputs.ref }}
+          message: ${{steps.validate_params.outputs.error}}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |              
+            const { REF, message } = 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 = `Ataching DR/DB branch 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/.pscale/cli-helper-scripts/ps-create-helper-functions.sh b/.pscale/cli-helper-scripts/ps-create-helper-functions.sh
@@ -57,7 +57,12 @@ function create-deploy-request {
         echo "Deploy request could not be created: $raw_output"
         exit 1
     fi
-    deploy_request_number=`echo $raw_output | jq -r '.number'`
+    local deploy_request_number=`echo $raw_output | jq -r '.number'`
+    # if deploy request number is empty, then error
+    if [ -z "$deploy_request_number" ]; then
+        echo "Could not retrieve deploy request number: $raw_output"
+        exit 1
+    fi
 
     local deploy_request="https://app.planetscale.com/${ORG_NAME}/${DB_NAME}/deploy-requests/${deploy_request_number}"
     echo "Check out the deploy request created at $deploy_request"
@@ -69,6 +74,75 @@ function create-deploy-request {
     fi   
 }
 
+function create-deploy-request-info {
+    local DB_NAME=$1
+    local ORG_NAME=$2
+    local DEPLOY_REQUEST_NUMBER=$3
+
+    local raw_output=`pscale deploy-request show "$DB_NAME" "$DEPLOY_REQUEST_NUMBER" --org "$ORG_NAME" --format json`
+    if [ $? -ne 0 ]; then
+        echo "Deploy request could not be retrieved: $raw_output"
+        exit 1
+    fi
+    # extract the branch name from the deploy request
+    local branch_name=`echo $raw_output | jq -r '.branch'`
+
+    # check if the branch name is empty
+    if [ -z "$branch_name" ]; then
+        echo "Could not extract branch name from deploy request $DEPLOY_REQUEST_NUMBER"
+        exit 1
+    fi
+
+    export BRANCH_NAME="$branch_name"
+    local deploy_request="https://app.planetscale.com/${ORG_NAME}/${DB_NAME}/deploy-requests/${DEPLOY_REQUEST_NUMBER}"
+
+    local branch_url="https://app.planetscale.com/${ORG_NAME}/${DB_NAME}/${BRANCH_NAME}"
+    export BRANCH_URL="$branch_url"
+
+    # if CI variable is set, export deployment request info
+    if [ -n "$CI" ]; then
+        echo "::set-output name=BRANCH_NAME::$branch_name"
+        echo "::set-output name=DB_NAME::$DB_NAME"
+        echo "::set-output name=ORG_NAME::$ORG_NAME"
+        echo "::set-output name=DEPLOY_REQUEST_URL::$deploy_request"
+        echo "::set-output name=DEPLOY_REQUEST_NUMBER::$DEPLOY_REQUEST_NUMBER"
+        echo "::set-output name=BRANCH_URL::$branch_url"
+    fi
+}
+
+function create-branch-info {
+    local DB_NAME=$1
+    local BRANCH_NAME=$2
+    local ORG_NAME=$3
+
+    local raw_output=`pscale branch show "$DB_NAME" "$BRANCH_NAME" --org "$ORG_NAME" --format json`
+    if [ $? -ne 0 ]; then
+        echo "Branch could not be retrieved: $raw_output"
+        exit 1
+    fi
+    # extract the branch name from the deploy request
+    local branch_name=`echo $raw_output | jq -r '.name'`
+
+    # check if the branch name is empty
+    if [ -z "$branch_name" ]; then
+        echo "Could not extract existing branch name from branch $BRANCH_NAME"
+        exit 1
+    fi
+
+    export BRANCH_NAME="$branch_name"
+    
+    local branch_url="https://app.planetscale.com/${ORG_NAME}/${DB_NAME}/${BRANCH_NAME}"
+    export BRANCH_URL="$branch_url"
+
+    # if CI variable is set, export branch info
+    if [ -n "$CI" ]; then
+        echo "::set-output name=BRANCH_NAME::$branch_name"
+        echo "::set-output name=DB_NAME::$DB_NAME"
+        echo "::set-output name=ORG_NAME::$ORG_NAME"
+        echo "::set-output name=BRANCH_URL::$branch_url"
+    fi
+}
+
 function create-diff-for-ci {
     local DB_NAME=$1
     local ORG_NAME=$2
diff --git a/.pscale/cli-helper-scripts/retrieve-branch-info.sh b/.pscale/cli-helper-scripts/retrieve-branch-info.sh
@@ -0,0 +1,16 @@
+#!/bin/bash
+
+. use-pscale-docker-image.sh
+
+. authenticate-ps.sh
+
+DB_NAME="$1"
+ORG_NAME="$2"
+BRANCH_NAME="$3"
+
+. ps-create-helper-functions.sh
+create-branch-info "$DB_NAME" "$BRANCH_NAME" "$ORG_NAME"
+create-deploy-request "$DB_NAME" "$BRANCH_NAME" "$ORG_NAME"
+
+. create-branch-connection-string.sh
+create-branch-connection-string "$DB_NAME" "$BRANCH_NAME" "$ORG_NAME" "creds-${BRANCH_NAME}" "sharesecret"
diff --git a/.pscale/cli-helper-scripts/retrieve-deploy-request-info.sh b/.pscale/cli-helper-scripts/retrieve-deploy-request-info.sh
@@ -0,0 +1,17 @@
+#!/bin/bash
+
+. use-pscale-docker-image.sh
+
+. authenticate-ps.sh
+
+DB_NAME="$1"
+ORG_NAME="$2"
+DEPLOY_REQUEST_NUMBER="$3"
+
+. ps-create-helper-functions.sh
+create-deploy-request-info "$DB_NAME" "$ORG_NAME" "$DEPLOY_REQUEST_NUMBER"
+
+create-diff-for-ci "$DB_NAME" "$ORG_NAME" "$DEPLOY_REQUEST_NUMBER" "$BRANCH_NAME" "update"
+
+. create-branch-connection-string.sh
+create-branch-connection-string "$DB_NAME" "$BRANCH_NAME" "$ORG_NAME" "creds-${BRANCH_NAME}" "sharesecret"
