refactor: extract Slack messaging into dedicated package

package.json

@@ -6,10 +6,12 @@
   "private": true,
   "license": "Apache-2.0",
   "scripts": {
+    "build:deps": "yarn workspace utils build && yarn workspace @arbitrum-monitoring/slack build",
+    "build": "yarn build:deps && yarn workspaces foreach run build",
     "retryable-monitor": "yarn workspace retryable-monitor dev",
     "batch-poster-monitor": "yarn workspace batch-poster-monitor dev",
     "assertion-monitor": "yarn workspace assertion-monitor dev",
-    "test": "yarn workspace utils build && vitest"
+    "test": "yarn build:deps && vitest"
   },
   "devDependencies": {
     "@types/node": "^20.14.10",

packages/assertion-monitor/package.json

@@ -5,6 +5,7 @@
   "dependencies": {
     "@arbitrum/sdk": "^4.0.0",
     "@types/yargs": "17.0.32",
+    "@arbitrum-monitoring/slack": "*",
     "typescript": "^5.4.5",
     "utils": "*",
     "viem": "^2.7.9",
@@ -17,7 +18,7 @@
   },
   "scripts": {
     "lint": "eslint .",
-    "build": "yarn workspace utils build && rm -rf ./dist && tsc",
+    "build": "yarn --cwd ../.. build:deps && rm -rf ./dist && tsc",
     "format": "prettier './**/*.{js,json,md,yml,sol,ts}' --write && yarn run lint --fix",
     "dev": "yarn build && node ./dist/main.js",
     "test": "vitest run __test__/*.test.ts",

packages/assertion-monitor/reportAssertionMonitorAlertToSlack.ts

@@ -1,4 +1,4 @@
-import { createSlackPoster } from 'utils'
+import { createSlackPoster } from '@arbitrum-monitoring/slack'
 
 export const reportAssertionMonitorErrorToSlack = createSlackPoster({
   tokenEnvVar: 'ASSERTION_MONITORING_SLACK_TOKEN',

packages/batch-poster-monitor/package.json

@@ -4,14 +4,15 @@
   "main": "index.ts",
   "scripts": {
     "lint": "eslint .",
-    "build": "yarn workspace utils build && rm -rf ./dist && tsc",
+    "build": "yarn --cwd ../.. build:deps && rm -rf ./dist && tsc",
     "format": "prettier './**/*.{js,json,md,yml,sol,ts}' --write && yarn run lint --fix",
     "dev": "yarn build && node ./dist/index.js",
     "test": "vitest"
   },
   "dependencies": {
     "@arbitrum/orbit-sdk": "^0.23.5",
     "abitype": "^1.0.5",
+    "@arbitrum-monitoring/slack": "*",
     "typescript": "^5.4.5",
     "utils": "*",
     "viem": "1.20.0"

packages/batch-poster-monitor/reportBatchPosterAlertToSlack.ts

@@ -1,4 +1,4 @@
-import { createSlackPoster } from 'utils'
+import { createSlackPoster } from '@arbitrum-monitoring/slack'
 
 export const reportBatchPosterErrorToSlack = createSlackPoster({
   tokenEnvVar: 'BATCH_POSTER_MONITORING_SLACK_TOKEN',

packages/retryable-monitor/handlers/slack/postSlackMessage.ts

@@ -1,4 +1,4 @@
-import { createSlackPoster } from 'utils'
+import { createSlackPoster } from '@arbitrum-monitoring/slack'
 
 export const postSlackMessage = createSlackPoster({
   tokenEnvVar: 'RETRYABLE_MONITORING_SLACK_TOKEN',

packages/retryable-monitor/package.json

@@ -12,12 +12,13 @@
     "ethers": "^5.5.4",
     "graphql": "^16.6.0",
     "graphql-request": "^6.1.0",
+    "@arbitrum-monitoring/slack": "*",
     "utils": "*",
     "winston": "^3.3.3"
   },
   "scripts": {
     "lint": "eslint .",
-    "build": "yarn workspace utils build && rm -rf ./dist && tsc",
+    "build": "yarn --cwd ../.. build:deps && rm -rf ./dist && tsc",
     "format": "prettier './**/*.{js,json,md,yml,sol,ts}' --write && yarn run lint --fix",
     "dev": "yarn build && node ./dist/index.js"
   }

packages/slack/index.ts

@@ -0,0 +1,3 @@
+export { createSlackPoster } from './createSlackPoster'
+export { postSlackMessage } from './postSlackMessage'
+export { sanitizeSlackMessage } from './sanitizeSlackMessage'

packages/slack/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@arbitrum-monitoring/slack",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@slack/web-api": "^7.0.4",
+    "dotenv": "^16.0.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint .",
+    "test": "vitest run"
+  }
+}

packages/utils/postSlackMessage.ts → packages/slack/postSlackMessage.ts

@@ -1,6 +1,6 @@
 import { WebClient } from '@slack/web-api'
-import { sanitizeSlackMessage } from './sanitizeSlackMessage'
 import { formatGitHubCIInfo } from './githubCIUtils'
+import { sanitizeSlackMessage } from './sanitizeSlackMessage'
 
 export const postSlackMessage = ({
   slackToken,

packages/slack/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "include": ["./**/*.ts", "./**/*.d.ts"],
+  "exclude": ["node_modules", "dist/"]
+}

packages/utils/index.ts

@@ -1,8 +1,6 @@
 export * from './types'
 export * from './config'
 export { getExplorerUrlPrefixes } from './getExplorerUrlPrefixes'
-export { postSlackMessage } from './postSlackMessage'
-export { createSlackPoster } from './createSlackPoster'
 export { parseAmount } from './amountUtils'
 
 export const sleep = (ms: number) =>

packages/utils/package.json

@@ -3,9 +3,7 @@
   "version": "1.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "dependencies": {
-    "@slack/web-api": "^7.0.4"
-  },
+  "dependencies": {},
   "scripts": {
     "build": "tsc",
     "lint": "eslint ."

yarn.lock

@@ -1913,6 +1913,11 @@ dotenv@^10.0.0:
   resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-10.0.0.tgz#3d4227b8fb95f81096cdd2b66653fb2c7085ba81"
   integrity sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==
 
+dotenv@^16.0.3:
+  version "16.6.1"
+  resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-16.6.1.tgz#773f0e69527a8315c7285d5ee73c4459d20a8020"
+  integrity sha512-uBq4egWHTcTt33a72vpSG0z3HnPuIl6NqYcTrKEg2azoEyl2hpW0zqlxysq2pK9HlDIHyHyakeYaYnSAwd8bow==
+
 dotenv@^16.3.1:
   version "16.4.5"
   resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-16.4.5.tgz#cdd3b3b604cb327e286b4762e13502f717cb099f"