Add interoperability test for py-libp2p and js-libp2p with enhanced logging

Author: paschal533

tests/interop/js_libp2p/README.md

@@ -0,0 +1,81 @@
+# py-libp2p and js-libp2p Interoperability Tests
+
+This repository contains interoperability tests for py-libp2p and js-libp2p using the /ipfs/ping/1.0.0 protocol. The goal is to verify compatibility in stream multiplexing, protocol negotiation, ping handling, transport layer, and multiaddr parsing.
+
+## Directory Structure
+
+- js_node/ping.js: JavaScript implementation of a ping server and client using libp2p.
+- py_node/ping.py: Python implementation of a ping server and client using py-libp2p.
+- scripts/run_test.sh: Shell script to automate running the server and client for testing.
+- README.md: This file.
+
+## Prerequisites
+
+- Python 3.8+ with `py-libp2p` and dependencies (`pip install libp2p trio cryptography multiaddr`).
+- Node.js 16+ with `libp2p` dependencies (`npm install @libp2p/core @libp2p/tcp @chainsafe/libp2p-noise @chainsafe/libp2p-yamux @libp2p/ping @libp2p/identify @multiformats/multiaddr`).
+- Bash shell for running `run_test.sh`.
+
+## Running Tests
+
+1. Change directory:
+
+```
+cd tests/interop/js_libp2p
+```
+
+2. Install dependencies:
+
+```
+For JavaScript: cd js_node && npm install && cd ...
+```
+
+3. Run the automated test:
+
+For Linux and Mac users:
+
+```
+chmod +x scripts/run_test.sh
+./scripts/run_test.sh
+```
+
+For Windows users:
+
+```
+.\scripts\run_test.ps1
+```
+
+This starts the Python server on port 8000 and runs the JavaScript client to send 5 pings.
+
+## Debugging
+
+- Logs are saved in py_node/py_server.log and js_node/js_client.log.
+- Check for:
+  - Successful connection establishment.
+  - Protocol negotiation (/ipfs/ping/1.0.0).
+  - 32-byte payload echo in server logs.
+  - RTT and payload hex in client logs.
+
+## Test Plan
+
+### The test verifies:
+
+- Stream Multiplexer Compatibility: Yamux is used and negotiates correctly.
+- Multistream Protocol Negotiation: /ipfs/ping/1.0.0 is selected via multistream-select.
+- Ping Protocol Handler: Handles 32-byte payloads per the libp2p ping spec.
+- Transport Layer Support: TCP is used; WebSocket support is optional.
+- Multiaddr Parsing: Correctly resolves multiaddr strings.
+- Logging: Includes peer ID, RTT, and payload hex for debugging.
+
+## Current Status
+
+### Working:
+
+- TCP transport and Noise encryption are functional.
+- Yamux multiplexing is implemented in both nodes.
+- Multiaddr parsing works correctly.
+- Logging provides detailed debug information.
+
+## Not Working:
+
+- Ping protocol handler fails to complete pings (JS client reports "operation aborted").
+- Potential issues with stream handling or protocol negotiation.

tests/interop/js_libp2p/js_node/.gitIgnore

@@ -0,0 +1,4 @@
+/node_modules
+/package-lock.json
+/dist
+.log

tests/interop/js_libp2p/js_node/.github/pull_request_template.md

@@ -0,0 +1,17 @@
+# ⚠️ IMPORTANT ⚠️
+
+# Please do not create a Pull Request for this repository
+
+The contents of this repository are automatically synced from the parent [js-libp2p Examples Project](https://github.com/libp2p/js-libp2p-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [js-libp2p Examples](https://github.com/libp2p/js-libp2p-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [js-libp2p Examples Project](https://github.com/libp2p/js-libp2p-examples)
+1. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+1. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+1. Push to the Branch (`git push origin feature/amazing-example`)
+1. Open a Pull Request

tests/interop/js_libp2p/js_node/.github/workflows/sync.yml

@@ -0,0 +1,19 @@
+name: pull
+
+on:
+  workflow_dispatch
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: libp2p/js-libp2p-examples
+          source-folder-path: examples/${{ github.event.repository.name }}
+          source-branch: main
+          target-branch: main
+          git-username: github-actions
+          git-email: [email protected]

tests/interop/js_libp2p/js_node/README.md

@@ -0,0 +1,53 @@
+# @libp2p/example-chat <!-- omit in toc -->
+
+[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
+[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-examples.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-examples)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-examples/ci.yml?branch=main&style=flat-square)](https://github.com/libp2p/js-libp2p-examples/actions/workflows/ci.yml?query=branch%3Amain)
+
+> An example chat app using libp2p
+
+## Table of contents <!-- omit in toc -->
+
+- [Setup](#setup)
+- [Running](#running)
+- [Need help?](#need-help)
+- [License](#license)
+- [Contribution](#contribution)
+
+## Setup
+
+1. Install example dependencies
+   ```console
+   $ npm install
+   ```
+1. Open 2 terminal windows in the `./src` directory.
+
+## Running
+
+1. Run the listener in window 1, `node listener.js`
+1. Run the dialer in window 2, `node dialer.js`
+1. Wait until the two peers discover each other
+1. Type a message in either window and hit *enter*
+1. Tell yourself secrets to your hearts content!
+
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
+## License
+
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.

tests/interop/js_libp2p/js_node/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@libp2p/example-chat",
+  "version": "0.0.0",
+  "description": "An example chat app using libp2p",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/libp2p/js-libp2p-example-chat#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/libp2p/js-libp2p-examples.git"
+  },
+  "bugs": {
+    "url": "https://github.com/libp2p/js-libp2p-examples/issues"
+  },
+  "type": "module",
+  "scripts": {
+    "test": "test-node-example test/*"
+  },
+  "dependencies": {
+    "@chainsafe/libp2p-noise": "^16.0.0",
+    "@chainsafe/libp2p-yamux": "^7.0.0",
+    "@libp2p/identify": "^3.0.33",
+    "@libp2p/mdns": "^11.0.1",
+    "@libp2p/ping": "^2.0.33",
+    "@libp2p/tcp": "^10.0.0",
+    "@libp2p/websockets": "^9.0.0",
+    "@multiformats/multiaddr": "^12.3.1",
+    "@nodeutils/defaults-deep": "^1.1.0",
+    "it-length-prefixed": "^10.0.1",
+    "it-map": "^3.0.3",
+    "it-pipe": "^3.0.1",
+    "libp2p": "^2.0.0",
+    "p-defer": "^4.0.0",
+    "uint8arrays": "^5.1.0"
+  },
+  "devDependencies": {
+    "test-ipfs-example": "^1.1.0"
+  },
+  "private": true
+}