feat: Add Sidecar connect function

[HazAT]

To hook into Sentry's Node SDK this is what you have to do:

import * as Sentry from '@sentry/node';
import { connect } from '@spotlightjs/sidecar/connect'

Sentry.init({debug: true});
connect(Sentry.getCurrentHub()); // After Sentry init, call connect and pass the hub
...
Sentry.captureMessage('Something went wrong');

ref: #76

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
spotlightjs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 21, 2023 7:42pm

[dcramer]

Is there any reason we cant automatically do this somehow?

[dcramer]

Also lets open a ticket on the core JS repo to make sure whatever we do here becomes a native API

[HazAT]

Only to avoid the SDK even knowing about Spotlight/Sidecar
If not, this fetch has to be in our Core Node SDK that every customer runs which is not a good idea imho

fetch("http://localhost:8969/stream", {
      method: "POST",
      body: serializeEnvelope(envelope),
      headers: {
        "Content-Type": "application/x-sentry-envelope",
      },
      mode: "cors",
    }).catch((err) => {
      console.error('[Spotlight]', err);
    });

This is only a problem for Node (and other Server SDKs) - not for Browser

[HazAT]

The advantage of an explicit connect function from the sidecar is that it stays in sync with the actual sidecar
If we add this code to the SDKs you need a specific version + if we change the URL / Port, it gets outdated.

I think initially this is fine until this all is a bit more robust.

[dcramer]

is there no other sane way to define these main exports e.g. in like an index.ts or something?

[dcramer]

did not test

[dcramer]

We should reconsider this and put a spotlight: true/false into Sentry.init() in SDKs imo.