initial commit very wip

add interception proxy source

from ably-js 0288761

wip compile it

further

compile and run

version

wip set up eslint

used the TUI of `npm init @eslint/config@latest` from
https://eslint.org/docs/latest/use/getting-started

> Note that some plugins currently do not support ESLint v9 yet.
> You may need to use '--force' when installing, or add the following to your package.json:
> "overrides": { "eslint": "^9.7.0" }

ok, I’ll add that 🤷

add CI workflow

a couple of other bits

fixing some mypy stuff

fix github

wip make runnable via npx

does this work?

manually declaring files so that install over git works

oh, and `prepare` is so that install over git works

fix dependencies that were incorrectly marked as dev

point to correct location for mitmproxy addon

move the start script here

python linting

ruff format

.github/workflows/check.yml

@@ -0,0 +1,34 @@
+name: check
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      # Set up
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20" # Oldest LTS at time of writing
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - run: npm ci
+      - run: pip install mitmproxy websockets ruff mypy # TODO I’m not sure what is the right way of doing this; what's the package.json equivalent? Ditto for the installation instructions
+
+      # Run JS checks
+      - run: npm run format:check
+      - run: npm run lint:check
+      - run: npm run build
+
+      # Run Python checks
+      - run: ruff format --check
+      - run: ruff check
+      - run: mypy

.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+/dist/
+__pycache__/
+.mypy_cache/

.prettierrc

@@ -0,0 +1 @@
+{}

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+TODO

COPYRIGHT

@@ -0,0 +1 @@
+Copyright 2024 Ably Real-time Ltd (ably.com)

LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

MAINTAINERS.md

@@ -0,0 +1 @@
+This repository is owned by the Ably Ecosystems team.

README.md

@@ -0,0 +1,40 @@
+# Interception Proxy
+
+Web service to create proxies for intercepting and manipulating WebSocket traffic between an Ably client library and the Realtime service. Very much a prototype and a work in progress (see the abundant TODOs in the code). The motivation for this work is currently best described by [this internal RFC](https://ably.atlassian.net/wiki/x/IYDItQ).
+
+## Requirements
+
+- Node LTS — tested on 20
+- Python 3.x — tested on 3.12.4
+- mitmproxy ([PyPi](https://pypi.org/project/mitmproxy/)) — tested on 10.3.1
+- websockets ([PyPi](https://pypi.org/project/websockets/)) — tested on 12.0
+
+## Installation
+
+There are currently no NPM releases of this package, so you’ll need to install it directly from the Git repo:
+
+```bash
+npm install https://github.com/ably-labs/interception-proxy
+```
+
+## Commands
+
+### Setup
+
+- `npx --package interception-proxy generate-mitmproxy-certs`: Generates the mitmproxy TLS certificate, so that you can add it to the trust store used by the process under test.
+
+### Running locally
+
+- `npx interception-proxy`: Starts the interception proxy. Use this when running in a local development environment.
+
+### Running in CI
+
+- `npx --package interception-proxy start-service`: Starts the interception proxy as a background service. Useful for CI. The script uses `sudo` so it’s probably not something you want to use locally.
+
+## JSON-RPC API
+
+See [`docs/API.md`](docs/API.md).
+
+## Examples
+
+Currently the best example of how to use this server is https://github.com/ably/ably-js/pull/1816.

bin/generate-mitmproxy-certs

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -e
+
+if [[ -z $BASH_SOURCE ]]
+then
+  echo "This script must be run from a file."
+  exit 1
+fi
+
+# https://mywiki.wooledge.org/BashFAQ/028 for BASH_SOURCE
+#
+# When invoked via NPM, this script is invoked as a symlink in node_modules/.bin, so we use readlink to dereference the symlink (see https://stackoverflow.com/questions/421772/how-can-a-bash-script-know-the-directory-it-is-installed-in-when-it-is-sourced-w)
+mitmdump -s $(dirname $(readlink -f "${BASH_SOURCE}"))/../dist/python/mitmproxy_addon_generate_certs_and_exit.py

bin/interception-proxy

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// This is the script which will be run when you run this package via `npx`.
+require("../dist/js/server.js");

bin/start-service

@@ -0,0 +1,95 @@
+#!/usr/bin/env bash
+
+# Runs the server as a background service, exiting once the server is ready to receive requests.
+#
+# Intended for use in SDKs’ CI jobs. Must be run from the root of this repository.
+#
+# Adapted from https://github.com/ably/sdk-test-proxy/blob/82e93a746c0cfaa3f75324e62d57921d14d8591a/start-service.
+
+set -e
+
+# We run as the current user so that we can access the generated server certificate (in ~/.mitmproxy) without having to worry about permissions. TODO consider instead generating our own cert and telling mitmproxy to use it, then we also won’t have to have that step where we run mitmproxy once (via npx interception-proxy generate-mitmproxy-certs) just to generate the certs
+start_systemd_service () {
+  systemd_service=$(cat <<SYSTEMD_SERVICE
+[Unit]
+Description=Ably SDK Test Proxy
+
+[Service]
+WorkingDirectory=$(pwd)
+ExecStart=npx interception-proxy
+User=$USER
+
+[Install]
+WantedBy=multi-user.target
+SYSTEMD_SERVICE
+)
+
+  # https://stackoverflow.com/questions/84882/sudo-echo-something-etc-privilegedfile-doesnt-work
+  echo "${systemd_service}" | sudo tee /etc/systemd/system/ably-sdk-test-proxy.service 1>/dev/null
+
+  echo "Starting ably-sdk-test-proxy systemd service..." 1>&2
+  sudo systemctl start ably-sdk-test-proxy.service
+  echo "Started ably-sdk-test-proxy systemd service." 1>&2
+}
+
+start_launchd_daemon () {
+  launchd_daemon=$(cat <<LAUNCHD_DAEMON
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>Label</key>
+    <string>com.ably.test.proxy</string>
+    <key>WorkingDirectory</key>
+    <string>$(pwd)</string>
+    <key>ProgramArguments</key>
+    <array>
+        <string>npx</string>
+        <string>interception-proxy</string>
+    </array>
+    <key>RunAtLoad</key>
+    <true/>
+</dict>
+</plist>
+LAUNCHD_DAEMON
+)
+
+  # https://stackoverflow.com/questions/84882/sudo-echo-something-etc-privilegedfile-doesnt-work
+  echo "${launchd_daemon}" | sudo tee /Library/LaunchDaemons/com.ably.test.proxy.plist
+
+  echo "Loading ably-sdk-test-proxy launchd daemon..." 1>&2
+  sudo launchctl load /Library/LaunchDaemons/com.ably.test.proxy.plist
+  echo "Loaded ably-sdk-test-proxy launchd daemon." 1>&2
+}
+
+check_daemon_still_running () {
+  if uname | grep Linux 1>/dev/null
+  then
+    systemctl is-active --quiet ably-sdk-test-proxy.service
+  elif uname | grep Darwin 1>/dev/null
+  then
+    launchctl print system/com.ably.test.proxy 1>/dev/null
+  fi
+}
+
+if uname | grep Linux 1>/dev/null
+then
+  start_systemd_service
+elif uname | grep Darwin 1>/dev/null
+then
+  start_launchd_daemon
+else
+  echo "Unsupported system $(uname); exiting" 1>&2
+  exit 1
+fi
+
+echo "Waiting for sdk-test-proxy server to start on port 8001..." 1>&2
+
+# https://stackoverflow.com/questions/27599839/how-to-wait-for-an-open-port-with-netcat
+while ! nc -z localhost 8001; do
+  # Check that the service hasn’t failed (else we’ll be waiting forever)
+  check_daemon_still_running
+  sleep 0.5
+done
+
+echo "sdk-test-proxy server is now listening on port 8001." 1>&2