https://github.com/andreas-schoch/arce

(A)rbitrary (R)emote (C)ode (E)xecutor for e2e testing purposes
https://github.com/andreas-schoch/arce

Last synced: 13 days ago
JSON representation

(A)rbitrary (R)emote (C)ode (E)xecutor for e2e testing purposes

• Host: GitHub
• URL: https://github.com/andreas-schoch/arce
• Owner: andreas-schoch
• License: mit
• Created: 2021-05-16T19:12:57.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-04-01T14:12:13.000Z (almost 2 years ago)
• Last Synced: 2024-10-06T05:06:33.975Z (5 months ago)
• Language: TypeScript
• Homepage:
• Size: 680 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
ARCE: Arbitrary Remote Code Executor

=======================

[![npm version](https://badge.fury.io/js/arce.svg)](https://badge.fury.io/js/arce)

[![GitHub license](https://img.shields.io/github/license/andreas-schoch/arce.svg)](https://github.com/andreas-schoch/arce/blob/main/LICENSE)

![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/andreas-schoch/e7afe8a31c8fde66fc11902f7aad7792/raw/arce__heads_main.json)

An experimental attempt to send arbitrary JavaScript commands to a webapp via a websocket server proxy.

**Should not be used anywhere near production or for any malicious purposes!**

## How is this useful?

This package tries to be a browser-agnostic alternative to tools like puppeteer, playwright, selenium etc.,

which either use the chrome devtools protocol, webdrivers and/or need the browser to be opened with specific args to

work.

Any of the above-mentioned tools should likely be preferred over 'arce', but in scenarios where you have limited

control over how a browser is opened (for example: a webapp shown in a webview embedded in some desktop app) and need to

e2e test a variety of otherwise unsupported browsers, this kind of websocket proxy might work.

## Install

```bash

npm install arce

```

or

```bash

yarn add arce

```

## Usage

1. Start websocket server proxy:

   ```shell

   npx arce --ssl_cert=example.crt --ssl_key=example.key

   ```

2. Include this script in your index.html to automatically open websocket connection:

   ```html

   

   ```

3. Open https://localhost:12000/public/example-client.html (has the above script already included)

4. Send a POST request to https://localhost:12000/command?foo=hello&bar=world with the following body:

   ```javascript

   async ({waitUntil, capture, done, global, scriptContext}) => {

     capture(scriptContext.foo);

     setTimeout(() => document.querySelector('button').click(), 1500);

     // waits for list to be visible

     const list = await waitUntil(() => document.querySelector('ul:not(.hidden)'));

     let i = 0;

     // Scroll to random list item every 0.3s

     const handler = setInterval(() => {

       const randIndex = Math.floor(Math.random() * list.children.length);

       const li = list.children[randIndex];

       capture(li.innerText); // value to be included with the http response

       li.scrollIntoView({ behavior: "smooth", block: "center" });

       if (++i > 10) {

         clearInterval(handler);

         document.body.style.backgroundColor = 'salmon';

         capture(scriptContext.bar);

         done();

       }

     }, 300);

   };

   ```

   Which will result in the following response:

   ```json

   {

     "status": 200,

     "script": "",

     "awaitId": "a35339e3-14d6-48ec-bb2b-0cdc7c81f363",

     "scriptContext": {"foo":  "hello", "bar":  "world"},

     "captures": [

       "hello",

       "Item 07",

       "Item 01",

       "Item 05",

       "Item 08",

        "...",

        "...",

       "world"

     ]

   }

   ```

   The code sent within the POST request is run directly on the connected client, so you have pretty much full access

   to the runtime to automate things and make assertions.

## License

MIT