feat: add switchboard artillery target

package.json

@@ -12,6 +12,7 @@
   },
   "dependencies": {
     "artillery": "^2.0.0-33",
+    "artillery-plugin-metrics-by-endpoint": "^1.2.0",
     "csv-parse": "^5.4.0",
     "csv-stringify": "^6.4.0",
     "dotenv": "^16.1.4",

targets/switchboard/.env.example

@@ -0,0 +1,5 @@
+SWITCHBOARD_CLIENT_ID="00000000-0000-4000-0000-000000000000"
+SWITCHBOARD_AUTH_TOKEN="SomethingLongAndSecure"
+SWITCHBOARD_SENDING_ACCOUNT_ID="00000000-0000-4000-0000-000000000000"
+SWITCHBOARD_PROFILE_ID="00000000-0000-4000-0000-000000000000"
+BANDWIDTH_CALLBACK_BASIC_AUTH="Base64Encoded(Username:Password)"

targets/switchboard/README.md

@@ -0,0 +1,59 @@
+# Switchboard Artillery Load Testing
+
+Perform load test against a dry run mode (no calls to 3rd party telecom providers) Switchboard deployment.
+
+## Setup
+
+**Stand up Switchboard shard in dry mode**
+
+TBD
+
+**Set up billing.clients, sms.sending_accounts, sms.profiles, etc.**
+
+TBD
+
+**Set values for Artillery use**
+
+Copy and update the provided example `.env`
+
+```sh
+cp .env.example .env
+vi .env
+```
+
+## Running
+
+Artillery scripts can be run locally like this:
+
+```sh
+yarn artillery run \
+  --platform=local \
+  --environment=staging \
+  --dotenv=targets/switchboard/.env \
+  targets/switchboard/artillery-scripts/send-message.yaml
+```
+
+Artillery scripts can be run from AWS Lambda like this:
+
+Get session for MFA-enabled users. The session returned by the command may be set as the AWS credentials [a few different ways](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).
+
+```sh
+aws sts get-session-token \
+  --serial-number arn:aws:iam::123456789012:mfa/user \
+  --token-code code-from-token
+```
+
+Run the script on Lambda:
+
+```sh
+yarn artillery run \
+  --platform=aws:lambda \
+  --platform-opt region=us-east-1 \
+  --platform-opt memory-size=2048 \
+  --environment=staging \
+  --count=20 \
+  --dotenv=targets/switchboard/.env \
+  targets/switchboard/artillery-scripts/send-message.yaml
+```
+
+Lambda limits the file descriptor count [to 1024 per worker](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html). You will need to specify a worker count (`--count`) that will support the maximum concurrent virtual users for the script.

targets/switchboard/artillery-scripts/send-message.yaml

@@ -0,0 +1,106 @@
+config:
+  environments:
+    staging:
+      target: "https://staging.switchboard.assemble.live"
+      phases:
+        - name: Spike - Spoke Autosending @ 100
+          duration: 180
+          arrivalRate: 100
+        - name: Spike - Spoke Autosending @ 200
+          duration: 180
+          arrivalRate: 200
+        - name: Spike - Spoke Autosending @ 300
+          duration: 180
+          arrivalRate: 300
+        - name: Spike - Spoke Autosending @ 400
+          duration: 180
+          arrivalRate: 400
+        - name: Spike - Spoke Autosending @ 500
+          duration: 180
+          arrivalRate: 500
+  plugins:
+    metrics-by-endpoint: {}
+  processor: "../processors/sendMessageProcessor.js"
+
+scenarios:
+  - name: "Sending Bandwidth messages"
+    flow:
+      # Execute sendMessage mutation
+      - post:
+          url: "/sms/graphql"
+          beforeRequest: generateSendMessageParams
+          headers:
+            token: "{{ $processEnvironment.SWITCHBOARD_AUTH_TOKEN }}"
+          json:
+            query: |
+              mutation sendMessage($profileId: UUID!, $to: PhoneNumber!, $body: String!, $contactZipCode: ZipCode, $mediaUrls: [Url], $sendBefore: Datetime!) {
+                sendMessage(input: {profileId: $profileId, to: $to, body: $body, contactZipCode: $contactZipCode, mediaUrls: $mediaUrls, sendBefore: $sendBefore}) {
+                  outboundMessage {
+                    id
+                    createdAt
+                  }
+                }
+              }
+            variables:
+              profileId: "{{ $processEnvironment.SWITCHBOARD_PROFILE_ID }}"
+              to: "{{ toNumber }}"
+              body: "An SMS from Artillery load test 💣!"
+              contactZipCode: "11238"
+              mediaUrls: []
+              sendBefore: "2099-01-01"
+          capture:
+            - json: "$.data.sendMessage.outboundMessage.id"
+              as: "messageId"
+            - json: "$.data.sendMessage.outboundMessage.createdAt"
+              as: "messageCreatedAt"
+
+      # Give process-grey-route-message a chance to work
+      - think: 0.2
+
+      # Receive 'message-sending' DLR
+      - post:
+          url: "/hooks/status/{{ $processEnvironment.SWITCHBOARD_SENDING_ACCOUNT_ID }}"
+          headers:
+            Authorization: "Basic {{ $processEnvironment.BANDWIDTH_CALLBACK_BASIC_AUTH }}"
+          json:
+            - time: ""
+              type: "message-sending"
+              to: "+16463893770"
+              errorCode: ""
+              description: ""
+              message:
+                id: "service-{{ messageId }}"
+                # owner: ""
+                # applicationId: ""
+                time: "{{ messageCreatedAt }}"
+                segmentCount: 1
+                direction: "outbound"
+                to:
+                  - "+16463893770"
+                media: []
+                text: "An SMS from Artillery load test!"
+                tag: "v1|{{ messageId }}|{{ messageCreatedAt }}"
+
+      # Receive 'message-delivered' DLR
+      - post:
+          url: "/hooks/status/{{ $processEnvironment.SWITCHBOARD_SENDING_ACCOUNT_ID }}"
+          headers:
+            Authorization: "Basic {{ $processEnvironment.BANDWIDTH_CALLBACK_BASIC_AUTH }}"
+          json:
+            - time: ""
+              type: "message-delivered"
+              to: "+16463893770"
+              errorCode: ""
+              description: ""
+              message:
+                id: "service-{{ messageId }}"
+                # owner: ""
+                # applicationId: ""
+                time: "{{ messageCreatedAt }}"
+                segmentCount: 1
+                direction: "outbound"
+                to:
+                  - "+16463893770"
+                media: []
+                text: "An SMS from Artillery load test!"
+                tag: "v1|{{ messageId }}|{{ messageCreatedAt }}"

targets/switchboard/processors/sendMessageProcessor.js

@@ -0,0 +1,10 @@
+function generateSendMessageParams(requestParams, ctx, ee, next) {
+  const tn = [...Array(10)].map(() => Math.floor(Math.random() * 10)).join("");
+  const toNumber = `+1${tn}`;
+
+  ctx.vars.toNumber = toNumber;
+
+  return next();
+}
+
+module.exports = { generateSendMessageParams };

yarn.lock

@@ -2161,6 +2161,13 @@ artillery-plugin-expect@latest:
     debug "^4.3.2"
     lodash "^4.17.21"
 
+artillery-plugin-metrics-by-endpoint@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/artillery-plugin-metrics-by-endpoint/-/artillery-plugin-metrics-by-endpoint-1.2.0.tgz#eaf9850ab86e200f816cf5d9d4e3b1308a17bbca"
+  integrity sha512-4SatrmYffyex/j/wjCBW2gVGwgRfLSJFBTuOGM1pJH3l0iEOeHM+/HOzVIUL8IQbnjA/G1WpkJL3bB7jOuX4Dg==
+  dependencies:
+    debug "^4.3.2"
+
 artillery-plugin-metrics-by-endpoint@latest:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/artillery-plugin-metrics-by-endpoint/-/artillery-plugin-metrics-by-endpoint-1.0.2.tgz#268928dbd4938cfd7b08ccf84d4ada20f009cf99"