Skip to content

Commit 8446414

Browse files
committed
docs
1 parent 476f68a commit 8446414

File tree

5 files changed

+62
-8
lines changed

5 files changed

+62
-8
lines changed

readme.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,6 @@ Effectively consumers will always receive the most current data, while the load
3131
* Postgres: [track_commit_timestamp](https://www.postgresql.org/docs/17/runtime-config-replication.html#GUC-TRACK-COMMIT-TIMESTAMP) is enabled. This can be done using `ALTER SYSTEM SET track_commit_timestamp to "on"` and then restarting the Postgres service
3232

3333

34-
## Certificates and Chromium
35-
36-
Chromium, and hence the Chrome and Edge browsers, are very sensitive to certificate problems when determining if an item should be cached. Specifically, if a request is done dynamically (type: xhr) and the server is using a self-signed certificate, then the browser will not send the `if-none-match` header. [Reference]( https://issues.chromium.org/issues/40666473). If self-signed certificates are required during development in lower environment, then use FireFox to test the caching behavior.
37-
3834

3935
## 304 Not Modified Flow
4036

@@ -759,6 +755,37 @@ alter table [{table}] disable change_tracking;
759755
<!-- endSnippet -->
760756

761757

758+
## Verifying behavior
759+
760+
The behavior of Delta can be verified as follows:
761+
762+
* Open a page in the site
763+
* Open the browser developer tools
764+
* Change to the Network tab
765+
* Refresh the page.
766+
767+
Cached responses will show as 304 in the `Status`:
768+
769+
<img src="/src/network.png">
770+
771+
In the headers `if-none-match` will show in the request and `etag` will show in the response:
772+
773+
<img src="/src/network-details.png">
774+
775+
776+
### Ensure cache is not disabled
777+
778+
If disable cache is checked, the browser will not send the `if-none-match` header. This will effectively cause a cache miss server side, and the full server pipeline will execute.
779+
780+
<img src="/src/disable-cache.png">
781+
782+
783+
### Certificates and Chromium
784+
785+
Chromium, and hence the Chrome and Edge browsers, are very sensitive to certificate problems when determining if an item should be cached. Specifically, if a request is done dynamically (type: xhr) and the server is using a self-signed certificate, then the browser will not send the `if-none-match` header. [Reference]( https://issues.chromium.org/issues/40666473). If self-signed certificates are required during development in lower environment, then use FireFox to test the caching behavior.
786+
787+
788+
762789
## Programmatic client usage
763790

764791
Delta is primarily designed to support web browsers as a client. All web browsers have the necessary 304 and caching functionally required.

readme.source.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,6 @@ Effectively consumers will always receive the most current data, while the load
2424
* Postgres: [track_commit_timestamp](https://www.postgresql.org/docs/17/runtime-config-replication.html#GUC-TRACK-COMMIT-TIMESTAMP) is enabled. This can be done using `ALTER SYSTEM SET track_commit_timestamp to "on"` and then restarting the Postgres service
2525

2626

27-
## Certificates and Chromium
28-
29-
Chromium, and hence the Chrome and Edge browsers, are very sensitive to certificate problems when determining if an item should be cached. Specifically, if a request is done dynamically (type: xhr) and the server is using a self-signed certificate, then the browser will not send the `if-none-match` header. [Reference]( https://issues.chromium.org/issues/40666473). If self-signed certificates are required during development in lower environment, then use FireFox to test the caching behavior.
30-
3127

3228
## 304 Not Modified Flow
3329

@@ -317,6 +313,37 @@ snippet: EnableTrackingTableSql
317313
snippet: DisableTrackingTableSql
318314

319315

316+
## Verifying behavior
317+
318+
The behavior of Delta can be verified as follows:
319+
320+
* Open a page in the site
321+
* Open the browser developer tools
322+
* Change to the Network tab
323+
* Refresh the page.
324+
325+
Cached responses will show as 304 in the `Status`:
326+
327+
<img src="/src/network.png">
328+
329+
In the headers `if-none-match` will show in the request and `etag` will show in the response:
330+
331+
<img src="/src/network-details.png">
332+
333+
334+
### Ensure cache is not disabled
335+
336+
If disable cache is checked, the browser will not send the `if-none-match` header. This will effectively cause a cache miss server side, and the full server pipeline will execute.
337+
338+
<img src="/src/disable-cache.png">
339+
340+
341+
### Certificates and Chromium
342+
343+
Chromium, and hence the Chrome and Edge browsers, are very sensitive to certificate problems when determining if an item should be cached. Specifically, if a request is done dynamically (type: xhr) and the server is using a self-signed certificate, then the browser will not send the `if-none-match` header. [Reference]( https://issues.chromium.org/issues/40666473). If self-signed certificates are required during development in lower environment, then use FireFox to test the caching behavior.
344+
345+
346+
320347
## Programmatic client usage
321348

322349
Delta is primarily designed to support web browsers as a client. All web browsers have the necessary 304 and caching functionally required.

src/disable-cache.png

2.87 KB
Loading

src/network-details.png

33 KB
Loading

src/network.png

14.8 KB
Loading

0 commit comments

Comments
 (0)