Is there a way to add a cache buster to the RenderFormScripts Html helper function?

Question

In our outerlayout.cshtml file we have the following code:

@Html.RenderFormScripts()

which seems to loop round the JS files, that have been attached to the Sitecore form:

and create script tags for each of them in the finally outputted HTML.

Does anyone know of a way where we can add a cache buster to this functionality so that we don't have to remember to manually update the attached JS file references every time one of the source JS files changes ?

We have other areas, of the site, where JS files have cache busting on them by having a buildNumber parameter, which is incremented every time the source code is deployed to PROD, and then injecting this parameter into the script tag but it seems like we need to customise what the RenderFormScripts function does

Answer 1

You can override IncludeFiles processor of forms.renderForm pipeline and add custom parameter for all the scripts (or styles). Class below adds DateTime.Now.Ticks to scripts only. You can use your own logic there to include desired cache buster:

public class IncludeFiles : Sitecore.ExperienceForms.Mvc.Pipelines.RenderForm.IncludeFiles
{
    protected override void IncludePath(HttpContextBase httpContext, string filePath, bool script)
    {
        var filePathWithCacheInfo = script ? $"{filePath}?{DateTime.Now.Ticks}" : filePath;
        base.IncludePath(httpContext, filePathWithCacheInfo, script);
    }
}

Remember to register your class with patch file:

<?xml version="1.0" encoding="utf-8"?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
    <sitecore>
        <pipelines>
            <forms.renderForm>
                <processor type="Sitecore.ExperienceForms.Mvc.Pipelines.RenderForm.IncludeFiles, Sitecore.ExperienceForms.Mvc">
                    <patch:attribute name="type">MyAssembly.MyNamespace.IncludeFiles, MyAssembly</patch:attribute>
                </processor>
            </forms.renderForm>
        </pipelines>
    </sitecore>
</configuration>