fix: [sc-105230] particle-api-js getEventStream does not honor setContext / X-Particle-Tool http header correctly

[joegoggins]

Description

Fixes bug sc-105230 by passing X-Particle-Tool or X-Particle-Project http headers accordingly to event stream http requests that honor particleAPI.setContext('tool|project'). This work makes it so that Delorean CLI telemetry will be accurate when event stream consuming commands are introduced.

Also, eliminates problem where PARTICLE_API_TOKEN had to be specified for many npm run commands by moving *.js files that require these to an e2e-tests that does NOT run in CI. This is not a step down in terms of quality; as these tests were not designed to be run in this CI context, but rather manually by developers working on the event stream.

How to test?

Get the branch setup: git checkout, cd into repo, nvm use, npm i 👍

1. npm run compile
2. npm run test:ci; observe no failures due to PARTICLE_API_TOKEN not being set
3. Put this foo.js snippet in the parent dir where your git checkout is

const ParticleAPI = require('.');

async function main() {
    const api = new ParticleAPI();
    api.setDefaultAuth('TODO');
    api.setContext('tool', {name: 'yoyo', version: '6.6.6'});
    const stream = await api.getEventStream({deviceId: 'mine'});
    console.log(stream);
}
main();

4. Populate TODO with valid token and run node foo.js
5. In the debug output, observe _headers has [email protected] in it (thus proving http headers are now honored)

[busticated]

looks good - thanks for doing battle 🙏 🙌

prior to merging, let's remove the env vars over in CircleCI to verify we do not have any lingering usages 👍

[busticated]

@joegoggins

Also, eliminates problem where PARTICLE_API_TOKEN had to be specified for many npm run commands by moving *.js files that require these to an e2e-tests that does NOT run in CI. This is not a step down in terms of quality; as these tests were not designed to be run in this CI context, but rather manually by developers working on the event stream.

fwiw, @deleonn updated CI over in #142 to ensure at least the node-side event e2e tests ran with their required perquisites - here's an example of them running and "passing":

https://app.circleci.com/pipelines/github/particle-iot/particle-api-js/53/workflows/cd0aa933-14fd-4836-a96b-024f13e31457/jobs/156?invite=true#step-103-42

further complicating things, the reference to "Agent integration tests" in these docs is incorrect - it's actually the test/EventStream-e2e-node.js file which is running in CI.

all that said, at this point i'd just delete all of those (e2e-tests directory and related) as they're likely to cause more confusion than help.

[joegoggins]

Cool. I'll remove circle ci vars, nuke e2e-tests, merge, and cut a release. Thanks. 👍