fix: Change parameter name to give more useful TypeScript error on SDK version mismatch

[timfish]

Closes #583

The error reported in the above issue would now read:

Argument of type '(if_you_get_a_typescript_error_ensure_sdks_use_version_v7_16_0: import("d:/dev/projects/glint/angular/node_modules/@sentry/browser/types/client").BrowserOptions) => void' is not assignable to parameter of type '(options: import("d:/dev/projects/glint/angular/node_modules/@sentry/electron/node_modules/@sentry/browser/types/client").BrowserOptions) => void'.
  Types of parameters 'if_you_get_a_typescript_error_ensure_sdks_use_version_v7_16_0' and 'options' are incompatible.
    Type 'import("d:/dev/projects/glint/angular/node_modules/@sentry/electron/node_modules/@sentry/browser/types/client").BrowserOptions' is not assignable to type 'import("d:/dev/projects/glint/angular/node_modules/@sentry/browser/types/client").BrowserOptions'.
      Types of property 'defaultIntegrations' are incompatible.
        Type 'false | import("d:/dev/projects/glint/angular/node_modules/@sentry/electron/node_modules/@sentry/types/types/integration").Integration[] | undefined' is not assignable to type 'false | import("d:/dev/projects/glint/angular/node_modules/@sentry/types/types/integration").Integration[] | undefined'.

[AbhiPrasad]

Let's do it!

[lucas-zimerman]

In this case, wouldn't it also give a margin of error to the user where the user installs "@sentry/angular": "^7.16.0" instead of "@sentry/angular": "7.16.0"?

[timfish]

In this case, wouldn't it also give a margin of error to the user where the user installs

Yes correct, this doesn't check the versions at all, it just means that if the types don't match, the error displayed by TypeScript is more helpful. We no doubt go through quite a few patch releases before the types become incompatible so this is not foolproof.

We could add version specific properties to some key types that cause the types to break immediately if versions don't match like:

interface ClientOptions {
  _sdk_version_v7_16_0?: bool
}

[AbhiPrasad]

We could add version specific properties to some key types that cause the types to break immediately if versions don't match like

yeah but this could possibly be a breaking change. could we just update the injected type for if_you_get_a_typescript_error_ensure_sdks_use_version to only use major + minor version?

[timfish]

yeah but this could possibly be a breaking change

This would only break the TypeScript builds of those using mismatched versions of SDKs and that is neither tested nor supported. If any customers have mismatched versions that are currently working, this is purely luck, even with only patch version differences.

could we just update the injected type for if_you_get_a_typescript_error_ensure_sdks_use_version to only use major + minor version

I don't think we can do anything from the top-level types since we need there to be a mismatch between the common types in @sentry/electron and whichever front-end SDK is being passed in (ie. @sentry/core).

[AbhiPrasad]

I don't think we can do anything from the top-level types since we need there to be a mismatch between the common types in @sentry/electron and whichever front-end SDK is being passed in (ie. @sentry/core).

This is a good point. Given that I'd be fine with updating the types this way and merging this in.

[mydea]

I think this is a good small improvement for this context!