Update builtins to new version (#27)

* Update builtins to new version

* Running integration tests in docker container

Author: coder11

README.md

@@ -64,7 +64,7 @@ Make a particle
 const particle = new Particle(
     `
     (seq
-        (call myRelay ("op" "identify") [] result)
+        (call myRelay ("peer" "identify") [] result)
         (call %init_peer_id% ("helloService" "helloFunction") [result])
     )`,
     {
@@ -112,10 +112,34 @@ npm install
 
 ### Running tests
 
-To run test execute
+Tests are split into unit and integration categories. By default integration tests require a locally running Fluence node with 4310 port open for ws connections. The dependency can be started with docker
 
 ```bash
-npm test
+ docker run --rm -e RUST_LOG="info" -p 1210:1210 -p 4310:4310 fluencelabs/fluence:freeze -t 1210 -w 4310 -k gKdiCSUr1TFGFEgu2t8Ch1XEUsrN5A2UfBLjSZvfci9SPR3NvZpACfcpPGC3eY4zma1pk7UvYv5zb1VjvPHwCjj
+```
+
+To run all tests in interactive mode
+
+```bash
+npm run test
+```
+
+To run only unit tests
+
+```bash
+npm run test:unit
+```
+
+To run only integration tests
+
+```bash
+npm run test:unit
+```
+
+To run all tests
+
+```bash
+npm run test:all
 ```
 
 ## Contributing

src/__test__/connection.ts

@@ -0,0 +1,35 @@
+import { generatePeerId } from '..';
+import { createClient } from '../api';
+import { FluenceClientImpl } from '../internal/FluenceClientImpl';
+
+// Uncomment to test on dev nodes
+// export const nodes = [
+//     {
+//         multiaddr: '/dns4/dev.fluence.dev/tcp/19003/wss/p2p/12D3KooWBUJifCTgaxAUrcM9JysqCcS4CS8tiYH5hExbdWCAoNwb',
+//         peerId: '12D3KooWBUJifCTgaxAUrcM9JysqCcS4CS8tiYH5hExbdWCAoNwb',
+//     },
+//     {
+//         multiaddr: '/dns4/dev.fluence.dev/tcp/19004/wss/p2p/12D3KooWJbJFaZ3k5sNd8DjQgg3aERoKtBAnirEvPV8yp76kEXHB',
+//         peerId: '12D3KooWJbJFaZ3k5sNd8DjQgg3aERoKtBAnirEvPV8yp76kEXHB',
+//     },
+// ];
+
+// start docker container to run integration tests locally
+// > docker run --rm -e RUST_LOG="info" -p 1210:1210 -p 4310:4310 fluencelabs/fluence:freeze -t 1210 -w 4310 -k gKdiCSUr1TFGFEgu2t8Ch1XEUsrN5A2UfBLjSZvfci9SPR3NvZpACfcpPGC3eY4zma1pk7UvYv5zb1VjvPHwCjj
+export const nodes = [
+    {
+        multiaddr: '/ip4/127.0.0.1/tcp/4310/ws/p2p/12D3KooWKEprYXUXqoV5xSBeyqrWLpQLLH4PXfvVkDJtmcqmh5V3',
+        peerId: '12D3KooWKEprYXUXqoV5xSBeyqrWLpQLLH4PXfvVkDJtmcqmh5V3',
+    },
+];
+
+export const createLocalClient = async () => {
+    const peerId = await generatePeerId();
+    const client = new FluenceClientImpl(peerId);
+    await client.local();
+    return client;
+};
+
+export const createConnectedClient = async (node: string) => {
+    return (await createClient(node)) as FluenceClientImpl;
+};

src/__test__/integration/builtins.spec.ts

@@ -1,46 +1,41 @@
 import {
     addBlueprint,
-    addProvider,
     addScript,
     createService,
     getBlueprints,
     getInterfaces,
     getModules,
-    getProviders,
     removeScript,
     uploadModule,
 } from '../../internal/builtins';
 import { ModuleConfig } from '../../internal/moduleConfig';
-import { createConnectedClient } from '../util';
 import { checkConnection } from '../../api';
 import log from 'loglevel';
 import { generatePeerId } from '../..';
 import { FluenceClientImpl } from '../../internal/FluenceClientImpl';
-
-const dev2multiaddr = '/dns4/dev.fluence.dev/tcp/19003/wss/p2p/12D3KooWBUJifCTgaxAUrcM9JysqCcS4CS8tiYH5hExbdWCAoNwb';
-const dev3multiaddr = '/dns4/dev.fluence.dev/tcp/19004/wss/p2p/12D3KooWJbJFaZ3k5sNd8DjQgg3aERoKtBAnirEvPV8yp76kEXHB';
-
-const dev2peerId = '12D3KooWEXNUbCXooUwHrHBbrmjsrpHXoEphPwbjQXEGyzbqKnE9';
+import { createConnectedClient, nodes } from '../connection';
 
 describe('Builtins usage suite', () => {
+    jest.setTimeout(10000);
+
     it('get_modules', async function () {
-        const client = await createConnectedClient(dev2multiaddr);
+        const client = await createConnectedClient(nodes[0].multiaddr);
 
         let modulesList = await getModules(client);
 
         expect(modulesList).not.toBeUndefined;
     });
 
     it('get_interfaces', async function () {
-        const client = await createConnectedClient(dev2multiaddr);
+        const client = await createConnectedClient(nodes[0].multiaddr);
 
         let interfaces = await getInterfaces(client);
 
         expect(interfaces).not.toBeUndefined;
     });
 
     it('get_blueprints', async function () {
-        const client = await createConnectedClient(dev2multiaddr);
+        const client = await createConnectedClient(nodes[0].multiaddr);
 
         let bpList = await getBlueprints(client);
 
@@ -51,15 +46,15 @@ describe('Builtins usage suite', () => {
         const peerId = await generatePeerId();
         const client = new FluenceClientImpl(peerId);
         await client.local();
-        await client.connect(dev2multiaddr);
+        await client.connect(nodes[0].multiaddr);
 
         let isConnected = await checkConnection(client);
 
         expect(isConnected).toEqual(true);
     });
 
     it('upload_modules', async function () {
-        const client = await createConnectedClient(dev2multiaddr);
+        const client = await createConnectedClient(nodes[0].multiaddr);
 
         console.log('peerid: ' + client.selfPeerId);
 
@@ -81,7 +76,7 @@ describe('Builtins usage suite', () => {
     });
 
     it('add_blueprint', async function () {
-        const client = await createConnectedClient(dev2multiaddr);
+        const client = await createConnectedClient(nodes[0].multiaddr);
 
         let bpId = 'some';
 
@@ -92,31 +87,16 @@ describe('Builtins usage suite', () => {
 
     // FIXME:: there is no error on broken blueprint from a node
     it.skip('create_service', async function () {
-        const client = await createConnectedClient(dev2multiaddr);
+        const client = await createConnectedClient(nodes[0].multiaddr);
 
         let serviceId = await createService(client, 'test_broken_blueprint');
 
         // TODO there is no error on broken blueprint from a node
         expect(serviceId).not.toBeUndefined;
     });
 
-    it('add_provider', async function () {
-        const client = await createConnectedClient(dev2multiaddr);
-
-        let key = Math.random().toString(36).substring(7);
-        let buf = Buffer.from(key);
-
-        let r = Math.random().toString(36).substring(7);
-        await addProvider(client, buf, dev2peerId, r, undefined, 10000);
-
-        let pr = await getProviders(client, buf, undefined, 10000);
-        console.log(pr);
-        console.log(r);
-        expect(r).toEqual(pr[0][0].service_id);
-    });
-
     it('add and remove script', async function () {
-        const client = await createConnectedClient(dev3multiaddr);
+        const client = await createConnectedClient(nodes[0].multiaddr);
 
         console.log('peerid: ' + client.selfPeerId);
 

src/__test__/integration/client.spec.ts

@@ -1,13 +1,10 @@
 import { encode } from 'bs58';
 import { generatePeerId, peerIdToSeed, seedToPeerId } from '../../internal/peerIdUtils';
 import { FluenceClientImpl } from '../../internal/FluenceClientImpl';
-import { createConnectedClient } from '../util';
 import log from 'loglevel';
 import { createClient } from '../../api';
 import Multiaddr from 'multiaddr';
-
-const devNodeAddress = '/dns4/dev.fluence.dev/tcp/19001/wss/p2p/12D3KooWEXNUbCXooUwHrHBbrmjsrpHXoEphPwbjQXEGyzbqKnE9';
-const devNodePeerId = '12D3KooWEXNUbCXooUwHrHBbrmjsrpHXoEphPwbjQXEGyzbqKnE9';
+import { createConnectedClient, nodes } from '../connection';
 
 describe('Typescript usage suite', () => {
     it('should create private key from seed and back', async function () {
@@ -45,7 +42,7 @@ describe('Typescript usage suite', () => {
 
         it('address as string', async function () {
             // arrange
-            const addr = devNodeAddress;
+            const addr = nodes[0].multiaddr;
 
             // act
             const client = (await createClient(addr)) as FluenceClientImpl;
@@ -57,7 +54,7 @@ describe('Typescript usage suite', () => {
 
         it('address as multiaddr', async function () {
             // arrange
-            const addr = new Multiaddr(devNodeAddress);
+            const addr = new Multiaddr(nodes[0].multiaddr);
 
             // act
             const client = (await createClient(addr)) as FluenceClientImpl;
@@ -69,10 +66,7 @@ describe('Typescript usage suite', () => {
 
         it('address as node', async function () {
             // arrange
-            const addr = {
-                multiaddr: devNodeAddress,
-                peerId: devNodePeerId,
-            };
+            const addr = nodes[0];
 
             // act
             const client = (await createClient(addr)) as FluenceClientImpl;
@@ -84,7 +78,7 @@ describe('Typescript usage suite', () => {
 
         it('peerid as peer id', async function () {
             // arrange
-            const addr = devNodeAddress;
+            const addr = nodes[0].multiaddr;
             const pid = await generatePeerId();
 
             // act
@@ -97,7 +91,7 @@ describe('Typescript usage suite', () => {
 
         it('peerid as seed', async function () {
             // arrange
-            const addr = devNodeAddress;
+            const addr = nodes[0].multiaddr;
             const pid = peerIdToSeed(await generatePeerId());
 
             // act
@@ -111,7 +105,7 @@ describe('Typescript usage suite', () => {
 
     it('should make a call through the network', async function () {
         // arrange
-        const client = await createConnectedClient(devNodeAddress);
+        const client = await createConnectedClient(nodes[0].multiaddr);
 
         client.registerCallback('test', 'test', (args, _) => {
             log.trace('should make a call through the network, called "test" "test" with args', args);
@@ -151,7 +145,7 @@ describe('Typescript usage suite', () => {
 
     it('fireAndForget should work', async function () {
         // arrange
-        const client = await createConnectedClient(devNodeAddress);
+        const client = await createConnectedClient(nodes[0].multiaddr);
 
         let resMakingPromise = new Promise((resolve) => {
             client.registerCallback('test', 'reverse_args', (args, _) => {
@@ -180,11 +174,11 @@ describe('Typescript usage suite', () => {
 
     it('fetch should work', async function () {
         // arrange
-        const client = await createConnectedClient(devNodeAddress);
+        const client = await createConnectedClient(nodes[0].multiaddr);
 
         // act
         let script = `
-        (call "${client.relayPeerId}" ("op" "identify") [] result)
+        (call "${client.relayPeerId}" ("peer" "identify") [] result)
         `;
         const data = new Map();
         data.set('__relay', client.relayPeerId);
@@ -197,8 +191,8 @@ describe('Typescript usage suite', () => {
 
     it('two clients should work inside the same time browser', async function () {
         // arrange
-        const client1 = await createConnectedClient(devNodeAddress);
-        const client2 = await createConnectedClient(devNodeAddress);
+        const client1 = await createConnectedClient(nodes[0].multiaddr);
+        const client2 = await createConnectedClient(nodes[0].multiaddr);
 
         let resMakingPromise = new Promise((resolve) => {
             client2.registerCallback('test', 'test', (args, _) => {
@@ -225,32 +219,4 @@ describe('Typescript usage suite', () => {
         let res = await resMakingPromise;
         expect(res).toEqual(['some a', 'some b', 'some c', 'some d']);
     });
-
-    it('event registration should work', async function () {
-        // arrange
-        const client1 = await createConnectedClient(devNodeAddress);
-        const client2 = await createConnectedClient(devNodeAddress);
-
-        client2.registerEvent('event_stream', 'test');
-        const resMakingPromise = new Promise((resolve) => {
-            client2.subscribe('event_stream', resolve);
-        });
-
-        // act
-        let script = `
-            (call "${client2.selfPeerId}" ("event_stream" "test") [hello])
-        `;
-
-        let data: Map<string, any> = new Map();
-        data.set('hello', 'world');
-
-        await client1.fireAndForget(script, data);
-
-        // assert
-        let res = await resMakingPromise;
-        expect(res).toEqual({
-            type: 'test',
-            args: ['world'],
-        });
-    });
 });

src/__test__/unit/air.spec.ts

@@ -1,4 +1,4 @@
-import { createLocalClient } from '../util';
+import { createLocalClient } from '../connection';
 
 describe('== AIR suite', () => {
     it('check init_peer_id', async function () {
@@ -57,7 +57,7 @@ describe('== AIR suite', () => {
 
         const script = `(call %init_peer_id% ("" "") [""])`;
 
-        await expect(client.sendScript(script, undefined, 1)).rejects.toContain("Particle expired");
+        await expect(client.sendScript(script, undefined, 1)).rejects.toContain('Particle expired');
     });
 
     it.skip('call broken script by fetch', async function () {