Sinon made it difficult to successfully stub/mock a method return

Question

Sinon made it difficult to successfully stub/mock a method return

I find myself facing a challenge as I navigate the learning path to nodejs and explore advanced javascript features. Progress is slow but steady. One of the rest endpoints utilizes the (azure blob storage) method from containerclient, which requires converting the results into a different format. When it comes to writing tests using sinon, there is a need to stub/mock/fake this method along with its return values. As I iterate through the Blobitem objects in my rest endpoint.

listBlobsByHierarchy(string, ContainerListBlobsOptions)

This method yields

PagedAsyncIterableIterator<({ kind: "prefix"; } & BlobPrefix) | ({ kind: "blob"; } & BlobItem), ContainerListBlobHierarchySegmentResponse>

The question arises - how should I proceed with this task? If I mock this method and alter its return value, what steps should I take next?

To learn more, check out the following reference link: ContainerClient.listBlobsByHierarchy

typescript azure-blob-storage sinon

Answer 1

Answer №1

Originally, I opted for the any type to work around the problem. Given that my code necessitates an iterable object, I implemented it in this manner... A great way to familiarize oneself with the any type

const obj: any = [ {...} ];
containerStub.listBlobsByHierarchy.returns(obj);
const actualResponse = await (await client.get('ENDPOINT')).body;
const expectedobj: any = [ {...} ]; // whatever the method will return
expect(actualResponse).deepEqual(expectedobj);

The code above reflects the concept. There is also a different approach believed to be more favorable - converting it to unknown and then transitioning it to the actual type. Apparently, utilizing the any type is less preferable than converting it to unknown.

const obj = [ {...} ] as unknown as PagedAsyncIterableIterator< 
                ({ kind: 'prefix' } & BlobPrefix) | ({ kind: 'blob' } & BlobItem), 
                ContainerListBlobHierarchySegmentResponse 
            >;
containerStub.listBlobsByHierarchy.returns(obj);

Transitioning from the realm of traditional Java into typescript / JavaScript poses a challenge for a beginner like me.

Answer 2

Originally, I opted for the any type to work around the problem. Given that my code necessitates an iterable object, I implemented it in this manner... A great way to familiarize oneself with the any type

const obj: any = [ {...} ];
containerStub.listBlobsByHierarchy.returns(obj);
const actualResponse = await (await client.get('ENDPOINT')).body;
const expectedobj: any = [ {...} ]; // whatever the method will return
expect(actualResponse).deepEqual(expectedobj);

The code above reflects the concept. There is also a different approach believed to be more favorable - converting it to unknown and then transitioning it to the actual type. Apparently, utilizing the any type is less preferable than converting it to unknown.

const obj = [ {...} ] as unknown as PagedAsyncIterableIterator< 
                ({ kind: 'prefix' } & BlobPrefix) | ({ kind: 'blob' } & BlobItem), 
                ContainerListBlobHierarchySegmentResponse 
            >;
containerStub.listBlobsByHierarchy.returns(obj);

Transitioning from the realm of traditional Java into typescript / JavaScript poses a challenge for a beginner like me.

Sinon made it difficult to successfully stub/mock a method return

Answer №1

Similar questions

Tips for modifying an axios instance during response interception

What is the process of transforming an array of string variables into TypeScript types?

Generate a blueprint for a TypeScript interface

ADAL-Node: Unable to locate tenant groups

Filtering data in Angular from an HTML source

exclude a few countries from ngx-intl-tel-input

Error 415 Unsupported Media Type when uploading files using Angular 12 with TypeScript

Tips for converting a string array constant into a union type

What steps can I take to resolve the "Unable to call a potentially 'undefined' object" error?

Tips on preventing the duplication of component instances in your project

Angular data binding with an object instead of an array list

Utilizing *ngIf for Showing Elements Once Data is Completely Loaded

How can I determine the existence of an S3 bucket and, if it doesn't exist, create it using TypeScript CDK?

Response received through GET call in text format

The comprehensive guide to using ambient enum types in an exhaustive switch statement

Is it considered an anti-pattern for certain components within a tile system to share a viewmodel when the parent web component has multiple child components?

Have there been any instances of combining AngularJS, ASP.NET-WebApi, OData, Breeze.js, and Typescript?

The HttpClient.get('/') request with {observe: 'response'} is failing to retrieve some headers

Utilize the useState hook to update state when changes occur in the

By utilizing a function provided within the context, React state will consistently have its original value