Sentry.Handlers.requestHandler migration steps required?

[simllll]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Self-hosted/on-premise

Which package are you using?

@sentry/node

SDK Version

7.2.0

Framework Version

No response

Link to Sentry event

No response

Steps to Reproduce

According to https://docs.sentry.io/platforms/node/guides/express/ and other docs,
we have this in our code base:

app.use(
	Sentry.Handlers.requestHandler({
		user: ['_id', 'source'],
		request: true,
		serverName: true,
		version: true
	})
);

but since the latest refactorings (d69cafc) this does not compile anymore, we get the following error:

TS2345: Argument of type '{ user: string[]; request: boolean; serverName: boolean; version: boolean; }' is not assignable to parameter of type 'RequestHandlerOptions'.   Object literal may only specify known properties, and 'user' does not exist in type 'RequestHandlerOptions'.

I looked into RequestHandlerOptions and found there a new child called "include":

Should I move user + request inside of include, and if yes, what happened to serverName and version, where can I specify them now?

Expected Result

Either a mirgation guide or it should work as before ;)

Actual Result

latest 7.2.0 is not compilable with config parameters for requestHandler

[lobsterkatie]

Shoot. You're totally right - apologies. I thought I'd handled backwards compatibility but I missed this bit of it. Will have a fix out shortly.

[simllll]

Thanks for the PR, just out of curiosity, is there a "new"/better way to provide the flags? As I've seen you check for "include" property, if it's there you use the new one, otherwise the old handler. does that mean there is a "new"/preferred way of passing the params. if so, is there any migration guide to find out how to set these four parameters: (user, request, serverName and version). I guess for user and request it is user -> include.user and request -> include.request, but not sure about serverName and version?