add port for github action

Author: shiyuhang0

.github/workflows/example.yml

@@ -22,12 +22,14 @@ jobs:
       - name: Use the output
         run: |
             echo "The host is ${{ steps.wait-for-branch.outputs.host }}"
+            echo "The port is ${{ steps.wait-for-branch.outputs.port }}"
             echo "The username is ${{ steps.wait-for-branch.outputs.username }}"
             echo "The password is ${{ steps.wait-for-branch.outputs.password }}"
     outputs:
       username: ${{ steps.wait-for-branch.outputs.username }}
       host: ${{ steps.wait-for-branch.outputs.host }}
       password: ${{ steps.wait-for-branch.outputs.password }}
+      port: ${{ steps.wait-for-branch.outputs.port }}
 
   test:
     needs: setup
@@ -36,5 +38,6 @@ jobs:
       - name: Use the output
         run: |
           echo "The host is ${{ needs.setup.outputs.host }}"
-          echo "The username is ${{ needs.setup.outputs.username }}"
-          echo "The password is ${{ needs.setup.outputs.password }}"
+          echo "The port is ${{ needs.setup.outputs.port }}"
+          echo '::add-mask::${{ needs.setup.outputs.password }}'
+          echo "The password is ${{ needs.setup.outputs.password }}"

README.md

@@ -32,6 +32,7 @@ The action provide the following outputs:
 - host - The host of the TiDB Cloud branch.
 - username - The username of the TiDB Cloud branch.
 - password - The password of the TiDB Cloud branch.
+- port - The port of the TiDB Cloud branch.
 
 ## Best practices
 
@@ -52,6 +53,7 @@ steps:
   - name: Use the output
      run: |
         echo "The host is ${{ steps.wait-for-branch.outputs.host }}"
+        echo "The port is ${{ steps.wait-for-branch.outputs.port }}"
         echo "The username is ${{ steps.wait-for-branch.outputs.username }}"
         echo "The password is ${{ steps.wait-for-branch.outputs.password }}"
 ```
@@ -76,6 +78,7 @@ jobs:
           addMask: false
     outputs:
       username: ${{ steps.wait-for-branch.outputs.username }}
+      port : ${{ steps.wait-for-branch.outputs.port }}
       host: ${{ steps.wait-for-branch.outputs.host }}
       password: ${{ steps.wait-for-branch.outputs.password }}
 
@@ -86,6 +89,7 @@ jobs:
       - name: Use the output
         run: |
           echo "The host is ${{ needs.setup.outputs.host }}"
+          echo "The port is ${{ needs.setup.outputs.port }}"
           echo "The username is ${{ needs.setup.outputs.username }}"
           echo '::add-mask::${{ needs.setup.outputs.password }}'
           echo "The password is ${{ needs.setup.outputs.password }}"       

dist/index.js

@@ -62,6 +62,7 @@ async function run(): Promise<void> {
     core.setOutput('host', sqlUser.host)
     core.setOutput('username', sqlUser.username)
     core.setOutput('password', sqlUser.password)
+    core.setOutput('port', sqlUser.port)
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)
   }

dist/index.js.map

@@ -11,11 +11,13 @@ export class SqlUser {
   host: string
   username: string
   password: string
+  port: number
 
-  constructor(host: string, user: string, password: string) {
+  constructor(host: string, port: number, user: string, password: string) {
     this.host = host
     this.username = user
     this.password = password
+    this.port = port
   }
 }
 
@@ -49,16 +51,34 @@ export async function sqluser(
     host = 'https://api.staging.tidbcloud.com'
   }
 
-  const url = `${host}/api/internal/projects/${projectID}/clusters/${clusterID}/branches/${branchName}/users`
-  log(`request url to get sql user: ${url}`)
-
   const client = new DigestFetch(publicKey, privateKey)
-  const resp = await client.fetch(url, {method: 'POST'})
+
+  // get sql user
+  const sqlUserUrl = `${host}/api/internal/projects/${projectID}/clusters/${clusterID}/branches/${branchName}/users`
+  log(`request url to get sql user: ${sqlUserUrl}`)
+  const resp = await client.fetch(sqlUserUrl, {method: 'POST'})
   const data = await resp.json()
   if (data['username'] === undefined || data['password'] === undefined) {
     throw new Error(
       `Can not get sql user with response: ${JSON.stringify(data)}`
     )
   }
-  return new SqlUser('', data['username'], data['password'])
+
+  // get branch info
+  const branchUrl = `${host}/api/internal/projects/${projectID}/clusters/${clusterID}/branches/${branchName}`
+  log(`request url to get host and port: ${branchUrl}`)
+  const resp2 = await client.fetch(branchUrl)
+  const branch = await resp2.json()
+  if (branch['host'] === undefined || branch['port'] === undefined) {
+    throw new Error(
+      `Can not get branch host and port with: ${JSON.stringify(branch)}`
+    )
+  }
+
+  return new SqlUser(
+    branch['host'],
+    branch['port'],
+    data['username'],
+    data['password']
+  )
 }