sp-dev-fx-webparts/samples/react-graph-auto-batching

Graph auto batching

Summary

This same shows how to abstract batching graph requests. The idea behind this sample is quite simple. To render simple user card we need three calls to MS GraphAPI. First one to get user information, second to get the image and third to get the presence. As with rendering multiple user card we may hit graph throttling, it is a good idea to batch those requests. This might create quite a repetition across our solution. To avoid such situation, we can implement composition pattern to abstract that batch generation. This design pattern will also help us with unit testing.

This is the second idea behind this sample. It provides few unit tests of quite a complex implementation detail, which auto batching is. You can also find how one can test react component in SPFx stack in isolation, by providing mock to all data access layer implementation.

Finally, let me know if You would like to see this auto batcher in some library You can import to Your solution.

You may ask why I used AadHttpClient instead of MSGraphClient. AadHttpClient shares more similarity with a http client based on fetch api, this means it will be easier to adopt this solution to an implementation outside of SPFx.

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

Applies to

• SharePoint Framework
• Microsoft 365 tenant

Prerequisites

None

Contributors

• Marcin Wojciechowski @mgwojciech

Version history

Version	Date	Comments
1.0	February 3, 2022	Initial release

Minimal Path to Awesome

• Clone this repository (or download this solution as a .ZIP file then unzip it)
• From your command line, change your current directory to the directory containing this sample (react-graph-auto-batching, located under samples)
• in the command line run:
  • npm install
  • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

• Add Graph Auto Batching

To run tests

• Clone this repository (or download this solution as a .ZIP file then unzip it)
• From your command line, change your current directory to the directory containing this sample (react-graph-auto-batching, located under samples)
• in the command line run:
  • npm install
  • npx jest

Features

Description of the extension that expands upon high-level summary above.

This extension illustrates the following concepts:

• User Card using auto batching requests to MS Graph Client
• Unit testing batching client using mocked http client
• Unit testing React component in SPFx
  • In total isolation
  • Awaiting the useEffect(()=>{},[]) operation

References

• Getting started with SharePoint Framework
• Building for Microsoft teams
• Use Microsoft Graph in your solution
• Publish SharePoint Framework applications to the Marketplace
• Microsoft 365 Patterns and Practices - Guidance, tooling, samples and open-source controls for your Microsoft 365 development
• You can find more on unit testing on my Blog

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.