paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 45 Packages Projects Releases Wiki Activity

1. Use etag over sha for the identifier

Browse Source 
2. Re-combine Resonse types into one
This commit is contained in:
Himanshu Mishra
2021-01-18 22:50:47 +01:00
parent 79f9a97428
commit 8565ad2279
17 changed files with 124 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/khaki-icons-trade.md
+7 -3
View File
@@ -2,7 +2,11 @@
'@backstage/backend-common': patch
---
1. URL Reader's `readTree` method now returns a `sha` in the response along with the blob. The SHA belongs to the latest commit on the target. `readTree` also takes an optional `sha` in its options and throws a `NotModifiedError` if the SHA matches with the latest commit SHA on the url's target. This can be used in building a cache when working with URL Reader.
1. URL Reader's `readTree` method now returns an `etag` in the response along with the blob. The etag is an identifier of the blob and will only change if the blob is modified on the target. Usually it is set to the latest commit SHA on the target.
`readTree` also takes an optional `etag` in its options and throws a `NotModifiedError` if the etag matches with the etag of the resource.
So, the `etag` can be used in building a cache when working with URL Reader.
An example -
@@ -11,11 +15,11 @@ const response = await reader.readTree(
'https://github.com/backstage/backstage',
);
const commitSha = response.sha;
const etag = response.etag;
// Will throw a new NotModifiedError (exported from @backstage/backstage-common)
await reader.readTree('https://github.com/backstage/backstage', {
sha: commitSha,
etag,
});
```