[Identity] min-max tests failed because of inconsistent types loaded

[sadasant]

Checklists

• Added impacted package name to the issue description

Packages impacted by this PR:

@azure/identity

Describe the problem that is addressed by this PR:

Even though we merged an update recently to fix min-max tests, #19810 which we tested using the pipelines against that PR, nightly min-max tests ended up failing right afterwards. The error received was as follows:

node/clientCertificateCredential.spec.ts(93,24): error TS2769: No overload matches this call.
  Overload 1 of 2, '(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions | undefined): ClientCertificateCredential', gave the following error.
    Argument of type '{ certificatePath: string; }' is not assignable to parameter of type 'string'.
  Overload 2 of 2, '(tenantId: string, clientId: string, configuration: ClientCertificateCredentialPEMConfiguration, options?: ClientCertificateCredentialOptions | undefined): ClientCertificateCredential', gave the following error.
    Type '(_request: PipelineRequest) => Promise<PipelineResponse>' is not assignable to type 'SendRequest'.
      Types of parameters '_request' and 'request' are incompatible.
        Type 'import("/mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/types/latest/core-rest-pipeline").PipelineRequest' is not assignable to type 'import("/mnt/vss/_work/1/s/common/temp/node_modules/.pnpm/@[email protected]/node_modules/@azure/core-rest-pipeline/types/latest/core-rest-pipeline").PipelineRequest'.
          Types of property 'body' are incompatible.
            Type 'import("/mnt/vss/_work/1/s/sdk/core/core-rest-pipeline/types/latest/core-rest-pipeline").RequestBodyType | undefined' is not assignable to type 'import("/mnt/vss/_work/1/s/common/temp/node_modules/.pnpm/@[email protected]/node_modules/@azure/core-rest-pipeline/types/latest/core-rest-pipeline").RequestBodyType | undefined'.
              Type 'ReadableStream<Uint8Array>' is not assignable to type 'RequestBodyType | undefined'.
                Type 'ReadableStream<Uint8Array>' is missing the following properties from type 'ReadableStream': readable, read, setEncoding, pause, and 22 more.

Having experienced similar issues in the past, I realized that this is likely because there are more than one copy of the same package loaded into TypeScript memory with a small version difference. Even if the types are identical, given that they don’t come from the same place, TypeScript can’t really assume they’re the same — that has been my experience in the past, at least.

So, my strategy was to find the simplest solution by perhaps removing an unnecessary type.

I followed the instructions to run min-max tests locally (here). I reproduced the issue, then I was able to remove an unused parameter to fix it.

[witemple-msft]

CC @joheredi @xirzec : This must be related to the whatwg stream and fetch support that was merged into corev2. It does make sense that adding a new variation to the request body type is a breaking change for core consumers.

[sadasant]

@witemple-msft keep in mind that this only fails in min-max and not on the rest of the tests (record, playback, live, none of that).

[xirzec]

CC @joheredi @xirzec : This must be related to the whatwg stream and fetch support that was merged into corev2. It does make sense that adding a new variation to the request body type is a breaking change for core consumers.

Hmm... doesn't the above error make sense though? If I understand it correctly, it's trying to send a PipelineRequest that supports streams to an older version of core that doesn't support streams, so it fails.

[sadasant]

I’ll merge this since this solves our nightly builds and the changes are not negatively impactful in any way.