Dawnline 0.20.0
Build packages / CI (push) Blocked by required conditions
Build packages / Version (push) Waiting to run
CI / Web (format, types, tests, bundles) (push) Blocked by required conditions
CI / ShellCheck (push) Blocked by required conditions
CI / Backend (Go: vet, tests, a real ubusd and uhttpd) (push) Blocked by required conditions
CI / Package files (push) Blocked by required conditions
Build packages / CI (push) Blocked by required conditions
Build packages / Version (push) Waiting to run
CI / Web (format, types, tests, bundles) (push) Blocked by required conditions
CI / ShellCheck (push) Blocked by required conditions
CI / Backend (Go: vet, tests, a real ubusd and uhttpd) (push) Blocked by required conditions
CI / Package files (push) Blocked by required conditions
- **Backend rewritten in Go.** One daemon, `dawnlined`, replaces the whole ucode backend: the rpcd plugin, the agent, the CLI and the updater. The package no longer depends on ucode. - **Per-architecture builds.** The release carries the backend for arm64, ARMv7, mips, mipsle and amd64; the router fetches its own after the package is installed and checks its sha256. Dawnline does not run on other architectures (older ARM, 32-bit x86, RISC-V). - **Faster on the router.** A firewall sync takes 0.06 s instead of 0.9 s; a full apply takes about 300 ms. The portal is served by the daemon itself, without a CGI process per request. - **Live pages.** The admin and the portal follow a live stream from the router instead of re-fetching the whole state every 30 seconds. - **Admin redesigned in the portal's style.** Three sections (Overview · Log · Settings); a server is a page of its own with People, Places and Settings; a device opens as a dialog over its person. - **Changes wait for «Apply».** Every setting, and a person's access, is staged in one dock before it reaches the router. - **Configuration rollout.** After a change that makes devices fetch their configuration again, the admin shows how many have fetched it and who has not. Every setting shows beforehand (⟳N) how many devices it will touch. - **Waiting for a decision.** Overview and People put first the people who need one (access ended, limit reached, a device that does not connect), each with its one action a tap away. - **Bulk actions on people.** «Select» (or a long press on a card) picks several people to extend by a month, pause or resume at once. - **Undo.** An action done from a card or a request is undone from its toast. - **Update dialogs redesigned.** An update is one view from its question to its result; Dawnline's own update runs in it like every other, and the page reloads itself once the new version answers. Other versions are a list, each with its notes and Install on a page of its own. - **Site to site: networks behind a router.** A router connected as a device can have networks behind it (up to eight, /16 to /30): the server routes them and applies the router's access to them. A network that shares addresses with a tunnel, the router's own networks or another site is refused by name. - **Routers from the portal.** People can add a router and name its networks on their own page; the admin accepts or declines with a reason, or lets them through without asking. - **Check access and Health know the networks behind routers.** - **Usage limits reworked.** A monthly limit no longer follows the calendar. A person's month starts with their first traffic and ends a month later; the next one starts only when they connect again, so time away uses up none of it. Before, everyone's limit reset on the 1st. - Extra data lasts until that person's month ends; «Reset usage» starts the month anew. - A limit is for a month or for the whole term; the admin and the portal show when it resets. - Charts that said «this month» show the last 30 days. - After the update nobody loses what was counted: the month that was running becomes the person's first and ends on the 1st. - **Access by time of day removed.** The Hours limit is gone from the admin, the portal and the backend; saved hours are dropped. - **Expiry simplified.** An end date always stops access, with a heads-up three days before; the per-person choice is gone. - **No false disconnects from sleeping phones.** A phone or a tablet stays online through ten minutes of silence. - **Mobile Safari fixes.** Pressing a control no longer sends the page to its top; tab tracks that do not fit scroll; switches animate after a press.
This commit is contained in:
1 parent
f8130e39a8
commit
ac90575b0b
788 files changed
+139244
-41720
No files matched your search
@@ -0,0 +1,133 @@
|
||||
// Package bridge has the backend's topics told again when they may have moved without an event of their
|
||||
// own: the settings or what was handed out changed on disk, somebody starts to look, or the minute passed
|
||||
// (the counters and the clock move by themselves). It also gives the topics their shape on the stream
|
||||
// (Split). The name is from the time it carried the ucode backend's answers over; nothing is asked of
|
||||
// anyone now.
|
||||
package bridge
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
"time"
|
||||
|
||||
"github.com/tickcount/luci-app-dawnline/backend/hub"
|
||||
)
|
||||
|
||||
// Refresh is how old what is published may get while nothing on disk moved: traffic totals and uptimes
|
||||
// change without an event.
|
||||
const Refresh = 30 * time.Second
|
||||
|
||||
// MeterKeep is how many points of the live meter are kept, one a second.
|
||||
const MeterKeep = 120
|
||||
|
||||
// Audience tells whether anyone looks.
|
||||
type Audience interface {
|
||||
Present() bool
|
||||
Wants(topic string) bool
|
||||
}
|
||||
|
||||
// Bridge has the topics told again.
|
||||
type Bridge struct {
|
||||
Hub *hub.Hub
|
||||
Audience Audience
|
||||
// Watch lists the files whose change means the topics changed (the settings, the configurations handed
|
||||
// out, the servers kept down).
|
||||
Watch []string
|
||||
// Tell puts the topics again, as the router is at that moment, and says whether it could: false while
|
||||
// there is nothing to make them from (the settings were not read yet). nil: nobody makes them here, a
|
||||
// test stand.
|
||||
Tell func() bool
|
||||
// Log gets a line for the system log.
|
||||
Log func(format string, args ...any)
|
||||
|
||||
asks chan chan struct{}
|
||||
sig string
|
||||
told time.Time
|
||||
wasAbsent bool
|
||||
}
|
||||
|
||||
// New makes a bridge ready to be asked (Look) before it runs.
|
||||
func New(b Bridge) *Bridge {
|
||||
b.asks = make(chan chan struct{})
|
||||
return &b
|
||||
}
|
||||
|
||||
// Look has the topics told now instead of at the next second, and returns once they hold what is on disk
|
||||
// (or ctx ended). A page asks after its own edit, to read what it wrote.
|
||||
func (b *Bridge) Look(ctx context.Context) {
|
||||
done := make(chan struct{})
|
||||
select {
|
||||
case b.asks <- done:
|
||||
case <-ctx.Done():
|
||||
return
|
||||
}
|
||||
select {
|
||||
case <-done:
|
||||
case <-ctx.Done():
|
||||
}
|
||||
}
|
||||
|
||||
// Run works until ctx ends.
|
||||
func (b *Bridge) Run(ctx context.Context) {
|
||||
tick := time.NewTicker(time.Second)
|
||||
defer tick.Stop()
|
||||
b.wasAbsent = true
|
||||
for {
|
||||
var asked chan struct{}
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return
|
||||
case asked = <-b.asks:
|
||||
case <-tick.C:
|
||||
}
|
||||
if asked != nil {
|
||||
// whoever asks is told at once
|
||||
b.wasAbsent = true
|
||||
b.status()
|
||||
close(asked)
|
||||
continue
|
||||
}
|
||||
if !b.Audience.Present() {
|
||||
b.wasAbsent = true
|
||||
continue
|
||||
}
|
||||
b.status()
|
||||
}
|
||||
}
|
||||
|
||||
// status has the topics told when they are due: the first look after nobody looked, a change on disk, or
|
||||
// Refresh since the last time. Topics that could not be made stay due, and the backend's own topic does not
|
||||
// say they were: a page that asked in the backend's first second is told with the next one, not after
|
||||
// Refresh.
|
||||
func (b *Bridge) status() {
|
||||
if b.Tell == nil {
|
||||
return
|
||||
}
|
||||
sig := signature(b.Watch)
|
||||
if !b.wasAbsent && sig == b.sig && time.Since(b.told) < Refresh {
|
||||
return
|
||||
}
|
||||
if !b.Tell() {
|
||||
return
|
||||
}
|
||||
b.sig, b.told, b.wasAbsent = sig, time.Now(), false
|
||||
// `at`: when the topics were last made, so a page that opens on documents kept from an hour ago
|
||||
// knows to wait for this instead of showing them
|
||||
b.Hub.Put("backend", map[string]any{"ok": true, "at": time.Now().Unix()})
|
||||
}
|
||||
|
||||
// signature is the files' identity: a commit of the settings replaces the
|
||||
// file (a new inode within the same second), a counter is rewritten in place.
|
||||
func signature(paths []string) string {
|
||||
s := ""
|
||||
for _, p := range paths {
|
||||
st, err := os.Stat(p)
|
||||
if err != nil {
|
||||
s += "-;"
|
||||
continue
|
||||
}
|
||||
s += fmt.Sprintf("%d/%d/%d;", st.ModTime().UnixNano(), st.Size(), inode(st))
|
||||
}
|
||||
return s
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
package bridge
|
||||
|
||||
import (
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/tickcount/luci-app-dawnline/backend/hub"
|
||||
)
|
||||
|
||||
// The topics are told again when somebody starts to look, when the settings change and with the minute,
|
||||
// and not otherwise; the backend's own topic says it is well.
|
||||
func TestToldWhenDue(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
conf := dir + "/dawnline"
|
||||
os.WriteFile(conf, []byte("a"), 0o600)
|
||||
h := hub.New()
|
||||
told := 0
|
||||
b := New(Bridge{Hub: h, Log: func(string, ...any) {}, Watch: []string{conf}, Tell: func() bool { told++; return true }})
|
||||
b.wasAbsent = true
|
||||
b.status()
|
||||
b.status()
|
||||
if told != 1 {
|
||||
t.Fatalf("the first look: told %d times", told)
|
||||
}
|
||||
time.Sleep(10 * time.Millisecond)
|
||||
os.WriteFile(conf, []byte("bb"), 0o600)
|
||||
b.status()
|
||||
b.status()
|
||||
if told != 2 {
|
||||
t.Fatalf("after the settings changed: told %d times", told)
|
||||
}
|
||||
b.told = time.Now().Add(-2 * Refresh)
|
||||
b.status()
|
||||
if told != 3 {
|
||||
t.Fatalf("a minute later: told %d times", told)
|
||||
}
|
||||
if doc, ok := h.Sync("", 0, nil).Docs["backend"].(map[string]any); !ok || doc["ok"] != true {
|
||||
t.Errorf("the backend's own topic: %v", h.Sync("", 0, nil).Docs["backend"])
|
||||
}
|
||||
// a stand with nobody to make the topics tells nothing
|
||||
quiet := New(Bridge{Hub: hub.New(), Watch: []string{conf}})
|
||||
quiet.wasAbsent = true
|
||||
quiet.status()
|
||||
}
|
||||
|
||||
// Topics that could not be made yet (the backend just started: the settings are not read) stay due: they
|
||||
// are asked for again with the next second, not after Refresh, and until then the backend's own topic does
|
||||
// not say that they are there.
|
||||
func TestStaysDueUntilTold(t *testing.T) {
|
||||
h := hub.New()
|
||||
asked, ready := 0, false
|
||||
b := New(Bridge{Hub: h, Tell: func() bool { asked++; return ready }})
|
||||
b.wasAbsent = true
|
||||
b.status()
|
||||
b.status()
|
||||
if asked != 2 {
|
||||
t.Fatalf("not told yet: asked %d times", asked)
|
||||
}
|
||||
if doc, there := h.Sync("", 0, nil).Docs["backend"]; there {
|
||||
t.Fatalf("the backend's own topic before any was made: %v", doc)
|
||||
}
|
||||
ready = true
|
||||
b.status()
|
||||
b.status()
|
||||
if asked != 3 {
|
||||
t.Fatalf("once told: asked %d times", asked)
|
||||
}
|
||||
if _, there := h.Sync("", 0, nil).Docs["backend"]; !there {
|
||||
t.Fatal("told, and the backend's own topic is not there")
|
||||
}
|
||||
// the same when they are due by their age
|
||||
ready = false
|
||||
b.told = time.Now().Add(-2 * Refresh)
|
||||
b.status()
|
||||
b.status()
|
||||
if asked != 5 {
|
||||
t.Fatalf("due by age and not told: asked %d times", asked)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
//go:build unix
|
||||
|
||||
package bridge
|
||||
|
||||
import (
|
||||
"os"
|
||||
"syscall"
|
||||
)
|
||||
|
||||
// inode is the file's inode number (0 when the system does not tell).
|
||||
func inode(st os.FileInfo) uint64 {
|
||||
if s, ok := st.Sys().(*syscall.Stat_t); ok {
|
||||
return uint64(s.Ino)
|
||||
}
|
||||
return 0
|
||||
}
|
||||
Vendored
+1661
File diff suppressed because it is too large.
Load diff
Vendored
+1882
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,142 @@
|
||||
// The ucode backend's `status` answer cut into the topics pages follow.
|
||||
//
|
||||
// `status` is one large document that every admin page used to fetch whole.
|
||||
// As topics, a change in one place (a device came online) is a patch of a few
|
||||
// bytes to one of them, and a page follows only those it shows. Lists of
|
||||
// things that have an id (people, devices, servers) become keyed lists, so a
|
||||
// change to one entry does not resend the list.
|
||||
//
|
||||
// Pure: a document in, documents out. bridge.go fetches and publishes.
|
||||
package bridge
|
||||
|
||||
// A keyed list is how a list of things with ids is published:
|
||||
//
|
||||
// { "order": ["p1", "p2"], "items": { "p1": {…}, "p2": {…} } }
|
||||
//
|
||||
// A merge patch replaces an array whole, but reaches into an object: with
|
||||
// the entries under their ids, one that changed is all that is sent, and
|
||||
// `order` only when something came, went or moved. A daily series (traffic
|
||||
// by the day) is keyed by its `day` the same way: every minute moves today's
|
||||
// entry, and on the router that alone was most of what a refresh resent.
|
||||
func keyed(list []any) (map[string]any, bool) {
|
||||
for _, key := range []string{"id", "day"} {
|
||||
if k, ok := keyedBy(list, key); ok {
|
||||
return k, true
|
||||
}
|
||||
}
|
||||
return nil, false
|
||||
}
|
||||
|
||||
// keyedBy keys a list by one field, when every entry has it, as a string of
|
||||
// its own.
|
||||
func keyedBy(list []any, key string) (map[string]any, bool) {
|
||||
order := make([]any, 0, len(list))
|
||||
items := make(map[string]any, len(list))
|
||||
for _, e := range list {
|
||||
m, ok := e.(map[string]any)
|
||||
if !ok {
|
||||
return nil, false
|
||||
}
|
||||
id, ok := m[key].(string)
|
||||
if !ok || id == "" {
|
||||
return nil, false
|
||||
}
|
||||
if _, twice := items[id]; twice {
|
||||
return nil, false
|
||||
}
|
||||
order = append(order, id)
|
||||
items[id] = m
|
||||
}
|
||||
return map[string]any{"order": order, "items": items}, true
|
||||
}
|
||||
|
||||
// Null stands for a null of the ucode answer: a topic holds none (a merge patch reads null as "remove this"),
|
||||
// and the pages' code tells "no link trouble" (null) from "not told" (absent). A field that was null is
|
||||
// published as { "$null": true } and read back as null (web/src/admin/state/join.ts). Only this bridge
|
||||
// needs it: a producer written for the stream leaves out what it has nothing to say about.
|
||||
const Null = "$null"
|
||||
|
||||
// rekey turns every list of things with ids (or days) inside v into a keyed
|
||||
// list, at any depth (a person's devices inside the list of people). A list of
|
||||
// anything else stays a list. An empty list stays one too: it cannot be told
|
||||
// what it would hold.
|
||||
func rekey(v any) any {
|
||||
switch x := v.(type) {
|
||||
case nil:
|
||||
return map[string]any{Null: true}
|
||||
case map[string]any:
|
||||
for k, e := range x {
|
||||
x[k] = rekey(e)
|
||||
}
|
||||
case []any:
|
||||
for i, e := range x {
|
||||
x[i] = rekey(e)
|
||||
}
|
||||
if len(x) > 0 {
|
||||
if k, ok := keyed(x); ok {
|
||||
return k
|
||||
}
|
||||
}
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
// Where each field of `status` goes. A field not named here goes to "router",
|
||||
// so one a later version adds is still published.
|
||||
var topicOf = map[string]string{
|
||||
"servers": "servers",
|
||||
"people": "people",
|
||||
"circles": "circles",
|
||||
"services": "services",
|
||||
"totals": "traffic",
|
||||
"series": "traffic",
|
||||
"hours": "traffic",
|
||||
"geo": "places",
|
||||
"events": "recent",
|
||||
"now": "clock",
|
||||
"tz": "clock",
|
||||
}
|
||||
|
||||
// Topics lists the topics Split fills, for hello and the tests.
|
||||
var Topics = []string{"router", "servers", "people", "circles", "services", "traffic", "places", "recent", "clock"}
|
||||
|
||||
// whole names the topics that are one field of `status` as it is; the others
|
||||
// are objects of several fields.
|
||||
var whole = map[string]bool{"servers": true, "people": true, "circles": true, "services": true, "places": true, "recent": true}
|
||||
|
||||
// lists names the topics that are a keyed list even while empty, so a page
|
||||
// reads one shape whether or not there is anyone yet.
|
||||
var lists = map[string]bool{"servers": true, "people": true, "circles": true, "services": true}
|
||||
|
||||
// Split cuts a `status` answer into topics. The answer is taken apart, not
|
||||
// copied: the caller gives it up.
|
||||
func Split(status map[string]any) map[string]any {
|
||||
out := map[string]any{}
|
||||
for _, t := range Topics {
|
||||
if !whole[t] {
|
||||
out[t] = map[string]any{}
|
||||
}
|
||||
}
|
||||
for field, v := range status {
|
||||
topic, ok := topicOf[field]
|
||||
if !ok {
|
||||
topic = "router"
|
||||
}
|
||||
if whole[topic] {
|
||||
// The recent events have no ids and come as a window that moves:
|
||||
// they stay a list.
|
||||
if topic != "recent" {
|
||||
v = rekey(v)
|
||||
}
|
||||
if list, isList := v.([]any); isList && lists[topic] {
|
||||
if k, ok := keyed(list); ok {
|
||||
v = k
|
||||
}
|
||||
}
|
||||
out[topic] = v
|
||||
continue
|
||||
}
|
||||
out[topic].(map[string]any)[field] = rekey(v)
|
||||
}
|
||||
return out
|
||||
}
|
||||
@@ -0,0 +1,89 @@
|
||||
package bridge
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"os"
|
||||
"reflect"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func doc(s string) map[string]any {
|
||||
var v map[string]any
|
||||
if err := json.Unmarshal([]byte(s), &v); err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
// Lists of things with ids become keyed lists, at any depth; the rest stays.
|
||||
func TestSplit(t *testing.T) {
|
||||
got := Split(doc(`{
|
||||
"version": "0.18.0", "now": 1700000000, "tz": "MSK-3", "hostname": "Outline",
|
||||
"servers": [{"id": "s1", "name": "Home", "series": [1, 2]}],
|
||||
"people": [
|
||||
{"id": "p1", "name": "Myata", "devices": [{"id": "d1", "online": true}, {"id": "d2", "online": false}]},
|
||||
{"id": "p2", "name": "Guest", "devices": []}
|
||||
],
|
||||
"circles": [], "services": [],
|
||||
"totals": {"rx": 1}, "series": [{"day": "2026-11-11", "rx": 1, "tx": 2}],
|
||||
"geo": {"enabled": true, "home": null, "points": [{"ip": "203.0.113.7"}]},
|
||||
"events": [{"ts": 1, "type": "connect"}]
|
||||
}`))
|
||||
want := doc(`{
|
||||
"router": {"version": "0.18.0", "hostname": "Outline"},
|
||||
"clock": {"now": 1700000000, "tz": "MSK-3"},
|
||||
"servers": {"order": ["s1"], "items": {"s1": {"id": "s1", "name": "Home", "series": [1, 2]}}},
|
||||
"people": {"order": ["p1", "p2"], "items": {
|
||||
"p1": {"id": "p1", "name": "Myata", "devices": {"order": ["d1", "d2"], "items": {"d1": {"id": "d1", "online": true}, "d2": {"id": "d2", "online": false}}}},
|
||||
"p2": {"id": "p2", "name": "Guest", "devices": []}
|
||||
}},
|
||||
"circles": {"order": [], "items": {}}, "services": {"order": [], "items": {}},
|
||||
"traffic": {"totals": {"rx": 1}, "series": {"order": ["2026-11-11"], "items": {"2026-11-11": {"day": "2026-11-11", "rx": 1, "tx": 2}}}},
|
||||
"places": {"enabled": true, "home": {"$null": true}, "points": [{"ip": "203.0.113.7"}]},
|
||||
"recent": [{"ts": 1, "type": "connect"}]
|
||||
}`)
|
||||
if !reflect.DeepEqual(got, map[string]any(want)) {
|
||||
g, _ := json.MarshalIndent(got, "", " ")
|
||||
t.Fatalf("got %s", g)
|
||||
}
|
||||
}
|
||||
|
||||
// Two entries with one id, or one without: the list is left as it came.
|
||||
func TestKeyedRefuses(t *testing.T) {
|
||||
for _, s := range []string{`{"l":[{"id":"a"},{"id":"a"}]}`, `{"l":[{"id":"a"},{"name":"b"}]}`, `{"l":[{"id":1}]}`, `{"l":[1,2]}`} {
|
||||
in := doc(s)
|
||||
if _, isList := rekey(in).(map[string]any)["l"].([]any); !isList {
|
||||
t.Fatalf("%s was keyed", s)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// The fixture the page's side reads too (web/tests/stream.test.ts joins testdata/topics.json back into
|
||||
// testdata/status.json): what Split makes of a whole status answer. Run with UPDATE=1 to write it anew
|
||||
// after Split changed, and look at the difference.
|
||||
func TestSplitFixture(t *testing.T) {
|
||||
raw, err := os.ReadFile("testdata/status.json")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var status map[string]any
|
||||
if err := json.Unmarshal(raw, &status); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
got, err := json.MarshalIndent(Split(status), "", " ")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if os.Getenv("UPDATE") != "" {
|
||||
if err := os.WriteFile("testdata/topics.json", append(got, '\n'), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
want, err := os.ReadFile("testdata/topics.json")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if string(got)+"\n" != string(want) {
|
||||
t.Fatal("Split no longer makes testdata/topics.json of testdata/status.json: UPDATE=1 writes it anew, and web/src/admin/state/join.ts must still join it back")
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user