Merge pull request #17 from sendbird/feat/command-params

feat: add command parameters with test param

README.md

@@ -58,6 +58,10 @@ You can use the following commands in the PR comment:
 | -------------------- | ------------------------------------- |
 | `/bot create ticket` | Creates a new release ticket in Jira. |
 
+## Test
+
+You can pass `--test` parameter to command: `/bot create ticket --test`
+
 ## Slack notifications
 
 It mentions the `@{{product}}-approver` Slack group to notify ticket creation in the channel.

src/command/command.create.ts

@@ -31,7 +31,7 @@ export default class CreateCommand extends CommandAbstract {
     }
 
     this.log('Workflow request to create a ticket')
-    const {workflowUrl} = await workflow.createTicket(this.args)
+    const {workflowUrl} = await workflow.createTicket(this.args, this.params)
 
     this.log('Add a comment about processing ticket creation')
     await this.args.octokit.rest.issues.createComment({

src/command/command.ts

@@ -14,10 +14,16 @@ export type CommandArguments = {
   [key: string]: unknown
 }
 
+export type CommandParameters = {
+  test: boolean
+  [key: string]: unknown
+}
+
 export abstract class CommandAbstract implements Command {
   constructor(
     protected readonly target: string,
-    protected readonly args: CommandArguments
+    protected readonly args: CommandArguments,
+    protected readonly params: CommandParameters
   ) {
     this.log(`target: ${target}`)
   }

src/command/index.ts

@@ -1,6 +1,11 @@
 import * as core from '@actions/core'
-import type {Command, CommandArguments} from './command'
-import {COMMAND_ACTIONS, COMMAND_TRIGGER} from '../constants'
+import type {Command, CommandArguments, CommandParameters} from './command'
+import {
+  COMMAND_ACTIONS,
+  COMMAND_DEFAULT_PARAMS,
+  COMMAND_PARAM_PREFIX,
+  COMMAND_TRIGGER
+} from '../constants'
 import CreateCommand from './command.create'
 
 export function buildCommand(
@@ -12,11 +17,23 @@ export function buildCommand(
     return null
   }
 
-  const [action, target] = text.replace(COMMAND_TRIGGER, '').trim().split(' ')
+  const [action, target, ...paramCandidates] = text
+    .replace(COMMAND_TRIGGER, '')
+    .trim()
+    .split(' ')
+
+  const params = paramCandidates
+    .filter(it => it.startsWith(COMMAND_PARAM_PREFIX))
+    .map(it => it.replace(COMMAND_PARAM_PREFIX, ''))
+    .map(it => it.split('='))
+    .reduce<CommandParameters>(
+      (acc, [key, value = true]) => ({...acc, [key]: value}),
+      COMMAND_DEFAULT_PARAMS
+    )
 
   switch (action) {
     case COMMAND_ACTIONS.CREATE:
-      return new CreateCommand(target, args)
+      return new CreateCommand(target, args, params)
     default:
       return null
   }

src/constants.ts

@@ -1,10 +1,13 @@
+import {CommandParameters} from './command/command'
+
 export const COMMAND_TRIGGER = '/bot'
 export const COMMAND_ACTIONS = {
   CREATE: 'create'
 }
 export const COMMAND_TARGETS = {
   TICKET: 'ticket'
 }
+export const COMMAND_PARAM_PREFIX = '--'
 
 export const BRANCH_RELEASE_PREFIX = 'release'
 export const BRANCH_HOTFIX_PREFIX = 'hotfix'
@@ -16,3 +19,6 @@ export const WORKFLOWS = {
 }
 
 export const SENDBIRD_BOT_USERNAME = 'sendbird-sdk-deployment'
+export const COMMAND_DEFAULT_PARAMS: CommandParameters = {
+  test: false
+}

src/main.ts

@@ -25,6 +25,7 @@ async function run(): Promise<void> {
       })
 
       const comment = payload.comment.body.toLowerCase()
+
       const command = buildCommand(comment, {
         gh_token,
         circleci_token,

src/workflow.ts

@@ -2,7 +2,7 @@ import * as core from '@actions/core'
 import * as github from '@actions/github'
 import fetch from 'node-fetch'
 
-import type {CommandArguments} from './command/command'
+import type {CommandArguments, CommandParameters} from './command/command'
 import {WORKFLOW_REPO, WORKFLOW_SCRIPT_VERSION, WORKFLOWS} from './constants'
 import {
   buildReleaseJiraTicket,
@@ -52,12 +52,21 @@ export const workflow = {
   log(message: string) {
     core.info(`Workflow: ${message}`)
   },
-  async createTicket(args: CommandArguments): Promise<{workflowUrl: string}> {
-    const parameters = await buildCreateTicketParams(args)
+  async createTicket(
+    commandArgs: CommandArguments,
+    commandParams: CommandParameters
+  ): Promise<{workflowUrl: string}> {
+    const ticketParams = await buildCreateTicketParams(
+      commandArgs,
+      commandParams
+    )
 
-    if (parameters.test) this.log('Run on test environment')
+    if (ticketParams.test) this.log('Run on test environment')
 
-    const {repository, response} = await workflowRequest(args, parameters)
+    const {repository, response} = await workflowRequest(
+      commandArgs,
+      ticketParams
+    )
     this.log(`response: ${JSON.stringify(response, null, 2)}`)
 
     if (response.message === 'Project not found') {
@@ -86,7 +95,10 @@ export const workflow = {
     }
   }
 }
-async function buildCreateTicketParams(args: CommandArguments) {
+async function buildCreateTicketParams(
+  args: CommandArguments,
+  params: CommandParameters
+) {
   const basicParams = buildBasicRequestParams(WORKFLOWS.CREATE_TICKET)
   const release_version = extractVersion(args.branch)
 
@@ -96,7 +108,7 @@ async function buildCreateTicketParams(args: CommandArguments) {
 
   return {
     ...basicParams,
-    test: core.getInput('test') !== '',
+    test: core.getBooleanInput('test') || params.test,
     product_jira_project_key: core.getInput('product_jira_project_key'),
     product_jira_version_prefix: core.getInput('product_jira_version_prefix'),
     release_branch: args.branch,