add tests

Author: davidmurdoch

packages/core/lib/console-child.js

@@ -3,7 +3,7 @@ const TruffleError = require("@truffle/error");
 const Config = require("@truffle/config");
 const Web3 = require("web3");
 const yargs = require("yargs");
-const StreamingWeb3HttpProvider = require("stream-provider");
+const StreamingWeb3HttpProvider = require("@truffle/stream-provider");
 
 const crypto = require("crypto");
 global.crypto = crypto;

packages/core/package.json

@@ -48,6 +48,7 @@
     "@truffle/require": "^2.0.79",
     "@truffle/resolver": "^7.0.33",
     "@truffle/source-fetcher": "^0.5.9",
+    "@truffle/stream-provider": "^0.0.1",
     "@truffle/workflow-compile": "^3.2.35",
     "chai": "^4.2.0",
     "colors": "^1.4.0",

packages/environment/environment.js

@@ -6,7 +6,7 @@ const Resolver = require("@truffle/resolver");
 const Artifactor = require("@truffle/artifactor");
 const Ganache = require("ganache-core/public-exports");
 const Provider = require("@truffle/provider");
-const StreamingWeb3HttpProvider = require("stream-provider");
+const StreamingWeb3HttpProvider = require("@truffle/stream-provider");
 
 const Environment = {
   // It's important config is a Config object and not a vanilla object

packages/environment/package.json

@@ -24,6 +24,7 @@
     "@truffle/expect": "^0.0.18",
     "@truffle/interface-adapter": "^0.5.8",
     "@truffle/resolver": "^7.0.33",
+    "@truffle/stream-provider": "^0.0.1",
     "ganache-core": "2.13.0",
     "node-ipc": "^9.1.1",
     "source-map-support": "^0.5.19",

packages/provider/index.js

@@ -3,7 +3,7 @@ const Web3 = require("web3");
 const { createInterfaceAdapter } = require("@truffle/interface-adapter");
 const wrapper = require("./wrapper");
 const DEFAULT_NETWORK_CHECK_TIMEOUT = 5000;
-const StreamingWeb3HttpProvider = require("stream-provider");
+const StreamingWeb3HttpProvider = require("@truffle/stream-provider");
 
 module.exports = {
   wrap: function (provider, options) {

packages/provider/package.json

@@ -22,6 +22,7 @@
   "dependencies": {
     "@truffle/error": "^0.0.14",
     "@truffle/interface-adapter": "^0.5.8",
+    "@truffle/stream-provider": "^0.0.1",
     "web3": "1.5.3"
   },
   "devDependencies": {

packages/stream-provider/lib/index.ts

@@ -7,7 +7,7 @@ const JSONStream = require("JSONStream");
 // they export types, but in the wrong place
 const Web3HttpProvider = (_Web3HttpProvider as any) as typeof HttpProvider;
 
-export class StreamingWeb3HttpProvider extends Web3HttpProvider {
+export default class StreamingWeb3HttpProvider extends Web3HttpProvider {
   /**
    * Should be used to make async request
    *
@@ -60,12 +60,23 @@ export class StreamingWeb3HttpProvider extends Web3HttpProvider {
         .then(async response => {
           let error = null;
           let result: any = {};
+          const stream = response.data.pipe(
+            JSONStream.parse([true, { emitKey: true }])
+          );
           try {
-            for await (const { key, value } of response.data.pipe(
-              JSONStream.parse([true, { emitKey: true }])
-            )) {
-              result[key] = value;
-            }
+            result = await new Promise((resolve, reject) => {
+              let result: any = {};
+              stream.on("data", (data: any) => {
+                const { key, value } = data;
+                result[key] = value;
+              });
+              stream.on("error", (error: Error) => {
+                reject(error);
+              });
+              stream.on("end", () => {
+                resolve(result);
+              });
+            });
           } catch (e) {
             error = errors.InvalidResponse(e);
           }

packages/stream-provider/package.json

@@ -22,7 +22,9 @@
   },
   "scripts": {
     "build": "tsc",
-    "prepare": "yarn build"
+    "prepare": "yarn build",
+    "test:ts": "mocha -r ts-node/register test/*.ts",
+    "test": "yarn test:ts"
   },
   "types": "dist/index.d.ts",
   "dependencies": {
@@ -31,6 +33,9 @@
     "JSONStream": "1.3.5",
     "axios": "^0.21.1"
   },
+  "devDependencies": {
+    "mocha": "8.1.2"
+  },
   "keywords": [
     "ethereum",
     "etherscan",

packages/stream-provider/test/stream.ts

@@ -0,0 +1,65 @@
+import assert from "assert";
+import http, { Server, ServerResponse } from "http";
+import StreamingWeb3HttpProvider from "../lib/";
+
+describe("test", () => {
+  const PORT = 9451;
+  let server: Server;
+  const SIZE = (1000000000 / 2) | 0;
+  beforeEach(() => {
+    server = http.createServer();
+    server
+      .on("request", (request, response: ServerResponse) => {
+        let body: Buffer[] = [];
+        request
+          .on("data", (chunk: Buffer) => {
+            body.push(chunk);
+          })
+          .on("end", () => {
+            response.writeHead(200, "OK", {
+              "content-type": "application/json"
+            });
+            const prefix = '{"id":1,"result":{"structLogs":["';
+            const postfix = '"]}}';
+            response.write(prefix);
+            // .5 gigs of utf-8 0s
+            const lots = Buffer.allocUnsafe(SIZE).fill(48);
+            response.write(lots);
+            response.write('","');
+            response.write(lots);
+            response.write('","');
+            response.write(lots);
+            response.write('","');
+            response.write(lots);
+            response.write(postfix);
+            response.end();
+          });
+      })
+      .listen(PORT);
+  });
+  afterEach(async () => {
+    server && server.close();
+  });
+  (it("handle giant traces", async () => {
+    const provider = new StreamingWeb3HttpProvider(`http://localhost:${PORT}`);
+    const result = await new Promise<any>((resolve, reject) => {
+      provider.send(
+        {
+          id: 1,
+          jsonrpc: "2.0",
+          method: "debug_traceTransaction",
+          params: ["0x1234"]
+        },
+        (err, result) => {
+          if (err) return void reject(err);
+          resolve(result);
+        }
+      );
+    });
+    assert.strictEqual(result.structLogs.length, 4);
+    result.structLogs.forEach((log: Buffer) => {
+      assert.strictEqual(log.length, SIZE);
+    });
+    assert(true);
+  }) as any).timeout(0);
+});

packages/stream-provider/tsconfig.json

@@ -10,14 +10,17 @@
     "sourceMap": true,
     "outDir": "dist",
     "baseUrl": ".",
-    "lib": ["es2017"],
-    "paths": {
-    },
+    "lib": [
+      "es2017"
+    ],
+    "paths": {},
     "rootDir": "lib",
-    "types": ["debug", "node"]
+    "types": [
+      "mocha",
+      "node"
+    ]
   },
   "include": [
     "./lib/**/*.ts"
   ]
-
-}
+}