Compare commits
1 Commits
main
...
f84378c426
| Author | SHA1 | Date | |
|---|---|---|---|
| f84378c426 |
14
Makefile
14
Makefile
@@ -23,19 +23,13 @@ lint:
|
|||||||
|
|
||||||
# Refresh the vendored dataset from the BlogsURL constant in hnblogs.go, which
|
# Refresh the vendored dataset from the BlogsURL constant in hnblogs.go, which
|
||||||
# is the single source of truth for the upstream location. The download lands
|
# is the single source of truth for the upstream location. The download lands
|
||||||
# on a temporary file and only replaces blogs.json once it has been checked to
|
# on a temporary file and only replaces blogs.json once it is complete, so an
|
||||||
# be a non-empty JSON array of blog entries, so neither an interrupted transfer
|
# interrupted fetch cannot leave a truncated dataset committed.
|
||||||
# nor a complete-but-wrong response (an error page, a redirect landing page)
|
|
||||||
# can overwrite the good dataset.
|
|
||||||
update-data:
|
update-data:
|
||||||
@command -v jq >/dev/null || { echo "update-data requires jq" >&2; exit 1; }
|
|
||||||
@url=$$(sed -n 's/^const BlogsURL = "\(.*\)"$$/\1/p' hnblogs.go); \
|
@url=$$(sed -n 's/^const BlogsURL = "\(.*\)"$$/\1/p' hnblogs.go); \
|
||||||
test -n "$$url" || { echo "could not parse BlogsURL from hnblogs.go" >&2; exit 1; }; \
|
test -n "$$url" || { echo "could not parse BlogsURL from hnblogs.go" >&2; exit 1; }; \
|
||||||
echo "downloading $$url"; \
|
echo "fetching $$url"; \
|
||||||
curl -fsSL "$$url" -o blogs.json.tmp
|
curl -fsSL "$$url" -o blogs.json.tmp
|
||||||
@jq -e 'type == "array" and length > 0 and all(.[]; type == "object" and has("url"))' \
|
@test -s blogs.json.tmp || { echo "downloaded dataset is empty" >&2; rm -f blogs.json.tmp; exit 1; }
|
||||||
blogs.json.tmp >/dev/null 2>&1 \
|
|
||||||
|| { echo "download is not a non-empty JSON array of blog entries; blogs.json left unchanged" >&2; \
|
|
||||||
rm -f blogs.json.tmp; exit 1; }
|
|
||||||
mv blogs.json.tmp blogs.json
|
mv blogs.json.tmp blogs.json
|
||||||
$(MAKE) test
|
$(MAKE) test
|
||||||
|
|||||||
18
README.md
18
README.md
@@ -16,9 +16,9 @@ the package with `go:embed`. The library performs no network I/O: importing it
|
|||||||
does not reach out to anything, results do not change under a caller between
|
does not reach out to anything, results do not change under a caller between
|
||||||
runs of the same build, and `go test` works offline.
|
runs of the same build, and `go test` works offline.
|
||||||
|
|
||||||
`GetBlogs` decodes the embedded bytes on first call and memoizes the result;
|
`FetchBlogs` keeps its name and its `sync.Once` memoization, but on first call
|
||||||
every other accessor goes through it. Its error return is only reachable if the
|
it decodes the embedded bytes rather than issuing an HTTP request. Its error
|
||||||
committed `blogs.json` is malformed.
|
return is now only reachable if the committed `blogs.json` is malformed.
|
||||||
|
|
||||||
The trade-off is that the dataset is a build-time artifact: it is roughly 8 MB
|
The trade-off is that the dataset is a build-time artifact: it is roughly 8 MB
|
||||||
of JSON, it lands in every binary that links the package, and it is only as
|
of JSON, it lands in every binary that links the package, and it is only as
|
||||||
@@ -31,12 +31,10 @@ make update-data
|
|||||||
```
|
```
|
||||||
|
|
||||||
That target reads the upstream location from the `BlogsURL` constant in
|
That target reads the upstream location from the `BlogsURL` constant in
|
||||||
`hnblogs.go` — the single source of truth — and downloads it to a temporary
|
`hnblogs.go` — the single source of truth — downloads to a temporary file,
|
||||||
file. It replaces `blogs.json` only once that file parses as a non-empty JSON
|
replaces `blogs.json` only once the download completes, and then runs the test
|
||||||
array of blog entries, so a response that arrives complete but is not the
|
suite against the new data. Commit the resulting `blogs.json` to publish the
|
||||||
dataset leaves the vendored copy untouched. It then runs the test suite
|
update.
|
||||||
against the new data. Requires `curl` and `jq`. Commit the resulting
|
|
||||||
`blogs.json` to publish the update.
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
@@ -46,4 +44,4 @@ make lint
|
|||||||
make docker
|
make docker
|
||||||
```
|
```
|
||||||
|
|
||||||
`make docker` runs lint and tests in containers.
|
`make docker` runs lint and tests in containers, matching CI.
|
||||||
|
|||||||
19
hnblogs.go
19
hnblogs.go
@@ -14,8 +14,8 @@ import (
|
|||||||
"sync"
|
"sync"
|
||||||
)
|
)
|
||||||
|
|
||||||
// BlogsURL is the upstream source of blogs.json. Nothing reads it at runtime;
|
// BlogsURL is the upstream source of blogs.json. It is not fetched at runtime;
|
||||||
// it documents where "make update-data" downloads the vendored copy from.
|
// it documents where "make update-data" pulls the vendored copy from.
|
||||||
const BlogsURL = "https://raw.githubusercontent.com/surprisetalk/blogs.hn/main/blogs.json"
|
const BlogsURL = "https://raw.githubusercontent.com/surprisetalk/blogs.hn/main/blogs.json"
|
||||||
|
|
||||||
// blogsJSON is the vendored dataset, refreshed by "make update-data".
|
// blogsJSON is the vendored dataset, refreshed by "make update-data".
|
||||||
@@ -39,13 +39,13 @@ type Blog struct {
|
|||||||
Desc string `json:"desc"`
|
Desc string `json:"desc"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetBlogs returns the embedded list of blogs, decoding it on first call and
|
// FetchBlogs returns the embedded list of blogs, decoding it on first call and
|
||||||
// memoizing the result for subsequent calls.
|
// memoizing the result for subsequent calls.
|
||||||
//
|
//
|
||||||
// It performs no I/O: the data is compiled into the binary, so the only error
|
// Despite the name it performs no I/O: the data is compiled into the binary, so
|
||||||
// it can return is a malformed embedded blogs.json, which would mean the
|
// the only error it can return is a malformed embedded blogs.json, which would
|
||||||
// committed dataset is broken.
|
// mean the committed dataset is broken.
|
||||||
func GetBlogs() ([]Blog, error) {
|
func FetchBlogs() ([]Blog, error) {
|
||||||
once.Do(func() {
|
once.Do(func() {
|
||||||
var decoded []Blog
|
var decoded []Blog
|
||||||
if err := json.Unmarshal(blogsJSON, &decoded); err != nil {
|
if err := json.Unmarshal(blogsJSON, &decoded); err != nil {
|
||||||
@@ -59,6 +59,11 @@ func GetBlogs() ([]Blog, error) {
|
|||||||
return blogs, loadError
|
return blogs, loadError
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetBlogs returns the memoized list of blogs.
|
||||||
|
func GetBlogs() ([]Blog, error) {
|
||||||
|
return FetchBlogs()
|
||||||
|
}
|
||||||
|
|
||||||
// RandomBlog returns a random blog from the list of blogs.
|
// RandomBlog returns a random blog from the list of blogs.
|
||||||
func RandomBlog() (Blog, error) {
|
func RandomBlog() (Blog, error) {
|
||||||
blogs, err := GetBlogs()
|
blogs, err := GetBlogs()
|
||||||
|
|||||||
@@ -1,15 +1,14 @@
|
|||||||
package hnblogs
|
package hnblogs
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"os/exec"
|
"go/build"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestGetBlogs(t *testing.T) {
|
func TestFetchBlogs(t *testing.T) {
|
||||||
blogs, err := GetBlogs()
|
blogs, err := FetchBlogs()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("Expected no error, got %v", err)
|
t.Fatalf("Expected no error, got %v", err)
|
||||||
}
|
}
|
||||||
@@ -40,25 +39,17 @@ func TestEmbeddedDataIsUsable(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// TestNoRuntimeNetworkImports is the regression guard for the reason this data
|
// TestNoRuntimeNetworkImports is the regression guard for the reason this data
|
||||||
// is embedded: the package must not reach the network on any code path. It
|
// is embedded: the package must not reach the network on any code path. A
|
||||||
// walks the whole dependency graph of the non-test build rather than the direct
|
// transport dependency reintroduced in non-test code fails here.
|
||||||
// import list, so a net/* package reached through an intermediate import fails
|
|
||||||
// here too. Test-only imports are outside that graph, which is why this test
|
|
||||||
// may use os/exec itself.
|
|
||||||
func TestNoRuntimeNetworkImports(t *testing.T) {
|
func TestNoRuntimeNetworkImports(t *testing.T) {
|
||||||
cmd := exec.Command("go", "list", "-deps", ".")
|
pkg, err := build.ImportDir(".", 0)
|
||||||
|
|
||||||
var stderr bytes.Buffer
|
|
||||||
cmd.Stderr = &stderr
|
|
||||||
|
|
||||||
out, err := cmd.Output()
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("Failed to list package dependencies: %v\n%s", err, stderr.String())
|
t.Fatalf("Failed to inspect package imports: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, dep := range strings.Fields(string(out)) {
|
for _, imported := range pkg.Imports {
|
||||||
if dep == "net" || strings.HasPrefix(dep, "net/") {
|
if imported == "net" || strings.HasPrefix(imported, "net/") {
|
||||||
t.Fatalf("Package must not perform network I/O, but depends on %q", dep)
|
t.Fatalf("Package must not perform network I/O, but imports %q", imported)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user