Add tests

[tony-go]

We'd like to have tests on this repository 🧪

As much as possible we'd like to use:

• tape or node-tap (node-tap is my new goto)
• have two scripts
  • one for running all tests once
  • one for running tests in watch mode
• execute the first script in the CI on node 18.x and the LTS.
• coverage is a plus

[PierreDemailly]

I'm on it

[tony-go]

Hey @PierreDemailly 👋

Thanks for this amazing work. 👏

How goes this issue? Do you need any support?

[PierreDemailly]

Hi @tony-go
network.js is the last file to test.
I remember tried to test it but it thrown due to missing browser API and/or others things, I will look again and give more details

[tony-go]

@PierreDemailly awesome ^^

Do you think that you could add a list of stuff you did and what is missing?

Thanks again for this amazing job 👏

[PierreDemailly]

Hi @tony-go 👋
So I've tried again to test NodeSecureNetwork but i'm stuck.
There was a problem with ESM:

I've tried multiple things to make it works, the only thing that seem to works is:

I wonder if it is an "anti-pattern" without deep-import / tree-shaking, not sure..
Then Network is made for browser and use multiple API we don't have in Node (that make crash the process):
I've 'mock' it (adding JSDOM needed APIs to global), it seem to be a bad practice -> WDYT ?

import crypto from "node:crypto";
import { JSDOM } from "jsdom";

const { window } = (new JSDOM(`
    <div id="network-graph"></div>
    <div id="network-loader"></div>
`));
const { document } = window;

global.window = window;
global.navigator = window.navigator;
global.document = document;
global.crypto = crypto;
global.Element = window.Element;
global.HTMLCanvasElement = window.HTMLCanvasElement;

I've also needed to add canvas to the dev deps: jsdom/jsdom#3042 (comment)

I've made my first test: OK.

tap.test("it should throw when providing unknown theme", (t) => {
    try {
        new NodeSecureNetwork(nsDataSet, { theme: "AZJ001" });
    }
    catch (e) {
        t.same(e, new Error("Unknown theme AZJ001. Theme value can be LIGHT or DARK"));
    }
    finally {
        t.end();
    }
});

So I've tried somethings like this:

t.equal(network.highlightEnabled, false, "highlight is disabled by default");
network.neighbourHighlight({ nodes: [0] });
t.equal(network.highlightEnabled, true, "highlight has been enabled");

(https://github.com/NodeSecure/vis-network/blob/main/src/network.js#L173)

But if I call any method from the NodeSecureNetwork, always this error:

And now, I'm stuck.
I'm not sure how to handle Missing Browser API & events (Network.on(), Network.stabilize(), Network.start/stopSimulation()...).

Maybe I should completely mock Network ?
I also would see e2e tests, WDYT ?

[tony-go]

I saw that you already add a few test here: main...PierreDemailly:vis-network:feat/add-tests-v1

Maybe you should raise a PR, and then we could merge it.

Also if some classes or functions are too broad maybe should we think about the e2e tests as you mentioned.