sp-dev-fx-webparts/samples/react-graph-auto-batching
Hugo Bernier 7e97daab76 Added more contributions 2023-03-15 01:23:34 -04:00
..
.devcontainer Added container, sample.json 2022-02-13 02:08:44 -05:00
assets Merge pull request #3124 from pnp/mgwojciech-react-query 2022-11-08 19:13:51 +01:00
config Samples reviewed and prepared for merge 2022-11-08 19:11:58 +01:00
src Samples reviewed and prepared for merge 2022-11-08 19:11:58 +01:00
teams Initial commit 2022-02-03 19:00:36 +01:00
tests Initial commit 2022-02-03 19:00:36 +01:00
.gitignore Samples reviewed and prepared for merge 2022-11-08 19:11:58 +01:00
.npmignore Initial commit 2022-02-03 19:00:36 +01:00
.yo-rc.json added sample for ACE 2022-05-05 10:58:49 +02:00
README.md Added more contributions 2023-03-15 01:23:34 -04:00
gulpfile.js Samples reviewed and prepared for merge 2022-11-08 19:11:58 +01:00
package-lock.json Bump decode-uri-component in /samples/react-graph-auto-batching 2022-12-30 23:28:12 -05:00
package.json Samples reviewed and prepared for merge 2022-11-08 19:11:58 +01:00
tsconfig.json Initial commit 2022-02-03 19:00:36 +01:00
tslint.json Initial commit 2022-02-03 19:00:36 +01:00

README.md

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.

SPFx 1.13.0 Node.js v14 | v12 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Prerequisites

None

Contributors

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

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.