Skip to content

Commit

Permalink
Implement cache max age (#37)
Browse files Browse the repository at this point in the history
* chore: deps

* chore: deps svelte demo app

* feat: cachetime command line option
  • Loading branch information
BCsabaEngine authored Jan 6, 2025
1 parent 006c251 commit cbbe0f8
Show file tree
Hide file tree
Showing 14 changed files with 463 additions and 392 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change log

## 1.7

### 1.7.0

- Using the cachetime command line option, you can set whether the browser can cache pages. Together with the ETag switch, you can replace the default no-cache response with a max-age=xy response.

## 1.6

### 1.6.1
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ In order to be able to easily update OTA, it is important - from the users' poin

This npm package provides a solution for **inserting any JS client application into the ESP web server** (PsychicHttp and also ESPAsyncWebServer available, PsychicHttp is the default). For this, JS, html, css, font, assets, etc. files must be converted to binary byte array. Npm mode is easy to use and easy to **integrate into your CI/CD pipeline**.

> Starting with version v1.7.0, with the cachetime command line option, you can set whether the browser can cache pages
> Starting with version v1.6.0, mime npm package is used instead of mime-types (application/javascript -> text/javascript)
> Starting with version v1.5.0, PsychicHttp v2 is also supported.
Expand Down Expand Up @@ -176,6 +178,12 @@ The use of ETag is **not enabled by default**, this can be achieved with the `--

> This setting has three states: yes, no, and compiler mode is available. In compiler mode, you can disable/enable ETag by setting the `SVELTEESP32_ENABLE_ETAG` c++ compiler directive. For example, if using platformio, just type `-D SVELTEESP32_ENABLE_ETAG`.
### Cache-control

By default (when using the ETag), we send no-cache in the cache-control header of the HTTP response. Pages, subpages and other elements are downloaded every time. This is perfectly acceptable when serving small pages with ESP.

At the same time, it can be an advantage that the content is cached by the browser and not even the ETag check is performed. For this, you can specify how many seconds the max-age value sent instead of no-cache should be. In the case of `--cachetime=86400` (max-age=86400), the page (and other elements) will not be downloaded by the browser **for one day**.

### Main entry point - index.html

Typically, the entry point for web applications is the **index.htm or index.html** file. This does not need to be listed in the browser's address bar because web servers know that this file should be served by default. Svelteesp32 also does this: if there is an index.htm or index.html file, it sets it as the main file to be served. So using `http://esp_xxx.local` or just entering the `http://x.y.w.z/` IP address will serve this main file.
Expand Down Expand Up @@ -230,6 +238,7 @@ You can use the following c++ directives at the project level if you want to con
| `-e` | The engine for which the include file is created (psychic/psychic2/async) | psychic |
| `-o` | Generated output file with path | `svelteesp32.h` |
| `--etag` | Use ETag header for cache (true/false/compiler) | false |
| `--cachetime` | Override no-cache response with a max-age=<cachetime> response | 0 |
| `--gzip` | Compress content with gzip (true/false/compiler) | true |
| `--created` | Include creation time | false |
| `--version` | Include a version string, `--version=v$npm_package_version` | '' |
Expand Down
1 change: 1 addition & 0 deletions demo/esp32/platformio.ini
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[env]
platform = espressif32
board = wemos_d1_mini32
#board = lolin_s3_mini
framework = arduino


Expand Down
1 change: 1 addition & 0 deletions demo/svelte/dist/assets/index-BC9dsMQQ.js

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion demo/svelte/dist/assets/index-DiIOlAIu.js

This file was deleted.

Binary file modified demo/svelte/dist/favicon.png.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion demo/svelte/dist/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>Svelte to ESP32 demo application</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#f3f4f6" />
<script type="module" crossorigin src="./assets/index-DiIOlAIu.js"></script>
<script type="module" crossorigin src="./assets/index-BC9dsMQQ.js"></script>
<link rel="stylesheet" crossorigin href="./assets/index-CMpKda2x.css">
</head>

Expand Down
Loading

0 comments on commit cbbe0f8

Please sign in to comment.