Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
61f8887319 | ||
|
|
72637a153a | ||
|
|
f06a25b43e | ||
|
|
6cf184caa6 | ||
|
|
3c14906db2 | ||
|
|
70d7398d5a | ||
|
|
1cabbb7a78 | ||
|
|
5eb689e4c2 | ||
|
|
e931ddc313 | ||
|
|
2210dc082a | ||
|
|
9fa47822c1 | ||
|
|
366bed3a15 | ||
|
|
07fc170b91 | ||
|
|
8139003b35 | ||
|
|
96e1fa251b | ||
|
|
40102d6038 | ||
|
|
0cf5c8c281 | ||
|
|
445d9de57a | ||
|
|
d5ad459eba | ||
|
|
c297d256e4 | ||
|
|
d063425cae | ||
|
|
0764fbd566 | ||
|
|
b041b32aa2 | ||
|
|
d8f5f6e236 | ||
|
|
61634a6bb5 | ||
|
|
8ee9fbedfb | ||
|
|
ab77024ec9 | ||
|
|
48509e3073 | ||
|
|
916a0c0224 | ||
|
|
ff75302cf8 | ||
|
|
08d703e3af | ||
|
|
d4784fd174 | ||
|
|
094ea5cdd8 | ||
|
|
f60758b770 | ||
|
|
9d390d021f | ||
|
|
18db79c063 | ||
|
|
1612f53966 | ||
|
|
4d5f1a56b1 | ||
|
|
274e392708 | ||
|
|
84ca506961 | ||
|
|
6db61b0cc7 | ||
|
|
57689ddfbb | ||
|
|
7770ba9844 | ||
|
|
55b8e438ad | ||
|
|
1607a22f0c |
@@ -3,6 +3,11 @@ name: Documentation
|
|||||||
# The docs are built on every push so a broken build is caught immediately, but
|
# The docs are built on every push so a broken build is caught immediately, but
|
||||||
# only published once GitHub Pages has been enabled for the repository. Until the
|
# only published once GitHub Pages has been enabled for the repository. Until the
|
||||||
# owner decides to publish, this job builds and stops.
|
# owner decides to publish, this job builds and stops.
|
||||||
|
#
|
||||||
|
# And on pull requests, where the build is the only check there is: `mkdocs build
|
||||||
|
# --strict` fails on a link to a page that does not exist, and building only after
|
||||||
|
# the merge means finding that out on `main`. Nothing is published from a pull
|
||||||
|
# request — the `deploy` job below runs on a manual dispatch and nothing else.
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [main]
|
branches: [main]
|
||||||
@@ -10,6 +15,11 @@ on:
|
|||||||
- 'docs/**'
|
- 'docs/**'
|
||||||
- 'mkdocs.yml'
|
- 'mkdocs.yml'
|
||||||
- '.github/workflows/docs.yml'
|
- '.github/workflows/docs.yml'
|
||||||
|
pull_request:
|
||||||
|
paths:
|
||||||
|
- 'docs/**'
|
||||||
|
- 'mkdocs.yml'
|
||||||
|
- '.github/workflows/docs.yml'
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
|
|||||||
@@ -17,6 +17,11 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
# Taggen selv, ikke kun den commit den peger på: udgivelsesteksten
|
||||||
|
# nedenfor står i tagbeskeden, og en overfladisk checkout henter
|
||||||
|
# commit'en uden den.
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
- uses: docker/setup-qemu-action@v3
|
- uses: docker/setup-qemu-action@v3
|
||||||
- uses: docker/setup-buildx-action@v3
|
- uses: docker/setup-buildx-action@v3
|
||||||
@@ -60,7 +65,28 @@ jobs:
|
|||||||
#
|
#
|
||||||
# Created after the image, so a release never announces a version that
|
# Created after the image, so a release never announces a version that
|
||||||
# failed to build.
|
# failed to build.
|
||||||
|
# Tagbeskeden ER annonceringen. Den skrives, når der tagges, på produktets
|
||||||
|
# eget sprog og til dem, der bruger det — og indtil nu nåede den aldrig
|
||||||
|
# frem: udgivelsen på GitHub blev fyldt med en autogenereret liste over
|
||||||
|
# commit-overskrifter, som er skrevet til dem, der læser koden.
|
||||||
|
#
|
||||||
|
# Den sidste linje er et link til udgivelsen selv, og den tages af: en
|
||||||
|
# side, der linker til sig selv, hjælper ingen.
|
||||||
|
- id: notes
|
||||||
|
run: |
|
||||||
|
{
|
||||||
|
echo 'body<<VERDANDE_EOF'
|
||||||
|
git tag -l --format='%(contents)' "${GITHUB_REF_NAME}" \
|
||||||
|
| sed '\#^https://github.com/.*/releases/tag/#d' \
|
||||||
|
| sed -e :a -e '/^\n*$/{$d;N;ba' -e '}'
|
||||||
|
echo VERDANDE_EOF
|
||||||
|
} >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
- uses: softprops/action-gh-release@v2
|
- uses: softprops/action-gh-release@v2
|
||||||
with:
|
with:
|
||||||
|
body: ${{ steps.notes.outputs.body }}
|
||||||
|
# Stadig sat: den autogenererede liste lægges *under* teksten ovenfor,
|
||||||
|
# så både den, der vil vide hvad der er nyt, og den, der vil se hvilke
|
||||||
|
# ændringer det var, kan læse det samme sted.
|
||||||
generate_release_notes: true
|
generate_release_notes: true
|
||||||
make_latest: true
|
make_latest: true
|
||||||
|
|||||||
@@ -37,17 +37,32 @@ and an MCP endpoint so Claude can work your task list directly.
|
|||||||
- **Projects, sections, sub-tasks, labels, saved filters.** List, board and calendar
|
- **Projects, sections, sub-tasks, labels, saved filters.** List, board and calendar
|
||||||
views, and foldable groups over the projects in the sidebar.
|
views, and foldable groups over the projects in the sidebar.
|
||||||
- **Notes, beside the work.** Rich text that is Markdown underneath — headings,
|
- **Notes, beside the work.** Rich text that is Markdown underneath — headings,
|
||||||
lists, quotes, fenced code. A note is shared by filing it in a project;
|
lists, quotes, fenced code. A note is shared by filing it in a project, by
|
||||||
`#project` and `[[another note]]` are links, and a task shows the notes that
|
handing it to one person — including somebody who has no account yet, who gets an
|
||||||
mention it. A zip of Markdown goes in — Obsidian, Bear, or Apple Notes through
|
invitation that becomes the share when they sign up — or by writing `@Sofie` in
|
||||||
|
the text, which shares it with her and tells her. `#project` and
|
||||||
|
`[[another note]]` are links, and a task shows the notes that mention it. A zip of Markdown goes in — Obsidian, Bear, or Apple Notes through
|
||||||
the exporter in [`tools/`](tools/) — and comes back out the same shape.
|
the exporter in [`tools/`](tools/) — and comes back out the same shape.
|
||||||
- **Drag where it means something.** Reorder a list or a board, file a project under
|
- **Drag where it means something.** Reorder a list or a board, file a project under
|
||||||
a group, drop a task on another project, or drop it on another day.
|
a group, drop a task on another project, or drop it on another day.
|
||||||
- **Sharing.** Owner, editor and viewer roles. There is no open registration:
|
- **Sharing.** Owner, editor and viewer roles. There is no open registration:
|
||||||
everybody arrives through an invite link, either to a project or — from
|
everybody arrives through an invite link — to a project, to a single note, or
|
||||||
**Settings → Brugere** — to the instance itself. Nobody's password is ever chosen
|
from **Settings → Brugere** to the instance itself. Nobody's password is ever
|
||||||
by somebody else.
|
chosen by somebody else.
|
||||||
- **Live sync.** A change made by somebody else appears without a refresh.
|
- **Live sync.** A change made by somebody else appears without a refresh.
|
||||||
|
- **Notifications that are worth reading.** A bell for what other people did to what
|
||||||
|
you share — folded, so one person typing for five minutes is one line — pushed to
|
||||||
|
your devices and counted on the app's icon in the Dock.
|
||||||
|
- **AI that suggests and never writes.** Optional, off by default, your own key and
|
||||||
|
your own model if you want. It tidies the inbox, pulls the tasks out of a meeting
|
||||||
|
note, writes a morning plan, turns *"SV: SV: Vedr. levering uge 12"* into the
|
||||||
|
action the mail asks for, and answers questions about your own notes with links to
|
||||||
|
what the answer rests on. Every one of them arrives as a line you accept, edit or
|
||||||
|
refuse — a model that edits your tasks directly has to be right every time to be
|
||||||
|
worth having.
|
||||||
|
- **Anything can put a task in the inbox.** A mail to your own forwarding address,
|
||||||
|
or a POST of one line of text from a shortcut on your phone, a script or any
|
||||||
|
service that can call a URL.
|
||||||
- **Recurring tasks** as RRULE (RFC 5545), reminders, comments and attachments.
|
- **Recurring tasks** as RRULE (RFC 5545), reminders, comments and attachments.
|
||||||
- **Standards, not homegrown formats.** iCalendar and CalDAV, ICS feeds, OAuth2 with
|
- **Standards, not homegrown formats.** iCalendar and CalDAV, ICS feeds, OAuth2 with
|
||||||
PKCE, OpenAPI 3.1, MCP, Web Push, Argon2id.
|
PKCE, OpenAPI 3.1, MCP, Web Push, Argon2id.
|
||||||
@@ -103,7 +118,7 @@ Apple Reminders, forward mail into it, and add it to Claude as a connector.
|
|||||||
| CalDAV server (two-way VTODO) | Done, tested |
|
| CalDAV server (two-way VTODO) | Done, tested |
|
||||||
| Mail-to-task | Done, tested |
|
| Mail-to-task | Done, tested |
|
||||||
| AI layer (Anthropic/OpenAI/Google/local) | Built, degrades when unconfigured |
|
| AI layer (Anthropic/OpenAI/Google/local) | Built, degrades when unconfigured |
|
||||||
| Gmail: OAuth2 with PKCE, polling, one-way to tasks | Done, tested |
|
| Gmail: OAuth2 with PKCE, polling to tasks, unstars what it imports | Done, tested |
|
||||||
| Google Calendar: read-only, laid over the task calendar | Built, never run against Google |
|
| Google Calendar: read-only, laid over the task calendar | Built, never run against Google |
|
||||||
| Calendar subscriptions: ICS and webcal, several per person | Done, tested |
|
| Calendar subscriptions: ICS and webcal, several per person | Done, tested |
|
||||||
| Times on tasks, set by dragging in the week grid | Done, tested |
|
| Times on tasks, set by dragging in the week grid | Done, tested |
|
||||||
|
|||||||
@@ -104,6 +104,8 @@ func run() error {
|
|||||||
runner.SyncCalendars = api.SyncCalendars
|
runner.SyncCalendars = api.SyncCalendars
|
||||||
runner.Push = api.PushToUser
|
runner.Push = api.PushToUser
|
||||||
runner.SendBeacon = api.SendBeacon
|
runner.SendBeacon = api.SendBeacon
|
||||||
|
runner.DailyPlans = api.DailyPlans
|
||||||
|
runner.NotifyOfUpdates = api.NotifyOfUpdates
|
||||||
runner.Start(jobCtx)
|
runner.Start(jobCtx)
|
||||||
|
|
||||||
srv := &http.Server{
|
srv := &http.Server{
|
||||||
|
|||||||
@@ -43,23 +43,92 @@ The key is stored on your account and is **never sent back** to the settings pag
|
|||||||
a page that repopulates a password field is one that will eventually leak it into a
|
a page that repopulates a password field is one that will eventually leak it into a
|
||||||
screenshot.
|
screenshot.
|
||||||
|
|
||||||
|
## The shape of all of it
|
||||||
|
|
||||||
|
**The model proposes; you decide.** Nothing is written until you say yes, and the
|
||||||
|
proposal is a line in the same syntax you type yourself — `Ring til Anders i morgen
|
||||||
|
p1 #Firma` — sitting in a field you can edit before you accept it.
|
||||||
|
|
||||||
|
That is not caution for its own sake. A model that edits your tasks directly has to
|
||||||
|
be right *every* time to be worth having. One that suggests only has to be right
|
||||||
|
often enough to save you some typing, and when it is wrong you have already seen it.
|
||||||
|
|
||||||
|
It is also why the suggestion is a line rather than a set of fields: there is one
|
||||||
|
reading of "i morgen" in this program, and a suggestion goes through the same
|
||||||
|
[quick add](quick-add.md) parser as anything you type — including after you have
|
||||||
|
edited it by hand.
|
||||||
|
|
||||||
|
The model is given the names of the projects that exist and may name no others. A
|
||||||
|
`#Projekt` it invented would create one by accident the first time you accepted it,
|
||||||
|
and a guess must not be able to move a task somewhere you will not look for it.
|
||||||
|
|
||||||
## What it can do
|
## What it can do
|
||||||
|
|
||||||
**Split a task into sub-tasks.** On any task: *Split with AI*. It suggests two to
|
**Tidy up the inbox.** In the Inbox, the menu → *Ryd op i indbakken*. For each loose
|
||||||
seven concrete actions and creates them as sub-tasks. Written in your language.
|
line it suggests how you would have written it if you had finished it — project,
|
||||||
|
date, priority — with one sentence on what it read out of the task. Accept, edit, or
|
||||||
|
skip, one line at a time.
|
||||||
|
|
||||||
|
**Find the tasks in a note.** Open a note → *Find opgaver i noten*. Only what
|
||||||
|
somebody committed to or was asked to do; a heading is not a task and a topic that
|
||||||
|
was discussed is not a task. Each suggestion quotes the words it came from, so a
|
||||||
|
wrong one can be seen through rather than merely being wrong. The note itself is
|
||||||
|
never edited — the task carries `[[the note's title]]` in its description instead.
|
||||||
|
|
||||||
|
**Today's plan, in the morning.** **Settings → Beskeder → Dagens plan**, off by
|
||||||
|
default; pick the hour yourself. One notification about what is due today and what
|
||||||
|
has been missed, and what to start with — and the same text as a card at the top of
|
||||||
|
**I dag**, where you are looking anyway when you start the day. The notification is
|
||||||
|
the reminder; the card is where it stays.
|
||||||
|
|
||||||
|
The card shows the plan *as it was sent*, with the time it was made, rather than a
|
||||||
|
new one each time you look: a plan that says something different when you look at it
|
||||||
|
than it said when it arrived is worse than either. **Forny planen** makes a new one
|
||||||
|
when the day has moved, and it does not send a notification about something you are
|
||||||
|
already looking at. With the morning notification off, the card offers to make one
|
||||||
|
on the spot.
|
||||||
|
|
||||||
|
The counts are done in the database and handed to the model as facts it may not
|
||||||
|
recompute — a plan that says four tasks where there are three is worse than no plan.
|
||||||
|
With no model configured the counts stand on their own, which is what you needed to
|
||||||
|
know at seven in the morning anyway. Nothing due and nothing overdue sends nothing.
|
||||||
|
|
||||||
|
**Mail that becomes a task you can act on.** Where a
|
||||||
|
[mailbox](mailboxes.md) used to produce *"Anders Jensen: SV: SV: Vedr. levering uge
|
||||||
|
12"*, the model writes the action the mail asks for — and leaves the mail alone if
|
||||||
|
it asks for nothing. The subject stays in the description, so a mail it misread can
|
||||||
|
still be read. If the model is unavailable the task is named sender and subject as
|
||||||
|
before: a model that is down must not be able to stop the post.
|
||||||
|
|
||||||
|
**Ask your own notes and tasks.** ⌘K, type the question, ⌘⏎. *"Hvad lovede jeg
|
||||||
|
Anders i august?"* — search finds what contains the words, this answers the
|
||||||
|
question, and the answer links to the notes and tasks it rests on. If nothing
|
||||||
|
matches, it says so; a guess would be useless here, because you are asking precisely
|
||||||
|
because you cannot remember.
|
||||||
|
|
||||||
|
**Split a task into sub-tasks.** On any task: *Split with AI*. Two to seven concrete
|
||||||
|
actions, created as sub-tasks.
|
||||||
|
|
||||||
**A weekly summary.** A short note over what is outstanding: what looks urgent and
|
**A weekly summary.** A short note over what is outstanding: what looks urgent and
|
||||||
what appears to be slipping. At most six lines — it is a prompt to think, not a
|
what appears to be slipping. At most six lines — a prompt to think, not a report.
|
||||||
report.
|
|
||||||
|
|
||||||
## What is sent
|
## What is sent
|
||||||
|
|
||||||
Only what the feature needs: for a split, the task's title and notes; for a
|
Only what the feature needs, and only when you invoke it:
|
||||||
summary, the titles, dates and priorities of your open tasks. Never comments,
|
|
||||||
attachments, or anything from a project the feature was not invoked on.
|
|
||||||
|
|
||||||
Nothing is sent to anybody until you configure a provider. With a local model,
|
| Feature | What leaves the instance |
|
||||||
nothing leaves your machine at all.
|
| --- | --- |
|
||||||
|
| Tidy the inbox | The titles of the loose tasks in your inbox, the first words of their descriptions, and your project names |
|
||||||
|
| Tasks in a note | That one note's text, and your project names |
|
||||||
|
| Today's plan | The titles and dates of what is due or overdue today |
|
||||||
|
| Mail to task | Sender, subject and the snippet of the mails in that sweep |
|
||||||
|
| Ask | Your question, and the notes and tasks the search matched |
|
||||||
|
| Split a task | That task's title and notes |
|
||||||
|
| Weekly summary | The titles, dates and priorities of your open tasks |
|
||||||
|
|
||||||
|
Never comments, never attachments, never a project the feature was not invoked on,
|
||||||
|
and never anything belonging to somebody else. Nothing is sent to anybody until you
|
||||||
|
configure a provider, and with a local model nothing leaves your machine at all.
|
||||||
|
|
||||||
## Turning it off
|
## Turning it off
|
||||||
|
|
||||||
|
|||||||
@@ -85,7 +85,7 @@ what a person reads is decided by the client, which knows what language they are
|
|||||||
curl -X POST https://todo.example.dk/api/v1/tasks/quick-add \
|
curl -X POST https://todo.example.dk/api/v1/tasks/quick-add \
|
||||||
-H "Authorization: Bearer vrd_..." \
|
-H "Authorization: Bearer vrd_..." \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"text": "betal moms i morgen kl 10 p1 #Firma @regnskab"}'
|
-d '{"text": "file the VAT return tomorrow at 10am p1 #Accounts @tax"}'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Projects and sections
|
### Projects and sections
|
||||||
@@ -108,7 +108,7 @@ curl -X POST https://todo.example.dk/api/v1/tasks/quick-add \
|
|||||||
| Method | Path | |
|
| Method | Path | |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| `GET` | `/today` | Overdue and due today, in your timezone. |
|
| `GET` | `/today` | Overdue and due today, in your timezone. |
|
||||||
| `GET` | `/upcoming?days=7` | One entry per day, empty days included. |
|
| `GET` | `/upcoming?days=7` | One entry per day, empty days included. Up to 31; over that is capped. |
|
||||||
| `GET` | `/search?q=` | Across everything you can see. |
|
| `GET` | `/search?q=` | Across everything you can see. |
|
||||||
| `GET` `POST` | `/filters` | |
|
| `GET` `POST` | `/filters` | |
|
||||||
| `GET` | `/filters/{id}/tasks` | Run one. |
|
| `GET` | `/filters/{id}/tasks` | Run one. |
|
||||||
|
|||||||
@@ -0,0 +1,75 @@
|
|||||||
|
# The install count
|
||||||
|
|
||||||
|
verdande reports that it exists. Two values, once a day:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"instance_id": "01a0806d-3601-7000-ad76-057f1f684881",
|
||||||
|
"version": "v0.44.1"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
That is the whole message. No IP is stored by the collector, no hostname, no
|
||||||
|
domain, no account, no counts of anything you have made, nothing about what you
|
||||||
|
use it for. The payload is small enough to be printed in full on the settings page,
|
||||||
|
and it is printed there — a promise about telemetry is worth exactly as much as
|
||||||
|
your ability to check it.
|
||||||
|
|
||||||
|
## On by default, off in one click
|
||||||
|
|
||||||
|
The alternative that was considered first was compulsory, and the argument against
|
||||||
|
it is practical rather than principled: it cannot be enforced. The domain can be
|
||||||
|
blocked, the binary can be patched, and a fork removes it in its first commit. So
|
||||||
|
mandatory buys nothing over on-by-default while costing the trust the rest of this
|
||||||
|
program works for.
|
||||||
|
|
||||||
|
Which is why the first administrator to sign in is **told, unprompted**, with the
|
||||||
|
real id, the real version and the real address in front of them, and two buttons.
|
||||||
|
On by default is only defensible if it is said out loud without being asked; a
|
||||||
|
settings page where it is stated fully is not the same thing, because that page is
|
||||||
|
opened by people who already suspect there is something to read.
|
||||||
|
|
||||||
|
**Settings → Data** afterwards: one switch. An explicit "off" survives upgrades.
|
||||||
|
|
||||||
|
!!! note "This disagrees with the update check, on purpose"
|
||||||
|
|
||||||
|
`VERDANDE_UPDATE_CHECK` is off unless you ask for it, and its reasoning is that
|
||||||
|
a self-hosted app reaching out unbidden has broken the deal its operator made by
|
||||||
|
self-hosting. That is the same situation as this one, and the two defaults do
|
||||||
|
not agree. The case for treating them differently: the update check reveals an
|
||||||
|
instance to a third party (GitHub) and returns something you can act on, while
|
||||||
|
this returns nothing and goes to the project. Whether that is a distinction or
|
||||||
|
an excuse is a judgement call, and it was made deliberately.
|
||||||
|
|
||||||
|
## What the collector cannot see, and what it can
|
||||||
|
|
||||||
|
A request has a source address whether or not anybody writes it down. The collector
|
||||||
|
stores none and logs none, and the code is arranged so the address never reaches a
|
||||||
|
function that could — the table has nowhere to put one. But the request passes
|
||||||
|
through a reverse proxy and a tunnel on the way, and those keep their own logs.
|
||||||
|
"We send no IP" would be a half-truth; what is true is that nothing here records
|
||||||
|
one.
|
||||||
|
|
||||||
|
The ping is not authenticated either, so anybody can post a made-up id and inflate
|
||||||
|
the count. That is an accepted trade: a token would have to ship inside every
|
||||||
|
install anyway.
|
||||||
|
|
||||||
|
## Running your own count
|
||||||
|
|
||||||
|
Somebody running a fleet points **Settings → Data → Modtagerens adresse** at their
|
||||||
|
own instance, and ticks **Denne instans er tælleren** there. Until that is ticked,
|
||||||
|
`POST /api/v1/beacon` answers **404** rather than accepting quietly — an instance
|
||||||
|
nobody made a collector must not become a bucket anyone can post into.
|
||||||
|
|
||||||
|
The collector's page then shows totals, active in 7 and 30 days, and a breakdown by
|
||||||
|
version. Publishing that number at `/api/v1/beacon/count` is a second, separate
|
||||||
|
opt-in, and it has a floor under it (25 by default): a number that *falls* cannot be
|
||||||
|
published as a fact — a bad release, a DNS change that quietly stops the pings, or
|
||||||
|
lost rows all look like "fewer people use this now" — and a small number mostly says
|
||||||
|
how little it takes to move it.
|
||||||
|
|
||||||
|
## When it cannot reach
|
||||||
|
|
||||||
|
The reason is written down and shown on the settings page. A beacon that cannot
|
||||||
|
reach its collector otherwise fails in complete silence: it tries again tomorrow,
|
||||||
|
the page says "last sent" with a date that quietly gets older, and nobody notices.
|
||||||
@@ -74,7 +74,7 @@ Then enable the APIs and scopes for whichever you want:
|
|||||||
|
|
||||||
| For | Enable | Scope |
|
| For | Enable | Scope |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| Mailboxes | Gmail API | `gmail.readonly` |
|
| Mailboxes | Gmail API | `gmail.modify` |
|
||||||
| Calendar | Google Calendar API | `calendar.readonly` |
|
| Calendar | Google Calendar API | `calendar.readonly` |
|
||||||
|
|
||||||
| Variable | What it does |
|
| Variable | What it does |
|
||||||
@@ -127,11 +127,17 @@ next time each value is written, so turning this on costs nobody a reconnection.
|
|||||||
|
|
||||||
| Variable | Default | What it does |
|
| Variable | Default | What it does |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| `VERDANDE_UPDATE_CHECK` | `false` | Ask GitHub whether a newer release exists. |
|
| `VERDANDE_UPDATE_CHECK` | `false` | Ask GitHub whether a newer release exists, and tell the administrators when one does. |
|
||||||
| `VERDANDE_PANEL_URL` | — | The Yggdrasil panel this instance runs under. |
|
| `VERDANDE_PANEL_URL` | — | The Yggdrasil panel this instance runs under. |
|
||||||
| `VERDANDE_PANEL_TOKEN` | — | An API token from that panel, belonging to somebody with control of this server. |
|
| `VERDANDE_PANEL_TOKEN` | — | An API token from that panel, belonging to somebody with control of this server. |
|
||||||
| `VERDANDE_PANEL_SERVER_ID` | — | Which server to restart — the id in the panel's URL. |
|
| `VERDANDE_PANEL_SERVER_ID` | — | Which server to restart — the id in the panel's URL. |
|
||||||
|
|
||||||
|
With the check on, administrators are told **once per version** — in the bell, in
|
||||||
|
push and on the app's badge — rather than having to open the settings page and
|
||||||
|
look. The notification leads to the page where the restart button is. With the
|
||||||
|
check off nothing is fetched and nothing is said; see
|
||||||
|
[Notifications](notifications.md).
|
||||||
|
|
||||||
All three together let **Settings → Notifications** restart this instance,
|
All three together let **Settings → Notifications** restart this instance,
|
||||||
which is also how it picks up a new version: a container cannot replace its own
|
which is also how it picks up a new version: a container cannot replace its own
|
||||||
image, so the panel recreates it and pulls `:latest` on the way. The request asks
|
image, so the panel recreates it and pulls `:latest` on the way. The request asks
|
||||||
|
|||||||
@@ -18,16 +18,18 @@ forward mail to, and an MCP endpoint so Claude can work your task list directly.
|
|||||||
|
|
||||||
## What it does
|
## What it does
|
||||||
|
|
||||||
- **[Quick add](quick-add.md) that reads what you type.** `betal moms i morgen kl
|
- **[Quick add](quick-add.md) that reads what you type.** `file the VAT return
|
||||||
10 p1 #Firma @regnskab` becomes a task due tomorrow at 10:00, priority 1, in
|
tomorrow at 10am p1 #Accounts @tax` becomes a task due tomorrow at 10:00,
|
||||||
Firma, labelled regnskab. Danish and English, mixed freely in one line.
|
priority 1, in Accounts, labelled tax. Danish and English, mixed freely in one
|
||||||
|
line.
|
||||||
- **Projects, sections, sub-tasks, labels, [saved filters](filters.md).** List,
|
- **Projects, sections, sub-tasks, labels, [saved filters](filters.md).** List,
|
||||||
board and calendar views, and foldable groups over the projects in the sidebar.
|
board and calendar views, and foldable groups over the projects in the sidebar.
|
||||||
The calendar draws each task to its length — drag the foot to resize, the body
|
The calendar draws each task to its length — drag the foot to resize, the body
|
||||||
to move it.
|
to move it.
|
||||||
- **Notes, beside the work.** Rich text to write in, Markdown on disk. Share a
|
- **Notes, beside the work.** Rich text to write in, Markdown on disk. Share a
|
||||||
single note with a person, or file it in a project; `#project` and
|
single note with a person — by name, by email address, or by writing `@Sofie` in
|
||||||
`[[another note]]` are links, and a task shows what has been written about it.
|
the text — or file it in a project; `#project` and `[[another note]]` are links,
|
||||||
|
and a task shows what has been written about it.
|
||||||
- **Delegate, and snooze.** Hand a task to somebody and it is marked with an
|
- **Delegate, and snooze.** Hand a task to somebody and it is marked with an
|
||||||
arrow to them, gathered on a *Waiting on others* page. Snooze one to park it,
|
arrow to them, gathered on a *Waiting on others* page. Snooze one to park it,
|
||||||
greyed, at the foot of the list until a moment you pick — without touching when
|
greyed, at the foot of the list until a moment you pick — without touching when
|
||||||
@@ -37,10 +39,29 @@ forward mail to, and an MCP endpoint so Claude can work your task list directly.
|
|||||||
- **Sharing** with owner, editor and viewer roles. Anyone outside your instance
|
- **Sharing** with owner, editor and viewer roles. Anyone outside your instance
|
||||||
joins through an invite link.
|
joins through an invite link.
|
||||||
- **Live sync** — a change made by somebody else appears without a refresh.
|
- **Live sync** — a change made by somebody else appears without a refresh.
|
||||||
|
- **[Told when it matters](notifications.md).** A bell for what other people did to
|
||||||
|
what you share, pushed to your devices and counted on the app's icon in the Dock.
|
||||||
|
- **[AI that suggests and never writes](ai.md).** Optional, your own key. It tidies
|
||||||
|
the inbox, pulls the tasks out of a meeting note, writes a morning plan, turns
|
||||||
|
*"SV: SV: Vedr. levering uge 12"* into what the mail actually asks for, and
|
||||||
|
answers questions about your own notes with links to what the answer rests on —
|
||||||
|
every one of them as a line you accept, edit or refuse.
|
||||||
- **Repeating tasks** as RRULE, comments and attachments, and reminders that go
|
- **Repeating tasks** as RRULE, comments and attachments, and reminders that go
|
||||||
out as Web Push to an iPhone or a Mac.
|
out as Web Push to an iPhone or a Mac.
|
||||||
- **[Calendar](caldav.md), [mail](mail.md) and [Claude](mcp.md)** connected over
|
- **[Anything can put a task in your inbox](mail.md)** — a mail to your own
|
||||||
open standards rather than private formats.
|
address, or a POST from a shortcut on your phone, a script, or any service that
|
||||||
|
can call a URL.
|
||||||
|
- **[Your mail as an inbox](mailboxes.md).** Star a mail in Gmail, or flag one
|
||||||
|
over IMAP in iCloud or Fastmail, and it becomes a task — and the star or flag
|
||||||
|
comes off once it has, so a starred inbox empties as the tasks are made instead
|
||||||
|
of only filling up.
|
||||||
|
- **[Calendar](caldav.md) and [Claude](mcp.md)** connected over open standards
|
||||||
|
rather than private formats.
|
||||||
|
- **Six themes**, three dark and three light — including *Charcoal*, a warm
|
||||||
|
near-black after Apple Notes — and a size and typeface chosen apart from them.
|
||||||
|
- **Holds through a short network drop.** A save rides out a few seconds of no
|
||||||
|
signal and goes through when it comes back; a reload opens from what it last saw
|
||||||
|
rather than the browser's offline page. It installs as a PWA.
|
||||||
|
|
||||||
## What it looks like
|
## What it looks like
|
||||||
|
|
||||||
@@ -60,6 +81,16 @@ columns.*
|
|||||||
marked with an arrow to them, so a delegated task reads as delegated wherever you
|
marked with an arrow to them, so a delegated task reads as delegated wherever you
|
||||||
meet it.*
|
meet it.*
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
*Charcoal, the newest of six themes — a warm near-black after Apple Notes, with
|
||||||
|
amber where the accent green usually is.*
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
*Six themes — three dark, three light — chosen on the settings page, with the
|
||||||
|
typeface and how tightly it sits set apart from them.*
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
*Where [Gmail](mailboxes.md), the [calendar feed](caldav.md) and the
|
*Where [Gmail](mailboxes.md), the [calendar feed](caldav.md) and the
|
||||||
|
|||||||
@@ -0,0 +1,52 @@
|
|||||||
|
# Opening links
|
||||||
|
|
||||||
|
A link in a task or a note opens in whichever browser your system opens links in.
|
||||||
|
**Settings → Links** can try to change that — and the honest description of what it
|
||||||
|
does is *try*.
|
||||||
|
|
||||||
|
## What a web page cannot do
|
||||||
|
|
||||||
|
Two things, and they set the limits of this feature:
|
||||||
|
|
||||||
|
- **It cannot see which browsers are installed.** The list is deliberately closed:
|
||||||
|
it would be a fingerprint, distinctive enough to follow somebody from site to
|
||||||
|
site.
|
||||||
|
- **It cannot ask the system to use a particular one.** A link goes to the default
|
||||||
|
browser, and there is no API that says otherwise.
|
||||||
|
|
||||||
|
The only handle that exists is the URL schemes browsers register for themselves —
|
||||||
|
`firefox://open-url?url=…`, `googlechrome://…`, `microsoft-edge:…` — and there is no
|
||||||
|
way to ask whether one exists. You can only try it.
|
||||||
|
|
||||||
|
## So the setting is an attempt
|
||||||
|
|
||||||
|
Pick Safari, Chrome, Firefox or Edge, or write your own scheme. When you click a
|
||||||
|
link, that scheme is tried first; if nothing has happened within about half a
|
||||||
|
second, the link opens the ordinary way.
|
||||||
|
|
||||||
|
The fallback is the whole reason this is safe to turn on. Without it, a setting
|
||||||
|
that works on your phone would leave links doing nothing on your desktop.
|
||||||
|
|
||||||
|
In practice: **it works on a phone**, where browsers register these schemes, and
|
||||||
|
**rarely on a Mac or a PC**, where Chrome and Firefox do not. Edge on Windows is
|
||||||
|
the usual exception. There is a **Prøv det** button for exactly this reason — you
|
||||||
|
cannot ask whether a scheme exists, so it is better to find out on example.dk than
|
||||||
|
on a link you meant to follow.
|
||||||
|
|
||||||
|
## Writing your own
|
||||||
|
|
||||||
|
Three placeholders, because browsers disagree about the shape they want the address
|
||||||
|
in:
|
||||||
|
|
||||||
|
| | |
|
||||||
|
| --- | --- |
|
||||||
|
| `{url}` | The address as it is — `x-safari-https://example.dk` |
|
||||||
|
| `{encoded}` | The address as a parameter value — `firefox://open-url?url=https%3A%2F%2F…` |
|
||||||
|
| `{stripped}` | The address without the `https://` — `googlechrome://example.dk` |
|
||||||
|
|
||||||
|
## It belongs to the machine, not the account
|
||||||
|
|
||||||
|
The choice is kept in the browser you are sitting at, not on your account — the
|
||||||
|
same rule the sidebar's width follows. `firefox://` works on the phone and does
|
||||||
|
nothing on the Mac, so a choice that followed the account would be wrong in one of
|
||||||
|
the two places every time.
|
||||||
@@ -67,3 +67,36 @@ immediately.
|
|||||||
|
|
||||||
!!! tip "Keep the address to yourself"
|
!!! tip "Keep the address to yourself"
|
||||||
Treat it like a secret. If you publish it somewhere, rotate it.
|
Treat it like a secret. If you publish it somewhere, rotate it.
|
||||||
|
|
||||||
|
## Pushing from another program
|
||||||
|
|
||||||
|
The address above needs a mail server. When what you want is a shortcut on your
|
||||||
|
phone, a script, or any service that can call a URL, there is a second way in:
|
||||||
|
**Settings → Integrationer → Skub fra andre programmer** gives you an address to
|
||||||
|
POST a line of text to.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST https://todo.example.dk/inbound/hook/<token> \
|
||||||
|
-H "Content-Type: text/plain" \
|
||||||
|
-d "Ring til Anders i morgen p1 #Firma"
|
||||||
|
```
|
||||||
|
|
||||||
|
The body is read three ways, because those are the three you meet: plain text from
|
||||||
|
a shortcut that just sends what was selected, JSON with a `text` field from a
|
||||||
|
service, or a form field from a webhook form. The first line becomes the task and
|
||||||
|
the rest sits underneath it, and the line goes through the [quick add](quick-add.md)
|
||||||
|
parser — so "i morgen", "p1" and "#Firma" mean here what they mean in the box at the
|
||||||
|
top of the app.
|
||||||
|
|
||||||
|
**The address is a key.** It has its own token rather than sharing the mail one:
|
||||||
|
the two are the same kind of secret but they leak separately, and a URL that has
|
||||||
|
been sitting in a shortcut on a lost phone has to be replaceable without changing
|
||||||
|
the address other people have in their address books. A token here can do one
|
||||||
|
thing — put a task in your inbox — which is why it is not an
|
||||||
|
[API token](api.md), which can do everything. Change it under the same setting; the
|
||||||
|
old one stops working at once.
|
||||||
|
|
||||||
|
**POST only.** A GET would be easier to call, and that is exactly the problem: a
|
||||||
|
browser prefetch, a link check in a chat, and a revisited history entry would all
|
||||||
|
create tasks nobody asked for.
|
||||||
|
|
||||||
|
|||||||
@@ -57,9 +57,9 @@ Both endpoints run the same server and reach the same things.
|
|||||||
| `complete_task` | Tick one off. |
|
| `complete_task` | Tick one off. |
|
||||||
| `add_comment` | Comment on a task. |
|
| `add_comment` | Comment on a task. |
|
||||||
|
|
||||||
`create_task` prefers natural language, so *"add betal moms i morgen kl 10 p1
|
`create_task` prefers natural language, so *"add file the VAT return tomorrow at
|
||||||
#Firma"* goes through the same parser the app uses — dates, priorities, projects,
|
10am p1 #Accounts"* goes through the same parser the app uses — dates, priorities,
|
||||||
labels and recurrence in either language.
|
projects, labels and recurrence in either language.
|
||||||
|
|
||||||
## What it can reach
|
## What it can reach
|
||||||
|
|
||||||
|
|||||||
@@ -79,6 +79,37 @@ There is no folder tree. Projects, groups and labels already exist, are already
|
|||||||
shared and already have roles — a second hierarchy to file things in is one too
|
shared and already have roles — a second hierarchy to file things in is one too
|
||||||
many, and a note in a project inherits every one of those answers.
|
many, and a note in a project inherits every one of those answers.
|
||||||
|
|
||||||
|
### Sharing one note with one person
|
||||||
|
|
||||||
|
Filing a note in a project is the right tool when the note belongs with a body of
|
||||||
|
work, and the wrong one when it is just *let Sofie see this*. **Del med personer**
|
||||||
|
at the foot of the note does the second: this note, this person, as reader or
|
||||||
|
editor. Only the note's owner can share it.
|
||||||
|
|
||||||
|
Type an **email address** rather than picking a name, and one of two things
|
||||||
|
happens. An address that already has an account is shared with straight away. One
|
||||||
|
that does not gets an invitation — a link that creates the account and the share
|
||||||
|
together, so the note is theirs the moment they sign up. Invitations wait in the
|
||||||
|
panel under the note, where they can be withdrawn; that is the only way back, since
|
||||||
|
only the token's hash is stored and a link sent to the wrong address cannot be
|
||||||
|
looked up.
|
||||||
|
|
||||||
|
### Naming somebody in a note
|
||||||
|
|
||||||
|
Writing `@Sofie` in a note shares it with her and tells her. Naming somebody in a
|
||||||
|
note *is* wanting them to read it, and doing it as two acts — write the name, then
|
||||||
|
open the panel and find the person — meant the second was forgotten, and the note
|
||||||
|
sat there addressing somebody who could not see it. The editor suggests names after
|
||||||
|
`@`, the same way `#` suggests projects.
|
||||||
|
|
||||||
|
- **Only the owner's mentions share.** An editor may write the name; giving
|
||||||
|
somebody else's note away is the owner's alone.
|
||||||
|
- **As a reader**, which is the least that satisfies "look at this". A role you
|
||||||
|
have raised in the panel is never lowered by a mention.
|
||||||
|
- **Only a name that has just appeared** counts. A note is saved on every typing
|
||||||
|
pause, so without that every save would be another share and another notification
|
||||||
|
about the same name.
|
||||||
|
|
||||||
## Finding
|
## Finding
|
||||||
|
|
||||||
The list groups itself: favourites first, then **Today**, **Yesterday**, **This
|
The list groups itself: favourites first, then **Today**, **Yesterday**, **This
|
||||||
|
|||||||
@@ -0,0 +1,51 @@
|
|||||||
|
# Notifications
|
||||||
|
|
||||||
|
What other people did that you need to know about, and what the day has in it.
|
||||||
|
Verdande tells you in three places at once, and they are the same thing said three
|
||||||
|
ways: the **bell** in the header, a **push** to your devices, and the **badge** on
|
||||||
|
the app's icon.
|
||||||
|
|
||||||
|
## What causes one
|
||||||
|
|
||||||
|
| | |
|
||||||
|
| --- | --- |
|
||||||
|
| Somebody edited a note shared with you | Repeat edits fold into one line while it is unread |
|
||||||
|
| Somebody shared a note with you | Once, when it happens |
|
||||||
|
| Somebody named you in a note with `@` | Instead of "edited a note" — one act, one message |
|
||||||
|
| Somebody gave you a task | Only on the change, and only to the person who got it |
|
||||||
|
| Somebody commented | |
|
||||||
|
| [Today's plan](ai.md), if you turned it on | In the morning, at the hour you chose — it opens the card on **I dag** |
|
||||||
|
| A new version is out | Administrators only, once per version |
|
||||||
|
|
||||||
|
Not your own actions: the server does not tell anybody what they just did
|
||||||
|
themselves. And not everything that happens — a bell that rings at every change in
|
||||||
|
a shared project is a bell people stop looking at.
|
||||||
|
|
||||||
|
**Repeat edits are folded.** A note is saved on every typing pause, so one person
|
||||||
|
writing for five minutes would otherwise be twenty identical lines. While the
|
||||||
|
message is unread, a further edit moves it back to the top and says who touched it
|
||||||
|
last. Once you have read it, the next edit is a new thing to be told.
|
||||||
|
|
||||||
|
## Push, and the badge
|
||||||
|
|
||||||
|
**Settings → Beskeder** turns on Web Push for the device you are sitting at, per
|
||||||
|
device: the phone in your pocket and the laptop you have open are different
|
||||||
|
answers, and a permission granted on one is not the other's.
|
||||||
|
|
||||||
|
The **badge** — the number on the icon in the Dock on a Mac, on the taskbar on a
|
||||||
|
PC — needs the app to be installed (added to the Dock, or installed as an app in
|
||||||
|
Chrome or Edge). Half the point of being told is being told while you are doing
|
||||||
|
something else, and the icon is the only place the app can say anything then. It
|
||||||
|
counts unread messages and goes down by itself as you read them. Firefox does not
|
||||||
|
support it; nothing else changes there.
|
||||||
|
|
||||||
|
The sentence you see is written in your browser from *what happened* and *who did
|
||||||
|
it*, so an English interface gets an English bell. The server's own wording is
|
||||||
|
Danish and is used only for push, which has no dictionary to look a phrase up in.
|
||||||
|
|
||||||
|
## Telling you about a new version
|
||||||
|
|
||||||
|
If the [update check](configuration.md) is on, administrators get one notification
|
||||||
|
per version — never one a day about the same one — and it leads to
|
||||||
|
**Settings → Beskeder**, where the button that restarts the instance to update it
|
||||||
|
sits. With the check off, nothing is fetched and nothing is said.
|
||||||
@@ -832,9 +832,9 @@ paths:
|
|||||||
tags: [tasks]
|
tags: [tasks]
|
||||||
summary: Create a task from one line of natural language.
|
summary: Create a task from one line of natural language.
|
||||||
description: |
|
description: |
|
||||||
Danish and English. `betal moms i morgen kl 10 p1 #Firma @vigtigt` becomes
|
Danish and English. `file the VAT return tomorrow at 10am p1 #Accounts @tax`
|
||||||
a task due tomorrow at 10:00, priority 1, in the project Firma, labelled
|
becomes a task due tomorrow at 10:00, priority 1, in the project Accounts,
|
||||||
vigtigt. An unknown `#project` is not an error — the task goes to the
|
labelled tax. An unknown `#project` is not an error — the task goes to the
|
||||||
Inbox rather than a thought being thrown away over a typo.
|
Inbox rather than a thought being thrown away over a typo.
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
@@ -1250,7 +1250,7 @@ paths:
|
|||||||
|
|
||||||
The one click that opens Google's consent screen already exists. What it
|
The one click that opens Google's consent screen already exists. What it
|
||||||
needs behind it is a registered client, and no app can conjure one: Google
|
needs behind it is a registered client, and no app can conjure one: Google
|
||||||
issues no Gmail access to an unregistered client, and `gmail.readonly` is a
|
issues no Gmail access to an unregistered client, and `gmail.modify` is a
|
||||||
restricted scope, so an id shipped inside a public image would be both
|
restricted scope, so an id shipped inside a public image would be both
|
||||||
extractable from it and unusable without Google's security review of every
|
extractable from it and unusable without Google's security review of every
|
||||||
deployment that used it.
|
deployment that used it.
|
||||||
@@ -1564,7 +1564,15 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
installs: { type: integer }
|
installs:
|
||||||
|
type: [integer, "null"]
|
||||||
|
description: |
|
||||||
|
Null below the collector's floor (`publish_min`, 25 by
|
||||||
|
default). A number that *falls* cannot be published as a
|
||||||
|
fact — a bad release, a DNS change that quietly stops the
|
||||||
|
pings, or lost rows all look like "fewer people use this
|
||||||
|
now" — and a small number mostly says how little it takes
|
||||||
|
to move it.
|
||||||
window_days: { type: integer }
|
window_days: { type: integer }
|
||||||
"404":
|
"404":
|
||||||
description: Not a collector, or not published.
|
description: Not a collector, or not published.
|
||||||
@@ -1590,7 +1598,19 @@ paths:
|
|||||||
version: { type: string }
|
version: { type: string }
|
||||||
is_collector: { type: boolean }
|
is_collector: { type: boolean }
|
||||||
publish_count: { type: boolean }
|
publish_count: { type: boolean }
|
||||||
|
publish_min:
|
||||||
|
type: integer
|
||||||
|
description: The floor under the published count.
|
||||||
last_ping_at: { type: string, format: date-time }
|
last_ping_at: { type: string, format: date-time }
|
||||||
|
last_error:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Why the last attempt did not arrive; absent when the last
|
||||||
|
one did. Shown rather than only logged: a beacon that
|
||||||
|
cannot reach its collector otherwise fails in complete
|
||||||
|
silence, and the only trace is a "last sent" date that
|
||||||
|
quietly gets older.
|
||||||
|
last_error_at: { type: string, format: date-time }
|
||||||
put:
|
put:
|
||||||
tags: [auth]
|
tags: [auth]
|
||||||
summary: Turn the beacon off, or point it somewhere else. Administrators only.
|
summary: Turn the beacon off, or point it somewhere else. Administrators only.
|
||||||
@@ -1610,12 +1630,74 @@ paths:
|
|||||||
make the server reach inside its own network.
|
make the server reach inside its own network.
|
||||||
is_collector: { type: boolean }
|
is_collector: { type: boolean }
|
||||||
publish_count: { type: boolean }
|
publish_count: { type: boolean }
|
||||||
|
publish_min: { type: integer, minimum: 0 }
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: The configuration as it now stands.
|
description: The configuration as it now stands.
|
||||||
"422":
|
"422":
|
||||||
description: The collector address is not an http or https URL.
|
description: The collector address is not an http or https URL.
|
||||||
|
|
||||||
|
/api/v1/beacon/notice:
|
||||||
|
get:
|
||||||
|
tags: [auth]
|
||||||
|
summary: Whether the disclosure is still owed, and what it says. Administrators only.
|
||||||
|
description: |
|
||||||
|
The beacon is on by default, and that is only defensible if it is said
|
||||||
|
unprompted. A settings page where it is stated fully is not the same as
|
||||||
|
saying it: that page is opened by people who already suspect there is
|
||||||
|
something to read.
|
||||||
|
|
||||||
|
The three values are in the response — the real id, the real version, the
|
||||||
|
real collector address — so the notice can show what is sent rather than
|
||||||
|
say "anonymous data" and ask to be believed.
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
pending:
|
||||||
|
type: boolean
|
||||||
|
description: False once anybody has answered, panel-wide.
|
||||||
|
enabled: { type: boolean }
|
||||||
|
instance_id: { type: string }
|
||||||
|
version: { type: string }
|
||||||
|
collector_url: { type: string }
|
||||||
|
post:
|
||||||
|
tags: [auth]
|
||||||
|
summary: Answer the notice. Administrators only.
|
||||||
|
description: |
|
||||||
|
One call for both answers — "keep it on" and "turn it off" are the same
|
||||||
|
act, somebody deciding, and two endpoints would mean one of them could
|
||||||
|
forget to record that a decision was made.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
required: [keep]
|
||||||
|
properties:
|
||||||
|
keep:
|
||||||
|
type: boolean
|
||||||
|
description: |
|
||||||
|
Required, and rejected when absent. An empty body must not be
|
||||||
|
able to mean "turn it off": an opt-out nobody chose is as much
|
||||||
|
a broken promise as an opt-in nobody chose.
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Recorded.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
enabled: { type: boolean }
|
||||||
|
"422":
|
||||||
|
description: No answer was given.
|
||||||
|
|
||||||
/api/v1/panel/restart:
|
/api/v1/panel/restart:
|
||||||
post:
|
post:
|
||||||
tags: [auth]
|
tags: [auth]
|
||||||
@@ -2365,7 +2447,12 @@ paths:
|
|||||||
tags: [views]
|
tags: [views]
|
||||||
summary: The next few days, empty ones included.
|
summary: The next few days, empty ones included.
|
||||||
parameters:
|
parameters:
|
||||||
- { name: days, in: query, schema: { type: integer, default: 7 } }
|
- {
|
||||||
|
name: days,
|
||||||
|
in: query,
|
||||||
|
description: "How many days to return, counting today. Above the maximum is capped, not refused.",
|
||||||
|
schema: { type: integer, default: 7, minimum: 1, maximum: 31 },
|
||||||
|
}
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: OK
|
description: OK
|
||||||
@@ -2713,6 +2800,25 @@ paths:
|
|||||||
responses:
|
responses:
|
||||||
"200": { $ref: "#/components/responses/MailAddress" }
|
"200": { $ref: "#/components/responses/MailAddress" }
|
||||||
|
|
||||||
|
/api/v1/hook-url:
|
||||||
|
get:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Your personal address for pushing a task in from somewhere else.
|
||||||
|
description: >
|
||||||
|
Minted on first ask. Its own token rather than the mail one: the two are
|
||||||
|
the same kind of secret, but they leak separately — a URL that has been
|
||||||
|
sitting in a shortcut on a lost phone has to be replaceable without
|
||||||
|
changing the address other people have in their address books.
|
||||||
|
responses:
|
||||||
|
"200": { $ref: "#/components/responses/HookURL" }
|
||||||
|
|
||||||
|
/api/v1/hook-url/rotate:
|
||||||
|
post:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Issue a new push address, retiring the old one at once.
|
||||||
|
responses:
|
||||||
|
"200": { $ref: "#/components/responses/HookURL" }
|
||||||
|
|
||||||
/api/v1/notifications:
|
/api/v1/notifications:
|
||||||
get:
|
get:
|
||||||
tags: [integrations]
|
tags: [integrations]
|
||||||
@@ -3012,6 +3118,12 @@ paths:
|
|||||||
post:
|
post:
|
||||||
tags: [notes]
|
tags: [notes]
|
||||||
summary: Write a note.
|
summary: Write a note.
|
||||||
|
description: >
|
||||||
|
`#Projekt` files the note against a project and `[[Another note]]` links to
|
||||||
|
one. A third, `@Name`, shares the note with that person as a viewer and
|
||||||
|
tells them — only the owner's mentions share, and only a name that has just
|
||||||
|
appeared in the text counts, so a note saved on every typing pause does not
|
||||||
|
share itself twice.
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
@@ -3075,6 +3187,11 @@ paths:
|
|||||||
patch:
|
patch:
|
||||||
tags: [notes]
|
tags: [notes]
|
||||||
summary: Change a note. Every field is optional; what is sent is what changes.
|
summary: Change a note. Every field is optional; what is sent is what changes.
|
||||||
|
description: >
|
||||||
|
A name written with an `@` that was not in the text before shares the note
|
||||||
|
with that person as a viewer and tells them. Only the owner's mentions
|
||||||
|
share — an editor may write the name, but giving somebody else's note away
|
||||||
|
is the owner's alone — and a role already granted is never lowered by one.
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
@@ -3121,25 +3238,103 @@ paths:
|
|||||||
candidates:
|
candidates:
|
||||||
type: array
|
type: array
|
||||||
items: { $ref: "#/components/schemas/Person" }
|
items: { $ref: "#/components/schemas/Person" }
|
||||||
|
invites:
|
||||||
|
description: >
|
||||||
|
Addresses invited to the note that have not been taken up yet.
|
||||||
|
There is no account behind them, so there is no name or colour
|
||||||
|
to show — the address is all there is until they arrive.
|
||||||
|
type: array
|
||||||
|
items: { $ref: "#/components/schemas/NoteInvite" }
|
||||||
|
follows:
|
||||||
|
description: >
|
||||||
|
The notes this one points at with [[links]], which are shared
|
||||||
|
alongside it. Owner's own notes only.
|
||||||
|
type: array
|
||||||
|
items: { $ref: "#/components/schemas/NoteFollow" }
|
||||||
"404": { $ref: "#/components/responses/NotFound" }
|
"404": { $ref: "#/components/responses/NotFound" }
|
||||||
post:
|
post:
|
||||||
tags: [notes]
|
tags: [notes]
|
||||||
summary: Share a note with a person, or change the role they hold.
|
summary: Share a note with a person, or change the role they hold.
|
||||||
|
description: >
|
||||||
|
The person is named either by `user_id` — somebody picked from the
|
||||||
|
candidates — or by `email`. An address that already has an account is
|
||||||
|
shared with straight away; one that does not gets an invitation, which
|
||||||
|
becomes the share the moment the account is created (201).
|
||||||
|
|
||||||
|
The notes this one points at with [[links]] are shared with the same person
|
||||||
|
and the same role, so a link in a shared note leads somewhere. Only notes
|
||||||
|
the sharer owns follow, and the response lists them.
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
required: [user_id]
|
description: One of user_id or email.
|
||||||
properties:
|
properties:
|
||||||
user_id: { type: string }
|
user_id: { type: string }
|
||||||
|
email: { type: string, format: email }
|
||||||
role: { type: string, enum: [viewer, editor] }
|
role: { type: string, enum: [viewer, editor] }
|
||||||
responses:
|
responses:
|
||||||
"204": { description: Shared }
|
"200":
|
||||||
|
description: Shared
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
user:
|
||||||
|
description: >
|
||||||
|
Who it was shared with. Sent back because a caller that shared
|
||||||
|
by address does not otherwise know who it reached.
|
||||||
|
$ref: "#/components/schemas/Person"
|
||||||
|
role: { type: string, enum: [viewer, editor] }
|
||||||
|
follows:
|
||||||
|
type: array
|
||||||
|
items: { $ref: "#/components/schemas/NoteFollow" }
|
||||||
|
"201":
|
||||||
|
description: >
|
||||||
|
Invited. The address has no account yet, so a link that creates one and
|
||||||
|
the share together has been issued.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
invited: { $ref: "#/components/schemas/NoteInvite" }
|
||||||
|
link:
|
||||||
|
description: The signup link, shown so it can be passed on.
|
||||||
|
type: string
|
||||||
|
emailed:
|
||||||
|
description: >
|
||||||
|
False when the instance has no mail configured, which is when
|
||||||
|
the link is the only way the invitation reaches anybody.
|
||||||
|
type: boolean
|
||||||
"404": { $ref: "#/components/responses/NotFound" }
|
"404": { $ref: "#/components/responses/NotFound" }
|
||||||
|
"409": { $ref: "#/components/responses/Conflict" }
|
||||||
"422": { $ref: "#/components/responses/Validation" }
|
"422": { $ref: "#/components/responses/Validation" }
|
||||||
|
|
||||||
|
/api/v1/notes/{noteID}/invites/{inviteID}:
|
||||||
|
delete:
|
||||||
|
tags: [notes]
|
||||||
|
summary: Withdraw an invitation to a note before it is used.
|
||||||
|
description: >
|
||||||
|
The only way back. Only the token's hash is stored, so a link sent to the
|
||||||
|
wrong address cannot be looked up and invalidated — only the row it belongs
|
||||||
|
to can.
|
||||||
|
parameters:
|
||||||
|
- name: noteID
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema: { type: string }
|
||||||
|
- name: inviteID
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema: { type: string }
|
||||||
|
responses:
|
||||||
|
"204": { description: Withdrawn }
|
||||||
|
"404": { $ref: "#/components/responses/NotFound" }
|
||||||
|
|
||||||
/api/v1/notes/{noteID}/shares/{userID}:
|
/api/v1/notes/{noteID}/shares/{userID}:
|
||||||
delete:
|
delete:
|
||||||
tags: [notes]
|
tags: [notes]
|
||||||
@@ -3337,6 +3532,247 @@ paths:
|
|||||||
$ref: "#/components/responses/Conflict"
|
$ref: "#/components/responses/Conflict"
|
||||||
"502": { $ref: "#/components/responses/Upstream" }
|
"502": { $ref: "#/components/responses/Upstream" }
|
||||||
|
|
||||||
|
/api/v1/ai/inbox/tidy:
|
||||||
|
post:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Suggest how the loose tasks in the inbox could have been written.
|
||||||
|
description: |
|
||||||
|
Suggests, never writes. Each suggestion is the line the person would have
|
||||||
|
typed — quick-add syntax, the same one parser as everywhere else — so it
|
||||||
|
can be read and edited by whoever it is put to, rather than being a set of
|
||||||
|
fields a model filled in that you take or leave.
|
||||||
|
|
||||||
|
The model is given the projects that exist and may name no other: a
|
||||||
|
`#Project` it invented would create one by accident the first time
|
||||||
|
somebody said yes.
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The suggestions, one per task, and none for a task already filed well.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
suggestions:
|
||||||
|
type: array
|
||||||
|
items: { $ref: "#/components/schemas/AISuggestion" }
|
||||||
|
"409": { $ref: "#/components/responses/Conflict" }
|
||||||
|
"502": { $ref: "#/components/responses/Upstream" }
|
||||||
|
|
||||||
|
/api/v1/ai/inbox/tidy/apply:
|
||||||
|
post:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Write one accepted suggestion into the task it is about.
|
||||||
|
description: |
|
||||||
|
The line is parsed here rather than in the browser, so "tomorrow" means
|
||||||
|
what it means everywhere else — and a suggestion edited by hand before it
|
||||||
|
was accepted is read exactly like one that was not.
|
||||||
|
|
||||||
|
Only what the line actually says is applied. A missing date means "the
|
||||||
|
line said nothing about a date", never "clear the one that is there". A
|
||||||
|
project the model invented moves nothing.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
required: [task_id, line]
|
||||||
|
properties:
|
||||||
|
task_id: { type: string }
|
||||||
|
line: { type: string }
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The task as it now stands.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema: { $ref: "#/components/schemas/Task" }
|
||||||
|
"404": { $ref: "#/components/responses/NotFound" }
|
||||||
|
"422": { $ref: "#/components/responses/Validation" }
|
||||||
|
|
||||||
|
/api/v1/ai/notes/{noteID}/actions:
|
||||||
|
parameters:
|
||||||
|
- { name: noteID, in: path, required: true, schema: { type: string } }
|
||||||
|
post:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Pull what somebody committed to out of a note.
|
||||||
|
description: |
|
||||||
|
Only things somebody committed to or was asked to do — a heading is not a
|
||||||
|
task, a topic discussed is not a task. An empty array is a useful answer
|
||||||
|
and a made-up list is not.
|
||||||
|
|
||||||
|
Each suggestion quotes the words it came from, so a wrong one can be seen
|
||||||
|
through rather than merely being wrong.
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
suggestions:
|
||||||
|
type: array
|
||||||
|
items: { $ref: "#/components/schemas/AISuggestion" }
|
||||||
|
"404": { $ref: "#/components/responses/NotFound" }
|
||||||
|
"409": { $ref: "#/components/responses/Conflict" }
|
||||||
|
"502": { $ref: "#/components/responses/Upstream" }
|
||||||
|
|
||||||
|
/api/v1/ai/notes/{noteID}/actions/apply:
|
||||||
|
parameters:
|
||||||
|
- { name: noteID, in: path, required: true, schema: { type: string } }
|
||||||
|
post:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Create one accepted task from a note.
|
||||||
|
description: |
|
||||||
|
The note is not touched. Writing the link back into it would make the two
|
||||||
|
point at each other, and a text a program edits without being asked is a
|
||||||
|
text people stop trusting — so the task carries where it came from, as a
|
||||||
|
`[[note title]]` in its description, and the note is left alone.
|
||||||
|
|
||||||
|
The note's own project is the default; a `#Project` in the line wins,
|
||||||
|
because typing it is a choice and inheriting is a circumstance.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
required: [line]
|
||||||
|
properties:
|
||||||
|
line: { type: string }
|
||||||
|
responses:
|
||||||
|
"201":
|
||||||
|
description: Created
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema: { $ref: "#/components/schemas/Task" }
|
||||||
|
"404": { $ref: "#/components/responses/NotFound" }
|
||||||
|
"422": { $ref: "#/components/responses/Validation" }
|
||||||
|
|
||||||
|
/api/v1/ai/plan:
|
||||||
|
get:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Whether a morning plan is sent, and at what hour.
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema: { $ref: "#/components/schemas/DailyPlanSettings" }
|
||||||
|
put:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Turn the morning plan on or off, or move the hour.
|
||||||
|
description: |
|
||||||
|
The hour is local to the person. Moving it clears the "already sent today"
|
||||||
|
mark, so somebody who moves the plan from 07 to 16 gets it this afternoon
|
||||||
|
rather than tomorrow — a setting whose effect you have to wait a day to
|
||||||
|
see is a setting nobody dares turn on.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
enabled: { type: boolean }
|
||||||
|
hour: { type: integer, minimum: 0, maximum: 23 }
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema: { $ref: "#/components/schemas/DailyPlanSettings" }
|
||||||
|
"422": { $ref: "#/components/responses/Validation" }
|
||||||
|
|
||||||
|
/api/v1/ai/plan/now:
|
||||||
|
post:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Make today's plan now, to whoever asks.
|
||||||
|
requestBody:
|
||||||
|
required: false
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
silent:
|
||||||
|
type: boolean
|
||||||
|
description: >
|
||||||
|
Make and store it without sending a notification — the card on
|
||||||
|
Today asking for a plan while somebody is looking at it. A
|
||||||
|
notification about something in front of you is the kind that
|
||||||
|
teaches people to ignore the bell.
|
||||||
|
description: |
|
||||||
|
The counts come from the database and the sentence from the model, in that
|
||||||
|
order: a model that counted for itself would sometimes count wrong, and a
|
||||||
|
plan that says four tasks where there are three is worse than no plan.
|
||||||
|
With no model configured the counts stand on their own, which is what you
|
||||||
|
needed to know at seven in the morning anyway.
|
||||||
|
|
||||||
|
Nothing due and nothing overdue sends nothing. A morning with nothing to
|
||||||
|
do is a good morning, and a notification saying "there is nothing" teaches
|
||||||
|
people to stop opening notifications.
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The plan, and whether it was sent.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
plan: { type: string }
|
||||||
|
sent: { type: boolean }
|
||||||
|
|
||||||
|
/api/v1/ai/ask:
|
||||||
|
post:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Ask a question of your own notes and tasks.
|
||||||
|
description: |
|
||||||
|
Search finds what contains the words. This answers the question — "what
|
||||||
|
did I promise Anders in August?" — which is not the same: the answer is
|
||||||
|
spread over three notes and a task, and none of them contains the word
|
||||||
|
"promise".
|
||||||
|
|
||||||
|
Two halves, and the order is the whole of the safety in it. The database
|
||||||
|
finds the candidates with the search that already exists and that already
|
||||||
|
only sees what this person may see. The model is given those and nothing
|
||||||
|
else — it does not look anything up and cannot ask for more.
|
||||||
|
|
||||||
|
The answer carries what it rests on. A model that says "you did, on the
|
||||||
|
14th" is only useful if you can open the note it read that in.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
required: [question]
|
||||||
|
properties:
|
||||||
|
question: { type: string }
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: |
|
||||||
|
The answer, and the passages it rests on — only those, not everything
|
||||||
|
that was looked at. An empty answer means nothing matched.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
answer: { type: string }
|
||||||
|
sources:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
kind: { type: string, enum: [note, task] }
|
||||||
|
id: { type: string }
|
||||||
|
title: { type: string }
|
||||||
|
"409": { $ref: "#/components/responses/Conflict" }
|
||||||
|
"422": { $ref: "#/components/responses/Validation" }
|
||||||
|
"502": { $ref: "#/components/responses/Upstream" }
|
||||||
|
|
||||||
/api/v1/mcp:
|
/api/v1/mcp:
|
||||||
post:
|
post:
|
||||||
tags: [integrations]
|
tags: [integrations]
|
||||||
@@ -3658,6 +4094,69 @@ paths:
|
|||||||
task_id: { type: string }
|
task_id: { type: string }
|
||||||
"404": { description: "No such address. Identical to a malformed one, deliberately." }
|
"404": { description: "No such address. Identical to a malformed one, deliberately." }
|
||||||
|
|
||||||
|
/inbound/hook/{token}:
|
||||||
|
post:
|
||||||
|
tags: [integrations]
|
||||||
|
summary: Push a task into somebody's inbox from another program.
|
||||||
|
description: |
|
||||||
|
The token in the path is the whole credential — the caller is a shortcut on
|
||||||
|
a phone or a script, and neither can sign in. A token here can do one
|
||||||
|
thing: create a task in that person's inbox. An API token can do everything,
|
||||||
|
which is why this is not one.
|
||||||
|
|
||||||
|
The body is read three ways, because those are the three you meet: JSON from
|
||||||
|
a service, a form field from a webhook form, and plain text from a shortcut
|
||||||
|
that just sends what was selected. The first line becomes the task and the
|
||||||
|
rest sits underneath it, and the line goes through the quick-add parser — so
|
||||||
|
"Ring til Anders i morgen p1 #Firma" means here what it means in the box at
|
||||||
|
the top of the app.
|
||||||
|
|
||||||
|
POST only. A GET would be easier to call, and that is exactly the problem:
|
||||||
|
a browser prefetch, a link check in a chat, and a revisited history entry
|
||||||
|
would all create tasks nobody asked for.
|
||||||
|
security: []
|
||||||
|
parameters:
|
||||||
|
- name: token
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema: { type: string }
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
text/plain:
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: First line the task, the rest its description.
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
text: { type: string }
|
||||||
|
title: { description: Same as text. }
|
||||||
|
content: { description: Same as text. }
|
||||||
|
note: { type: string }
|
||||||
|
body: { description: Same as note. }
|
||||||
|
description: { description: Same as note. }
|
||||||
|
application/x-www-form-urlencoded:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
text: { type: string }
|
||||||
|
note: { type: string }
|
||||||
|
responses:
|
||||||
|
"201":
|
||||||
|
description: Created
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
task_id: { type: string }
|
||||||
|
content: { type: string }
|
||||||
|
"404": { description: "No such address. Identical to a malformed one, deliberately." }
|
||||||
|
"422": { $ref: "#/components/responses/Validation" }
|
||||||
|
"429": { description: Too many pushes; the address is rate limited. }
|
||||||
|
|
||||||
/oauth/gmail/callback:
|
/oauth/gmail/callback:
|
||||||
get:
|
get:
|
||||||
tags: [integrations]
|
tags: [integrations]
|
||||||
@@ -3924,6 +4423,15 @@ components:
|
|||||||
type: array
|
type: array
|
||||||
items: { type: string }
|
items: { type: string }
|
||||||
|
|
||||||
|
HookURL:
|
||||||
|
description: The address another program pushes to.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
url: { type: string }
|
||||||
|
|
||||||
schemas:
|
schemas:
|
||||||
Calendar:
|
Calendar:
|
||||||
type: object
|
type: object
|
||||||
@@ -4030,6 +4538,74 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
user: { $ref: "#/components/schemas/Person" }
|
user: { $ref: "#/components/schemas/Person" }
|
||||||
role: { type: string, enum: [viewer, editor] }
|
role: { type: string, enum: [viewer, editor] }
|
||||||
|
linked:
|
||||||
|
description: >
|
||||||
|
True when the person has this note because another shared note points
|
||||||
|
at it, rather than because it was shared with them on its own. Such a
|
||||||
|
grant is taken back by removing the link or the share it came from, not
|
||||||
|
by removing it here.
|
||||||
|
type: boolean
|
||||||
|
via:
|
||||||
|
description: The title of the shared note that points at this one.
|
||||||
|
type: string
|
||||||
|
|
||||||
|
NoteFollow:
|
||||||
|
type: object
|
||||||
|
description: A note that is shared alongside another because that one links to it.
|
||||||
|
properties:
|
||||||
|
note_id: { type: string }
|
||||||
|
title: { type: string }
|
||||||
|
|
||||||
|
DailyPlanSettings:
|
||||||
|
type: object
|
||||||
|
description: >
|
||||||
|
One person's morning plan, and today's plan itself. One resource, because
|
||||||
|
it is one thing: the plan is the resource and the setting is when it gets
|
||||||
|
made.
|
||||||
|
properties:
|
||||||
|
enabled: { type: boolean }
|
||||||
|
hour:
|
||||||
|
type: integer
|
||||||
|
description: Local to the person, because seven o'clock is seven different places.
|
||||||
|
last_sent:
|
||||||
|
type: string
|
||||||
|
description: The date it last went out, in that person's own timezone.
|
||||||
|
plan:
|
||||||
|
type: string
|
||||||
|
description: >
|
||||||
|
Today's plan as it was sent — kept rather than recomputed on every
|
||||||
|
look. A plan that says something different when you look at it than it
|
||||||
|
said when it arrived is worse than either. Absent when the stored plan
|
||||||
|
is from another day.
|
||||||
|
plan_date: { type: string }
|
||||||
|
plan_at:
|
||||||
|
type: integer
|
||||||
|
description: Unix seconds. Shown on the card, because a plan made at seven reads differently at four.
|
||||||
|
|
||||||
|
AISuggestion:
|
||||||
|
type: object
|
||||||
|
description: >
|
||||||
|
One proposed line, in quick-add syntax, plus one sentence on why it looks
|
||||||
|
like that. Nothing has happened yet — a suggestion becomes something when
|
||||||
|
somebody says yes to it.
|
||||||
|
properties:
|
||||||
|
task_id:
|
||||||
|
type: string
|
||||||
|
description: >
|
||||||
|
The task the suggestion is about, when it is about one that already
|
||||||
|
exists. Absent when the suggestion is a new task.
|
||||||
|
line: { type: string, example: "Ring til Anders i morgen p1 #Firma" }
|
||||||
|
why: { type: string }
|
||||||
|
|
||||||
|
NoteInvite:
|
||||||
|
type: object
|
||||||
|
description: >
|
||||||
|
A share on a note that is waiting for an account. The address is the whole
|
||||||
|
of who the person is until they sign up.
|
||||||
|
properties:
|
||||||
|
id: { type: string }
|
||||||
|
email: { type: string, format: email }
|
||||||
|
role: { type: string, enum: [viewer, editor] }
|
||||||
|
|
||||||
Mailbox:
|
Mailbox:
|
||||||
type: object
|
type: object
|
||||||
@@ -4519,12 +5095,22 @@ components:
|
|||||||
|
|
||||||
Notification:
|
Notification:
|
||||||
type: object
|
type: object
|
||||||
|
description: >
|
||||||
|
Something somebody else did that you need to know about. `kind` says what
|
||||||
|
happened and the client composes the sentence from it, so the bell follows
|
||||||
|
the reader's language; `title` is the server's own Danish wording, used for
|
||||||
|
Web Push, which has no dictionary to look words up in.
|
||||||
properties:
|
properties:
|
||||||
id: { type: string }
|
id: { type: string }
|
||||||
actor_name: { type: string }
|
actor_name: { type: string }
|
||||||
project_id: { type: string }
|
project_id: { type: string }
|
||||||
task_id: { type: string }
|
task_id: { type: string }
|
||||||
kind: { type: string }
|
note_id:
|
||||||
|
description: Set on a notification about a note — a shared note somebody else edited.
|
||||||
|
type: string
|
||||||
|
kind:
|
||||||
|
type: string
|
||||||
|
enum: [assigned, note.changed, comment]
|
||||||
title: { type: string }
|
title: { type: string }
|
||||||
body: { type: string }
|
body: { type: string }
|
||||||
read: { type: boolean }
|
read: { type: boolean }
|
||||||
|
|||||||
@@ -3,11 +3,11 @@
|
|||||||
One line in, a fully-formed task out.
|
One line in, a fully-formed task out.
|
||||||
|
|
||||||
```
|
```
|
||||||
betal moms i morgen kl 10 p1 #Firma @regnskab
|
file the VAT return tomorrow at 10am p1 #Accounts @tax
|
||||||
```
|
```
|
||||||
|
|
||||||
becomes a task called **betal moms**, due tomorrow at 10:00, priority 1, in the
|
becomes a task called **file the VAT return**, due tomorrow at 10:00, priority 1,
|
||||||
Firma project, labelled regnskab.
|
in the Accounts project, labelled tax.
|
||||||
|
|
||||||
The parts it understands are tinted underneath the text as you type, so you can see
|
The parts it understands are tinted underneath the text as you type, so you can see
|
||||||
it being read before you commit to it.
|
it being read before you commit to it.
|
||||||
@@ -16,8 +16,8 @@ it being read before you commit to it.
|
|||||||
|
|
||||||
| You type | It means |
|
| You type | It means |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `#Firma` | Put it in that project. `#"Q3 rapport"` for a name with spaces. |
|
| `#Accounts` | Put it in that project. `#"Q3 report"` for a name with spaces. |
|
||||||
| `@regnskab` | Add that label. As many as you like. |
|
| `@tax` | Add that label. As many as you like. |
|
||||||
| `p1` … `p4` | Priority. `!!!`, `!!` and `!` also work. |
|
| `p1` … `p4` | Priority. `!!!`, `!!` and `!` also work. |
|
||||||
| `i dag`, `i morgen`, `i overmorgen` | Today, tomorrow, the day after. |
|
| `i dag`, `i morgen`, `i overmorgen` | Today, tomorrow, the day after. |
|
||||||
| `mandag`, `på fredag` | The next such weekday. |
|
| `mandag`, `på fredag` | The next such weekday. |
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 248 KiB After Width: | Height: | Size: 248 KiB |
|
Before Width: | Height: | Size: 308 KiB After Width: | Height: | Size: 308 KiB |
|
Before Width: | Height: | Size: 228 KiB After Width: | Height: | Size: 221 KiB |
|
Before Width: | Height: | Size: 147 KiB After Width: | Height: | Size: 148 KiB |
|
Before Width: | Height: | Size: 333 KiB After Width: | Height: | Size: 334 KiB |
|
Before Width: | Height: | Size: 245 KiB After Width: | Height: | Size: 245 KiB |
|
After Width: | Height: | Size: 346 KiB |
|
Before Width: | Height: | Size: 282 KiB After Width: | Height: | Size: 283 KiB |
|
Before Width: | Height: | Size: 370 KiB After Width: | Height: | Size: 367 KiB |
|
Before Width: | Height: | Size: 356 KiB After Width: | Height: | Size: 352 KiB |
|
Before Width: | Height: | Size: 229 KiB After Width: | Height: | Size: 232 KiB |
|
Before Width: | Height: | Size: 253 KiB After Width: | Height: | Size: 260 KiB |
|
After Width: | Height: | Size: 237 KiB |
|
After Width: | Height: | Size: 232 KiB |
|
After Width: | Height: | Size: 245 KiB |
|
After Width: | Height: | Size: 244 KiB |
|
After Width: | Height: | Size: 244 KiB |
|
After Width: | Height: | Size: 246 KiB |
|
Before Width: | Height: | Size: 238 KiB After Width: | Height: | Size: 245 KiB |
|
Before Width: | Height: | Size: 243 KiB After Width: | Height: | Size: 245 KiB |
|
Before Width: | Height: | Size: 243 KiB After Width: | Height: | Size: 244 KiB |
|
Before Width: | Height: | Size: 218 KiB After Width: | Height: | Size: 220 KiB |
|
Before Width: | Height: | Size: 227 KiB After Width: | Height: | Size: 220 KiB |
@@ -395,22 +395,266 @@ back, do not congratulate, and do not offer productivity advice.`, language)
|
|||||||
return c.Complete(ctx, system, []Message{{Role: "user", Content: prompt}})
|
return c.Complete(ctx, system, []Message{{Role: "user", Content: prompt}})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Suggestion er én foreslået opgave, skrevet som en linje, man selv kunne have
|
||||||
|
// tastet.
|
||||||
|
//
|
||||||
|
// `line` er quick-add-syntaks — "Ring til Anders i morgen p1 #Firma" — og ikke et
|
||||||
|
// felt pr. egenskab. To grunde, og den anden er den vigtige. Parseren findes
|
||||||
|
// allerede og er den samme, uanset hvor teksten kom fra, så der er ingen anden
|
||||||
|
// fortolkning at holde i takt med den. Og et forslag, der er skrevet i det sprog,
|
||||||
|
// man selv skriver i, kan læses og rettes af den, det bliver stillet til — hvor
|
||||||
|
// et sæt felter, en model har udfyldt, er noget, man skal tage eller lade være.
|
||||||
|
//
|
||||||
|
// `why` er én sætning om, hvorfor den ser sådan ud. Den står ved siden af
|
||||||
|
// forslaget, så et forkert gæt kan gennemskues frem for bare at være forkert.
|
||||||
|
type Suggestion struct {
|
||||||
|
Line string `json:"line"`
|
||||||
|
Why string `json:"why,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// TidyInbox foreslår, hvordan løse opgaver i indbakken kunne skrives færdig.
|
||||||
|
//
|
||||||
|
// Modellen får de projekter, der findes, og må kun bruge dem: et `#Nyt Projekt`,
|
||||||
|
// den fandt på, ville lave et projekt ved et uheld, første gang nogen sagde ja.
|
||||||
|
func (c *Client) TidyInbox(ctx context.Context, tasks, projects []string, today, locale string) ([]Suggestion, error) {
|
||||||
|
language := languageOf(locale)
|
||||||
|
|
||||||
|
known := "none"
|
||||||
|
if len(projects) > 0 {
|
||||||
|
known = "#" + strings.Join(projects, ", #")
|
||||||
|
}
|
||||||
|
|
||||||
|
system := fmt.Sprintf(`You tidy up a task inbox.
|
||||||
|
|
||||||
|
For each task you are given, write the line the person would have typed if they
|
||||||
|
had filed it properly. Keep their own words for what the task is — you are filing
|
||||||
|
it, not rewriting it.
|
||||||
|
|
||||||
|
The line may carry, in this syntax and no other:
|
||||||
|
#Project one of these existing projects, and never one that is not: %s
|
||||||
|
p1..p4 priority, where p1 is most urgent
|
||||||
|
a date in plain %s, such as "i morgen", "on friday", "15/3"
|
||||||
|
|
||||||
|
Leave out anything the task does not tell you. A guessed deadline is worse than
|
||||||
|
none: the person can add one, but they cannot see a wrong one you invented.
|
||||||
|
Today is %s.
|
||||||
|
|
||||||
|
Reply with a JSON array and nothing else — no prose, no code fence. Each element
|
||||||
|
is {"line": "...", "why": "..."} where why is at most one short sentence in %s
|
||||||
|
saying what you read out of the task. Give one element per task, in the order you
|
||||||
|
were given them, and leave a task out entirely if it is already filed well.`,
|
||||||
|
known, language, today, language)
|
||||||
|
|
||||||
|
prompt := "Tasks:\n" + strings.Join(tasks, "\n")
|
||||||
|
return c.suggestions(ctx, system, prompt)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ActionsInNote trækker det, nogen har lovet, ud af en note.
|
||||||
|
//
|
||||||
|
// Beskrivelsen er stram med vilje. En model, der får lov at "finde opgaver" i en
|
||||||
|
// tekst, finder også emner, overskrifter og gode idéer — og så er resultatet en
|
||||||
|
// liste, man skal luge i, hvilket er dyrere end at skrive de tre punkter selv.
|
||||||
|
func (c *Client) ActionsInNote(ctx context.Context, note string, projects []string, today, locale string) ([]Suggestion, error) {
|
||||||
|
language := languageOf(locale)
|
||||||
|
|
||||||
|
known := "none"
|
||||||
|
if len(projects) > 0 {
|
||||||
|
known = "#" + strings.Join(projects, ", #")
|
||||||
|
}
|
||||||
|
|
||||||
|
system := fmt.Sprintf(`You read a note and pull out what somebody has to do.
|
||||||
|
|
||||||
|
Only things somebody committed to or was asked to do. A heading is not a task, a
|
||||||
|
topic that was discussed is not a task, and an idea nobody agreed to is not a
|
||||||
|
task. If the note contains none, reply with an empty array — that is a useful
|
||||||
|
answer and a made-up list is not.
|
||||||
|
|
||||||
|
Write each one as the line the person would have typed, in %s, in this syntax and
|
||||||
|
no other:
|
||||||
|
#Project one of these existing projects, and never one that is not: %s
|
||||||
|
p1..p4 priority, where p1 is most urgent
|
||||||
|
a date in plain %s, only when the note actually gives one
|
||||||
|
|
||||||
|
Today is %s.
|
||||||
|
|
||||||
|
Reply with a JSON array and nothing else — no prose, no code fence. Each element
|
||||||
|
is {"line": "...", "why": "..."} where why quotes the few words in the note that
|
||||||
|
the task came from, so it can be checked.`, language, known, language, today)
|
||||||
|
|
||||||
|
return c.suggestions(ctx, system, "Note:\n"+note)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DailyPlan skriver morgenens to-tre linjer.
|
||||||
|
//
|
||||||
|
// Tallene er talt i basen og gives med som kendsgerninger, modellen ikke må regne
|
||||||
|
// om. En plan, der siger fire opgaver, hvor der er tre, er værre end ingen plan —
|
||||||
|
// og en model, der tæller en liste, tæller den forkert af og til.
|
||||||
|
//
|
||||||
|
// Det ene sted, den må mene noget, er hvad man skulle begynde med, og hvad der
|
||||||
|
// kunne vente. Det er dét, der gør det til en plan frem for en optælling.
|
||||||
|
func (c *Client) DailyPlan(ctx context.Context, tasks []string, due, overdue int, locale string) (string, error) {
|
||||||
|
language := languageOf(locale)
|
||||||
|
|
||||||
|
system := fmt.Sprintf(`You write somebody's morning note about their own day.
|
||||||
|
|
||||||
|
Write in %s. At most three short lines, no greeting, no sign-off, no
|
||||||
|
encouragement. Say what to start with and why. Name at most one thing that could
|
||||||
|
wait or be dropped, and only if something obviously can.
|
||||||
|
|
||||||
|
These numbers are counted for you and are facts: %d due today, %d overdue. Do not
|
||||||
|
recount them, do not contradict them, and do not list every task back.`,
|
||||||
|
language, due, overdue)
|
||||||
|
|
||||||
|
return c.Complete(ctx, system, []Message{
|
||||||
|
{Role: "user", Content: "The tasks:\n" + strings.Join(tasks, "\n")},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ask svarer på et spørgsmål ud fra de tekststykker, den får med — og kun dem.
|
||||||
|
//
|
||||||
|
// Svaret skal bære sine kilder, og det er derfor svaret er JSON og ikke prosa: en
|
||||||
|
// model, der skriver "[3]" midt i en sætning, gør det af og til, og en, der
|
||||||
|
// afleverer nummeret i et felt, gør det hver gang. Fladen skal kunne lave et link,
|
||||||
|
// ikke lede efter kantede parenteser i en tekst.
|
||||||
|
//
|
||||||
|
// "Det står der ikke" er et rigtigt svar. En model, der hellere gætter end
|
||||||
|
// skuffer, er ubrugelig til netop det her: man spørger om sine egne noter, fordi
|
||||||
|
// man ikke selv kan huske det, og har derfor ingen mulighed for at se, at svaret
|
||||||
|
// var opfundet.
|
||||||
|
func (c *Client) Ask(ctx context.Context, question string, passages []string, locale string) (string, []int, error) {
|
||||||
|
language := languageOf(locale)
|
||||||
|
|
||||||
|
system := fmt.Sprintf(`You answer a question from somebody's own notes and tasks.
|
||||||
|
|
||||||
|
Use only the passages given. If they do not answer the question, say so plainly —
|
||||||
|
that is a useful answer, and a guess is not: the person is asking because they
|
||||||
|
cannot remember, so they cannot tell an invented answer from a real one.
|
||||||
|
|
||||||
|
Write in %s, at most four short lines. Reply with a JSON object and nothing else:
|
||||||
|
{"answer": "...", "sources": [1, 3]} where sources are the numbers of the
|
||||||
|
passages the answer actually rests on, and nothing else.`, language)
|
||||||
|
|
||||||
|
prompt := "Question: " + question + "\n\nPassages:\n" + strings.Join(passages, "\n\n")
|
||||||
|
|
||||||
|
reply, err := c.Complete(ctx, system, []Message{{Role: "user", Content: prompt}})
|
||||||
|
if err != nil {
|
||||||
|
return "", nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var out struct {
|
||||||
|
Answer string `json:"answer"`
|
||||||
|
Sources []int `json:"sources"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal([]byte(extractObject(reply)), &out); err != nil {
|
||||||
|
// Et svar, der ikke er JSON, er stadig et svar. Teksten er det, personen
|
||||||
|
// spurgte om; henvisningerne er det, der går tabt, og det er en dårligere
|
||||||
|
// dag end en fejlmeddelelse ville være.
|
||||||
|
return strings.TrimSpace(reply), nil, nil
|
||||||
|
}
|
||||||
|
return strings.TrimSpace(out.Answer), out.Sources, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TasksFromMail skriver én opgavelinje pr. mail.
|
||||||
|
//
|
||||||
|
// Emnefeltet er skrevet til at blive genkendt i en indbakke, ikke til at blive
|
||||||
|
// gjort noget ved: "SV: SV: Vedr. levering uge 12" siger, hvilken tråd det er, og
|
||||||
|
// intet om, hvad man skal. Modellen skriver den handling, mailen beder om — og
|
||||||
|
// lader være, hvis den ikke beder om nogen.
|
||||||
|
func (c *Client) TasksFromMail(ctx context.Context, mails []string, today, locale string) ([]Suggestion, error) {
|
||||||
|
language := languageOf(locale)
|
||||||
|
|
||||||
|
system := fmt.Sprintf(`You turn emails into the tasks they ask for.
|
||||||
|
|
||||||
|
For each numbered email, write the line the recipient would have typed for
|
||||||
|
themselves — what they have to DO, in %s, starting with a verb. Keep the sender's
|
||||||
|
name in it when it matters who it is about. Not a summary of the email: the
|
||||||
|
action it asks for.
|
||||||
|
|
||||||
|
The line may carry a date in plain %s, and p1..p4 for priority, but only when the
|
||||||
|
email itself says so — "before friday" in the text is a date, an email that merely
|
||||||
|
sounds urgent is not. Today is %s.
|
||||||
|
|
||||||
|
Reply with a JSON array and nothing else — no prose, no code fence. Each element
|
||||||
|
is {"line": "N. ..."} keeping the number the email was given, so the line can be
|
||||||
|
put back on the right one. Leave an email out entirely if it asks for nothing.`,
|
||||||
|
language, language, today)
|
||||||
|
|
||||||
|
return c.suggestions(ctx, system, "Emails:\n"+strings.Join(mails, "\n"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// suggestions er den fælles halvdel: spørg, læs svaret som JSON, og smid det væk,
|
||||||
|
// der ikke er en linje.
|
||||||
|
//
|
||||||
|
// Et tomt svar er ikke en fejl. "Der er ikke noget at foreslå" er et rigtigt svar
|
||||||
|
// på begge spørgsmål, og en fejlmeddelelse ville lære folk, at funktionen er i
|
||||||
|
// stykker, når den i virkeligheden var enig med dem.
|
||||||
|
func (c *Client) suggestions(ctx context.Context, system, prompt string) ([]Suggestion, error) {
|
||||||
|
reply, err := c.Complete(ctx, system, []Message{{Role: "user", Content: prompt}})
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var out []Suggestion
|
||||||
|
if err := json.Unmarshal([]byte(extractJSON(reply)), &out); err != nil {
|
||||||
|
return nil, fmt.Errorf("ai: the model did not return a list: %s", truncate(reply, 200))
|
||||||
|
}
|
||||||
|
|
||||||
|
clean := make([]Suggestion, 0, len(out))
|
||||||
|
for _, s := range out {
|
||||||
|
s.Line = strings.TrimSpace(s.Line)
|
||||||
|
s.Why = strings.TrimSpace(s.Why)
|
||||||
|
if s.Line != "" {
|
||||||
|
clean = append(clean, s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return clean, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// languageOf er det sprog, svaret skal skrives i. Ét sted, fordi det ellers er
|
||||||
|
// den slags, der bliver rettet ét sted ud af fire.
|
||||||
|
func languageOf(locale string) string {
|
||||||
|
if strings.HasPrefix(strings.ToLower(locale), "en") {
|
||||||
|
return "English"
|
||||||
|
}
|
||||||
|
return "Danish"
|
||||||
|
}
|
||||||
|
|
||||||
|
// unfence tager svaret ud af den kodeblok, modeller pakker det ind i, uanset hvor
|
||||||
|
// omhyggeligt de bliver bedt om at lade være.
|
||||||
|
func unfence(reply string) string {
|
||||||
|
reply = strings.TrimSpace(reply)
|
||||||
|
fence := strings.Index(reply, "```")
|
||||||
|
if fence < 0 {
|
||||||
|
return reply
|
||||||
|
}
|
||||||
|
rest := reply[fence+3:]
|
||||||
|
if newline := strings.IndexByte(rest, '\n'); newline >= 0 {
|
||||||
|
rest = rest[newline+1:]
|
||||||
|
}
|
||||||
|
if end := strings.Index(rest, "```"); end >= 0 {
|
||||||
|
return strings.TrimSpace(rest[:end])
|
||||||
|
}
|
||||||
|
return reply
|
||||||
|
}
|
||||||
|
|
||||||
|
// extractObject er extractJSON for et objekt frem for en liste. Samme problem,
|
||||||
|
// samme løsning: modeller pakker svar ind i en kodeblok, hvor omhyggeligt de end
|
||||||
|
// bliver bedt om at lade være.
|
||||||
|
func extractObject(reply string) string {
|
||||||
|
reply = unfence(reply)
|
||||||
|
start := strings.IndexByte(reply, '{')
|
||||||
|
end := strings.LastIndexByte(reply, '}')
|
||||||
|
if start >= 0 && end > start {
|
||||||
|
return reply[start : end+1]
|
||||||
|
}
|
||||||
|
return reply
|
||||||
|
}
|
||||||
|
|
||||||
// extractJSON pulls an array out of a reply that may have been wrapped in a code
|
// extractJSON pulls an array out of a reply that may have been wrapped in a code
|
||||||
// fence or preceded by a sentence, which models do however firmly they are asked
|
// fence or preceded by a sentence, which models do however firmly they are asked
|
||||||
// not to.
|
// not to.
|
||||||
func extractJSON(reply string) string {
|
func extractJSON(reply string) string {
|
||||||
reply = strings.TrimSpace(reply)
|
reply = unfence(reply)
|
||||||
|
|
||||||
if fence := strings.Index(reply, "```"); fence >= 0 {
|
|
||||||
rest := reply[fence+3:]
|
|
||||||
if newline := strings.IndexByte(rest, '\n'); newline >= 0 {
|
|
||||||
rest = rest[newline+1:]
|
|
||||||
}
|
|
||||||
if end := strings.Index(rest, "```"); end >= 0 {
|
|
||||||
reply = strings.TrimSpace(rest[:end])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
start := strings.IndexByte(reply, '[')
|
start := strings.IndexByte(reply, '[')
|
||||||
end := strings.LastIndexByte(reply, ']')
|
end := strings.LastIndexByte(reply, ']')
|
||||||
if start >= 0 && end > start {
|
if start >= 0 && end > start {
|
||||||
|
|||||||
@@ -1,14 +1,20 @@
|
|||||||
// Package gmail is the small slice of the Gmail API verdande needs, and the scope
|
// Package gmail is the small slice of the Gmail API verdande needs, and the scope
|
||||||
// it asks for.
|
// it asks for.
|
||||||
//
|
//
|
||||||
// The connection is one-way on purpose: a starred or labelled message becomes a
|
// The one thing verdande writes back is the star. A starred message becomes a
|
||||||
// task, and nothing verdande does afterwards touches the mailbox. Unstarring the
|
// task, and once it has, the star comes off — exactly as the IMAP side takes the
|
||||||
// message does not delete the task, completing the task does not unstar the
|
// flag off a mail it has imported, and for the same reason: the star meant "turn
|
||||||
// message. Two-way would mean deciding what to do when both sides changed, and the
|
// this into a task", the task now exists, so the star is no longer true. Nothing
|
||||||
// only honest answer to that is a synchronisation model far bigger than the feature.
|
// else is touched. Completing the task does not reach back to the mail; the mail
|
||||||
|
// is a pointer the task was made from, not a copy the two have to be kept in step.
|
||||||
//
|
//
|
||||||
// Scope is gmail.readonly. verdande never needs to send, modify or delete, and
|
// That one write is why the scope is gmail.modify rather than gmail.readonly.
|
||||||
// asking for less is what makes the consent screen something a person can agree to.
|
// Removing the STARRED label is a modify, and Gmail offers no narrower scope that
|
||||||
|
// can do it — so the consent screen asks for more than it used to, and the trade
|
||||||
|
// is deliberate: a starred inbox that empties itself as the tasks are made, rather
|
||||||
|
// than one that fills with stars nothing ever clears. Still not send, still not
|
||||||
|
// delete — modify is labels, and the only label verdande removes is the one that
|
||||||
|
// triggered the task.
|
||||||
//
|
//
|
||||||
// The OAuth flow itself moved to internal/google when Calendar needed the same one.
|
// The OAuth flow itself moved to internal/google when Calendar needed the same one.
|
||||||
// The names below are aliases so that every call site — and this package's own
|
// The names below are aliases so that every call site — and this package's own
|
||||||
@@ -27,8 +33,10 @@ import (
|
|||||||
"github.com/kristianwind/verdande/internal/google"
|
"github.com/kristianwind/verdande/internal/google"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Read-only, and only mail. Not profile, not contacts, not send.
|
// Read mail and change its labels, and only mail. Not profile, not contacts, not
|
||||||
const Scope = "https://www.googleapis.com/auth/gmail.readonly"
|
// send, not delete. The single write is removing the STARRED label from a message
|
||||||
|
// that has become a task; see the package comment for why that costs modify.
|
||||||
|
const Scope = "https://www.googleapis.com/auth/gmail.modify"
|
||||||
|
|
||||||
const defaultAPIBase = "https://gmail.googleapis.com/gmail/v1"
|
const defaultAPIBase = "https://gmail.googleapis.com/gmail/v1"
|
||||||
|
|
||||||
@@ -169,6 +177,25 @@ func (c *Client) get(ctx context.Context, url string, out any) error {
|
|||||||
return google.Get(ctx, c.http, c.accessToken, url, out)
|
return google.Get(ctx, c.http, c.accessToken, url, out)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Unstar takes the star off the given messages — one call for all of them, the way
|
||||||
|
// the IMAP side unflags a batch, so a sweep that made ten tasks is one write and
|
||||||
|
// not ten.
|
||||||
|
//
|
||||||
|
// STARRED is a system label whose id is its name, so no lookup is needed; a custom
|
||||||
|
// label would need one, and verdande removes none. batchModify answers 204 with no
|
||||||
|
// body on success. An empty list is a no-op, not a call: batchModify with no ids is
|
||||||
|
// an error on Google's side and nothing worth making a round trip to hear.
|
||||||
|
func (c *Client) Unstar(ctx context.Context, ids []string) error {
|
||||||
|
if len(ids) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
body := struct {
|
||||||
|
IDs []string `json:"ids"`
|
||||||
|
RemoveLabelIDs []string `json:"removeLabelIds"`
|
||||||
|
}{IDs: ids, RemoveLabelIDs: []string{"STARRED"}}
|
||||||
|
return google.Post(ctx, c.http, c.accessToken, c.api()+"/users/me/messages/batchModify", body, nil)
|
||||||
|
}
|
||||||
|
|
||||||
// SenderName pulls "Anders Jensen" out of "Anders Jensen <anders@example.dk>",
|
// SenderName pulls "Anders Jensen" out of "Anders Jensen <anders@example.dk>",
|
||||||
// falling back to the address when there is no display name.
|
// falling back to the address when there is no display name.
|
||||||
func SenderName(from string) string {
|
func SenderName(from string) string {
|
||||||
|
|||||||
@@ -1,16 +1,81 @@
|
|||||||
package gmail
|
package gmail
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The scope is the one thing verdande chooses about the connection, and it is the
|
// The scope is the one thing verdande chooses about the connection, and it is the
|
||||||
// one the person reads on the consent screen. The flow itself is exercised in
|
// one the person reads on the consent screen. The flow itself is exercised in
|
||||||
// internal/google; what belongs here is that Gmail still asks for read-only mail.
|
// internal/google; what belongs here is that Gmail asks for modify — read plus the
|
||||||
func TestTheScopeIsReadOnlyMail(t *testing.T) {
|
// one write it makes, taking the star off an imported message — and nothing wider.
|
||||||
if !strings.HasSuffix(Scope, "gmail.readonly") {
|
func TestTheScopeIsModifyMail(t *testing.T) {
|
||||||
t.Errorf("scope = %q; verdande never needs to send or modify", Scope)
|
if !strings.HasSuffix(Scope, "gmail.modify") {
|
||||||
|
t.Errorf("scope = %q; want gmail.modify — read, plus removing the star", Scope)
|
||||||
|
}
|
||||||
|
// Modify is the ceiling. Send, or the full account, would be a different promise
|
||||||
|
// to the person on the consent screen than the one this feature needs.
|
||||||
|
for _, wider := range []string{"gmail.send", "mail.google.com", "gmail.settings"} {
|
||||||
|
if strings.Contains(Scope, wider) {
|
||||||
|
t.Errorf("scope = %q; must not include %q", Scope, wider)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unstar removes the star from a batch in one call, and it addresses the messages
|
||||||
|
// it was given and only the STARRED label.
|
||||||
|
func TestUnstarRemovesOnlyTheStar(t *testing.T) {
|
||||||
|
var gotPath string
|
||||||
|
var gotBody struct {
|
||||||
|
IDs []string `json:"ids"`
|
||||||
|
AddLabelIDs []string `json:"addLabelIds"`
|
||||||
|
RemoveLabelIDs []string `json:"removeLabelIds"`
|
||||||
|
}
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
gotPath = r.URL.Path
|
||||||
|
raw, _ := io.ReadAll(r.Body)
|
||||||
|
_ = json.Unmarshal(raw, &gotBody)
|
||||||
|
w.WriteHeader(http.StatusNoContent) // what batchModify answers on success
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
err := NewClient("token").At(srv.URL).Unstar(context.Background(), []string{"a", "b"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Unstar: %v", err)
|
||||||
|
}
|
||||||
|
if !strings.HasSuffix(gotPath, "/users/me/messages/batchModify") {
|
||||||
|
t.Errorf("path = %q, want the batchModify endpoint", gotPath)
|
||||||
|
}
|
||||||
|
if strings.Join(gotBody.IDs, ",") != "a,b" {
|
||||||
|
t.Errorf("ids = %v, want [a b]", gotBody.IDs)
|
||||||
|
}
|
||||||
|
if strings.Join(gotBody.RemoveLabelIDs, ",") != "STARRED" {
|
||||||
|
t.Errorf("removeLabelIds = %v, want [STARRED]", gotBody.RemoveLabelIDs)
|
||||||
|
}
|
||||||
|
if len(gotBody.AddLabelIDs) != 0 {
|
||||||
|
t.Errorf("addLabelIds = %v, want none — verdande adds no label", gotBody.AddLabelIDs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// An empty batch is not a request: Gmail rejects a batchModify with no ids, and
|
||||||
|
// there is nothing to say to it anyway.
|
||||||
|
func TestUnstarOfNothingMakesNoCall(t *testing.T) {
|
||||||
|
called := false
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(http.ResponseWriter, *http.Request) {
|
||||||
|
called = true
|
||||||
|
}))
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
if err := NewClient("token").At(srv.URL).Unstar(context.Background(), nil); err != nil {
|
||||||
|
t.Fatalf("Unstar(nil): %v", err)
|
||||||
|
}
|
||||||
|
if called {
|
||||||
|
t.Error("Unstar(nil) made a request; it should make none")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -215,6 +215,40 @@ func Get(ctx context.Context, client *http.Client, accessToken, url string, out
|
|||||||
return json.NewDecoder(resp.Body).Decode(out)
|
return json.NewDecoder(resp.Body).Decode(out)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Post sends a JSON body to a Google API and, unlike Get, does not insist on a
|
||||||
|
// body coming back. A write call — modifying labels on a message — answers with
|
||||||
|
// 204 No Content when it worked, so anything 2xx is success and only the body is
|
||||||
|
// decoded, and only when the caller asked for one.
|
||||||
|
func Post(ctx context.Context, client *http.Client, accessToken, url string, body, out any) error {
|
||||||
|
payload, err := json.Marshal(body)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, strings.NewReader(string(payload)))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
req.Header.Set("Authorization", "Bearer "+accessToken)
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
|
||||||
|
resp, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
if resp.StatusCode == http.StatusUnauthorized {
|
||||||
|
return ErrUnauthorized
|
||||||
|
}
|
||||||
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
|
return fmt.Errorf("google: %s", resp.Status)
|
||||||
|
}
|
||||||
|
if out == nil || resp.StatusCode == http.StatusNoContent {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return json.NewDecoder(resp.Body).Decode(out)
|
||||||
|
}
|
||||||
|
|
||||||
func randomString(n int) (string, error) {
|
func randomString(n int) (string, error) {
|
||||||
b := make([]byte, n)
|
b := make([]byte, n)
|
||||||
if _, err := rand.Read(b); err != nil {
|
if _, err := rand.Read(b); err != nil {
|
||||||
|
|||||||
@@ -0,0 +1,203 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/kristianwind/verdande/internal/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Spørg om sine egne noter og opgaver i almindeligt sprog.
|
||||||
|
//
|
||||||
|
// Søgningen finder det, der indeholder ordene. Det her svarer på spørgsmålet —
|
||||||
|
// "hvad lovede jeg Anders i august?" — og det er ikke det samme: svaret står
|
||||||
|
// spredt over tre noter og en opgave, og ingen af dem indeholder ordet "lovede".
|
||||||
|
//
|
||||||
|
// To halvdele, og rækkefølgen er hele sikkerheden i det. Basen finder kandidaterne
|
||||||
|
// med den søgning, der allerede findes, og som allerede kun kan se det, personen
|
||||||
|
// selv må se. Modellen får kun dem — den slår ikke selv noget op og kan ikke bede
|
||||||
|
// om mere. Et svar, der ikke står i det udleverede, kan derfor ikke handle om
|
||||||
|
// nogen andens noter.
|
||||||
|
//
|
||||||
|
// Og svaret bærer, hvad det er bygget på. En model, der svarer "det gjorde du den
|
||||||
|
// 14.", er kun brugbar, hvis man kan slå op i den note, den læste det i.
|
||||||
|
|
||||||
|
type askRequest struct {
|
||||||
|
Question string `json:"question"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type askSourceJSON struct {
|
||||||
|
Kind string `json:"kind"` // "note" eller "task"
|
||||||
|
ID string `json:"id"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleAIAsk svarer på et spørgsmål ud fra personens egne noter og opgaver.
|
||||||
|
func (s *Server) handleAIAsk(w http.ResponseWriter, r *http.Request) {
|
||||||
|
var req askRequest
|
||||||
|
if err := decodeJSON(w, r, &req); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
question := strings.TrimSpace(req.Question)
|
||||||
|
if question == "" {
|
||||||
|
writeFieldErrors(w, map[string]string{"question": "required"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
user := userFrom(r.Context())
|
||||||
|
client, ok := s.aiClientFor(w, r)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ord for ord, ikke hele spørgsmålet på én gang.
|
||||||
|
//
|
||||||
|
// Søgningen kræver, at *alle* ord optræder, og det er den rigtige regel for et
|
||||||
|
// søgefelt: skriver man to ord, mener man begge. Men et spørgsmål er ikke en
|
||||||
|
// søgning — "hvad lovede jeg Anders i august" indeholder ét ord, der står i
|
||||||
|
// noten, og fem, der ikke gør, så et krav om dem alle finder ingenting hver
|
||||||
|
// eneste gang.
|
||||||
|
//
|
||||||
|
// Så: et groft net her, og modellen læser fangsten. Alternativet — at lade
|
||||||
|
// modellen skrive søgningen — lægger et led mere ind, der kan tage fejl,
|
||||||
|
// mellem spørgsmålet og de noter, der faktisk findes.
|
||||||
|
notes, tasks, err := s.candidatesFor(r, user.ID, question)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "search for the question", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if len(notes) == 0 && len(tasks) == 0 {
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{
|
||||||
|
"answer": "", "sources": []askSourceJSON{},
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nummereret, fordi svaret skal kunne pege tilbage. En henvisning til "noten
|
||||||
|
// om leveringen" er ikke noget, fladen kan lave et link ud af; et nummer er.
|
||||||
|
sources := make([]askSourceJSON, 0, len(notes)+len(tasks))
|
||||||
|
passages := make([]string, 0, len(notes)+len(tasks))
|
||||||
|
for _, n := range notes {
|
||||||
|
sources = append(sources, askSourceJSON{Kind: "note", ID: n.ID, Title: n.Title})
|
||||||
|
passages = append(passages, "["+itoaSource(len(sources))+"] Note: "+n.Title+"\n"+
|
||||||
|
firstWords(n.Body, 300))
|
||||||
|
}
|
||||||
|
for _, t := range tasks {
|
||||||
|
sources = append(sources, askSourceJSON{Kind: "task", ID: t.ID, Title: t.Content})
|
||||||
|
line := "[" + itoaSource(len(sources)) + "] Task: " + t.Content
|
||||||
|
if t.DueDate != "" {
|
||||||
|
line += " (" + t.DueDate + ")"
|
||||||
|
}
|
||||||
|
if t.Description != "" {
|
||||||
|
line += "\n" + firstWords(t.Description, 60)
|
||||||
|
}
|
||||||
|
passages = append(passages, line)
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, cancel := contextWithTimeout(r, 90*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
answer, used, err := client.Ask(ctx, question, passages, user.Locale)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("ai ask", "err", err)
|
||||||
|
writeError(w, StatusUpstreamRefused, CodeInternal, err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Kun de kilder, svaret faktisk brugte. Alle tolv ville gøre henvisningen
|
||||||
|
// værdiløs: en liste over alt, der blev kigget i, er ikke det samme som det,
|
||||||
|
// svaret står på.
|
||||||
|
cited := make([]askSourceJSON, 0, len(used))
|
||||||
|
for _, n := range used {
|
||||||
|
if n >= 1 && n <= len(sources) {
|
||||||
|
cited = append(cited, sources[n-1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"answer": answer, "sources": cited})
|
||||||
|
}
|
||||||
|
|
||||||
|
func itoaSource(n int) string {
|
||||||
|
if n < 10 {
|
||||||
|
return string(rune('0' + n))
|
||||||
|
}
|
||||||
|
return string(rune('0'+n/10)) + string(rune('0'+n%10))
|
||||||
|
}
|
||||||
|
|
||||||
|
// candidatesFor henter det, spørgsmålet kunne handle om.
|
||||||
|
//
|
||||||
|
// Ét opslag pr. ord, lagt sammen og med det, der rammes af flere ord, øverst: et
|
||||||
|
// spørgsmål har ét eller to bærende ord og en håndfuld, der bare er dansk, og den
|
||||||
|
// note, der indeholder begge de bærende, er den, det handler om.
|
||||||
|
//
|
||||||
|
// Korte ord springes over. "i", "på" og "the" står i alt, og en note, der blev
|
||||||
|
// hentet, fordi den indeholder "i", fortrænger en, der faktisk svarer.
|
||||||
|
func (s *Server) candidatesFor(r *http.Request, userID, question string) ([]store.Note, []store.Task, error) {
|
||||||
|
terms := store.SearchTerms(question)
|
||||||
|
|
||||||
|
type scored struct {
|
||||||
|
note store.Note
|
||||||
|
task store.Task
|
||||||
|
hits int
|
||||||
|
}
|
||||||
|
noteHits := map[string]*scored{}
|
||||||
|
taskHits := map[string]*scored{}
|
||||||
|
|
||||||
|
for _, term := range terms {
|
||||||
|
if len([]rune(term)) < 3 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
found, err := s.db.SearchNotes(r.Context(), term, 10)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
for _, n := range found {
|
||||||
|
if at, ok := noteHits[n.ID]; ok {
|
||||||
|
at.hits++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
noteHits[n.ID] = &scored{note: n, hits: 1}
|
||||||
|
}
|
||||||
|
|
||||||
|
tasks, err := s.db.ListTasks(r.Context(), userID, store.TaskFilter{
|
||||||
|
Search: term, Limit: 10, IncludeCompleted: true,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
for _, t := range tasks {
|
||||||
|
if at, ok := taskHits[t.ID]; ok {
|
||||||
|
at.hits++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
taskHits[t.ID] = &scored{task: t, hits: 1}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
notes := make([]store.Note, 0, len(noteHits))
|
||||||
|
for _, at := range noteHits {
|
||||||
|
notes = append(notes, at.note)
|
||||||
|
}
|
||||||
|
sort.SliceStable(notes, func(i, j int) bool {
|
||||||
|
return noteHits[notes[i].ID].hits > noteHits[notes[j].ID].hits
|
||||||
|
})
|
||||||
|
|
||||||
|
tasks := make([]store.Task, 0, len(taskHits))
|
||||||
|
for _, at := range taskHits {
|
||||||
|
tasks = append(tasks, at.task)
|
||||||
|
}
|
||||||
|
sort.SliceStable(tasks, func(i, j int) bool {
|
||||||
|
return taskHits[tasks[i].ID].hits > taskHits[tasks[j].ID].hits
|
||||||
|
})
|
||||||
|
|
||||||
|
// Loftet er, hvad der kan stå i én prompt uden at koste mere, end svaret er
|
||||||
|
// værd — og hvad et menneske ville have gidet læse igennem selv.
|
||||||
|
return capped(notes, 12), capped(tasks, 20), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func capped[T any](in []T, n int) []T {
|
||||||
|
if len(in) > n {
|
||||||
|
return in[:n]
|
||||||
|
}
|
||||||
|
return in
|
||||||
|
}
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/kristianwind/verdande/internal/ai"
|
||||||
|
"github.com/kristianwind/verdande/internal/quickadd"
|
||||||
|
"github.com/kristianwind/verdande/internal/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
// En mail, der bliver til en brugbar opgave.
|
||||||
|
//
|
||||||
|
// Uden det her hedder opgaven, hvad mailen hed: "Anders Jensen: SV: SV: Vedr.
|
||||||
|
// levering uge 12". Det er nok til at genkende den og ikke nok til at gøre noget
|
||||||
|
// ved den — og en indbakke af den slags linjer er præcis den bunke, man havde
|
||||||
|
// mail for at slippe for.
|
||||||
|
//
|
||||||
|
// Ét kald pr. gennemløb frem for ét pr. mail. Femogtyve mails er femogtyve gange
|
||||||
|
// ventetid og femogtyve gange betaling for det samme spørgsmål, og et gennemløb,
|
||||||
|
// der tager fem minutter, er et, der overlapper med det næste.
|
||||||
|
//
|
||||||
|
// Falder det ud, er der ikke sket noget: opgaven hedder afsender og emne, som den
|
||||||
|
// altid har gjort. En model, der er nede, må ikke kunne stoppe posten.
|
||||||
|
|
||||||
|
// mailForAI er én mail, som modellen får den at se.
|
||||||
|
type mailForAI struct {
|
||||||
|
From string
|
||||||
|
Subject string
|
||||||
|
Snippet string
|
||||||
|
}
|
||||||
|
|
||||||
|
// mailTaskLines beder modellen om én linje pr. mail, i quick-add-syntaks.
|
||||||
|
//
|
||||||
|
// Returnerer en tabel fra mailens plads i listen til linjen. Ikke en liste, fordi
|
||||||
|
// en model, der springer en mail over, ellers ville flytte alle de følgende
|
||||||
|
// linjer én plads — og så ville en opgave hedde noget, der stod i en anden mail.
|
||||||
|
// Det er den samme forsigtighed som ved oprydningen i indbakken, og den samme
|
||||||
|
// grund: en forskydning på én er den slags fejl, ingen opdager.
|
||||||
|
func (s *Server) mailTaskLines(ctx context.Context, user *store.User, mails []mailForAI) map[int]string {
|
||||||
|
if len(mails) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
cfg, err := s.aiConfigFor(ctx, user)
|
||||||
|
if err != nil || !cfg.Configured() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
lines := make([]string, 0, len(mails))
|
||||||
|
for i, m := range mails {
|
||||||
|
line := strconv.Itoa(i+1) + ". " + m.From + " — " + m.Subject
|
||||||
|
if m.Snippet != "" {
|
||||||
|
line += "\n " + firstWords(m.Snippet, 40)
|
||||||
|
}
|
||||||
|
lines = append(lines, line)
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(ctx, 90*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
today := time.Now().In(userLocation(user.Timezone)).Format("2006-01-02")
|
||||||
|
out, err := ai.New(cfg).TasksFromMail(ctx, lines, today, user.Locale)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Info("mail tasks without the model", "err", err, "user", user.ID)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
byIndex := map[int]string{}
|
||||||
|
for i, sug := range out {
|
||||||
|
n, line := numberedLine(sug.Line)
|
||||||
|
if n == 0 {
|
||||||
|
n = i + 1
|
||||||
|
}
|
||||||
|
if n < 1 || n > len(mails) || strings.TrimSpace(line) == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
byIndex[n-1] = line
|
||||||
|
}
|
||||||
|
return byIndex
|
||||||
|
}
|
||||||
|
|
||||||
|
// applyMailLine lægger modellens linje ind i opgaven, hvis der er en.
|
||||||
|
//
|
||||||
|
// Linjen går gennem quick-add-parseren som alt andet, så en mail, hvor der står
|
||||||
|
// "inden fredag", får en dato — og "#Firma" i en linje, modellen fandt på, flytter
|
||||||
|
// ingenting, for projektet slås op blandt dem, der findes.
|
||||||
|
//
|
||||||
|
// Emnet bliver stående i beskrivelsen. Modellen har skrevet en titel ud fra det,
|
||||||
|
// og hvis den har misforstået mailen, skal det oprindelige stadig kunne læses ved
|
||||||
|
// siden af — ellers er den eneste vej tilbage at finde mailen frem igen.
|
||||||
|
func (s *Server) applyMailLine(ctx context.Context, user *store.User, task *store.Task, line, subject string) {
|
||||||
|
if strings.TrimSpace(line) == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
parsed := quickadd.Parse(line, time.Now().In(userLocation(user.Timezone)), user.Locale)
|
||||||
|
if strings.TrimSpace(parsed.Content) == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
task.Content = parsed.Content
|
||||||
|
if parsed.Priority != 0 {
|
||||||
|
task.Priority = parsed.Priority
|
||||||
|
}
|
||||||
|
if parsed.DueDate != "" {
|
||||||
|
task.DueDate = parsed.DueDate
|
||||||
|
}
|
||||||
|
if parsed.Project != "" {
|
||||||
|
if id, err := s.db.ProjectByName(ctx, user.ID, parsed.Project); err == nil {
|
||||||
|
if _, err := store.RequireProjectRole(ctx, s.db, id, user.ID, store.RoleEditor); err == nil {
|
||||||
|
task.ProjectID = id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if subject != "" {
|
||||||
|
task.Description = strings.TrimSpace(subject + "\n\n" + task.Description)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,409 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/kristianwind/verdande/internal/ai"
|
||||||
|
"github.com/kristianwind/verdande/internal/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Dagens plan: én besked om morgenen om det, der venter i dag.
|
||||||
|
//
|
||||||
|
// Klokken siger, hvad andre har gjort. Det her siger, hvad der ligger foran en —
|
||||||
|
// og det er en anden slags besked: den kommer, fordi det er blevet morgen, ikke
|
||||||
|
// fordi nogen har rørt noget. Uden den skal man selv åbne listen for at opdage,
|
||||||
|
// at der lå tre ting og forfaldt i går.
|
||||||
|
//
|
||||||
|
// Sendt som en besked frem for en mail, fordi røret allerede findes: klokken,
|
||||||
|
// push til telefonen og mærket på ikonet er ét kald, og en mail mere i indbakken
|
||||||
|
// er præcis det, dette program findes for at slippe for.
|
||||||
|
|
||||||
|
const planScope = "dailyplan"
|
||||||
|
|
||||||
|
// planSettings er, hvad én person har bedt om.
|
||||||
|
//
|
||||||
|
// Slået fra som udgangspunkt. En besked, man ikke har bedt om, klokken syv om
|
||||||
|
// morgenen, er ikke en hjælp — og modsat beaconet er der ingen, der har brug for,
|
||||||
|
// at det her er tændt for at kunne gøre sit arbejde.
|
||||||
|
type planSettings struct {
|
||||||
|
Enabled bool `json:"enabled"`
|
||||||
|
// Hour er lokal tid hos personen selv. Et tal og ikke et klokkeslæt: planen
|
||||||
|
// sendes på timen, og et minuttal ville love en præcision, en time-tikkende
|
||||||
|
// baggrundsjob ikke har.
|
||||||
|
Hour int `json:"hour"`
|
||||||
|
// LastSent er datoen, den sidst blev sendt, som "2006-01-02" i personens egen
|
||||||
|
// tidszone. En dato og ikke et tidsstempel, fordi spørgsmålet er "har de fået
|
||||||
|
// dagens plan i dag" — og det er et spørgsmål om dagen dér, hvor de er.
|
||||||
|
LastSent string `json:"last_sent,omitempty"`
|
||||||
|
// Plan er teksten, som den blev sendt, og PlanDate den dag den gælder.
|
||||||
|
//
|
||||||
|
// Gemt frem for regnet forfra, hver gang nogen kigger. To grunde, og den anden
|
||||||
|
// er den vigtige: en model pr. sidevisning er dyr, og en plan, der siger noget
|
||||||
|
// andet end den besked, man fik i morges, er værre end begge dele hver for
|
||||||
|
// sig. Det er den samme tekst — ellers er det ikke *dagens plan*, men et nyt
|
||||||
|
// gæt hver gang man kigger.
|
||||||
|
//
|
||||||
|
// PlanAt er klokkeslættet, den blev lavet, så kortet kan sige det: en plan fra
|
||||||
|
// klokken syv er en anden slags oplysning klokken fire end klokken otte.
|
||||||
|
Plan string `json:"plan,omitempty"`
|
||||||
|
PlanDate string `json:"plan_date,omitempty"`
|
||||||
|
PlanAt int64 `json:"plan_at,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) planSettings(ctx context.Context, userID string) (planSettings, error) {
|
||||||
|
out := planSettings{Hour: 7}
|
||||||
|
stored, err := s.db.UserSettings(ctx, userID, planScope)
|
||||||
|
if err != nil {
|
||||||
|
return out, err
|
||||||
|
}
|
||||||
|
if v, ok := stored["enabled"].(bool); ok {
|
||||||
|
out.Enabled = v
|
||||||
|
}
|
||||||
|
if v, ok := stored["hour"].(float64); ok && v >= 0 && v <= 23 {
|
||||||
|
out.Hour = int(v)
|
||||||
|
}
|
||||||
|
if v, ok := stored["last_sent"].(string); ok {
|
||||||
|
out.LastSent = v
|
||||||
|
}
|
||||||
|
if v, ok := stored["plan"].(string); ok {
|
||||||
|
out.Plan = v
|
||||||
|
}
|
||||||
|
if v, ok := stored["plan_date"].(string); ok {
|
||||||
|
out.PlanDate = v
|
||||||
|
}
|
||||||
|
if v, ok := stored["plan_at"].(float64); ok {
|
||||||
|
out.PlanAt = int64(v)
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) savePlanSettings(ctx context.Context, userID string, p planSettings) error {
|
||||||
|
return s.db.SetUserSettings(ctx, userID, planScope, map[string]any{
|
||||||
|
"enabled": p.Enabled, "hour": p.Hour, "last_sent": p.LastSent,
|
||||||
|
"plan": p.Plan, "plan_date": p.PlanDate, "plan_at": p.PlanAt,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleGetPlanSettings er både indstillingen og dagens plan.
|
||||||
|
//
|
||||||
|
// Ét endepunkt, fordi det er én ting: planen *er* ressourcen, og indstillingen er,
|
||||||
|
// hvornår den bliver lavet. To ville betyde to kald fra siden, der viser den, og
|
||||||
|
// to steder at huske at rydde en plan fra i går.
|
||||||
|
//
|
||||||
|
// En plan fra i går sendes ikke med. Den er ikke forkert, den er bare ikke dagens
|
||||||
|
// — og et kort, der viser gårsdagens plan under overskriften "i dag", er værre end
|
||||||
|
// et tomt kort.
|
||||||
|
func (s *Server) handleGetPlanSettings(w http.ResponseWriter, r *http.Request) {
|
||||||
|
user := userFrom(r.Context())
|
||||||
|
p, err := s.planSettings(r.Context(), user.ID)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "plan settings", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if p.PlanDate != time.Now().In(userLocation(user.Timezone)).Format("2006-01-02") {
|
||||||
|
p.Plan, p.PlanDate, p.PlanAt = "", "", 0
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
type planRequest struct {
|
||||||
|
Enabled *bool `json:"enabled"`
|
||||||
|
Hour *int `json:"hour"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) handleSetPlanSettings(w http.ResponseWriter, r *http.Request) {
|
||||||
|
var req planRequest
|
||||||
|
if err := decodeJSON(w, r, &req); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
user := userFrom(r.Context())
|
||||||
|
p, err := s.planSettings(r.Context(), user.ID)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "plan settings", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if req.Enabled != nil {
|
||||||
|
p.Enabled = *req.Enabled
|
||||||
|
}
|
||||||
|
if req.Hour != nil {
|
||||||
|
if *req.Hour < 0 || *req.Hour > 23 {
|
||||||
|
writeFieldErrors(w, map[string]string{"hour": "must be between 0 and 23"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
p.Hour = *req.Hour
|
||||||
|
// Timen er flyttet, så dagens plan er ikke sendt på den nye tid endnu.
|
||||||
|
// Uden det her ville en, der flytter planen fra 07 til 16, først få den i
|
||||||
|
// morgen — hvilket ligner, at indstillingen ikke virkede.
|
||||||
|
p.LastSent = ""
|
||||||
|
}
|
||||||
|
if err := s.savePlanSettings(r.Context(), user.ID, p); err != nil {
|
||||||
|
s.internal(w, r, "save plan settings", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
type planNowRequest struct {
|
||||||
|
// Silent er kortet på I dag, der beder om en plan, mens man kigger på den.
|
||||||
|
//
|
||||||
|
// En besked om noget, man står og ser på, er en besked, der lærer folk at
|
||||||
|
// ignorere klokken. Indstillingssidens knap sender derimod rigtigt — det er
|
||||||
|
// hele dens formål: at vise, at push virker på det her apparat.
|
||||||
|
Silent bool `json:"silent"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// handlePlanNow laver dagens plan med det samme, til den der beder om det.
|
||||||
|
//
|
||||||
|
// Findes, fordi en indstilling, man skal vente til i morgen for at se virkningen
|
||||||
|
// af, er en indstilling, ingen tør slå til — og fordi kortet på I dag skal kunne
|
||||||
|
// lave en plan for den, der har beskeden slået fra.
|
||||||
|
func (s *Server) handlePlanNow(w http.ResponseWriter, r *http.Request) {
|
||||||
|
var req planNowRequest
|
||||||
|
if r.ContentLength > 0 {
|
||||||
|
if err := decodeJSON(w, r, &req); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
user := userFrom(r.Context())
|
||||||
|
|
||||||
|
plan, err := s.buildPlan(r.Context(), user)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "build plan", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if plan == "" {
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"plan": "", "sent": false})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := s.rememberPlan(r.Context(), user, plan); err != nil {
|
||||||
|
s.internal(w, r, "save plan", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
sent := false
|
||||||
|
if !req.Silent {
|
||||||
|
s.notify(r, &store.Notification{
|
||||||
|
UserID: user.ID, Kind: "daily.plan",
|
||||||
|
Title: planTitle(user.Locale), Body: plan,
|
||||||
|
})
|
||||||
|
sent = true
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{
|
||||||
|
"plan": plan, "sent": sent,
|
||||||
|
"plan_at": time.Now().Unix(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// rememberPlan gemmer dagens plan, så den kan ses igen uden at blive lavet igen.
|
||||||
|
func (s *Server) rememberPlan(ctx context.Context, user *store.User, plan string) error {
|
||||||
|
p, err := s.planSettings(ctx, user.ID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
now := time.Now()
|
||||||
|
p.Plan = plan
|
||||||
|
p.PlanDate = now.In(userLocation(user.Timezone)).Format("2006-01-02")
|
||||||
|
p.PlanAt = now.Unix()
|
||||||
|
return s.savePlanSettings(ctx, user.ID, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DailyPlans er timeslaget: hvem er der morgen hos, og hvem har ikke fået planen
|
||||||
|
// endnu i dag.
|
||||||
|
//
|
||||||
|
// Kaldt hver time frem for lagt på et klokkeslæt — samme form som backup og
|
||||||
|
// beacon, og af samme grund: en instans, der sov klokken syv, ville ellers
|
||||||
|
// springe dagen over. Og fordi klokken syv er syv forskellige steder: personens
|
||||||
|
// egen tidszone afgør, hvornår det er morgen hos dem.
|
||||||
|
func (s *Server) DailyPlans(ctx context.Context) error {
|
||||||
|
users, err := s.db.ListUsers(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for _, u := range users {
|
||||||
|
user, err := s.db.UserByID(ctx, u.ID)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
p, err := s.planSettings(ctx, user.ID)
|
||||||
|
if err != nil || !p.Enabled {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
now := time.Now().In(userLocation(user.Timezone))
|
||||||
|
today := now.Format("2006-01-02")
|
||||||
|
if p.LastSent == today || now.Hour() < p.Hour {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// Kun samme dag. En instans, der har været slukket i tre dage, skal ikke
|
||||||
|
// sende tre planer, når den kommer op — de to af dem er om dage, der er
|
||||||
|
// gået, og en plan for i forgårs er ikke en plan.
|
||||||
|
if now.Hour() > p.Hour+3 {
|
||||||
|
p.LastSent = today
|
||||||
|
_ = s.savePlanSettings(ctx, user.ID, p)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
plan, err := s.buildPlan(ctx, user)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("build daily plan", "err", err, "user", user.ID)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// Ingen plan er ikke en besked. En morgen uden noget at gøre er en god
|
||||||
|
// morgen, og en besked, der siger "der er ingenting", lærer folk at lade
|
||||||
|
// være med at åbne beskeder.
|
||||||
|
if plan != "" {
|
||||||
|
s.notifyDirect(ctx, &store.Notification{
|
||||||
|
UserID: user.ID, Kind: "daily.plan",
|
||||||
|
Title: planTitle(user.Locale), Body: plan,
|
||||||
|
})
|
||||||
|
// Gemt, og gemt her frem for i rememberPlan: rækken er allerede
|
||||||
|
// læst ind i `p`, og to gemninger oven i hinanden ville lade den
|
||||||
|
// ene overskrive den andens `last_sent`.
|
||||||
|
p.Plan, p.PlanDate, p.PlanAt = plan, today, time.Now().Unix()
|
||||||
|
}
|
||||||
|
p.LastSent = today
|
||||||
|
if err := s.savePlanSettings(ctx, user.ID, p); err != nil {
|
||||||
|
s.log.Warn("save plan settings", "err", err, "user", user.ID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildPlan skriver dagens plan.
|
||||||
|
//
|
||||||
|
// Tallene kommer fra basen og sætningen fra modellen — i den rækkefølge. En model,
|
||||||
|
// der selv skulle tælle, ville af og til tælle forkert, og en plan, der siger fire
|
||||||
|
// opgaver, hvor der er tre, er værre end ingen plan. Er der ingen model sat op,
|
||||||
|
// står tallene alene, og det er stadig det, man havde brug for at vide.
|
||||||
|
func (s *Server) buildPlan(ctx context.Context, user *store.User) (string, error) {
|
||||||
|
loc := userLocation(user.Timezone)
|
||||||
|
now := time.Now().In(loc)
|
||||||
|
today := now.Format("2006-01-02")
|
||||||
|
// I går, ikke i dag: grænserne i filteret er inklusive, så "før i dag" skrevet
|
||||||
|
// som DueBefore: today ville tælle dagens egne opgaver med som sprunget over —
|
||||||
|
// og en plan, der klokken syv om morgenen siger, at dagens opgaver allerede er
|
||||||
|
// overskredet, er en plan, man holder op med at læse.
|
||||||
|
yesterday := now.AddDate(0, 0, -1).Format("2006-01-02")
|
||||||
|
|
||||||
|
overdue, err := s.db.ListTasks(ctx, user.ID, store.TaskFilter{DueBefore: yesterday, Limit: 50})
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
due, err := s.db.ListTasks(ctx, user.ID, store.TaskFilter{
|
||||||
|
DueFrom: today, DueBefore: today, Limit: 50,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if len(overdue) == 0 && len(due) == 0 {
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
plain := plainPlan(len(due), len(overdue), user.Locale)
|
||||||
|
|
||||||
|
cfg, err := s.aiConfigFor(ctx, user)
|
||||||
|
if err != nil || !cfg.Configured() {
|
||||||
|
return plain, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
lines := make([]string, 0, len(due)+len(overdue))
|
||||||
|
for _, t := range overdue {
|
||||||
|
lines = append(lines, "- "+t.Content+" ("+overdueWord(user.Locale)+" "+t.DueDate+")")
|
||||||
|
}
|
||||||
|
for _, t := range due {
|
||||||
|
lines = append(lines, "- "+t.Content)
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(ctx, 60*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
written, err := ai.New(cfg).DailyPlan(ctx, lines, len(due), len(overdue), user.Locale)
|
||||||
|
if err != nil {
|
||||||
|
// Modellen er ikke det, planen står og falder med. Tallene er rigtige uden
|
||||||
|
// den, og en morgen uden besked, fordi en API-nøgle er udløbet, er en
|
||||||
|
// dårligere handel end en besked uden en velskrevet sætning.
|
||||||
|
s.log.Info("daily plan without the model", "err", err, "user", user.ID)
|
||||||
|
return plain, nil
|
||||||
|
}
|
||||||
|
return strings.TrimSpace(written), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// aiConfigFor er aiConfig uden en request bag sig — baggrundsjobbet har ingen.
|
||||||
|
//
|
||||||
|
// AllowPrivate er falsk her, og det er med vilje: retten til at nå det private
|
||||||
|
// net blev givet til en administrator, der sad og skrev adressen ind, og et job,
|
||||||
|
// der kører klokken syv om morgenen, er ikke nogen, der sidder og skriver. En
|
||||||
|
// model på maskinen selv skal derfor bruges gennem fladen, ikke af planen.
|
||||||
|
func (s *Server) aiConfigFor(ctx context.Context, user *store.User) (ai.Config, error) {
|
||||||
|
values, err := s.db.UserSettings(ctx, user.ID, "ai")
|
||||||
|
if err != nil {
|
||||||
|
return ai.Config{}, err
|
||||||
|
}
|
||||||
|
str := func(key string) string {
|
||||||
|
v, _ := values[key].(string)
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
return ai.Config{
|
||||||
|
Provider: ai.Provider(str("provider")),
|
||||||
|
APIKey: str("api_key"),
|
||||||
|
BaseURL: str("base_url"),
|
||||||
|
Model: str("model"),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// notifyDirect er notify uden en request. Baggrundsjobbet har ingen bruger i
|
||||||
|
// konteksten og ingen actor — planen er ikke noget, nogen har gjort ved en.
|
||||||
|
func (s *Server) notifyDirect(ctx context.Context, n *store.Notification) {
|
||||||
|
if err := s.db.CreateNotification(ctx, n); err != nil {
|
||||||
|
s.log.Warn("create notification", "err", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s.hub.PublishToUser(n.UserID, "notification", notificationJSON{
|
||||||
|
ID: n.ID, Kind: n.Kind, Title: n.Title, Body: n.Body,
|
||||||
|
CreatedAt: n.CreatedAt.Format(time.RFC3339),
|
||||||
|
})
|
||||||
|
go s.pushToUser(n.UserID, n.Title, n.Body, "")
|
||||||
|
}
|
||||||
|
|
||||||
|
func planTitle(locale string) string {
|
||||||
|
if strings.HasPrefix(strings.ToLower(locale), "en") {
|
||||||
|
return "Today"
|
||||||
|
}
|
||||||
|
return "I dag"
|
||||||
|
}
|
||||||
|
|
||||||
|
func overdueWord(locale string) string {
|
||||||
|
if strings.HasPrefix(strings.ToLower(locale), "en") {
|
||||||
|
return "was due"
|
||||||
|
}
|
||||||
|
return "forfaldt"
|
||||||
|
}
|
||||||
|
|
||||||
|
// plainPlan er planen uden en model: to tal, og ikke et ord mere.
|
||||||
|
//
|
||||||
|
// Det er ikke en nødløsning, det er bunden. Det, man har brug for at vide klokken
|
||||||
|
// syv, er om der er noget, der er sprunget over — og det tal er rigtigt, uanset
|
||||||
|
// om nogen har lagt en API-nøgle ind.
|
||||||
|
func plainPlan(due, overdue int, locale string) string {
|
||||||
|
english := strings.HasPrefix(strings.ToLower(locale), "en")
|
||||||
|
var parts []string
|
||||||
|
if due > 0 {
|
||||||
|
if english {
|
||||||
|
parts = append(parts, strconv.Itoa(due)+" due today")
|
||||||
|
} else {
|
||||||
|
parts = append(parts, strconv.Itoa(due)+" forfalder i dag")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if overdue > 0 {
|
||||||
|
if english {
|
||||||
|
parts = append(parts, strconv.Itoa(overdue)+" overdue")
|
||||||
|
} else {
|
||||||
|
parts = append(parts, strconv.Itoa(overdue)+" er sprunget over")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return strings.Join(parts, ", ")
|
||||||
|
}
|
||||||
@@ -0,0 +1,157 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Planen er tal fra basen, ikke fra modellen. En plan, der siger fire opgaver,
|
||||||
|
// hvor der er tre, er værre end ingen plan — så tallene tælles her, og modellen
|
||||||
|
// får dem udleveret som kendsgerninger.
|
||||||
|
func TestTheDailyPlanCountsForItself(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
ts.quickTask(t, "ring til anders i dag")
|
||||||
|
ts.quickTask(t, "køb mælk i dag")
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/ai/plan/now", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("send planen: %d %v", resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
if out["sent"] != true {
|
||||||
|
t.Fatalf("planen blev ikke sendt: %v", out)
|
||||||
|
}
|
||||||
|
// Uden en model står tallene alene, og det er stadig det, man havde brug for
|
||||||
|
// at vide klokken syv.
|
||||||
|
if plan, _ := out["plan"].(string); plan != "2 forfalder i dag" {
|
||||||
|
t.Errorf("plan = %q", plan)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Og den lander i klokken som en besked.
|
||||||
|
list, unread := notifications(t, ts)
|
||||||
|
if len(list) != 1 || unread != 1 {
|
||||||
|
t.Fatalf("beskeder = %d (%v ulæste), want 1", len(list), unread)
|
||||||
|
}
|
||||||
|
if n := firstOf(t, list); n["kind"] != "daily.plan" {
|
||||||
|
t.Errorf("besked = %v", n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ingen plan er ikke en besked. En morgen uden noget at gøre er en god morgen, og
|
||||||
|
// en besked, der siger "der er ingenting", lærer folk at lade være med at åbne
|
||||||
|
// beskeder.
|
||||||
|
func TestAnEmptyDaySendsNoPlan(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/ai/plan/now", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("send planen: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if out["sent"] != false {
|
||||||
|
t.Errorf("der blev sendt en plan om ingenting: %v", out)
|
||||||
|
}
|
||||||
|
if list, _ := notifications(t, ts); len(list) != 0 {
|
||||||
|
t.Errorf("beskeder = %d, want 0", len(list))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Timen er flyttet, så dagens plan er ikke sendt på den nye tid endnu. Uden det
|
||||||
|
// ville en, der flytter planen fra 07 til 16, først få den i morgen — hvilket
|
||||||
|
// ligner, at indstillingen ikke virkede.
|
||||||
|
func TestMovingThePlanHourClearsTodaysMark(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
ts.quickTask(t, "noget i dag")
|
||||||
|
|
||||||
|
if resp, _ := ts.do(t, "PUT", "/api/v1/ai/plan", map[string]any{
|
||||||
|
"enabled": true, "hour": 7,
|
||||||
|
}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("slå planen til")
|
||||||
|
}
|
||||||
|
if _, out := ts.do(t, "POST", "/api/v1/ai/plan/now", nil); out["sent"] != true {
|
||||||
|
t.Fatalf("planen blev ikke sendt: %v", out)
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "PUT", "/api/v1/ai/plan", map[string]any{"hour": 16})
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("flyt timen: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if out["hour"] != float64(16) {
|
||||||
|
t.Errorf("time = %v", out["hour"])
|
||||||
|
}
|
||||||
|
if out["last_sent"] != nil && out["last_sent"] != "" {
|
||||||
|
t.Errorf("mærket for i dag blev stående: %v", out["last_sent"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En time, der ikke findes på et ur, er en fejl i feltet og ikke en 500.
|
||||||
|
func TestAnImpossiblePlanHourIsRefused(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
if resp, _ := ts.do(t, "PUT", "/api/v1/ai/plan", map[string]any{"hour": 25}); resp.StatusCode != http.StatusUnprocessableEntity {
|
||||||
|
t.Fatalf("time 25 gav %d, want 422", resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Planen gemmes for dagen, så kortet på I dag kan vise nøjagtig den tekst,
|
||||||
|
// beskeden bar — og ikke et nyt gæt, hver gang nogen kigger.
|
||||||
|
func TestTodaysPlanIsKeptForTheDay(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
ts.quickTask(t, "noget i dag")
|
||||||
|
|
||||||
|
// Ingen plan endnu: kortet viser en knap frem for gårsdagens tekst.
|
||||||
|
if _, before := ts.do(t, "GET", "/api/v1/ai/plan", nil); before["plan"] != nil && before["plan"] != "" {
|
||||||
|
t.Fatalf("der lå en plan, før nogen havde lavet en: %v", before["plan"])
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, made := ts.do(t, "POST", "/api/v1/ai/plan/now", map[string]any{"silent": true})
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("lav planen: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if made["sent"] != false {
|
||||||
|
t.Errorf("en stille plan sendte en besked: %v", made["sent"])
|
||||||
|
}
|
||||||
|
if list, _ := notifications(t, ts); len(list) != 0 {
|
||||||
|
t.Errorf("kortets egen plan gav %d beskeder, want 0", len(list))
|
||||||
|
}
|
||||||
|
|
||||||
|
_, after := ts.do(t, "GET", "/api/v1/ai/plan", nil)
|
||||||
|
if after["plan"] != made["plan"] {
|
||||||
|
t.Errorf("den gemte plan = %v, den lavede = %v", after["plan"], made["plan"])
|
||||||
|
}
|
||||||
|
if after["plan_at"] == nil {
|
||||||
|
t.Error("planen bærer ikke, hvornår den blev lavet")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En plan fra i går er ikke dagens. Et kort, der viser gårsdagens plan under
|
||||||
|
// overskriften "i dag", er værre end et tomt kort.
|
||||||
|
func TestYesterdaysPlanIsNotTodays(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
ts.quickTask(t, "noget i dag")
|
||||||
|
|
||||||
|
if resp, _ := ts.do(t, "POST", "/api/v1/ai/plan/now", map[string]any{"silent": true}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("lav planen")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sat en dag tilbage, som om den var lavet i går.
|
||||||
|
user := userID(t, ts, "kristian@example.dk")
|
||||||
|
stored, err := ts.db.UserSettings(t.Context(), user, "dailyplan")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
stored["plan_date"] = time.Now().AddDate(0, 0, -1).Format("2006-01-02")
|
||||||
|
if err := ts.db.SetUserSettings(t.Context(), user, "dailyplan", stored); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, out := ts.do(t, "GET", "/api/v1/ai/plan", nil)
|
||||||
|
if plan, _ := out["plan"].(string); plan != "" {
|
||||||
|
t.Errorf("gårsdagens plan blev vist som dagens: %q", plan)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,370 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/go-chi/chi/v5"
|
||||||
|
|
||||||
|
"github.com/kristianwind/verdande/internal/ai"
|
||||||
|
"github.com/kristianwind/verdande/internal/quickadd"
|
||||||
|
"github.com/kristianwind/verdande/internal/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AI'ens forslag, og hvad der sker med dem.
|
||||||
|
//
|
||||||
|
// Fælles for det hele: modellen skriver ikke noget. Den foreslår en *linje* i den
|
||||||
|
// syntaks, man selv skriver i — "Ring til Anders i morgen p1 #Firma" — og
|
||||||
|
// forslaget bliver til noget, når nogen siger ja til det. Det er ikke
|
||||||
|
// forsigtighed for forsigtighedens skyld: en model, der retter i folks opgaver
|
||||||
|
// direkte, skal have ret hver gang for at være til gavn, hvor en, der foreslår,
|
||||||
|
// skal have ret tit nok til at spare et par tastetryk.
|
||||||
|
//
|
||||||
|
// Og linjen er quick-add-syntaks frem for et felt pr. egenskab, fordi parseren
|
||||||
|
// findes: der er én fortolkning af "i morgen" i dette program, og forslaget går
|
||||||
|
// gennem den samme som alt andet.
|
||||||
|
|
||||||
|
// aiSuggestionJSON er ét forslag på vej til fladen.
|
||||||
|
type aiSuggestionJSON struct {
|
||||||
|
// TaskID er sat, når forslaget handler om en opgave, der allerede findes —
|
||||||
|
// altså ved oprydningen i indbakken. Tomt, når forslaget er en ny opgave.
|
||||||
|
TaskID string `json:"task_id,omitempty"`
|
||||||
|
Line string `json:"line"`
|
||||||
|
Why string `json:"why,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// aiClientFor er de tre linjer, hver eneste AI-funktion ellers ville gentage:
|
||||||
|
// hent opsætningen, og sig pænt fra, når der ikke er nogen.
|
||||||
|
func (s *Server) aiClientFor(w http.ResponseWriter, r *http.Request) (*ai.Client, bool) {
|
||||||
|
cfg, err := s.aiConfig(r, userFrom(r.Context()).ID)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "ai settings", err)
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
if !cfg.Configured() {
|
||||||
|
// Ikke en fejl, nogen har lavet: funktionen er slået fra, indtil man
|
||||||
|
// lægger sin egen nøgle ind.
|
||||||
|
writeError(w, http.StatusConflict, CodeAINotConfigured, "no AI provider is configured")
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
return ai.New(cfg), true
|
||||||
|
}
|
||||||
|
|
||||||
|
// projectNames er de projekter, modellen må nævne.
|
||||||
|
//
|
||||||
|
// Givet med frem for udeladt, fordi alternativet er, at den finder på et: et
|
||||||
|
// `#Nyt projekt`, ingen har, ville lave et projekt ved et uheld, første gang
|
||||||
|
// nogen sagde ja til forslaget.
|
||||||
|
func (s *Server) projectNames(r *http.Request) []string {
|
||||||
|
projects, err := s.db.ListProjects(r.Context(), userFrom(r.Context()).ID, false)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("projects for ai", "err", err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
out := make([]string, 0, len(projects))
|
||||||
|
for _, p := range projects {
|
||||||
|
if p.IsInbox {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
out = append(out, p.Name)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleAITidyInbox foreslår, hvordan det, der ligger løst i indbakken, kunne
|
||||||
|
// skrives færdig.
|
||||||
|
//
|
||||||
|
// Indbakken er der, hvor ting lander, når man ikke havde tid til at skrive dem
|
||||||
|
// ordentligt — og den er derfor også der, hvor de bliver liggende. At åbne hver
|
||||||
|
// enkelt og sætte projekt, dato og prioritet er ti klik pr. linje; det her er ét
|
||||||
|
// spørgsmål og et ja pr. linje.
|
||||||
|
func (s *Server) handleAITidyInbox(w http.ResponseWriter, r *http.Request) {
|
||||||
|
user := userFrom(r.Context())
|
||||||
|
client, ok := s.aiClientFor(w, r)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
inbox, err := s.db.InboxID(r.Context(), user.ID)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "inbox", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
tasks, err := s.db.ListTasks(r.Context(), user.ID, store.TaskFilter{
|
||||||
|
ProjectIDs: []string{inbox}, Limit: 50,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "list inbox", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if len(tasks) == 0 {
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"suggestions": []aiSuggestionJSON{}})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nummereret, så svaret kan lægges tilbage på den rigtige opgave. Modellen
|
||||||
|
// bliver bedt om at svare i rækkefølge, men en model, der springer en over,
|
||||||
|
// må ikke kunne flytte alle de andres forslag én plads — derfor står
|
||||||
|
// nummeret i teksten og bliver læst tilbage.
|
||||||
|
lines := make([]string, 0, len(tasks))
|
||||||
|
for i, t := range tasks {
|
||||||
|
line := strconv.Itoa(i+1) + ". " + t.Content
|
||||||
|
if t.Description != "" {
|
||||||
|
line += " — " + firstWords(t.Description, 30)
|
||||||
|
}
|
||||||
|
lines = append(lines, line)
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, cancel := contextWithTimeout(r, 90*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
today := time.Now().In(userLocation(user.Timezone)).Format("2006-01-02")
|
||||||
|
suggestions, err := client.TidyInbox(ctx, lines, s.projectNames(r), today, user.Locale)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("ai tidy inbox", "err", err)
|
||||||
|
writeError(w, StatusUpstreamRefused, CodeInternal, err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
out := make([]aiSuggestionJSON, 0, len(suggestions))
|
||||||
|
for i, sug := range suggestions {
|
||||||
|
n, line := numberedLine(sug.Line)
|
||||||
|
// Uden et nummer falder vi tilbage på rækkefølgen, som er det, der blev
|
||||||
|
// bedt om. Med et nummer, der ikke findes, springes forslaget over —
|
||||||
|
// et forslag, der peger på en opgave, der ikke er der, er ikke et forslag.
|
||||||
|
if n == 0 {
|
||||||
|
n = i + 1
|
||||||
|
}
|
||||||
|
if n < 1 || n > len(tasks) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(line) == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
out = append(out, aiSuggestionJSON{TaskID: tasks[n-1].ID, Line: line, Why: sug.Why})
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"suggestions": out})
|
||||||
|
}
|
||||||
|
|
||||||
|
type applyLineRequest struct {
|
||||||
|
TaskID string `json:"task_id"`
|
||||||
|
Line string `json:"line"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleAIApplyToTask skriver ét accepteret forslag ind i den opgave, det handler
|
||||||
|
// om.
|
||||||
|
//
|
||||||
|
// Parsningen sker her og ikke i browseren, så "i morgen" betyder det samme, som
|
||||||
|
// det gør alle andre steder i programmet — og så et forslag, der er blevet rettet
|
||||||
|
// i hånden, inden det blev sagt ja til, bliver læst på nøjagtig samme måde som et,
|
||||||
|
// der ikke blev rørt.
|
||||||
|
func (s *Server) handleAIApplyToTask(w http.ResponseWriter, r *http.Request) {
|
||||||
|
var req applyLineRequest
|
||||||
|
if err := decodeJSON(w, r, &req); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
user := userFrom(r.Context())
|
||||||
|
if strings.TrimSpace(req.Line) == "" {
|
||||||
|
writeFieldErrors(w, map[string]string{"line": "required"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
task, err := s.db.GetTask(r.Context(), req.TaskID, user.ID)
|
||||||
|
if err != nil {
|
||||||
|
s.storeError(w, r, "get task", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
loc := userLocation(user.Timezone)
|
||||||
|
parsed := quickadd.Parse(req.Line, time.Now().In(loc), user.Locale)
|
||||||
|
if strings.TrimSpace(parsed.Content) == "" {
|
||||||
|
writeFieldErrors(w, map[string]string{"line": "there is no task in that"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Kun det, linjen faktisk siger. En tom dato i et forslag betyder "der stod
|
||||||
|
// ikke noget om en dato" og ikke "fjern den, der er" — modellen er blevet bedt
|
||||||
|
// om at lade være med at gætte datoer, og så må et manglende gæt heller ikke
|
||||||
|
// slette noget.
|
||||||
|
update := store.TaskUpdate{Content: &parsed.Content}
|
||||||
|
if parsed.Priority != 0 {
|
||||||
|
update.Priority = &parsed.Priority
|
||||||
|
}
|
||||||
|
if parsed.DueDate != "" {
|
||||||
|
update.SetDue, update.DueDate = true, parsed.DueDate
|
||||||
|
}
|
||||||
|
if parsed.Recurrence != "" {
|
||||||
|
update.RecurrenceRule = &parsed.Recurrence
|
||||||
|
}
|
||||||
|
if len(parsed.Labels) > 0 {
|
||||||
|
update.Labels, update.SetLabels = parsed.Labels, true
|
||||||
|
}
|
||||||
|
if err := s.db.UpdateTask(r.Context(), task.ID, user.ID, update); err != nil {
|
||||||
|
s.storeError(w, r, "update task", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Et projekt, modellen fandt på, flytter ingenting. Den fik listen over dem,
|
||||||
|
// der findes, og et navn uden for den er et gæt — og et gæt må ikke kunne
|
||||||
|
// lave et projekt eller flytte en opgave hen, hvor ejeren ikke leder.
|
||||||
|
if parsed.Project != "" {
|
||||||
|
if id, err := s.db.ProjectByName(r.Context(), user.ID, parsed.Project); err == nil && id != task.ProjectID {
|
||||||
|
if _, err := store.RequireProjectRole(r.Context(), s.db, id, user.ID, store.RoleEditor); err == nil {
|
||||||
|
if _, err := s.db.MoveTask(r.Context(), task.ID, id, "", "", ""); err != nil {
|
||||||
|
s.internal(w, r, "move task", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
updated, err := s.db.GetTask(r.Context(), task.ID, user.ID)
|
||||||
|
if err != nil {
|
||||||
|
s.storeError(w, r, "get task", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s.publish(updated.ProjectID, "task.updated", toTaskJSON(*updated))
|
||||||
|
writeJSON(w, http.StatusOK, toTaskJSON(*updated))
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleAINoteActions trækker det, nogen har lovet, ud af en note.
|
||||||
|
//
|
||||||
|
// Et referat er fuldt af sætninger, der ligner opgaver, og af tre, der er det.
|
||||||
|
// Modellen bliver bedt om kun at tage dem, nogen har forpligtet sig på, og om at
|
||||||
|
// citere de ord, den tog dem fra — så et forkert punkt kan gennemskues frem for
|
||||||
|
// bare at være forkert.
|
||||||
|
func (s *Server) handleAINoteActions(w http.ResponseWriter, r *http.Request) {
|
||||||
|
user := userFrom(r.Context())
|
||||||
|
client, ok := s.aiClientFor(w, r)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
n, err := s.db.Note(r.Context(), chi.URLParam(r, "noteID"))
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "get note", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if n == nil || !s.mayTouchNote(r, n, store.RoleViewer) {
|
||||||
|
writeError(w, http.StatusNotFound, CodeNotFound, "no such note")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(n.Body) == "" {
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"suggestions": []aiSuggestionJSON{}})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, cancel := contextWithTimeout(r, 90*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
today := time.Now().In(userLocation(user.Timezone)).Format("2006-01-02")
|
||||||
|
suggestions, err := client.ActionsInNote(ctx, n.Body, s.projectNames(r), today, user.Locale)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("ai note actions", "err", err)
|
||||||
|
writeError(w, StatusUpstreamRefused, CodeInternal, err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
out := make([]aiSuggestionJSON, 0, len(suggestions))
|
||||||
|
for _, sug := range suggestions {
|
||||||
|
out = append(out, aiSuggestionJSON{Line: sug.Line, Why: sug.Why})
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"suggestions": out})
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleAICreateFromNote laver én accepteret opgave fra en note.
|
||||||
|
//
|
||||||
|
// Noten bliver ikke rørt. Det er fristende at skrive linket ind i den, så de to
|
||||||
|
// peger på hinanden, men en tekst, et program skriver i uden at blive bedt om
|
||||||
|
// det, er en tekst, man holder op med at stole på. I stedet bærer opgaven, hvor
|
||||||
|
// den kom fra — og noten kan findes på sin titel.
|
||||||
|
func (s *Server) handleAICreateFromNote(w http.ResponseWriter, r *http.Request) {
|
||||||
|
var req applyLineRequest
|
||||||
|
if err := decodeJSON(w, r, &req); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
user := userFrom(r.Context())
|
||||||
|
|
||||||
|
n, err := s.db.Note(r.Context(), chi.URLParam(r, "noteID"))
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "get note", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if n == nil || !s.mayTouchNote(r, n, store.RoleViewer) {
|
||||||
|
writeError(w, http.StatusNotFound, CodeNotFound, "no such note")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
loc := userLocation(user.Timezone)
|
||||||
|
parsed := quickadd.Parse(req.Line, time.Now().In(loc), user.Locale)
|
||||||
|
if strings.TrimSpace(parsed.Content) == "" {
|
||||||
|
writeFieldErrors(w, map[string]string{"line": "there is no task in that"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Notens eget projekt som udgangspunkt: står referatet i et projekt, hører
|
||||||
|
// det, der blev aftalt i det, som regel til samme sted. Et `#projekt` i
|
||||||
|
// linjen vinder, fordi det er valgt frem for arvet.
|
||||||
|
projectID := n.ProjectID
|
||||||
|
if parsed.Project != "" {
|
||||||
|
if id, err := s.db.ProjectByName(r.Context(), user.ID, parsed.Project); err == nil {
|
||||||
|
projectID = id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if projectID == "" {
|
||||||
|
if projectID, err = s.db.InboxID(r.Context(), user.ID); err != nil {
|
||||||
|
s.internal(w, r, "inbox", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := store.RequireProjectRole(r.Context(), s.db, projectID, user.ID, store.RoleEditor); err != nil {
|
||||||
|
writeError(w, http.StatusNotFound, CodeNotFound, "not found")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
task := &store.Task{
|
||||||
|
ProjectID: projectID, Content: parsed.Content, Priority: parsed.Priority,
|
||||||
|
DueDate: parsed.DueDate, RecurrenceRule: parsed.Recurrence,
|
||||||
|
Description: "[[" + n.Title + "]]", CreatedBy: user.ID,
|
||||||
|
}
|
||||||
|
if err := s.db.CreateTask(r.Context(), task, parsed.Labels); err != nil {
|
||||||
|
s.internal(w, r, "create task from note", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s.publish(projectID, "task.created", toTaskJSON(*task))
|
||||||
|
writeJSON(w, http.StatusCreated, toTaskJSON(*task))
|
||||||
|
}
|
||||||
|
|
||||||
|
// numberedLine skiller "3. Ring til Anders" ad i nummeret og linjen.
|
||||||
|
//
|
||||||
|
// Nummeret er, hvordan et forslag finder tilbage til den opgave, det handler om.
|
||||||
|
// Rækkefølgen alene ville også kunne bruges, og gør det som reserve — men en
|
||||||
|
// model, der springer en opgave over, ville så flytte alle de følgende forslag
|
||||||
|
// én plads, og så bliver "sæt dato på den her" sat på en anden.
|
||||||
|
func numberedLine(s string) (int, string) {
|
||||||
|
s = strings.TrimSpace(s)
|
||||||
|
dot := strings.IndexByte(s, '.')
|
||||||
|
if dot <= 0 || dot > 3 {
|
||||||
|
return 0, s
|
||||||
|
}
|
||||||
|
n := 0
|
||||||
|
for _, c := range s[:dot] {
|
||||||
|
if c < '0' || c > '9' {
|
||||||
|
return 0, s
|
||||||
|
}
|
||||||
|
n = n*10 + int(c-'0')
|
||||||
|
}
|
||||||
|
return n, strings.TrimSpace(s[dot+1:])
|
||||||
|
}
|
||||||
|
|
||||||
|
// firstWords klipper en beskrivelse ned til noget, der kan stå i en prompt uden at
|
||||||
|
// fylde den med en hel note.
|
||||||
|
func firstWords(s string, n int) string {
|
||||||
|
fields := strings.Fields(s)
|
||||||
|
if len(fields) <= n {
|
||||||
|
return strings.Join(fields, " ")
|
||||||
|
}
|
||||||
|
return strings.Join(fields[:n], " ") + " …"
|
||||||
|
}
|
||||||
@@ -0,0 +1,234 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fakeModel er en OpenAI-formet endpoint, der svarer med det, prøven har brug for.
|
||||||
|
//
|
||||||
|
// Den rigtige vej hele vejen igennem: indstillingerne, prompten, parsningen af
|
||||||
|
// svaret og skrivningen bagefter. Det, der er værd at prøve her, er ikke om en
|
||||||
|
// model kan svare — det er, hvad der sker med svaret, når den har svaret noget.
|
||||||
|
func fakeModel(t *testing.T, reply string) string {
|
||||||
|
t.Helper()
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
_ = json.NewEncoder(w).Encode(map[string]any{
|
||||||
|
"choices": []map[string]any{
|
||||||
|
{"message": map[string]string{"content": reply}},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}))
|
||||||
|
t.Cleanup(srv.Close)
|
||||||
|
return srv.URL
|
||||||
|
}
|
||||||
|
|
||||||
|
// useModel peger kontoen på den falske model. Kun en administrator må pege AI'en
|
||||||
|
// på en adresse i det private net, og bootstrap-kontoen er en.
|
||||||
|
func (ts *testServer) useModel(t *testing.T, url string) {
|
||||||
|
t.Helper()
|
||||||
|
resp, _ := ts.do(t, "PUT", "/api/v1/ai/settings", map[string]any{
|
||||||
|
"provider": "compatible", "base_url": url, "model": "prøvemodel",
|
||||||
|
})
|
||||||
|
if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusNoContent {
|
||||||
|
t.Fatalf("gem ai-indstillinger: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Forslaget peger tilbage på den opgave, det handler om — også når modellen
|
||||||
|
// springer en over. Uden nummeret ville "sæt en dato på den her" lande på en
|
||||||
|
// anden opgave end den, den blev skrevet om.
|
||||||
|
func TestTidyingTheInboxSuggestsPerTask(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
ts.useModel(t, fakeModel(t, `[
|
||||||
|
{"line": "2. Ring til Anders i morgen p1", "why": "der står et navn og et telefonnummer"}
|
||||||
|
]`))
|
||||||
|
|
||||||
|
first := ts.quickTask(t, "noget som helst")
|
||||||
|
second := ts.quickTask(t, "anders 12345678")
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/ai/inbox/tidy", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("ryd op: %d %v", resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
list, _ := out["suggestions"].([]any)
|
||||||
|
if len(list) != 1 {
|
||||||
|
t.Fatalf("forslag = %v, want ét", list)
|
||||||
|
}
|
||||||
|
sug := list[0].(map[string]any)
|
||||||
|
if sug["task_id"] != second {
|
||||||
|
t.Errorf("forslaget peger på %v, want den anden opgave (%v)", sug["task_id"], second)
|
||||||
|
}
|
||||||
|
if sug["line"] != "Ring til Anders i morgen p1" {
|
||||||
|
t.Errorf("nummeret blev ikke taget af linjen: %v", sug["line"])
|
||||||
|
}
|
||||||
|
if sug["why"] == "" {
|
||||||
|
t.Error("forslaget siger ikke hvorfor")
|
||||||
|
}
|
||||||
|
_ = first
|
||||||
|
}
|
||||||
|
|
||||||
|
// Et ja skriver forslaget ind i opgaven — gennem den samme parser som alt andet,
|
||||||
|
// så "i morgen" betyder det samme her som i feltet øverst i fladen.
|
||||||
|
func TestAcceptingASuggestionWritesItIntoTheTask(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
ts.useModel(t, fakeModel(t, `[]`))
|
||||||
|
taskID := ts.quickTask(t, "anders")
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/ai/inbox/tidy/apply", map[string]any{
|
||||||
|
"task_id": taskID, "line": "Ring til Anders i morgen p1",
|
||||||
|
})
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("accepter: %d %v", resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
if out["content"] != "Ring til Anders" {
|
||||||
|
t.Errorf("indhold = %v", out["content"])
|
||||||
|
}
|
||||||
|
if out["priority"] != float64(1) {
|
||||||
|
t.Errorf("prioritet = %v, want 1", out["priority"])
|
||||||
|
}
|
||||||
|
if out["due_date"] == nil || out["due_date"] == "" {
|
||||||
|
t.Errorf("datoen blev ikke sat: %v", out["due_date"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Et projekt, modellen har fundet på, flytter ingenting. Den fik listen over dem,
|
||||||
|
// der findes, og et navn uden for den er et gæt — et gæt må ikke kunne flytte en
|
||||||
|
// opgave hen, hvor ejeren ikke leder efter den.
|
||||||
|
func TestAnInventedProjectDoesNotMoveTheTask(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
ts.useModel(t, fakeModel(t, `[]`))
|
||||||
|
taskID := ts.quickTask(t, "anders")
|
||||||
|
|
||||||
|
_, before := ts.do(t, "GET", "/api/v1/tasks/"+taskID, nil)
|
||||||
|
resp, after := ts.do(t, "POST", "/api/v1/ai/inbox/tidy/apply", map[string]any{
|
||||||
|
"task_id": taskID, "line": "Ring til Anders #EtProjektDerIkkeFindes",
|
||||||
|
})
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("accepter: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if after["project_id"] != before["project_id"] {
|
||||||
|
t.Errorf("opgaven blev flyttet til %v (var %v)", after["project_id"], before["project_id"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En note bliver ikke rørt, når der bliver lavet opgaver ud af den. En tekst, et
|
||||||
|
// program skriver i uden at blive bedt om det, er en tekst, man holder op med at
|
||||||
|
// stole på.
|
||||||
|
func TestTasksFromANoteLeaveTheNoteAlone(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
ts.useModel(t, fakeModel(t, `[
|
||||||
|
{"line": "Send prisliste til Anders på fredag", "why": "“jeg sender prislisten fredag”"}
|
||||||
|
]`))
|
||||||
|
|
||||||
|
body := "# Møde med Anders\njeg sender prislisten fredag"
|
||||||
|
noteID := ts.createNote(t, body)
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/ai/notes/"+noteID+"/actions", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("find opgaver: %d %v", resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
list, _ := out["suggestions"].([]any)
|
||||||
|
if len(list) != 1 {
|
||||||
|
t.Fatalf("forslag = %v, want ét", list)
|
||||||
|
}
|
||||||
|
line := list[0].(map[string]any)["line"].(string)
|
||||||
|
|
||||||
|
resp, task := ts.do(t, "POST", "/api/v1/ai/notes/"+noteID+"/actions/apply",
|
||||||
|
map[string]any{"line": line})
|
||||||
|
if resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatalf("accepter: %d %v", resp.StatusCode, task)
|
||||||
|
}
|
||||||
|
if task["content"] != "Send prisliste til Anders" {
|
||||||
|
t.Errorf("opgave = %v", task["content"])
|
||||||
|
}
|
||||||
|
// Opgaven bærer, hvor den kom fra, som et notelink.
|
||||||
|
if task["description"] != "[[Møde med Anders]]" {
|
||||||
|
t.Errorf("beskrivelse = %v, want et link til noten", task["description"])
|
||||||
|
}
|
||||||
|
|
||||||
|
_, note := ts.do(t, "GET", "/api/v1/notes/"+noteID, nil)
|
||||||
|
if note["body"] != body {
|
||||||
|
t.Errorf("noten blev rettet:\n%v", note["body"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Uden en model er funktionen slået fra — ikke i stykker. Svaret skal kunne
|
||||||
|
// kendes fra en fejl, så fladen kan sige "læg din nøgle ind" frem for "der skete
|
||||||
|
// noget".
|
||||||
|
func TestSuggestionsAreOffWithoutAModel(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
for _, path := range []string{"/api/v1/ai/inbox/tidy"} {
|
||||||
|
if resp, _ := ts.do(t, "POST", path, nil); resp.StatusCode != http.StatusConflict {
|
||||||
|
t.Errorf("%s gav %d, want 409", path, resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// quickTask lægger en linje i indbakken gennem den samme vej som feltet øverst.
|
||||||
|
func (ts *testServer) quickTask(t *testing.T, text string) string {
|
||||||
|
t.Helper()
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/tasks/quick-add", map[string]any{"text": text})
|
||||||
|
if resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatalf("quickadd %q: %d %v", text, resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
id, _ := out["id"].(string)
|
||||||
|
if id == "" {
|
||||||
|
t.Fatalf("quickadd gav intet id: %v", out)
|
||||||
|
}
|
||||||
|
return id
|
||||||
|
}
|
||||||
|
|
||||||
|
// Svaret på et spørgsmål bærer, hvad det står på — og kun det, det faktisk brugte.
|
||||||
|
// En liste over alt, der blev kigget i, er ikke en henvisning.
|
||||||
|
func TestAskingAnswersFromYourOwnNotes(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
ts.useModel(t, fakeModel(t, `{"answer": "Du lovede Anders prislisten fredag.", "sources": [1]}`))
|
||||||
|
|
||||||
|
ts.createNote(t, "# Møde med Anders\njeg sender prislisten fredag")
|
||||||
|
ts.createNote(t, "# Noget helt andet\nanders er ikke nævnt her")
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/ai/ask", map[string]any{"question": "hvad lovede jeg Anders?"})
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("spørg: %d %v", resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
if out["answer"] != "Du lovede Anders prislisten fredag." {
|
||||||
|
t.Errorf("svar = %v", out["answer"])
|
||||||
|
}
|
||||||
|
sources, _ := out["sources"].([]any)
|
||||||
|
if len(sources) != 1 {
|
||||||
|
t.Fatalf("kilder = %v, want én", sources)
|
||||||
|
}
|
||||||
|
src := sources[0].(map[string]any)
|
||||||
|
if src["kind"] != "note" || src["title"] != "Møde med Anders" {
|
||||||
|
t.Errorf("kilde = %v", src)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Et spørgsmål, der ikke rammer noget, får ikke et opfundet svar. Man spørger om
|
||||||
|
// sine egne noter, fordi man ikke selv kan huske det, og kan derfor ikke se, at
|
||||||
|
// svaret var gættet.
|
||||||
|
func TestAskingAboutNothingAnswersNothing(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
ts.useModel(t, fakeModel(t, `{"answer": "det burde du huske", "sources": []}`))
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/ai/ask",
|
||||||
|
map[string]any{"question": "kvadratrodenafenbanan"})
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("spørg: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if out["answer"] != "" {
|
||||||
|
t.Errorf("der blev svaret uden noget at svare ud fra: %v", out["answer"])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -20,6 +20,11 @@ import (
|
|||||||
|
|
||||||
const beaconScope = "beacon"
|
const beaconScope = "beacon"
|
||||||
|
|
||||||
|
// defaultPublishMin er, hvor mange installationer der skal være, før tallet
|
||||||
|
// offentliggøres. Selve tallet er et skøn; det, gulvet køber, er det ikke: under
|
||||||
|
// det fortæller et offentligt tal mest om, hvor lidt der skal til at flytte det.
|
||||||
|
const defaultPublishMin = 25
|
||||||
|
|
||||||
// beaconConfig is what this instance has been told to do. The zero value is what
|
// beaconConfig is what this instance has been told to do. The zero value is what
|
||||||
// a fresh installation gets, which is why Enabled defaults to true elsewhere and
|
// a fresh installation gets, which is why Enabled defaults to true elsewhere and
|
||||||
// not here — a zero struct must never mean "silently on".
|
// not here — a zero struct must never mean "silently on".
|
||||||
@@ -30,6 +35,33 @@ type beaconConfig struct {
|
|||||||
IsCollector bool `json:"is_collector"`
|
IsCollector bool `json:"is_collector"`
|
||||||
PublishCount bool `json:"publish_count"`
|
PublishCount bool `json:"publish_count"`
|
||||||
LastPingAt int64 `json:"last_ping_at,omitempty"`
|
LastPingAt int64 `json:"last_ping_at,omitempty"`
|
||||||
|
// LastVersion er den version, der sidst nåede frem. Gemt, fordi en
|
||||||
|
// installation, der opdaterer sig selv om natten, ellers står som gårsdagens
|
||||||
|
// version i op til et døgn — og en tælling efter version, der er en dag bagud,
|
||||||
|
// kan man ikke se en udrulning i.
|
||||||
|
LastVersion string `json:"last_version,omitempty"`
|
||||||
|
// LastError er grunden til, at det sidste forsøg ikke nåede frem.
|
||||||
|
//
|
||||||
|
// Skrevet ned, fordi alternativet er tavshed: et beacon, der ikke kan nå sin
|
||||||
|
// collector, prøver igen i morgen og siger ingenting, og det opdages først ved
|
||||||
|
// at tælle installationer i den anden ende og savne en. Det er ikke en fejl,
|
||||||
|
// der skal afbryde nogen — det er en linje på en side, der ellers påstår, at
|
||||||
|
// alt er sendt.
|
||||||
|
LastError string `json:"last_error,omitempty"`
|
||||||
|
LastErrorAt int64 `json:"last_error_at,omitempty"`
|
||||||
|
// NoticeAck er sat, når nogen har set beskeden om, hvad der bliver sendt.
|
||||||
|
//
|
||||||
|
// Slået til som udgangspunkt kan kun forsvares, hvis det bliver sagt
|
||||||
|
// uopfordret — ikke på en indstillingsside, ingen åbner af sig selv. Feltet er
|
||||||
|
// det, der husker, at det er blevet sagt.
|
||||||
|
NoticeAck bool `json:"notice_ack"`
|
||||||
|
// PublishMin er gulvet under det offentliggjorte tal.
|
||||||
|
//
|
||||||
|
// Et tal, der *falder*, kan ikke offentliggøres som en kendsgerning: en dårlig
|
||||||
|
// udrulning, en DNS-ændring, der stille stopper meldingerne, eller rækker, der
|
||||||
|
// er væk, ser alle sammen ud som "færre bruger det nu". Under gulvet svares
|
||||||
|
// der ingenting frem for et lille tal, ingen kan tolke.
|
||||||
|
PublishMin int `json:"publish_min"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// beaconSettings reads the configuration, filling in the defaults and minting the
|
// beaconSettings reads the configuration, filling in the defaults and minting the
|
||||||
@@ -40,7 +72,9 @@ type beaconConfig struct {
|
|||||||
// also be a value the collector could compare against a guess — which is the
|
// also be a value the collector could compare against a guess — which is the
|
||||||
// difference between anonymous and pseudonymous, and it is the whole point.
|
// difference between anonymous and pseudonymous, and it is the whole point.
|
||||||
func (s *Server) beaconSettings(ctx context.Context) (beaconConfig, error) {
|
func (s *Server) beaconSettings(ctx context.Context) (beaconConfig, error) {
|
||||||
cfg := beaconConfig{Enabled: true, Collector: beacon.DefaultCollector}
|
cfg := beaconConfig{
|
||||||
|
Enabled: true, Collector: beacon.DefaultCollector, PublishMin: defaultPublishMin,
|
||||||
|
}
|
||||||
|
|
||||||
stored, err := s.db.InstanceSettings(ctx, beaconScope)
|
stored, err := s.db.InstanceSettings(ctx, beaconScope)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -65,6 +99,21 @@ func (s *Server) beaconSettings(ctx context.Context) (beaconConfig, error) {
|
|||||||
if v, ok := stored["last_ping_at"].(float64); ok {
|
if v, ok := stored["last_ping_at"].(float64); ok {
|
||||||
cfg.LastPingAt = int64(v)
|
cfg.LastPingAt = int64(v)
|
||||||
}
|
}
|
||||||
|
if v, ok := stored["last_version"].(string); ok {
|
||||||
|
cfg.LastVersion = v
|
||||||
|
}
|
||||||
|
if v, ok := stored["last_error"].(string); ok {
|
||||||
|
cfg.LastError = v
|
||||||
|
}
|
||||||
|
if v, ok := stored["last_error_at"].(float64); ok {
|
||||||
|
cfg.LastErrorAt = int64(v)
|
||||||
|
}
|
||||||
|
if v, ok := stored["notice_ack"].(bool); ok {
|
||||||
|
cfg.NoticeAck = v
|
||||||
|
}
|
||||||
|
if v, ok := stored["publish_min"].(float64); ok && v >= 0 {
|
||||||
|
cfg.PublishMin = int(v)
|
||||||
|
}
|
||||||
|
|
||||||
if cfg.InstanceID == "" {
|
if cfg.InstanceID == "" {
|
||||||
cfg.InstanceID = store.NewID()
|
cfg.InstanceID = store.NewID()
|
||||||
@@ -83,20 +132,31 @@ func (s *Server) saveBeaconSettings(ctx context.Context, cfg beaconConfig) error
|
|||||||
"is_collector": cfg.IsCollector,
|
"is_collector": cfg.IsCollector,
|
||||||
"publish_count": cfg.PublishCount,
|
"publish_count": cfg.PublishCount,
|
||||||
"last_ping_at": cfg.LastPingAt,
|
"last_ping_at": cfg.LastPingAt,
|
||||||
|
"last_version": cfg.LastVersion,
|
||||||
|
"last_error": cfg.LastError,
|
||||||
|
"last_error_at": cfg.LastErrorAt,
|
||||||
|
"notice_ack": cfg.NoticeAck,
|
||||||
|
"publish_min": cfg.PublishMin,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- what the settings page shows ------------------------------------------------
|
// --- what the settings page shows ------------------------------------------------
|
||||||
|
|
||||||
type beaconStatusJSON struct {
|
type beaconStatusJSON struct {
|
||||||
Enabled bool `json:"enabled"`
|
Enabled bool `json:"enabled"`
|
||||||
Collector string `json:"collector_url"`
|
Collector string `json:"collector_url"`
|
||||||
InstanceID string `json:"instance_id"`
|
InstanceID string `json:"instance_id"`
|
||||||
Version string `json:"version"`
|
Version string `json:"version"`
|
||||||
IsCollector bool `json:"is_collector"`
|
IsCollector bool `json:"is_collector"`
|
||||||
PublishCount bool `json:"publish_count"`
|
PublishCount bool `json:"publish_count"`
|
||||||
LastPingAt string `json:"last_ping_at,omitempty"`
|
PublishMin int `json:"publish_min"`
|
||||||
Stats *store.BeaconStats `json:"stats,omitempty"`
|
LastPingAt string `json:"last_ping_at,omitempty"`
|
||||||
|
// Sidste forsøg, der ikke nåede frem — tomt, når det sidste gik godt. Vist
|
||||||
|
// frem for talt: en dato under "sidst sendt", der bliver ældre og ældre, er
|
||||||
|
// det eneste spor, et tavst beacon ellers efterlader.
|
||||||
|
LastError string `json:"last_error,omitempty"`
|
||||||
|
LastErrorAt string `json:"last_error_at,omitempty"`
|
||||||
|
Stats *store.BeaconStats `json:"stats,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) handleBeaconStatus(w http.ResponseWriter, r *http.Request) {
|
func (s *Server) handleBeaconStatus(w http.ResponseWriter, r *http.Request) {
|
||||||
@@ -109,10 +169,15 @@ func (s *Server) handleBeaconStatus(w http.ResponseWriter, r *http.Request) {
|
|||||||
out := beaconStatusJSON{
|
out := beaconStatusJSON{
|
||||||
Enabled: cfg.Enabled, Collector: cfg.Collector, InstanceID: cfg.InstanceID,
|
Enabled: cfg.Enabled, Collector: cfg.Collector, InstanceID: cfg.InstanceID,
|
||||||
Version: Version, IsCollector: cfg.IsCollector, PublishCount: cfg.PublishCount,
|
Version: Version, IsCollector: cfg.IsCollector, PublishCount: cfg.PublishCount,
|
||||||
|
PublishMin: cfg.PublishMin,
|
||||||
}
|
}
|
||||||
if cfg.LastPingAt > 0 {
|
if cfg.LastPingAt > 0 {
|
||||||
out.LastPingAt = time.Unix(cfg.LastPingAt, 0).Format(time.RFC3339)
|
out.LastPingAt = time.Unix(cfg.LastPingAt, 0).Format(time.RFC3339)
|
||||||
}
|
}
|
||||||
|
if cfg.LastError != "" {
|
||||||
|
out.LastError = cfg.LastError
|
||||||
|
out.LastErrorAt = time.Unix(cfg.LastErrorAt, 0).Format(time.RFC3339)
|
||||||
|
}
|
||||||
if cfg.IsCollector {
|
if cfg.IsCollector {
|
||||||
stats, err := s.db.BeaconSummary(r.Context())
|
stats, err := s.db.BeaconSummary(r.Context())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -129,6 +194,7 @@ type beaconRequest struct {
|
|||||||
Collector *string `json:"collector_url"`
|
Collector *string `json:"collector_url"`
|
||||||
IsCollector *bool `json:"is_collector"`
|
IsCollector *bool `json:"is_collector"`
|
||||||
PublishCount *bool `json:"publish_count"`
|
PublishCount *bool `json:"publish_count"`
|
||||||
|
PublishMin *int `json:"publish_min"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) handleSetBeacon(w http.ResponseWriter, r *http.Request) {
|
func (s *Server) handleSetBeacon(w http.ResponseWriter, r *http.Request) {
|
||||||
@@ -151,6 +217,13 @@ func (s *Server) handleSetBeacon(w http.ResponseWriter, r *http.Request) {
|
|||||||
if req.PublishCount != nil {
|
if req.PublishCount != nil {
|
||||||
cfg.PublishCount = *req.PublishCount
|
cfg.PublishCount = *req.PublishCount
|
||||||
}
|
}
|
||||||
|
if req.PublishMin != nil {
|
||||||
|
if *req.PublishMin < 0 {
|
||||||
|
writeFieldErrors(w, map[string]string{"publish_min": "must not be negative"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
cfg.PublishMin = *req.PublishMin
|
||||||
|
}
|
||||||
if req.Collector != nil {
|
if req.Collector != nil {
|
||||||
url := strings.TrimSpace(*req.Collector)
|
url := strings.TrimSpace(*req.Collector)
|
||||||
if url == "" {
|
if url == "" {
|
||||||
@@ -237,6 +310,16 @@ func (s *Server) handleBeaconCount(w http.ResponseWriter, r *http.Request) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
n, err := s.db.BeaconCount(r.Context(), 30*24*time.Hour)
|
n, err := s.db.BeaconCount(r.Context(), 30*24*time.Hour)
|
||||||
|
if err == nil && n < cfg.PublishMin {
|
||||||
|
// Ingenting frem for et lille tal. Et tal under gulvet fortæller mest om,
|
||||||
|
// hvor lidt der skal til at flytte det — og et, der falder, ville blive
|
||||||
|
// læst som "færre bruger det nu", også når det i virkeligheden var en
|
||||||
|
// udrulning, der gik galt, eller en adresse, der stille holdt op med at
|
||||||
|
// blive ramt.
|
||||||
|
w.Header().Set("Cache-Control", "public, max-age=60")
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"installs": nil, "window_days": 30})
|
||||||
|
return
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.internal(w, r, "beacon count", err)
|
s.internal(w, r, "beacon count", err)
|
||||||
return
|
return
|
||||||
@@ -269,11 +352,15 @@ func (s *Server) SendBeacon(ctx context.Context) error {
|
|||||||
if err := s.db.RecordBeacon(ctx, cfg.InstanceID, Version); err != nil {
|
if err := s.db.RecordBeacon(ctx, cfg.InstanceID, Version); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
cfg.LastPingAt = time.Now().Unix()
|
return s.beaconSent(ctx, cfg)
|
||||||
return s.saveBeaconSettings(ctx, cfg)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if time.Since(time.Unix(cfg.LastPingAt, 0)) < 24*time.Hour {
|
// Undtagelsen fra døgnet er en version, der er skiftet. En installation, der
|
||||||
|
// opdaterer sig selv om natten og først melder ind igen et døgn senere, står
|
||||||
|
// som gårsdagens version hele dagen — og så kan man ikke se en udrulning i
|
||||||
|
// tallene. Målt hos Yggdrasil: to paneler rapporterede den forrige version i
|
||||||
|
// et døgn efter at være opdateret.
|
||||||
|
if time.Since(time.Unix(cfg.LastPingAt, 0)) < 24*time.Hour && cfg.LastVersion == Version {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -289,9 +376,100 @@ func (s *Server) SendBeacon(ctx context.Context) error {
|
|||||||
// installation's problem and must never look like one — it is somebody
|
// installation's problem and must never look like one — it is somebody
|
||||||
// else's server, and the only consequence is a number being one lower.
|
// else's server, and the only consequence is a number being one lower.
|
||||||
s.log.Info("beacon not delivered", "err", err)
|
s.log.Info("beacon not delivered", "err", err)
|
||||||
return nil
|
// Men skrevet ned. Uden det her fejler et beacon, der ikke kan nå sin
|
||||||
|
// collector, i fuldstændig tavshed: det prøver igen i morgen, siden siger
|
||||||
|
// "sidst sendt" med en dato, der bare bliver ældre, og ingen opdager det.
|
||||||
|
// Fundet hos Yggdrasil ved at tælle installationer i den anden ende og
|
||||||
|
// savne en.
|
||||||
|
cfg.LastError, cfg.LastErrorAt = err.Error(), time.Now().Unix()
|
||||||
|
return s.saveBeaconSettings(ctx, cfg)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return s.beaconSent(ctx, cfg)
|
||||||
|
}
|
||||||
|
|
||||||
|
// beaconSent skriver, at det lykkedes: tidspunktet, versionen der nåede frem, og
|
||||||
|
// en fejl, der ikke længere gælder. Ét sted, fordi de fire felter skal skrives
|
||||||
|
// sammen — en gemning, der glemte at rydde fejlen, ville lade en linje stå på
|
||||||
|
// siden om noget, der virker.
|
||||||
|
func (s *Server) beaconSent(ctx context.Context, cfg beaconConfig) error {
|
||||||
cfg.LastPingAt = time.Now().Unix()
|
cfg.LastPingAt = time.Now().Unix()
|
||||||
|
cfg.LastVersion = Version
|
||||||
|
cfg.LastError, cfg.LastErrorAt = "", 0
|
||||||
return s.saveBeaconSettings(ctx, cfg)
|
return s.saveBeaconSettings(ctx, cfg)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- beskeden, der bliver sagt uopfordret ------------------------------------------
|
||||||
|
|
||||||
|
// handleBeaconNotice says whether the disclosure is still owed, and what it would
|
||||||
|
// say.
|
||||||
|
//
|
||||||
|
// Slået til som udgangspunkt kan kun forsvares, hvis det bliver sagt uopfordret.
|
||||||
|
// En indstillingsside, hvor det står rigtigt og fyldestgørende, er ikke det samme
|
||||||
|
// som at sige det: den bliver åbnet af dem, der i forvejen har en mistanke om, at
|
||||||
|
// der er noget at læse. Uden beskeden her er "du kan slå den fra" et tilbud til
|
||||||
|
// dem, der ved, at der er noget at slå fra.
|
||||||
|
//
|
||||||
|
// De tre værdier står i svaret — det rigtige id, den rigtige version, den rigtige
|
||||||
|
// adresse — så beskeden kan vise, hvad der bliver sendt, frem for at sige
|
||||||
|
// "anonyme data" og bede om at blive troet på. Det er den eneste version af det
|
||||||
|
// løfte, der er noget værd: en, læseren selv kan kontrollere.
|
||||||
|
//
|
||||||
|
// Panelbredt frem for pr. bruger: det er installationen, der melder ind, ikke
|
||||||
|
// personen, og en besked pr. konto ville stille det samme spørgsmål til folk, der
|
||||||
|
// ikke kan svare på det.
|
||||||
|
func (s *Server) handleBeaconNotice(w http.ResponseWriter, r *http.Request) {
|
||||||
|
cfg, err := s.beaconSettings(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "beacon settings", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{
|
||||||
|
"pending": !cfg.NoticeAck,
|
||||||
|
"enabled": cfg.Enabled,
|
||||||
|
"instance_id": cfg.InstanceID,
|
||||||
|
"version": Version,
|
||||||
|
"collector_url": cfg.Collector,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
type beaconNoticeRequest struct {
|
||||||
|
// Keep er en peger og ikke en bool, og det er hele pointen.
|
||||||
|
//
|
||||||
|
// En tom krop ville ellers betyde "slå det fra", og det er den vej, en fejl
|
||||||
|
// aldrig må falde: et fravalg, ingen har truffet, er lige så meget et brudt
|
||||||
|
// løfte som et tilvalg, ingen har truffet. Yggdrasil har den fejl i sin
|
||||||
|
// tilsvarende ende og er blevet bidt af den.
|
||||||
|
Keep *bool `json:"keep"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleAckBeaconNotice records that the notice has been seen, and turns the
|
||||||
|
// beacon off if that was the answer.
|
||||||
|
//
|
||||||
|
// Ét kald til begge svar. "Behold den" og "slå den fra" er den samme handling —
|
||||||
|
// nogen har taget stilling — og to endpoints ville betyde, at det ene kunne
|
||||||
|
// glemme at skrive, at der var taget stilling, og beskeden dermed komme igen.
|
||||||
|
func (s *Server) handleAckBeaconNotice(w http.ResponseWriter, r *http.Request) {
|
||||||
|
var req beaconNoticeRequest
|
||||||
|
if err := decodeJSON(w, r, &req); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if req.Keep == nil {
|
||||||
|
writeFieldErrors(w, map[string]string{"keep": "required"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg, err := s.beaconSettings(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "beacon settings", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
cfg.NoticeAck = true
|
||||||
|
cfg.Enabled = *req.Keep
|
||||||
|
if err := s.saveBeaconSettings(r.Context(), cfg); err != nil {
|
||||||
|
s.internal(w, r, "save beacon settings", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s.log.Info("beacon notice answered", "keep", *req.Keep, "user", userFrom(r.Context()).ID)
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"enabled": cfg.Enabled})
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,132 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Beaconet er slået til som udgangspunkt, og det kan kun forsvares, hvis det
|
||||||
|
// bliver sagt uopfordret. Beskeden venter, indtil nogen har taget stilling — og
|
||||||
|
// den viser de rigtige værdier, så løftet kan efterprøves frem for tros på.
|
||||||
|
func TestTheBeaconSaysWhatItSendsBeforeAnybodyAsks(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
resp, notice := ts.do(t, "GET", "/api/v1/beacon/notice", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("hent besked: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if notice["pending"] != true {
|
||||||
|
t.Fatalf("beskeden er ikke i vente på en frisk installation: %v", notice)
|
||||||
|
}
|
||||||
|
if notice["enabled"] != true {
|
||||||
|
t.Errorf("beaconet er ikke slået til som udgangspunkt: %v", notice)
|
||||||
|
}
|
||||||
|
// De tre værdier, beskeden viser frem, er de rigtige — ikke et eksempel.
|
||||||
|
settings := beaconSettingsOf(t, ts)
|
||||||
|
if notice["instance_id"] != settings["instance_id"] {
|
||||||
|
t.Errorf("id i beskeden = %v, i indstillingerne = %v",
|
||||||
|
notice["instance_id"], settings["instance_id"])
|
||||||
|
}
|
||||||
|
if notice["collector_url"] != settings["collector_url"] {
|
||||||
|
t.Errorf("adressen i beskeden = %v, i indstillingerne = %v",
|
||||||
|
notice["collector_url"], settings["collector_url"])
|
||||||
|
}
|
||||||
|
if notice["version"] == "" || notice["version"] == nil {
|
||||||
|
t.Error("beskeden siger ikke, hvilken version der bliver sendt")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// "Behold den" er et svar, og det svar skal huskes: beskeden må ikke komme igen
|
||||||
|
// ved næste login.
|
||||||
|
func TestKeepingTheBeaconAnswersTheNoticeForGood(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/beacon/notice", map[string]any{"keep": true})
|
||||||
|
if resp.StatusCode != http.StatusOK || out["enabled"] != true {
|
||||||
|
t.Fatalf("behold: %d %v", resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
if _, notice := ts.do(t, "GET", "/api/v1/beacon/notice", nil); notice["pending"] != false {
|
||||||
|
t.Errorf("beskeden kommer igen efter et svar: %v", notice)
|
||||||
|
}
|
||||||
|
if s := beaconSettingsOf(t, ts); s["enabled"] != true {
|
||||||
|
t.Errorf("beaconet blev slået fra af et ja: %v", s["enabled"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Og "slå den fra" slår den fra — ét kald, både svaret og virkningen.
|
||||||
|
func TestTurningTheBeaconOffFromTheNoticeStopsIt(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/beacon/notice", map[string]any{"keep": false})
|
||||||
|
if resp.StatusCode != http.StatusOK || out["enabled"] != false {
|
||||||
|
t.Fatalf("slå fra: %d %v", resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
s := beaconSettingsOf(t, ts)
|
||||||
|
if s["enabled"] != false {
|
||||||
|
t.Errorf("beaconet kører stadig efter et nej: %v", s["enabled"])
|
||||||
|
}
|
||||||
|
if _, notice := ts.do(t, "GET", "/api/v1/beacon/notice", nil); notice["pending"] != false {
|
||||||
|
t.Errorf("beskeden kommer igen efter et nej: %v", notice)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En tom krop må ikke kunne betyde "slå det fra". Et fravalg, ingen har truffet,
|
||||||
|
// er lige så meget et brudt løfte som et tilvalg, ingen har truffet.
|
||||||
|
func TestAnEmptyAnswerToTheNoticeIsRefused(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
resp, _ := ts.do(t, "POST", "/api/v1/beacon/notice", map[string]any{})
|
||||||
|
if resp.StatusCode != http.StatusUnprocessableEntity {
|
||||||
|
t.Fatalf("tom krop gav %d, want 422", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if s := beaconSettingsOf(t, ts); s["enabled"] != true {
|
||||||
|
t.Errorf("en tom krop slog beaconet fra: %v", s["enabled"])
|
||||||
|
}
|
||||||
|
if _, notice := ts.do(t, "GET", "/api/v1/beacon/notice", nil); notice["pending"] != true {
|
||||||
|
t.Errorf("en tom krop talte som et svar: %v", notice)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Et tal, der falder, kan ikke offentliggøres som en kendsgerning. Under gulvet
|
||||||
|
// svares der ingenting frem for et lille tal, ingen kan tolke.
|
||||||
|
func TestThePublishedCountHasAFloorUnderIt(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
if resp, _ := ts.do(t, "PUT", "/api/v1/beacon/settings", map[string]any{
|
||||||
|
"is_collector": true, "publish_count": true,
|
||||||
|
}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("bliv collector")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Instansen tæller sig selv, så der er én. Gulvet er højere.
|
||||||
|
resp, out := ts.do(t, "GET", "/api/v1/beacon/count", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("tælling: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if out["installs"] != nil {
|
||||||
|
t.Errorf("et tal under gulvet blev offentliggjort: %v", out["installs"])
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sættes gulvet ned, står tallet der.
|
||||||
|
if resp, _ := ts.do(t, "PUT", "/api/v1/beacon/settings",
|
||||||
|
map[string]any{"publish_min": 0}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("sænk gulvet")
|
||||||
|
}
|
||||||
|
if _, out := ts.do(t, "GET", "/api/v1/beacon/count", nil); out["installs"] == nil {
|
||||||
|
t.Errorf("tallet blev holdt tilbage uden et gulv: %v", out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func beaconSettingsOf(t *testing.T, ts *testServer) map[string]any {
|
||||||
|
t.Helper()
|
||||||
|
resp, out := ts.do(t, "GET", "/api/v1/beacon/settings", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("hent beacon-indstillinger: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
@@ -251,10 +251,12 @@ func (s *Server) handleGmailSyncNow(w http.ResponseWriter, r *http.Request) {
|
|||||||
// takes a context and a user rather than a request.
|
// takes a context and a user rather than a request.
|
||||||
// maxGmailSeen bounds the list of message ids already turned into tasks.
|
// maxGmailSeen bounds the list of message ids already turned into tasks.
|
||||||
//
|
//
|
||||||
// Gmail is read-only here — the scope is `gmail.readonly`, deliberately, because
|
// The star is taken off an imported message now, so on a starred trigger the mail
|
||||||
// asking for less is what makes the consent screen something a person can agree
|
// leaves the query on its own and this list is a safety net rather than the only
|
||||||
// to — so verdande cannot unstar a message the way the IMAP side unflags one. The
|
// record. It still earns its place: it covers the window between making the task
|
||||||
// record has to live on this side, and a record on this side has to be bounded.
|
// and the star coming off, and it is the whole of the dedup for a label trigger,
|
||||||
|
// where the label is the person's and not ours to remove. A record on this side
|
||||||
|
// has to be bounded.
|
||||||
//
|
//
|
||||||
// A count rather than the previous rule of "whatever Gmail returned this run",
|
// A count rather than the previous rule of "whatever Gmail returned this run",
|
||||||
// which was not a bound but a way of forgetting.
|
// which was not a bound but a way of forgetting.
|
||||||
@@ -330,7 +332,16 @@ func (s *Server) SyncGmail(ctx context.Context, user *store.User) (int, error) {
|
|||||||
projectID = inbox
|
projectID = inbox
|
||||||
}
|
}
|
||||||
|
|
||||||
created := 0
|
// Hentet først, skrevet bagefter. To gennemløb frem for ét, fordi modellen
|
||||||
|
// skal se hele bunken på én gang: ét spørgsmål for femogtyve mails frem for
|
||||||
|
// femogtyve spørgsmål er den samme oplysning til en femogtyvendedel af
|
||||||
|
// ventetiden — og et gennemløb, der tager fem minutter, overlapper med det
|
||||||
|
// næste.
|
||||||
|
type fetched struct {
|
||||||
|
id string
|
||||||
|
msg gmail.Message
|
||||||
|
}
|
||||||
|
var pending []fetched
|
||||||
for _, id := range ids {
|
for _, id := range ids {
|
||||||
if seen[id] {
|
if seen[id] {
|
||||||
continue
|
continue
|
||||||
@@ -338,13 +349,27 @@ func (s *Server) SyncGmail(ctx context.Context, user *store.User) (int, error) {
|
|||||||
// A spent budget ends the run rather than turning into twenty-five failed
|
// A spent budget ends the run rather than turning into twenty-five failed
|
||||||
// fetches logged one at a time.
|
// fetches logged one at a time.
|
||||||
if ctx.Err() != nil {
|
if ctx.Err() != nil {
|
||||||
return created, ctx.Err()
|
return 0, ctx.Err()
|
||||||
}
|
}
|
||||||
msg, err := client.Get(ctx, id)
|
msg, err := client.Get(ctx, id)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.log.Warn("gmail get message", "err", err, "id", id)
|
s.log.Warn("gmail get message", "err", err, "id", id)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
pending = append(pending, fetched{id: id, msg: msg})
|
||||||
|
}
|
||||||
|
|
||||||
|
forAI := make([]mailForAI, 0, len(pending))
|
||||||
|
for _, f := range pending {
|
||||||
|
forAI = append(forAI, mailForAI{
|
||||||
|
From: gmail.SenderName(f.msg.From), Subject: f.msg.Subject, Snippet: f.msg.Snippet,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
written := s.mailTaskLines(ctx, user, forAI)
|
||||||
|
|
||||||
|
created := 0
|
||||||
|
for i, f := range pending {
|
||||||
|
id, msg := f.id, f.msg
|
||||||
|
|
||||||
subject := strings.TrimSpace(msg.Subject)
|
subject := strings.TrimSpace(msg.Subject)
|
||||||
if subject == "" {
|
if subject == "" {
|
||||||
@@ -365,6 +390,9 @@ func (s *Server) SyncGmail(ctx context.Context, user *store.User) (int, error) {
|
|||||||
// key exists to prevent.
|
// key exists to prevent.
|
||||||
SourceKey: "gmail:thread:" + msg.ThreadID,
|
SourceKey: "gmail:thread:" + msg.ThreadID,
|
||||||
}
|
}
|
||||||
|
// Og modellens linje, hvis den skrev en til netop den her mail.
|
||||||
|
s.applyMailLine(ctx, user, task, written[i], sender+": "+subject)
|
||||||
|
|
||||||
if err := s.db.CreateTask(ctx, task, nil); err != nil {
|
if err := s.db.CreateTask(ctx, task, nil); err != nil {
|
||||||
if errors.Is(err, store.ErrDuplicate) {
|
if errors.Is(err, store.ErrDuplicate) {
|
||||||
// Somebody got there first — an earlier sweep, or another
|
// Somebody got there first — an earlier sweep, or another
|
||||||
@@ -381,6 +409,29 @@ func (s *Server) SyncGmail(ctx context.Context, user *store.User) (int, error) {
|
|||||||
s.hub.Publish(projectID, "task.created", toTaskJSON(*task))
|
s.hub.Publish(projectID, "task.created", toTaskJSON(*task))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The star comes off every message this query returned that now has a task —
|
||||||
|
// the ones made this run and the ones a run before it already made. Gated to the
|
||||||
|
// triggers that are about the star: for a label trigger the star is the person's
|
||||||
|
// own and not ours to touch, and dedup there rests on the seen list alone.
|
||||||
|
//
|
||||||
|
// Best effort, exactly like the IMAP unflag: a task made is not undone by a star
|
||||||
|
// that would not come off. The likeliest reason it will not, right after this
|
||||||
|
// ships, is a connection still holding the old read-only grant — the write is a
|
||||||
|
// 403 until the account is reconnected, and this logs it rather than failing the
|
||||||
|
// sync. It self-heals: the mail stays starred, stays in the next query, and is
|
||||||
|
// tried again once the grant is there.
|
||||||
|
if box.Trigger == "starred" || box.Trigger == "both" {
|
||||||
|
unstar := make([]string, 0, len(ids))
|
||||||
|
for _, id := range ids {
|
||||||
|
if seen[id] {
|
||||||
|
unstar = append(unstar, id)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := client.Unstar(ctx, unstar); err != nil {
|
||||||
|
s.log.Warn("gmail unstar", "err", err, "user", user.ID, "count", len(unstar))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if created > 0 {
|
if created > 0 {
|
||||||
// The ids this run saw, on top of the ones already known.
|
// The ids this run saw, on top of the ones already known.
|
||||||
//
|
//
|
||||||
@@ -442,8 +493,8 @@ func (s *Server) handleVersion(w http.ResponseWriter, r *http.Request) {
|
|||||||
//
|
//
|
||||||
// The one click that opens Google's consent screen already exists; what it needs
|
// The one click that opens Google's consent screen already exists; what it needs
|
||||||
// behind it is a registered client, and that is not something any app can conjure:
|
// behind it is a registered client, and that is not something any app can conjure:
|
||||||
// Google issues no Gmail access to an unregistered client, and `gmail.readonly` is
|
// Google issues no Gmail access to an unregistered client, and `gmail.modify` is a
|
||||||
// a restricted scope, so an id shipped inside a public image would be both
|
// restricted scope, so an id shipped inside a public image would be both
|
||||||
// extractable from it and unusable without Google's security review of every
|
// extractable from it and unusable without Google's security review of every
|
||||||
// deployment. The registration is a one-off. Having to edit a Rune's manifest and
|
// deployment. The registration is a one-off. Having to edit a Rune's manifest and
|
||||||
// recreate the container to paste the result was not.
|
// recreate the container to paste the result was not.
|
||||||
|
|||||||
@@ -1,14 +1,17 @@
|
|||||||
package httpapi
|
package httpapi
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"github.com/kristianwind/verdande/internal/store"
|
"encoding/json"
|
||||||
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/kristianwind/verdande/internal/config"
|
"github.com/kristianwind/verdande/internal/config"
|
||||||
|
"github.com/kristianwind/verdande/internal/store"
|
||||||
)
|
)
|
||||||
|
|
||||||
// A Gmail failure has to survive being reported.
|
// A Gmail failure has to survive being reported.
|
||||||
@@ -150,6 +153,84 @@ func TestASlowMailboxDoesNotHangTheRequest(t *testing.T) {
|
|||||||
t.Logf("came back in %s with %d", took.Round(time.Millisecond), resp.StatusCode)
|
t.Logf("came back in %s with %d", took.Round(time.Millisecond), resp.StatusCode)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A message that becomes a task has its star taken off — the write that the whole
|
||||||
|
// gmail.modify scope is for. The mail's own inbox empties as the tasks are made,
|
||||||
|
// the way the IMAP side unflags what it imports.
|
||||||
|
func TestASyncedGmailMessageIsUnstarred(t *testing.T) {
|
||||||
|
var unstarred struct {
|
||||||
|
hit bool
|
||||||
|
body struct {
|
||||||
|
IDs []string `json:"ids"`
|
||||||
|
RemoveLabelIDs []string `json:"removeLabelIds"`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
google := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
switch {
|
||||||
|
case r.Method == "POST" && strings.HasSuffix(r.URL.Path, "/messages/batchModify"):
|
||||||
|
unstarred.hit = true
|
||||||
|
raw, _ := io.ReadAll(r.Body)
|
||||||
|
_ = json.Unmarshal(raw, &unstarred.body)
|
||||||
|
w.WriteHeader(http.StatusNoContent)
|
||||||
|
case strings.Contains(r.URL.Path, "/messages/") && r.URL.Query().Get("format") == "metadata":
|
||||||
|
writeTestJSON(w, map[string]any{
|
||||||
|
"id": "m1", "threadId": "t1", "snippet": "kort tekst",
|
||||||
|
"payload": map[string]any{"headers": []map[string]string{
|
||||||
|
{"name": "From", "value": "Anders <anders@example.dk>"},
|
||||||
|
{"name": "Subject", "value": "Møde på fredag"},
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
case strings.HasSuffix(r.URL.Path, "/messages"):
|
||||||
|
writeTestJSON(w, map[string]any{"messages": []map[string]string{{"id": "m1"}}})
|
||||||
|
default:
|
||||||
|
http.Error(w, "unexpected "+r.Method+" "+r.URL.Path, http.StatusNotFound)
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
defer google.Close()
|
||||||
|
|
||||||
|
ts := newTestServerWith(t, func(cfg *config.Config) {
|
||||||
|
cfg.GmailClientID = "test-client"
|
||||||
|
cfg.GmailClientSecret = "test-secret"
|
||||||
|
cfg.GoogleTokenURL = google.URL + "/token"
|
||||||
|
cfg.GmailAPIURL = google.URL
|
||||||
|
})
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
user, err := ts.db.UserByEmail(t.Context(), "kristian@example.dk")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
// A live access token, so the run goes straight to the list without a refresh.
|
||||||
|
if err := ts.db.SaveMailbox(t.Context(), &store.Mailbox{
|
||||||
|
UserID: user.ID, Kind: "gmail", RefreshToken: "r", AccessToken: "a",
|
||||||
|
Trigger: "starred", ExpiresAt: time.Now().Add(time.Hour),
|
||||||
|
}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, body := ts.do(t, "POST", "/api/v1/gmail/sync", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("sync: status %d, want 200", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if created, _ := body["created"].(float64); created != 1 {
|
||||||
|
t.Fatalf("created = %v, want 1", body["created"])
|
||||||
|
}
|
||||||
|
|
||||||
|
if !unstarred.hit {
|
||||||
|
t.Fatal("the message was never unstarred; its star is the one thing modify is for")
|
||||||
|
}
|
||||||
|
if strings.Join(unstarred.body.IDs, ",") != "m1" {
|
||||||
|
t.Errorf("unstarred ids = %v, want [m1]", unstarred.body.IDs)
|
||||||
|
}
|
||||||
|
if strings.Join(unstarred.body.RemoveLabelIDs, ",") != "STARRED" {
|
||||||
|
t.Errorf("removed = %v, want [STARRED]", unstarred.body.RemoveLabelIDs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeTestJSON(w http.ResponseWriter, v any) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
_ = json.NewEncoder(w).Encode(v)
|
||||||
|
}
|
||||||
|
|
||||||
func mustParse(t *testing.T, raw string) *url.URL {
|
func mustParse(t *testing.T, raw string) *url.URL {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
u, err := url.Parse(raw)
|
u, err := url.Parse(raw)
|
||||||
|
|||||||
@@ -0,0 +1,194 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// doRaw sender en krop, der ikke er JSON — en genvej på en telefon sender ren
|
||||||
|
// tekst, og en webhook-formular sender felter. Det er halvdelen af det, der
|
||||||
|
// prøves her.
|
||||||
|
func (ts *testServer) doRaw(t *testing.T, method, path, contentType, body string) (*http.Response, map[string]any) {
|
||||||
|
t.Helper()
|
||||||
|
req, err := http.NewRequest(method, ts.URL+path, strings.NewReader(body))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("build request: %v", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Content-Type", contentType)
|
||||||
|
resp, err := ts.client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s %s: %v", method, path, err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { resp.Body.Close() })
|
||||||
|
|
||||||
|
var decoded map[string]any
|
||||||
|
raw, _ := io.ReadAll(resp.Body)
|
||||||
|
if len(raw) > 0 {
|
||||||
|
_ = json.Unmarshal(raw, &decoded)
|
||||||
|
}
|
||||||
|
return resp, decoded
|
||||||
|
}
|
||||||
|
|
||||||
|
// hookURL henter personens egen krog-adresse, som fladen viser den.
|
||||||
|
func (ts *testServer) hookURL(t *testing.T) string {
|
||||||
|
t.Helper()
|
||||||
|
resp, out := ts.do(t, "GET", "/api/v1/hook-url", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("hent krog-URL: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
url, _ := out["url"].(string)
|
||||||
|
if !strings.Contains(url, "/inbound/hook/") {
|
||||||
|
t.Fatalf("url = %q", url)
|
||||||
|
}
|
||||||
|
return url
|
||||||
|
}
|
||||||
|
|
||||||
|
// hookPath er stien, testserveren kan kaldes på — URL'en er absolut, fordi den
|
||||||
|
// skal kunne kopieres ind i en genvej på en telefon.
|
||||||
|
func hookPath(url string) string {
|
||||||
|
return url[strings.Index(url, "/inbound/hook/"):]
|
||||||
|
}
|
||||||
|
|
||||||
|
// En linje ren tekst, skubbet ind udefra, bliver til en opgave i indbakken — og
|
||||||
|
// betyder det samme, som den ville betyde i feltet øverst i fladen.
|
||||||
|
func TestAPushFromAnotherAppLandsInTheInbox(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
path := hookPath(ts.hookURL(t))
|
||||||
|
|
||||||
|
anon := newSignedOut(t, ts)
|
||||||
|
resp, out := anon.doRaw(t, "POST", path, "text/plain",
|
||||||
|
"Ring til Anders p1\nhan ringede i går")
|
||||||
|
if resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatalf("skub: %d, %v", resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, list := ts.do(t, "GET", "/api/v1/tasks", nil)
|
||||||
|
tasks, _ := list["tasks"].([]any)
|
||||||
|
var found map[string]any
|
||||||
|
for _, raw := range tasks {
|
||||||
|
task := raw.(map[string]any)
|
||||||
|
if task["content"] == "Ring til Anders" {
|
||||||
|
found = task
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if found == nil {
|
||||||
|
t.Fatalf("opgaven kom ikke i indbakken: %v", tasks)
|
||||||
|
}
|
||||||
|
// Parseren er den samme som fladens: p1 er en prioritet og ikke en del af
|
||||||
|
// teksten, og resten af kroppen står under opgaven.
|
||||||
|
if found["priority"] != float64(1) {
|
||||||
|
t.Errorf("prioritet = %v, want 1", found["priority"])
|
||||||
|
}
|
||||||
|
if found["description"] != "han ringede i går" {
|
||||||
|
t.Errorf("beskrivelse = %v", found["description"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// JSON fra en tjeneste, med de feltnavne folk faktisk sender.
|
||||||
|
func TestTheHookReadsJSON(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
path := hookPath(ts.hookURL(t))
|
||||||
|
anon := newSignedOut(t, ts)
|
||||||
|
|
||||||
|
for _, body := range []string{
|
||||||
|
`{"text": "Køb mælk"}`,
|
||||||
|
`{"title": "Køb mælk"}`,
|
||||||
|
`{"content": "Køb mælk"}`,
|
||||||
|
} {
|
||||||
|
resp, out := anon.doRaw(t, "POST", path, "application/json", body)
|
||||||
|
if resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatalf("%s: %d, %v", body, resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
if out["content"] != "Køb mælk" {
|
||||||
|
t.Errorf("%s gav %v", body, out["content"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En krop, der siger JSON og ikke er det, læses ikke som tekst bagefter: en
|
||||||
|
// opgave, der hedder `{"txt": …}`, er en dårligere fejlmeddelelse end et 422.
|
||||||
|
resp, _ := anon.doRaw(t, "POST", path, "application/json", `{"txt": "skrevet forkert"}`)
|
||||||
|
if resp.StatusCode != http.StatusUnprocessableEntity {
|
||||||
|
t.Errorf("forkert JSON gav %d, want 422", resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Et token, der ikke findes, er det samme svar som et, der aldrig har eksisteret.
|
||||||
|
// Alt andet er en maskine til at gætte tokens med.
|
||||||
|
func TestAnUnknownHookTokenIsNotFound(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
anon := newSignedOut(t, ts)
|
||||||
|
|
||||||
|
resp, _ := anon.doRaw(t, "POST", "/inbound/hook/deteringentingogsaaslet", "text/plain", "hej")
|
||||||
|
if resp.StatusCode != http.StatusNotFound {
|
||||||
|
t.Fatalf("ukendt token gav %d, want 404", resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Den gamle URL holder op med at virke, når man skifter den. Det er den eneste vej
|
||||||
|
// tilbage: adressen står i en genvej på en telefon eller i et script.
|
||||||
|
func TestRotatingTheHookRetiresTheOldURL(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
old := hookPath(ts.hookURL(t))
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/hook-url/rotate", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("skift: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
fresh := hookPath(out["url"].(string))
|
||||||
|
if fresh == old {
|
||||||
|
t.Fatal("den nye URL er den gamle")
|
||||||
|
}
|
||||||
|
|
||||||
|
anon := newSignedOut(t, ts)
|
||||||
|
if resp, _ := anon.doRaw(t, "POST", old, "text/plain", "gammel"); resp.StatusCode != http.StatusNotFound {
|
||||||
|
t.Errorf("den gamle URL virker stadig: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if resp, _ := anon.doRaw(t, "POST", fresh, "text/plain", "ny"); resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Errorf("den nye URL virker ikke: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ingen tekst er ikke en opgave. En tom opgave i indbakken er værre end en fejl,
|
||||||
|
// fordi den ser ud som om integrationen virker.
|
||||||
|
func TestAnEmptyPushIsRefused(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
path := hookPath(ts.hookURL(t))
|
||||||
|
anon := newSignedOut(t, ts)
|
||||||
|
|
||||||
|
resp, _ := anon.doRaw(t, "POST", path, "text/plain", " \n ")
|
||||||
|
if resp.StatusCode != http.StatusUnprocessableEntity {
|
||||||
|
t.Fatalf("tom tekst gav %d, want 422", resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Et token kan én ting. Det ligger i et script på en anden maskine, og hvad der
|
||||||
|
// ellers kan nås med det, er hvad der er sluppet ud sammen med det.
|
||||||
|
func TestTheHookTokenIsNotAnAPIToken(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
url := ts.hookURL(t)
|
||||||
|
token := url[strings.LastIndex(url, "/")+1:]
|
||||||
|
|
||||||
|
anon := newSignedOut(t, ts)
|
||||||
|
req, err := http.NewRequest("GET", anon.URL+"/api/v1/tasks", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Authorization", "Bearer "+token)
|
||||||
|
resp, err := anon.client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode == http.StatusOK {
|
||||||
|
t.Fatal("krog-tokenet gav adgang til API'et")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,7 +2,9 @@ package httpapi
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"net/url"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -155,6 +157,191 @@ func (s *Server) handleInboundMail(w http.ResponseWriter, r *http.Request) {
|
|||||||
writeJSON(w, http.StatusCreated, map[string]string{"task_id": task.ID})
|
writeJSON(w, http.StatusCreated, map[string]string{"task_id": task.ID})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- en krog ind i indbakken --------------------------------------------------------
|
||||||
|
|
||||||
|
type hookURLResponse struct {
|
||||||
|
URL string `json:"url"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleGetHookURL returns the personal address another program can push a task
|
||||||
|
// to, minting the token on first ask.
|
||||||
|
//
|
||||||
|
// Der var to veje ind i forvejen, og ingen af dem passer til "gem den her, mens
|
||||||
|
// jeg står med telefonen i hånden". API-tokenet giver adgang til alt og skal have
|
||||||
|
// en JSON-krop skrevet rigtigt; mailadressen virker først, når nogen har sat en
|
||||||
|
// mailserver op. Det, der manglede, var en URL, man kan smide en linje tekst efter
|
||||||
|
// — fra en genvej på telefonen, et script, en anden tjeneste.
|
||||||
|
func (s *Server) handleGetHookURL(w http.ResponseWriter, r *http.Request) {
|
||||||
|
token, err := s.db.EnsureHookToken(r.Context(), userFrom(r.Context()).ID)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "hook token", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, hookURLResponse{URL: s.hookURL(token)})
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleRotateHookURL mints a new one and retires the old.
|
||||||
|
//
|
||||||
|
// Den eneste vej tilbage, når en URL er sluppet ud: den står i en genvej på en
|
||||||
|
// telefon eller i et script på en anden maskine, og der er ikke andet at trække
|
||||||
|
// tilbage end tokenet selv.
|
||||||
|
func (s *Server) handleRotateHookURL(w http.ResponseWriter, r *http.Request) {
|
||||||
|
token, err := auth.NewToken()
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "generate hook token", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := s.db.SetHookToken(r.Context(), userFrom(r.Context()).ID, token); err != nil {
|
||||||
|
s.internal(w, r, "set hook token", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, hookURLResponse{URL: s.hookURL(token)})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) hookURL(token string) string {
|
||||||
|
return strings.TrimSuffix(s.cfg.BaseURL, "/") + "/inbound/hook/" + token
|
||||||
|
}
|
||||||
|
|
||||||
|
type hookRequest struct {
|
||||||
|
// Text er linjen, der bliver til opgaven. `title` og `content` tages med som
|
||||||
|
// de samme, fordi det er dem, andre tjenester i forvejen kalder feltet — og en
|
||||||
|
// integration, der fejler på et feltnavn, fejler tavst hos den, der satte den
|
||||||
|
// op.
|
||||||
|
Text string `json:"text"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
Content string `json:"content"`
|
||||||
|
// Note er det, der står under opgaven. `body` og `description` ligeså.
|
||||||
|
Note string `json:"note"`
|
||||||
|
Body string `json:"body"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h hookRequest) line() string {
|
||||||
|
for _, v := range []string{h.Text, h.Title, h.Content} {
|
||||||
|
if strings.TrimSpace(v) != "" {
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h hookRequest) note() string {
|
||||||
|
for _, v := range []string{h.Note, h.Body, h.Description} {
|
||||||
|
if strings.TrimSpace(v) != "" {
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleInboundHook turns a POST from somewhere else into a task in the inbox.
|
||||||
|
//
|
||||||
|
// Tokenet i stien er hele legitimationen, som i kalenderfeedet og den indgående
|
||||||
|
// post: den, der kalder, er et script eller en genvej på en telefon, og hverken
|
||||||
|
// kan logge ind. Derfor kan et token herfra også kun én ting — lave en opgave i
|
||||||
|
// den ene persons indbakke — hvor et API-token kan alt.
|
||||||
|
//
|
||||||
|
// Kroppen læses på tre måder, fordi de tre er dem, man møder: JSON fra en
|
||||||
|
// tjeneste, et formularfelt fra en webhook-formular, og ren tekst fra en genvej,
|
||||||
|
// der bare sender det, man har markeret. Første linje bliver til opgaven, resten
|
||||||
|
// til noten under den — det er sådan, en tekst, man har delt, ser ud.
|
||||||
|
//
|
||||||
|
// Linjen læses med quick-add-parseren, så "Ring til Anders i morgen p1 #Firma"
|
||||||
|
// betyder det samme her som i feltet øverst i fladen. Det er hele pointen med at
|
||||||
|
// have én parser: den vej, teksten kom ind ad, ændrer ikke, hvad den betyder.
|
||||||
|
func (s *Server) handleInboundHook(w http.ResponseWriter, r *http.Request) {
|
||||||
|
user, err := s.db.UserByHookToken(r.Context(), chi.URLParam(r, "token"))
|
||||||
|
if err != nil {
|
||||||
|
// Samme svar som en adresse, der aldrig har eksisteret: et endpoint, der
|
||||||
|
// kender forskel, er en maskine til at gætte tokens med.
|
||||||
|
writeError(w, http.StatusNotFound, CodeNotFound, "no such address")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
line, note := s.readHookBody(r)
|
||||||
|
if strings.TrimSpace(line) == "" {
|
||||||
|
writeFieldErrors(w, map[string]string{"text": "required"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
parsed := quickadd.Parse(line, time.Now().In(userLocation(user.Timezone)), user.Locale)
|
||||||
|
content := parsed.Content
|
||||||
|
if strings.TrimSpace(content) == "" {
|
||||||
|
content = line
|
||||||
|
}
|
||||||
|
|
||||||
|
projectID := ""
|
||||||
|
if parsed.Project != "" {
|
||||||
|
if id, err := s.db.ProjectByName(r.Context(), user.ID, parsed.Project); err == nil {
|
||||||
|
projectID = id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if projectID == "" {
|
||||||
|
if projectID, err = s.db.InboxID(r.Context(), user.ID); err != nil {
|
||||||
|
s.internal(w, r, "inbox", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
task := &store.Task{
|
||||||
|
ProjectID: projectID, Content: content, Priority: parsed.Priority,
|
||||||
|
Description: strings.TrimSpace(note), DueDate: parsed.DueDate,
|
||||||
|
RecurrenceRule: parsed.Recurrence, CreatedBy: user.ID,
|
||||||
|
}
|
||||||
|
if err := s.db.CreateTask(r.Context(), task, parsed.Labels); err != nil {
|
||||||
|
s.internal(w, r, "create task from hook", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
s.publish(projectID, "task.created", toTaskJSON(*task))
|
||||||
|
s.log.Info("task created from hook", "user", user.ID)
|
||||||
|
writeJSON(w, http.StatusCreated, map[string]string{"task_id": task.ID, "content": task.Content})
|
||||||
|
}
|
||||||
|
|
||||||
|
// readHookBody er de tre måder, en linje tekst kommer ind ad.
|
||||||
|
//
|
||||||
|
// Rækkefølgen er efter, hvor sikkert man ved, hvad man har: en erklæret
|
||||||
|
// Content-Type tros, og ellers falder det tilbage på ren tekst — som er det, en
|
||||||
|
// genvej på en telefon sender, når den ikke er blevet bedt om andet.
|
||||||
|
//
|
||||||
|
// En krop, der siger JSON, men ikke er det, læses ikke som tekst bagefter. Den,
|
||||||
|
// der satte integrationen op, har skrevet noget forkert, og en opgave, der hedder
|
||||||
|
// `{"txt": "køb mælk"}`, er en dårligere måde at finde ud af det på end et 422.
|
||||||
|
func (s *Server) readHookBody(r *http.Request) (line, note string) {
|
||||||
|
const maxBody = 64 << 10
|
||||||
|
body, err := io.ReadAll(io.LimitReader(r.Body, maxBody))
|
||||||
|
if err != nil {
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
kind := r.Header.Get("Content-Type")
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case strings.Contains(kind, "application/json"):
|
||||||
|
var req hookRequest
|
||||||
|
if err := json.Unmarshal(body, &req); err != nil {
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
return req.line(), req.note()
|
||||||
|
|
||||||
|
case strings.Contains(kind, "application/x-www-form-urlencoded"):
|
||||||
|
values, err := url.ParseQuery(string(body))
|
||||||
|
if err != nil {
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
req := hookRequest{
|
||||||
|
Text: values.Get("text"), Title: values.Get("title"), Content: values.Get("content"),
|
||||||
|
Note: values.Get("note"), Body: values.Get("body"), Description: values.Get("description"),
|
||||||
|
}
|
||||||
|
return req.line(), req.note()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ren tekst: første linje er opgaven, resten står under den. Sådan ser en tekst,
|
||||||
|
// man har delt fra en anden app, ud — en overskrift og noget under.
|
||||||
|
text := strings.TrimSpace(string(body))
|
||||||
|
first, rest, _ := strings.Cut(text, "\n")
|
||||||
|
return first, strings.TrimSpace(rest)
|
||||||
|
}
|
||||||
|
|
||||||
// mailToken reads the token out of "Name <todo+TOKEN@domain>".
|
// mailToken reads the token out of "Name <todo+TOKEN@domain>".
|
||||||
func mailToken(address string) string {
|
func mailToken(address string) string {
|
||||||
if i := strings.LastIndex(address, "<"); i >= 0 {
|
if i := strings.LastIndex(address, "<"); i >= 0 {
|
||||||
|
|||||||
@@ -173,13 +173,22 @@ func (s *Server) SyncMailbox(ctx context.Context, user *store.User, m *store.Mai
|
|||||||
return 0, err
|
return 0, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Ét spørgsmål til modellen for hele gennemløbet, inden der bliver skrevet
|
||||||
|
// noget. Er der ingen model, er kortet tomt, og hver opgave hedder afsender og
|
||||||
|
// emne, som den altid har gjort.
|
||||||
|
forAI := make([]mailForAI, 0, len(messages))
|
||||||
|
for _, msg := range messages {
|
||||||
|
forAI = append(forAI, mailForAI{From: msg.From, Subject: msg.Subject, Snippet: msg.Snippet})
|
||||||
|
}
|
||||||
|
written := s.mailTaskLines(ctx, user, forAI)
|
||||||
|
|
||||||
created := 0
|
created := 0
|
||||||
highest := m.LastUID
|
highest := m.LastUID
|
||||||
// The uids of the mails that actually became tasks. Only those get unflagged,
|
// The uids of the mails that actually became tasks. Only those get unflagged,
|
||||||
// and only after the task is committed: a flag removed from a mail whose task
|
// and only after the task is committed: a flag removed from a mail whose task
|
||||||
// was never written is a mail nobody will ever see again.
|
// was never written is a mail nobody will ever see again.
|
||||||
done := make([]uint32, 0, len(messages))
|
done := make([]uint32, 0, len(messages))
|
||||||
for _, msg := range messages {
|
for i, msg := range messages {
|
||||||
if ctx.Err() != nil {
|
if ctx.Err() != nil {
|
||||||
// What was made so far is already committed and counted, and the marker
|
// What was made so far is already committed and counted, and the marker
|
||||||
// below has to be written for it: a run that created tasks and forgot how
|
// below has to be written for it: a run that created tasks and forgot how
|
||||||
@@ -206,6 +215,11 @@ func (s *Server) SyncMailbox(ctx context.Context, user *store.User, m *store.Mai
|
|||||||
// one server, and two accounts will hand out the same small numbers.
|
// one server, and two accounts will hand out the same small numbers.
|
||||||
SourceKey: fmt.Sprintf("imap:%s:%s:%d", m.Host, m.Folder, msg.UID),
|
SourceKey: fmt.Sprintf("imap:%s:%s:%d", m.Host, m.Folder, msg.UID),
|
||||||
}
|
}
|
||||||
|
// Og modellens linje, hvis den skrev en til netop den her. Emnet bliver
|
||||||
|
// stående i beskrivelsen: har den misforstået mailen, skal det oprindelige
|
||||||
|
// kunne læses ved siden af.
|
||||||
|
s.applyMailLine(ctx, user, task, written[i], content)
|
||||||
|
|
||||||
if err := s.db.CreateTask(ctx, task, nil); err != nil {
|
if err := s.db.CreateTask(ctx, task, nil); err != nil {
|
||||||
if errors.Is(err, store.ErrDuplicate) {
|
if errors.Is(err, store.ErrDuplicate) {
|
||||||
// Already a task. Still count it as read, or last_uid never moves
|
// Already a task. Still count it as read, or last_uid never moves
|
||||||
|
|||||||
@@ -527,7 +527,9 @@ func (s *Server) registerNoteTools(m *mcp.Server) {
|
|||||||
"is lost. Two things in the text are read out of it and become links: " +
|
"is lost. Two things in the text are read out of it and become links: " +
|
||||||
"`#Projekt` files the note against that project, so it appears on the " +
|
"`#Projekt` files the note against that project, so it appears on the " +
|
||||||
"project's page without anybody filing it there, and `[[Another note]]` " +
|
"project's page without anybody filing it there, and `[[Another note]]` " +
|
||||||
"links to a note by its title. Use this to bring notes in from elsewhere — " +
|
"links to a note by its title. A third, `@Navn`, shares the note with that " +
|
||||||
|
"person and tells them — so only write one when the note is meant for them. " +
|
||||||
|
"Use this to bring notes in from elsewhere — " +
|
||||||
"Apple Notes, OneNote, a folder of Markdown — one call per note.",
|
"Apple Notes, OneNote, a folder of Markdown — one call per note.",
|
||||||
InputSchema: mcp.Schema(map[string]any{
|
InputSchema: mcp.Schema(map[string]any{
|
||||||
"body": mcp.Str("The note as Markdown. Its first line becomes the title, so start with one. #Projekt and [[note]] become links."),
|
"body": mcp.Str("The note as Markdown. Its first line becomes the title, so start with one. #Projekt and [[note]] become links."),
|
||||||
|
|||||||
@@ -204,9 +204,152 @@ func (s *Server) handleCreateNote(w http.ResponseWriter, r *http.Request) {
|
|||||||
s.internal(w, r, "create note", err)
|
s.internal(w, r, "create note", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
// En ny note kan være den, en delt note hele tiden har peget på: linket er
|
||||||
|
// skrevet som en titel, og titlen fandtes ikke før nu.
|
||||||
|
//
|
||||||
|
// Kun når der står noget i den. En tom note har ingen titel, og et link peger på
|
||||||
|
// en titel — så der er intet at regne, og det kostede alligevel: udregningen
|
||||||
|
// åbner hver eneste af ejerens noter, og den lå her mellem "Ny note" og det
|
||||||
|
// svar, fladen venter på for at kunne tegne editoren. Halvfems millisekunder er
|
||||||
|
// nok til at nå at taste den første linje ind i den forrige note, som så blev
|
||||||
|
// tegnet væk. Målt i e2e-prøven for monospace, der begyndte at tabe sin titel.
|
||||||
|
if strings.TrimSpace(n.Body) != "" {
|
||||||
|
s.followLinks(r, n)
|
||||||
|
s.shareWithMentioned(r, n, "")
|
||||||
|
}
|
||||||
writeJSON(w, http.StatusCreated, n)
|
writeJSON(w, http.StatusCreated, n)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// followLinks holder de udledte delinger i takt med teksten.
|
||||||
|
//
|
||||||
|
// De noter, en delt note peger på, følger med — og teksten kan ændre sig, efter
|
||||||
|
// delingen er sat. Et link skrevet i dag i en note, der blev delt i går, skal føre
|
||||||
|
// samme sted hen for begge.
|
||||||
|
//
|
||||||
|
// Kun ejerens egne gemninger regner om, og det er ikke en optimering. Et link
|
||||||
|
// peger på en titel, og en medredaktør må skrive i teksten — så hvis enhver
|
||||||
|
// gemning talte med, kunne den, man har delt en note med, skrive
|
||||||
|
// `[[Bankoplysninger]]` ind i den og dermed dele den med sig selv.
|
||||||
|
//
|
||||||
|
// Det lukker ikke hullet helt, og det skal siges frem for at lyde lukket: skriver
|
||||||
|
// medredaktøren linket, og gemmer ejeren bagefter sin egen note, følger den note
|
||||||
|
// med dér. Det, der står tilbage mod det, er synlighed — linket står som tekst i
|
||||||
|
// ejerens egen note, og delingspanelet viser hver note, der er fulgt med, og hvem
|
||||||
|
// der har den. En stille eskalering er det ikke; en, man kan overse, er den.
|
||||||
|
//
|
||||||
|
// Fejler det, siges det i loggen og ikke til den, der gemte: noten *er* gemt, og
|
||||||
|
// et svar, der lyder som om den ikke er, ville få dem til at skrive den igen.
|
||||||
|
func (s *Server) followLinks(r *http.Request, n *store.Note) {
|
||||||
|
if n == nil || n.CreatedBy != userFrom(r.Context()).ID {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if _, err := s.db.SyncLinkedShares(r.Context(), n.CreatedBy); err != nil {
|
||||||
|
s.log.Error("sync linked shares", "err", err, "note", n.ID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// shareWithMentioned deler noten med dem, der er skrevet ind i den med et @.
|
||||||
|
//
|
||||||
|
// At nævne nogen i en note *er* at ville have dem til at læse den. Indtil nu var
|
||||||
|
// det to handlinger — skriv navnet, åbn panelet, find personen, del — og den
|
||||||
|
// anden blev glemt, så noten stod med en besked til en, der ikke kunne se den.
|
||||||
|
//
|
||||||
|
// Kun nye omtaler. Sammenlignet med teksten før gemningen på nøjagtig samme måde
|
||||||
|
// som links, fordi en note gemmes ved hver tastepause: uden sammenligningen ville
|
||||||
|
// hver eneste gemning være en ny deling og en ny besked om det samme navn.
|
||||||
|
//
|
||||||
|
// Kun ejerens omtaler deler. En medredaktør må skrive i noten, men ikke give den
|
||||||
|
// videre — ellers kunne den, ejeren har delt med, skrive et navn og dermed dele
|
||||||
|
// ejerens note med en, ejeren aldrig har hørt om. Det er den samme regel, panelet
|
||||||
|
// følger: kun ejeren deler. En medredaktørs omtale er derfor tekst, og den giver
|
||||||
|
// kun besked til en, der kan se noten i forvejen.
|
||||||
|
//
|
||||||
|
// Læser, ikke medredaktør. En omtale siger "se på det her", og det mindste, der
|
||||||
|
// opfylder sætningen, er det rigtige at give — resten kan ejeren hæve i panelet,
|
||||||
|
// og en rolle, der er hævet dér, sænkes ikke igen af en omtale.
|
||||||
|
// Returnerer dem, der fik besked om omtalen, så den samme gemning ikke også
|
||||||
|
// fortæller dem, at noten er blevet rettet.
|
||||||
|
func (s *Server) shareWithMentioned(r *http.Request, n *store.Note, before string) map[string]bool {
|
||||||
|
told := map[string]bool{}
|
||||||
|
if n == nil || n.CreatedBy == "" {
|
||||||
|
return told
|
||||||
|
}
|
||||||
|
// Slået op mod alle konti på instansen — det er dem, noten kan deles med, og
|
||||||
|
// derfor dem, et navn kan betyde. Ejeren selv er ikke iblandt: en note kan ikke
|
||||||
|
// deles med den, der har den.
|
||||||
|
people, err := s.db.UsersForSharing(r.Context(), n.CreatedBy)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("people for mentions", "err", err, "note", n.ID)
|
||||||
|
return told
|
||||||
|
}
|
||||||
|
|
||||||
|
was := map[string]bool{}
|
||||||
|
for _, id := range store.MentionsIn(before, people) {
|
||||||
|
was[id] = true
|
||||||
|
}
|
||||||
|
fresh := []string{}
|
||||||
|
for _, id := range store.MentionsIn(n.Body, people) {
|
||||||
|
if !was[id] {
|
||||||
|
fresh = append(fresh, id)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(fresh) == 0 {
|
||||||
|
return told
|
||||||
|
}
|
||||||
|
|
||||||
|
actor := userFrom(r.Context())
|
||||||
|
owner := actor.ID == n.CreatedBy
|
||||||
|
shared := false
|
||||||
|
for _, id := range fresh {
|
||||||
|
if !owner {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// En rolle, der allerede er sat, står. Omtalen skal give adgang til den, der
|
||||||
|
// ikke har nogen — ikke sætte en medredaktør ned til læser, fordi ejeren
|
||||||
|
// skrev deres navn i teksten.
|
||||||
|
if _, has, err := s.db.NoteShareRole(r.Context(), n.ID, id); err != nil {
|
||||||
|
s.log.Warn("mention share role", "err", err, "note", n.ID)
|
||||||
|
continue
|
||||||
|
} else if has {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err := s.db.ShareNote(r.Context(), n.ID, id, store.RoleViewer, actor.ID); err != nil {
|
||||||
|
s.log.Warn("share with mentioned", "err", err, "note", n.ID)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
shared = true
|
||||||
|
}
|
||||||
|
if shared {
|
||||||
|
// Og det, noten peger på, følger med delingen — samme vej som en deling
|
||||||
|
// sat i panelet.
|
||||||
|
s.followLinks(r, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Besked til dem, der kan se noten. Efter delingen, så den, omtalen lige har
|
||||||
|
// givet adgang, er med — og kun til dem, så en medredaktørs omtale af en
|
||||||
|
// fremmed ikke bliver en besked om en note, de ikke kan åbne.
|
||||||
|
audience, err := s.db.NoteAudience(r.Context(), n.ID)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("note audience for mention", "err", err, "note", n.ID)
|
||||||
|
return told
|
||||||
|
}
|
||||||
|
canSee := map[string]bool{}
|
||||||
|
for _, id := range audience {
|
||||||
|
canSee[id] = true
|
||||||
|
}
|
||||||
|
for _, id := range fresh {
|
||||||
|
if !canSee[id] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
s.notify(r, &store.Notification{
|
||||||
|
UserID: id, ActorID: actor.ID, ProjectID: n.ProjectID, NoteID: n.ID,
|
||||||
|
Kind: "note.mention", Title: actor.Name + " nævnte dig i en note", Body: n.Title,
|
||||||
|
})
|
||||||
|
told[id] = true
|
||||||
|
}
|
||||||
|
return told
|
||||||
|
}
|
||||||
|
|
||||||
func (s *Server) handleUpdateNote(w http.ResponseWriter, r *http.Request) {
|
func (s *Server) handleUpdateNote(w http.ResponseWriter, r *http.Request) {
|
||||||
var body noteBody
|
var body noteBody
|
||||||
if err := decodeJSON(w, r, &body); err != nil {
|
if err := decodeJSON(w, r, &body); err != nil {
|
||||||
@@ -242,6 +385,7 @@ func (s *Server) handleUpdateNote(w http.ResponseWriter, r *http.Request) {
|
|||||||
}
|
}
|
||||||
n.ProjectID = *body.ProjectID
|
n.ProjectID = *body.ProjectID
|
||||||
}
|
}
|
||||||
|
before := n.Body
|
||||||
if body.Body != nil {
|
if body.Body != nil {
|
||||||
n.Body = *body.Body
|
n.Body = *body.Body
|
||||||
}
|
}
|
||||||
@@ -249,13 +393,51 @@ func (s *Server) handleUpdateNote(w http.ResponseWriter, r *http.Request) {
|
|||||||
n.Pinned = *body.Pinned
|
n.Pinned = *body.Pinned
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Læst før gemningen, sammenlignet efter. En gemning er en tastepause, ikke en
|
||||||
|
// begivenhed, så de fleste af dem ændrer intet af det her — og udregningen
|
||||||
|
// åbner hver eneste af ejerens noter, fordi titlerne er forseglet. Den skal
|
||||||
|
// køre, når svaret kan være blevet et andet, og ellers ikke.
|
||||||
|
wasLinking := store.LinksIn(before)
|
||||||
|
wasTitled := n.Title
|
||||||
|
|
||||||
if err := s.db.SaveNote(r.Context(), n); err != nil {
|
if err := s.db.SaveNote(r.Context(), n); err != nil {
|
||||||
s.internal(w, r, "update note", err)
|
s.internal(w, r, "update note", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
// Titlen tæller med: den *er* første linje, så en omskrevet overskrift flytter
|
||||||
|
// det, andres links peger på, uden at et eneste link er rørt.
|
||||||
|
if n.Title != wasTitled || !sameLinks(wasLinking, store.LinksIn(n.Body)) {
|
||||||
|
s.followLinks(r, n)
|
||||||
|
}
|
||||||
|
// Kun når teksten har flyttet sig. En note, der bliver stjernemarkeret eller
|
||||||
|
// lagt i et projekt, er ikke en note, nogen har skrevet i — og en besked om
|
||||||
|
// det ville lære folk at overse dem alle sammen.
|
||||||
|
if before != n.Body {
|
||||||
|
// Omtalerne først. Den, der lige er blevet nævnt, skal have "nævnte dig" og
|
||||||
|
// ikke også "rettede en note" om den samme gemning — det er én handling, og
|
||||||
|
// den ene sætning siger mere end den anden.
|
||||||
|
mentioned := s.shareWithMentioned(r, n, before)
|
||||||
|
s.notifyNoteChanged(r, n, mentioned)
|
||||||
|
}
|
||||||
writeJSON(w, http.StatusOK, n)
|
writeJSON(w, http.StatusOK, n)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func sameLinks(a, b []store.NoteLink) bool {
|
||||||
|
if len(a) != len(b) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
in := make(map[store.NoteLink]bool, len(a))
|
||||||
|
for _, l := range a {
|
||||||
|
in[l] = true
|
||||||
|
}
|
||||||
|
for _, l := range b {
|
||||||
|
if !in[l] {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
func (s *Server) handleDeleteNote(w http.ResponseWriter, r *http.Request) {
|
func (s *Server) handleDeleteNote(w http.ResponseWriter, r *http.Request) {
|
||||||
n, err := s.db.Note(r.Context(), chi.URLParam(r, "noteID"))
|
n, err := s.db.Note(r.Context(), chi.URLParam(r, "noteID"))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -279,6 +461,9 @@ func (s *Server) handleDeleteNote(w http.ResponseWriter, r *http.Request) {
|
|||||||
s.internal(w, r, "delete note", err)
|
s.internal(w, r, "delete note", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
// En note i papirkurven er ikke længere et udgangspunkt for noget. Det, den tog
|
||||||
|
// med sig, skal derfor heller ikke blive stående hos dem, den blev delt med.
|
||||||
|
s.followLinks(r, n)
|
||||||
w.WriteHeader(http.StatusNoContent)
|
w.WriteHeader(http.StatusNoContent)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,186 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Hele vejen: ejeren deler en note med en adresse, der ikke har nogen konto, og
|
||||||
|
// den, der tager imod invitationen, har noten fra det øjeblik, kontoen findes.
|
||||||
|
func TestANoteCanBeSharedWithSomebodyWhoHasNoAccount(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
noteID := owner.createNote(t, "# Aftale om levering\nfredag kl. 9")
|
||||||
|
|
||||||
|
resp, body := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"email": "sofie@example.dk", "role": "editor"})
|
||||||
|
if resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatalf("invite by email: status %d, body %v", resp.StatusCode, body)
|
||||||
|
}
|
||||||
|
invited, _ := body["invited"].(map[string]any)
|
||||||
|
if invited == nil || invited["email"] != "sofie@example.dk" {
|
||||||
|
t.Fatalf("the response does not say who was invited: %v", body)
|
||||||
|
}
|
||||||
|
if invited["role"] != "editor" {
|
||||||
|
t.Errorf("role = %v, want the one the owner chose", invited["role"])
|
||||||
|
}
|
||||||
|
// Uden en postserver er linket det eneste, der findes, og det skal stå i
|
||||||
|
// svaret frem for at blive lovet i en mail, der ikke kom af sted.
|
||||||
|
if body["emailed"] != false {
|
||||||
|
t.Errorf("emailed = %v, want false with no mail server configured", body["emailed"])
|
||||||
|
}
|
||||||
|
link, _ := body["link"].(string)
|
||||||
|
if !strings.Contains(link, "token=") {
|
||||||
|
t.Fatalf("link = %q, want one carrying a token", link)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Den venter i panelet under noten, så ejeren kan se, at den er sendt.
|
||||||
|
_, panel := owner.do(t, "GET", "/api/v1/notes/"+noteID+"/shares", nil)
|
||||||
|
pending, _ := panel["invites"].([]any)
|
||||||
|
if len(pending) != 1 {
|
||||||
|
t.Fatalf("want one pending invite under the note, got %v", pending)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Og linket laver kontoen og delingen i ét.
|
||||||
|
token := link[strings.Index(link, "token=")+len("token="):]
|
||||||
|
fresh := newSignedOut(t, owner)
|
||||||
|
resp, _ = fresh.do(t, "POST", "/api/v1/auth/signup", map[string]any{
|
||||||
|
"token": token, "name": "Sofie", "password": "et langt kodeord",
|
||||||
|
})
|
||||||
|
if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatalf("signup with the note invite: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Noten er hendes at læse — og som medredaktør også at rette.
|
||||||
|
resp, note := fresh.do(t, "GET", "/api/v1/notes/"+noteID, nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("the invited person cannot read the note: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if note["title"] != "Aftale om levering" {
|
||||||
|
t.Errorf("the invited person got something else: %v", note)
|
||||||
|
}
|
||||||
|
resp, _ = fresh.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]string{"body": "# Aftale om levering\nfredag kl. 10"})
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("an invited editor cannot write: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Og invitationen er brugt op: den står ikke længere og venter.
|
||||||
|
_, after := owner.do(t, "GET", "/api/v1/notes/"+noteID+"/shares", nil)
|
||||||
|
if left, _ := after["invites"].([]any); len(left) != 0 {
|
||||||
|
t.Errorf("the invite is still pending after it was accepted: %v", left)
|
||||||
|
}
|
||||||
|
shares, _ := after["shares"].([]any)
|
||||||
|
if len(shares) != 1 {
|
||||||
|
t.Fatalf("want the accepted invite to be a share, got %v", shares)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En adresse, der viser sig at høre til en konto, er den konto — ikke en
|
||||||
|
// invitation til at oprette en, som personen aldrig kan komme igennem.
|
||||||
|
func TestSharingByEmailFindsAnExistingAccount(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
sofie := userID(t, owner, "sofie@example.dk")
|
||||||
|
noteID := owner.createNote(t, "# Prisliste\n2026")
|
||||||
|
|
||||||
|
resp, body := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"email": "Sofie@Example.dk"})
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("share with an existing address: status %d, body %v", resp.StatusCode, body)
|
||||||
|
}
|
||||||
|
person, _ := body["user"].(map[string]any)
|
||||||
|
if person == nil || person["id"] != sofie {
|
||||||
|
t.Fatalf("the response does not say who it reached: %v", body)
|
||||||
|
}
|
||||||
|
if _, invited := body["invited"]; invited {
|
||||||
|
t.Error("an address with an account was invited rather than shared with")
|
||||||
|
}
|
||||||
|
|
||||||
|
role, _, err := owner.db.NoteShareRole(t.Context(), noteID, sofie)
|
||||||
|
if err != nil || role != "viewer" {
|
||||||
|
t.Fatalf("share role = %v (%v), want viewer by default", role, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// To links til den samme indbakke er ikke en invitation mere: det er to, der gør
|
||||||
|
// det samme, og kun det ene kan trækkes tilbage ad gangen.
|
||||||
|
func TestASecondInviteToTheSameNoteIsRefused(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
noteID := owner.createNote(t, "# Bankoplysninger\nkonto")
|
||||||
|
|
||||||
|
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"email": "ny@example.dk"}); resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatalf("first invite: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"email": "ny@example.dk"})
|
||||||
|
if resp.StatusCode != http.StatusConflict {
|
||||||
|
t.Fatalf("second invite: status %d, want 409", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Trukket tilbage kan den derimod, og så kan der sendes en ny.
|
||||||
|
_, panel := owner.do(t, "GET", "/api/v1/notes/"+noteID+"/shares", nil)
|
||||||
|
pending, _ := panel["invites"].([]any)
|
||||||
|
id := pending[0].(map[string]any)["id"].(string)
|
||||||
|
if resp, _ := owner.do(t, "DELETE", "/api/v1/notes/"+noteID+"/invites/"+id, nil); resp.StatusCode != http.StatusNoContent {
|
||||||
|
t.Fatalf("withdraw: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"email": "ny@example.dk"}); resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatalf("invite again after withdrawing: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Kun ejeren. En medlæser, der kunne invitere, ville kunne give noten videre til
|
||||||
|
// nogen, ejeren aldrig har hørt om — og til en konto, der ikke fandtes før.
|
||||||
|
func TestOnlyTheOwnerCanInviteToANote(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
other := owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
sofie := userID(t, owner, "sofie@example.dk")
|
||||||
|
noteID := owner.createNote(t, "# Ferieplan\nuge 29")
|
||||||
|
|
||||||
|
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"user_id": sofie, "role": "editor"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("share: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, _ := other.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"email": "fremmed@example.dk"})
|
||||||
|
if resp.StatusCode != http.StatusNotFound {
|
||||||
|
t.Fatalf("an editor could invite somebody: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if n, err := owner.db.ListNoteInvites(t.Context(), noteID); err != nil || len(n) != 0 {
|
||||||
|
t.Fatalf("invites = %v (%v), want none", n, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En invitation til én note kan ikke bruges til at rydde en anden notes
|
||||||
|
// invitationer af vejen: note-id'et er en del af WHERE, ikke et tjek udenom.
|
||||||
|
func TestANoteInviteCannotBeWithdrawnThroughAnotherNote(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
mine := owner.createNote(t, "# Min note\n1")
|
||||||
|
other := owner.createNote(t, "# Min anden note\n2")
|
||||||
|
|
||||||
|
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+mine+"/shares",
|
||||||
|
map[string]string{"email": "ny@example.dk"}); resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatal("invite failed")
|
||||||
|
}
|
||||||
|
invites, err := owner.db.ListNoteInvites(t.Context(), mine)
|
||||||
|
if err != nil || len(invites) != 1 {
|
||||||
|
t.Fatalf("invites = %v (%v)", invites, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, _ := owner.do(t, "DELETE", "/api/v1/notes/"+other+"/invites/"+invites[0].ID, nil)
|
||||||
|
if resp.StatusCode != http.StatusNotFound {
|
||||||
|
t.Fatalf("status %d, want 404 for another note's invite", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if left, _ := owner.db.ListNoteInvites(t.Context(), mine); len(left) != 1 {
|
||||||
|
t.Error("the invite was withdrawn through a note it does not belong to")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,132 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// At nævne nogen i en note er at ville have dem til at læse den: omtalen deler
|
||||||
|
// noten, og den, der bliver nævnt, får besked om det.
|
||||||
|
func TestMentioningSomebodySharesTheNote(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
other := owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
sofie := userID(t, owner, "sofie@example.dk")
|
||||||
|
|
||||||
|
noteID := owner.createNote(t, "# Aftale om levering\nikke noget endnu")
|
||||||
|
if resp, _ := other.do(t, "GET", "/api/v1/notes/"+noteID, nil); resp.StatusCode != http.StatusNotFound {
|
||||||
|
t.Fatalf("noten var læselig før omtalen: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Aftale om levering\n@Sofie kan du kigge på det?"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("ret noten: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delt, som læser.
|
||||||
|
role, has, err := owner.db.NoteShareRole(t.Context(), noteID, sofie)
|
||||||
|
if err != nil || !has || role != "viewer" {
|
||||||
|
t.Fatalf("deling = %v (findes: %v, fejl: %v), want viewer", role, has, err)
|
||||||
|
}
|
||||||
|
if resp, _ := other.do(t, "GET", "/api/v1/notes/"+noteID, nil); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("den omtalte kan ikke læse noten: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Og sagt til — med omtalen som beskeden, ikke "rettede en note". Det er én
|
||||||
|
// handling, og den ene sætning siger mere end den anden.
|
||||||
|
list, unread := notifications(t, other)
|
||||||
|
if len(list) != 1 || unread != 1 {
|
||||||
|
t.Fatalf("Sofie fik %d beskeder (%v ulæste), want 1", len(list), unread)
|
||||||
|
}
|
||||||
|
if n := firstOf(t, list); n["kind"] != "note.mention" || n["note_id"] != noteID {
|
||||||
|
t.Errorf("besked = %v", n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En gemning mere med det samme navn i er ikke en omtale mere. En note gemmes ved
|
||||||
|
// hver tastepause, så uden det bliver fem minutters skriveri til tyve beskeder.
|
||||||
|
func TestTheSameMentionOnlyCountsOnce(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
other := owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
|
||||||
|
noteID := owner.createNote(t, "# Aftale\n@Sofie kigger")
|
||||||
|
// Omtalen stod i noten fra begyndelsen: den tæller ved oprettelsen.
|
||||||
|
if list, _ := notifications(t, other); len(list) != 1 {
|
||||||
|
t.Fatalf("en omtale i en ny note gav %d beskeder, want 1", len(list))
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < 3; i++ {
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Aftale\n@Sofie kigger på linje " + string(rune('a'+i))}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("ret noten")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Tre gemninger mere: én besked om rettelserne, slået sammen, og ikke tre
|
||||||
|
// omtaler mere.
|
||||||
|
list, _ := notifications(t, other)
|
||||||
|
if len(list) != 2 {
|
||||||
|
t.Fatalf("tre gemninger med det samme navn gav %d beskeder, want 2", len(list))
|
||||||
|
}
|
||||||
|
if firstOf(t, list)["kind"] != "note.changed" {
|
||||||
|
t.Errorf("den nyeste besked = %v, want note.changed", firstOf(t, list))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En medredaktør må skrive i noten, men ikke give den videre. Ellers kunne den,
|
||||||
|
// ejeren har delt med, skrive et navn og dele ejerens note med en fremmed.
|
||||||
|
func TestAnEditorsMentionDoesNotShareTheNote(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
editor := owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
sofie := userID(t, owner, "sofie@example.dk")
|
||||||
|
peterClient := owner.newUser(t, "peter@example.dk", "Peter")
|
||||||
|
peter := userID(t, owner, "peter@example.dk")
|
||||||
|
|
||||||
|
noteID := owner.createNote(t, "# Aftale\nintet")
|
||||||
|
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"user_id": sofie, "role": "editor"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("del noten")
|
||||||
|
}
|
||||||
|
|
||||||
|
if resp, _ := editor.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Aftale\n@Peter ved det"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("medredaktøren retter")
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, has, err := owner.db.NoteShareRole(t.Context(), noteID, peter); err != nil || has {
|
||||||
|
t.Errorf("en medredaktørs omtale delte ejerens note (findes: %v, fejl: %v)", has, err)
|
||||||
|
}
|
||||||
|
// Og Peter får ikke besked om en note, han ikke kan åbne.
|
||||||
|
if list, _ := notifications(t, peterClient); len(list) != 0 {
|
||||||
|
t.Errorf("Peter fik %d beskeder om en note, han ikke kan se", len(list))
|
||||||
|
}
|
||||||
|
// Ejeren hører derimod, at der er skrevet i noten — det er stadig en rettelse.
|
||||||
|
if list, _ := notifications(t, owner); len(list) == 0 {
|
||||||
|
t.Error("ejeren hørte ikke, at medredaktøren skrev i noten")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rollen står. En omtale skal give adgang til den, der ikke har nogen — ikke
|
||||||
|
// sætte en medredaktør ned til læser, fordi ejeren skrev deres navn.
|
||||||
|
func TestAMentionDoesNotLowerAnExistingRole(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
sofie := userID(t, owner, "sofie@example.dk")
|
||||||
|
|
||||||
|
noteID := owner.createNote(t, "# Aftale\nintet")
|
||||||
|
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"user_id": sofie, "role": "editor"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("del noten")
|
||||||
|
}
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Aftale\n@Sofie retter selv"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("ret noten")
|
||||||
|
}
|
||||||
|
|
||||||
|
role, _, err := owner.db.NoteShareRole(t.Context(), noteID, sofie)
|
||||||
|
if err != nil || role != "editor" {
|
||||||
|
t.Errorf("rolle = %v (%v), want editor uændret", role, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,6 +2,7 @@ package httpapi
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"github.com/go-chi/chi/v5"
|
"github.com/go-chi/chi/v5"
|
||||||
|
|
||||||
@@ -77,12 +78,37 @@ func (s *Server) handleListNoteShares(w http.ResponseWriter, r *http.Request) {
|
|||||||
s.internal(w, r, "list note shares", err)
|
s.internal(w, r, "list note shares", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
// Regnet forfra, én gang, og læst to veje ud af det samme svar: hvem der har
|
||||||
|
// *denne* note, fordi en anden peger på den, og hvilke noter der omvendt følger
|
||||||
|
// med den her. To udregninger af det samme er to, der kan blive uenige.
|
||||||
|
//
|
||||||
|
// Og forfra frem for læst af basen, så panelet viser det, der gælder nu — også
|
||||||
|
// når linkene er skrevet af en anden og delingerne derfor ikke er regnet om
|
||||||
|
// siden.
|
||||||
|
following, err := s.db.SyncLinkedShares(r.Context(), userFrom(r.Context()).ID)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "sync linked shares", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
via := map[string]string{}
|
||||||
|
for _, l := range following {
|
||||||
|
if l.NoteID == n.ID {
|
||||||
|
via[l.UserID] = l.Via
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
out := make([]noteShareJSON, 0, len(shares))
|
out := make([]noteShareJSON, 0, len(shares))
|
||||||
already := map[string]bool{}
|
already := map[string]bool{}
|
||||||
for _, sh := range shares {
|
for _, sh := range shares {
|
||||||
|
// Panelet skal kunne sige forskel: en deling, nogen har valgt, tages tilbage
|
||||||
|
// ved at fjerne den — en, der er fulgt med, ved at fjerne linket eller den
|
||||||
|
// deling, den kom fra. En knap, der lover det første og gør det andet, er
|
||||||
|
// værre end ingen knap.
|
||||||
out = append(out, noteShareJSON{
|
out = append(out, noteShareJSON{
|
||||||
User: personJSON{ID: sh.User.ID, Name: sh.User.Name, AvatarColor: sh.User.AvatarColor},
|
User: personJSON{ID: sh.User.ID, Name: sh.User.Name, AvatarColor: sh.User.AvatarColor},
|
||||||
Role: string(sh.Role),
|
Role: string(sh.Role),
|
||||||
|
Linked: via[sh.User.ID] != "",
|
||||||
|
Via: via[sh.User.ID],
|
||||||
})
|
})
|
||||||
already[sh.User.ID] = true
|
already[sh.User.ID] = true
|
||||||
}
|
}
|
||||||
@@ -103,20 +129,86 @@ func (s *Server) handleListNoteShares(w http.ResponseWriter, r *http.Request) {
|
|||||||
cand = append(cand, personJSON{ID: p.ID, Name: p.Name, AvatarColor: p.AvatarColor})
|
cand = append(cand, personJSON{ID: p.ID, Name: p.Name, AvatarColor: p.AvatarColor})
|
||||||
}
|
}
|
||||||
|
|
||||||
writeJSON(w, http.StatusOK, map[string]any{"shares": out, "candidates": cand})
|
// De inviterede står ved siden af dem, der er kommet. Uden dem er en
|
||||||
|
// invitation sendt i går usynlig, og så sender man den igen — endnu et link til
|
||||||
|
// den samme indbakke, og ingen af dem til at trække tilbage.
|
||||||
|
invites, err := s.db.ListNoteInvites(r.Context(), n.ID)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "list note invites", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
pending := make([]noteInviteJSON, 0, len(invites))
|
||||||
|
for _, i := range invites {
|
||||||
|
pending = append(pending, noteInviteJSON{ID: i.ID, Email: i.Email, Role: string(i.Role)})
|
||||||
|
}
|
||||||
|
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{
|
||||||
|
"shares": out,
|
||||||
|
"candidates": cand,
|
||||||
|
"invites": pending,
|
||||||
|
"follows": followsOf(following, n.ID),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// followsOf er de noter, der følger med *denne* note — én linje pr. note, ikke én
|
||||||
|
// pr. note og person. Panelet spørger på vegne af noten, og svaret "Prisliste
|
||||||
|
// følger med" er det samme, hvem det så end deles med.
|
||||||
|
func followsOf(all []store.LinkedShare, noteID string) []followJSON {
|
||||||
|
seen := map[string]bool{}
|
||||||
|
out := []followJSON{}
|
||||||
|
for _, l := range all {
|
||||||
|
if l.ViaID != noteID || seen[l.NoteID] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
seen[l.NoteID] = true
|
||||||
|
out = append(out, followJSON{NoteID: l.NoteID, Title: l.Title})
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
type followJSON struct {
|
||||||
|
NoteID string `json:"note_id"`
|
||||||
|
Title string `json:"title"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type noteShareJSON struct {
|
type noteShareJSON struct {
|
||||||
User personJSON `json:"user"`
|
User personJSON `json:"user"`
|
||||||
Role string `json:"role"`
|
Role string `json:"role"`
|
||||||
|
// Sat, når personen har noten, fordi en anden delt note peger på den — ikke
|
||||||
|
// fordi nogen har delt netop den. `via` er den note, der peger.
|
||||||
|
Linked bool `json:"linked"`
|
||||||
|
Via string `json:"via,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type shareNoteRequest struct {
|
type shareNoteRequest struct {
|
||||||
UserID string `json:"user_id"`
|
UserID string `json:"user_id"`
|
||||||
Role string `json:"role"`
|
// Email deles der med, når personen ikke er at finde i listen — enten fordi
|
||||||
|
// man kender adressen bedre end navnet, eller fordi der ikke er nogen konto at
|
||||||
|
// finde endnu.
|
||||||
|
Email string `json:"email"`
|
||||||
|
Role string `json:"role"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// noteInviteJSON er en deling, der venter på en konto. Der er ikke noget navn og
|
||||||
|
// ingen farve at vise: adressen er alt, hvad der findes om personen indtil de
|
||||||
|
// dukker op.
|
||||||
|
type noteInviteJSON struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Email string `json:"email"`
|
||||||
|
Role string `json:"role"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// handleShareNote grants a person a role on a note, or changes the role they hold.
|
// handleShareNote grants a person a role on a note, or changes the role they hold.
|
||||||
|
//
|
||||||
|
// Der er to måder at sige, hvem det er. `user_id` er den, man har peget på i
|
||||||
|
// listen. `email` er den, man kender adressen på — og det er den, der også virker,
|
||||||
|
// når personen ikke har nogen konto: så bliver delingen til en invitation, der
|
||||||
|
// venter, og bliver til en rigtig deling i det øjeblik, kontoen bliver oprettet.
|
||||||
|
//
|
||||||
|
// Det er ikke en ny magt til nogen. Enhver, der ejer et projekt, kunne i forvejen
|
||||||
|
// invitere en fremmed ind på instansen pr. e-mail; det her er den samme handling
|
||||||
|
// på en note, der ellers krævede tre skridt og en ventetid: invitér til instansen,
|
||||||
|
// vent på at de opretter sig, find noten frem, del den.
|
||||||
func (s *Server) handleShareNote(w http.ResponseWriter, r *http.Request) {
|
func (s *Server) handleShareNote(w http.ResponseWriter, r *http.Request) {
|
||||||
var req shareNoteRequest
|
var req shareNoteRequest
|
||||||
if err := decodeJSON(w, r, &req); err != nil {
|
if err := decodeJSON(w, r, &req); err != nil {
|
||||||
@@ -140,25 +232,133 @@ func (s *Server) handleShareNote(w http.ResponseWriter, r *http.Request) {
|
|||||||
writeFieldErrors(w, map[string]string{"role": "must be viewer or editor"})
|
writeFieldErrors(w, map[string]string{"role": "must be viewer or editor"})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if req.UserID == "" {
|
|
||||||
|
me := userFrom(r.Context())
|
||||||
|
email := store.NormalizeEmail(req.Email)
|
||||||
|
|
||||||
|
if req.UserID == "" && email == "" {
|
||||||
writeFieldErrors(w, map[string]string{"user_id": "required"})
|
writeFieldErrors(w, map[string]string{"user_id": "required"})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// En adresse, der viser sig at høre til en konto, er den konto. At sende dem
|
||||||
|
// gennem en oprettelsesside, de ikke kan komme igennem, ville være en blindgyde
|
||||||
|
// — samme regel som en projektinvitation følger.
|
||||||
|
if req.UserID == "" {
|
||||||
|
if !strings.Contains(email, "@") {
|
||||||
|
writeFieldErrors(w, map[string]string{"email": "must be an email address"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if email == store.NormalizeEmail(me.Email) {
|
||||||
|
writeFieldErrors(w, map[string]string{"email": "you already have this note"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
existing, err := s.db.UserByEmail(r.Context(), email)
|
||||||
|
if err != nil {
|
||||||
|
s.inviteToNote(w, r, n, email, role)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
req.UserID = existing.ID
|
||||||
|
}
|
||||||
|
|
||||||
// The recipient must be a real account and not the sharer themselves; ShareNote
|
// The recipient must be a real account and not the sharer themselves; ShareNote
|
||||||
// refuses the owner, and a made-up id should not reach it.
|
// refuses the owner, and a made-up id should not reach it.
|
||||||
if req.UserID == userFrom(r.Context()).ID {
|
if req.UserID == me.ID {
|
||||||
writeFieldErrors(w, map[string]string{"user_id": "you already have this note"})
|
writeFieldErrors(w, map[string]string{"user_id": "you already have this note"})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if _, err := s.db.PersonByID(r.Context(), req.UserID); err != nil {
|
person, err := s.db.PersonByID(r.Context(), req.UserID)
|
||||||
|
if err != nil {
|
||||||
writeError(w, http.StatusNotFound, CodeNotFound, "no such person")
|
writeError(w, http.StatusNotFound, CodeNotFound, "no such person")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := s.db.ShareNote(r.Context(), n.ID, req.UserID, role, userFrom(r.Context()).ID); err != nil {
|
if err := s.db.ShareNote(r.Context(), n.ID, req.UserID, role, me.ID); err != nil {
|
||||||
s.storeError(w, r, "share note", err)
|
s.storeError(w, r, "share note", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
s.notifyNoteShared(r, n, req.UserID)
|
||||||
|
|
||||||
|
// Og det, noten peger på, følger med. Svaret siger hvad — en deling, der stille
|
||||||
|
// tog tre noter mere med, ville være rigtig og alligevel ikke til at overskue.
|
||||||
|
followed, err := s.db.SyncLinkedShares(r.Context(), me.ID)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "sync linked shares", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{
|
||||||
|
"follows": followsOf(followed, n.ID),
|
||||||
|
// Personen sendes med retur, fordi fladen kan have delt med en adresse og
|
||||||
|
// derfor ikke selv ved, hvem den ramte.
|
||||||
|
"user": personJSON{ID: person.ID, Name: person.Name, AvatarColor: person.AvatarColor},
|
||||||
|
"role": string(role),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// inviteToNote sends a link that creates an account and the share at once.
|
||||||
|
//
|
||||||
|
// Linket vises i svaret, når der ikke er nogen post at sende det med. En
|
||||||
|
// invitation, der forsvandt, fordi instansen ikke har en SMTP-server, ville se ud
|
||||||
|
// som om den var sendt — og først blive opdaget som ikke-sendt af den, der ventede
|
||||||
|
// på den.
|
||||||
|
func (s *Server) inviteToNote(w http.ResponseWriter, r *http.Request, n *store.Note, email string, role store.Role) {
|
||||||
|
me := userFrom(r.Context())
|
||||||
|
|
||||||
|
// En anden invitation til den samme note i den samme indbakke er ikke en
|
||||||
|
// invitation mere: det er to links, der gør det samme, og kun det ene kan
|
||||||
|
// trækkes tilbage ad gangen.
|
||||||
|
pending, err := s.db.PendingNoteInvite(r.Context(), n.ID, email)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "pending note invite", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if pending {
|
||||||
|
writeError(w, http.StatusConflict, CodeConflict, "that address has already been invited to this note")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
token, inv, err := s.db.CreateNoteInvite(r.Context(), email, n.ID, role, me.ID, s.cfg.InviteTTL)
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "create note invite", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
link := s.cfg.BaseURL + "/invite?token=" + token
|
||||||
|
|
||||||
|
emailed := false
|
||||||
|
if s.mail.Configured() {
|
||||||
|
if err := s.mail.SendNoteInvite(r.Context(), email, me.Name, n.Title, link, s.cfg.InviteTTL); err != nil {
|
||||||
|
s.log.Error("send note invite", "err", err, "to", email)
|
||||||
|
} else {
|
||||||
|
emailed = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
writeJSON(w, http.StatusCreated, map[string]any{
|
||||||
|
"invited": noteInviteJSON{ID: inv.ID, Email: inv.Email, Role: string(inv.Role)},
|
||||||
|
"link": link,
|
||||||
|
"emailed": emailed,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleDeleteNoteInvite withdraws an invitation before it is used.
|
||||||
|
//
|
||||||
|
// Det er den eneste vej tilbage. Kun aftrykket af tokenet er gemt, så et link, der
|
||||||
|
// er sendt til den forkerte adresse, kan ikke findes frem og gøres ugyldigt — det
|
||||||
|
// kan kun rækken, det hører til.
|
||||||
|
func (s *Server) handleDeleteNoteInvite(w http.ResponseWriter, r *http.Request) {
|
||||||
|
n, err := s.db.Note(r.Context(), chi.URLParam(r, "noteID"))
|
||||||
|
if err != nil {
|
||||||
|
s.internal(w, r, "get note", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if n == nil || !s.ownsNote(r, n) {
|
||||||
|
writeError(w, http.StatusNotFound, CodeNotFound, "no such note")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := s.db.DeleteNoteInvite(r.Context(), n.ID, chi.URLParam(r, "inviteID")); err != nil {
|
||||||
|
s.storeError(w, r, "delete note invite", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
w.WriteHeader(http.StatusNoContent)
|
w.WriteHeader(http.StatusNoContent)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -177,5 +377,12 @@ func (s *Server) handleUnshareNote(w http.ResponseWriter, r *http.Request) {
|
|||||||
s.internal(w, r, "unshare note", err)
|
s.internal(w, r, "unshare note", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
// Det, der fulgte med, følger også med tilbage. Regnet forfra: de udledte rækker
|
||||||
|
// skrives om fra bunden, så en note, der stadig kan nås fra en anden deling,
|
||||||
|
// bliver stående, og en, der ikke kan, forsvinder.
|
||||||
|
if _, err := s.db.SyncLinkedShares(r.Context(), userFrom(r.Context()).ID); err != nil {
|
||||||
|
s.internal(w, r, "sync linked shares", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
w.WriteHeader(http.StatusNoContent)
|
w.WriteHeader(http.StatusNoContent)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ func TestSharedNoteReachesTheOtherPerson(t *testing.T) {
|
|||||||
// Share it as a viewer.
|
// Share it as a viewer.
|
||||||
resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
map[string]string{"user_id": sofie, "role": "viewer"})
|
map[string]string{"user_id": sofie, "role": "viewer"})
|
||||||
if resp.StatusCode != http.StatusNoContent {
|
if resp.StatusCode != http.StatusOK {
|
||||||
t.Fatalf("share: status %d", resp.StatusCode)
|
t.Fatalf("share: status %d", resp.StatusCode)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ func TestSharedEditorCanWriteButNotGiveAway(t *testing.T) {
|
|||||||
|
|
||||||
noteID := owner.createNote(t, "# Delt\noprindelig")
|
noteID := owner.createNote(t, "# Delt\noprindelig")
|
||||||
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
map[string]string{"user_id": sofie, "role": "editor"}); resp.StatusCode != http.StatusNoContent {
|
map[string]string{"user_id": sofie, "role": "editor"}); resp.StatusCode != http.StatusOK {
|
||||||
t.Fatalf("share as editor failed")
|
t.Fatalf("share as editor failed")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -193,7 +193,104 @@ func TestShareRejectsUnknownAndSelf(t *testing.T) {
|
|||||||
t.Errorf("sharing with oneself: %d, want 422", resp.StatusCode)
|
t.Errorf("sharing with oneself: %d, want 422", resp.StatusCode)
|
||||||
}
|
}
|
||||||
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
map[string]string{"user_id": me, "role": "owner"}); resp.StatusCode == http.StatusNoContent {
|
map[string]string{"user_id": me, "role": "owner"}); resp.StatusCode == http.StatusOK {
|
||||||
t.Error("a note was shared at the owner role")
|
t.Error("a note was shared at the owner role")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// De noter, en delt note peger på, følger med — og holder op igen.
|
||||||
|
//
|
||||||
|
// Det var meldt som en fejl den anden vej rundt: linkene i en delt note førte
|
||||||
|
// ingen steder hen, fordi det, de pegede på, ikke var delt. Prøven går hele vejen
|
||||||
|
// rundt om svaret på det — dybden, teksten der ændrer sig bagefter, det der ikke
|
||||||
|
// må følge med, og vejen tilbage.
|
||||||
|
func TestSharedNoteTakesItsLinksWithIt(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
other := owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
sofie := userID(t, owner, "sofie@example.dk")
|
||||||
|
|
||||||
|
// Prisliste peger videre på Leveringstider, så kæden er to led lang.
|
||||||
|
deep := owner.createNote(t, "# Leveringstider\nfire dage")
|
||||||
|
linked := owner.createNote(t, "# Prisliste\nog [[Leveringstider]]")
|
||||||
|
apart := owner.createNote(t, "# Bankoplysninger\nikke til deling")
|
||||||
|
noteID := owner.createNote(t, "# Aftale om levering\nse [[Prisliste]]")
|
||||||
|
|
||||||
|
reachable := func(id string) bool {
|
||||||
|
resp, _ := other.do(t, "GET", "/api/v1/notes/"+id, nil)
|
||||||
|
return resp.StatusCode == http.StatusOK
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, out := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"user_id": sofie, "role": "viewer"})
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("share: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
// Svaret siger, hvad der fulgte med — hele kæden, ikke kun første led. En
|
||||||
|
// deling, der stille tog to noter mere med, ville være rigtig og alligevel ikke
|
||||||
|
// til at overskue.
|
||||||
|
follows, _ := out["follows"].([]any)
|
||||||
|
if len(follows) != 2 {
|
||||||
|
t.Fatalf("delingen nævnte %d noter, der fulgte med, want 2: %v", len(follows), out["follows"])
|
||||||
|
}
|
||||||
|
|
||||||
|
if !reachable(linked) {
|
||||||
|
t.Error("noten, den delte note peger på, fulgte ikke med")
|
||||||
|
}
|
||||||
|
if !reachable(deep) {
|
||||||
|
t.Error("kæden stoppede efter ét led")
|
||||||
|
}
|
||||||
|
if reachable(apart) {
|
||||||
|
t.Error("en note, ingen peger på, blev delt")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Skrevet bagefter tæller også. Et link i dag i en note delt i går skal føre
|
||||||
|
// samme sted hen for begge.
|
||||||
|
senere := owner.createNote(t, "# Rabatter\nti procent")
|
||||||
|
if reachable(senere) {
|
||||||
|
t.Fatal("en helt ny note var delt, før noget pegede på den")
|
||||||
|
}
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Aftale om levering\nse [[Prisliste]] og [[Rabatter]]"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("kunne ikke skrive videre i den delte note")
|
||||||
|
}
|
||||||
|
if !reachable(senere) {
|
||||||
|
t.Error("et link skrevet efter delingen fulgte ikke med")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Og vejen tilbage: tages delingen tilbage, følger det med, den tog med sig.
|
||||||
|
if resp, _ := owner.do(t, "DELETE", "/api/v1/notes/"+noteID+"/shares/"+sofie, nil); resp.StatusCode != http.StatusNoContent {
|
||||||
|
t.Fatalf("unshare: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if reachable(linked) || reachable(deep) || reachable(senere) {
|
||||||
|
t.Error("det, der fulgte med delingen, blev stående, da den blev taget tilbage")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En medredaktør kan ikke dele ejerens noter med sig selv ved at skrive et link.
|
||||||
|
//
|
||||||
|
// Det er den ene vej, "linkene følger med" kunne blive til en rettighedsfejl: et
|
||||||
|
// link peger på en titel, og enhver, der må rette i en delt note, kan skrive en
|
||||||
|
// titel. Derfor regnes delingerne kun om, når ejeren selv har gemt.
|
||||||
|
func TestAnEditorCannotShareTheOwnersNotesWithThemselves(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
other := owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
sofie := userID(t, owner, "sofie@example.dk")
|
||||||
|
|
||||||
|
secret := owner.createNote(t, "# Bankoplysninger\nreg og konto")
|
||||||
|
noteID := owner.createNote(t, "# Fælles\nintet link her")
|
||||||
|
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"user_id": sofie, "role": "editor"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("share as editor failed")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Hun skriver linket selv, i den note hun har fået lov at rette i.
|
||||||
|
if resp, _ := other.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Fælles\nse [[Bankoplysninger]]"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("medredaktøren kunne ikke skrive")
|
||||||
|
}
|
||||||
|
if resp, _ := other.do(t, "GET", "/api/v1/notes/"+secret, nil); resp.StatusCode == http.StatusOK {
|
||||||
|
t.Error("en medredaktør delte ejerens note med sig selv ved at skrive et link")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ type notificationJSON struct {
|
|||||||
ActorName string `json:"actor_name,omitempty"`
|
ActorName string `json:"actor_name,omitempty"`
|
||||||
ProjectID string `json:"project_id,omitempty"`
|
ProjectID string `json:"project_id,omitempty"`
|
||||||
TaskID string `json:"task_id,omitempty"`
|
TaskID string `json:"task_id,omitempty"`
|
||||||
|
NoteID string `json:"note_id,omitempty"`
|
||||||
Kind string `json:"kind"`
|
Kind string `json:"kind"`
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
Body string `json:"body,omitempty"`
|
Body string `json:"body,omitempty"`
|
||||||
@@ -44,8 +45,8 @@ func (s *Server) handleListNotifications(w http.ResponseWriter, r *http.Request)
|
|||||||
for _, n := range list {
|
for _, n := range list {
|
||||||
out = append(out, notificationJSON{
|
out = append(out, notificationJSON{
|
||||||
ID: n.ID, ActorName: n.ActorName, ProjectID: n.ProjectID, TaskID: n.TaskID,
|
ID: n.ID, ActorName: n.ActorName, ProjectID: n.ProjectID, TaskID: n.TaskID,
|
||||||
Kind: n.Kind, Title: n.Title, Body: n.Body, Read: n.ReadAt != nil,
|
NoteID: n.NoteID, Kind: n.Kind, Title: n.Title, Body: n.Body,
|
||||||
CreatedAt: n.CreatedAt.Format(time.RFC3339),
|
Read: n.ReadAt != nil, CreatedAt: n.CreatedAt.Format(time.RFC3339),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
writeJSON(w, http.StatusOK, map[string]any{"notifications": out, "unread": unread})
|
writeJSON(w, http.StatusOK, map[string]any{"notifications": out, "unread": unread})
|
||||||
@@ -75,8 +76,9 @@ func (s *Server) notify(r *http.Request, n *store.Notification) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
s.hub.PublishToUser(n.UserID, "notification", notificationJSON{
|
s.hub.PublishToUser(n.UserID, "notification", notificationJSON{
|
||||||
ID: n.ID, ProjectID: n.ProjectID, TaskID: n.TaskID, Kind: n.Kind,
|
ID: n.ID, ActorName: n.ActorName, ProjectID: n.ProjectID, TaskID: n.TaskID,
|
||||||
Title: n.Title, Body: n.Body, CreatedAt: n.CreatedAt.Format(time.RFC3339),
|
NoteID: n.NoteID, Kind: n.Kind, Title: n.Title, Body: n.Body,
|
||||||
|
CreatedAt: n.CreatedAt.Format(time.RFC3339),
|
||||||
})
|
})
|
||||||
|
|
||||||
// Detached from the request: a push round trip to Google or Mozilla has no
|
// Detached from the request: a push round trip to Google or Mozilla has no
|
||||||
@@ -102,6 +104,89 @@ func (s *Server) notifyProject(r *http.Request, projectID, taskID, actorID, kind
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// notifyAssigned tells somebody a task is now theirs.
|
||||||
|
//
|
||||||
|
// Kun ved *skiftet*, og kun til den, der får den. En opgave, der bliver rørt ti
|
||||||
|
// gange bagefter, er stadig den samme besked — og den, der uddelegerer, ved godt
|
||||||
|
// hvad de lige har gjort.
|
||||||
|
func (s *Server) notifyAssigned(r *http.Request, t *store.Task) {
|
||||||
|
if t == nil || t.AssigneeID == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
actor := userFrom(r.Context())
|
||||||
|
s.notify(r, &store.Notification{
|
||||||
|
UserID: t.AssigneeID, ActorID: actor.ID, ProjectID: t.ProjectID, TaskID: t.ID,
|
||||||
|
Kind: "assigned", Title: actor.Name + " gav dig en opgave", Body: t.Content,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// notifyNoteShared tells somebody that a note is now theirs to read.
|
||||||
|
//
|
||||||
|
// Én besked, når delingen sker, og ikke noget bagefter: den, der får en note delt,
|
||||||
|
// skal vide, at den er der. At den senere bliver rettet, er en anden besked — den
|
||||||
|
// skriver notifyNoteChanged — og de to må ikke sige det samme om det samme.
|
||||||
|
//
|
||||||
|
// Ikke sammenlagt med noget. En deling sker én gang pr. person pr. note, så der er
|
||||||
|
// ikke en gentagelse at folde sammen — og bliver rollen ændret bagefter, er det
|
||||||
|
// ikke en ny note at læse.
|
||||||
|
func (s *Server) notifyNoteShared(r *http.Request, n *store.Note, userID string) {
|
||||||
|
if n == nil || userID == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
actor := userFrom(r.Context())
|
||||||
|
s.notify(r, &store.Notification{
|
||||||
|
UserID: userID, ActorID: actor.ID, ProjectID: n.ProjectID, NoteID: n.ID,
|
||||||
|
Kind: "note.shared", Title: actor.Name + " delte en note med dig", Body: n.Title,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// notifyNoteChanged tells everybody who can see a note that somebody else wrote in
|
||||||
|
// it — folded into one line per note while it is unread.
|
||||||
|
//
|
||||||
|
// `except` er dem, den samme gemning allerede har sagt noget mere præcist til:
|
||||||
|
// den, der lige er blevet nævnt ved navn, skal ikke også høre, at noten er rettet.
|
||||||
|
//
|
||||||
|
// Skrevet som ét kald pr. modtager frem for ét pr. note, fordi sammenlægningen er
|
||||||
|
// pr. person: to mennesker kan have læst den forrige besked på hvert sit tidspunkt,
|
||||||
|
// og den ene skal have en ny linje, mens den anden får sin gamle rykket op.
|
||||||
|
func (s *Server) notifyNoteChanged(r *http.Request, n *store.Note, except map[string]bool) {
|
||||||
|
if n == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
actor := userFrom(r.Context())
|
||||||
|
audience, err := s.db.NoteAudience(r.Context(), n.ID)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("note audience for notification", "err", err, "note", n.ID)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
title := actor.Name + " rettede en note"
|
||||||
|
body := n.Title
|
||||||
|
for _, userID := range audience {
|
||||||
|
if userID == actor.ID || except[userID] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// Fold first, and only write a row when there was nothing to fold into.
|
||||||
|
// Den anden vej rundt — skriv, og ryd op bagefter — efterlader et vindue,
|
||||||
|
// hvor klokken siger to.
|
||||||
|
folded, err := s.db.BumpUnreadNoteNotification(r.Context(), userID, n.ID, actor.ID, title, body)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("fold note notification", "err", err, "note", n.ID)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if folded {
|
||||||
|
// Klokken skal stadig vide det: tallet er uændret, men linjen er rykket
|
||||||
|
// op og siger nu et andet navn. Uden det her opdager en åben fane først
|
||||||
|
// den sammenlagte rettelse ved næste genindlæsning.
|
||||||
|
s.hub.PublishToUser(userID, "notification.folded", map[string]any{"note_id": n.ID})
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
s.notify(r, &store.Notification{
|
||||||
|
UserID: userID, ActorID: actor.ID, ProjectID: n.ProjectID, NoteID: n.ID,
|
||||||
|
Kind: "note.changed", Title: title, Body: body,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// PushToUser is pushToUser for callers outside this package — the reminder job,
|
// PushToUser is pushToUser for callers outside this package — the reminder job,
|
||||||
// which has the schedule but not the keys.
|
// which has the schedule but not the keys.
|
||||||
func (s *Server) PushToUser(userID, title, body, projectID string) {
|
func (s *Server) PushToUser(userID, title, body, projectID string) {
|
||||||
@@ -152,7 +237,16 @@ func (s *Server) pushToUser(userID, title, body, projectID string) pushOutcome {
|
|||||||
if projectID == "" {
|
if projectID == "" {
|
||||||
target = "/"
|
target = "/"
|
||||||
}
|
}
|
||||||
payload := push.Payload{Title: title, Body: body, URL: target}
|
// Mærket på ikonet følger med beskeden. Talt her frem for i service-workeren,
|
||||||
|
// som ikke har nogen hukommelse mellem to opvågninger og derfor kun kunne lægge
|
||||||
|
// én til noget, den ikke kender — et mærke, der tæller sig selv op og aldrig
|
||||||
|
// ned. Fejler tællingen, sendes beskeden alligevel: en besked uden et tal er
|
||||||
|
// stadig en besked.
|
||||||
|
unread, err := s.db.UnreadNotificationCount(ctx, userID)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("unread count for push", "err", err)
|
||||||
|
}
|
||||||
|
payload := push.Payload{Title: title, Body: body, URL: target, Unread: unread}
|
||||||
subject := s.vapidSubject()
|
subject := s.vapidSubject()
|
||||||
for _, sub := range subs {
|
for _, sub := range subs {
|
||||||
err := push.Send(ctx, push.Subscription{
|
err := push.Send(ctx, push.Subscription{
|
||||||
|
|||||||
@@ -0,0 +1,205 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// notifications reads somebody's bell.
|
||||||
|
func notifications(t *testing.T, ts *testServer) ([]any, float64) {
|
||||||
|
t.Helper()
|
||||||
|
resp, out := ts.do(t, "GET", "/api/v1/notifications", nil)
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("list notifications: status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
list, _ := out["notifications"].([]any)
|
||||||
|
unread, _ := out["unread"].(float64)
|
||||||
|
return list, unread
|
||||||
|
}
|
||||||
|
|
||||||
|
func firstOf(t *testing.T, list []any) map[string]any {
|
||||||
|
t.Helper()
|
||||||
|
if len(list) == 0 {
|
||||||
|
t.Fatal("ingen beskeder")
|
||||||
|
}
|
||||||
|
n, _ := list[0].(map[string]any)
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
// At blive tildelt en opgave giver besked — og kun ved selve skiftet.
|
||||||
|
func TestBeingGivenATaskNotifiesTheAssignee(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
other := owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
sofie := userID(t, owner, "sofie@example.dk")
|
||||||
|
|
||||||
|
_, project := owner.do(t, "POST", "/api/v1/projects", map[string]any{"name": "Fælles"})
|
||||||
|
projectID, _ := project["id"].(string)
|
||||||
|
// Medlemskab kommer gennem en invitation; en konto, der allerede findes, bliver
|
||||||
|
// medlem med det samme.
|
||||||
|
if resp, _ := owner.do(t, "POST", "/api/v1/projects/"+projectID+"/invites",
|
||||||
|
map[string]any{"email": "sofie@example.dk", "role": "editor"}); resp.StatusCode >= 300 {
|
||||||
|
t.Fatalf("invitér: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, task := owner.do(t, "POST", "/api/v1/tasks",
|
||||||
|
map[string]any{"project_id": projectID, "content": "ring til revisor"})
|
||||||
|
if resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatalf("opret opgave: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
taskID, _ := task["id"].(string)
|
||||||
|
|
||||||
|
// Hvad hun havde, før nogen tildelte hende noget. Ikke nødvendigvis nul —
|
||||||
|
// invitationen kan selv have sagt noget — og prøven handler om forskellen.
|
||||||
|
before, _ := notifications(t, other)
|
||||||
|
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/tasks/"+taskID,
|
||||||
|
map[string]any{"assignee_id": sofie}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("tildel: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
list, _ := notifications(t, other)
|
||||||
|
if len(list) != len(before)+1 {
|
||||||
|
t.Fatalf("Sofie fik %d beskeder, want %d", len(list), len(before)+1)
|
||||||
|
}
|
||||||
|
n := firstOf(t, list)
|
||||||
|
if n["kind"] != "assigned" {
|
||||||
|
t.Errorf("kind = %v, want assigned", n["kind"])
|
||||||
|
}
|
||||||
|
if n["task_id"] != taskID {
|
||||||
|
t.Errorf("beskeden pegede ikke på opgaven: %v", n["task_id"])
|
||||||
|
}
|
||||||
|
if n["actor_name"] != "Kristian" {
|
||||||
|
t.Errorf("actor_name = %v", n["actor_name"])
|
||||||
|
}
|
||||||
|
|
||||||
|
// En rettelse af noget andet, mens den samme tildeling står i forespørgslen,
|
||||||
|
// er ikke en ny besked. Det er dét, en fladet, der sender hele opgaven ved hver
|
||||||
|
// ændring, gør — og så bliver klokken ubrugelig på en dag.
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/tasks/"+taskID,
|
||||||
|
map[string]any{"assignee_id": sofie, "content": "ring til revisoren"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("ret: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if now, _ := notifications(t, other); len(now) != len(before)+1 {
|
||||||
|
t.Errorf("en uændret tildeling gav besked igen: %d beskeder", len(now))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Og den, der tildeler sig selv, får ingenting.
|
||||||
|
me := userID(t, owner, "kristian@example.dk")
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/tasks/"+taskID,
|
||||||
|
map[string]any{"assignee_id": me}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("tildel til sig selv: %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
if list, _ := notifications(t, owner); len(list) != 0 {
|
||||||
|
t.Errorf("man fik besked om noget, man selv gjorde: %d beskeder", len(list))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En rettelse i en delt note giver besked — og gentagne rettelser bliver til én,
|
||||||
|
// så længe den ikke er læst.
|
||||||
|
func TestEditingASharedNoteNotifiesTheOthers(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
other := owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
sofie := userID(t, owner, "sofie@example.dk")
|
||||||
|
|
||||||
|
noteID := owner.createNote(t, "# Aftale om levering\nfirst")
|
||||||
|
if resp, _ := owner.do(t, "POST", "/api/v1/notes/"+noteID+"/shares",
|
||||||
|
map[string]string{"user_id": sofie, "role": "editor"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("del noten")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Selve delingen er den første besked: Sofie skal vide, at noten er der, før
|
||||||
|
// nogen retter i den. Den tælles med i alt, hvad der følger.
|
||||||
|
if list, unread := notifications(t, other); len(list) != 1 || unread != 1 ||
|
||||||
|
firstOf(t, list)["kind"] != "note.shared" {
|
||||||
|
t.Fatalf("delingen gav %d beskeder (%v ulæste): %v", len(list), unread, list)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ejeren skriver. Sofie skal høre det.
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Aftale om levering\nanden linje"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("ret noten")
|
||||||
|
}
|
||||||
|
list, unread := notifications(t, other)
|
||||||
|
if unread != 2 || len(list) != 2 {
|
||||||
|
t.Fatalf("Sofie fik %d beskeder (%v ulæste), want 2 — delingen og rettelsen",
|
||||||
|
len(list), unread)
|
||||||
|
}
|
||||||
|
n := firstOf(t, list)
|
||||||
|
if n["kind"] != "note.changed" || n["note_id"] != noteID {
|
||||||
|
t.Errorf("besked = %v", n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// En gemning mere, mens den er ulæst, må ikke blive til en linje mere. En note
|
||||||
|
// gemmes ved hver tastepause, så uden det her er fem minutters skriveri tyve
|
||||||
|
// ens linjer i klokken.
|
||||||
|
for i := 0; i < 3; i++ {
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Aftale om levering\nlinje nummer " + string(rune('a'+i))}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("ret noten igen")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if list, unread := notifications(t, other); len(list) != 2 || unread != 2 {
|
||||||
|
t.Errorf("tre gemninger blev til %d beskeder, want 2 — delingen og én rettelse",
|
||||||
|
len(list))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Læst, og så en rettelse mere: dét er en ny ting at få at vide.
|
||||||
|
if resp, _ := other.do(t, "POST", "/api/v1/notifications/read", nil); resp.StatusCode != http.StatusNoContent {
|
||||||
|
t.Fatal("markér som læst")
|
||||||
|
}
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Aftale om levering\nefter læsningen"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("ret noten efter læsningen")
|
||||||
|
}
|
||||||
|
if list, unread := notifications(t, other); len(list) != 3 || unread != 1 {
|
||||||
|
t.Errorf("efter læsningen gav en rettelse %d beskeder (%v ulæste), want 3 og 1", len(list), unread)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ejeren har ikke fået besked om sine egne rettelser undervejs.
|
||||||
|
if list, _ := notifications(t, owner); len(list) != 0 {
|
||||||
|
t.Errorf("ejeren fik %d beskeder om sine egne rettelser", len(list))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Og den anden vej: Sofie skriver, ejeren hører det.
|
||||||
|
if resp, _ := other.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Aftale om levering\nfra Sofie"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("Sofie retter")
|
||||||
|
}
|
||||||
|
list, _ = notifications(t, owner)
|
||||||
|
if len(list) != 1 {
|
||||||
|
t.Fatalf("ejeren fik %d beskeder, da noten blev rettet af en anden, want 1", len(list))
|
||||||
|
}
|
||||||
|
if firstOf(t, list)["actor_name"] != "Sofie" {
|
||||||
|
t.Errorf("beskeden nævnte ikke hvem: %v", list[0])
|
||||||
|
}
|
||||||
|
|
||||||
|
// En ændring, der ikke er tekst, er ikke en rettelse at give besked om.
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"pinned": true}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("stjernemarkér")
|
||||||
|
}
|
||||||
|
if list, _ := notifications(t, other); len(list) != 3 {
|
||||||
|
t.Errorf("en stjernemarkering gav besked: %d beskeder, want 3", len(list))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// En note, ingen deler, er ingen at give besked.
|
||||||
|
func TestEditingAPrivateNoteNotifiesNobody(t *testing.T) {
|
||||||
|
owner := newTestServer(t)
|
||||||
|
owner.bootstrap(t)
|
||||||
|
other := owner.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
|
||||||
|
noteID := owner.createNote(t, "# Min egen\nintet")
|
||||||
|
if resp, _ := owner.do(t, "PATCH", "/api/v1/notes/"+noteID,
|
||||||
|
map[string]any{"body": "# Min egen\nnoget"}); resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatal("ret noten")
|
||||||
|
}
|
||||||
|
if list, _ := notifications(t, other); len(list) != 0 {
|
||||||
|
t.Errorf("Sofie hørte om en note, hun ikke kan se: %d beskeder", len(list))
|
||||||
|
}
|
||||||
|
if list, _ := notifications(t, owner); len(list) != 0 {
|
||||||
|
t.Errorf("ejeren fik besked om sin egen note: %d beskeder", len(list))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -66,6 +66,7 @@ type Server struct {
|
|||||||
// Sat kun af prøver; se icsClient().
|
// Sat kun af prøver; se icsClient().
|
||||||
icsFetch *http.Client
|
icsFetch *http.Client
|
||||||
mailLimiter *limiter
|
mailLimiter *limiter
|
||||||
|
hookLimiter *limiter
|
||||||
resetLimiter *limiter
|
resetLimiter *limiter
|
||||||
// Second factors are counted against the *account*, not the address. An
|
// Second factors are counted against the *account*, not the address. An
|
||||||
// address bucket is defeated by anybody with more than one address, which is
|
// address bucket is defeated by anybody with more than one address, which is
|
||||||
@@ -93,6 +94,7 @@ func New(cfg *config.Config, db *store.DB, log *slog.Logger, web fs.FS) *Server
|
|||||||
// day. Sixty a minute never touches real delivery and still puts a ceiling
|
// day. Sixty a minute never touches real delivery and still puts a ceiling
|
||||||
// on the one public write path that has none.
|
// on the one public write path that has none.
|
||||||
mailLimiter: newLimiter(60, time.Minute),
|
mailLimiter: newLimiter(60, time.Minute),
|
||||||
|
hookLimiter: newLimiter(60, time.Minute),
|
||||||
resetLimiter: newLimiter(5, time.Hour),
|
resetLimiter: newLimiter(5, time.Hour),
|
||||||
// Tighter than the password bucket, and for a whole hour. Somebody typing
|
// Tighter than the password bucket, and for a whole hour. Somebody typing
|
||||||
// their own code gets it right on the first or second try; ten in an hour is
|
// their own code gets it right on the first or second try; ten in an hour is
|
||||||
@@ -143,6 +145,20 @@ func New(cfg *config.Config, db *store.DB, log *slog.Logger, web fs.FS) *Server
|
|||||||
r.Method(http.MethodPost, "/inbound/mail",
|
r.Method(http.MethodPost, "/inbound/mail",
|
||||||
s.rateLimit(s.mailLimiter, http.HandlerFunc(s.handleInboundMail)))
|
s.rateLimit(s.mailLimiter, http.HandlerFunc(s.handleInboundMail)))
|
||||||
|
|
||||||
|
// En krog ind i indbakken: en URL, et andet program kan skubbe en linje tekst
|
||||||
|
// til. Uden for /api/v1 og uden for sessionen af samme grund som feedet og
|
||||||
|
// posten ovenfor — den, der kalder, er en genvej på en telefon eller et script,
|
||||||
|
// og kan ikke logge ind, så tokenet i stien er hele legitimationen.
|
||||||
|
//
|
||||||
|
// Kun POST. En GET ville være nemmere at kalde, og det er præcis problemet:
|
||||||
|
// forudindlæsning i en browser, en linkkontrol i en chat og en historik, der
|
||||||
|
// bliver besøgt igen, ville alle lave opgaver, ingen har bedt om.
|
||||||
|
//
|
||||||
|
// Sin egen kvote frem for postens: en travl integration skal ikke kunne lukke
|
||||||
|
// for den indgående post, og omvendt.
|
||||||
|
r.Method(http.MethodPost, "/inbound/hook/{token}",
|
||||||
|
s.rateLimit(s.hookLimiter, http.HandlerFunc(s.handleInboundHook)))
|
||||||
|
|
||||||
// MCP with the token in the query string, for clients that cannot send a
|
// MCP with the token in the query string, for clients that cannot send a
|
||||||
// header. Claude's custom-connector dialog takes a URL and nothing else, so
|
// header. Claude's custom-connector dialog takes a URL and nothing else, so
|
||||||
// /api/v1/mcp — which wants Authorization: Bearer — cannot be configured from
|
// /api/v1/mcp — which wants Authorization: Bearer — cannot be configured from
|
||||||
@@ -319,6 +335,9 @@ func New(cfg *config.Config, db *store.DB, log *slog.Logger, web fs.FS) *Server
|
|||||||
r.Get("/mail-address", s.handleGetMailAddress)
|
r.Get("/mail-address", s.handleGetMailAddress)
|
||||||
r.Post("/mail-address/rotate", s.handleRotateMailAddress)
|
r.Post("/mail-address/rotate", s.handleRotateMailAddress)
|
||||||
|
|
||||||
|
r.Get("/hook-url", s.handleGetHookURL)
|
||||||
|
r.Post("/hook-url/rotate", s.handleRotateHookURL)
|
||||||
|
|
||||||
// Personal API tokens. Behind requireSession rather than the ambient
|
// Personal API tokens. Behind requireSession rather than the ambient
|
||||||
// auth: a token must not be able to mint or revoke another.
|
// auth: a token must not be able to mint or revoke another.
|
||||||
r.Route("/tokens", func(r chi.Router) {
|
r.Route("/tokens", func(r chi.Router) {
|
||||||
@@ -333,6 +352,23 @@ func New(cfg *config.Config, db *store.DB, log *slog.Logger, web fs.FS) *Server
|
|||||||
r.Put("/settings", s.handleSetAISettings)
|
r.Put("/settings", s.handleSetAISettings)
|
||||||
r.Post("/summary", s.handleAISummary)
|
r.Post("/summary", s.handleAISummary)
|
||||||
r.Post("/tasks/{taskID}/split", s.handleAISplit)
|
r.Post("/tasks/{taskID}/split", s.handleAISplit)
|
||||||
|
// Forslag, ikke skrivninger. De to første svarer med linjer i
|
||||||
|
// quick-add-syntaks, som fladen viser frem; de to sidste er dét,
|
||||||
|
// der sker, når nogen siger ja til én af dem.
|
||||||
|
r.Post("/inbox/tidy", s.handleAITidyInbox)
|
||||||
|
r.Post("/inbox/tidy/apply", s.handleAIApplyToTask)
|
||||||
|
r.Post("/notes/{noteID}/actions", s.handleAINoteActions)
|
||||||
|
r.Post("/notes/{noteID}/actions/apply", s.handleAICreateFromNote)
|
||||||
|
// Dagens plan: indstillingen, og en knap til at se den nu. En
|
||||||
|
// indstilling, man skal vente til i morgen for at se virkningen af,
|
||||||
|
// er en indstilling, ingen tør slå til.
|
||||||
|
r.Get("/plan", s.handleGetPlanSettings)
|
||||||
|
r.Put("/plan", s.handleSetPlanSettings)
|
||||||
|
r.Post("/plan/now", s.handlePlanNow)
|
||||||
|
// Spørg om sine egne noter og opgaver i almindeligt sprog. Basen
|
||||||
|
// finder kandidaterne, modellen læser dem — og svaret bærer, hvad
|
||||||
|
// det er bygget på.
|
||||||
|
r.Post("/ask", s.handleAIAsk)
|
||||||
})
|
})
|
||||||
|
|
||||||
r.Get("/version", s.handleVersion)
|
r.Get("/version", s.handleVersion)
|
||||||
@@ -353,6 +389,9 @@ func New(cfg *config.Config, db *store.DB, log *slog.Logger, web fs.FS) *Server
|
|||||||
r.Get("/{noteID}/shares", s.handleListNoteShares)
|
r.Get("/{noteID}/shares", s.handleListNoteShares)
|
||||||
r.Post("/{noteID}/shares", s.handleShareNote)
|
r.Post("/{noteID}/shares", s.handleShareNote)
|
||||||
r.Delete("/{noteID}/shares/{userID}", s.handleUnshareNote)
|
r.Delete("/{noteID}/shares/{userID}", s.handleUnshareNote)
|
||||||
|
// En invitation til en note er en deling, der venter på en konto.
|
||||||
|
// Den kan tages tilbage indtil den bruges; se handleShareNote.
|
||||||
|
r.Delete("/{noteID}/invites/{inviteID}", s.handleDeleteNoteInvite)
|
||||||
r.Get("/{noteID}", s.handleGetNote)
|
r.Get("/{noteID}", s.handleGetNote)
|
||||||
r.Patch("/{noteID}", s.handleUpdateNote)
|
r.Patch("/{noteID}", s.handleUpdateNote)
|
||||||
r.Delete("/{noteID}", s.handleDeleteNote)
|
r.Delete("/{noteID}", s.handleDeleteNote)
|
||||||
@@ -490,6 +529,12 @@ func New(cfg *config.Config, db *store.DB, log *slog.Logger, web fs.FS) *Server
|
|||||||
// installation and it either phones home or it does not.
|
// installation and it either phones home or it does not.
|
||||||
r.Get("/beacon/settings", s.handleBeaconStatus)
|
r.Get("/beacon/settings", s.handleBeaconStatus)
|
||||||
r.Put("/beacon/settings", s.handleSetBeacon)
|
r.Put("/beacon/settings", s.handleSetBeacon)
|
||||||
|
// Beskeden om, hvad der bliver sendt, og svaret på den. I samme
|
||||||
|
// gruppe som resten: den, der kan slå beaconet fra, er den, der
|
||||||
|
// skal have beskeden, og at spørge alle andre ville være at
|
||||||
|
// stille et spørgsmål, de ikke kan svare på.
|
||||||
|
r.Get("/beacon/notice", s.handleBeaconNotice)
|
||||||
|
r.Post("/beacon/notice", s.handleAckBeaconNotice)
|
||||||
// A backup file is a complete copy of the database, so this whole
|
// A backup file is a complete copy of the database, so this whole
|
||||||
// group is sessions-only as well as administrators-only: a leaked
|
// group is sessions-only as well as administrators-only: a leaked
|
||||||
// token must not be able to download everybody's data.
|
// token must not be able to download everybody's data.
|
||||||
|
|||||||
@@ -245,6 +245,10 @@ func (s *Server) handleCreateTask(w http.ResponseWriter, r *http.Request) {
|
|||||||
t.Labels = req.Labels
|
t.Labels = req.Labels
|
||||||
s.activity(r, t.ProjectID, t.ID, "task.created", map[string]any{"content": t.Content})
|
s.activity(r, t.ProjectID, t.ID, "task.created", map[string]any{"content": t.Content})
|
||||||
s.publish(t.ProjectID, "task.created", toTaskJSON(*t))
|
s.publish(t.ProjectID, "task.created", toTaskJSON(*t))
|
||||||
|
// Lavet til en anden med det samme. Det er den samme besked som at blive
|
||||||
|
// tildelt en, der allerede fandtes — hvad der ikke skal ske er, at den ene vej
|
||||||
|
// ind i "det her er dit nu" giver besked og den anden ikke.
|
||||||
|
s.notifyAssigned(r, t)
|
||||||
writeJSON(w, http.StatusCreated, toTaskJSON(*t))
|
writeJSON(w, http.StatusCreated, toTaskJSON(*t))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -272,6 +276,17 @@ func (s *Server) handleUpdateTask(w http.ResponseWriter, r *http.Request) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Læst før ændringen, og kun når der faktisk kommer en tildeling med i den:
|
||||||
|
// beskeden skal gå på *skiftet*, ikke på at feltet stod i forespørgslen. Den,
|
||||||
|
// der får en opgave tildelt igen, den allerede har, skal ikke have besked om
|
||||||
|
// det hver gang nogen retter en overskrift.
|
||||||
|
wasAssigned := ""
|
||||||
|
if req.AssigneeID != nil {
|
||||||
|
if before, err := s.db.GetTask(r.Context(), taskID, user.ID); err == nil {
|
||||||
|
wasAssigned = before.AssigneeID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
u := store.TaskUpdate{
|
u := store.TaskUpdate{
|
||||||
Description: req.Description, Priority: req.Priority,
|
Description: req.Description, Priority: req.Priority,
|
||||||
SectionID: req.SectionID, ParentID: req.ParentID,
|
SectionID: req.SectionID, ParentID: req.ParentID,
|
||||||
@@ -324,6 +339,9 @@ func (s *Server) handleUpdateTask(w http.ResponseWriter, r *http.Request) {
|
|||||||
}
|
}
|
||||||
s.activity(r, t.ProjectID, t.ID, "task.updated", nil)
|
s.activity(r, t.ProjectID, t.ID, "task.updated", nil)
|
||||||
s.publish(t.ProjectID, "task.updated", toTaskJSON(*t))
|
s.publish(t.ProjectID, "task.updated", toTaskJSON(*t))
|
||||||
|
if req.AssigneeID != nil && t.AssigneeID != wasAssigned {
|
||||||
|
s.notifyAssigned(r, t)
|
||||||
|
}
|
||||||
writeJSON(w, http.StatusOK, toTaskJSON(*t))
|
writeJSON(w, http.StatusOK, toTaskJSON(*t))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -285,6 +285,49 @@ func TestTodayAndUpcoming(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The horizon is the list's, and it is asked for per request: seven days is the
|
||||||
|
// default, thirty is what Kommende offers for "when does this month get busy", and
|
||||||
|
// anything past the cap is trimmed rather than refused — a client that asks for a
|
||||||
|
// year gets a month, not a 400.
|
||||||
|
func TestUpcomingHorizon(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
resp, out := ts.do(t, "POST", "/api/v1/tasks", map[string]any{
|
||||||
|
"content": "om tyve dage",
|
||||||
|
"due_date": userDate(t, 20),
|
||||||
|
})
|
||||||
|
if resp.StatusCode != http.StatusCreated {
|
||||||
|
t.Fatalf("create: %d %v", resp.StatusCode, out)
|
||||||
|
}
|
||||||
|
|
||||||
|
count := func(query string) (int, int) {
|
||||||
|
t.Helper()
|
||||||
|
_, view := ts.do(t, "GET", "/api/v1/upcoming"+query, nil)
|
||||||
|
days, _ := view["days"].([]any)
|
||||||
|
var tasks int
|
||||||
|
for _, d := range days {
|
||||||
|
day, _ := d.(map[string]any)
|
||||||
|
list, _ := day["tasks"].([]any)
|
||||||
|
tasks += len(list)
|
||||||
|
}
|
||||||
|
return len(days), tasks
|
||||||
|
}
|
||||||
|
|
||||||
|
if n, found := count(""); n != 7 || found != 0 {
|
||||||
|
t.Errorf("default horizon returned %d days and %d tasks, want 7 and 0", n, found)
|
||||||
|
}
|
||||||
|
if n, found := count("?days=30"); n != 30 || found != 1 {
|
||||||
|
t.Errorf("days=30 returned %d days and %d tasks, want 30 and 1", n, found)
|
||||||
|
}
|
||||||
|
if n, _ := count("?days=365"); n != 31 {
|
||||||
|
t.Errorf("days=365 returned %d days, want it capped at 31", n)
|
||||||
|
}
|
||||||
|
if n, _ := count("?days=nonsense"); n != 7 {
|
||||||
|
t.Errorf("an unreadable days returned %d days, want the default 7", n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestSearchFindsAcrossProjects(t *testing.T) {
|
func TestSearchFindsAcrossProjects(t *testing.T) {
|
||||||
ts := newTestServer(t)
|
ts := newTestServer(t)
|
||||||
ts.bootstrap(t)
|
ts.bootstrap(t)
|
||||||
|
|||||||
@@ -0,0 +1,91 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/kristianwind/verdande/internal/store"
|
||||||
|
"github.com/kristianwind/verdande/internal/update"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Besked til administratorerne, når der er kommet en ny version.
|
||||||
|
//
|
||||||
|
// Tjekket fandtes i forvejen, og svaret stod ét sted: nederst på en
|
||||||
|
// indstillingsside. Det er en oplysning, man kun får, hvis man i forvejen havde
|
||||||
|
// mistanke om, at der var noget at se efter — og "der er kommet en rettelse af
|
||||||
|
// noget, du er ramt af" er ikke noget, man gætter sig til at kigge efter.
|
||||||
|
//
|
||||||
|
// Kun til administratorer, af samme grund som versionsfeltet er det: en besked om,
|
||||||
|
// at serveren er bagud, er en besked om en andens arbejde, hvis man ikke selv kan
|
||||||
|
// gøre noget ved den. Og den fører hen, hvor knappen til at gøre det sidder.
|
||||||
|
|
||||||
|
const updateScope = "update"
|
||||||
|
|
||||||
|
// NotifyOfUpdates er timeslaget. Selve tjekket mellemlagrer sit svar i seks timer,
|
||||||
|
// så en time mellem opslagene her koster ikke noget — og en instans, der har været
|
||||||
|
// slukket, opdager det ved den første time, den er vågen.
|
||||||
|
func (s *Server) NotifyOfUpdates(ctx context.Context) error {
|
||||||
|
return s.notifyOfUpdate(ctx, s.updates.Status(ctx))
|
||||||
|
}
|
||||||
|
|
||||||
|
// notifyOfUpdate tager status som argument frem for at hente den, så den kan
|
||||||
|
// prøves uden at spørge GitHub om noget.
|
||||||
|
func (s *Server) notifyOfUpdate(ctx context.Context, status update.Status) error {
|
||||||
|
// Slået fra betyder slået fra. Et tjek, operatøren ikke har bedt om, må ikke
|
||||||
|
// blive til en besked ad bagvejen.
|
||||||
|
if status.Disabled || !status.Available || status.Latest == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
stored, err := s.db.InstanceSettings(ctx, updateScope)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
// Én besked pr. version, ikke én pr. dag. En påmindelse hver morgen om det
|
||||||
|
// samme er den slags besked, folk slår fra — og så er den næste, der betyder
|
||||||
|
// noget, også slået fra.
|
||||||
|
if last, _ := stored["notified_version"].(string); last == status.Latest {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
users, err := s.db.ListUsers(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
title := updateTitle(status.Latest)
|
||||||
|
body := firstLineOf(status.Notes)
|
||||||
|
for _, u := range users {
|
||||||
|
if !u.IsAdmin {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
s.notifyDirect(ctx, &store.Notification{
|
||||||
|
UserID: u.ID, Kind: "update.available", Title: title, Body: body,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Skrevet efter beskederne, og kun hvis de blev sendt. Skrevet først ville en
|
||||||
|
// fejl midtvejs betyde, at halvdelen fik besked og resten aldrig gjorde.
|
||||||
|
return s.db.SetInstanceSettings(ctx, updateScope, map[string]any{
|
||||||
|
"notified_version": status.Latest,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// updateTitle er skrevet på dansk, fordi den også bliver til en push-besked, og
|
||||||
|
// push har ingen ordbog at slå op i. Fladen skriver sin egen sætning ud fra
|
||||||
|
// `kind` — se KINDS i Notifications.svelte.
|
||||||
|
func updateTitle(version string) string {
|
||||||
|
return "verdande " + version + " er klar"
|
||||||
|
}
|
||||||
|
|
||||||
|
// firstLineOf er den første linje af udgivelsesnoterne, som beskedens krop.
|
||||||
|
//
|
||||||
|
// Hele teksten ville være en udgivelsesnote i en notifikation, og det er ikke det,
|
||||||
|
// en notifikation er til: den skal sige, at der er noget, og hvor man læser det.
|
||||||
|
func firstLineOf(notes string) string {
|
||||||
|
for _, line := range strings.Split(notes, "\n") {
|
||||||
|
if line = strings.TrimSpace(line); line != "" {
|
||||||
|
return firstWords(line, 30)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
@@ -0,0 +1,127 @@
|
|||||||
|
package httpapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/kristianwind/verdande/internal/update"
|
||||||
|
)
|
||||||
|
|
||||||
|
// En ny version siger til af sig selv. Uden det stod svaret nederst på en
|
||||||
|
// indstillingsside, som man kun åbner, hvis man i forvejen havde mistanke om, at
|
||||||
|
// der var noget at se efter.
|
||||||
|
func TestANewVersionTellsTheAdministrator(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
status := update.Status{
|
||||||
|
Current: "v0.44.0", Latest: "v0.45.0", Available: true,
|
||||||
|
Notes: "Nyt:\n\n- noget godt", URL: "https://example.dk/v0.45.0",
|
||||||
|
}
|
||||||
|
if err := ts.api.notifyOfUpdate(t.Context(), status); err != nil {
|
||||||
|
t.Fatalf("besked om ny version: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
list, unread := notifications(t, ts)
|
||||||
|
if len(list) != 1 || unread != 1 {
|
||||||
|
t.Fatalf("beskeder = %d (%v ulæste), want 1", len(list), unread)
|
||||||
|
}
|
||||||
|
n := firstOf(t, list)
|
||||||
|
if n["kind"] != "update.available" {
|
||||||
|
t.Errorf("besked = %v", n)
|
||||||
|
}
|
||||||
|
// Titlen bærer versionen, fordi den også bliver til en push-besked, og push
|
||||||
|
// har ingen ordbog at slå sætningen op i.
|
||||||
|
if title, _ := n["title"].(string); title != "verdande v0.45.0 er klar" {
|
||||||
|
t.Errorf("titel = %q", title)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Én besked pr. version, ikke én pr. time. En påmindelse hver time om det
|
||||||
|
// samme er den slags besked, folk slår fra — og så er den næste, der betyder
|
||||||
|
// noget, også slået fra.
|
||||||
|
if err := ts.api.notifyOfUpdate(t.Context(), status); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if list, _ := notifications(t, ts); len(list) != 1 {
|
||||||
|
t.Errorf("den samme version gav %d beskeder, want 1", len(list))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Og den næste version er en ny ting at få at vide.
|
||||||
|
status.Latest = "v0.46.0"
|
||||||
|
if err := ts.api.notifyOfUpdate(t.Context(), status); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if list, _ := notifications(t, ts); len(list) != 2 {
|
||||||
|
t.Errorf("en ny version gav %d beskeder, want 2", len(list))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Kun administratorer. En besked om, at serveren er bagud, er en besked om en
|
||||||
|
// andens arbejde, hvis man ikke selv kan gøre noget ved den.
|
||||||
|
func TestOnlyAdministratorsHearAboutANewVersion(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
other := ts.newUser(t, "sofie@example.dk", "Sofie")
|
||||||
|
|
||||||
|
err := ts.api.notifyOfUpdate(t.Context(), update.Status{
|
||||||
|
Current: "v0.44.0", Latest: "v0.45.0", Available: true,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if list, _ := notifications(t, other); len(list) != 0 {
|
||||||
|
t.Errorf("en almindelig bruger fik %d beskeder om en opdatering", len(list))
|
||||||
|
}
|
||||||
|
if list, _ := notifications(t, ts); len(list) != 1 {
|
||||||
|
t.Errorf("administratoren fik %d beskeder, want 1", len(list))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Et tjek, operatøren har slået fra, må ikke blive til en besked ad bagvejen.
|
||||||
|
func TestNoUpdateNoticeWhenTheCheckIsOff(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
for _, status := range []update.Status{
|
||||||
|
{Current: "v0.44.0", Disabled: true},
|
||||||
|
{Current: "v0.44.0", Available: false},
|
||||||
|
{Current: "v0.44.0", Available: true, Latest: ""},
|
||||||
|
} {
|
||||||
|
if err := ts.api.notifyOfUpdate(t.Context(), status); err != nil {
|
||||||
|
t.Fatalf("%v: %v", status, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if list, _ := notifications(t, ts); len(list) != 0 {
|
||||||
|
t.Errorf("der blev sagt til om en opdatering, der ikke var: %d beskeder", len(list))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Beskeden fører hen, hvor knappen sidder — ikke ud af programmet. Prøvet på det,
|
||||||
|
// fladen læser: en besked uden note, opgave eller projekt skal stadig kunne
|
||||||
|
// klikkes.
|
||||||
|
func TestAnUpdateNoticeCarriesNoTarget(t *testing.T) {
|
||||||
|
ts := newTestServer(t)
|
||||||
|
ts.bootstrap(t)
|
||||||
|
|
||||||
|
err := ts.api.notifyOfUpdate(t.Context(), update.Status{
|
||||||
|
Current: "v0.44.0", Latest: "v0.45.0", Available: true,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
n := firstOf(t, mustNotifications(t, ts))
|
||||||
|
for _, key := range []string{"note_id", "task_id", "project_id"} {
|
||||||
|
if v, ok := n[key]; ok && v != "" {
|
||||||
|
t.Errorf("%s = %v, want ingenting", key, v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func mustNotifications(t *testing.T, ts *testServer) []any {
|
||||||
|
t.Helper()
|
||||||
|
list, _ := notifications(t, ts)
|
||||||
|
if len(list) == 0 {
|
||||||
|
t.Fatal("ingen beskeder")
|
||||||
|
}
|
||||||
|
return list
|
||||||
|
}
|
||||||
@@ -51,7 +51,8 @@ type upcomingDay struct {
|
|||||||
Tasks []taskJSON `json:"tasks"`
|
Tasks []taskJSON `json:"tasks"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// handleUpcoming returns the next seven days, one entry per day.
|
// handleUpcoming returns the next `days` days, one entry per day, seven by default
|
||||||
|
// and at most a month.
|
||||||
//
|
//
|
||||||
// Empty days are included on purpose: the view is a calendar strip, and a Thursday
|
// Empty days are included on purpose: the view is a calendar strip, and a Thursday
|
||||||
// missing from the response because nothing is due would collapse the layout and
|
// missing from the response because nothing is due would collapse the layout and
|
||||||
@@ -65,10 +66,14 @@ func (s *Server) handleUpcoming(w http.ResponseWriter, r *http.Request) {
|
|||||||
from := start.Format("2006-01-02")
|
from := start.Format("2006-01-02")
|
||||||
to := start.AddDate(0, 0, days-1).Format("2006-01-02")
|
to := start.AddDate(0, 0, days-1).Format("2006-01-02")
|
||||||
|
|
||||||
|
// The row limit follows the window rather than sitting at a constant, or a
|
||||||
|
// month asked for with the same ceiling as a week would truncate the last days
|
||||||
|
// silently — and a day cut off the end of the answer looks exactly like a day
|
||||||
|
// with nothing due.
|
||||||
tasks, err := s.db.ListTasks(r.Context(), user.ID, store.TaskFilter{
|
tasks, err := s.db.ListTasks(r.Context(), user.ID, store.TaskFilter{
|
||||||
DueFrom: from,
|
DueFrom: from,
|
||||||
DueBefore: to,
|
DueBefore: to,
|
||||||
Limit: 1000,
|
Limit: 200 * days,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.internal(w, r, "upcoming", err)
|
s.internal(w, r, "upcoming", err)
|
||||||
|
|||||||
@@ -49,6 +49,14 @@ type Runner struct {
|
|||||||
// layer, which owns the VAPID keys and the subscription list.
|
// layer, which owns the VAPID keys and the subscription list.
|
||||||
Push func(userID, title, body, projectID string)
|
Push func(userID, title, body, projectID string)
|
||||||
|
|
||||||
|
// DailyPlans sender morgenens plan til dem, der har bedt om en. Sat af
|
||||||
|
// serveren af samme grund som SendBeacon: opsætningen, tidszonen og
|
||||||
|
// AI-nøglen ligger derovre, og jobbet skal ikke kende nogen af delene.
|
||||||
|
DailyPlans func(ctx context.Context) error
|
||||||
|
|
||||||
|
// NotifyOfUpdates tells the administrators when a newer version is out.
|
||||||
|
NotifyOfUpdates func(ctx context.Context) error
|
||||||
|
|
||||||
// SendBeacon reports this installation to the collector, if it is switched on
|
// SendBeacon reports this installation to the collector, if it is switched on
|
||||||
// and a day has passed. Supplied by the HTTP layer for the same reason as the
|
// and a day has passed. Supplied by the HTTP layer for the same reason as the
|
||||||
// syncs: that is where the instance settings and the version live.
|
// syncs: that is where the instance settings and the version live.
|
||||||
@@ -89,6 +97,13 @@ func (r *Runner) Start(ctx context.Context) {
|
|||||||
// the same reason: a container asleep at the scheduled minute would otherwise
|
// the same reason: a container asleep at the scheduled minute would otherwise
|
||||||
// skip the day. SendBeacon decides whether a day has passed.
|
// skip the day. SendBeacon decides whether a day has passed.
|
||||||
r.every(ctx, "beacon", time.Hour, r.sendBeacon)
|
r.every(ctx, "beacon", time.Hour, r.sendBeacon)
|
||||||
|
// Dagens plan. Hver time, sendt højst én gang om dagen pr. person — samme
|
||||||
|
// form som ovenstående, og af samme grund. Timen er personens egen: klokken
|
||||||
|
// syv er syv forskellige steder.
|
||||||
|
r.every(ctx, "dailyplan", time.Hour, r.dailyPlans)
|
||||||
|
// Nye versioner. Hver time er rigeligt: selve tjekket mellemlagrer sit svar i
|
||||||
|
// seks timer, og beskeden sendes én gang pr. version.
|
||||||
|
r.every(ctx, "updates", time.Hour, r.updateNotices)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r *Runner) Wait() { r.wg.Wait() }
|
func (r *Runner) Wait() { r.wg.Wait() }
|
||||||
@@ -123,6 +138,20 @@ func (r *Runner) every(ctx context.Context, name string, interval time.Duration,
|
|||||||
}()
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (r *Runner) updateNotices(ctx context.Context) error {
|
||||||
|
if r.NotifyOfUpdates == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return r.NotifyOfUpdates(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Runner) dailyPlans(ctx context.Context) error {
|
||||||
|
if r.DailyPlans == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return r.DailyPlans(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
// sendBeacon reports that this installation exists, at most once a day.
|
// sendBeacon reports that this installation exists, at most once a day.
|
||||||
//
|
//
|
||||||
// Every decision about what is sent, and why this is on by default rather than
|
// Every decision about what is sent, and why this is on by default rather than
|
||||||
|
|||||||
@@ -38,11 +38,30 @@ func New(cfg config.SMTP, baseURL string, log *slog.Logger) *Sender {
|
|||||||
func (s *Sender) Configured() bool { return s.cfg.Configured() }
|
func (s *Sender) Configured() bool { return s.cfg.Configured() }
|
||||||
|
|
||||||
func (s *Sender) SendInvite(ctx context.Context, to, inviterName, projectName, link string, ttl time.Duration) error {
|
func (s *Sender) SendInvite(ctx context.Context, to, inviterName, projectName, link string, ttl time.Duration) error {
|
||||||
subject := fmt.Sprintf("%s har delt noget med dig i verdande", inviterName)
|
|
||||||
what := "verdande"
|
what := "verdande"
|
||||||
if projectName != "" {
|
if projectName != "" {
|
||||||
what = "projektet “" + projectName + "”"
|
what = "projektet “" + projectName + "”"
|
||||||
}
|
}
|
||||||
|
return s.sendInvite(ctx, to, inviterName, what, link, ttl)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendNoteInvite is the same letter about a single note.
|
||||||
|
//
|
||||||
|
// The title is in the mail because it is what makes the invitation mean anything —
|
||||||
|
// "Kristian har inviteret dig til noten “Aftale om levering”" is a sentence
|
||||||
|
// somebody can decide about, where "til en note" is one they have to click a link
|
||||||
|
// to understand. It travels no further than the address the owner typed, which is
|
||||||
|
// the address they chose to share the note with.
|
||||||
|
func (s *Sender) SendNoteInvite(ctx context.Context, to, inviterName, noteTitle, link string, ttl time.Duration) error {
|
||||||
|
what := "en note"
|
||||||
|
if noteTitle != "" {
|
||||||
|
what = "noten “" + noteTitle + "”"
|
||||||
|
}
|
||||||
|
return s.sendInvite(ctx, to, inviterName, what, link, ttl)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Sender) sendInvite(ctx context.Context, to, inviterName, what, link string, ttl time.Duration) error {
|
||||||
|
subject := fmt.Sprintf("%s har delt noget med dig i verdande", inviterName)
|
||||||
body := fmt.Sprintf(`Hej
|
body := fmt.Sprintf(`Hej
|
||||||
|
|
||||||
%s har inviteret dig til %s.
|
%s har inviteret dig til %s.
|
||||||
|
|||||||
@@ -56,6 +56,13 @@ type Payload struct {
|
|||||||
Body string `json:"body,omitempty"`
|
Body string `json:"body,omitempty"`
|
||||||
URL string `json:"url,omitempty"`
|
URL string `json:"url,omitempty"`
|
||||||
Tag string `json:"tag,omitempty"`
|
Tag string `json:"tag,omitempty"`
|
||||||
|
// Unread er tallet, mærket på appens ikon skal stå på, når beskeden lander.
|
||||||
|
//
|
||||||
|
// Sendt med frem for talt i service-workeren. Den har ingen hukommelse mellem
|
||||||
|
// to opvågninger, så den kan kun lægge én til noget, den ikke ved hvad er — og
|
||||||
|
// et mærke, der tæller sig selv op, kommer aldrig ned igen af sig selv. Tallet
|
||||||
|
// er serverens, og serveren ved det i forvejen.
|
||||||
|
Unread int `json:"unread,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
var b64 = base64.RawURLEncoding
|
var b64 = base64.RawURLEncoding
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"crypto/ecdh"
|
"crypto/ecdh"
|
||||||
"crypto/rand"
|
"crypto/rand"
|
||||||
|
"encoding/json"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -64,3 +65,25 @@ func testVAPID(t *testing.T) VAPID {
|
|||||||
}
|
}
|
||||||
return VAPID{Public: pub, Private: priv, Subject: "mailto:kristian@example.dk"}
|
return VAPID{Public: pub, Private: priv, Subject: "mailto:kristian@example.dk"}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Tallet til mærket på ikonet skal med i beskeden — og skal blive væk, når der
|
||||||
|
// ikke er noget at sige. Service-workeren læser netop det: er `unread` ikke et
|
||||||
|
// tal, står mærket, som det stod, frem for at blive nulstillet af en tælling, der
|
||||||
|
// ikke lykkedes.
|
||||||
|
func TestPayloadCarriesTheUnreadCount(t *testing.T) {
|
||||||
|
with, err := json.Marshal(Payload{Title: "hej", Unread: 3})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(string(with), `"unread":3`) {
|
||||||
|
t.Errorf("payload = %s, want the unread count in it", with)
|
||||||
|
}
|
||||||
|
|
||||||
|
without, err := json.Marshal(Payload{Title: "hej"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if strings.Contains(string(without), "unread") {
|
||||||
|
t.Errorf("payload = %s, want no count when there is none to send", without)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ type Invite struct {
|
|||||||
ID string
|
ID string
|
||||||
Email string
|
Email string
|
||||||
ProjectID string // empty for an invite to the instance rather than to a project
|
ProjectID string // empty for an invite to the instance rather than to a project
|
||||||
|
NoteID string // set when the invite is to a single note
|
||||||
Role Role
|
Role Role
|
||||||
CreatedBy string
|
CreatedBy string
|
||||||
CreatedAt time.Time
|
CreatedAt time.Time
|
||||||
@@ -68,36 +69,46 @@ func (db *DB) CreateFirstAdmin(ctx context.Context, u *User, inboxName string) e
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// CreateInvite issues an invite and returns the token for the emailed link.
|
// CreateInvite issues an invite to a project and returns the token for the emailed
|
||||||
// projectID may be empty, which invites somebody to the instance rather than to a
|
// link. projectID may be empty, which invites somebody to the instance rather than
|
||||||
// particular project.
|
// to a particular project.
|
||||||
func (db *DB) CreateInvite(ctx context.Context, email, projectID string, role Role, createdBy string, ttl time.Duration) (string, *Invite, error) {
|
func (db *DB) CreateInvite(ctx context.Context, email, projectID string, role Role, createdBy string, ttl time.Duration) (string, *Invite, error) {
|
||||||
if !role.Valid() {
|
return db.createInvite(ctx, &Invite{Email: email, ProjectID: projectID, Role: role, CreatedBy: createdBy}, ttl)
|
||||||
return "", nil, fmt.Errorf("store: %q is not a role", role)
|
}
|
||||||
|
|
||||||
|
// CreateNoteInvite issues an invite to a single note.
|
||||||
|
//
|
||||||
|
// Same row, same token, same link as a project invite — the difference is only
|
||||||
|
// what the person gets when they arrive, and that is settled in AcceptInvite. A
|
||||||
|
// second table for "invited to a note" would have meant a second signup path to
|
||||||
|
// keep in step with this one, and the two would drift the first time either was
|
||||||
|
// touched.
|
||||||
|
func (db *DB) CreateNoteInvite(ctx context.Context, email, noteID string, role Role, createdBy string, ttl time.Duration) (string, *Invite, error) {
|
||||||
|
if noteID == "" {
|
||||||
|
return "", nil, errors.New("store: a note invite needs a note")
|
||||||
|
}
|
||||||
|
return db.createInvite(ctx, &Invite{Email: email, NoteID: noteID, Role: role, CreatedBy: createdBy}, ttl)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (db *DB) createInvite(ctx context.Context, inv *Invite, ttl time.Duration) (string, *Invite, error) {
|
||||||
|
if !inv.Role.Valid() {
|
||||||
|
return "", nil, fmt.Errorf("store: %q is not a role", inv.Role)
|
||||||
}
|
}
|
||||||
token, err := auth.NewToken()
|
token, err := auth.NewToken()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", nil, err
|
return "", nil, err
|
||||||
}
|
}
|
||||||
now := time.Now().UTC()
|
now := time.Now().UTC()
|
||||||
inv := &Invite{
|
inv.ID = NewID()
|
||||||
ID: NewID(),
|
inv.Email = NormalizeEmail(inv.Email)
|
||||||
Email: NormalizeEmail(email),
|
inv.CreatedAt = now
|
||||||
ProjectID: projectID,
|
inv.ExpiresAt = now.Add(ttl)
|
||||||
Role: role,
|
|
||||||
CreatedBy: createdBy,
|
|
||||||
CreatedAt: now,
|
|
||||||
ExpiresAt: now.Add(ttl),
|
|
||||||
}
|
|
||||||
|
|
||||||
var project any
|
|
||||||
if projectID != "" {
|
|
||||||
project = projectID
|
|
||||||
}
|
|
||||||
_, err = db.ExecContext(ctx,
|
_, err = db.ExecContext(ctx,
|
||||||
`INSERT INTO invites (id, email, project_id, role, token_hash, created_by, created_at, expires_at)
|
`INSERT INTO invites (id, email, project_id, note_id, role, token_hash, created_by, created_at, expires_at)
|
||||||
VALUES (?, ?, ?, ?, ?, ?, ?, ?)`,
|
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)`,
|
||||||
inv.ID, inv.Email, project, string(inv.Role), auth.HashToken(token),
|
inv.ID, inv.Email, nullString(inv.ProjectID), nullString(inv.NoteID),
|
||||||
|
string(inv.Role), auth.HashToken(token),
|
||||||
inv.CreatedBy, inv.CreatedAt.Unix(), inv.ExpiresAt.Unix())
|
inv.CreatedBy, inv.CreatedAt.Unix(), inv.ExpiresAt.Unix())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", nil, err
|
return "", nil, err
|
||||||
@@ -112,14 +123,14 @@ func (db *DB) InviteByToken(ctx context.Context, token string) (*Invite, error)
|
|||||||
return nil, ErrInviteInvalid
|
return nil, ErrInviteInvalid
|
||||||
}
|
}
|
||||||
var inv Invite
|
var inv Invite
|
||||||
var projectID sql.NullString
|
var projectID, noteID sql.NullString
|
||||||
var created, expires int64
|
var created, expires int64
|
||||||
var accepted sql.NullInt64
|
var accepted sql.NullInt64
|
||||||
|
|
||||||
err := db.QueryRowContext(ctx,
|
err := db.QueryRowContext(ctx,
|
||||||
`SELECT id, email, project_id, role, created_by, created_at, expires_at, accepted_at
|
`SELECT id, email, project_id, note_id, role, created_by, created_at, expires_at, accepted_at
|
||||||
FROM invites WHERE token_hash = ?`, auth.HashToken(token)).
|
FROM invites WHERE token_hash = ?`, auth.HashToken(token)).
|
||||||
Scan(&inv.ID, &inv.Email, &projectID, &inv.Role, &inv.CreatedBy, &created, &expires, &accepted)
|
Scan(&inv.ID, &inv.Email, &projectID, ¬eID, &inv.Role, &inv.CreatedBy, &created, &expires, &accepted)
|
||||||
if errors.Is(err, sql.ErrNoRows) {
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
return nil, ErrInviteInvalid
|
return nil, ErrInviteInvalid
|
||||||
}
|
}
|
||||||
@@ -131,6 +142,7 @@ func (db *DB) InviteByToken(ctx context.Context, token string) (*Invite, error)
|
|||||||
}
|
}
|
||||||
|
|
||||||
inv.ProjectID = projectID.String
|
inv.ProjectID = projectID.String
|
||||||
|
inv.NoteID = noteID.String
|
||||||
inv.CreatedAt = time.Unix(created, 0).UTC()
|
inv.CreatedAt = time.Unix(created, 0).UTC()
|
||||||
inv.ExpiresAt = time.Unix(expires, 0).UTC()
|
inv.ExpiresAt = time.Unix(expires, 0).UTC()
|
||||||
return &inv, nil
|
return &inv, nil
|
||||||
@@ -144,10 +156,16 @@ type PendingInvite struct {
|
|||||||
Email string
|
Email string
|
||||||
ProjectID string
|
ProjectID string
|
||||||
ProjectName string
|
ProjectName string
|
||||||
Role Role
|
// NoteID is set for an invitation to a single note. The note is named by its
|
||||||
InvitedBy string
|
// id and never by its title: titles are sealed in the database, and a private
|
||||||
CreatedAt time.Time
|
// note's first line is not something an administrator's user list should
|
||||||
ExpiresAt time.Time
|
// spell out. That there is an account on its way is the administrator's
|
||||||
|
// business; what it was invited to read is not.
|
||||||
|
NoteID string
|
||||||
|
Role Role
|
||||||
|
InvitedBy string
|
||||||
|
CreatedAt time.Time
|
||||||
|
ExpiresAt time.Time
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListPendingInvites returns invites that are neither accepted nor expired.
|
// ListPendingInvites returns invites that are neither accepted nor expired.
|
||||||
@@ -159,7 +177,8 @@ type PendingInvite struct {
|
|||||||
// able to say which it is.
|
// able to say which it is.
|
||||||
func (db *DB) ListPendingInvites(ctx context.Context) ([]PendingInvite, error) {
|
func (db *DB) ListPendingInvites(ctx context.Context) ([]PendingInvite, error) {
|
||||||
rows, err := db.QueryContext(ctx, `
|
rows, err := db.QueryContext(ctx, `
|
||||||
SELECT i.id, i.email, COALESCE(i.project_id, ''), COALESCE(p.name, ''), i.role,
|
SELECT i.id, i.email, COALESCE(i.project_id, ''), COALESCE(p.name, ''),
|
||||||
|
COALESCE(i.note_id, ''), i.role,
|
||||||
COALESCE(u.name, ''), i.created_at, i.expires_at
|
COALESCE(u.name, ''), i.created_at, i.expires_at
|
||||||
FROM invites i
|
FROM invites i
|
||||||
LEFT JOIN projects p ON p.id = i.project_id
|
LEFT JOIN projects p ON p.id = i.project_id
|
||||||
@@ -175,8 +194,8 @@ func (db *DB) ListPendingInvites(ctx context.Context) ([]PendingInvite, error) {
|
|||||||
for rows.Next() {
|
for rows.Next() {
|
||||||
var p PendingInvite
|
var p PendingInvite
|
||||||
var created, expires int64
|
var created, expires int64
|
||||||
if err := rows.Scan(&p.ID, &p.Email, &p.ProjectID, &p.ProjectName, &p.Role,
|
if err := rows.Scan(&p.ID, &p.Email, &p.ProjectID, &p.ProjectName, &p.NoteID,
|
||||||
&p.InvitedBy, &created, &expires); err != nil {
|
&p.Role, &p.InvitedBy, &created, &expires); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
p.CreatedAt = time.Unix(created, 0).UTC()
|
p.CreatedAt = time.Unix(created, 0).UTC()
|
||||||
@@ -200,12 +219,16 @@ func (db *DB) DeleteInvite(ctx context.Context, inviteID string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// AcceptInvite marks the invite used and grants the membership it promised, in one
|
// AcceptInvite marks the invite used and grants what it promised, in one
|
||||||
// transaction. Splitting the two would allow a signup to fail partway and leave a
|
// transaction. Splitting the two would allow a signup to fail partway and leave a
|
||||||
// live invite behind, which is a link that still works after it has been used.
|
// live invite behind, which is a link that still works after it has been used.
|
||||||
//
|
//
|
||||||
// The UPDATE is guarded on accepted_at IS NULL, so two requests racing with the
|
// The UPDATE is guarded on accepted_at IS NULL, so two requests racing with the
|
||||||
// same link produce one membership and one failure rather than two memberships.
|
// same link produce one grant and one failure rather than two.
|
||||||
|
//
|
||||||
|
// What is granted depends on what the invite was to: a project membership, a share
|
||||||
|
// on a single note, or — when it carries neither — nothing beyond the account the
|
||||||
|
// caller has just created.
|
||||||
func (db *DB) AcceptInvite(ctx context.Context, inviteID, userID string) error {
|
func (db *DB) AcceptInvite(ctx context.Context, inviteID, userID string) error {
|
||||||
return db.Tx(ctx, func(tx *sql.Tx) error {
|
return db.Tx(ctx, func(tx *sql.Tx) error {
|
||||||
res, err := tx.ExecContext(ctx,
|
res, err := tx.ExecContext(ctx,
|
||||||
@@ -218,13 +241,40 @@ func (db *DB) AcceptInvite(ctx context.Context, inviteID, userID string) error {
|
|||||||
return ErrInviteInvalid
|
return ErrInviteInvalid
|
||||||
}
|
}
|
||||||
|
|
||||||
var projectID sql.NullString
|
var projectID, noteID sql.NullString
|
||||||
var role Role
|
var role Role
|
||||||
|
var invitedBy string
|
||||||
if err := tx.QueryRowContext(ctx,
|
if err := tx.QueryRowContext(ctx,
|
||||||
`SELECT project_id, role FROM invites WHERE id = ?`, inviteID).
|
`SELECT project_id, note_id, role, created_by FROM invites WHERE id = ?`, inviteID).
|
||||||
Scan(&projectID, &role); err != nil {
|
Scan(&projectID, ¬eID, &role, &invitedBy); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if noteID.Valid && noteID.String != "" {
|
||||||
|
// created_by is the person who invited, not the person arriving: the row
|
||||||
|
// records who did the sharing, the same as a share made from the panel.
|
||||||
|
//
|
||||||
|
// The note may have been deleted between the invite and the signup. The
|
||||||
|
// foreign key would refuse the row and take the whole signup with it, so
|
||||||
|
// the note is looked up first and a share on a note that is gone is
|
||||||
|
// simply not made — the account is still worth creating.
|
||||||
|
var alive int
|
||||||
|
if err := tx.QueryRowContext(ctx,
|
||||||
|
`SELECT count(*) FROM notes WHERE id = ? AND deleted_at IS NULL AND created_by <> ?`,
|
||||||
|
noteID.String, userID).Scan(&alive); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if alive == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
_, err = tx.ExecContext(ctx, `
|
||||||
|
INSERT INTO note_shares (note_id, user_id, role, created_by, created_at)
|
||||||
|
VALUES (?, ?, ?, ?, ?)
|
||||||
|
ON CONFLICT (note_id, user_id) DO UPDATE SET role = excluded.role`,
|
||||||
|
noteID.String, userID, string(role), invitedBy, time.Now().Unix())
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
if !projectID.Valid || projectID.String == "" {
|
if !projectID.Valid || projectID.String == "" {
|
||||||
return nil // an invite to the instance, with no project attached
|
return nil // an invite to the instance, with no project attached
|
||||||
}
|
}
|
||||||
@@ -240,6 +290,81 @@ func (db *DB) AcceptInvite(ctx context.Context, inviteID, userID string) error {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- invitationer til én note ----------------------------------------------------
|
||||||
|
|
||||||
|
// NoteInvite is somebody who has been invited to a note and has not arrived yet.
|
||||||
|
// The email address is the whole of who they are — there is no account to name
|
||||||
|
// them by, which is the entire reason the row exists.
|
||||||
|
type NoteInvite struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Email string `json:"email"`
|
||||||
|
Role Role `json:"role"`
|
||||||
|
CreatedAt time.Time `json:"-"`
|
||||||
|
ExpiresAt time.Time `json:"-"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListNoteInvites is who has been invited to a note and not yet taken it up.
|
||||||
|
//
|
||||||
|
// The panel needs them beside the people who *are* on the note: without this, an
|
||||||
|
// invitation sent yesterday is invisible, and the owner sends it again — a second
|
||||||
|
// link to the same inbox, and no way to take either back.
|
||||||
|
//
|
||||||
|
// Expired ones are left out, the same rule the administrator's list follows: an
|
||||||
|
// invite past its date is not something anybody can act on.
|
||||||
|
func (db *DB) ListNoteInvites(ctx context.Context, noteID string) ([]NoteInvite, error) {
|
||||||
|
rows, err := db.QueryContext(ctx, `
|
||||||
|
SELECT id, email, role, created_at, expires_at
|
||||||
|
FROM invites
|
||||||
|
WHERE note_id = ? AND accepted_at IS NULL AND expires_at > ?
|
||||||
|
ORDER BY created_at`, noteID, time.Now().Unix())
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
out := []NoteInvite{}
|
||||||
|
for rows.Next() {
|
||||||
|
var i NoteInvite
|
||||||
|
var created, expires int64
|
||||||
|
if err := rows.Scan(&i.ID, &i.Email, &i.Role, &created, &expires); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
i.CreatedAt = time.Unix(created, 0).UTC()
|
||||||
|
i.ExpiresAt = time.Unix(expires, 0).UTC()
|
||||||
|
out = append(out, i)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteNoteInvite withdraws an invitation to a note, and refuses to withdraw
|
||||||
|
// anything else.
|
||||||
|
//
|
||||||
|
// The note id is part of the WHERE rather than checked beforehand: the owner has
|
||||||
|
// been established for *this* note, and one statement that can only touch this
|
||||||
|
// note's rows cannot be talked into deleting a project invite by id.
|
||||||
|
func (db *DB) DeleteNoteInvite(ctx context.Context, noteID, inviteID string) error {
|
||||||
|
res, err := db.ExecContext(ctx,
|
||||||
|
`DELETE FROM invites WHERE id = ? AND note_id = ?`, inviteID, noteID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if n, _ := res.RowsAffected(); n == 0 {
|
||||||
|
return ErrNotFound
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// PendingNoteInvite reports whether this address already has a live invitation to
|
||||||
|
// this note, so a second attempt can say so instead of sending a second link.
|
||||||
|
func (db *DB) PendingNoteInvite(ctx context.Context, noteID, email string) (bool, error) {
|
||||||
|
var n int
|
||||||
|
err := db.QueryRowContext(ctx, `
|
||||||
|
SELECT count(*) FROM invites
|
||||||
|
WHERE note_id = ? AND email = ? AND accepted_at IS NULL AND expires_at > ?`,
|
||||||
|
noteID, NormalizeEmail(email), time.Now().Unix()).Scan(&n)
|
||||||
|
return n > 0, err
|
||||||
|
}
|
||||||
|
|
||||||
// --- password resets ----------------------------------------------------------
|
// --- password resets ----------------------------------------------------------
|
||||||
|
|
||||||
// CreatePasswordReset invalidates any outstanding reset for the user before issuing
|
// CreatePasswordReset invalidates any outstanding reset for the user before issuing
|
||||||
|
|||||||
@@ -0,0 +1,116 @@
|
|||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"unicode"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MentionsIn reads the people named with an @ out of a body, and returns their
|
||||||
|
// ids in the order they are written.
|
||||||
|
//
|
||||||
|
// Slået op i navnene frem for tolket ud af teksten. Et navn kan have mellemrum,
|
||||||
|
// bindestreg og punktum i sig, og et udtryk, der skulle fange dem alle, ville
|
||||||
|
// også fange sætningen bagefter: `@Sofie i morgen` ville blive til en person, der
|
||||||
|
// hedder "Sofie i morgen", og ellers til "Sofie", alt efter hvor grådigt det var
|
||||||
|
// skrevet. Her er der ikke noget at gætte — der står et navn, eller der gør ikke.
|
||||||
|
//
|
||||||
|
// Det er også dét, der gør det forsvarligt at *dele* på: en omtale giver adgang,
|
||||||
|
// og adgang må ikke afhænge af, hvor langt et regulært udtryk valgte at læse.
|
||||||
|
//
|
||||||
|
// Længste navn først, så "@Sofie Jensen" bliver Sofie Jensen og ikke Sofie med et
|
||||||
|
// efternavn hængende bagefter — også når begge findes som konti.
|
||||||
|
func MentionsIn(body string, people []Person) []string {
|
||||||
|
if body == "" || len(people) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
lower := strings.ToLower(body)
|
||||||
|
|
||||||
|
byLength := make([]Person, len(people))
|
||||||
|
copy(byLength, people)
|
||||||
|
sort.SliceStable(byLength, func(i, j int) bool {
|
||||||
|
return len(byLength[i].Name) > len(byLength[j].Name)
|
||||||
|
})
|
||||||
|
|
||||||
|
// Hvilke tegn der allerede er læst som en del af en omtale. Uden det ville
|
||||||
|
// "@Sofie Jensen" også tælle som en omtale af Sofie, hvis begge er konti — og
|
||||||
|
// noten ville blive delt med en, der ikke står i den.
|
||||||
|
claimed := make([]bool, len(body))
|
||||||
|
found := map[string]int{} // bruger -> hvor i teksten, så rækkefølgen kan bæres
|
||||||
|
|
||||||
|
for _, p := range byLength {
|
||||||
|
name := strings.ToLower(strings.TrimSpace(p.Name))
|
||||||
|
if name == "" || p.ID == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
needle := "@" + name
|
||||||
|
for at := 0; ; {
|
||||||
|
i := strings.Index(lower[at:], needle)
|
||||||
|
if i < 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
i += at
|
||||||
|
at = i + len(needle)
|
||||||
|
|
||||||
|
end := i + len(needle)
|
||||||
|
if overlaps(claimed, i, end) || !isMention(body, i, end) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for j := i; j < end; j++ {
|
||||||
|
claimed[j] = true
|
||||||
|
}
|
||||||
|
if _, seen := found[p.ID]; !seen {
|
||||||
|
found[p.ID] = i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
out := make([]string, 0, len(found))
|
||||||
|
for id := range found {
|
||||||
|
out = append(out, id)
|
||||||
|
}
|
||||||
|
sort.Slice(out, func(i, j int) bool { return found[out[i]] < found[out[j]] })
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func overlaps(claimed []bool, from, to int) bool {
|
||||||
|
for i := from; i < to && i < len(claimed); i++ {
|
||||||
|
if claimed[i] {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// isMention er de to kanter om navnet.
|
||||||
|
//
|
||||||
|
// Foran: begyndelsen af noten eller noget, der ikke er en bogstavstavelse — så en
|
||||||
|
// e-mailadresse ikke bliver til en omtale, fordi der tilfældigvis står et navn
|
||||||
|
// efter snabel-a'et.
|
||||||
|
//
|
||||||
|
// Bagved: ikke midt i et længere ord. "@Sofies kalender" er skrevet om Sofie og
|
||||||
|
// tæller med — ejefaldets s hører til sætningen, ikke til en anden person — men
|
||||||
|
// "@Sofienberg" er et sted og ikke en, der skal have noten delt. Grænsen er sat
|
||||||
|
// ved, at et bogstav *lige* efter navnet kun må være et ejefalds-s.
|
||||||
|
func isMention(body string, from, to int) bool {
|
||||||
|
runes := []rune(body[:from])
|
||||||
|
if len(runes) > 0 {
|
||||||
|
prev := runes[len(runes)-1]
|
||||||
|
if unicode.IsLetter(prev) || unicode.IsDigit(prev) || prev == '@' {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
rest := body[to:]
|
||||||
|
if rest == "" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
next := []rune(rest)
|
||||||
|
if next[0] == 's' || next[0] == 'S' {
|
||||||
|
next = next[1:]
|
||||||
|
if len(next) == 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return !unicode.IsLetter(next[0]) && !unicode.IsDigit(next[0])
|
||||||
|
}
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestMentionsIn(t *testing.T) {
|
||||||
|
people := []Person{
|
||||||
|
{ID: "sofie", Name: "Sofie"},
|
||||||
|
{ID: "sofie-jensen", Name: "Sofie Jensen"},
|
||||||
|
{ID: "kristian", Name: "Kristian"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
body string
|
||||||
|
want []string
|
||||||
|
}{
|
||||||
|
{"ingen omtale", "En helt almindelig note om noget", nil},
|
||||||
|
{"én omtale", "@Sofie kan du kigge på det her?", []string{"sofie"}},
|
||||||
|
{"midt i en sætning", "Aftalt med @Kristian i går", []string{"kristian"}},
|
||||||
|
{"uden hensyn til store bogstaver", "@sofie ja", []string{"sofie"}},
|
||||||
|
{"to omtaler i den rækkefølge de står", "@Kristian og @Sofie", []string{"kristian", "sofie"}},
|
||||||
|
{"den samme to gange er én", "@Sofie ... og @Sofie igen", []string{"sofie"}},
|
||||||
|
// Det lange navn vinder, og det korte tælles ikke med oveni: noten deles
|
||||||
|
// med den, der står i den, og ikke også med en, der ikke gør.
|
||||||
|
{"længste navn vinder", "@Sofie Jensen kigger på det", []string{"sofie-jensen"}},
|
||||||
|
// En adresse er ikke en omtale. Ellers ville enhver note med en mailadresse
|
||||||
|
// i sig dele sig selv med den, der tilfældigvis hedder noget efter snabel-a.
|
||||||
|
{"e-mailadresse", "skriv til hej@Sofie.dk", nil},
|
||||||
|
{"ejefald tæller med", "det står i @Sofies kalender", []string{"sofie"}},
|
||||||
|
{"et længere ord gør ikke", "vi mødtes på @Sofienberg", nil},
|
||||||
|
{"ukendt navn", "@Ingen her", nil},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
got := MentionsIn(tc.body, people)
|
||||||
|
if len(got) == 0 && len(tc.want) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(got, tc.want) {
|
||||||
|
t.Errorf("MentionsIn(%q) = %v, want %v", tc.body, got, tc.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ingen mennesker, ingen omtaler: opslaget sker i navnene, så en tom liste er et
|
||||||
|
// tomt svar frem for et gæt på, hvad et @ mon betød.
|
||||||
|
func TestMentionsInWithoutPeople(t *testing.T) {
|
||||||
|
if got := MentionsIn("@Sofie hej", nil); got != nil {
|
||||||
|
t.Errorf("got %v, want nothing to resolve against", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
-- De noter, en delt note peger på, følger med delingen.
|
||||||
|
--
|
||||||
|
-- Et `[[link]]` i en note, der er delt, pegede indtil nu på noget, modtageren
|
||||||
|
-- ikke havde fået. Linket stod der, kunne ses, og førte ingen steder hen — meldt
|
||||||
|
-- af den første, der prøvede at læse en delt note, og med rette: den, der deler
|
||||||
|
-- en note, deler det, noten *siger*, og et link er en del af det, den siger.
|
||||||
|
--
|
||||||
|
-- Rækken er den samme som en almindelig deling. `linked` er den ene forskel: den
|
||||||
|
-- siger, at rækken ikke er valgt af nogen, men udledt af, hvad noten peger på.
|
||||||
|
-- Det gør to ting muligt, som en boolsk værdi ellers sjældent gør sig fortjent
|
||||||
|
-- til. Fladen kan sige *hvorfor* en person har den note — "den fulgte med" er en
|
||||||
|
-- anden sætning end "du delte den". Og udledningen kan regnes forfra hver gang:
|
||||||
|
-- de udledte rækker må slettes og skrives igen efter hver ændring, mens de
|
||||||
|
-- valgte aldrig røres. Uden skellet ville en oprydning enten lade forældede
|
||||||
|
-- delinger blive stående eller fjerne dem, ejeren selv havde sat.
|
||||||
|
--
|
||||||
|
-- Kun ejerens egne noter følger med. Et link peger på en *titel*, og titler kan
|
||||||
|
-- skrives af enhver, der må rette i noten — så hvis et link kunne hente hvad som
|
||||||
|
-- helst, ville en medredaktør kunne skrive `[[Bankoplysninger]]` og læse med.
|
||||||
|
-- Opslaget sker derfor kun blandt de noter, ejeren selv ejer, og deling af dem
|
||||||
|
-- har ejeren allerede ret til.
|
||||||
|
ALTER TABLE note_shares ADD COLUMN linked INTEGER NOT NULL DEFAULT 0;
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
-- En besked kan handle om en note.
|
||||||
|
--
|
||||||
|
-- Tabellen kunne pege på et projekt og en opgave, fordi det var de to ting, der
|
||||||
|
-- kunne ske noget med. Nu kan der også: en note, der er delt, bliver rettet af en
|
||||||
|
-- anden, og den, den er delt med, skal kunne se at det er sket — uden at åbne den
|
||||||
|
-- for at opdage det.
|
||||||
|
--
|
||||||
|
-- En søjle ved siden af de to andre frem for et generisk (kind, id)-par. De tre er
|
||||||
|
-- ikke det samme slags nul: en besked om en opgave har *også* et projekt, og en om
|
||||||
|
-- en note har måske ingen af delene. Et par ville skulle tolkes hvert sted, det
|
||||||
|
-- læses, og fremmednøglen — som er dén, der rydder beskeden op, når noten slettes
|
||||||
|
-- — kan et generisk par slet ikke have.
|
||||||
|
ALTER TABLE notifications ADD COLUMN note_id TEXT REFERENCES notes (id) ON DELETE CASCADE;
|
||||||
|
|
||||||
|
-- Beskeder om den samme note bliver slået sammen, mens de er ulæste, og opslaget
|
||||||
|
-- er nøjagtig det: min, ulæst, om denne note.
|
||||||
|
CREATE INDEX notifications_unread_by_note
|
||||||
|
ON notifications (user_id, note_id) WHERE read_at IS NULL AND note_id IS NOT NULL;
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
-- En invitation kan handle om en note.
|
||||||
|
--
|
||||||
|
-- En note kunne deles med nogen, der allerede havde en konto — og kun med dem.
|
||||||
|
-- Skulle en, der ikke havde en, læse med, skulle man først invitere dem til
|
||||||
|
-- instansen, vente på at de oprettede sig, og så finde noten frem og dele den. Tre
|
||||||
|
-- skridt og en ventetid for det, der er én sætning: "lad Sofie se den her".
|
||||||
|
--
|
||||||
|
-- Rækken er den, der allerede findes. En invitation bærer i forvejen en e-mail, en
|
||||||
|
-- rolle og et forseglet token; det eneste, der manglede, var at kunne sige, hvad
|
||||||
|
-- den er en invitation *til*. project_id sagde det for projekter, og note_id siger
|
||||||
|
-- det nu for noter.
|
||||||
|
--
|
||||||
|
-- To søjler frem for én kolonne med et id og en art ved siden af — samme valg som
|
||||||
|
-- notifications traf i 0033, og af samme grund: fremmednøglen. ON DELETE CASCADE
|
||||||
|
-- er dén, der rydder invitationen væk, når noten slettes, inden nogen når at tage
|
||||||
|
-- imod en invitation til noget, der ikke er der længere. Et generisk par kan ikke
|
||||||
|
-- have den nøgle, og oprydningen skulle så skrives i kode, der huskede at køre.
|
||||||
|
--
|
||||||
|
-- De to udelukker hinanden i praksis, men det står ikke som en CHECK: en
|
||||||
|
-- invitation uden nogen af delene er den gyldige "kom med på instansen", og en
|
||||||
|
-- regel, der skulle tillade nul eller én af to, ville skulle skrives om hver gang
|
||||||
|
-- der kom en tredje slags ting at invitere til.
|
||||||
|
ALTER TABLE invites ADD COLUMN note_id TEXT REFERENCES notes (id) ON DELETE CASCADE;
|
||||||
|
|
||||||
|
-- Panelet under en note spørger "hvem er inviteret til den her, og har ikke taget
|
||||||
|
-- imod endnu" hver gang, det åbnes. Det er opslaget, og det er derfor, det er
|
||||||
|
-- indekset. Kun de uafklarede: en invitation, der er taget imod, er en deling nu
|
||||||
|
-- og står i note_shares.
|
||||||
|
CREATE INDEX invites_pending_by_note
|
||||||
|
ON invites (note_id) WHERE accepted_at IS NULL AND note_id IS NOT NULL;
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
-- En personlig adresse, andre programmer kan skubbe en opgave ind ad.
|
||||||
|
--
|
||||||
|
-- Der var to veje ind i forvejen, og ingen af dem passer til "gem den her, mens
|
||||||
|
-- jeg står med telefonen i hånden". API-tokenet giver adgang til alt og skal have
|
||||||
|
-- en JSON-krop skrevet rigtigt; mailadressen virker først, når nogen har sat en
|
||||||
|
-- mailserver op, og går gennem en indbakke, der kan være minutter om det. Det, der
|
||||||
|
-- manglede, var en URL, man kan smide en linje tekst efter.
|
||||||
|
--
|
||||||
|
-- Sit eget token frem for at låne mailens. De to er den samme slags hemmelighed,
|
||||||
|
-- men de bliver kompromitteret hver for sig: en URL, der har ligget i en genvej på
|
||||||
|
-- en telefon, der blev væk, skal kunne skiftes uden at mailadressen — som står i
|
||||||
|
-- andres adressebøger — skifter med. Og omvendt.
|
||||||
|
--
|
||||||
|
-- Ikke et API-token. Et token herfra kan én ting: lave en opgave i den persons
|
||||||
|
-- indbakke. Det er hele forskellen på en hemmelighed, man kan lægge i et script på
|
||||||
|
-- en anden maskine, og en, man ikke kan.
|
||||||
|
ALTER TABLE users ADD COLUMN hook_token TEXT;
|
||||||
|
|
||||||
|
-- Opslaget er "hvem er det her token", og det er også dét, der skal være entydigt:
|
||||||
|
-- to konti med det samme token er to konti, en opgave kan lande i.
|
||||||
|
CREATE UNIQUE INDEX idx_users_hook_token ON users (hook_token) WHERE hook_token IS NOT NULL;
|
||||||
@@ -4,6 +4,8 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"database/sql"
|
"database/sql"
|
||||||
"errors"
|
"errors"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -131,3 +133,280 @@ func (db *DB) NotesSharedWith(ctx context.Context, userID string, noteIDs []stri
|
|||||||
}
|
}
|
||||||
return out, rows.Err()
|
return out, rows.Err()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- de noter, en delt note peger på ---------------------------------------------
|
||||||
|
|
||||||
|
// LinkedShare is one note that followed a share: which note, what it is called,
|
||||||
|
// and which of the owner's shared notes brought it. The panel shows all three —
|
||||||
|
// "Prisliste came along with Aftale om levering" is a sentence somebody can act
|
||||||
|
// on, where a bare id is not.
|
||||||
|
type LinkedShare struct {
|
||||||
|
NoteID string `json:"note_id"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
ViaID string `json:"via_id"`
|
||||||
|
Via string `json:"via"`
|
||||||
|
Role Role `json:"role"`
|
||||||
|
UserID string `json:"user_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Hvor langt en deling må brede sig.
|
||||||
|
//
|
||||||
|
// En note, der peger på en note, der peger på en note, er stadig én ting at læse,
|
||||||
|
// og den skal følge med. Men noter kan pege i ring og i vifte, og "del denne ene
|
||||||
|
// note" må ikke kunne blive til fire hundrede. Loftet er ikke en optimering: det
|
||||||
|
// er den grænse, hvor en deling holder op med at være noget, ejeren kan overskue.
|
||||||
|
const linkedShareLimit = 100
|
||||||
|
|
||||||
|
// SyncLinkedShares regner de udledte delinger forfra for alt, hvad én person ejer.
|
||||||
|
//
|
||||||
|
// Kaldt efter enhver af ejerens egne handlinger, der kan flytte svaret: en deling,
|
||||||
|
// en fjernet deling, og en gemning, der har ændret på det, noten peger på. Regnet
|
||||||
|
// forfra frem for rettet til, fordi det er den samme kode hver gang og derfor det
|
||||||
|
// samme resultat hver gang — en tilføjelse og en fjernelse er ikke to veje gennem
|
||||||
|
// koden, men det samme kald med et andet udgangspunkt.
|
||||||
|
//
|
||||||
|
// Kun *direkte* delinger er udgangspunkt. En note i et delt projekt er delt af
|
||||||
|
// projektet, og projektets folk kan se projektets noter; det er en anden vej ind,
|
||||||
|
// med sine egne regler, og den blander sig ikke her.
|
||||||
|
//
|
||||||
|
// Returnerer, hvad der nu følger med, så kalderen kan sige det. Det er meningen at
|
||||||
|
// det bliver sagt: en deling, der stille tager tre noter mere med, er ikke til at
|
||||||
|
// overskue, uanset hvor rigtigt den gør det.
|
||||||
|
func (db *DB) SyncLinkedShares(ctx context.Context, ownerID string) ([]LinkedShare, error) {
|
||||||
|
if ownerID == "" {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Har personen ikke delt noget, er der intet at regne — og det er de fleste,
|
||||||
|
// det meste af tiden. Uden det her ville hvert eneste klik i notelisten åbne
|
||||||
|
// hver eneste note for at finde ud af, at svaret er tomt: fladen spørger til
|
||||||
|
// delingerne, hver gang man vælger en note, man selv ejer.
|
||||||
|
//
|
||||||
|
// Ét spørgsmål dækker begge halvdele. Er der ingen rækker overhovedet, er der
|
||||||
|
// hverken en deling at brede ud eller en udledt række at rydde op efter.
|
||||||
|
var anyShare int
|
||||||
|
if err := db.QueryRowContext(ctx, `
|
||||||
|
SELECT EXISTS(
|
||||||
|
SELECT 1 FROM note_shares s
|
||||||
|
JOIN notes n ON n.id = s.note_id
|
||||||
|
WHERE n.created_by = ?)`, ownerID).Scan(&anyShare); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if anyShare == 0 {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ejerens egne noter, åbnet. Titlerne er forseglet i basen, og et link peger på
|
||||||
|
// en titel — så der er ikke noget opslag at lave i SQL. Målt andetsteds i denne
|
||||||
|
// fil: tolv hundrede noter koster nogle og tredive millisekunder at åbne, og det
|
||||||
|
// her kører kun, når ejeren selv har gjort noget.
|
||||||
|
mine, err := db.notesWhere(ctx, `WHERE created_by = ? AND deleted_at IS NULL`, ownerID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
byTitle := map[string]string{}
|
||||||
|
title := map[string]string{}
|
||||||
|
for _, n := range mine {
|
||||||
|
title[n.ID] = n.Title
|
||||||
|
key := strings.ToLower(strings.TrimSpace(n.Title))
|
||||||
|
// Den første vinder, og listen kommer sorteret med den senest rørte først:
|
||||||
|
// to noter med samme titel er sjældent, og når det sker, er den, man skrev
|
||||||
|
// sidst, den, man mente.
|
||||||
|
if key != "" {
|
||||||
|
if _, taken := byTitle[key]; !taken {
|
||||||
|
byTitle[key] = n.ID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Hvad hver note peger på, i ét spørgsmål frem for ét pr. note.
|
||||||
|
links := map[string][]string{}
|
||||||
|
rows, err := db.QueryContext(ctx, `
|
||||||
|
SELECT l.note_id, l.target_id
|
||||||
|
FROM note_links l
|
||||||
|
JOIN notes n ON n.id = l.note_id
|
||||||
|
WHERE l.kind = 'note' AND n.created_by = ? AND n.deleted_at IS NULL`, ownerID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
for rows.Next() {
|
||||||
|
var from, target string
|
||||||
|
if err := rows.Scan(&from, &target); err != nil {
|
||||||
|
rows.Close()
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
links[from] = append(links[from], target)
|
||||||
|
}
|
||||||
|
rows.Close()
|
||||||
|
if err := rows.Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// De delinger, ejeren selv har sat.
|
||||||
|
type grant struct{ noteID, userID string }
|
||||||
|
direct := map[grant]Role{}
|
||||||
|
rows, err = db.QueryContext(ctx, `
|
||||||
|
SELECT s.note_id, s.user_id, s.role
|
||||||
|
FROM note_shares s
|
||||||
|
JOIN notes n ON n.id = s.note_id
|
||||||
|
WHERE s.linked = 0 AND n.created_by = ? AND n.deleted_at IS NULL`, ownerID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
for rows.Next() {
|
||||||
|
var g grant
|
||||||
|
var role Role
|
||||||
|
if err := rows.Scan(&g.noteID, &g.userID, &role); err != nil {
|
||||||
|
rows.Close()
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if role.Valid() {
|
||||||
|
direct[g] = role
|
||||||
|
}
|
||||||
|
}
|
||||||
|
rows.Close()
|
||||||
|
if err := rows.Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Vandringen. Pr. person, fordi det er personen, delingen handler om: to
|
||||||
|
// forskellige mennesker kan have to forskellige noter og derfor to forskellige
|
||||||
|
// vifter ud fra dem.
|
||||||
|
wanted := map[grant]LinkedShare{}
|
||||||
|
perUser := map[string][]grant{}
|
||||||
|
for g := range direct {
|
||||||
|
perUser[g.userID] = append(perUser[g.userID], g)
|
||||||
|
}
|
||||||
|
for userID, roots := range perUser {
|
||||||
|
seen := map[string]bool{}
|
||||||
|
type step struct {
|
||||||
|
noteID string
|
||||||
|
via string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Medredaktør først, læser bagefter, og hver runde tømt for sig.
|
||||||
|
//
|
||||||
|
// En note kan nås fra to delte noter med hver sin rolle, og så skal den
|
||||||
|
// stærkeste gælde. Én kø med det hele i ville afgøre det på afstand frem for
|
||||||
|
// på rolle: et barnebarn af en redigerbar note ville tabe til et barn af en
|
||||||
|
// læsbar, fordi det stod længere bagude i køen. To runder gør reglen til
|
||||||
|
// rækkefølgen — er noten allerede nået som redigerbar, ser den anden runde
|
||||||
|
// den ikke.
|
||||||
|
for _, role := range []Role{RoleEditor, RoleViewer} {
|
||||||
|
var queue []step
|
||||||
|
for _, g := range roots {
|
||||||
|
if direct[g] != role || seen[g.noteID] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
seen[g.noteID] = true
|
||||||
|
queue = append(queue, step{noteID: g.noteID, via: g.noteID})
|
||||||
|
}
|
||||||
|
for len(queue) > 0 && len(seen) <= linkedShareLimit {
|
||||||
|
cur := queue[0]
|
||||||
|
queue = queue[1:]
|
||||||
|
for _, target := range links[cur.noteID] {
|
||||||
|
id, ok := byTitle[strings.ToLower(strings.TrimSpace(target))]
|
||||||
|
// Et link, der ikke rammer en af ejerens egne noter, er enten
|
||||||
|
// dødt eller peger på en andens note. Ingen af delene er ejerens
|
||||||
|
// at dele.
|
||||||
|
if !ok || seen[id] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
seen[id] = true
|
||||||
|
// Rollen arves fra den note, man kom fra. En medredaktør på en
|
||||||
|
// note bliver medredaktør på det, den peger på: teksten er én
|
||||||
|
// ting at arbejde i, og et link midt i den er ikke en grænse.
|
||||||
|
if _, isDirect := direct[grant{noteID: id, userID: userID}]; !isDirect {
|
||||||
|
wanted[grant{noteID: id, userID: userID}] = LinkedShare{
|
||||||
|
NoteID: id,
|
||||||
|
Title: title[id],
|
||||||
|
ViaID: cur.via,
|
||||||
|
Via: title[cur.via],
|
||||||
|
Role: role,
|
||||||
|
UserID: userID,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
queue = append(queue, step{noteID: id, via: cur.via})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Skrevet i én transaktion: mellem sletningen og skrivningen står basen med
|
||||||
|
// færre delinger, end den skal, og det er ikke et vindue nogen skal kunne læse i.
|
||||||
|
err = db.Tx(ctx, func(tx *sql.Tx) error {
|
||||||
|
if _, err := tx.ExecContext(ctx, `
|
||||||
|
DELETE FROM note_shares
|
||||||
|
WHERE linked = 1
|
||||||
|
AND note_id IN (SELECT id FROM notes WHERE created_by = ?)`, ownerID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for g, l := range wanted {
|
||||||
|
// DO NOTHING ved sammenstød: en direkte deling på den samme note er
|
||||||
|
// ejerens eget valg og har forrang. Den kan ikke nå herned — den er
|
||||||
|
// sorteret fra ovenfor — men reglen skal stå dér, hvor rækken skrives,
|
||||||
|
// ikke kun dér, hvor den udregnes.
|
||||||
|
if _, err := tx.ExecContext(ctx, `
|
||||||
|
INSERT INTO note_shares (note_id, user_id, role, created_by, created_at, linked)
|
||||||
|
VALUES (?, ?, ?, ?, ?, 1)
|
||||||
|
ON CONFLICT (note_id, user_id) DO NOTHING`,
|
||||||
|
g.noteID, g.userID, l.Role, ownerID, time.Now().Unix()); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
out := make([]LinkedShare, 0, len(wanted))
|
||||||
|
for _, l := range wanted {
|
||||||
|
out = append(out, l)
|
||||||
|
}
|
||||||
|
sort.Slice(out, func(i, j int) bool {
|
||||||
|
if out[i].UserID != out[j].UserID {
|
||||||
|
return out[i].UserID < out[j].UserID
|
||||||
|
}
|
||||||
|
return strings.ToLower(out[i].Title) < strings.ToLower(out[j].Title)
|
||||||
|
})
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// NoteAudience is everybody who can see a note: its owner, the people it is shared
|
||||||
|
// with — chosen or followed along a link — and the members of the project it is
|
||||||
|
// filed in.
|
||||||
|
//
|
||||||
|
// Ét spørgsmål frem for tre, fordi svaret skal være en mængde og ikke tre lister,
|
||||||
|
// der skal lægges sammen bagefter: en person kan både eje projektet og have noten
|
||||||
|
// delt direkte, og to beskeder om den samme rettelse er én for mange.
|
||||||
|
//
|
||||||
|
// The note's own row is joined rather than passed in, so a caller cannot ask about
|
||||||
|
// a note that has been deleted and get an audience for it anyway.
|
||||||
|
func (db *DB) NoteAudience(ctx context.Context, noteID string) ([]string, error) {
|
||||||
|
rows, err := db.QueryContext(ctx, `
|
||||||
|
SELECT created_by FROM notes WHERE id = ? AND deleted_at IS NULL AND created_by IS NOT NULL
|
||||||
|
UNION
|
||||||
|
SELECT user_id FROM note_shares WHERE note_id = ?
|
||||||
|
UNION
|
||||||
|
SELECT p.owner_id FROM notes n JOIN projects p ON p.id = n.project_id
|
||||||
|
WHERE n.id = ? AND n.deleted_at IS NULL AND p.deleted_at IS NULL
|
||||||
|
UNION
|
||||||
|
SELECT m.user_id FROM notes n JOIN project_members m ON m.project_id = n.project_id
|
||||||
|
WHERE n.id = ? AND n.deleted_at IS NULL`,
|
||||||
|
noteID, noteID, noteID, noteID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
var out []string
|
||||||
|
for rows.Next() {
|
||||||
|
var id string
|
||||||
|
if err := rows.Scan(&id); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, id)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ type Notification struct {
|
|||||||
ActorName string
|
ActorName string
|
||||||
ProjectID string
|
ProjectID string
|
||||||
TaskID string
|
TaskID string
|
||||||
|
NoteID string
|
||||||
Kind string
|
Kind string
|
||||||
Title string
|
Title string
|
||||||
Body string
|
Body string
|
||||||
@@ -32,25 +33,54 @@ func (db *DB) CreateNotification(ctx context.Context, n *Notification) error {
|
|||||||
n.CreatedAt = time.Now().UTC()
|
n.CreatedAt = time.Now().UTC()
|
||||||
|
|
||||||
_, err := db.ExecContext(ctx,
|
_, err := db.ExecContext(ctx,
|
||||||
`INSERT INTO notifications (id, user_id, actor_id, project_id, task_id, kind,
|
`INSERT INTO notifications (id, user_id, actor_id, project_id, task_id, note_id, kind,
|
||||||
title, body, created_at)
|
title, body, created_at)
|
||||||
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)`,
|
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`,
|
||||||
n.ID, n.UserID, nullString(n.ActorID), nullString(n.ProjectID),
|
n.ID, n.UserID, nullString(n.ActorID), nullString(n.ProjectID),
|
||||||
nullString(n.TaskID), n.Kind, n.Title, n.Body, n.CreatedAt.Unix())
|
nullString(n.TaskID), nullString(n.NoteID), n.Kind, n.Title, n.Body, n.CreatedAt.Unix())
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// BumpUnreadNoteNotification folds a second change to the same note into the first,
|
||||||
|
// and says whether it found one to fold into.
|
||||||
|
//
|
||||||
|
// A note is saved on a typing pause, so writing a row per save would turn one
|
||||||
|
// person editing one note for five minutes into a column of twenty identical
|
||||||
|
// lines. Slået sammen, mens beskeden er ulæst: den rykker op som ny og siger hvem
|
||||||
|
// der rørte den sidst.
|
||||||
|
//
|
||||||
|
// Kun mens den er ulæst — og det er hele reglen. Har man læst "Andreas rettede
|
||||||
|
// Aftalen" og går videre, er den næste rettelse en ny ting at få at vide, ikke en
|
||||||
|
// gentagelse af noget, man allerede har set.
|
||||||
|
func (db *DB) BumpUnreadNoteNotification(ctx context.Context, userID, noteID, actorID, title, body string) (bool, error) {
|
||||||
|
res, err := db.ExecContext(ctx, `
|
||||||
|
UPDATE notifications
|
||||||
|
SET created_at = ?, actor_id = ?, title = ?, body = ?
|
||||||
|
WHERE user_id = ? AND note_id = ? AND kind = 'note.changed' AND read_at IS NULL`,
|
||||||
|
time.Now().UTC().Unix(), nullString(actorID), title, body, userID, noteID)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
n, err := res.RowsAffected()
|
||||||
|
return n > 0, err
|
||||||
|
}
|
||||||
|
|
||||||
func (db *DB) ListNotifications(ctx context.Context, userID string, limit int) ([]Notification, error) {
|
func (db *DB) ListNotifications(ctx context.Context, userID string, limit int) ([]Notification, error) {
|
||||||
if limit <= 0 || limit > 100 {
|
if limit <= 0 || limit > 100 {
|
||||||
limit = 30
|
limit = 30
|
||||||
}
|
}
|
||||||
rows, err := db.QueryContext(ctx, `
|
rows, err := db.QueryContext(ctx, `
|
||||||
SELECT n.id, n.user_id, n.actor_id, COALESCE(u.name, ''), n.project_id, n.task_id,
|
SELECT n.id, n.user_id, n.actor_id, COALESCE(u.name, ''), n.project_id, n.task_id,
|
||||||
n.kind, n.title, n.body, n.read_at, n.created_at
|
n.note_id, n.kind, n.title, n.body, n.read_at, n.created_at
|
||||||
FROM notifications n
|
FROM notifications n
|
||||||
LEFT JOIN users u ON u.id = n.actor_id
|
LEFT JOIN users u ON u.id = n.actor_id
|
||||||
WHERE n.user_id = ?
|
WHERE n.user_id = ?
|
||||||
ORDER BY n.created_at DESC
|
-- Tiden er sekunder, og to ting kan ske i det samme sekund: en note bliver
|
||||||
|
-- delt og rettet i samme håndbevægelse. Uden andet at falde tilbage på
|
||||||
|
-- afgør basen selv, hvilken der står øverst, og klokken viser dem i den
|
||||||
|
-- rækkefølge, den nu engang fandt dem i. id'et er tidsordnet, så det er
|
||||||
|
-- den rigtige afgørelse at give den — og den er den samme hver gang.
|
||||||
|
ORDER BY n.created_at DESC, n.id DESC
|
||||||
LIMIT ?`, userID, limit)
|
LIMIT ?`, userID, limit)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -60,14 +90,15 @@ func (db *DB) ListNotifications(ctx context.Context, userID string, limit int) (
|
|||||||
out := []Notification{}
|
out := []Notification{}
|
||||||
for rows.Next() {
|
for rows.Next() {
|
||||||
var n Notification
|
var n Notification
|
||||||
var actorID, projectID, taskID sql.NullString
|
var actorID, projectID, taskID, noteID sql.NullString
|
||||||
var readAt sql.NullInt64
|
var readAt sql.NullInt64
|
||||||
var created int64
|
var created int64
|
||||||
if err := rows.Scan(&n.ID, &n.UserID, &actorID, &n.ActorName, &projectID,
|
if err := rows.Scan(&n.ID, &n.UserID, &actorID, &n.ActorName, &projectID,
|
||||||
&taskID, &n.Kind, &n.Title, &n.Body, &readAt, &created); err != nil {
|
&taskID, ¬eID, &n.Kind, &n.Title, &n.Body, &readAt, &created); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
n.ActorID, n.ProjectID, n.TaskID = actorID.String, projectID.String, taskID.String
|
n.ActorID, n.ProjectID = actorID.String, projectID.String
|
||||||
|
n.TaskID, n.NoteID = taskID.String, noteID.String
|
||||||
if readAt.Valid {
|
if readAt.Valid {
|
||||||
v := time.Unix(readAt.Int64, 0).UTC()
|
v := time.Unix(readAt.Int64, 0).UTC()
|
||||||
n.ReadAt = &v
|
n.ReadAt = &v
|
||||||
@@ -299,6 +330,52 @@ func (db *DB) SetMailToken(ctx context.Context, userID, token string) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- krogen ind i indbakken ------------------------------------------------------
|
||||||
|
|
||||||
|
// EnsureHookToken returns the token in the person's webhook URL, minting one the
|
||||||
|
// first time it is asked for.
|
||||||
|
//
|
||||||
|
// Sit eget token frem for mailens. De to er den samme slags hemmelighed, men de
|
||||||
|
// slipper ud hver for sig: en URL, der har ligget i en genvej på en telefon, der
|
||||||
|
// blev væk, skal kunne skiftes uden at mailadressen — som står i andres
|
||||||
|
// adressebøger — skifter med.
|
||||||
|
func (db *DB) EnsureHookToken(ctx context.Context, userID string) (string, error) {
|
||||||
|
var token sql.NullString
|
||||||
|
err := db.QueryRowContext(ctx, `SELECT hook_token FROM users WHERE id = ?`, userID).Scan(&token)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if token.Valid && token.String != "" {
|
||||||
|
return token.String, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
fresh, err := auth.NewToken()
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if err := db.SetHookToken(ctx, userID, fresh); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return fresh, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (db *DB) SetHookToken(ctx context.Context, userID, token string) error {
|
||||||
|
_, err := db.ExecContext(ctx,
|
||||||
|
`UPDATE users SET hook_token = ?, updated_at = ? WHERE id = ?`,
|
||||||
|
token, time.Now().Unix(), userID)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// UserByHookToken is who a webhook call is on behalf of. Tokenet er hele
|
||||||
|
// legitimationen, så et tomt et er et nej med det samme frem for et opslag, der
|
||||||
|
// kunne ramme en række, hvor søjlen aldrig er sat.
|
||||||
|
func (db *DB) UserByHookToken(ctx context.Context, token string) (*User, error) {
|
||||||
|
if token == "" {
|
||||||
|
return nil, ErrNotFound
|
||||||
|
}
|
||||||
|
return db.scanUser(ctx, `SELECT `+userColumns+` FROM users WHERE hook_token = ?`, token)
|
||||||
|
}
|
||||||
|
|
||||||
func (db *DB) UserByMailToken(ctx context.Context, token string) (*User, error) {
|
func (db *DB) UserByMailToken(ctx context.Context, token string) (*User, error) {
|
||||||
if token == "" {
|
if token == "" {
|
||||||
return nil, ErrNotFound
|
return nil, ErrNotFound
|
||||||
|
|||||||
@@ -51,6 +51,8 @@ nav:
|
|||||||
- Signing in: signing-in.md
|
- Signing in: signing-in.md
|
||||||
- Quick add: quick-add.md
|
- Quick add: quick-add.md
|
||||||
- Notes: notes.md
|
- Notes: notes.md
|
||||||
|
- Notifications: notifications.md
|
||||||
|
- Opening links: links.md
|
||||||
- Filters: filters.md
|
- Filters: filters.md
|
||||||
- Importing from Todoist: import.md
|
- Importing from Todoist: import.md
|
||||||
- Connecting things:
|
- Connecting things:
|
||||||
@@ -60,6 +62,8 @@ nav:
|
|||||||
- Mailboxes: mailboxes.md
|
- Mailboxes: mailboxes.md
|
||||||
- Claude (MCP): mcp.md
|
- Claude (MCP): mcp.md
|
||||||
- AI features: ai.md
|
- AI features: ai.md
|
||||||
|
- Privacy:
|
||||||
|
- The install count: beacon.md
|
||||||
# openapi.yaml is deliberately not in the nav: MkDocs copies it to the site as a
|
# openapi.yaml is deliberately not in the nav: MkDocs copies it to the site as a
|
||||||
# file, and api.md links to it. A nav entry expects a page to render.
|
# file, and api.md links to it. A nav entry expects a page to render.
|
||||||
- Reference:
|
- Reference:
|
||||||
|
|||||||
@@ -992,12 +992,22 @@
|
|||||||
<figure class="shot">
|
<figure class="shot">
|
||||||
<img
|
<img
|
||||||
src="screenshots/themes.webp"
|
src="screenshots/themes.webp"
|
||||||
alt="The settings page showing five themes as swatches and, below them, four looks written in the typeface each one selects."
|
alt="The settings page showing six themes as swatches and, below them, four looks written in the typeface each one selects."
|
||||||
width="1400"
|
width="1400"
|
||||||
height="900"
|
height="900"
|
||||||
loading="lazy"
|
loading="lazy"
|
||||||
/>
|
/>
|
||||||
<figcaption>Five themes and four looks: how bright, and how it reads.</figcaption>
|
<figcaption>Six themes and four looks: how bright, and how it reads.</figcaption>
|
||||||
|
</figure>
|
||||||
|
<figure class="shot">
|
||||||
|
<img
|
||||||
|
src="screenshots/notes-charcoal.webp"
|
||||||
|
alt="Notes in the Charcoal theme: a warm near-black modelled on Apple Notes, the note list on the left and a note open on the right, with amber where the accent green usually is."
|
||||||
|
width="1400"
|
||||||
|
height="900"
|
||||||
|
loading="lazy"
|
||||||
|
/>
|
||||||
|
<figcaption>Charcoal — the newest theme, a warm near-black after Apple Notes, amber for the accent.</figcaption>
|
||||||
</figure>
|
</figure>
|
||||||
<figure class="shot">
|
<figure class="shot">
|
||||||
<img
|
<img
|
||||||
@@ -1040,6 +1050,75 @@
|
|||||||
<figcaption>Integrations: your mailbox, your calendar feed, your address.</figcaption>
|
<figcaption>Integrations: your mailbox, your calendar feed, your address.</figcaption>
|
||||||
</figure>
|
</figure>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<h3 class="sub">Six themes, the same day</h3>
|
||||||
|
<p class="muted">
|
||||||
|
Three dark and three light — a property of the screen you are sitting at, a
|
||||||
|
laptop in the sun and a monitor in a dark room wanting different answers. The
|
||||||
|
typeface and how tight it sits are chosen apart from them.
|
||||||
|
</p>
|
||||||
|
<div class="shots">
|
||||||
|
<figure class="shot">
|
||||||
|
<img
|
||||||
|
src="screenshots/theme-northern-lights.webp"
|
||||||
|
alt="The Today view in the Northern lights theme: dark, with a green accent."
|
||||||
|
width="1400"
|
||||||
|
height="900"
|
||||||
|
loading="lazy"
|
||||||
|
/>
|
||||||
|
<figcaption>Northern lights — dark, a green accent. The default.</figcaption>
|
||||||
|
</figure>
|
||||||
|
<figure class="shot">
|
||||||
|
<img
|
||||||
|
src="screenshots/theme-charcoal.webp"
|
||||||
|
alt="The Today view in the Charcoal theme: a warm near-black modelled on Apple Notes, with amber for the accent."
|
||||||
|
width="1400"
|
||||||
|
height="900"
|
||||||
|
loading="lazy"
|
||||||
|
/>
|
||||||
|
<figcaption>Charcoal — a warm near-black after Apple Notes, amber accent.</figcaption>
|
||||||
|
</figure>
|
||||||
|
<figure class="shot">
|
||||||
|
<img
|
||||||
|
src="screenshots/theme-dusk.webp"
|
||||||
|
alt="The Today view in the Dusk theme: dark and warm, with an amber accent."
|
||||||
|
width="1400"
|
||||||
|
height="900"
|
||||||
|
loading="lazy"
|
||||||
|
/>
|
||||||
|
<figcaption>Dusk — dark and warm.</figcaption>
|
||||||
|
</figure>
|
||||||
|
<figure class="shot">
|
||||||
|
<img
|
||||||
|
src="screenshots/theme-daylight.webp"
|
||||||
|
alt="The Today view in the Daylight theme: light and coolly neutral."
|
||||||
|
width="1400"
|
||||||
|
height="900"
|
||||||
|
loading="lazy"
|
||||||
|
/>
|
||||||
|
<figcaption>Daylight — light and coolly neutral.</figcaption>
|
||||||
|
</figure>
|
||||||
|
<figure class="shot">
|
||||||
|
<img
|
||||||
|
src="screenshots/theme-paper.webp"
|
||||||
|
alt="The Today view in the Paper theme: light and warm, like paper."
|
||||||
|
width="1400"
|
||||||
|
height="900"
|
||||||
|
loading="lazy"
|
||||||
|
/>
|
||||||
|
<figcaption>Paper — light and warm, like paper.</figcaption>
|
||||||
|
</figure>
|
||||||
|
<figure class="shot">
|
||||||
|
<img
|
||||||
|
src="screenshots/theme-contrast.webp"
|
||||||
|
alt="The Today view in the Contrast theme: black on white, for bright light."
|
||||||
|
width="1400"
|
||||||
|
height="900"
|
||||||
|
loading="lazy"
|
||||||
|
/>
|
||||||
|
<figcaption>Contrast — black on white, for bright light.</figcaption>
|
||||||
|
</figure>
|
||||||
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id="features">
|
<section id="features">
|
||||||
@@ -1120,6 +1199,15 @@
|
|||||||
by itself — without touching when it is actually due.
|
by itself — without touching when it is actually due.
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="cell">
|
||||||
|
<h3>Holds through a drop</h3>
|
||||||
|
<p>
|
||||||
|
A tunnel, a lift, a base station handing over — the app does not go
|
||||||
|
blank when the signal does. A save you make rides out a few seconds of
|
||||||
|
no connection and goes through when it comes back, and a reload opens
|
||||||
|
from what it last saw rather than the browser's offline page.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<p class="group-label">Connected to what you already use</p>
|
<p class="group-label">Connected to what you already use</p>
|
||||||
@@ -1154,9 +1242,10 @@
|
|||||||
<h3>Your mail, as an inbox</h3>
|
<h3>Your mail, as an inbox</h3>
|
||||||
<p>
|
<p>
|
||||||
Star a mail in Gmail, or flag one over IMAP in iCloud or Fastmail, and
|
Star a mail in Gmail, or flag one over IMAP in iCloud or Fastmail, and
|
||||||
it becomes a task. Forward one to your own address instead and the
|
it becomes a task — and the star or flag comes off once it has, so a
|
||||||
subject is parsed like anything else you type. One way: unstarring it
|
starred inbox empties as the tasks are made instead of only filling up.
|
||||||
later does nothing to the task you made.
|
Forward one to your own address instead and the subject is parsed like
|
||||||
|
anything else you type.
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="cell">
|
<div class="cell">
|
||||||
@@ -1237,6 +1326,25 @@
|
|||||||
<a href="https://github.com/kristianwind/verdande/releases">the releases page</a>.
|
<a href="https://github.com/kristianwind/verdande/releases">the releases page</a>.
|
||||||
</p>
|
</p>
|
||||||
<ul class="lately">
|
<ul class="lately">
|
||||||
|
<li>
|
||||||
|
<span class="ver">0.42</span>
|
||||||
|
A sixth theme, <strong>Charcoal</strong> — a warm near-black after Apple
|
||||||
|
Notes, with amber for the accent. And the app now holds through a short
|
||||||
|
network drop: a save rides out a few seconds of no signal, and a reload
|
||||||
|
opens from what it last saw rather than the browser's offline page.
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<span class="ver">0.42</span>
|
||||||
|
A starred Gmail message loses its star once it has become a task, the way
|
||||||
|
a flagged IMAP mail already did — so a starred inbox empties itself as the
|
||||||
|
tasks are made instead of only filling up.
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<span class="ver">0.42</span>
|
||||||
|
Notes read as three lines, the last one the project they are filed under;
|
||||||
|
the calendar lightened to pastel days with today marked at the top; and
|
||||||
|
two-factor set-up shows a QR code to scan.
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<span class="ver">0.41</span>
|
<span class="ver">0.41</span>
|
||||||
A task you have delegated is marked where you meet it, not only on the
|
A task you have delegated is marked where you meet it, not only on the
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 25 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 66 KiB |
|
Before Width: | Height: | Size: 63 KiB After Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 49 KiB |
|
After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 48 KiB |
|
After Width: | Height: | Size: 42 KiB |