<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:content="http://purl.org/rss/1.0/modules/content/"><channel><title>Microsoft 365 API Performance on Jeppe Spanggaard - Software Developer | .NET, Azure &amp; Microsoft 365</title><link>https://jeppe-spanggaard.dk/tags/api-performance/</link><description>Recent content in Microsoft 365 API Performance on Jeppe Spanggaard - Software Developer | .NET, Azure &amp; Microsoft 365</description><generator>Hugo</generator><language>en-US</language><lastBuildDate>Sun, 26 Jul 2026 00:00:00 +0000</lastBuildDate><atom:link href="https://jeppe-spanggaard.dk/tags/api-performance/index.xml" rel="self" type="application/rss+xml"/><item><title>Stop Re-Downloading Unchanged Blobs: Let Azure Answer 304 for You</title><link>https://jeppe-spanggaard.dk/blogs/azure-blob-storage-etag-304/</link><pubDate>Sun, 05 Jul 2026 00:00:00 +0000</pubDate><guid>https://jeppe-spanggaard.dk/blogs/azure-blob-storage-etag-304/</guid><description>Learn how to forward the browser's If-None-Match header to Azure Blob Storage with BlobRequestConditions, so unchanged files never leave storage at all.</description><content:encoded><![CDATA[<p>I have an Azure Functions backend whose job, among other things, is serving a web app&rsquo;s static files out of Blob Storage: JS bundles, fonts, icons, an <code>index.html</code>. Same files, same users, many times a day.</p>
<p>And for a while, every single request did the same dumb thing: download the blob from storage, push the bytes to the browser. The file hadn&rsquo;t changed since five seconds ago. The user&rsquo;s browser literally had an identical copy already. Didn&rsquo;t matter - full download from storage, full response to the client, every time. I was paying latency and moving bytes just to deliver files nobody actually needed re-delivered.</p>
<p>The fix was already sitting in every storage response I&rsquo;d been ignoring: the ETag.</p>
<h2 id="thirty-seconds-on-etags">Thirty Seconds on ETags</h2>
<p>Every blob response (and every properties call) includes an <code>ETag</code> header, something like <code>&quot;0x8DC5F3A2B1E4D70&quot;</code>. Storage changes it whenever the blob&rsquo;s content or metadata changes. It costs nothing, it&rsquo;s always there.</p>
<p>On the HTTP side, the handshake is old and boring and great: the server sends <code>ETag</code> with a response; the browser saves it; next time the browser asks for the same URL it includes <code>If-None-Match: &lt;that etag&gt;</code>; if the server still has the same version, it answers <code>304 Not Modified</code> with no body, and the browser uses its cached copy.</p>
<p>Boring. Reliable. Built into every browser since forever.</p>
<h2 id="the-naive-version">The Naive Version</h2>
<p>My first pass was the obvious one:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">var</span> response = <span style="color:#66d9ef">await</span> blob.DownloadStreamingAsync(cancellationToken: ct);
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> FileStreamResult(response.Value.Content, contentType);
</span></span></code></pre></div><p>Works fine. But look at what the function actually <em>is</em> in this setup: a photocopier standing between storage and the browser, dutifully copying files that both sides already agree on. The browser has the file. Storage knows the file hasn&rsquo;t changed. And my function in the middle is the only one who never asked.</p>
<h2 id="the-trick-be-a-pipe-not-a-cache">The Trick: Be a Pipe, Not a Cache</h2>
<p>The Azure SDK supports conditional requests natively. So instead of checking anything myself, I just hand the browser&rsquo;s ETag straight to storage:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">public</span> <span style="color:#66d9ef">async</span> Task&lt;AssetResponse?&gt; GetAsync(<span style="color:#66d9ef">string</span> path, <span style="color:#66d9ef">string?</span> ifNoneMatch, CancellationToken ct)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> blob = _container.GetBlobClient(path);
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> options = <span style="color:#66d9ef">new</span> BlobDownloadOptions();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Pass the client&#39;s ETag to the storage service as a conditional request.</span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Azure Blob Storage will short-circuit at the network level and return a 304,</span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// meaning we never transfer the file body when the client is up to date.</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (!<span style="color:#66d9ef">string</span>.IsNullOrEmpty(ifNoneMatch))
</span></span><span style="display:flex;"><span>        options.Conditions = <span style="color:#66d9ef">new</span> BlobRequestConditions { IfNoneMatch = <span style="color:#66d9ef">new</span> ETag(ifNoneMatch) };
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">try</span>
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> response = <span style="color:#66d9ef">await</span> blob.DownloadStreamingAsync(options, ct);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">if</span> (response.GetRawResponse().Status == <span style="color:#ae81ff">304</span>)
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// Client&#39;s copy is current - signal it without a body.</span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> AssetResponse { ETag = ifNoneMatch!, IsNotModified = <span style="color:#66d9ef">true</span> };
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> details = response.Value.Details;
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> AssetResponse
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            ETag = details.ETag.ToString(),
</span></span><span style="display:flex;"><span>            Content = response.Value.Content,
</span></span><span style="display:flex;"><span>            ContentType = details.ContentType,
</span></span><span style="display:flex;"><span>        };
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">catch</span> (RequestFailedException ex) when (ex.Status == <span style="color:#ae81ff">404</span>)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">null</span>;
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p><strong>What&rsquo;s happening here?</strong></p>
<ol>
<li>The browser&rsquo;s <code>If-None-Match</code> value goes into <code>BlobRequestConditions.IfNoneMatch</code>. That turns the download into a conditional request, the same ETag handshake, just one hop deeper.</li>
<li>The comparison happens <strong>inside Azure Storage</strong>, not in my code. On a match, storage answers 304 and the response has no body. The file bytes never even reach my function.</li>
<li>On a miss (file changed, or first visit), it&rsquo;s a normal download, and <code>DownloadStreamingAsync</code> gives me a live stream I pass straight through without buffering the whole file in memory.</li>
<li>Missing blob → the <code>RequestFailedException</code> filter turns a 404 into a <code>null</code>, which the endpoint maps to a proper NotFound.</li>
</ol>
<p>There is no dictionary of ETags, no memory cache, no invalidation logic. I didn&rsquo;t build a cache, I <em>connected two caches that already existed</em>: the browser&rsquo;s and storage&rsquo;s own knowledge of its blobs.</p>
<h2 id="finishing-the-loop-toward-the-browser">Finishing the Loop Toward the Browser</h2>
<p>The function endpoint relays the result:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span>req.HttpContext.Response.Headers[HeaderNames.ETag] = asset.ETag;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">if</span> (asset.IsNotModified)
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> StatusCodeResult(StatusCodes.Status304NotModified);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>req.HttpContext.Response.Headers[HeaderNames.CacheControl] = asset.IsImmutable
</span></span><span style="display:flex;"><span>    ? <span style="color:#e6db74">&#34;public, max-age=31536000, immutable&#34;</span>
</span></span><span style="display:flex;"><span>    : <span style="color:#e6db74">&#34;no-cache&#34;</span>;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> FileStreamResult(asset.Content!, asset.ContentType!);
</span></span></code></pre></div><p>Two details worth pausing on:</p>
<ul>
<li><strong><code>no-cache</code> doesn&rsquo;t mean &ldquo;don&rsquo;t cache&rdquo;.</strong> It means &ldquo;cache it, but revalidate before using it&rdquo;. That revalidation is exactly the <code>If-None-Match</code> round trip, which the pass-through just made nearly free - a header-only 304 instead of a file download. This is what <code>index.html</code> gets.</li>
<li><strong>Content-hashed files skip the conversation entirely.</strong> My build tool outputs filenames like <code>app.ByJ3R0Az.js</code> - the hash <em>is</em> the version. Those get <code>max-age=31536000, immutable</code>, so the browser never revalidates them at all. A new deploy produces a new filename, which is simply a different URL. The ETag dance is only for files whose names stay stable while their content changes.</li>
</ul>
<h2 id="why-i-like-this-better-than-a-memory-cache">Why I Like This Better Than a Memory Cache</h2>
<p>My first instinct was an <code>IMemoryCache</code> of blob contents in the function. I&rsquo;m glad I resisted:</p>
<ul>
<li><strong>Nothing to size.</strong> No &ldquo;how many MB of blobs do I keep in memory&rdquo; question.</li>
<li><strong>Nothing to invalidate.</strong> The ETag comparison is against live storage, so a deploy is visible on the very next request. Stale-cache bugs can&rsquo;t exist because there&rsquo;s no cache to go stale.</li>
<li><strong>Scale-out safe.</strong> Ten function instances behave identically because none of them hold state. A per-instance memory cache would give ten different answers for 60 seconds after every deploy.</li>
</ul>
<p>The thing that owns the data does the validation. Everyone else just forwards headers. 📮</p>
<h2 id="gotchas">Gotchas</h2>
<ul>
<li><strong>Round-trip the ETag string untouched.</strong> The quotes are part of the value. Trim them, &ldquo;clean them up&rdquo;, or re-wrap them and the comparison silently never matches again - everything still works, you just download every file every time and never notice.</li>
<li><strong>No ETag out, no <code>If-None-Match</code> back.</strong> Browsers only revalidate if your response included the <code>ETag</code> header in the first place. Forget it on one branch (error paths are a classic) and that file is a full download forever.</li>
<li><strong><code>no-cache</code> still costs one round trip per file per load.</strong> That&rsquo;s the deal: a header-only 304 instead of a body. For files that never change, don&rsquo;t negotiate - content-hash the filename and go <code>immutable</code>.</li>
</ul>
<h2 id="wrapping-up">Wrapping Up</h2>
<p>The cheapest download is the one that never happens. Blob Storage already fingerprints every blob and already speaks conditional requests - most backends just never pass the browser&rsquo;s question along. Forward <code>If-None-Match</code>, relay the 304, and let the two parties who actually know the answer talk to each other.</p>
]]></content:encoded></item><item><title>One Endpoint, Whole Website: Serving a Static Site Through an Azure Function</title><link>https://jeppe-spanggaard.dk/blogs/azure-function-blob-storage-static-site-proxy/</link><pubDate>Thu, 25 Jun 2026 00:00:00 +0000</pubDate><guid>https://jeppe-spanggaard.dk/blogs/azure-function-blob-storage-static-site-proxy/</guid><description>Learn how a single Azure Function with a catch-all route can proxy an entire static website out of a private Blob Storage container, with auth in front of every file.</description><content:encoded><![CDATA[<p>I needed to host an internal handbook. Nothing fancy: a static site full of onboarding guides and how-tos, built with a static site generator into a folder of HTML, CSS, JS, and images. The one hard requirement: <strong>only signed-in employees get to see it.</strong></p>
<p>And that requirement quietly kills all the easy hosting options. Blob Storage&rsquo;s static website feature? Public. A plain CDN? Public. The moment &ldquo;who is asking&rdquo; matters for every single file - not just the pages, the images and search index too - the files have to live somewhere private, and <em>something</em> with auth has to sit in front and hand them out.</p>
<p>My something is one Azure Function. One endpoint. It serves the entire site.</p>
<h2 id="the-blob-container-is-the-filesystem">The Blob Container Is the Filesystem</h2>
<p>There&rsquo;s no clever mapping layer. I upload the build output into the container exactly as the generator produced it:</p>
<pre tabindex="0"><code>index.html
guides/onboarding/index.html
guides/expenses/index.html
assets/main.css
assets/search.js
images/office-map.png
</code></pre><p>The container layout <em>is</em> the URL space. Deploying a new version of the site is one CLI command:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-powershell" data-lang="powershell"><span style="display:flex;"><span>az storage blob upload-batch --source ./public --destination site-content --overwrite
</span></span></code></pre></div><h2 id="the-catch-all-function">The Catch-All Function</h2>
<p>Here&rsquo;s the whole thing, trimmed to its skeleton:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#a6e22e">[Function(&#34;Site&#34;)]</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">public</span> <span style="color:#66d9ef">async</span> Task&lt;IActionResult&gt; Run(
</span></span><span style="display:flex;"><span><span style="color:#a6e22e">    [HttpTrigger(AuthorizationLevel.Anonymous, &#34;get&#34;, Route = &#34;{*path}&#34;)]</span> HttpRequest req,
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">string?</span> path,
</span></span><span style="display:flex;"><span>    CancellationToken ct)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Every file goes through this gate - pages, scripts, images, all of it.</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (!<span style="color:#66d9ef">await</span> _auth.IsSignedInAsync(req))
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> UnauthorizedResult();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> blobPath = MapToBlobPath(path);
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> blob = _container.GetBlobClient(blobPath);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">try</span>
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> response = <span style="color:#66d9ef">await</span> blob.DownloadStreamingAsync(cancellationToken: ct);
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> contentType = response.Value.Details.ContentType ?? ContentTypeFor(blobPath);
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> FileStreamResult(response.Value.Content, contentType);
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">catch</span> (RequestFailedException ex) when (ex.Status == <span style="color:#ae81ff">404</span>)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> NotFoundResult();
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">private</span> <span style="color:#66d9ef">static</span> <span style="color:#66d9ef">string</span> MapToBlobPath(<span style="color:#66d9ef">string?</span> path)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (<span style="color:#66d9ef">string</span>.IsNullOrEmpty(path))
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#e6db74">&#34;index.html&#34;</span>;                    <span style="color:#75715e">// &#34;/&#34; → the front page</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (path.EndsWith(<span style="color:#e6db74">&#39;/&#39;</span>) || !Path.HasExtension(path))
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#e6db74">$&#34;{path.TrimEnd(&#39;/&#39;)}/index.html&#34;</span>; <span style="color:#75715e">// &#34;/guides/onboarding/&#34; → its index</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> path;                                 <span style="color:#75715e">// &#34;/assets/main.css&#34; → as-is</span>
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p><strong>What&rsquo;s happening here?</strong></p>
<ol>
<li><code>Route = &quot;{*path}&quot;</code> is the whole trick. The <code>*</code> makes it a catch-all: one route binding matches <code>/</code>, <code>/guides/onboarding/</code>, <code>/assets/main.css</code>, anything. One function, every file on the site.</li>
<li>The auth guard runs before anything touches storage. That&rsquo;s the entire reason this setup exists - a static host can protect a <em>site</em>, this protects every <em>byte</em>. (How <code>IsSignedInAsync</code> works - cookies, Entra ID, whatever fits - is its own topic; the point is it&rsquo;s one <code>if</code> at the top.)</li>
<li><code>MapToBlobPath</code> does the job a web server normally does silently: default documents. <code>/</code> becomes <code>index.html</code>, extension-less routes like <code>/guides/onboarding</code> become <code>guides/onboarding/index.html</code>. Forget this and your front page is a 404.</li>
<li><code>DownloadStreamingAsync</code> returns a live stream, and <code>FileStreamResult</code> pipes it straight to the response. The function never buffers a whole file in memory - a 4 MB image flows through, it doesn&rsquo;t <em>land</em> here.</li>
<li>A missing blob throws <code>RequestFailedException</code> with status 404; the exception filter turns that into a clean <code>NotFoundResult</code> instead of a pre-flight existence check (which would just be a second storage call).</li>
</ol>
<h2 id="content-types-the-unglamorous-part-that-breaks-everything">Content Types: The Unglamorous Part That Breaks Everything</h2>
<p>If you serve HTML with the wrong <code>Content-Type</code>, the browser doesn&rsquo;t render your page, it <em>downloads</em> it. Ask me how I know.</p>
<p>Best option: set correct content types on the blobs at upload time (<code>upload-batch</code> infers most of them). But blobs uploaded by hand or by older scripts often end up as <code>application/octet-stream</code>, so I keep a fallback map:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">private</span> <span style="color:#66d9ef">static</span> <span style="color:#66d9ef">string</span> ContentTypeFor(<span style="color:#66d9ef">string</span> path) =&gt; Path.GetExtension(path).ToLowerInvariant() <span style="color:#66d9ef">switch</span>
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;.html&#34;</span> =&gt; <span style="color:#e6db74">&#34;text/html&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;.css&#34;</span>  =&gt; <span style="color:#e6db74">&#34;text/css&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;.js&#34;</span>   =&gt; <span style="color:#e6db74">&#34;text/javascript&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;.json&#34;</span> =&gt; <span style="color:#e6db74">&#34;application/json&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;.svg&#34;</span>  =&gt; <span style="color:#e6db74">&#34;image/svg+xml&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;.png&#34;</span>  =&gt; <span style="color:#e6db74">&#34;image/png&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;.woff2&#34;</span> =&gt; <span style="color:#e6db74">&#34;font/woff2&#34;</span>,
</span></span><span style="display:flex;"><span>    _ =&gt; <span style="color:#e6db74">&#34;application/octet-stream&#34;</span>,
</span></span><span style="display:flex;"><span>};
</span></span></code></pre></div><h2 id="what-you-get-for-free">What You Get for Free</h2>
<ul>
<li><strong>Auth on every file.</strong> Not just page-level protection - the org chart PNG and the search index JSON are exactly as protected as the pages.</li>
<li><strong>One deploy target.</strong> Build the site, <code>upload-batch</code> the folder, done. No web server to configure, nothing to restart.</li>
<li><strong>Generator-agnostic.</strong> The function doesn&rsquo;t know or care if the folder came from Hugo, Astro, Docusaurus, or hand-written HTML.</li>
<li><strong>Cheap environments.</strong> Staging is just a second container and one config value. Rollback is re-uploading yesterday&rsquo;s build folder.</li>
</ul>
<h2 id="one-more-trick-stop-re-downloading-unchanged-files">One More Trick: Stop Re-Downloading Unchanged Files</h2>
<p>There&rsquo;s an elephant in the version above: every request downloads the full file from storage and pushes it to the browser - even when the file hasn&rsquo;t changed in weeks and the browser has a perfect copy from five minutes ago.</p>
<p>The fix is already sitting in Blob Storage: every blob has an <strong>ETag</strong>, a version fingerprint that changes on every write. Browsers already know the game - once they&rsquo;ve seen an <code>ETag</code> header, they send it back as <code>If-None-Match</code> on the next request. All the function has to do is forward that header into the SDK call:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">var</span> options = <span style="color:#66d9ef">new</span> BlobDownloadOptions();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> ifNoneMatch = req.Headers.IfNoneMatch.ToString();
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">if</span> (!<span style="color:#66d9ef">string</span>.IsNullOrEmpty(ifNoneMatch))
</span></span><span style="display:flex;"><span>    options.Conditions = <span style="color:#66d9ef">new</span> BlobRequestConditions { IfNoneMatch = <span style="color:#66d9ef">new</span> ETag(ifNoneMatch) };
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> response = <span style="color:#66d9ef">await</span> blob.DownloadStreamingAsync(options, ct);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">if</span> (response.GetRawResponse().Status == <span style="color:#ae81ff">304</span>)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Browser&#39;s copy is current - Azure never sent us the body at all.</span>
</span></span><span style="display:flex;"><span>    req.HttpContext.Response.Headers[HeaderNames.ETag] = ifNoneMatch;
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> StatusCodeResult(StatusCodes.Status304NotModified);
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>req.HttpContext.Response.Headers[HeaderNames.ETag] = response.Value.Details.ETag.ToString();
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> contentType = response.Value.Details.ContentType ?? ContentTypeFor(blobPath);
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> FileStreamResult(response.Value.Content, contentType);
</span></span></code></pre></div><p>The beautiful part: the ETag comparison happens <strong>inside Azure Storage</strong>, not in your code. On a match, storage answers 304 with no body - the file bytes never reach the function, and the function relays a bare 304 to the browser. No server-side cache, nothing to invalidate, and it works identically across scaled-out instances because nobody holds any state. The browser is the cache, Azure is the validator, and the function stays what it was: a pipe.</p>
<p>Two rules to make it stick: always set the <code>ETag</code> response header (no ETag out means the browser never asks conditionally again), and pass the value through untouched - the quotes are part of it, and &ldquo;cleaning them up&rdquo; silently breaks the match forever.</p>
<h2 id="gotchas">Gotchas</h2>
<ul>
<li><strong>You are the web server now.</strong> Default documents, trailing slashes, 404 pages - all the invisible things a real web server does are your job. <code>MapToBlobPath</code> above is the minimum, not the maximum.</li>
<li><strong>SPA? Then unknown routes need a fallback.</strong> For a client-side-routed app, a route with no matching blob should serve <code>index.html</code> (200, not 404) and let the router sort it out. For a docs site like mine, a real 404 is correct.</li>
<li><strong>Cold starts sit in front of your CSS.</strong> The function is in the path of <em>every byte</em>, so a consumption-plan cold start delays the whole page, not just an API call. For an internal tool I can live with it; know your tolerance.</li>
</ul>
<h2 id="wrapping-up">Wrapping Up</h2>
<p>One catch-all route, a private container, and a twenty-line function: a whole authenticated website with no web server to run. Add the <code>If-None-Match</code> pass-through and unchanged files stop moving entirely. The container is the filesystem, the function is the doorman. 🚪</p>
]]></content:encoded></item><item><title>The SharePoint CSOM Performance Playbook: Stop Paying for Wasted API Calls</title><link>https://jeppe-spanggaard.dk/blogs/sharepoint-csom-performance-playbook/</link><pubDate>Wed, 20 May 2026 00:00:00 +0000</pubDate><guid>https://jeppe-spanggaard.dk/blogs/sharepoint-csom-performance-playbook/</guid><description>Learn how to speed up SharePoint CSOM with five proven techniques - batching, CAML joins, change detection, server-side exception handling, and fast taxonomy loading.</description><content:encoded><![CDATA[<p>I&rsquo;ve spent years writing CSOM code, and I keep seeing the same performance sins in every codebase I review. Including my own older code, which is the humbling part.</p>
<p>For a long time, slow CSOM was just annoying. Users waited, someone made coffee, life went on. Then I sat down with a client to calculate the cost of <a href="https://learn.microsoft.com/en-us/sharepoint/sharepoint-prioritization">Service Prioritization in SharePoint</a>, where every CSOM call has an actual price tag: USD $1.00 per 1,000 calls. Suddenly all those wasted calls weren&rsquo;t just slow. They were an invoice.</p>
<p>That changed how I write CSOM. I count round trips now, the way you&rsquo;d count database queries in a hot loop. Over the past year I&rsquo;ve written several posts about the specific techniques that came out of that habit, and this post ties them together into one playbook.</p>
<h2 id="every-executequery-is-a-road-trip">Every ExecuteQuery Is a Road Trip</h2>
<p>Here&rsquo;s the mental model that makes all four techniques click: every <code>ExecuteQueryAsync()</code> is a road trip to the SharePoint server. Doesn&rsquo;t matter if you&rsquo;re delivering one package or a hundred, the drive takes the same time. Network latency, authentication, server processing - the overhead is per trip, not per operation.</p>
<p>So the whole playbook boils down to four questions:</p>
<ol>
<li>Can I deliver more packages per trip? (batching)</li>
<li>Can one trip cover several destinations? (CAML joins)</li>
<li>Is this trip even necessary? (change detection)</li>
<li>Can I avoid a second trip when something goes wrong? (ExceptionHandlingScope, and the taxonomy trick)</li>
</ol>
<p>Let&rsquo;s take them one at a time.</p>
<h2 id="rule-1-batch-or-suffer">Rule 1: Batch or Suffer</h2>
<p>The most common sin. A loop that loads items one by one:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// ❌ 50 items = 50 round trips = 3-5 seconds</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> id <span style="color:#66d9ef">in</span> itemIds)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> item = list.GetItemById(id);
</span></span><span style="display:flex;"><span>    context.Load(item);
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">await</span> context.ExecuteQueryAsync();
</span></span><span style="display:flex;"><span>    ProcessItem(item);
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>CSOM happily queues up operations until you call <code>ExecuteQueryAsync()</code>. Around 100 operations per batch is the reliable sweet spot:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// ✅ 50 items = 1 round trip = ~200-500ms</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> items = chunk.Select(id =&gt; {
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> item = list.GetItemById(id);
</span></span><span style="display:flex;"><span>    list.Context.Load(item);
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> item;
</span></span><span style="display:flex;"><span>}).ToList();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">await</span> context.ExecuteQueryAsync();
</span></span></code></pre></div><p>In my testing, that&rsquo;s a 10x+ improvement for the price of restructuring a loop. It works for reads, writes, deletes, all of it.</p>
<p>Full post with the reusable <code>ProcessInChunks</code> helper: <a href="https://jeppe-spanggaard.dk/blogs/csom-performance-optimization-chunking/">CSOM Performance Optimization: Why You Should Batch Your SharePoint Operations</a>.</p>
<h2 id="rule-2-join-lists-dont-query-them-one-by-one">Rule 2: Join Lists, Don&rsquo;t Query Them One by One</h2>
<p>Related data across multiple lists is where round trips multiply quietly. Customers in one list, orders in another, order items in a third, so you write three queries and merge the results in C#. Every multi-item query costs <a href="https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online">2 resource units</a> toward your throttling budget, so three lists cost 6 units plus three round trips plus the merging code nobody wants to maintain.</p>
<p>CAML supports joins, even though the SharePoint UI never hints at it. One query, one trip, 2 resource units, and the server does the merging. I use <a href="https://github.com/sadomovalex/camlex">CAMLEX</a> instead of raw CAML XML because lambda expressions are readable and the XML it generates is not:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">var</span> query = Camlex.Query()
</span></span><span style="display:flex;"><span>    .Where(x =&gt; (<span style="color:#66d9ef">string</span>)x[<span style="color:#e6db74">&#34;CustomerName&#34;</span>] == <span style="color:#e6db74">&#34;Contoso&#34;</span>) <span style="color:#75715e">// filter on a field 2 lists away!</span>
</span></span><span style="display:flex;"><span>    .LeftJoin(x =&gt; x[<span style="color:#e6db74">&#34;OrderTaskLookUp&#34;</span>].ForeignList(ListGuidOrderTasks))
</span></span><span style="display:flex;"><span>    .LeftJoin(x =&gt; x[<span style="color:#e6db74">&#34;OrderDetailLookUp&#34;</span>].PrimaryList(ListGuidOrderTasks).ForeignList(ListGuidOrders))
</span></span><span style="display:flex;"><span>    .LeftJoin(x =&gt; x[<span style="color:#e6db74">&#34;CustomerLookUp&#34;</span>].PrimaryList(ListGuidOrders).ForeignList(ListGuidCustomers))
</span></span><span style="display:flex;"><span>    .ProjectedField(x =&gt; x[<span style="color:#e6db74">&#34;CustomerName&#34;</span>].List(ListGuidCustomers).ShowField(<span style="color:#e6db74">&#34;CustomerName&#34;</span>));
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> camlQuery = <span style="color:#66d9ef">new</span> CamlQuery { ViewXml = query.ToString() };
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> items = ordersList.GetItems(camlQuery);
</span></span></code></pre></div><p>That&rsquo;s 66% fewer resource units than the three-query version, and you can even filter on a value several lists away. The lists must be connected via lookup columns, and ProjectedFields only supports simple field types (text, number, date - not user, choice, or managed metadata fields).</p>
<p>Full post with the raw CAML comparison and the field type list: <a href="https://jeppe-spanggaard.dk/blogs/joining-multiple-lists-csom-caml/">Efficient Multi-List Queries in CSOM: Using CAML Joins with CAMLEX</a>.</p>
<h2 id="rule-3-did-anything-actually-change">Rule 3: Did Anything Actually Change?</h2>
<p>Users are save-happy. They open a form, change nothing, and click save anyway. Automated syncs are worse. When I dug into a typical day of API logs on one project, <strong>roughly 70% of our SharePoint update calls weren&rsquo;t changing anything</strong>. SharePoint accepts identical data with a smile and bills you for the privilege.</p>
<p>The fix is change detection before the update:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">var</span> differences = GetDifferences(listItem, newValues, treatEmptyStringAsNull: <span style="color:#66d9ef">true</span>);
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">if</span> (differences.Any())
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> (fieldName, newValue) <span style="color:#66d9ef">in</span> differences)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        listItem[fieldName] = newValue;
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>    listItem.Update();
</span></span><span style="display:flex;"><span>    clientContext.ExecuteQuery();
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Nothing changed? Do absolutely nothing.</span>
</span></span></code></pre></div><p>The hard part is the comparison itself. SharePoint field types fight you: user fields where only <code>LookupId</code> matters, multi-choice fields that come back in random order, taxonomy values, dates with kind mismatches. Naive <code>oldValue == newValue</code> doesn&rsquo;t survive contact with any of them, and JSON serialization comparison turned out 3-5x slower than a proper normalizing comparer when I benchmarked both.</p>
<p>Full post with the complete comparison engine: <a href="https://jeppe-spanggaard.dk/blogs/sharepoint-csom-prevent-unnecessary-updates/">SharePoint CSOM: Prevent Unnecessary Updates and API Calls</a>.</p>
<h2 id="rule-4-let-the-server-do-the-catching">Rule 4: Let the Server Do the Catching</h2>
<p>This one came straight out of that Service Prioritization cost analysis. The client&rsquo;s solution made about 90,000 CSOM calls per month, and <strong>88% of them were <code>EnsureUser</code> calls for users who were already on the site</strong>. The classic defensive pattern - always ensure the user before setting a user field - was two round trips per assignment, and the first one was almost always pointless.</p>
<p><code>ExceptionHandlingScope</code> lets you ship try-catch logic to the server and resolve it in one round trip:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">var</span> scope = <span style="color:#66d9ef">new</span> ExceptionHandlingScope(clientContext);
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">using</span> (scope.StartScope())
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">using</span> (scope.StartTry())
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#75715e">// Optimistic: works for users already known to the site</span>
</span></span><span style="display:flex;"><span>        listItem[<span style="color:#e6db74">&#34;AssignedTo&#34;</span>] = FieldUserValue.FromUser(<span style="color:#e6db74">&#34;user@company.com&#34;</span>);
</span></span><span style="display:flex;"><span>        listItem.Update();
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">using</span> (scope.StartCatch())
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#75715e">// Fallback: only runs server-side if the try failed</span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> user = clientContext.Web.EnsureUser(<span style="color:#e6db74">&#34;user@company.com&#34;</span>);
</span></span><span style="display:flex;"><span>        listItem[<span style="color:#e6db74">&#34;AssignedTo&#34;</span>] = FieldUserValue.FromUser(<span style="color:#e6db74">&#34;user@company.com&#34;</span>);
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>clientContext.ExecuteQuery(); <span style="color:#75715e">// one trip</span>
</span></span></code></pre></div><p>Result for that client: a 75-85% reduction in monthly calls. One honest caveat, and it&rsquo;s important: the scope reduces <em>round trips</em>, not <em>server requests</em>. Each operation inside still counts toward throttling. The call reduction came from the optimistic-first logic, and ExceptionHandlingScope is what made that logic affordable.</p>
<p>Full post with the cost breakdown: <a href="https://jeppe-spanggaard.dk/blogs/sharepoint-exceptionhandlingscope-csom-ensureuser/">SharePoint&rsquo;s Server-Side Try-Catch: ExceptionHandlingScope</a>.</p>
<h2 id="rule-5-keep-taxonomy-out-of-your-viewfields">Rule 5: Keep Taxonomy Out of Your ViewFields</h2>
<p>Taxonomy fields are the slowest thing you can put in a CAML query. On a list where items carried 5 to 50 terms across multiple managed metadata fields, loading a few hundred items took 90-120 seconds. Users literally walked away from their computers.</p>
<p>The fix has two parts. First, query the list <em>without</em> the taxonomy fields in ViewFields, which is where most of the cost hides. Then load the taxonomy data separately through <code>FieldValuesForEdit</code>, where SharePoint stores it as a raw string you can parse directly:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// Raw format in FieldValuesForEdit: &#34;Label1|GUID1;Label2|GUID2&#34;</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">foreach</span> (ListItem[] chunk <span style="color:#66d9ef">in</span> items.Cast&lt;ListItem&gt;().Chunk(<span style="color:#ae81ff">100</span>))
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> item <span style="color:#66d9ef">in</span> chunk)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        clientContext.Load(item, i =&gt; i.FieldValuesForEdit);
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">await</span> clientContext.ExecuteQueryAsync();
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// parse Label|GUID pairs per item</span>
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>That took the same load from 90-120 seconds down to 25-35 seconds, a 70-75% improvement. Fair warning: this parses an internal, undocumented format. It&rsquo;s been reliable for me, but test it in your environment and keep the traditional approach as a fallback.</p>
<p>Full post with the parser: <a href="https://jeppe-spanggaard.dk/blogs/csom-taxonomy-performance-optimization/">CSOM Performance: Fast Taxonomy Loading for SharePoint List Items with Many Terms</a>.</p>
<h2 id="which-one-first">Which One First?</h2>
<p>If your workload is write-heavy (forms, syncs, integrations), start with change detection. It&rsquo;s the only technique that eliminates entire operations instead of making them cheaper, and it&rsquo;s invisible to users.</p>
<p>If your workload is read-heavy, start with batching. It&rsquo;s the smallest code change for the biggest win, and the chunking helper is reusable everywhere. And if those reads span related lists, add joins next: they cut resource units, not just latency, which stretches your throttling budget further.</p>
<p>ExceptionHandlingScope is for when a specific fallback pattern (like <code>EnsureUser</code>) dominates your call logs. Check your logs first - I only found the 88% figure because I went looking. And the taxonomy trick is a targeted weapon: only reach for it when managed metadata is measurably your bottleneck, because it carries the undocumented-format risk.</p>
<p>The good news is they stack. Batched updates that skip unchanged items, with server-side fallbacks, is exactly how my current projects run.</p>
<h2 id="gotchas">Gotchas</h2>
<ul>
<li><strong>100 operations per batch is the sweet spot.</strong> CSOM reliably handles around that many. Bigger batches mean bigger payloads and less predictable behavior across environments. Ask me how I know.</li>
<li><strong>ExceptionHandlingScope doesn&rsquo;t reduce throttling pressure by itself.</strong> Round trips go down, but every operation inside the scope still counts as a request. The savings come from the optimistic-first logic it enables.</li>
<li><strong>Your numbers will differ from mine.</strong> The 70%, 75-85%, and 70-75% figures are from real projects, but latency, item complexity, and tenant load all move them. Measure before and after in your own environment.</li>
<li><strong>Test under throttling before you trust any of it.</strong> <a href="https://jeppe-spanggaard.dk/blogs/devproxy-throttling-testing/">Dev Proxy</a> can simulate 429 responses locally so you find out how your batches behave under pressure before production does.</li>
<li><strong>The taxonomy trick gives you label and GUID, nothing more.</strong> If you need full term paths or custom properties, you&rsquo;re back to the taxonomy API for those items.</li>
<li><strong>Joins need lookup columns and GUIDs.</strong> CAML joins only work across lists connected by lookup columns, and referencing lists by GUID instead of title saves you from &ldquo;list does not exist&rdquo; surprises.</li>
</ul>
<p>If you&rsquo;re also downloading files in the same solution, the round-trip mindset applies there too - I&rsquo;ve covered that in <a href="https://jeppe-spanggaard.dk/blogs/download-multiple-files-from-sharepoint/">downloading multiple files from SharePoint</a>.</p>
<h2 id="wrapping-up">Wrapping Up</h2>
<p>Count your round trips before SharePoint counts them for you. That&rsquo;s the whole playbook in one sentence: fewer trips (batching), combined trips (CAML joins), no pointless trips (change detection), no second trips (ExceptionHandlingScope), and lighter trips (taxonomy loading).</p>
<p>Each technique stands on its own, so grab the one that matches your bottleneck:</p>
<ul>
<li><a href="https://jeppe-spanggaard.dk/blogs/csom-performance-optimization-chunking/">Batch your SharePoint operations</a></li>
<li><a href="https://jeppe-spanggaard.dk/blogs/joining-multiple-lists-csom-caml/">Join multiple lists in one CAML query</a></li>
<li><a href="https://jeppe-spanggaard.dk/blogs/sharepoint-csom-prevent-unnecessary-updates/">Prevent unnecessary updates</a></li>
<li><a href="https://jeppe-spanggaard.dk/blogs/sharepoint-exceptionhandlingscope-csom-ensureuser/">Server-side try-catch with ExceptionHandlingScope</a></li>
<li><a href="https://jeppe-spanggaard.dk/blogs/csom-taxonomy-performance-optimization/">Fast taxonomy loading</a></li>
</ul>
]]></content:encoded></item><item><title>CSOM Performance: Fast Taxonomy Loading for SharePoint List Items with Many Terms</title><link>https://jeppe-spanggaard.dk/blogs/csom-taxonomy-performance-optimization/</link><pubDate>Sun, 21 Dec 2025 00:00:00 +0000</pubDate><author>Jeppe Spanggaard</author><guid>https://jeppe-spanggaard.dk/blogs/csom-taxonomy-performance-optimization/</guid><description>An undocumented but effective approach to dramatically speed up CSOM taxonomy field loading when dealing with SharePoint list items that have many terms.</description><content:encoded><![CDATA[<h2 id="when-fast-wasnt-fast-enough">When Fast Wasn&rsquo;t Fast Enough</h2>
<p>I was working on a SharePoint solution where we had a list with items containing multiple taxonomy fields. Each item could have anywhere from 5 to 50 taxonomy terms across different fields. The client needed to load hundreds of these items regularly.</p>
<p>The traditional CSOM approach was&hellip; well, let&rsquo;s just say coffee breaks became very popular during load times.</p>
<p><strong>The loading process was taking 90-120 seconds for a few hundred items.</strong> Users were literally walking away from their computers while waiting for data to load.</p>
<p>That&rsquo;s when I realized we needed to completely rethink how we approach taxonomy loading in CSOM.</p>
<h2 id="the-traditional-slow-way">The Traditional (Slow) Way</h2>
<p>Here&rsquo;s what most developers do, and what I was doing initially:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// The traditional approach - including taxonomy fields in ViewFields</span>
</span></span><span style="display:flex;"><span>CamlQuery query = <span style="color:#66d9ef">new</span> CamlQuery();
</span></span><span style="display:flex;"><span>query.Query = <span style="color:#e6db74">@&#34;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">    &lt;View&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">        &lt;ViewFields&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">            &lt;FieldRef Name=&#39;ID&#39;/&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">            &lt;FieldRef Name=&#39;Title&#39;/&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">            &lt;FieldRef Name=&#39;CategoryField&#39;/&gt;     &lt;!-- Taxonomy field --&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">            &lt;FieldRef Name=&#39;TagField&#39;/&gt;          &lt;!-- Taxonomy field --&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">            &lt;FieldRef Name=&#39;OtherTaxField&#39;/&gt;     &lt;!-- Taxonomy field --&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">        &lt;/ViewFields&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">    &lt;/View&gt;&#34;</span>;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>ListItemCollection items = list.GetItems(query);
</span></span><span style="display:flex;"><span>clientContext.Load(items);
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">await</span> clientContext.ExecuteQueryAsync();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Then access taxonomy fields normally</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">foreach</span> (ListItem item <span style="color:#66d9ef">in</span> items)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> categoryField = item[<span style="color:#e6db74">&#34;CategoryField&#34;</span>] <span style="color:#66d9ef">as</span> TaxonomyFieldValueCollection;
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> tagField = item[<span style="color:#e6db74">&#34;TagField&#34;</span>] <span style="color:#66d9ef">as</span> TaxonomyFieldValueCollection;
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Process taxonomy values...</span>
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p><strong>Problems with this approach:</strong></p>
<ul>
<li><strong>Including taxonomy fields in ViewFields is extremely slow</strong></li>
<li>SharePoint has to load and process all taxonomy data upfront</li>
<li>Multiple expensive taxonomy service calls during the initial load</li>
<li>No control over how taxonomy data is loaded</li>
</ul>
<p>Result: Coffee break time. Lots of it.</p>
<h2 id="the-optimization-journey">The Optimization Journey</h2>
<p>After digging into SharePoint&rsquo;s internals and some experimentation, I discovered two key things:</p>
<ol>
<li>
<p><strong>Including taxonomy fields in ViewFields is what kills performance.</strong> SharePoint has to load and process all taxonomy data during the initial query, which is extremely slow.</p>
</li>
<li>
<p><strong>SharePoint stores taxonomy data in a raw format</strong> that can be accessed via <code>FieldValuesForEdit</code> and parsed directly. This bypasses the expensive taxonomy service calls entirely.</p>
</li>
</ol>
<p><strong>The breakthrough:</strong> Separate regular field loading from taxonomy field loading. Load items with only the fields you need immediately, then load taxonomy fields separately using the faster <code>FieldValuesForEdit</code> approach.</p>
<h3 id="key-insights">Key Insights:</h3>
<ol>
<li><strong>Exclude taxonomy fields from ViewFields</strong> - This is the biggest performance gain. Load regular fields first, taxonomy fields separately.</li>
<li><strong><code>FieldValuesForEdit</code> contains raw taxonomy data</strong> in the format: <code>Label|GUID;Label|GUID</code> - much faster to parse than TaxonomyFieldValue API</li>
<li><strong>Batch loading is crucial</strong> - load all items&rsquo; FieldValuesForEdit in one call per chunk</li>
<li><strong>Chunking prevents timeouts</strong> - process items in manageable batches</li>
<li><strong>Dictionary lookups are fast</strong> - map terms back to items efficiently</li>
</ol>
<h2 id="the-optimized-solution">The Optimized Solution</h2>
<p>Here&rsquo;s the approach that cut our load times by 70-75%:</p>
<h3 id="main-loading-logic">Main Loading Logic</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">public</span> <span style="color:#66d9ef">async</span> Task&lt;List&lt;MyItemDTO?&gt;?&gt; GetItemsByOptions(<span style="color:#66d9ef">string</span>[] options)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Step 1: Load list items WITHOUT taxonomy fields in ViewFields</span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// This is much faster than including taxonomy fields in the initial query</span>
</span></span><span style="display:flex;"><span>    List list = clientContext.Web.Lists.GetByTitle(<span style="color:#e6db74">&#34;YourListName&#34;</span>);
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    CamlQuery query = <span style="color:#66d9ef">new</span> CamlQuery();
</span></span><span style="display:flex;"><span>    query.Query = <span style="color:#e6db74">@&#34;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">        &lt;View&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">            &lt;ViewFields&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">                &lt;FieldRef Name=&#39;ID&#39;/&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">                &lt;FieldRef Name=&#39;Title&#39;/&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">                &lt;FieldRef Name=&#39;OtherRegularFields&#39;/&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">                &lt;!-- Notice: NO taxonomy fields here --&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">            &lt;/ViewFields&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">            &lt;Query&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">                &lt;!-- Your where clause here --&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">            &lt;/Query&gt;
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74">        &lt;/View&gt;&#34;</span>;
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    ListItemCollection items = list.GetItems(query);
</span></span><span style="display:flex;"><span>    clientContext.Load(items);
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">await</span> clientContext.ExecuteQueryAsync();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (items == <span style="color:#66d9ef">null</span> || items.Count == <span style="color:#ae81ff">0</span>)
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">null</span>;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Step 2: Process in chunks and load taxonomy fields separately</span>
</span></span><span style="display:flex;"><span>    List&lt;MyItemDTO&gt; result = <span style="color:#66d9ef">new</span> List&lt;MyItemDTO&gt;();
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">foreach</span> (ListItem[] chunk <span style="color:#66d9ef">in</span> items.Cast&lt;ListItem&gt;().Chunk(<span style="color:#ae81ff">100</span>))
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#75715e">// Load taxonomy fields separately using FieldValuesForEdit</span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> categoryTerms = <span style="color:#66d9ef">await</span> LoadTaxonomyField(chunk, <span style="color:#e6db74">&#34;CategoryField&#34;</span>);
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> tagTerms = <span style="color:#66d9ef">await</span> LoadTaxonomyField(chunk, <span style="color:#e6db74">&#34;TagField&#34;</span>);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#75715e">// Step 3: Map everything together</span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> item <span style="color:#66d9ef">in</span> chunk)
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> dto = <span style="color:#66d9ef">new</span> MyItemDTO
</span></span><span style="display:flex;"><span>            {
</span></span><span style="display:flex;"><span>                Id = item.Id,
</span></span><span style="display:flex;"><span>                Title = item[<span style="color:#e6db74">&#34;Title&#34;</span>]?.ToString(),
</span></span><span style="display:flex;"><span>                <span style="color:#75715e">// Map regular fields normally</span>
</span></span><span style="display:flex;"><span>            };
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// Add taxonomy terms from our separate loading</span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">if</span> (categoryTerms.TryGetValue(item.Id.ToString(), <span style="color:#66d9ef">out</span> <span style="color:#66d9ef">var</span> terms))
</span></span><span style="display:flex;"><span>                dto.CategoryTerms = terms;
</span></span><span style="display:flex;"><span>                
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">if</span> (tagTerms.TryGetValue(item.Id.ToString(), <span style="color:#66d9ef">out</span> <span style="color:#66d9ef">var</span> tags))
</span></span><span style="display:flex;"><span>                dto.TagTerms = tags;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            result.Add(dto);
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> result;
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h3 id="batch-taxonomy-loading">Batch Taxonomy Loading</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">private</span> <span style="color:#66d9ef">async</span> Task&lt;Dictionary&lt;<span style="color:#66d9ef">string</span>, List&lt;TaxonomyTerm&gt;&gt;&gt; LoadTaxonomyField(
</span></span><span style="display:flex;"><span>    IEnumerable&lt;ListItem&gt; items, 
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">string</span> taxonomyFieldInternalName)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Load FieldValuesForEdit for all items in one batch</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> item <span style="color:#66d9ef">in</span> items)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        clientContext.Load(item, i =&gt; i.FieldValuesForEdit);
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">await</span> clientContext.ExecuteQueryRetryAsync();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Get the field ID for internal format matching</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> list = clientContext.Web.Lists.GetById(listGuid);
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> field = list.Fields.GetFieldByInternalName(taxonomyFieldInternalName);
</span></span><span style="display:flex;"><span>    clientContext.Load(field);
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">await</span> clientContext.ExecuteQueryRetryAsync();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">string</span> fieldId = field.Id.ToString();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Parse taxonomy data from each item&#39;s FieldValuesForEdit</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> items.ToDictionary(
</span></span><span style="display:flex;"><span>        item =&gt; item.Id.ToString(),
</span></span><span style="display:flex;"><span>        item =&gt; ParseTaxonomyFromEditValues(item, fieldId)
</span></span><span style="display:flex;"><span>    );
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">private</span> List&lt;TaxonomyTerm&gt; ParseTaxonomyFromEditValues(ListItem item, <span style="color:#66d9ef">string</span> fieldId)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Find the correct field key (SharePoint uses shortened GUIDs)</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> fieldValues = item.FieldValuesForEdit.FieldValues
</span></span><span style="display:flex;"><span>        .Where(x =&gt; x.Key.EndsWith(fieldId.Replace(<span style="color:#e6db74">&#34;-&#34;</span>, <span style="color:#e6db74">&#34;&#34;</span>).Substring(<span style="color:#ae81ff">4</span>)));
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (!fieldValues.Any())
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> List&lt;TaxonomyTerm&gt;();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">string</span> actualFieldKey = fieldValues.First().Key;
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (!item.FieldValuesForEdit.FieldValues.ContainsKey(actualFieldKey))
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> List&lt;TaxonomyTerm&gt;();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Parse the raw taxonomy string</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">string</span> rawTaxonomyData = item.FieldValuesForEdit[actualFieldKey];
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> ParseTaxonomyEditString(rawTaxonomyData);
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h3 id="raw-format-parser">Raw Format Parser</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">private</span> List&lt;TaxonomyTerm&gt; ParseTaxonomyEditString(<span style="color:#66d9ef">string</span> editString)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (<span style="color:#66d9ef">string</span>.IsNullOrWhiteSpace(editString))
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> List&lt;TaxonomyTerm&gt;();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Format: &#34;Label1|GUID1;Label2|GUID2;Label3|GUID3&#34;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> editString
</span></span><span style="display:flex;"><span>        .Split(<span style="color:#66d9ef">new</span>[] { <span style="color:#e6db74">&#39;;&#39;</span> }, StringSplitOptions.RemoveEmptyEntries)
</span></span><span style="display:flex;"><span>        .Select(entry =&gt; 
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> parts = entry.Split(<span style="color:#e6db74">&#39;|&#39;</span>);
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">if</span> (parts.Length == <span style="color:#ae81ff">2</span> &amp;&amp; Guid.TryParse(parts[<span style="color:#ae81ff">1</span>], <span style="color:#66d9ef">out</span> Guid guid))
</span></span><span style="display:flex;"><span>            {
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> TaxonomyTerm 
</span></span><span style="display:flex;"><span>                { 
</span></span><span style="display:flex;"><span>                    Label = parts[<span style="color:#ae81ff">0</span>].Trim(), 
</span></span><span style="display:flex;"><span>                    TermGuid = guid 
</span></span><span style="display:flex;"><span>                };
</span></span><span style="display:flex;"><span>            }
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">null</span>;
</span></span><span style="display:flex;"><span>        })
</span></span><span style="display:flex;"><span>        .Where(t =&gt; t != <span style="color:#66d9ef">null</span>)
</span></span><span style="display:flex;"><span>        .Select(t =&gt; t!)
</span></span><span style="display:flex;"><span>        .ToList();
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">public</span> <span style="color:#66d9ef">class</span> <span style="color:#a6e22e">TaxonomyTerm</span>
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">string</span> Label { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> Guid TermGuid { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h2 id="performance-impact">Performance Impact</h2>
<p>The results were dramatic:</p>
<p><strong>Before optimization:</strong></p>
<ul>
<li>90-120 seconds for a few hundred items with multiple taxonomy fields</li>
<li>Multiple <code>ExecuteQueryRetryAsync()</code> calls per item</li>
<li>Heavy taxonomy service usage</li>
</ul>
<p><strong>After optimization:</strong></p>
<ul>
<li>25-35 seconds for the same dataset</li>
<li><strong>~70-75% performance improvement</strong></li>
<li>Minimal API calls (2 per chunk: one for items, one for field metadata)</li>
</ul>
<p>The exact savings depend on the number of items and terms, but the pattern held consistently across different datasets.</p>
<h2 id="should-you-try-this-approach">Should You Try This Approach?</h2>
<p><strong>If you&rsquo;re experiencing slow loading times with taxonomy fields, this might be worth testing.</strong></p>
<p>I can&rsquo;t give you specific numbers for when this optimization makes sense - every environment and scenario is different. What I can tell you is that in my case, it made a dramatic difference.</p>
<p><strong>My recommendation:</strong></p>
<ul>
<li>If your current taxonomy loading is painfully slow, try this approach in a test environment</li>
<li>Measure the before and after performance in your specific scenario</li>
<li>Keep the complexity vs. benefit trade-off in mind</li>
<li>Always have a fallback to the traditional approach</li>
</ul>
<p><strong>Remember the limitations:</strong></p>
<ul>
<li>This is an undocumented approach that works with SharePoint&rsquo;s internal formats</li>
<li>You only get basic term information (label + GUID)</li>
<li>You&rsquo;ll need to test thoroughly in your environment</li>
</ul>
<p>The traditional CSOM approach works fine for many scenarios. But if you&rsquo;re hitting performance walls with taxonomy fields, this optimization might be exactly what you need.</p>
<h2 id="important-disclaimers">Important Disclaimers</h2>
<p>⚠️ <strong>This is an undocumented approach</strong> that relies on SharePoint&rsquo;s internal storage format for taxonomy fields. While it has worked reliably in my experience, it&rsquo;s not officially supported by Microsoft.</p>
<h2 id="key-takeaways">Key Takeaways</h2>
<ol>
<li><strong>Batch operations are crucial</strong> - Load multiple items&rsquo; data in single API calls</li>
<li><strong>Chunking prevents timeouts</strong> - Process large datasets in manageable pieces</li>
<li><strong>Raw formats can be faster</strong> - Sometimes bypassing official APIs improves performance</li>
<li><strong>Know when to optimize</strong> - Don&rsquo;t add complexity unless you really need the performance</li>
<li><strong>Document your risks</strong> - Be transparent about using undocumented approaches</li>
</ol>
<p>The traditional CSOM taxonomy approach works fine for simple scenarios. But when you&rsquo;re dealing with lots of items and lots of terms, sometimes you need to think outside the box.</p>
<p>Fast taxonomy loading is one of five techniques in <a href="https://jeppe-spanggaard.dk/blogs/sharepoint-csom-performance-playbook/">The SharePoint CSOM Performance Playbook</a>, which is where I&rsquo;d start if taxonomy isn&rsquo;t the only thing slowing you down.</p>
<p>I demoed this approach on the <a href="https://pnp.github.io/blog/weekly-agenda/26-01-26/">Microsoft 365 &amp; Power Platform community demos call</a> in January 2026, under the same title as this post. Those calls are worth an hour of your month if you build on this stack.</p>
]]></content:encoded></item><item><title>SharePoint CSOM: Prevent Unnecessary Updates and API Calls</title><link>https://jeppe-spanggaard.dk/blogs/sharepoint-csom-prevent-unnecessary-updates/</link><pubDate>Wed, 05 Nov 2025 10:00:00 +0100</pubDate><author>Jeppe Spanggaard</author><guid>https://jeppe-spanggaard.dk/blogs/sharepoint-csom-prevent-unnecessary-updates/</guid><description>The SharePoint API call that wasted resources is now optimized with smart change detection, reducing unnecessary updates and costs.</description><content:encoded><![CDATA[<h2 id="the-moment-everything-clicked">The Moment Everything Clicked</h2>
<p>So there I was, building what I thought was a pretty straightforward API endpoint. Users fill out a form, click save, and boom—SharePoint list item gets updated. Simple, right?</p>
<p>Wrong.</p>
<p>It was during one of those routine maintenance windows when I decided to review some API logs that I noticed something odd. The numbers just didn&rsquo;t add up. We were making way more SharePoint API calls than seemed necessary for the amount of actual data changes happening in the system.</p>
<p><strong>Every operation was hitting SharePoint. Even when nothing had actually changed.</strong></p>
<p>That&rsquo;s when it hit me. Our application was treating every potential update as an actual update, regardless of whether the data was different from what SharePoint already had. Users could open a form, change nothing, click save, and we&rsquo;d still fire off an API call to &ldquo;update&rdquo; the item with identical values.</p>
<p>But SharePoint doesn&rsquo;t care if you&rsquo;re setting a field to the exact same value it already has. It still counts that as an API call. It still hits your throttling limits. And if you&rsquo;re paying for &ldquo;Service Prioritization in SharePoint&rdquo;? It still costs you money.</p>
<h2 id="the-why-did-i-even-build-this-moment">The &ldquo;Why Did I Even Build This?&rdquo; Moment</h2>
<p>I spent some time digging deeper into the patterns, and the numbers were&hellip; enlightening.</p>
<p>This wasn&rsquo;t just a user behavior issue. It was happening everywhere:</p>
<ul>
<li>Users frequently save forms without making actual changes</li>
<li>Automated processes periodically &ldquo;sync&rdquo; data that&rsquo;s already current</li>
<li>Applications send complete object states rather than just changed fields</li>
<li>Integration systems perform routine updates as part of larger workflows</li>
</ul>
<p>When I looked at a typical day&rsquo;s worth of operations, I found that <strong>roughly 70% of our SharePoint update calls weren&rsquo;t actually changing anything</strong>. We were essentially paying SharePoint to accept identical data and politely say &ldquo;thanks for the update!&rdquo;</p>
<p>The more I thought about it, the more I realized this pattern was probably happening in systems everywhere. How many developers have built the same &ldquo;just update everything&rdquo; approach without stopping to ask whether anything actually changed?</p>
<h2 id="sharepoints-sure-ill-take-your-money-attitude">SharePoint&rsquo;s &ldquo;Sure, I&rsquo;ll Take Your Money&rdquo; Attitude</h2>
<p>Here&rsquo;s the thing about SharePoint&rsquo;s CSOM that nobody really talks about: it doesn&rsquo;t care if you&rsquo;re being wasteful. You want to set a field to the exact same value it already has? &ldquo;No problem!&rdquo; says SharePoint. &ldquo;That&rsquo;ll be one API call, please.&rdquo;</p>
<p>And if you&rsquo;re using Service Prioritization in SharePoint? That&rsquo;s real money walking out the door.</p>
<p>Let me show you what I mean with some concrete numbers from a client I worked with recently:</p>
<h3 id="the-head-scratching-cases">The Head-Scratching Cases</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// These should be considered equal, but .NET says &#34;nope&#34;</span>
</span></span><span style="display:flex;"><span>currentValue: <span style="color:#e6db74">&#34;John Doe&#34;</span>
</span></span><span style="display:flex;"><span>newValue: <span style="color:#e6db74">&#34;John Doe&#34;</span>  <span style="color:#75715e">// Easy case, no problem here</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>currentValue: <span style="color:#66d9ef">null</span>
</span></span><span style="display:flex;"><span>newValue: <span style="color:#e6db74">&#34;&#34;</span>  <span style="color:#75715e">// Is empty string the same as null? Your call!</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>currentValue: <span style="color:#ae81ff">42</span>
</span></span><span style="display:flex;"><span>newValue: <span style="color:#e6db74">&#34;42&#34;</span>  <span style="color:#75715e">// Different types, same value. Fun times.</span>
</span></span></code></pre></div><h3 id="the-sharepoint-special-cases">The SharePoint Special Cases</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// User fields (oh boy...)</span>
</span></span><span style="display:flex;"><span>currentValue: FieldUserValue { LookupId = <span style="color:#ae81ff">15</span>, LookupValue = <span style="color:#e6db74">&#34;John Doe&#34;</span> }
</span></span><span style="display:flex;"><span>newValue: FieldUserValue { LookupId = <span style="color:#ae81ff">15</span>, LookupValue = <span style="color:#e6db74">&#34;John Doe&#34;</span> }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Multi-choice fields that hate you</span>
</span></span><span style="display:flex;"><span>currentValue: [<span style="color:#e6db74">&#34;Option A&#34;</span>, <span style="color:#e6db74">&#34;Option C&#34;</span>, <span style="color:#e6db74">&#34;Option B&#34;</span>]
</span></span><span style="display:flex;"><span>newValue: [<span style="color:#e6db74">&#34;Option B&#34;</span>, <span style="color:#e6db74">&#34;Option A&#34;</span>, <span style="color:#e6db74">&#34;Option C&#34;</span>]  <span style="color:#75715e">// Same options, different order</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Taxonomy fields (because why not make it complicated?)</span>
</span></span><span style="display:flex;"><span>currentValue: TaxonomyFieldValue { TermGuid = <span style="color:#e6db74">&#34;abc-123&#34;</span>, Label = <span style="color:#e6db74">&#34;Technology&#34;</span> }
</span></span><span style="display:flex;"><span>newValue: TaxonomyFieldValue { TermGuid = <span style="color:#e6db74">&#34;abc-123&#34;</span>, Label = <span style="color:#e6db74">&#34;Technology&#34;</span> }
</span></span></code></pre></div><p>After an hour of testing different scenarios, I realized I needed something more sophisticated than <code>oldValue == newValue</code>.</p>
<h2 id="building-the-actually-smart-comparison-engine">Building the &ldquo;Actually Smart&rdquo; Comparison Engine</h2>
<p>Alright, time to get serious. I needed a comparison function that could handle all of SharePoint&rsquo;s quirky field types and still be fast enough to not slow down my API.</p>
<p>Here&rsquo;s what I ended up building (and yes, it&rsquo;s a bit of a beast):</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">internal</span> <span style="color:#66d9ef">static</span> List&lt;(<span style="color:#66d9ef">string</span> InternalName, <span style="color:#66d9ef">object?</span> NewValue)&gt; GetDifferences(
</span></span><span style="display:flex;"><span>    ListItem item,
</span></span><span style="display:flex;"><span>    IDictionary&lt;<span style="color:#66d9ef">string</span>, <span style="color:#66d9ef">object?</span>&gt; newValues,
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">bool</span> treatEmptyStringAsNull)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> diffs = <span style="color:#66d9ef">new</span> List&lt;(<span style="color:#66d9ef">string</span>, <span style="color:#66d9ef">object?</span>)&gt;();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> kvp <span style="color:#66d9ef">in</span> newValues)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> name = kvp.Key;
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> newVal = kvp.Value;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">object?</span> currentVal = <span style="color:#66d9ef">null</span>;
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">if</span> (item.FieldValues != <span style="color:#66d9ef">null</span> &amp;&amp; item.FieldValues.TryGetValue(name, <span style="color:#66d9ef">out</span> <span style="color:#66d9ef">var</span> cv))
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            currentVal = cv;
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">if</span> (!ValuesEqual(currentVal, newVal, treatEmptyStringAsNull))
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            diffs.Add((name, newVal));
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> diffs;
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">private</span> <span style="color:#66d9ef">static</span> <span style="color:#66d9ef">bool</span> ValuesEqual(<span style="color:#66d9ef">object?</span> a, <span style="color:#66d9ef">object?</span> b, <span style="color:#66d9ef">bool</span> treatEmptyStringAsNull)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (ReferenceEquals(a, b))
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">true</span>;
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (a <span style="color:#66d9ef">is</span> <span style="color:#66d9ef">null</span> || b <span style="color:#66d9ef">is</span> <span style="color:#66d9ef">null</span>)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">if</span> (treatEmptyStringAsNull)
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">if</span> ((a <span style="color:#66d9ef">is</span> <span style="color:#66d9ef">null</span> &amp;&amp; IsEmptyStringLike(b)) || (b <span style="color:#66d9ef">is</span> <span style="color:#66d9ef">null</span> &amp;&amp; IsEmptyStringLike(a)))
</span></span><span style="display:flex;"><span>            {
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">true</span>;
</span></span><span style="display:flex;"><span>            }
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">false</span>;
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    a = Normalize(a, treatEmptyStringAsNull);
</span></span><span style="display:flex;"><span>    b = Normalize(b, treatEmptyStringAsNull);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (a <span style="color:#66d9ef">is</span> IStructuralEquatable seA &amp;&amp; b <span style="color:#66d9ef">is</span> IStructuralEquatable seB)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> StructuralComparisons.StructuralEqualityComparer.Equals(seA, seB);
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> Equals(a, b);
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">private</span> <span style="color:#66d9ef">static</span> <span style="color:#66d9ef">bool</span> IsEmptyStringLike(<span style="color:#66d9ef">object?</span> x)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> x <span style="color:#66d9ef">is</span> <span style="color:#66d9ef">string</span> s &amp;&amp; <span style="color:#66d9ef">string</span>.IsNullOrWhiteSpace(s);
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">private</span> <span style="color:#66d9ef">static</span> <span style="color:#66d9ef">object?</span> Normalize(<span style="color:#66d9ef">object?</span> v, <span style="color:#66d9ef">bool</span> treatEmptyStringAsNull)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (v == <span style="color:#66d9ef">null</span>)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">null</span>;
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">switch</span> (v)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> <span style="color:#66d9ef">string</span> s:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> (treatEmptyStringAsNull &amp;&amp; <span style="color:#66d9ef">string</span>.IsNullOrWhiteSpace(s)) ? <span style="color:#66d9ef">null</span> : s;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> <span style="color:#66d9ef">bool</span> b:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> b;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> <span style="color:#66d9ef">byte</span> or <span style="color:#66d9ef">sbyte</span> or <span style="color:#66d9ef">short</span> or <span style="color:#66d9ef">ushort</span> or <span style="color:#66d9ef">int</span> or <span style="color:#66d9ef">uint</span> or <span style="color:#66d9ef">long</span> or <span style="color:#66d9ef">ulong</span> or <span style="color:#66d9ef">float</span> or <span style="color:#66d9ef">double</span> or <span style="color:#66d9ef">decimal</span>:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> Convert.ToDecimal(v, CultureInfo.InvariantCulture);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> DateTime dt:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> utc = (dt.Kind == DateTimeKind.Utc ? dt : DateTime.SpecifyKind(dt, DateTimeKind.Unspecified)).ToUniversalTime();
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> DateTime(utc.Year, utc.Month, utc.Day, utc.Hour, utc.Minute, utc.Second, DateTimeKind.Utc);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> FieldUserValue u:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> u.LookupId;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> FieldLookupValue l:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> l.LookupId;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> IEnumerable&lt;FieldLookupValue&gt; multiLookup:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> multiLookup.Select(x =&gt; x?.LookupId ?? <span style="color:#ae81ff">0</span>).OrderBy(x =&gt; x).ToArray();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> TaxonomyFieldValue tx:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> tx.TermGuid?.Trim().ToLowerInvariant();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> TaxonomyFieldValueCollection txc:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> txc
</span></span><span style="display:flex;"><span>                .Where(x =&gt; x != <span style="color:#66d9ef">null</span> &amp;&amp; !<span style="color:#66d9ef">string</span>.IsNullOrEmpty(x.TermGuid))
</span></span><span style="display:flex;"><span>                .Select(x =&gt; x.TermGuid.Trim().ToLowerInvariant())
</span></span><span style="display:flex;"><span>                .OrderBy(g =&gt; g)
</span></span><span style="display:flex;"><span>                .ToArray();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> FieldGeolocationValue geo:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> ValueTuple&lt;<span style="color:#66d9ef">double</span>, <span style="color:#66d9ef">double</span>, <span style="color:#66d9ef">double</span>, <span style="color:#66d9ef">double</span>&gt;(
</span></span><span style="display:flex;"><span>                Math.Round(geo.Latitude, <span style="color:#ae81ff">6</span>),
</span></span><span style="display:flex;"><span>                Math.Round(geo.Longitude, <span style="color:#ae81ff">6</span>),
</span></span><span style="display:flex;"><span>                Math.Round(geo.Altitude, <span style="color:#ae81ff">2</span>),
</span></span><span style="display:flex;"><span>                Math.Round(geo.Measure, <span style="color:#ae81ff">2</span>));
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> <span style="color:#66d9ef">string</span>[] ss:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> ss
</span></span><span style="display:flex;"><span>                .Select(x =&gt; treatEmptyStringAsNull &amp;&amp; <span style="color:#66d9ef">string</span>.IsNullOrWhiteSpace(x) ? <span style="color:#66d9ef">null</span> : x)
</span></span><span style="display:flex;"><span>                .OrderBy(x =&gt; x, StringComparer.Ordinal)
</span></span><span style="display:flex;"><span>                .ToArray();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">case</span> IEnumerable enumerable when v <span style="color:#66d9ef">is</span> not <span style="color:#66d9ef">string</span>:
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> list = <span style="color:#66d9ef">new</span> List&lt;<span style="color:#66d9ef">object?</span>&gt;();
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> e <span style="color:#66d9ef">in</span> enumerable)
</span></span><span style="display:flex;"><span>            {
</span></span><span style="display:flex;"><span>                list.Add(Normalize(e, treatEmptyStringAsNull));
</span></span><span style="display:flex;"><span>            }
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> list.ToArray();
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">default</span>:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> v;
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h2 id="the-magic-behind-the-scenes">The Magic Behind the Scenes</h2>
<h3 id="1-the-normalization-dance">1. <strong>The Normalization Dance</strong></h3>
<p>The <code>Normalize</code> method is where the real magic happens. It takes SharePoint&rsquo;s various field types and converts them into something we can actually compare:</p>
<ul>
<li><strong>Numbers</strong>: Everything becomes a <code>decimal</code> because SharePoint loves to mix integers and strings</li>
<li><strong>DateTime</strong>: Converted to UTC and truncated to seconds (because who needs millisecond precision for list items?)</li>
<li><strong>User/Lookup Fields</strong>: We only care about the <code>LookupId</code>, not the display text that might change</li>
<li><strong>Collections</strong>: Sorted alphabetically because SharePoint doesn&rsquo;t guarantee order</li>
<li><strong>Strings</strong>: Can optionally treat empty/whitespace as null (trust me, you want this)</li>
</ul>
<h3 id="2-the">2. <strong>The &ldquo;It&rsquo;s Not You, It&rsquo;s SharePoint&rdquo; Handling</strong></h3>
<p>For arrays and complex objects, I use <code>IStructuralEquatable</code> to do deep comparisons. Because yes, SharePoint will absolutely give you arrays that contain the same items but in different orders.</p>
<h3 id="3-the-business-logic-escape-hatch">3. <strong>The Business Logic Escape Hatch</strong></h3>
<p>The <code>treatEmptyStringAsNull</code> parameter saved my sanity. Different parts of your application might handle empty values differently, and this lets you define your own rules for what counts as &ldquo;unchanged.&rdquo;</p>
<h2 id="but-wait-why-not-just-use-json-comparison">But Wait, Why Not Just Use JSON Comparison?</h2>
<p>Before you ask (because I know you&rsquo;re thinking it): &ldquo;Why build this elaborate comparison engine when you could just serialize both objects to JSON and compare the strings?&rdquo;</p>
<p>Great question. I actually thought the same thing initially. How hard could it be, right? Just <code>JsonSerializer.Serialize()</code> both the old and new values, compare the resulting strings, and call it a day.</p>
<p>Here&rsquo;s what the &ldquo;simple&rdquo; JSON approach looks like:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">internal</span> <span style="color:#66d9ef">static</span> List&lt;(<span style="color:#66d9ef">string</span> InternalName, <span style="color:#66d9ef">object?</span> NewValue)&gt; GetDifferencesJson(
</span></span><span style="display:flex;"><span>    IDictionary&lt;<span style="color:#66d9ef">string</span>, <span style="color:#66d9ef">object?</span>&gt; oldValues,
</span></span><span style="display:flex;"><span>    IDictionary&lt;<span style="color:#66d9ef">string</span>, <span style="color:#66d9ef">object?</span>&gt; newValues,
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">bool</span> treatEmptyStringAsNull)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> diffs = <span style="color:#66d9ef">new</span> List&lt;(<span style="color:#66d9ef">string</span>, <span style="color:#66d9ef">object?</span>)&gt;();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> kvp <span style="color:#66d9ef">in</span> newValues)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> name = kvp.Key;
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> newVal = kvp.Value;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">object?</span> currentVal = <span style="color:#66d9ef">null</span>;
</span></span><span style="display:flex;"><span>        oldValues?.TryGetValue(name, <span style="color:#66d9ef">out</span> currentVal);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> newJson = JsonSerializer.Serialize(newVal);
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> oldJson = JsonSerializer.Serialize(currentVal);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">if</span> (newJson != oldJson)
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            diffs.Add((name, newVal));
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> diffs;
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>Looks clean and simple, right? That&rsquo;s what I thought too. So I built both approaches and put them head-to-head with BenchmarkDotNet. The results were&hellip; eye-opening.</p>
<h3 id="the-performance-reality-check">The Performance Reality Check</h3>
<p>Here&rsquo;s what I found when comparing the performance of my custom approach versus JSON string comparison:</p>
<p><strong>Single List Item Comparison:</strong></p>
<ul>
<li><strong>Custom Dictionary Approach</strong>: 749,625 operations/second (1.334 μs per operation)</li>
<li><strong>JSON String Approach</strong>: 201,109 operations/second (4.972 μs per operation)</li>
<li><strong>Performance difference</strong>: 3.7x faster with the custom approach</li>
</ul>
<p><strong>Batch Operations (300 items):</strong></p>
<ul>
<li><strong>Custom Dictionary Approach</strong>: 3,705 operations/second (269.91 μs per batch)</li>
<li><strong>JSON String Approach</strong>: 712 operations/second (1,404.06 μs per batch)</li>
<li><strong>Performance difference</strong>: 5.2x faster with the custom approach</li>
</ul>
<h3 id="why-json-comparison-falls-short">Why JSON Comparison Falls Short</h3>
<p>The numbers tell the story, but here&rsquo;s what&rsquo;s actually happening under the hood:</p>
<ol>
<li><strong>Serialization Overhead</strong>: Converting SharePoint field values to JSON strings requires multiple allocations and string operations</li>
<li><strong>Memory Pressure</strong>: JSON approach allocated nearly 50% more memory (4.67KB vs 3.17KB per operation)</li>
<li><strong>Type Conversion Issues</strong>: JSON serialization doesn&rsquo;t handle SharePoint&rsquo;s quirky field types the way we need</li>
<li><strong>Garbage Collection</strong>: More allocations = more GC pressure = slower overall performance</li>
</ol>
<p>When you&rsquo;re processing hundreds or thousands of list items in batch operations, that 3-5x performance difference really adds up. Plus, the custom approach gives us complete control over how different field types are compared, which JSON comparison simply can&rsquo;t provide.</p>
<h2 id="putting-it-all-together-the-real-world-implementation">Putting It All Together: The Real-World Implementation</h2>
<p>Here&rsquo;s how I actually use this in my APIs:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">public</span> <span style="color:#66d9ef">async</span> Task&lt;<span style="color:#66d9ef">bool</span>&gt; UpdateListItemAsync(<span style="color:#66d9ef">int</span> itemId, Dictionary&lt;<span style="color:#66d9ef">string</span>, <span style="color:#66d9ef">object?</span>&gt; newValues)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> clientContext = GetClientContext();
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> list = clientContext.Web.Lists.GetByTitle(<span style="color:#e6db74">&#34;YourList&#34;</span>);
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> listItem = list.GetItemById(itemId);
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    clientContext.Load(listItem);
</span></span><span style="display:flex;"><span>    clientContext.ExecuteQuery();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// The moment of truth - what actually changed?</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> differences = GetDifferences(listItem, newValues, treatEmptyStringAsNull: <span style="color:#66d9ef">true</span>);
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (!differences.Any())
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#75715e">// Nothing changed! Skip the update entirely</span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">false</span>; <span style="color:#75715e">// &#34;Thanks for playing, but you didn&#39;t actually change anything&#34;</span>
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Only update the fields that actually changed</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> (fieldName, newValue) <span style="color:#66d9ef">in</span> differences)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        listItem[fieldName] = newValue;
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    listItem.Update();
</span></span><span style="display:flex;"><span>    clientContext.ExecuteQuery();
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">true</span>; <span style="color:#75715e">// &#34;Something actually happened!&#34;</span>
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h2 id="the-numbers-dont-lie-and-theyre-pretty-great">The Numbers Don&rsquo;t Lie (And They&rsquo;re Pretty Great)</h2>
<p>After implementing this change detection across our applications, here&rsquo;s what we typically see:</p>
<p><strong>Before implementing change detection:</strong></p>
<ul>
<li>Applications making thousands of update requests per day</li>
<li>Every single one triggered a SharePoint <code>ExecuteQuery()</code></li>
<li>High API call volumes and occasional throttling issues</li>
</ul>
<p><strong>After implementing change detection:</strong></p>
<ul>
<li>Same number of update requests from users/systems</li>
<li>60-80% contained no actual changes and were skipped</li>
<li>Dramatically reduced SharePoint API consumption</li>
<li>Much lower throttling risk</li>
</ul>
<p><strong>The typical impact:</strong></p>
<ul>
<li><strong>Significant reduction in monthly API calls</strong></li>
<li><strong>Cost savings</strong> with Service Prioritization in SharePoint (varies by usage)</li>
<li><strong>Reduced throttling risk</strong> during busy periods</li>
<li><strong>Faster API responses</strong> because skipped operations are basically instant</li>
</ul>
<p>But here&rsquo;s what really matters: the performance improvement isn&rsquo;t just about the numbers. Users notice when applications feel more responsive, and developers notice when they stop getting throttling alerts.</p>
<h2 id="the-gotchas-because-there-are-always-gotchas">The Gotchas (Because There Are Always Gotchas)</h2>
<h3 id="when-this-approach-might-not-be-for-you">When This Approach Might Not Be For You</h3>
<ol>
<li>
<p><strong>Audit Requirements</strong>: If you need to log every single &ldquo;save&rdquo; action regardless of whether anything changed, this might not work for your use case.</p>
</li>
<li>
<p><strong>Always Update Timestamps</strong>: Some business requirements dictate that &ldquo;LastModified&rdquo; should always be updated when a user clicks save, even if the content is identical.</p>
</li>
<li>
<p><strong>Super Simple Scenarios</strong>: If you&rsquo;re only updating one field and it&rsquo;s a simple string comparison, the overhead of this elaborate comparison might not be worth it.</p>
</li>
</ol>
<h3 id="the-sharepoint-field-types-that-made-me-question-my-life-choices">The SharePoint Field Types That Made Me Question My Life Choices</h3>
<p>Some field types need special handling:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// Calculated fields - don&#39;t even try to update these</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">if</span> (field.ReadOnlyField || field.FieldTypeKind == FieldType.Calculated)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">continue</span>; <span style="color:#75715e">// SharePoint will just ignore you anyway</span>
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Attachment fields - these need completely different logic</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">if</span> (field.FieldTypeKind == FieldType.Attachments)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Handle separately - attachments are their own special nightmare</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">continue</span>;
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h2 id="wrapping-up-and-why-this-matters-more-than-you-think">Wrapping Up (And Why This Matters More Than You Think)</h2>
<p>Look, I know this might seem like over-engineering for a simple &ldquo;update SharePoint item&rdquo; operation. But here&rsquo;s the thing: those small inefficiencies add up fast.</p>
<p>In my case, this one change:</p>
<ul>
<li><strong>Improved user experience</strong> with faster response times</li>
<li><strong>Reduced throttling headaches</strong> during busy periods</li>
<li><strong>Made me feel like a responsible developer</strong> (this one&rsquo;s important too!)</li>
</ul>
<p>The pattern I&rsquo;ve shown you isn&rsquo;t just about SharePoint or just about API optimization. It&rsquo;s about asking the fundamental question: <strong>&ldquo;Is this operation actually necessary?&rdquo;</strong></p>
<p>That question has made me a better developer across all the platforms I work with, not just SharePoint.</p>
<p>So next time you&rsquo;re building any kind of update operation—whether it&rsquo;s SharePoint, a database, or that JSON file you&rsquo;re definitely not using as a database—pause for a moment and ask: &ldquo;Did anything actually change?&rdquo;</p>
<p>Your future self (and your API bills) will thank you.</p>
<p><strong>Pro tip</strong>: Start implementing this pattern on your highest-traffic endpoints first. That&rsquo;s where you&rsquo;ll see the biggest impact, and it&rsquo;ll give you the confidence to roll it out everywhere else.</p>
<p>Now go forth and eliminate those unnecessary API calls. Your SharePoint environment will purr like a happy cat.</p>
<p>Change detection is one of five techniques in <a href="https://jeppe-spanggaard.dk/blogs/sharepoint-csom-performance-playbook/">The SharePoint CSOM Performance Playbook</a>. If you want the whole picture of where CSOM calls leak, start there.</p>
]]></content:encoded></item><item><title>SharePoint's Server-Side Try-Catch: ExceptionHandlingScope</title><link>https://jeppe-spanggaard.dk/blogs/sharepoint-exceptionhandlingscope-csom-ensureuser/</link><pubDate>Mon, 20 Oct 2025 10:00:00 +0100</pubDate><author>Jeppe Spanggaard</author><guid>https://jeppe-spanggaard.dk/blogs/sharepoint-exceptionhandlingscope-csom-ensureuser/</guid><description>Discover how SharePoint's ExceptionHandlingScope can optimize your API calls, reduce costs, and enhance performance with server-side exception handling.</description><content:encoded><![CDATA[<h2 id="the-service-prioritization-in-sharepoint-cost-analysis">The Service Prioritization in SharePoint Cost Analysis</h2>
<p>Recently, I was working with a client to calculate the cost of enabling <a href="https://learn.microsoft.com/en-us/sharepoint/sharepoint-prioritization">Service Prioritization in SharePoint</a> on one of their app registrations. The pricing model is straightforward: USD $0.50 per 1,000 Graph calls and USD $1.00 per 1,000 SP REST/CSOM calls.</p>
<p>During the analysis, I discovered something that caught my attention: their solution was making approximately <strong>90,000 calls per month</strong>, and <strong>88% of all their CSOM calls were <code>EnsureUser</code> operations.</strong></p>
<p>This was particularly interesting because the users being &ldquo;ensured&rdquo; were already associated with the site where the data was being created. It seemed like there should be a more efficient approach - similar to what&rsquo;s possible with Graph API.</p>
<h2 id="the-problem-with-user-field-assignment">The Problem with User Field Assignment</h2>
<p>If you&rsquo;ve worked with SharePoint user fields, you&rsquo;re familiar with this common pattern:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// The standard approach</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> user = clientContext.Web.EnsureUser(<span style="color:#e6db74">&#34;user@company.com&#34;</span>);
</span></span><span style="display:flex;"><span>clientContext.Load(user);
</span></span><span style="display:flex;"><span>clientContext.ExecuteQuery(); <span style="color:#75715e">// Network call #1</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>listItem[<span style="color:#e6db74">&#34;AssignedTo&#34;</span>] = <span style="color:#66d9ef">new</span> FieldUserValue()
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    LookupId = user.Id
</span></span><span style="display:flex;"><span>};
</span></span><span style="display:flex;"><span>listItem.Update();
</span></span><span style="display:flex;"><span>clientContext.ExecuteQuery(); <span style="color:#75715e">// Network call #2</span>
</span></span></code></pre></div><p>This requires two network calls for each user assignment. Microsoft provides <code>FieldUserValue.FromUser(&quot;user@company.com&quot;)</code> as an alternative, but it throws an exception if the user isn&rsquo;t already &ldquo;known&rdquo; to the site. This leads to either making two calls to be safe, or handling exceptions with additional calls.</p>
<h2 id="discovering-exceptionhandlingscope">Discovering ExceptionHandlingScope</h2>
<p>While researching optimization approaches, I came across a section in Microsoft&rsquo;s documentation for &ldquo;<a href="https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-client-library-code">Complete basic operations using SharePoint client library code</a>&rdquo; about <strong>ExceptionHandlingScope</strong>.</p>
<p>ExceptionHandlingScope allows you to implement try-catch logic that executes on the SharePoint server rather than requiring multiple round trips from your client application. Instead of this painful dance:</p>
<ol>
<li>Try operation → Network call</li>
<li>Handle exception → Network call</li>
<li>Retry operation → Network call</li>
</ol>
<p>You get this beautiful symphony:</p>
<ol>
<li>Send try-catch logic to server → Network call</li>
<li>Server handles everything internally</li>
<li>Get result → You&rsquo;re done</li>
</ol>
<p>Here&rsquo;s the magic in action:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">var</span> scope = <span style="color:#66d9ef">new</span> ExceptionHandlingScope(clientContext);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">using</span> (scope.StartScope())
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">using</span> (scope.StartTry())
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#75715e">// Try the optimistic approach first</span>
</span></span><span style="display:flex;"><span>        listItem[<span style="color:#e6db74">&#34;CaseResponsible&#34;</span>] = FieldUserValue.FromUser(<span style="color:#e6db74">&#34;user@company.com&#34;</span>);
</span></span><span style="display:flex;"><span>        listItem.Update();
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">using</span> (scope.StartCatch())
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#75715e">// If that fails, ensure the user exists</span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> user = clientContext.Web.EnsureUser(<span style="color:#e6db74">&#34;user@company.com&#34;</span>);
</span></span><span style="display:flex;"><span>        listItem[<span style="color:#e6db74">&#34;CaseResponsible&#34;</span>] = FieldUserValue.FromUser(<span style="color:#e6db74">&#34;user@company.com&#34;</span>);
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Execute once - the server handles all the logic</span>
</span></span><span style="display:flex;"><span>clientContext.ExecuteQuery();
</span></span></code></pre></div><p><strong>One network call. That&rsquo;s it.</strong></p>
<p>The server receives your entire try-catch block, attempts the optimistic operation first, and only falls back to <code>EnsureUser</code> if needed. No round trips. No guessing. No waste.</p>
<h2 id="real-world-impact-significant-call-reduction">Real-World Impact: Significant Call Reduction</h2>
<p>Looking back at the client scenario with ExceptionHandlingScope:</p>
<ul>
<li><strong>Before</strong>: ~79,200 <code>EnsureUser</code> calls + ~10,800 actual operations = 90,000 total calls</li>
<li><strong>After</strong>: ~10,800-21,600 operations (depending on how many users need ensuring) = substantial reduction</li>
</ul>
<p>This represents a potential <strong>75-85% reduction</strong> in API calls, with corresponding improvements in both performance and Service Prioritization in SharePoint costs.</p>
<h3 id="the-cost-breakdown">The Cost Breakdown</h3>
<p>Let&rsquo;s translate this into actual Service Prioritization in SharePoint costs:</p>
<p><strong>Before optimization:</strong></p>
<ul>
<li>90,000 CSOM calls per month</li>
<li>At USD $1.00 per 1,000 calls</li>
<li><strong>Monthly cost: $90</strong></li>
</ul>
<p><strong>After ExceptionHandlingScope optimization:</strong></p>
<ul>
<li>Best case: 10,800 calls (if most users are already known) = <strong>$10.80/month</strong></li>
<li>Worst case: 21,600 calls (if many users need ensuring) = <strong>$21.60/month</strong></li>
<li><strong>Monthly savings: $68.40 - $79.20</strong></li>
</ul>
<p><strong>Annual savings: $820 - $950</strong></p>
<p>These savings become even more significant at scale. For organizations with multiple solutions or higher call volumes, the cost difference can easily reach thousands of dollars annually.</p>
<p>More importantly, the performance improvements—reduced network latency, faster operations, and lower throttling risk—often provide value that far exceeds the direct cost savings.</p>
<h2 id="throttling-the-hidden-performance-killer">Throttling: The Hidden Performance Killer</h2>
<p>Beyond cost savings, ExceptionHandlingScope provides significant throttling benefits that are often more impactful than the financial savings.</p>
<h3 id="understanding-sharepoint-throttling">Understanding SharePoint Throttling</h3>
<p>SharePoint applies throttling limits to prevent abuse and ensure service stability. When you exceed these limits, you&rsquo;ll encounter:</p>
<ul>
<li><strong>HTTP 429 (Too Many Requests)</strong> responses</li>
<li><strong>Exponential backoff delays</strong> (sometimes minutes)</li>
<li><strong>User experience degradation</strong> as operations slow down</li>
<li><strong>Potential service interruptions</strong> during peak usage</li>
</ul>
<h3 id="the-throttling-math">The Throttling Math</h3>
<p>In our client scenario:</p>
<p><strong>Before ExceptionHandlingScope:</strong></p>
<ul>
<li>90,000 calls per month = ~3,000 calls per day</li>
<li>During peak hours, this could easily trigger throttling</li>
<li>Each throttled request requires retry with exponential backoff</li>
<li>A single throttled operation can delay your entire batch</li>
</ul>
<p><strong>After ExceptionHandlingScope:</strong></p>
<ul>
<li>10,800-21,600 calls per month = ~360-720 calls per day</li>
<li><strong>10x reduction in throttling risk</strong></li>
<li>Smoother operation during peak business hours</li>
<li>More predictable performance for end users</li>
</ul>
<h3 id="real-world-throttling-impact">Real-World Throttling Impact</h3>
<p>Consider a typical business day where multiple users are creating items simultaneously:</p>
<ul>
<li><strong>Without optimization</strong>: 88% of your throttling budget consumed by redundant EnsureUser calls</li>
<li><strong>With ExceptionHandlingScope</strong>: 88% of your throttling budget available for actual business operations</li>
</ul>
<p>The beauty of ExceptionHandlingScope is that it doesn&rsquo;t just reduce the number of calls—it makes your remaining calls more valuable and less likely to be throttled.</p>
<h2 id="important-exceptionhandlingscope-is-not-a-magic-bullet">Important: ExceptionHandlingScope Is NOT a Magic Bullet</h2>
<p><strong>Critical Disclaimer</strong>: ExceptionHandlingScope itself does NOT reduce the number of requests to SharePoint. Each operation within the scope still counts as a separate request for throttling purposes.</p>
<p>The reduction in our scenario comes from <strong>changing the approach</strong>, not from using ExceptionHandlingScope:</p>
<h3 id="what-actually-reduces-calls">What Actually Reduces Calls</h3>
<ul>
<li><strong>Before</strong>: Always calling <code>EnsureUser</code> + setting the field = 2 calls per user</li>
<li><strong>After</strong>: Using <code>FieldUserValue.FromUser()</code> directly, falling back to <code>EnsureUser</code> only when needed</li>
</ul>
<h3 id="what-exceptionhandlingscope-actually-does">What ExceptionHandlingScope Actually Does</h3>
<p>ExceptionHandlingScope reduces <strong>network round trips</strong>, not <strong>server requests</strong>:</p>
<ul>
<li><strong>Network benefit</strong>: 1 round trip instead of potentially 2-3</li>
<li><strong>Throttling impact</strong>: Each operation still counts toward throttling limits</li>
<li><strong>Performance gain</strong>: Reduced latency, not reduced server load</li>
</ul>
<h3 id="the-real-magic">The Real Magic</h3>
<p>The 75-85% reduction in our client scenario comes from this logic change:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// This approach reduces actual requests</span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Most users are already known to the site</span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// So most operations only need 1 request instead of 2</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">using</span> (scope.StartTry())
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// This succeeds for ~80% of users (1 request)</span>
</span></span><span style="display:flex;"><span>    listItem[<span style="color:#e6db74">&#34;Field&#34;</span>] = FieldUserValue.FromUser(<span style="color:#e6db74">&#34;user@company.com&#34;</span>);
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">using</span> (scope.StartCatch())
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// This only runs for ~20% of users (1 request)</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> user = clientContext.Web.EnsureUser(<span style="color:#e6db74">&#34;user@company.com&#34;</span>);
</span></span><span style="display:flex;"><span>    listItem[<span style="color:#e6db74">&#34;Field&#34;</span>] = FieldUserValue.FromUser(<span style="color:#e6db74">&#34;user@company.com&#34;</span>);
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>ExceptionHandlingScope simply makes this pattern efficient by handling the try-catch logic server-side instead of requiring multiple network round trips to determine which approach to use.</p>
<p><strong>Bottom line</strong>: ExceptionHandlingScope optimizes network efficiency, but the request reduction comes from smarter business logic, not from the scope itself.</p>
<h2 id="the-broader-lesson">The Broader Lesson</h2>
<p>This experience highlighted an important principle: before optimizing an existing approach, it&rsquo;s worth questioning whether there&rsquo;s a fundamentally different way to solve the problem. In this case, server-side exception handling provided a cleaner solution than client-side optimization or caching strategies.</p>
<p>ExceptionHandlingScope has been available since SharePoint 2013, but it&rsquo;s not widely discussed in the SharePoint development community. It&rsquo;s a good reminder to periodically review Microsoft&rsquo;s documentation for features that might address current challenges in new ways.</p>
<h2 id="your-next-steps">Your Next Steps</h2>
<p>Before you write your next SharePoint operation that involves potential exceptions:</p>
<ol>
<li><strong>Pause and calculate</strong>: How many network calls will your approach generate?</li>
<li><strong>Question the pattern</strong>: Could server-side logic handle the complexity?</li>
<li><strong>Explore ExceptionHandlingScope</strong>: Can your try-catch logic run on the server?</li>
<li><strong>Measure the impact</strong>: Compare network calls before and after implementation</li>
</ol>
<p>Sometimes the most powerful optimizations come from using the tools that were there all along. ExceptionHandlingScope isn&rsquo;t just a performance optimization—it&rsquo;s a reminder that the platform often provides solutions we didn&rsquo;t know we were looking for.</p>
<p>Next time you&rsquo;re facing a SharePoint performance challenge, remember: the answer might not be in the latest framework or cutting-edge technique. Sometimes, it&rsquo;s hiding in plain sight in the documentation you scrolled past.</p>
<p>ExceptionHandlingScope is one of five techniques in <a href="https://jeppe-spanggaard.dk/blogs/sharepoint-csom-performance-playbook/">The SharePoint CSOM Performance Playbook</a>, alongside batching, CAML joins, change detection and fast taxonomy loading.</p>
]]></content:encoded></item><item><title>Optimize SharePoint Webhooks: Debouncing User Actions</title><link>https://jeppe-spanggaard.dk/blogs/optimize-sharepoint-webhooks-debouncing-user-actions/</link><pubDate>Tue, 14 Oct 2025 00:00:00 +0000</pubDate><guid>https://jeppe-spanggaard.dk/blogs/optimize-sharepoint-webhooks-debouncing-user-actions/</guid><description>Learn how to effectively debounce SharePoint webhooks to optimize performance and reduce unnecessary operations when users frequently click save.</description><content:encoded><![CDATA[<p>Have you ever watched a user frantically editing a SharePoint list item? Click save, make another tiny change, click save again, then realize they made a typo and&hellip; click save once more. Meanwhile, your perfectly crafted webhook is firing off like a machine gun, triggering expensive operations for every single keystroke (okay, not literally every keystroke—but you get the idea).</p>
<p>This is exactly the problem I ran into while building a system where SharePoint list changes needed to trigger updates to site titles. Users would edit customer information, and I wanted the customer&rsquo;s SharePoint site title to reflect those changes. But I definitely didn&rsquo;t want to rename a site five times in thirty seconds just because someone couldn&rsquo;t decide between &ldquo;Acme Corp&rdquo; and &ldquo;ACME Corporation.&rdquo;</p>
<p>The solution? Debouncing. Just like the <code>useDebounce</code> hook that React developers know and love, but for SharePoint webhooks.</p>
<h2 id="the-business-problem">The Business Problem</h2>
<p>Let me paint you the picture. We have a UI that updates SharePoint list items every time a user makes a change. When they modify a customer&rsquo;s name, we want to update the title of that customer&rsquo;s SharePoint site. Simple enough, right?</p>
<p>Wrong.</p>
<p>Users don&rsquo;t make one clean edit and walk away. They edit the name, realize they want to change the format, edit it again, spot a typo, fix that too, and maybe adjust the capitalization for good measure. Each of these changes triggers our SharePoint webhook, which in turn tries to update the site title.</p>
<p>Not only is this inefficient, but it&rsquo;s also potentially problematic. Site title updates aren&rsquo;t instant operations, and we definitely don&rsquo;t want them queuing up and executing out of order.</p>
<p>What we really want is to wait until the user is <em>done</em> making changes, then process all their edits as one logical operation.</p>
<h2 id="enter-the-debounce-pattern">Enter the Debounce Pattern</h2>
<p>The concept is borrowed straight from the front-end world. Instead of reacting to every single change immediately, we wait. If another change comes in within our debounce window, we cancel the previous operation and reset the timer.</p>
<p>Here&rsquo;s the entry point to my implementation:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">public</span> <span style="color:#66d9ef">class</span> <span style="color:#a6e22e">WebhookProcessor</span>() {
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">async</span> Task HandleListChangeAsync(<span style="color:#66d9ef">string</span> itemId, <span style="color:#66d9ef">string</span> listId) {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">using</span> (DebounceScheduler debouncer = <span style="color:#66d9ef">new</span> DebounceScheduler()) {
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> message = <span style="color:#66d9ef">new</span> ServiceBusMessage() {
</span></span><span style="display:flex;"><span>                ContentType = <span style="color:#e6db74">&#34;application/json&#34;</span>,
</span></span><span style="display:flex;"><span>            };
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">await</span> debouncer.DebounceAsync(itemId, listId, message, TimeSpan.FromMinutes(<span style="color:#ae81ff">5</span>));
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>Simple on the surface, but there&rsquo;s quite a bit happening under the hood.</p>
<h2 id="the-architecture-azure-service-bus--table-storage">The Architecture: Azure Service Bus + Table Storage</h2>
<p>I built this debounce system using two Azure services:</p>
<ol>
<li><strong>Azure Service Bus</strong> for scheduled message delivery</li>
<li><strong>Azure Table Storage</strong> for tracking sequence numbers</li>
</ol>
<p>Here&rsquo;s why this combination works so well:</p>
<h3 id="azure-service-bus-scheduled-messages">Azure Service Bus Scheduled Messages</h3>
<p>Service Bus has a fantastic feature called scheduled messages. You can schedule a message to be delivered at a specific time in the future, and critically, you can cancel that scheduled message if needed.</p>
<p>This is perfect for debouncing. When a webhook fires, I schedule a message to be processed in 5 minutes. If another webhook fires for the same item before those 5 minutes are up, I cancel the previously scheduled message and schedule a new one.</p>
<h3 id="table-storage-for-state-management">Table Storage for State Management</h3>
<p>The tricky part is remembering which messages you&rsquo;ve scheduled so you can cancel them later. That&rsquo;s where Table Storage comes in.</p>
<p>The core logic looks something like this:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">internal</span> <span style="color:#66d9ef">async</span> Task DebounceAsync(<span style="color:#66d9ef">string</span> entityId, <span style="color:#66d9ef">string</span> listId, ServiceBusMessage message, TimeSpan delay) {
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Get any existing scheduled message for this entity</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> oldSeq = <span style="color:#66d9ef">await</span> store.GetSequenceNumberAsync(entityId);
</span></span><span style="display:flex;"><span>   
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (oldSeq.HasValue) {
</span></span><span style="display:flex;"><span>        <span style="color:#75715e">// Cancel the previous scheduled message</span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">await</span> _sender.CancelScheduledMessageAsync(oldSeq.Value);
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">await</span> store.DeleteSequenceNumberAsync(entityId);
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Schedule a new message</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> scheduledTime = DateTimeOffset.UtcNow.Add(delay);
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">long</span> newSeq = <span style="color:#66d9ef">await</span> _sender.ScheduleMessageAsync(message, scheduledTime);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Store the new sequence number for future cancellation</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">await</span> store.SetSequenceNumberAsync(entityId, newSeq, listId);
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>For each item being debounced, I store:</p>
<ul>
<li>The sequence number of the scheduled Service Bus message</li>
<li>The list ID</li>
</ul>
<p>When a new change comes in, I can look up the previous sequence number, cancel that message, and schedule a new one.</p>
<h2 id="the-flow-in-action">The Flow in Action</h2>
<p>Let&rsquo;s walk through what happens when a user edits a customer:</p>
<ol>
<li>User changes customer name → SharePoint webhook fires</li>
<li>My webhook Azure Function receives the notification and queues it</li>
<li>The webhook queue processor calls <code>WebhookProcessor.HandleListChangeAsync()</code></li>
<li><code>DebounceScheduler</code> checks Table Storage for any existing scheduled message</li>
<li>If one exists, it gets cancelled via the Service Bus sequence number</li>
<li>A new message is scheduled for 5 minutes from now</li>
<li>The new sequence number is saved to Table Storage</li>
</ol>
<p>If the user makes another change within 5 minutes, steps 4-7 repeat, effectively resetting the countdown.</p>
<p>Once 5 minutes pass without any changes, the scheduled message is delivered to our debounce queue, and the actual processing begins.</p>
<h2 id="when-sharepoint-gets-slow-really-slow">When SharePoint Gets Slow (Really Slow)</h2>
<p>Here&rsquo;s where things got interesting. During testing, I discovered that SharePoint webhooks aren&rsquo;t always as snappy as you&rsquo;d expect.</p>
<p>One evening, I made a change to a list item and noticed that both my webhook and a Power Automate flow (each set up for the same list) didn&rsquo;t fire until 22 minutes later. The timing was unusual, especially since this happened right when the customer&rsquo;s backup solution started running.</p>
<p>I can&rsquo;t say for sure what caused the delay, and I don&rsquo;t want to speculate or draw any conclusions based on this single incident. However, it does highlight an important consideration: webhook delivery isn&rsquo;t guaranteed to be immediate.</p>
<h2 id="trade-offs-and-considerations">Trade-offs and Considerations</h2>
<p>Like any architectural decision, this approach comes with trade-offs:</p>
<p><strong>Pros:</strong></p>
<ul>
<li>Dramatically reduces unnecessary processing</li>
<li>Handles the &ldquo;fidgety user&rdquo; problem elegantly</li>
<li>Resilient to webhook delivery delays</li>
<li>Scales well (Service Bus handles the heavy lifting)</li>
<li>Works across multiple function instances</li>
</ul>
<p><strong>Cons:</strong></p>
<ul>
<li>Adds latency (minimum 5-minute delay)</li>
<li>Requires additional Azure services (cost)</li>
<li>More complex than direct processing</li>
<li>Potential for message loss (though Service Bus is pretty reliable)</li>
</ul>
<p><strong>Alternative Approaches I Considered:</strong></p>
<ol>
<li><strong>In-memory debouncing</strong>: Would work for a single instance, but doesn&rsquo;t scale across multiple Azure Function instances</li>
<li><strong>Redis-based debouncing</strong>: Would work, but adds another dependency and requires more custom logic</li>
<li><strong>Database polling</strong>: Could work, but feels clunky and less efficient than Service Bus scheduled messages</li>
<li><strong>Simple delays</strong>: Just wait X seconds before processing, but this doesn&rsquo;t handle multiple rapid changes</li>
</ol>
<p>The Service Bus + Table Storage approach won because it&rsquo;s distributed by nature, leverages existing Azure services we were already using, and handles cancellation elegantly.</p>
<h2 id="wrapping-up">Wrapping Up</h2>
<p>Debouncing SharePoint webhooks with Azure Service Bus and Table Storage has made our operations more efficient and resilient to user behavior and platform quirks.</p>
]]></content:encoded></item><item><title>Stop Retrying Everything: Smart Graph Batch Retry Logic</title><link>https://jeppe-spanggaard.dk/blogs/graph-batch-smart-retry/</link><pubDate>Mon, 22 Sep 2025 00:00:00 +0000</pubDate><author>Jeppe</author><guid>https://jeppe-spanggaard.dk/blogs/graph-batch-smart-retry/</guid><description>Learn smart retry logic for Microsoft Graph batching to optimize API calls, reduce throttling, and enhance user experience.</description><content:encoded><![CDATA[<h2 id="the-day-my-batch-requests-started-fighting-back">The Day My Batch Requests Started Fighting Back</h2>
<p>Picture this: It&rsquo;s 2 AM, you&rsquo;re on your third cup of coffee, and you&rsquo;re watching your perfectly crafted Microsoft Graph batch request fail spectacularly. Again.</p>
<p>You&rsquo;ve got 25 files to download from SharePoint. Your batch processes 24 of them perfectly, then one lonely file decides to throw a throttling tantrum. What does your retry logic do? It throws away all 24 successful downloads and starts over. From scratch. Like a digital Groundhog Day, but less amusing and more soul-crushing.</p>
<p>Sound familiar? Welcome to the &ldquo;retry everything&rdquo; club – where perfectly good API calls go to die unnecessarily. 😅</p>
<h2 id="the-grocery-cart-problem-or-why-were-doing-this-wrong">The Grocery Cart Problem (Or: Why We&rsquo;re Doing This Wrong)</h2>
<p>Let me paint you a picture. You&rsquo;re at the grocery store with a cart full of 20 items. You get to checkout, and the cashier says, &ldquo;Sorry, we&rsquo;re out of milk.&rdquo;</p>
<p>What would you do?</p>
<ul>
<li><strong>Option A:</strong> Put back everything, go home, and come back later to shop for all 20 items again</li>
<li><strong>Option B:</strong> Buy the 19 items you can get, then come back just for the milk</li>
</ul>
<p>If you picked Option A, congratulations – you think like most API retry logic! If you picked Option B, you&rsquo;re ready to learn about smart retries.</p>
<p><strong>The &ldquo;retry everything&rdquo; approach is like Option A, and here&rsquo;s why it&rsquo;s bonkers:</strong></p>
<ul>
<li>🔄 <strong>Wasted effort</strong>: You&rsquo;re re-requesting stuff that already worked perfectly</li>
<li>🐌 <strong>Slower performance</strong>: Users wait longer while you redo successful work</li>
<li>📈 <strong>Throttling amplification</strong>: You&rsquo;re actually making the problem worse by hitting successful endpoints again</li>
<li>🔍 <strong>Poor debugging</strong>: Can&rsquo;t easily identify which specific requests are the real troublemakers</li>
</ul>
<p>I learned this the hard way when I watched a simple file sync turn into an API call avalanche. 20 requests became 40, then 80, then&hellip; well, let&rsquo;s just say Microsoft&rsquo;s throttling system got very acquainted with my application.</p>
<h2 id="the-aha-moment-its-simpler-than-you-think">The &ldquo;Aha!&rdquo; Moment (It&rsquo;s Simpler Than You Think)</h2>
<p>The solution hit me during one of those 2 AM debugging sessions: <strong>What if we only retry the stuff that actually failed?</strong></p>
<p>Revolutionary, right? 😏</p>
<p>Here&rsquo;s the beautiful thing – this isn&rsquo;t some PhD-level computer science. It&rsquo;s just common sense applied to code. Keep the winners, retry the losers. Simple.</p>
<p>But (there&rsquo;s always a &ldquo;but&rdquo;), there&rsquo;s one sneaky technical challenge that makes this trickier than it sounds. Microsoft&rsquo;s Graph SDK has a helpful method called <code>NewBatchWithFailedRequests()</code>, but it has a quirk: it generates brand new request IDs. This breaks your ability to map responses back to your original data.</p>
<p>Think of it like this: You order pizza for table 5, but when they bring the replacement slice, they call it table 23. Good luck figuring out who ordered what!</p>
<p>If you&rsquo;re new to Graph batching or request mapping, I&rsquo;d recommend checking out my post on <a href="https://jeppe-spanggaard.dk/blogs/graph-batching-file-content-mapping/">Graph Batching for File Content: Mapping Requests to Responses</a> first. It&rsquo;s like the prequel to this story – explains how to keep track of what&rsquo;s what when dealing with batch responses.</p>
<h2 id="quick-win-summary-for-the-impatient-developers">Quick Win Summary (For the Impatient Developers)</h2>
<p><strong>The Problem:</strong> Your retry logic is like that friend who starts the entire conversation over when they missed one word. Inefficient and annoying.</p>
<p><strong>The Solution:</strong> A drop-in extension method that only retries the actual failures while keeping successful responses safe and sound.</p>
<p><strong>The Payoff:</strong></p>
<ul>
<li>⚡ Faster operations (no more re-downloading working files)</li>
<li>📉 Fewer API calls (your rate limits will thank you)</li>
<li>🎯 Less throttling (stop beating dead endpoints)</li>
<li>😌 Happier users (and happier you at 2 AM)</li>
</ul>
<p><strong>The Catch:</strong> You need to understand request-to-response mapping. Don&rsquo;t worry, it&rsquo;s not rocket science, and I&rsquo;ve got a whole post about it.</p>
<p><strong>Time Investment:</strong> About 5 minutes to implement, countless hours of frustration saved.</p>
<p>Ready for the nitty-gritty? Let&rsquo;s dive in! 👇</p>
<h2 id="the-hero-of-our-story-the-smart-retry-extension">The Hero of Our Story: The Smart Retry Extension</h2>
<p>Okay, here&rsquo;s where we get our hands dirty. The main challenge isn&rsquo;t just filtering out successful requests – it&rsquo;s that pesky <code>NewBatchWithFailedRequests</code> method that scrambles your request IDs like eggs at Sunday brunch.</p>
<p>Here&rsquo;s the extension method that saves the day:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-cs" data-lang="cs"><span style="display:flex;"><span><span style="color:#66d9ef">internal</span> <span style="color:#66d9ef">static</span> <span style="color:#66d9ef">class</span> <span style="color:#a6e22e">GraphServiceClientExtensions</span> 
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">internal</span> <span style="color:#66d9ef">static</span> <span style="color:#66d9ef">async</span> Task&lt;(IReadOnlyDictionary&lt;<span style="color:#66d9ef">string</span>, HttpStatusCode&gt; Statuses, Dictionary&lt;<span style="color:#66d9ef">string</span>, HttpResponseMessage&gt; BatchResponse)&gt; 
</span></span><span style="display:flex;"><span>        PostBatchWithFailedDependencyRetriesAsync(<span style="color:#66d9ef">this</span> GraphServiceClient graphClient, BatchRequestContentCollection originalBatch) 
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">const</span> <span style="color:#66d9ef">int</span> maxRetries = <span style="color:#ae81ff">5</span>;
</span></span><span style="display:flex;"><span>        TimeSpan delay = TimeSpan.FromSeconds(<span style="color:#ae81ff">1</span>);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        Dictionary&lt;<span style="color:#66d9ef">string</span>, HttpResponseMessage&gt; allResponses = <span style="color:#66d9ef">new</span> Dictionary&lt;<span style="color:#66d9ef">string</span>, HttpResponseMessage&gt;();
</span></span><span style="display:flex;"><span>        Dictionary&lt;<span style="color:#66d9ef">string</span>, HttpStatusCode&gt; allStatuses = <span style="color:#66d9ef">new</span> Dictionary&lt;<span style="color:#66d9ef">string</span>, HttpStatusCode&gt;();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        BatchRequestContentCollection batchToSend = originalBatch;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">for</span> (<span style="color:#66d9ef">int</span> attempt = <span style="color:#ae81ff">1</span>; attempt &lt;= maxRetries; attempt++) 
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            BatchResponseContentCollection batchResponse = <span style="color:#66d9ef">await</span> graphClient.Batch.PostAsync(batchToSend);
</span></span><span style="display:flex;"><span>            Dictionary&lt;<span style="color:#66d9ef">string</span>, HttpStatusCode&gt; responses = <span style="color:#66d9ef">await</span> batchResponse.GetResponsesStatusCodesAsync();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// Filter out failures (excluding redirects which are normal for file content)</span>
</span></span><span style="display:flex;"><span>            Dictionary&lt;<span style="color:#66d9ef">string</span>, HttpStatusCode&gt; failedRequests = responses
</span></span><span style="display:flex;"><span>                .Where(kvp =&gt; !BatchResponseContent.IsSuccessStatusCode(kvp.Value) &amp;&amp; kvp.Value != HttpStatusCode.Found)
</span></span><span style="display:flex;"><span>                .ToDictionary(kvp =&gt; kvp.Key, kvp =&gt; kvp.Value);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// Collect all responses from this attempt</span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> kvp <span style="color:#66d9ef">in</span> responses) 
</span></span><span style="display:flex;"><span>            {
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">var</span> response = <span style="color:#66d9ef">await</span> batchResponse.GetResponseByIdAsync(kvp.Key);
</span></span><span style="display:flex;"><span>                allResponses[kvp.Key] = response;
</span></span><span style="display:flex;"><span>                allStatuses[kvp.Key] = kvp.Value;
</span></span><span style="display:flex;"><span>            }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">if</span> (failedRequests.Count == <span style="color:#ae81ff">0</span> || attempt == maxRetries) 
</span></span><span style="display:flex;"><span>            {
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">break</span>;
</span></span><span style="display:flex;"><span>            }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">await</span> Task.Delay(delay);
</span></span><span style="display:flex;"><span>            delay = TimeSpan.FromSeconds(delay.TotalSeconds * <span style="color:#ae81ff">2</span>);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// The key problem: NewBatchWithFailedRequests creates new request IDs!</span>
</span></span><span style="display:flex;"><span>            batchToSend = batchToSend.NewBatchWithFailedRequests(responses);
</span></span><span style="display:flex;"><span>            
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// This is why we need this method - restore the original request IDs</span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">await</span> RestoreOriginalRequestIdsAsync(batchToSend, originalBatch);
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> (allStatuses, allResponses);
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">private</span> <span style="color:#66d9ef">static</span> <span style="color:#66d9ef">async</span> Task RestoreOriginalRequestIdsAsync(
</span></span><span style="display:flex;"><span>        BatchRequestContentCollection newBatch, 
</span></span><span style="display:flex;"><span>        BatchRequestContentCollection originalBatch) 
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> stepsSnapshot = newBatch.BatchRequestSteps.ToArray();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> kvp <span style="color:#66d9ef">in</span> stepsSnapshot) 
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> oldStepId = kvp.Key;
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> step = kvp.Value;
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> requestPath = step.Request.RequestUri!.AbsolutePath;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// Find the original request ID by matching the request path</span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> matchingOriginal = originalBatch.BatchRequestSteps
</span></span><span style="display:flex;"><span>                .First(x =&gt; x.Value.Request.RequestUri!.AbsolutePath == requestPath);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> originalStepId = matchingOriginal.Key;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">if</span> (oldStepId != originalStepId) 
</span></span><span style="display:flex;"><span>            {
</span></span><span style="display:flex;"><span>                newBatch.RemoveBatchRequestStepWithId(oldStepId);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">var</span> newStep = <span style="color:#66d9ef">new</span> BatchRequestStep(
</span></span><span style="display:flex;"><span>                    requestId: originalStepId,
</span></span><span style="display:flex;"><span>                    httpRequestMessage: step.Request,
</span></span><span style="display:flex;"><span>                    dependsOn: step.DependsOn);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>                newBatch.AddBatchRequestStep(newStep);
</span></span><span style="display:flex;"><span>            }
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p><strong>What&rsquo;s happening here?</strong> Think of it as a diplomatic negotiator for your API calls:</p>
<ol>
<li><strong>The ID Shuffle Problem</strong>: <code>NewBatchWithFailedRequests</code> gives failed requests shiny new IDs, like witness protection for HTTP requests</li>
<li><strong>The Detective Work</strong>: <code>RestoreOriginalRequestIdsAsync</code> plays detective, matching requests by their paths to find their original identities</li>
<li><strong>The Happy Reunion</strong>: Failed requests get their original IDs back, so your mapping dictionary doesn&rsquo;t break down in tears</li>
</ol>
<p>It&rsquo;s like having a really good wedding planner who makes sure everyone sits at the right table, even after the venue changes.</p>
<h2 id="showtime-watching-smart-retries-in-action">Showtime: Watching Smart Retries in Action</h2>
<p>Now let&rsquo;s see our smart retry logic work its magic in a real-world scenario. Imagine you&rsquo;re building a document sync tool and need to download 25 files from SharePoint. Some will work perfectly, others might throw tantrums due to throttling or network hiccups.</p>
<p>Here&rsquo;s how the new approach handles it like a champ:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-cs" data-lang="cs"><span style="display:flex;"><span><span style="color:#75715e">// Let&#39;s say you need to download content from 25 SharePoint files</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> batch = <span style="color:#66d9ef">new</span> BatchRequestContentCollection(graphClient);
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> fileMapping = <span style="color:#66d9ef">new</span> Dictionary&lt;<span style="color:#66d9ef">string</span>, FileContentRequest&gt;();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Build the batch for file content downloads</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> filesToDownload = <span style="color:#66d9ef">await</span> GetFilesToProcess(); <span style="color:#75715e">// Your method to get file list</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> file <span style="color:#66d9ef">in</span> filesToDownload) 
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> requestInfo = graphClient.Sites[siteId]
</span></span><span style="display:flex;"><span>                                .Drives[driveId]
</span></span><span style="display:flex;"><span>                                .Items[file.DriveItemId]
</span></span><span style="display:flex;"><span>                                .Content
</span></span><span style="display:flex;"><span>                                .ToGetRequestInformation();
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> requestId = <span style="color:#66d9ef">await</span> batch.AddBatchRequestStepAsync(requestInfo);
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Map the request ID to your file info (same pattern as previous post)</span>
</span></span><span style="display:flex;"><span>    fileMapping[requestId] = <span style="color:#66d9ef">new</span> FileContentRequest 
</span></span><span style="display:flex;"><span>    { 
</span></span><span style="display:flex;"><span>        DriveItemId = file.DriveItemId,
</span></span><span style="display:flex;"><span>        FileName = file.Name,
</span></span><span style="display:flex;"><span>        ExpectedSize = file.Size,
</span></span><span style="display:flex;"><span>        DownloadStartTime = DateTime.Now
</span></span><span style="display:flex;"><span>    };
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// 🎯 Here&#39;s where the magic happens - just one line change!</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> (statuses, responses) = <span style="color:#66d9ef">await</span> graphClient.PostBatchWithFailedDependencyRetriesAsync(batch);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Process results - this is where the retry really shines</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> successfulDownloads = <span style="color:#66d9ef">new</span> List&lt;FileDownloadResult&gt;();
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> failedDownloads = <span style="color:#66d9ef">new</span> List&lt;<span style="color:#66d9ef">string</span>&gt;();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> kvp <span style="color:#66d9ef">in</span> fileMapping) 
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> requestId = kvp.Key;
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> fileRequest = kvp.Value;
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (responses.TryGetValue(requestId, <span style="color:#66d9ef">out</span> <span style="color:#66d9ef">var</span> response)) 
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> statusCode = statuses[requestId];
</span></span><span style="display:flex;"><span>        
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">if</span> (BatchResponseContent.IsSuccessStatusCode(statusCode)) 
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// Success! Handle the file content</span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> contentBytes = <span style="color:#66d9ef">await</span> response.Content.ReadAsByteArrayAsync();
</span></span><span style="display:flex;"><span>            
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// Save to your desired location</span>
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> localPath = Path.Combine(downloadFolder, fileRequest.FileName);
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">await</span> File.WriteAllBytesAsync(localPath, contentBytes);
</span></span><span style="display:flex;"><span>            
</span></span><span style="display:flex;"><span>            successfulDownloads.Add(<span style="color:#66d9ef">new</span> FileDownloadResult 
</span></span><span style="display:flex;"><span>            { 
</span></span><span style="display:flex;"><span>                FileName = fileRequest.FileName,
</span></span><span style="display:flex;"><span>                LocalPath = localPath,
</span></span><span style="display:flex;"><span>                ActualSize = contentBytes.Length,
</span></span><span style="display:flex;"><span>                ExpectedSize = fileRequest.ExpectedSize,
</span></span><span style="display:flex;"><span>                DownloadTime = DateTime.Now - fileRequest.DownloadStartTime
</span></span><span style="display:flex;"><span>            });
</span></span><span style="display:flex;"><span>        } 
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">else</span> 
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// Even after smart retries, this file failed</span>
</span></span><span style="display:flex;"><span>            failedDownloads.Add(<span style="color:#e6db74">$&#34;{fileRequest.FileName} ({statusCode})&#34;</span>);
</span></span><span style="display:flex;"><span>            
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// Log the specific failure for debugging</span>
</span></span><span style="display:flex;"><span>            Console.WriteLine(<span style="color:#e6db74">$&#34;Failed to download {fileRequest.FileName}: {statusCode}&#34;</span>);
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>        
</span></span><span style="display:flex;"><span>        <span style="color:#75715e">// Always clean up the response</span>
</span></span><span style="display:flex;"><span>        response.Dispose();
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>Console.WriteLine(<span style="color:#e6db74">$&#34;Successfully downloaded: {successfulDownloads.Count} files&#34;</span>);
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">if</span> (failedDownloads.Any())
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    Console.WriteLine(<span style="color:#e6db74">$&#34;Failed downloads: {string.Join(&#34;</span>, <span style="color:#e6db74">&#34;, failedDownloads)}&#34;</span>);
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p><strong>The beautiful part?</strong> Look at that line with the magic emoji 🎯. That&rsquo;s literally the only change you need to make to your existing batch processing code. Everything else stays exactly the same.</p>
<p><strong>Here&rsquo;s what&rsquo;s happening behind the scenes:</strong></p>
<ol>
<li><strong>First batch attempt</strong>: Say 20 files succeed, 5 fail due to throttling</li>
<li><strong>Smart filtering</strong>: Keep those 20 successful responses safe</li>
<li><strong>Targeted retry</strong>: Build a new batch with just the 5 failures</li>
<li><strong>ID preservation</strong>: Make sure those 5 retries still map to your original file info</li>
<li><strong>Rinse and repeat</strong>: Maybe 4 of the 5 succeed on retry, leaving just 1 persistent troublemaker</li>
</ol>
<p><strong>The result?</strong> Instead of making 250 API calls (25 files × 5 retry attempts for the unlucky ones), you might only make 35 total calls. Your throttling problems become manageable, and files download way faster.</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-cs" data-lang="cs"><span style="display:flex;"><span><span style="color:#75715e">// Supporting classes for the example above</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">public</span> <span style="color:#66d9ef">class</span> <span style="color:#a6e22e">FileContentRequest</span> 
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">string</span> DriveItemId { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; } = <span style="color:#66d9ef">string</span>.Empty;
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">string</span> FileName { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; } = <span style="color:#66d9ef">string</span>.Empty;
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">long</span> ExpectedSize { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> DateTime DownloadStartTime { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">public</span> <span style="color:#66d9ef">class</span> <span style="color:#a6e22e">FileDownloadResult</span> 
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">string</span> FileName { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; } = <span style="color:#66d9ef">string</span>.Empty;
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">string</span> LocalPath { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; } = <span style="color:#66d9ef">string</span>.Empty;
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">long</span> ActualSize { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">long</span> ExpectedSize { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> TimeSpan DownloadTime { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h2 id="the-method-to-the-madness-whats-really-happening">The Method to the Madness (What&rsquo;s Really Happening)</h2>
<p>I know that extension method looks intimidating – like trying to read assembly instructions in a foreign language. But once you break it down, it&rsquo;s actually pretty logical. Let me walk you through the step-by-step dance:</p>
<p><strong>Step 1: The First Attempt</strong>
&ldquo;Let&rsquo;s try everything once and see what happens&rdquo;</p>
<p>Sends your original batch of 25 files and carefully captures every single response and status code. No throwing anything away yet.</p>
<p><strong>Step 2: The Great Sorting</strong>
&ldquo;Okay, who succeeded and who&rsquo;s being difficult?&rdquo;</p>
<p>Separates the winners from the losers, but (and this is important) ignores redirect responses. Why? Because when you&rsquo;re downloading large files, redirects are totally normal – SharePoint often redirects you to the actual storage location.</p>
<p><strong>Step 3: The Preservation Society</strong>
&ldquo;Keep the good stuff safe while we deal with the troublemakers&rdquo;</p>
<p>All successful responses get stored in a safe place while we build a new, smaller batch containing only the failed requests. It&rsquo;s like having a really good filing system for your API responses.</p>
<p><strong>Step 4: The Identity Crisis Resolution</strong>
&ldquo;Wait, who are you again? Let me check your original ID&hellip;&rdquo;</p>
<p>This is the tricky bit! The <code>NewBatchWithFailedRequests</code> method gives everyone new IDs, like a witness protection program for HTTP requests. Our <code>RestoreOriginalRequestIdsAsync</code> method plays detective, matching requests by their URL paths to restore their original identities.</p>
<p><strong>Step 5: The Polite Wait</strong>
&ldquo;Let&rsquo;s not be pushy – maybe try again in a second?&rdquo;</p>
<p>Implements <a href="https://docs.microsoft.com/en-us/azure/architecture/patterns/retry">exponential backoff</a> – starts with a 1-second wait, then 2 seconds, then 4 seconds, etc. This prevents your app from being that annoying person who keeps knocking on the door every second.</p>
<p><strong>Step 6: The Safety Net</strong>
&ldquo;Okay, we tried 5 times. Some files just aren&rsquo;t meant to be downloaded today.&rdquo;</p>
<p>Gives up after 5 attempts to prevent infinite retry loops. Because sometimes you need to know when to walk away from the poker table.</p>
<h2 id="why-this-actually-works-the-science-behind-the-magic">Why This Actually Works (The Science Behind the Magic)</h2>
<p>Here&rsquo;s what makes this approach so much better than the &ldquo;retry everything&rdquo; strategy:</p>
<p><strong>🎯 Surgical Precision</strong>
Only retry what actually failed – it&rsquo;s like having a really good therapist who focuses on the actual problems instead of rehashing everything from childhood.</p>
<p>No wasted API calls on requests that already succeeded. If 24 out of 25 files downloaded perfectly, why punish them with another round trip?</p>
<p><strong>⚡ Speed Demon</strong>
Successful requests don&rsquo;t get repeated, so everything finishes faster – sometimes dramatically faster.</p>
<p>Users see their successful downloads immediately while you quietly retry the problematic ones in the background.</p>
<p><strong>🤝 Throttling-Friendly</strong>
Fewer total requests means you&rsquo;re less likely to hit Microsoft&rsquo;s rate limits, and when you do, recovery is faster.</p>
<p>Instead of amplifying throttling issues, you&rsquo;re actually helping to resolve them by reducing load on the endpoints that are already struggling.</p>
<p><strong>🔄 Drop-in Simplicity</strong>
Change literally one line of code and you&rsquo;re done. No architectural rewrites, no complex state management – just swap out the method call.</p>
<p>Your existing error handling, logging, and business logic all stay exactly the same.</p>
<p><strong>🔍 Debug Paradise</strong>
Easy to see exactly which requests are consistently failing, making troubleshooting a breeze instead of a nightmare.</p>
<p>When file &ldquo;ImportantDocument.pdf&rdquo; fails on every retry attempt, you know there&rsquo;s something specific about that file, not your entire batch logic.</p>
<h2 id="the-before-and-after-moment">The &ldquo;Before and After&rdquo; Moment</h2>
<p>Let me paint you a picture of how this changes your life:</p>
<p><strong>Before Smart Retries:</strong></p>
<ul>
<li>25 file batch fails on 3 files due to throttling</li>
<li>Retry all 25 files → now 5 files fail due to increased throttling</li>
<li>Retry all 25 files again → now 8 files fail</li>
<li>You&rsquo;re now in the throttling spiral of doom</li>
<li>Users are staring at loading spinners</li>
<li>You&rsquo;re questioning your career choices</li>
</ul>
<p><strong>After Smart Retries:</strong></p>
<ul>
<li>25 file batch fails on 3 files due to throttling</li>
<li>Keep the 22 successful files, retry only the 3 failures</li>
<li>Maybe 2 of the 3 succeed on retry, leaving 1 stubborn file</li>
<li>Final retry gets the last file, or you log it as a persistent issue</li>
<li>Users get 24/25 files quickly, you sleep better at night</li>
</ul>
<p>It&rsquo;s the difference between being stuck in traffic because one lane is blocked (and everyone keeps switching to that lane), versus just using the open lanes and going around the problem.</p>
<h2 id="the-bottom-line-and-why-your-future-self-will-thank-you">The Bottom Line (And Why Your Future Self Will Thank You)</h2>
<p>I&rsquo;ll be real with you – when I first started working with Microsoft Graph batching, I thought the built-in retry policies were enough. &ldquo;How hard could it be?&rdquo; I thought. &ldquo;APIs fail sometimes, just retry them!&rdquo;</p>
<p>Then I built my first real-world document sync application. Suddenly, I was dealing with users uploading hundreds of files, enterprise throttling limits, and the occasional network hiccup that would bring the whole operation to a screeching halt.</p>
<p><strong>That&rsquo;s when I learned the hard way that &ldquo;retry everything&rdquo; is like using a sledgehammer to hang a picture frame.</strong> Sure, it might work, but you&rsquo;re probably going to break some stuff in the process.</p>
<p>This selective retry approach has been a game-changer. Not just for performance (though users definitely notice when their bulk operations actually complete), but for debugging too. When you can see that <code>ImportantReport_v23_FINAL_REALLY_FINAL.docx</code> is the file that keeps failing, you can actually do something about it.</p>
<p><strong>The best part?</strong> Once you have this extension method in your toolkit, it becomes muscle memory. You&rsquo;re not adding complexity to your day-to-day development – you&rsquo;re just swapping out one method call for a smarter one. It&rsquo;s like upgrading from a flip phone to a smartphone – you wonder how you ever lived without it.</p>
<p><strong>Pro tip:</strong> After implementing this, keep an eye on your application logs. You&rsquo;ll start to notice patterns in failures that you never saw before. Maybe certain file types are more prone to issues, or maybe there&rsquo;s a specific time of day when throttling gets worse. This kind of insight is pure gold for optimization.</p>
<p>The moral of the story? Sometimes the biggest performance improvements come not from doing things faster, but from doing fewer unnecessary things. And sometimes, the best debugging tool is just&hellip; not breaking the working stuff while you fix the broken stuff.</p>
<p>Your 2 AM debugging sessions will never be the same. 😌</p>
<h2 id="want-to-learn-more-the-reading-list">Want to Learn More? (The Reading List)</h2>
<ul>
<li><strong><a href="https://docs.microsoft.com/en-us/graph/json-batching">Microsoft Graph JSON batching</a></strong> - The official documentation (surprisingly readable!)</li>
<li><strong><a href="https://jeppe-spanggaard.dk/blogs/graph-batching-file-content-mapping/">Graph Batching for File Content: Mapping Requests to Responses</a></strong> - My previous post that sets up the foundation for this one</li>
<li><strong><a href="https://docs.microsoft.com/en-us/graph/throttling">Microsoft Graph throttling guidance</a></strong> - Understanding what makes Microsoft&rsquo;s APIs cranky</li>
<li><strong><a href="https://developer.microsoft.com/en-us/graph/graph-explorer">Graph Explorer</a></strong> - Test your batch requests interactively (great for experimenting)</li>
<li><strong><a href="https://docs.microsoft.com/en-us/azure/architecture/patterns/retry">Exponential Backoff Pattern</a></strong> - The polite way to retry things</li>
</ul>
<p>Now go forth and batch smarter, not harder! 🚀</p>
]]></content:encoded></item><item><title>Graph Batching for File Content: Mapping Requests to Responses</title><link>https://jeppe-spanggaard.dk/blogs/graph-batching-file-content-mapping/</link><pubDate>Wed, 10 Sep 2025 00:00:00 +0000</pubDate><author>Jeppe</author><guid>https://jeppe-spanggaard.dk/blogs/graph-batching-file-content-mapping/</guid><description>How to handle Graph batching when downloading file content and mapping responses back to original requests</description><content:encoded><![CDATA[<h2 id="the-problem-thatll-drive-you-crazy">The Problem That&rsquo;ll Drive You Crazy</h2>
<p>Picture this: you need to download 50 files from SharePoint using Microsoft Graph. Being a good developer, you decide to use batching instead of making 50 individual API calls (because nobody wants to wait that long, and Microsoft&rsquo;s throttling limits aren&rsquo;t going anywhere).</p>
<p>You set up your batch request, send it off, and get your responses back. Great! Except&hellip; now you&rsquo;re staring at a bunch of file content with absolutely no way to tell which file is which. 😅</p>
<p>Unlike other Graph operations that return nice JSON objects with IDs and metadata, file content responses are just raw bytes. No file name, no path, no ID - nothing to help you figure out which response belongs to which original request.</p>
<p>I learned this the hard way when I first tried Graph batching for file downloads. Spent way too much time trying to correlate responses by file size or content patterns before realizing there was a much cleaner solution.</p>
<h2 id="the-mapping-solution-its-simpler-than-you-think">The Mapping Solution (It&rsquo;s Simpler Than You Think)</h2>
<p>The trick is surprisingly straightforward: use the batch request ID as your bridge between the original file info and the response content. Every batch request gets a unique ID, and that same ID comes back with the response.</p>
<p>Here&rsquo;s the game plan:</p>
<ol>
<li>Create a dictionary mapping request IDs to your original file information</li>
<li>Build your batch requests and store the mappings</li>
<li>Process responses using the request ID to look up the original file info</li>
</ol>
<p>Let me show you exactly how this works.</p>
<h2 id="setting-up-your-file-information">Setting Up Your File Information</h2>
<p>First, let&rsquo;s create a simple model to hold our file details:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">public</span> <span style="color:#66d9ef">class</span> <span style="color:#a6e22e">FileInfoDTO</span> {
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">string?</span> Path { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">string?</span> Name { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">string?</span> RelativePath { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">public</span> <span style="color:#66d9ef">string?</span> UniqueFileName { <span style="color:#66d9ef">get</span>; <span style="color:#66d9ef">set</span>; }
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>Nothing fancy here - just the basics we need to identify and process each file.</p>
<h2 id="the-complete-batch-download-method">The Complete Batch Download Method</h2>
<p>Here&rsquo;s the full implementation. Don&rsquo;t worry, I&rsquo;ll break down the important parts afterward:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">private</span> <span style="color:#66d9ef">async</span> Task&lt;Dictionary&lt;<span style="color:#66d9ef">string</span>, <span style="color:#66d9ef">byte</span>[]&gt;&gt; DownloadFilesBatchAsync(
</span></span><span style="display:flex;"><span>    FileInfoDTO[] fileInfos, 
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">string</span> siteId, 
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">string</span> driveId) {
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">using</span> BatchRequestContent batchRequestContent = <span style="color:#66d9ef">new</span> BatchRequestContent();
</span></span><span style="display:flex;"><span>    Dictionary&lt;<span style="color:#66d9ef">string</span>, FileInfoDTO&gt; requestMapping = <span style="color:#66d9ef">new</span> Dictionary&lt;<span style="color:#66d9ef">string</span>, FileInfoDTO&gt;();
</span></span><span style="display:flex;"><span>    Dictionary&lt;<span style="color:#66d9ef">string</span>, <span style="color:#66d9ef">byte</span>[]&gt; results = <span style="color:#66d9ef">new</span> Dictionary&lt;<span style="color:#66d9ef">string</span>, <span style="color:#66d9ef">byte</span>[]&gt;();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Build batch requests with mapping</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">foreach</span> (FileInfoDTO fileInfo <span style="color:#66d9ef">in</span> fileInfos) {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">if</span> (<span style="color:#66d9ef">string</span>.IsNullOrEmpty(fileInfo.RelativePath) || <span style="color:#66d9ef">string</span>.IsNullOrEmpty(fileInfo.UniqueFileName))
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">continue</span>;
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">string</span> requestId = batchRequestContent.AddBatchRequestStep(
</span></span><span style="display:flex;"><span>            GraphClient.Sites[siteId]
</span></span><span style="display:flex;"><span>                      .Drives[driveId]
</span></span><span style="display:flex;"><span>                      .Root
</span></span><span style="display:flex;"><span>                      .ItemWithPath(fileInfo.RelativePath)
</span></span><span style="display:flex;"><span>                      .Content
</span></span><span style="display:flex;"><span>                      .Request());
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#75715e">// This is the magic - storing the mapping!</span>
</span></span><span style="display:flex;"><span>        requestMapping[requestId] = fileInfo;
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Execute batch request</span>
</span></span><span style="display:flex;"><span>    BatchResponseContent batchResponse = <span style="color:#66d9ef">await</span> GraphClient.Batch.Request().PostAsync(batchRequestContent);
</span></span><span style="display:flex;"><span>    Dictionary&lt;<span style="color:#66d9ef">string</span>, HttpResponseMessage&gt; responses = <span style="color:#66d9ef">await</span> batchResponse.GetResponsesAsync();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Process responses using our mapping</span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">foreach</span> ((<span style="color:#66d9ef">string</span> requestId, HttpResponseMessage response) <span style="color:#66d9ef">in</span> responses) {
</span></span><span style="display:flex;"><span>        FileInfoDTO originalFile = requestMapping[requestId]; <span style="color:#75715e">// Look up the original file info</span>
</span></span><span style="display:flex;"><span>        
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">try</span> {
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">switch</span> (response.StatusCode) {
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">case</span> HttpStatusCode.OK:
</span></span><span style="display:flex;"><span>                    <span style="color:#66d9ef">byte</span>[] content = <span style="color:#66d9ef">await</span> response.Content.ReadAsByteArrayAsync();
</span></span><span style="display:flex;"><span>                    results[originalFile.UniqueFileName!] = content;
</span></span><span style="display:flex;"><span>                    <span style="color:#66d9ef">break</span>;
</span></span><span style="display:flex;"><span>                    
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">case</span> HttpStatusCode.Redirect:
</span></span><span style="display:flex;"><span>                    <span style="color:#75715e">// Handle redirect for large files (more on this below)</span>
</span></span><span style="display:flex;"><span>                    <span style="color:#66d9ef">byte</span>[] redirectContent = <span style="color:#66d9ef">await</span> DownloadFromRedirectAsync(response.Headers.Location);
</span></span><span style="display:flex;"><span>                    results[originalFile.UniqueFileName!] = redirectContent;
</span></span><span style="display:flex;"><span>                    <span style="color:#66d9ef">break</span>;
</span></span><span style="display:flex;"><span>                    
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">case</span> HttpStatusCode.TooManyRequests:
</span></span><span style="display:flex;"><span>                    <span style="color:#75715e">// Handle throttling</span>
</span></span><span style="display:flex;"><span>                    <span style="color:#66d9ef">throw</span> <span style="color:#66d9ef">new</span> Exception(<span style="color:#e6db74">$&#34;Throttled request for {originalFile.Name}&#34;</span>);
</span></span><span style="display:flex;"><span>                    
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">default</span>:
</span></span><span style="display:flex;"><span>                    <span style="color:#66d9ef">throw</span> <span style="color:#66d9ef">new</span> Exception(<span style="color:#e6db74">$&#34;Failed to download {originalFile.Name}: {response.ReasonPhrase}&#34;</span>);
</span></span><span style="display:flex;"><span>            }
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">finally</span> {
</span></span><span style="display:flex;"><span>            <span style="color:#75715e">// Always dispose - learned this one the hard way after some memory leak hunting</span>
</span></span><span style="display:flex;"><span>            response.Content.Dispose();
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> results;
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h2 id="the-key-parts-explained">The Key Parts Explained</h2>
<h3 id="the-mapping-dictionary">The Mapping Dictionary</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span>Dictionary&lt;<span style="color:#66d9ef">string</span>, FileInfoDTO&gt; requestMapping = <span style="color:#66d9ef">new</span> Dictionary&lt;<span style="color:#66d9ef">string</span>, FileInfoDTO&gt;();
</span></span></code></pre></div><p>This is your lifeline. For every request you add to the batch, you store the request ID and link it to your original file information. When responses come back, you can instantly look up which file each response belongs to.</p>
<h3 id="building-requests-with-mapping">Building Requests with Mapping</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">string</span> requestId = batchRequestContent.AddBatchRequestStep(...);
</span></span><span style="display:flex;"><span>requestMapping[requestId] = fileInfo;
</span></span></code></pre></div><p>The <code>AddBatchRequestStep</code> method returns a unique request ID. Store this immediately - you&rsquo;ll need it to match responses later.</p>
<h2 id="handling-the-redirect-curveball">Handling the Redirect Curveball</h2>
<p>Here&rsquo;s something that caught me off guard initially: large files don&rsquo;t return content directly. Instead, Graph gives you a redirect to an Azure Blob Storage URL where the actual file lives. Microsoft doesn&rsquo;t specify the exact file size threshold, but in practice, I&rsquo;ve observed this happening with files larger than a few MB.</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">private</span> <span style="color:#66d9ef">async</span> Task&lt;<span style="color:#66d9ef">byte</span>[]&gt; DownloadFromRedirectAsync(Uri? redirectUri) {
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (redirectUri == <span style="color:#66d9ef">null</span>)
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">throw</span> <span style="color:#66d9ef">new</span> ArgumentException(<span style="color:#e6db74">&#34;Redirect URI is null&#34;</span>);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">using</span> HttpClient httpClient = <span style="color:#66d9ef">new</span> HttpClient();
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">await</span> httpClient.GetByteArrayAsync(redirectUri);
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p>This happens because Microsoft doesn&rsquo;t want to push huge files through the Graph API unnecessarily. The redirect URL is temporary and works great - just make sure you handle it properly.</p>
<p><strong>Note:</strong> The exact file size that triggers a redirect isn&rsquo;t officially documented by Microsoft, so always handle both direct content (200 OK) and redirect (302) responses in your code.</p>
<h2 id="error-handling-that-actually-helps">Error Handling That Actually Helps</h2>
<p>When things go wrong (and they will), you want meaningful error messages. Here&rsquo;s how to handle the common scenarios:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">private</span> <span style="color:#66d9ef">async</span> Task ProcessBatchResponseAsync(
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">string</span> requestId, 
</span></span><span style="display:flex;"><span>    HttpResponseMessage response, 
</span></span><span style="display:flex;"><span>    FileInfoDTO originalFile,
</span></span><span style="display:flex;"><span>    Dictionary&lt;<span style="color:#66d9ef">string</span>, <span style="color:#66d9ef">byte</span>[]&gt; results) {
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">try</span> {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">switch</span> (response.StatusCode) {
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">case</span> HttpStatusCode.OK:
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">byte</span>[] content = <span style="color:#66d9ef">await</span> response.Content.ReadAsByteArrayAsync();
</span></span><span style="display:flex;"><span>                results[originalFile.UniqueFileName!] = content;
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">break</span>;
</span></span><span style="display:flex;"><span>                
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">case</span> HttpStatusCode.Redirect:
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">case</span> HttpStatusCode.Found:
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">byte</span>[] redirectContent = <span style="color:#66d9ef">await</span> DownloadFromRedirectAsync(response.Headers.Location);
</span></span><span style="display:flex;"><span>                results[originalFile.UniqueFileName!] = redirectContent;
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">break</span>;
</span></span><span style="display:flex;"><span>                
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">case</span> HttpStatusCode.NotFound:
</span></span><span style="display:flex;"><span>                Console.WriteLine(<span style="color:#e6db74">$&#34;File not found: {originalFile.Name} at {originalFile.RelativePath}&#34;</span>);
</span></span><span style="display:flex;"><span>                <span style="color:#75715e">// Maybe the file was moved or deleted</span>
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">break</span>;
</span></span><span style="display:flex;"><span>                
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">case</span> HttpStatusCode.TooManyRequests:
</span></span><span style="display:flex;"><span>                Console.WriteLine(<span style="color:#e6db74">$&#34;Throttled request for: {originalFile.Name}&#34;</span>);
</span></span><span style="display:flex;"><span>                <span style="color:#75715e">// This is where retry logic would go (coming in the next post!)</span>
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">break</span>;
</span></span><span style="display:flex;"><span>                
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">case</span> HttpStatusCode.Forbidden:
</span></span><span style="display:flex;"><span>                Console.WriteLine(<span style="color:#e6db74">$&#34;Access denied for: {originalFile.Name}&#34;</span>);
</span></span><span style="display:flex;"><span>                <span style="color:#75715e">// Check your permissions</span>
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">break</span>;
</span></span><span style="display:flex;"><span>                
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">default</span>:
</span></span><span style="display:flex;"><span>                Console.WriteLine(<span style="color:#e6db74">$&#34;Unexpected error downloading {originalFile.Name}: {response.StatusCode} - {response.ReasonPhrase}&#34;</span>);
</span></span><span style="display:flex;"><span>                <span style="color:#66d9ef">break</span>;
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">finally</span> {
</span></span><span style="display:flex;"><span>        response.Content?.Dispose(); <span style="color:#75715e">// Don&#39;t leak memory!</span>
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h2 id="important-things-to-remember">Important Things to Remember</h2>
<h3 id="batch-size-limits">Batch Size Limits</h3>
<p>Graph batching has a hard limit of 20 requests per batch. If you have more files, you&rsquo;ll need to chunk them:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">const</span> <span style="color:#66d9ef">int</span> BATCH_SIZE = <span style="color:#ae81ff">20</span>;
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">for</span> (<span style="color:#66d9ef">int</span> i = <span style="color:#ae81ff">0</span>; i &lt; fileInfos.Length; i += BATCH_SIZE) {
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> batch = fileInfos.Skip(i).Take(BATCH_SIZE).ToArray();
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> batchResults = <span style="color:#66d9ef">await</span> DownloadFilesBatchAsync(batch, siteId, driveId);
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Merge results...</span>
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h3 id="memory-management">Memory Management</h3>
<p>Always dispose of <code>HttpResponseMessage.Content</code>. File downloads can be large, and forgetting to dispose will cause memory leaks that are painful to debug.</p>
<h3 id="request-id-uniqueness">Request ID Uniqueness</h3>
<p>Request IDs are unique within a single batch, but not across different batches. Don&rsquo;t try to reuse mappings between different batch operations.</p>
<h2 id="why-this-pattern-works-so-well">Why This Pattern Works So Well</h2>
<p>This approach has several advantages that make it my go-to solution:</p>
<ul>
<li><strong>Dead Simple</strong>: No complex logic, just a straightforward mapping pattern</li>
<li><strong>Reliable</strong>: Works consistently regardless of file sizes or response order</li>
<li><strong>Memory Efficient</strong>: Proper cleanup prevents memory leaks</li>
<li><strong>Debuggable</strong>: Easy to trace issues when something goes wrong</li>
<li><strong>Extensible</strong>: Perfect foundation for adding retry logic later</li>
</ul>
<p>The beauty is in its simplicity. You&rsquo;re not trying to guess which response belongs to which request - you know exactly because you mapped it from the start.</p>
<h2 id="whats-next">What&rsquo;s Next?</h2>
<p>This mapping pattern solves the core problem of correlating Graph batch responses with your original requests. But what happens when some requests fail due to throttling or temporary errors?</p>
<p>In my next post, I&rsquo;ll show you how to build retry logic on top of this foundation that automatically handles failed requests without losing track of which files still need to be downloaded.</p>
<p>Have you run into this mapping challenge before? Let me know in the comments how you solved it - I&rsquo;m always curious about different approaches! 🚀</p>
]]></content:encoded></item><item><title>CSOM Performance Optimization: Why You Should Batch Your SharePoint Operations</title><link>https://jeppe-spanggaard.dk/blogs/csom-performance-optimization-chunking/</link><pubDate>Sun, 31 Aug 2025 00:00:00 +0000</pubDate><author>Jeppe</author><guid>https://jeppe-spanggaard.dk/blogs/csom-performance-optimization-chunking/</guid><description>Learn how to dramatically improve CSOM performance by batching operations instead of executing them one by one</description><content:encoded><![CDATA[<h2 id="the-problem-one-by-one-operations-kill-performance">The Problem: One-by-One Operations Kill Performance</h2>
<p>Following up on my previous post about <a href="https://jeppe-spanggaard.dk/blogs/devproxy-throttling-testing/">DevProxy and throttling testing</a>, there&rsquo;s another critical performance issue I see regularly in SharePoint CSOM code: executing operations one by one instead of batching them.</p>
<p>Consider this common pattern that I see everywhere:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// ❌ This approach is slow and inefficient</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> id <span style="color:#66d9ef">in</span> itemIds)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> item = list.GetItemById(id);
</span></span><span style="display:flex;"><span>    context.Load(item);
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">await</span> context.ExecuteQueryAsync(); <span style="color:#75715e">// Executing for EACH item!</span>
</span></span><span style="display:flex;"><span>    
</span></span><span style="display:flex;"><span>    <span style="color:#75715e">// Process the item</span>
</span></span><span style="display:flex;"><span>    ProcessItem(item);
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><p><strong>This code makes a server round-trip for every single item.</strong> If you&rsquo;re processing 50 items, that&rsquo;s 50 separate calls to SharePoint. Each call has network latency and server processing time.</p>
<h2 id="the-solution-batch-operations">The Solution: Batch Operations</h2>
<p>SharePoint CSOM reliably handles batches of around <strong>100 operations</strong> before calling <code>ExecuteQueryAsync()</code>. This means you can dramatically reduce the number of server round-trips.</p>
<p>Microsoft&rsquo;s official documentation also emphasizes this pattern in their <a href="https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-client-library-code#group-data-retrieval-on-the-same-object-together-to-improve-performance">performance guidelines</a>, showing how grouping data retrieval operations significantly improves performance.</p>
<p>Here&rsquo;s the pattern I use in most of my SharePoint projects:</p>
<h2 id="the-helper-methods">The Helper Methods</h2>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">public</span> <span style="color:#66d9ef">static</span> <span style="color:#66d9ef">async</span> Task&lt;List&lt;T&gt;&gt; GetItemsByIds&lt;T&gt;(<span style="color:#66d9ef">this</span> List list, IEnumerable&lt;<span style="color:#66d9ef">int</span>&gt; ids) 
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">where</span> T : <span style="color:#66d9ef">new</span>()
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (ids == <span style="color:#66d9ef">null</span> || !ids.Any())
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> <span style="color:#66d9ef">new</span> List&lt;T&gt;();
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> listItems = <span style="color:#66d9ef">await</span> CSOMHelpers.ProcessInChunks(ids.ToList(), <span style="color:#ae81ff">100</span>, <span style="color:#66d9ef">async</span> chunk =&gt; {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">var</span> items = chunk.Select(id =&gt; {
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">var</span> item = list.GetItemById(id);
</span></span><span style="display:flex;"><span>            list.Context.Load(item);
</span></span><span style="display:flex;"><span>            <span style="color:#66d9ef">return</span> item;
</span></span><span style="display:flex;"><span>        }).ToList();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">await</span> ExecuteQuery(list.Context, () =&gt; { <span style="color:#75715e">/* Load calls already done above */</span> });
</span></span><span style="display:flex;"><span>        
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">return</span> items;
</span></span><span style="display:flex;"><span>    });
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> listItems.ToList();
</span></span><span style="display:flex;"><span>}
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">internal</span> <span style="color:#66d9ef">static</span> <span style="color:#66d9ef">async</span> Task&lt;List&lt;TOut&gt;&gt; ProcessInChunks&lt;TIn, TOut&gt;(List&lt;TIn&gt; source, <span style="color:#66d9ef">int</span> chunkSize, Func&lt;List&lt;TIn&gt;, Task&lt;List&lt;TOut&gt;&gt;&gt; action)
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> result = <span style="color:#66d9ef">new</span> List&lt;TOut&gt;();
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> chunk <span style="color:#66d9ef">in</span> source.Chunk(chunkSize))
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        result.AddRange(<span style="color:#66d9ef">await</span> action(chunk.ToList()));
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">return</span> result;
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h2 id="performance-impact-the-numbers">Performance Impact: The Numbers</h2>
<p>Let me show you the difference with a real-world example. Loading 50 SharePoint list items:</p>
<h3 id="before-one-by-one">Before (One-by-One)</h3>
<ul>
<li><strong>50 server calls</strong></li>
<li><strong>Network latency</strong>: 50ms × 50 = 2.5 seconds</li>
<li><strong>Actual total time is usually higher due to server-side processing, hence</strong>: ~3-5 seconds</li>
</ul>
<h3 id="after-batched">After (Batched)</h3>
<ul>
<li><strong>1 server call</strong> (all 50 items in one batch)</li>
<li><strong>Network latency</strong>: 50ms × 1 = 50ms</li>
<li><strong>Total time</strong>: ~200-500ms</li>
</ul>
<blockquote>
<p><strong>⚠️ Performance Disclaimer</strong></p>
<p>The numbers shown above are from a specific example scenario and are meant to illustrate the concept of batching benefits. <strong>Your actual performance gains will vary significantly</strong> based on:</p>
<ul>
<li>Network latency and bandwidth</li>
<li>SharePoint server load and location</li>
<li>Item complexity and field count</li>
<li>Query complexity and filtering</li>
<li>Authentication overhead</li>
<li>Time of day and concurrent users</li>
</ul>
<p>While batching almost always improves performance, the exact improvement factor can range from marginal gains to dramatic improvements. The key takeaway is the <strong>pattern and approach</strong>, not the specific numbers.</p>
</blockquote>
<h2 id="applying-the-pattern-to-crud-operations">Applying the Pattern to CRUD Operations</h2>
<p>This pattern works for all CSOM operations, not just reading, but for all the CRUD operations.</p>
<h2 id="why-100-items">Why 100 Items?</h2>
<p>SharePoint has practical limits on how many operations you can batch:</p>
<ul>
<li><strong>CSOM limit</strong>: Around 100 operations per batch</li>
<li><strong>REST API limit</strong>: Different limits depending on operation type</li>
<li><strong>Network payload</strong>: Larger batches mean bigger HTTP requests</li>
</ul>
<p>I&rsquo;ve found <strong>100 items</strong> to be the sweet spot that:</p>
<ul>
<li>Maximizes performance gains</li>
<li>Stays well within SharePoint limits</li>
<li>Keeps HTTP payloads manageable</li>
<li>Works reliably across different SharePoint environments</li>
</ul>
<h2 id="combining-with-throttling-protection">Combining with Throttling Protection</h2>
<p>When you combine this batching approach with the throttling protection patterns from my <a href="https://jeppe-spanggaard.dk/blogs/devproxy-throttling-testing/">DevProxy post</a>, you get robust, high-performance SharePoint applications.</p>
<h2 id="best-practices">Best Practices</h2>
<ol>
<li><strong>Batch whenever you can</strong> - even for small numbers of items, batching usually helps.</li>
<li><strong>Use 100 as your chunk size</strong> for most scenarios</li>
<li><strong>Combine with retry logic</strong> for production resilience</li>
<li><strong>Test with DevProxy</strong> to ensure your batching works under throttling conditions</li>
<li><strong>Monitor performance</strong> before and after implementing batching</li>
</ol>
<h2 id="the-bottom-line">The Bottom Line</h2>
<p>Batching CSOM operations is one of the easiest wins for SharePoint performance optimization. The code pattern is straightforward to implement and reuse, but the performance impact is dramatic.</p>
<p><strong>Stop executing SharePoint operations one by one.</strong> Your users (and SharePoint servers) will thank you.</p>
<p>Batching is the first of five techniques I use to keep CSOM cheap. The rest, and the order I reach for them in, are in <a href="https://jeppe-spanggaard.dk/blogs/sharepoint-csom-performance-playbook/">The SharePoint CSOM Performance Playbook</a>.</p>
<h2 id="resources">Resources</h2>
<ul>
<li><a href="https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-client-library-code">SharePoint CSOM Best Practices</a></li>
<li><a href="https://jeppe-spanggaard.dk/blogs/devproxy-throttling-testing/">DevProxy for Testing Throttling</a></li>
<li><a href="https://docs.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online">SharePoint Performance Guidelines</a></li>
</ul>
]]></content:encoded></item><item><title>DevProxy: How to Test API Rate Limiting and Throttling in C# Development</title><link>https://jeppe-spanggaard.dk/blogs/devproxy-throttling-testing/</link><pubDate>Sun, 10 Aug 2025 00:00:00 +0000</pubDate><author>Jeppe</author><guid>https://jeppe-spanggaard.dk/blogs/devproxy-throttling-testing/</guid><description>Discover how to simulate Microsoft Graph and SharePoint throttling locally using DevProxy, and prevent production slowdowns before they happen.</description><content:encoded><![CDATA[<h2 id="the-problem-when-parallel-programming-backfires">The Problem: When Parallel Programming Backfires</h2>
<p>If you’ve ever optimized your C# API calls with parallel programming, you might know this story.</p>
<p>Your client wants faster performance. You run multiple API requests in parallel. Locally, everything flies — especially late at night when traffic is low. But the next morning, on the final pre-deployment test, disaster strikes.</p>
<p><strong>Random errors. Requests delayed for 45 seconds.</strong><br>
Microsoft Graph or SharePoint has slammed you with throttling and rate limits. Your blazing-fast local solution crumbles under production-like conditions.</p>
<hr>
<h2 id="how-crud-operations-can-secretly-burn-through-your-limits--and-how-to-catch-them-with-devproxy">How CRUD Operations Can Secretly Burn Through Your Limits — and How to Catch Them with DevProxy</h2>
<p>Here’s the thing:<br>
SharePoint Online charges “Resource Units” (RUs) for every request you make. Think of RUs as an invisible currency — every API call you send deducts from your allowance. Run out too fast, and throttling kicks in.</p>
<p>And those “simple” operations? They’re not as cheap as you think.</p>
<p><strong>From Microsoft’s RU table</strong>:</p>
<table>
  <thead>
      <tr>
          <th>Operation Type</th>
          <th>RU Cost</th>
          <th>What That Means</th>
      </tr>
  </thead>
  <tbody>
      <tr>
          <td><strong>Single item query</strong></td>
          <td>1 RU</td>
          <td>Reading one specific list item</td>
      </tr>
      <tr>
          <td><strong>Multi-item query</strong></td>
          <td>2 RUs</td>
          <td>Listing children, filtering, sorting</td>
      </tr>
      <tr>
          <td><strong>Create / Update / Delete / Upload</strong></td>
          <td>2 RUs</td>
          <td>Per individual operation (bulk operations may be more efficient)</td>
      </tr>
      <tr>
          <td><strong>Permission expansion</strong> (<code>$expand=permissions</code>)</td>
          <td>5 RUs</td>
          <td>Heavy permission lookups</td>
      </tr>
  </tbody>
</table>
<blockquote>
<p><strong>Source:</strong> <a href="https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online#resource-units">Microsoft&rsquo;s official SharePoint throttling documentation</a></p>
</blockquote>
<p>Permission expansions are just one type of &ldquo;expensive&rdquo; call. Another common scenario that can impact RU consumption is <strong>making multiple separate queries instead of using CAML joins</strong> — something I explored in <a href="https://jeppe-spanggaard.dk/blogs/joining-multiple-lists-csom-caml/">my CAML join post</a>.<br>
While joining multiple lists in a single query is actually more efficient than separate calls, poorly structured queries or retrieving unnecessarily large datasets can still consume RUs quickly if not optimized properly.</p>
<hr>
<h3 id="why-this-sneaks-up-on-you">Why This Sneaks Up on You</h3>
<p>When coding locally, it’s easy to run a handful of queries without noticing.<br>
But in production, with real concurrency and volume, these calls pile up in seconds.</p>
<p>Imagine:</p>
<ul>
<li>10 parallel updates (2 RUs each) = <strong>20 RUs in one burst</strong></li>
<li>Add a few joins/expansions or large list queries, and you’re suddenly <em>burning through limits 5x faster</em>.</li>
</ul>
<hr>
<h3 id="how-devproxy-can-show-you-the-pain-before-production">How DevProxy Can Show You the Pain Before Production</h3>
<p>Here’s where DevProxy shines.<br>
If you configure it to simulate throttling based on these RU-heavy calls, you’ll <em>see</em> the impact locally:</p>
<ol>
<li><strong>Enable throttling plugins</strong> in your <code>devproxy.json</code> (as shown earlier).</li>
<li>Point <code>urlsToWatch</code> at your SharePoint endpoints.</li>
<li>Run your CRUD-heavy code.</li>
</ol>
<p>DevProxy will start throwing 429s (Too Many Requests) once your “fake” RU budget is exhausted — just like SharePoint would in production.</p>
<p>The beautiful part?<br>
You can crank the limits <em>down</em> during testing to make expensive patterns obvious. Even a single large query or unbatched <code>Update</code> will light up your logs.</p>
<p>Example DevProxy log when hitting a throttling simulation:</p>
<pre tabindex="0"><code>[Warning] Throttling triggered: 2 parallel Create calls exceeded RU limit (RateLimitingPlugin)
Retry after: 30 seconds
</code></pre><p><strong>Pro tip:</strong><br>
Use DevProxy as a <strong>budget meter</strong> for your API calls. Treat every 2-RU and 5-RU operation as “spending big” — and redesign those spots <em>before</em> they become a production outage.</p>
<h2 id="what-is-devproxy">What is DevProxy?</h2>
<p><a href="https://github.com/dotnet/dev-proxy">DevProxy</a> is an open-source HTTP/HTTPS proxy server that can simulate real-world network issues, including:</p>
<ul>
<li><a href="https://learn.microsoft.com/en-us/microsoft-cloud/dev/dev-proxy/concepts/what-is-rate-limiting"><strong>Rate limiting</strong></a></li>
<li><a href="https://learn.microsoft.com/en-us/microsoft-cloud/dev/dev-proxy/concepts/what-is-throttling"><strong>Throttling</strong></a></li>
<li><a href="https://learn.microsoft.com/en-us/microsoft-cloud/dev/dev-proxy/how-to/simulate-slow-api-responses"><strong>Network delays</strong></a></li>
<li><a href="https://learn.microsoft.com/en-us/microsoft-cloud/dev/dev-proxy/how-to/test-my-app-with-random-errors"><strong>Intermittent errors</strong></a></li>
</ul>
<p>It’s free, open source, and designed for developers who want to <strong>catch performance bottlenecks before they reach production</strong>.</p>
<hr>
<h2 id="installing-devproxy">Installing DevProxy</h2>
<p>Follow the official setup guide here:<br>
<a href="https://learn.microsoft.com/en-us/microsoft-cloud/dev/dev-proxy/get-started/set-up">DevProxy Installation Documentation</a></p>
<hr>
<h2 id="basic-usage">Basic Usage</h2>
<p>Run DevProxy with the default configuration:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>devproxy
</span></span></code></pre></div><p>It will begin intercepting all HTTP/HTTPS requests.</p>
<blockquote>
<p><strong>Tip:</strong> Start DevProxy <em>before</em> running your own code — otherwise, it won’t capture the traffic.</p>
</blockquote>
<hr>
<h2 id="simulating-microsoft-graph-throttling">Simulating Microsoft Graph Throttling</h2>
<p>Here’s how to configure DevProxy to reproduce Microsoft Graph and SharePoint throttling issues locally.</p>
<h3 id="1-create-a-devproxyjson-configuration-file">1. Create a <code>devproxy.json</code> configuration file</h3>
<p>This is the exact configuration I used when testing my problematic parallel code:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&#34;$schema&#34;</span>: <span style="color:#e6db74">&#34;https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/rc.schema.json&#34;</span>,
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&#34;rate&#34;</span>: <span style="color:#ae81ff">25</span>,
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&#34;plugins&#34;</span>: [
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;name&#34;</span>: <span style="color:#e6db74">&#34;RetryAfterPlugin&#34;</span>,
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;enabled&#34;</span>: <span style="color:#66d9ef">true</span>,
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;pluginPath&#34;</span>: <span style="color:#e6db74">&#34;~appFolder/plugins/dev-proxy-plugins.dll&#34;</span>
</span></span><span style="display:flex;"><span>    },
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;name&#34;</span>: <span style="color:#e6db74">&#34;RateLimitingPlugin&#34;</span>,
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;enabled&#34;</span>: <span style="color:#66d9ef">true</span>,
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;pluginPath&#34;</span>: <span style="color:#e6db74">&#34;~appFolder/plugins/dev-proxy-plugins.dll&#34;</span>,
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;configSection&#34;</span>: <span style="color:#e6db74">&#34;rateLimitingPlugin&#34;</span>
</span></span><span style="display:flex;"><span>    },
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;name&#34;</span>: <span style="color:#e6db74">&#34;GraphRandomErrorPlugin&#34;</span>,
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;enabled&#34;</span>: <span style="color:#66d9ef">true</span>,
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;pluginPath&#34;</span>: <span style="color:#e6db74">&#34;~appFolder/plugins/dev-proxy-plugins.dll&#34;</span>,
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&#34;configSection&#34;</span>: <span style="color:#e6db74">&#34;graphRandomErrorPlugin&#34;</span>
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>  ],
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&#34;urlsToWatch&#34;</span>: [
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://graph.microsoft.com/v1.0/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://graph.microsoft.com/beta/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://graph.microsoft.us/v1.0/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://graph.microsoft.us/beta/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://dod-graph.microsoft.us/v1.0/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://dod-graph.microsoft.us/beta/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://microsoftgraph.chinacloudapi.cn/v1.0/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://microsoftgraph.chinacloudapi.cn/beta/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://*.sharepoint.*/*_api/web/GetClientSideComponents&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://*.sharepoint.*/*_api/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://*.sharepoint.*/*_vti_bin/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://*.sharepoint-df.*/*_api/*&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#e6db74">&#34;https://*.sharepoint-df.*/*_vti_bin/*&#34;</span>
</span></span><span style="display:flex;"><span>  ],
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&#34;graphRandomErrorPlugin&#34;</span>: {
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&#34;$schema&#34;</span>: <span style="color:#e6db74">&#34;https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/graphrandomerrorplugin.schema.json&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&#34;allowedErrors&#34;</span>: [
</span></span><span style="display:flex;"><span>      <span style="color:#ae81ff">429</span>,
</span></span><span style="display:flex;"><span>      <span style="color:#ae81ff">503</span>,
</span></span><span style="display:flex;"><span>      <span style="color:#ae81ff">504</span>
</span></span><span style="display:flex;"><span>    ]
</span></span><span style="display:flex;"><span>  },
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&#34;rateLimitingPlugin&#34;</span>: {
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&#34;$schema&#34;</span>: <span style="color:#e6db74">&#34;https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/ratelimitingplugin.schema.json&#34;</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&#34;costPerRequest&#34;</span>: <span style="color:#ae81ff">2</span>,
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&#34;rateLimit&#34;</span>: <span style="color:#ae81ff">120</span>
</span></span><span style="display:flex;"><span>  },
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&#34;logLevel&#34;</span>: <span style="color:#e6db74">&#34;information&#34;</span>,
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&#34;newVersionNotification&#34;</span>: <span style="color:#e6db74">&#34;stable&#34;</span>,
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&#34;showSkipMessages&#34;</span>: <span style="color:#66d9ef">true</span>,
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&#34;showTimestamps&#34;</span>: <span style="color:#66d9ef">true</span>
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h3 id="2-start-devproxy-with-your-configuration">2. Start DevProxy with your configuration</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>devproxy --config-file devproxy.json
</span></span></code></pre></div><hr>
<h2 id="example-of-problematic-code">Example of Problematic Code</h2>
<p>Here’s the snippet that caused my throttling nightmare. It uses <code>Parallel.ForEachAsync</code> to query SharePoint in bulk:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// ❌ This will likely trigger throttling in production</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> customers = <span style="color:#66d9ef">new</span> ConcurrentBag&lt;CustomerDTO&gt;();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">await</span> Parallel.ForEachAsync(departmentIds, <span style="color:#66d9ef">async</span> (departmentId, token) =&gt; 
</span></span><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> clonedContext = _clientContext.Clone(_clientContext.Url);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> query = Camlex.Query()
</span></span><span style="display:flex;"><span>        .ViewFields(<span style="color:#66d9ef">new</span> CustomerDTO().ViewFields().ToArray().Append(<span style="color:#e6db74">&#34;DepartmentId&#34;</span>))
</span></span><span style="display:flex;"><span>        .LeftJoin(x =&gt; x[<span style="color:#e6db74">&#34;DepartmentLookup&#34;</span>].ForeignList(DEPARTMENT_LIST_GUID))
</span></span><span style="display:flex;"><span>        .ProjectedField(x =&gt; x[<span style="color:#e6db74">&#34;DepartmentId&#34;</span>].List(DEPARTMENT_LIST_GUID).ShowField(<span style="color:#e6db74">&#34;ID&#34;</span>))
</span></span><span style="display:flex;"><span>        .Where(x =&gt; x[<span style="color:#e6db74">&#34;DepartmentId&#34;</span>] == departmentId);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">var</span> departmentCustomers = <span style="color:#66d9ef">await</span> SharePointService.GetItemsFromListByQuery&lt;CustomerDTO&gt;(
</span></span><span style="display:flex;"><span>        CUSTOMER_LIST_GUID,
</span></span><span style="display:flex;"><span>        clonedContext,
</span></span><span style="display:flex;"><span>        query);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>    <span style="color:#66d9ef">if</span> (departmentCustomers?.Any() == <span style="color:#66d9ef">true</span>)
</span></span><span style="display:flex;"><span>    {
</span></span><span style="display:flex;"><span>        <span style="color:#66d9ef">foreach</span> (<span style="color:#66d9ef">var</span> customer <span style="color:#66d9ef">in</span> departmentCustomers)
</span></span><span style="display:flex;"><span>        {
</span></span><span style="display:flex;"><span>            customers.Add(customer);
</span></span><span style="display:flex;"><span>        }
</span></span><span style="display:flex;"><span>    }
</span></span><span style="display:flex;"><span>});
</span></span></code></pre></div><hr>
<h2 id="why-this-code-fails-in-production">Why This Code Fails in Production</h2>
<ol>
<li><strong>No throttling safeguards</strong> — Multiple parallel requests overwhelm SharePoint.</li>
<li><strong>No retry logic</strong> — Requests fail instead of recovering.</li>
<li><strong>No request limiting</strong> — All departments are processed simultaneously.</li>
<li><strong>Silent failures</strong> — Errors are ignored without logging or fallback.</li>
</ol>
<hr>
<h2 id="the-better-way">The Better Way</h2>
<p>Instead of hard-coding fixes here, I recommend Bert Jansen’s detailed guide on throttling and rate limit handling:<br>
<a href="https://github.com/OneDrive/samples/blob/master/scenarios/throttling-ratelimit-handling/readme.md">Throttling &amp; Rate Limit Handling Patterns</a></p>
<p>Key principles:</p>
<ul>
<li><strong>Limit concurrency</strong> with <code>SemaphoreSlim</code>.</li>
<li><strong>Use exponential backoff</strong> for retries.</li>
<li><strong>Monitor rate limit headers</strong> to adjust requests dynamically.</li>
<li><strong>Handle errors explicitly</strong> to prevent silent failures.</li>
</ul>
<hr>
<h2 id="conclusion">Conclusion</h2>
<p>DevProxy has become an essential tool in my Microsoft 365 development workflow. It helps me:</p>
<ul>
<li>Catch throttling issues <strong>before</strong> production.</li>
<li>Test error handling and retry logic <strong>locally</strong>.</li>
<li>Deliver applications that can survive real-world API limits.</li>
</ul>
<p>If I’d used DevProxy from the start, I could have avoided the last-minute throttling meltdown entirely.</p>
<p>💡 <strong>Pro tip:</strong> Make DevProxy part of your <em>early</em> development process, not your emergency toolkit.</p>
<hr>
<h2 id="additional-resources">Additional Resources</h2>
<ul>
<li><a href="https://github.com/dotnet/dev-proxy">DevProxy GitHub Repository</a></li>
<li><a href="https://docs.microsoft.com/en-us/graph/throttling">Microsoft Graph Throttling Guidelines</a></li>
<li><a href="https://aka.ms/devproxy/docs">DevProxy Documentation</a></li>
</ul>
]]></content:encoded></item><item><title>Efficient Multi-List Queries in CSOM: Using CAML Joins with CAMLEX</title><link>https://jeppe-spanggaard.dk/blogs/joining-multiple-lists-csom-caml/</link><pubDate>Mon, 28 Jul 2025 00:00:00 +0000</pubDate><author>Jeppe</author><guid>https://jeppe-spanggaard.dk/blogs/joining-multiple-lists-csom-caml/</guid><description>Learn how to efficiently query multiple SharePoint lists using CAML joins instead of multiple API calls to avoid throttling</description><content:encoded><![CDATA[<h2 id="the-problem-multiple-list-queries-and-throttling">The Problem: Multiple List Queries and Throttling</h2>
<p>When working with related data across multiple SharePoint lists, developers often fall into the trap of making multiple individual queries:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// ❌ Bad approach - Multiple API calls</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> customers = context.Web.Lists.GetByTitle(<span style="color:#e6db74">&#34;Customers&#34;</span>);
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> orders = context.Web.Lists.GetByTitle(<span style="color:#e6db74">&#34;Orders&#34;</span>);
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> orderItems = context.Web.Lists.GetByTitle(<span style="color:#e6db74">&#34;OrderItems&#34;</span>);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Each query consumes 2 resource units</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> customerItems = customers.GetItems(camlQuery1);  <span style="color:#75715e">// 2 units</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> orderItems = orders.GetItems(camlQuery2);        <span style="color:#75715e">// 2 units  </span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> itemDetails = orderItems.GetItems(camlQuery3);   <span style="color:#75715e">// 2 units</span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Total: 6 resource units + processing overhead</span>
</span></span></code></pre></div><p>This approach has several issues:</p>
<ul>
<li><strong>Higher resource consumption</strong>: Each query consumes <a href="https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online">2 resource units</a> per multi-item request</li>
<li><strong>Increased throttling risk</strong>: More API calls mean hitting limits faster</li>
<li><strong>Network overhead</strong>: Multiple round trips to SharePoint</li>
<li><strong>Complex data merging</strong>: Manual joining of results in C#</li>
</ul>
<h2 id="how-to-fix-it">How to fix it?</h2>
<p>I have worked alot with MSSQL where it is pretty easy to just join a table on a table on a table. But I did not know it was possible in CSOM. Eg. in the UI of SharePoint you can only expand one table - NOT multiple. But one day I deep dived into CAML and joins, and found out it was possible!</p>
<p><strong>Resource Unit Comparison:</strong></p>
<p>Let&rsquo;s break down the actual cost difference. According to Microsoft&rsquo;s <a href="https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online">throttling documentation</a>, each multi-item query consumes <strong>2 resource units</strong>.</p>
<p><strong>Multiple separate queries (❌ Bad approach):</strong></p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// Query 1: Get order items from main list</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> orderItems = ordersList.GetItems(query1);        <span style="color:#75715e">// 2 resource units</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Query 2: Get customer details  </span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> customers = customersList.GetItems(query2);      <span style="color:#75715e">// 2 resource units</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Query 3: Get order details</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> orderDetails = orderDetailsList.GetItems(query3); <span style="color:#75715e">// 2 resource units</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e">// Total: 6 resource units + network overhead + manual C# joining</span>
</span></span></code></pre></div><p><strong>Single join query (✅ Good approach):</strong></p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// One query with joins gets ALL the data</span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> items = ordersList.GetItems(joinQuery);          <span style="color:#75715e">// 2 resource units total</span>
</span></span></code></pre></div><p><strong>The math:</strong></p>
<ul>
<li>Multiple queries: <strong>2 units × 3 lists = 6 units</strong></li>
<li>Single join query: <strong>2 units total</strong></li>
<li><strong>Savings: 66% fewer resource units!</strong></li>
</ul>
<p>This becomes even more significant when you consider that SharePoint throttling limits are measured in resource units per time window. With joins, you can query 3x more data within the same throttling limits.</p>
<p><img src="https://jeppe-spanggaard.dk/images/CamlJoin_hu_ac4f9ad836dd7741.webp" srcset="/images/CamlJoin_hu_86b3b075eaa520a.webp 480w, /images/CamlJoin_hu_118714a818876a25.webp 720w, /images/CamlJoin_hu_ac4f9ad836dd7741.webp 1200w" sizes="(max-width: 760px) 100vw, 720px"
    width="1200" height="749"
    alt="alt text" style="background:url(data:image/webp;base64,UklGRlIAAABXRUJQVlA4IEYAAADwAwCdASoYAA8AP1mMt0upJKKYBACTFYT0gGGaEsaVl24t/frQwLnAAP7S9AkNB92WF1gIbVQK3xT5oPTvGrkAHO3MUAAA) center/cover no-repeat" loading="lazy" decoding="async"></p>
<h2 id="the-solution-caml-joins">The Solution: CAML Joins</h2>
<p>CAML actually supports joining multiple lists in a single query! This means you can get data from related lists without multiple API calls.</p>
<p><strong>First, install CAMLEX via NuGet:</strong></p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-powershell" data-lang="powershell"><span style="display:flex;"><span>Install-Package Camlex.Client.dll
</span></span></code></pre></div><p><strong>Then build your join query:</strong></p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#66d9ef">var</span> list = context.Web.Lists.GetByTitle(<span style="color:#e6db74">&#34;YourMainList&#34;</span>);
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>CamlexNET.Interfaces.IQuery query = Camlex.Query();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>query = query
</span></span><span style="display:flex;"><span>.LeftJoin(x =&gt; x[<span style="color:#e6db74">&#34;OrderTaskLookUp&#34;</span>].ForeignList(ListGuidOrderTasks))
</span></span><span style="display:flex;"><span>.LeftJoin(x =&gt; x[<span style="color:#e6db74">&#34;OrderDetailLookUp&#34;</span>].PrimaryList(ListGuidOrderTasks).ForeignList(ListGuidOrders))
</span></span><span style="display:flex;"><span>.LeftJoin(x =&gt; x[<span style="color:#e6db74">&#34;CustomerLookUp&#34;</span>].PrimaryList(ListGuidOrders).ForeignList(ListGuidCustomers))
</span></span><span style="display:flex;"><span>.ProjectedField(x =&gt; x[<span style="color:#e6db74">&#34;CustomerNo&#34;</span>].List(ListGuidCustomers).ShowField(<span style="color:#e6db74">&#34;CustomerNo&#34;</span>))
</span></span><span style="display:flex;"><span>.ProjectedField(x =&gt; x[<span style="color:#e6db74">&#34;CustomerName&#34;</span>].List(ListGuidCustomers).ShowField(<span style="color:#e6db74">&#34;CustomerName&#34;</span>));
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> camlQuery = <span style="color:#66d9ef">new</span> CamlQuery();
</span></span><span style="display:flex;"><span>camlQuery.ViewXml = query.ToString();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> items = list.GetItems(camlQuery);
</span></span><span style="display:flex;"><span>context.Load(items);
</span></span><span style="display:flex;"><span>context.ExecuteQuery();
</span></span></code></pre></div><p><strong>Important:</strong> Your lists need to be connected via lookup columns for joins to work!</p>
<h2 id="why-camlex-instead-of-raw-caml">Why CAMLEX Instead of Raw CAML?</h2>
<p>I don&rsquo;t write raw CAML myself - it&rsquo;s verbose and error-prone. Instead, I use <a href="https://github.com/sadomovalex/camlex">CAMLEX</a> because:</p>
<ul>
<li><strong>Cleaner syntax</strong>: C# lambda expressions instead of XML</li>
<li><strong>IntelliSense support</strong>: Catch errors at compile time</li>
<li><strong>Easier for the next developer</strong>: Self-documenting code</li>
<li><strong>Less mistakes</strong>: No more XML typos or missing tags</li>
</ul>
<h2 id="what-else">What else?</h2>
<p>One thing is to join multiple lists, but to filter on a value 4 lists away - That is neat!</p>
<p>For example, filtering orders by the customer&rsquo;s name, which is 2 lists away:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span>CamlexNET.Interfaces.IQuery query = Camlex.Query();
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>query = query
</span></span><span style="display:flex;"><span>.Where(x =&gt; (<span style="color:#66d9ef">string</span>)x[<span style="color:#e6db74">&#34;CustomerName&#34;</span>] == <span style="color:#e6db74">&#34;Contoso&#34;</span>) <span style="color:#75715e">// &lt;---- Filtering on join field</span>
</span></span><span style="display:flex;"><span>.LeftJoin(x =&gt; x[<span style="color:#e6db74">&#34;OrderTaskLookUp&#34;</span>].ForeignList(ListGuidOrderTasks))
</span></span><span style="display:flex;"><span>.LeftJoin(x =&gt; x[<span style="color:#e6db74">&#34;OrderDetailLookUp&#34;</span>].PrimaryList(ListGuidOrderTasks).ForeignList(ListGuidOrders))
</span></span><span style="display:flex;"><span>.LeftJoin(x =&gt; x[<span style="color:#e6db74">&#34;CustomerLookUp&#34;</span>].PrimaryList(ListGuidOrders).ForeignList(ListGuidCustomers))
</span></span><span style="display:flex;"><span>.ProjectedField(x =&gt; x[<span style="color:#e6db74">&#34;CustomerNo&#34;</span>].List(ListGuidCustomers).ShowField(<span style="color:#e6db74">&#34;CustomerNo&#34;</span>))
</span></span><span style="display:flex;"><span>.ProjectedField(x =&gt; x[<span style="color:#e6db74">&#34;CustomerName&#34;</span>].List(ListGuidCustomers).ShowField(<span style="color:#e6db74">&#34;CustomerName&#34;</span>));
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> camlQuery = <span style="color:#66d9ef">new</span> CamlQuery();
</span></span><span style="display:flex;"><span>camlQuery.ViewXml = query.ToString();
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">var</span> items = ordersList.GetItems(camlQuery);
</span></span></code></pre></div><p>This CAMLEX query automatically generates the following CAML XML - notice how complex the raw XML is compared to the clean C# syntax above:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#f92672">&lt;View&gt;</span>
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&lt;Query&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;Where&gt;</span>
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&lt;Geq&gt;</span>
</span></span><span style="display:flex;"><span>        <span style="color:#f92672">&lt;FieldRef</span> <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;customerName&#34;</span> <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>        <span style="color:#f92672">&lt;Value</span> <span style="color:#a6e22e">Type=</span><span style="color:#e6db74">&#34;Text&#34;</span><span style="color:#f92672">&gt;</span>Contoso<span style="color:#f92672">&lt;/Value&gt;</span>
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&lt;/Geq&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;/Where&gt;</span>
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&lt;/Query&gt;</span>
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&lt;ViewFields&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;FieldRef</span> <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;Id&#34;</span> <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;FieldRef</span> <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;customerNo&#34;</span> <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;FieldRef</span> <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;customerName&#34;</span> <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&lt;/ViewFields&gt;</span>
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&lt;Joins&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;Join</span> <span style="color:#a6e22e">Type=</span><span style="color:#e6db74">&#34;LEFT&#34;</span> <span style="color:#a6e22e">ListAlias=</span><span style="color:#e6db74">&#34;0f0cfc71-1c6e-4fd4-b6f2-279d0e3862f4&#34;</span><span style="color:#f92672">&gt;</span>
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&lt;Eq&gt;</span>
</span></span><span style="display:flex;"><span>        <span style="color:#f92672">&lt;FieldRef</span> <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;OrderTaskLookUp&#34;</span> <span style="color:#a6e22e">RefType=</span><span style="color:#e6db74">&#34;Id&#34;</span> <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>        <span style="color:#f92672">&lt;FieldRef</span> <span style="color:#a6e22e">List=</span><span style="color:#e6db74">&#34;0f0cfc71-1c6e-4fd4-b6f2-279d0e3862f4&#34;</span> <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;Id&#34;</span> <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&lt;/Eq&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;/Join&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;Join</span> <span style="color:#a6e22e">Type=</span><span style="color:#e6db74">&#34;LEFT&#34;</span> <span style="color:#a6e22e">ListAlias=</span><span style="color:#e6db74">&#34;ce57b9a2-5052-482c-a8c8-150c7d59ced3&#34;</span><span style="color:#f92672">&gt;</span>
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&lt;Eq&gt;</span>
</span></span><span style="display:flex;"><span>        <span style="color:#f92672">&lt;FieldRef</span> <span style="color:#a6e22e">List=</span><span style="color:#e6db74">&#34;0f0cfc71-1c6e-4fd4-b6f2-279d0e3862f4&#34;</span> <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;OrderDetailLookUp&#34;</span> <span style="color:#a6e22e">RefType=</span><span style="color:#e6db74">&#34;Id&#34;</span> <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>        <span style="color:#f92672">&lt;FieldRef</span> <span style="color:#a6e22e">List=</span><span style="color:#e6db74">&#34;ce57b9a2-5052-482c-a8c8-150c7d59ced3&#34;</span> <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;Id&#34;</span> <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&lt;/Eq&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;/Join&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;Join</span> <span style="color:#a6e22e">Type=</span><span style="color:#e6db74">&#34;LEFT&#34;</span> <span style="color:#a6e22e">ListAlias=</span><span style="color:#e6db74">&#34;e204ed0f-7c25-432f-9228-3eb438c527e2&#34;</span><span style="color:#f92672">&gt;</span>
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&lt;Eq&gt;</span>
</span></span><span style="display:flex;"><span>        <span style="color:#f92672">&lt;FieldRef</span> <span style="color:#a6e22e">List=</span><span style="color:#e6db74">&#34;ce57b9a2-5052-482c-a8c8-150c7d59ced3&#34;</span> <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;CustomerLookUp&#34;</span> <span style="color:#a6e22e">RefType=</span><span style="color:#e6db74">&#34;Id&#34;</span> <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>        <span style="color:#f92672">&lt;FieldRef</span> <span style="color:#a6e22e">List=</span><span style="color:#e6db74">&#34;e204ed0f-7c25-432f-9228-3eb438c527e2&#34;</span> <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;Id&#34;</span> <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>      <span style="color:#f92672">&lt;/Eq&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;/Join&gt;</span>
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&lt;/Joins&gt;</span>
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&lt;ProjectedFields&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;Field</span> 
</span></span><span style="display:flex;"><span>      <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;customerNo&#34;</span> 
</span></span><span style="display:flex;"><span>      <span style="color:#a6e22e">Type=</span><span style="color:#e6db74">&#34;Lookup&#34;</span> 
</span></span><span style="display:flex;"><span>      <span style="color:#a6e22e">List=</span><span style="color:#e6db74">&#34;e204ed0f-7c25-432f-9228-3eb438c527e2&#34;</span> 
</span></span><span style="display:flex;"><span>      <span style="color:#a6e22e">ShowField=</span><span style="color:#e6db74">&#34;customerNo&#34;</span> 
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">&lt;Field</span> 
</span></span><span style="display:flex;"><span>      <span style="color:#a6e22e">Name=</span><span style="color:#e6db74">&#34;customerName&#34;</span> 
</span></span><span style="display:flex;"><span>      <span style="color:#a6e22e">Type=</span><span style="color:#e6db74">&#34;Lookup&#34;</span> 
</span></span><span style="display:flex;"><span>      <span style="color:#a6e22e">List=</span><span style="color:#e6db74">&#34;e204ed0f-7c25-432f-9228-3eb438c527e2&#34;</span> 
</span></span><span style="display:flex;"><span>      <span style="color:#a6e22e">ShowField=</span><span style="color:#e6db74">&#34;customerName&#34;</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">/&gt;</span>
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">&lt;/ProjectedFields&gt;</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">&lt;/View&gt;</span>
</span></span></code></pre></div><p>Imagine having to write and maintain that XML manually! This is exactly why CAMLEX is so valuable - you get all the power of CAML joins with readable C# syntax.</p>
<h2 id="performance-benefits">Performance Benefits</h2>
<p><strong>Before (Multiple queries):</strong></p>
<ul>
<li>🔴 6+ resource units</li>
<li>🔴 Multiple network calls</li>
<li>🔴 Complex C# merging logic</li>
</ul>
<p><strong>After (Single join):</strong></p>
<ul>
<li>✅ 2 resource units only</li>
<li>✅ One network call</li>
<li>✅ Server-side joining</li>
</ul>
<h2 id="key-takeaways">Key Takeaways</h2>
<ul>
<li><strong>Use joins instead of multiple queries</strong> to reduce resource consumption</li>
<li><strong>CAMLEX makes CAML readable</strong> for you and the next developer</li>
<li><strong>You can filter on joined data</strong> even multiple lists away</li>
<li><strong>SharePoint UI limitations ≠ API limitations</strong> - joins work even if the UI doesn&rsquo;t show it</li>
</ul>
<h2 id="common-issues--solutions">Common Issues &amp; Solutions</h2>
<p><strong>❌ &ldquo;List does not exist&rdquo; error</strong></p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// Use list GUIDs instead of names for reliability</span>
</span></span><span style="display:flex;"><span>.ForeignList(<span style="color:#66d9ef">new</span> Guid(<span style="color:#e6db74">&#34;12345678-1234-1234-1234-123456789012&#34;</span>))
</span></span></code></pre></div><p><strong>❌ &ldquo;Field not found&rdquo; error</strong></p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-csharp" data-lang="csharp"><span style="display:flex;"><span><span style="color:#75715e">// Use internal field names, not display names</span>
</span></span><span style="display:flex;"><span>.ShowField(<span style="color:#e6db74">&#34;Title&#34;</span>)        <span style="color:#75715e">// ✅ Internal name</span>
</span></span><span style="display:flex;"><span>.ShowField(<span style="color:#e6db74">&#34;Customer Name&#34;</span>) <span style="color:#75715e">// ❌ Display name</span>
</span></span></code></pre></div><p><strong>❌ Join returns no data</strong></p>
<ul>
<li>Verify lookup columns exist and are properly configured</li>
<li>Check that you&rsquo;re joining on the correct fields</li>
<li>Ensure the lookup field contains valid IDs</li>
</ul>
<p><strong>❌ &ldquo;Cannot project this field type&rdquo; error</strong></p>
<p>Only specific field types can be included in ProjectedFields:</p>
<p>✅ Supported ProjectedFields types:</p>
<ul>
<li>Calculated (treated as plain text)</li>
<li>ContentTypeId</li>
<li>Counter</li>
<li>Currency</li>
<li>DateTime</li>
<li>Guid</li>
<li>Integer</li>
<li>Note (one-line only)</li>
<li>Number</li>
<li>Text</li>
</ul>
<p>❌ NOT supported in ProjectedFields:</p>
<ul>
<li>Multi-line text fields</li>
<li>Rich text fields</li>
<li>Choice fields</li>
<li>Lookup fields (use joins instead)</li>
<li>User/Person fields</li>
<li>Managed metadata fields</li>
</ul>
<p><strong>💡 Pro tip:</strong> If you need data from unsupported field types, query them separately after getting your joined results.</p>
<p>CAML joins are one of five techniques in <a href="https://jeppe-spanggaard.dk/blogs/sharepoint-csom-performance-playbook/">The SharePoint CSOM Performance Playbook</a>, which covers when a join is the right answer and when batching or change detection would serve you better.</p>
]]></content:encoded></item></channel></rss>