andrzej
/
devlog
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

edits

This commit is contained in:
andrzej 2024-11-15 00:49:17 +01:00
parent 17e481db14
commit 65ecffc583
3 changed files with 52 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
content/posts/hard-problem.md
View File

@ -8,49 +8,55 @@ title = 'Hard Problem? Invalidating the browser cache'
I pushed some changes incorporating images for the first time (I know, very swish), and everything seemed to be working just fine, but when I loaded the production site in Firefox, the images were not styled. Stranger still, they *were* styled when I loaded the same page in Chrome. I pushed some changes incorporating images for the first time (I know, very swish), and everything seemed to be working just fine, but when I loaded the production site in Firefox, the images were not styled. Stranger still, they *were* styled when I loaded the same page in Chrome.
The experienced computer touchers amongst you will be saying "this is obviously a cache problem", and you're right, it is obviously a cache problem. Pressing `CTR + SHIFT + R` (which forces Firefox to clear the cache and do a full reload) proved this thesis, and solved the problem handily for me, on my machine. But what about other people's machines? The experienced computer touchers amongst you will be saying "this is obviously a cache problem", and you're right, it is obviously a cache problem. Pressing `CTR + SHIFT + R` (which forces Firefox to clear the cache and do a full reload) proved this thesis, and solved the problem handily for me, on my machine. But what about other people's machines? I need to cache-bust.
Post-processors such as Tailwind use fancy 'fingerprinting' techniques for this, but I want something simpler than that for this project. Something I can code myself, and understand at a deep level.
## Invalidating cached HTML ## Invalidating cached HTML
The best way to deal with this problem is to tell the browser not to cache our HTML in the first place. We can achieve this by adding the following meta tag to `index.html`, and any other HTML files we don't want cached. The best way to deal with the caching problem is to tell the browser not to cache our HTML in the first place. Yes, this is kind of (100%) cheating, but c'mon bro, it's just one little HTML file --- browsers only cache those because most websites these days are glorified SPAs where the HTML rarely changes.
I can stop the HTML getting cached by by adding the following meta tag, in this case to `index.html`.
```html ```html
<meta http-equiv="pragma" content="no-cache" /> <meta http-equi"pragma" content="no-cache" />
``` ```
## Invalidating cached CSS ## Invalidating cached CSS
What we need is for the browser to recognize our CSS as a new file and load it anew from the server. We could change the file name whenever we want to bust the cache, but this would get tedious very quickly. What's more, as far as Git is concerned, we'd be deleting the CSS file and writing a new one with every deployment. Surely there's a better way? That's all well and good, but what I really need is for the browser to recognize my CSS as a new file and load it anew from the server. I could change the file name whenever I want to bust the cache, but this would get tedious very quickly. What's more, as far as Git is concerned, I'd be deleting the CSS file and writing a new one with every deployment. Surely there's a better way?
### Using a query ### Using a query
Of course there is. Look at this: Of course there is. Look at this:
```html ```html
<link rel="stylesheet" href="css/defaults.css?v=2"/> <link rel="stylesheet" href="css/defaults.css?2"/>
``` ```
As we're requesting the file via http, we can append a query. Awesome. Not awesome enough though. I'm too lazy to do this every time I push a commit, and, being human, I'll probably forget at a critical moment. This can only mean one thing. It's time to bash (🤣) out a quick build script! As I'm requesting the file via http, I can append a query. Awesome. Not awesome enough though. I'm too lazy to do this every time I push a commit, and, being human, I'll probably forget at a critical moment. This can only mean one thing. It's time to bash (🤣) out a quick build script.
### Automating query insertion
```bash ```bash
#!/usr/bin/env bash #!/usr/bin/env bash
COMMIT="$(git rev-parse HEAD)" COMMIT="$(git rev-parse HEAD)"
sed -i "s/css?=\w*/css?v=${COMMIT}/g" index.html sed -i "s/css?=\w*/css?${COMMIT}/g" index.html
``` ```
Let's talk real quick about what's happening here: Let's talk real quick about what's happening here:
`COMMIT="$(git rev-parse HEAD)"` gets the commit id from Git and assigns it the variable `$COMMIT`. `COMMIT="$(git rev-parse HEAD)"` gets the commit id from Git and assigns it to the variable `$COMMIT`.
Then, `sed -i "s/css?=\w*/css?v=${COMMIT}/g" index.html` does a find and replace on `index.html`. The regular expression `css?=\w*` matches 'css?=' plus any number of contiguous alphanumeric characters (everything until the next quote mark, basically) before replacing these alphanumeric characters with the commit id. The flag `-i` tells sed to edit the file in place. The `g` tells it to perform the operation on the whole file. Then, `sed -i "s/css?=\w*/css?${COMMIT}/g" index.html` does a find and replace on `index.html`. The regular expression `css?=\w*` matches 'css?=' plus any number of contiguous alphanumeric characters (everything until the next quote mark, basically) before replacing these alphanumeric characters with the commit id. The flag `-i` tells sed to edit the file in place. The `g` tells it to perform the operation on the whole file.
Now, whenever we push a new commit, any CSS imports in `index.html` will be changed to something like this: Now, whenever we push a new commit, any CSS imports in `index.html` will be changed to something like this:
```html ```html
<link rel="stylesheet" <link rel="stylesheet"
href="css/styles.css?v=ab10c24280844c10c10c1adfb8b85b03b316f72b" href="css/styles.css?ab10c24280844c10c10c1adfb8b85b03b316f72b"
/> />
``` ```
Now I just need to add the build script to my Jenkinsfile, and the problem is solved.
Pretty neat, huh? Pretty neat, huh?

23
public/css/main.css
View File

@ -55,17 +55,31 @@
} }
} }
html {
width: 100vw;
}
body { body {
background-color: var(--rp-base); background-color: var(--rp-base);
color: var(--rp-text); color: var(--rp-text);
font-family: sans-serif; font-family: sans-serif;
line-height: 1.5; line-height: 1.5;
margin: 1rem; margin: 1rem;
max-width: 768px; width: 100%;
display: flex;
flex-direction: column;
justify-items: center;
}
main {
margin: auto;
max-width: 780px;
width: fit;
padding: 0 1em 0 1em;
} }
strong { strong {
color: var(--rp-rose); color: var(--rp-iris);
} }
em { em {
@ -102,6 +116,10 @@ h1 {
text-shadow: 1px 1px 2px black; text-shadow: 1px 1px 2px black;
} }
time {
color: var(--rp-gold);
}
code { code {
background: var(--rp-surface); background: var(--rp-surface);
@ -109,6 +127,7 @@ code {
padding: 0.3em; padding: 0.3em;
border-radius: 1em; border-radius: 1em;
font-size: 1.2em; font-size: 1.2em;
font-style: oblique;
span { span {
background: var(--rp-surface); background: var(--rp-surface);

26
public/posts/hard-problem/index.html
View File

@ -44,27 +44,31 @@
<p><strong>I had a bit of an issue with my <a href="https://demos.ajstepien.xyz">website</a> recently.</strong></p> <p><strong>I had a bit of an issue with my <a href="https://demos.ajstepien.xyz">website</a> recently.</strong></p>
<p>I pushed some changes incorporating images for the first time (I know, very swish), and everything seemed to be working just fine, but when I loaded the production site in Firefox, the images were not styled. Stranger still, they <em>were</em> styled when I loaded the same page in Chrome.</p> <p>I pushed some changes incorporating images for the first time (I know, very swish), and everything seemed to be working just fine, but when I loaded the production site in Firefox, the images were not styled. Stranger still, they <em>were</em> styled when I loaded the same page in Chrome.</p>
<p>The experienced computer touchers amongst you will be saying &ldquo;this is obviously a cache problem&rdquo;, and you&rsquo;re right, it is obviously a cache problem. Pressing <code>CTR + SHIFT + R</code> (which forces Firefox to clear the cache and do a full reload) proved this thesis, and solved the problem handily for me, on my machine. But what about other people&rsquo;s machines?</p> <p>The experienced computer touchers amongst you will be saying &ldquo;this is obviously a cache problem&rdquo;, and you&rsquo;re right, it is obviously a cache problem. Pressing <code>CTR + SHIFT + R</code> (which forces Firefox to clear the cache and do a full reload) proved this thesis, and solved the problem handily for me, on my machine. But what about other people&rsquo;s machines? I need to cache-bust.</p>
<p>Post-processors such as Tailwind use fancy &lsquo;fingerprinting&rsquo; techniques for this, but I want something simpler than that for this project. Something I can code myself, and understand at a deep level.</p>
<h2 id="invalidating-cached-html">Invalidating cached HTML</h2> <h2 id="invalidating-cached-html">Invalidating cached HTML</h2>
<p>The best way to deal with this problem is to tell the browser not to cache our HTML in the first place. We can achieve this by adding the following meta tag to <code>index.html</code>, and any other HTML files we don&rsquo;t want cached.</p> <p>The best way to deal with the caching problem is to tell the browser not to cache our HTML in the first place. Yes, this is kind of (100%) cheating, but c&rsquo;mon bro, it&rsquo;s just one little HTML file &mdash; browsers only cache those because most websites these days are glorified SPAs where the HTML rarely changes.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"> <span class="p">&lt;</span><span class="nt">meta</span> <span class="na">http-equiv</span><span class="o">=</span><span class="s">&#34;pragma&#34;</span> <span class="na">content</span><span class="o">=</span><span class="s">&#34;no-cache&#34;</span> <span class="p">/&gt;</span> <p>I can stop the HTML getting cached by by adding the following meta tag, in this case to <code>index.html</code>.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"> <span class="p">&lt;</span><span class="nt">meta</span> <span class="na">http-equi</span><span class="err">&#34;</span><span class="na">pragma</span><span class="err">&#34;</span> <span class="na">content</span><span class="o">=</span><span class="s">&#34;no-cache&#34;</span> <span class="p">/&gt;</span>
</span></span></code></pre></div><h2 id="invalidating-cached-css">Invalidating cached CSS</h2> </span></span></code></pre></div><h2 id="invalidating-cached-css">Invalidating cached CSS</h2>
<p>What we need is for the browser to recognize our CSS as a new file and load it anew from the server. We could change the file name whenever we want to bust the cache, but this would get tedious very quickly. What&rsquo;s more, as far as Git is concerned, we&rsquo;d be deleting the CSS file and writing a new one with every deployment. Surely there&rsquo;s a better way?</p> <p>That&rsquo;s all well and good, but what I really need is for the browser to recognize my CSS as a new file and load it anew from the server. I could change the file name whenever I want to bust the cache, but this would get tedious very quickly. What&rsquo;s more, as far as Git is concerned, I&rsquo;d be deleting the CSS file and writing a new one with every deployment. Surely there&rsquo;s a better way?</p>
<h3 id="using-a-query">Using a query</h3> <h3 id="using-a-query">Using a query</h3>
<p>Of course there is. Look at this:</p> <p>Of course there is. Look at this:</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p">&lt;</span><span class="nt">link</span> <span class="na">rel</span><span class="o">=</span><span class="s">&#34;stylesheet&#34;</span> <span class="na">href</span><span class="o">=</span><span class="s">&#34;css/defaults.css?v=2&#34;</span><span class="p">/&gt;</span> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p">&lt;</span><span class="nt">link</span> <span class="na">rel</span><span class="o">=</span><span class="s">&#34;stylesheet&#34;</span> <span class="na">href</span><span class="o">=</span><span class="s">&#34;css/defaults.css?2&#34;</span><span class="p">/&gt;</span>
</span></span></code></pre></div><p>As we&rsquo;re requesting the file via http, we can append a query. Awesome. Not awesome enough though. I&rsquo;m too lazy to do this every time I push a commit, and, being human, I&rsquo;ll probably forget at a critical moment. This can only mean one thing. It&rsquo;s time to bash (🤣) out a quick build script!</p> </span></span></code></pre></div><p>As I&rsquo;m requesting the file via http, I can append a query. Awesome. Not awesome enough though. I&rsquo;m too lazy to do this every time I push a commit, and, being human, I&rsquo;ll probably forget at a critical moment. This can only mean one thing. It&rsquo;s time to bash (🤣) out a quick build script.</p>
<h3 id="automating-query-insertion">Automating query insertion</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl"><span class="cp">#!/usr/bin/env bash <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl"><span class="cp">#!/usr/bin/env bash
</span></span></span><span class="line"><span class="cl"><span class="cp"></span><span class="nv">COMMIT</span><span class="o">=</span><span class="s2">&#34;</span><span class="k">$(</span>git rev-parse HEAD<span class="k">)</span><span class="s2">&#34;</span> </span></span></span><span class="line"><span class="cl"><span class="cp"></span><span class="nv">COMMIT</span><span class="o">=</span><span class="s2">&#34;</span><span class="k">$(</span>git rev-parse HEAD<span class="k">)</span><span class="s2">&#34;</span>
</span></span><span class="line"><span class="cl">sed -i <span class="s2">&#34;s/css?=\w*/css?v=</span><span class="si">${</span><span class="nv">COMMIT</span><span class="si">}</span><span class="s2">/g&#34;</span> index.html </span></span><span class="line"><span class="cl">sed -i <span class="s2">&#34;s/css?=\w*/css?</span><span class="si">${</span><span class="nv">COMMIT</span><span class="si">}</span><span class="s2">/g&#34;</span> index.html
</span></span></code></pre></div><p>Let&rsquo;s talk real quick about what&rsquo;s happening here:</p> </span></span></code></pre></div><p>Let&rsquo;s talk real quick about what&rsquo;s happening here:</p>
<p><code>COMMIT=&quot;$(git rev-parse HEAD)&quot;</code> gets the commit id from Git and assigns it the variable <code>$COMMIT</code>.</p> <p><code>COMMIT=&quot;$(git rev-parse HEAD)&quot;</code> gets the commit id from Git and assigns it to the variable <code>$COMMIT</code>.</p>
<p>Then, <code>sed -i &quot;s/css?=\w*/css?v=${COMMIT}/g&quot; index.html</code> does a find and replace on <code>index.html</code>. The regular expression <code>css?=\w*</code> matches &lsquo;css?=&rsquo; plus any number of contiguous alphanumeric characters (everything until the next quote mark, basically) before replacing these alphanumeric characters with the commit id. The flag <code>-i</code> tells sed to edit the file in place. The <code>g</code> tells it to perform the operation on the whole file.</p> <p>Then, <code>sed -i &quot;s/css?=\w*/css?${COMMIT}/g&quot; index.html</code> does a find and replace on <code>index.html</code>. The regular expression <code>css?=\w*</code> matches &lsquo;css?=&rsquo; plus any number of contiguous alphanumeric characters (everything until the next quote mark, basically) before replacing these alphanumeric characters with the commit id. The flag <code>-i</code> tells sed to edit the file in place. The <code>g</code> tells it to perform the operation on the whole file.</p>
<p>Now, whenever we push a new commit, any CSS imports in <code>index.html</code> will be changed to something like this:</p> <p>Now, whenever we push a new commit, any CSS imports in <code>index.html</code> will be changed to something like this:</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p">&lt;</span><span class="nt">link</span> <span class="na">rel</span><span class="o">=</span><span class="s">&#34;stylesheet&#34;</span> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p">&lt;</span><span class="nt">link</span> <span class="na">rel</span><span class="o">=</span><span class="s">&#34;stylesheet&#34;</span>
</span></span><span class="line"><span class="cl"><span class="na">href</span><span class="o">=</span><span class="s">&#34;css/styles.css?v=ab10c24280844c10c10c1adfb8b85b03b316f72b&#34;</span> </span></span><span class="line"><span class="cl"><span class="na">href</span><span class="o">=</span><span class="s">&#34;css/styles.css?ab10c24280844c10c10c1adfb8b85b03b316f72b&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">/&gt;</span> </span></span><span class="line"><span class="cl"><span class="p">/&gt;</span>
</span></span></code></pre></div><p>Pretty neat, huh?</p> </span></span></code></pre></div><p>Now I just need to add the build script to my Jenkinsfile, and the problem is solved.</p>
<p>Pretty neat, huh?</p>
<p>There&rsquo;s just one thing bugging me: surely I do actually want the CSS to be cached <em>sometimes</em>. Caching exists for a reason, and I don&rsquo;t want to sacrifice performance. Maybe I can modify the build script so that it only updates the CSS imports when the CSS files have changed&hellip; Sounds like a topic for another blogpost&hellip;</p> <p>There&rsquo;s just one thing bugging me: surely I do actually want the CSS to be cached <em>sometimes</em>. Caching exists for a reason, and I don&rsquo;t want to sacrifice performance. Maybe I can modify the build script so that it only updates the CSS imports when the CSS files have changed&hellip; Sounds like a topic for another blogpost&hellip;</p>