Migrating Custom Transports to latest (7.x) SDK version

[ktsangop]

Hello people,

We are trying to upgrade our self-hosted Sentry server and clients to latest versions.
I have refactored our JS client based on the migration guide here:
https://github.com/getsentry/sentry-javascript/blob/master/MIGRATION.md#custom-transports and I have a question regarding the example code line :
return createTransport({ bufferSize: options.bufferSize }, makeRequest);
The createTransport method's options argument seems to implement the following interface :

export interface InternalBaseTransportOptions {
    bufferSize?: number;
    recordDroppedEvent: Client['recordDroppedEvent'];
    textEncoder?: TextEncoderInternal;
}

which makes the recordDroppedEvent property required.

Now I am not sure what we should pass to that argument, and I cannot seem to find any related documentation.
We currently pass recordDroppedEvent: null but, our requests fail (probably not related but can't be sure at the moment)

Any help would be appreciated,
Thanks in advance!

[AbhiPrasad]

Hey @ktsangop - you shouldn't need to access those internal base transport options.

Something like so should suffice:

/**
 * Creates a Custom transport.
 */
export function makeCustomTransport(
  options: BrowserTransportOptions,
): Transport {
  async function makeRequest(request: TransportRequest): PromiseLike<TransportMakeRequestResponse> {
    try {
      const response = await makeARequestFromUrl(options.url, request.body);
      // the `statusCode` and the two rate limiting headers 
      const transportResponse = {
        statusCode: response.status,
        headers: {
          'x-sentry-rate-limits': response.header['X-Sentry-Rate-Limits'],
          'retry-after': response.headers['Retry-After'],
        },
      };
      return Promise.resolve(transportResponse)
    } catch (e) {
      clearCachedFetchImplementation();
      return rejectedSyncPromise(e);
    }
  }

  return createTransport(options, makeRequest);
}

[ktsangop]

Does this mean that the migration guide has a type error?
Don't know if you had a chance to take a look at the example provided, because my link was malformed (edited now)

Anyway, I suppose passing the options just as they were received above will suffice.
Thanks for helping :)

[AbhiPrasad]

I'll amend the migration docs, forwarding should be all you need to do.

[ktsangop]

Not sure if I need to start another discussion for this, but I have a related question.
The Envelopes API we have to use now that we upgraded Sentry, has a totally different data payload model as described here:
https://develop.sentry.dev/sdk/envelopes/

We need to parse "Envelopes" sent from our client to our private API before we sent them to our self-hosted Sentry server,
as we add extra information.

Previously that was fairly straightforward using the Store API
since we had to manipulate JSON data.

Is there any respective API on the server side JAVA SDK we can use to parse and manipulate Envelopes ?
Any point to documentation would be extremely helpful!

Thanks again

[AbhiPrasad]

Is there any respective API on the server side JAVA SDK we can use to parse and manipulate Envelopes ?

I would reach out to the Java SDK maintainers to ask! https://github.com/getsentry/sentry-java

[AbhiPrasad]

#7143