Repository navigation
docs: add outpost engineering handbook - #15865
maximevast wants to merge 1 commit into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 2 files
Confidence score: 3/5
outpost.mdxsays the state hash has a 24-hour TTL, but the Lua scripts set no TTL, so it persists indefinitely and the footprint guidance is misleading. Align the doc with actual behavior or add the TTL to the scripts.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="handbook/engineering/design-documents/outpost.mdx">
<violation number="1" location="handbook/engineering/design-documents/outpost.mdx:44">
P2: According to the linked Linear issue PLR-349, the footprint section depends on TTLs, and this doc states a 24 h TTL on the state hash. The Lua scripts never set one, so the state hash persists indefinitely. Either add the expiry in the scripts or correct the lifetime, the READ_STATE description, and the 'State expired after 24 h idle' failure mode.</violation>
</file>
Reply with feedback, questions, or to request a fix.
View guided diff | Turn on auto-fix | Re-trigger cubic
|
|
||
| | Key | Content | Lifetime | | ||
| |---|---|---| | ||
| | `outpost:v1:state:<identity>` | A hash: see the fields below | 24 h after the last script touched it | |
There was a problem hiding this comment.
P2: According to the linked Linear issue PLR-349, the footprint section depends on TTLs, and this doc states a 24 h TTL on the state hash. The Lua scripts never set one, so the state hash persists indefinitely. Either add the expiry in the scripts or correct the lifetime, the READ_STATE description, and the 'State expired after 24 h idle' failure mode.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At handbook/engineering/design-documents/outpost.mdx, line 44:
<comment>According to the linked Linear issue PLR-349, the footprint section depends on TTLs, and this doc states a 24 h TTL on the state hash. The Lua scripts never set one, so the state hash persists indefinitely. Either add the expiry in the scripts or correct the lifetime, the READ_STATE description, and the 'State expired after 24 h idle' failure mode.</comment>
<file context>
@@ -0,0 +1,169 @@
+
+| Key | Content | Lifetime |
+|---|---|---|
+| `outpost:v1:state:<identity>` | A hash: see the fields below | 24 h after the last script touched it |
+| `outpost:v1:pending:<identity>:<bucket_start>` | A hash: `external_id` to the event's value, or empty for a count | 65 min after the last write |
+| `outpost:v1:<db>:updates` | Pub/sub channel: `{customer, bucket}` after a write, `{customer, state}` after a confirmation or a snapshot | No storage |
</file context>
There was a problem hiding this comment.
wrong, lua script now have a 24h ttl.
There was a problem hiding this comment.
No blocking issues remain. Requires human review: Adds the Outpost engineering handbook and navigation entry; docs-only change, but the disputed 24h TTL claim cannot be verified from this diff, so the document's accuracy needs human sign-off.
Summary
Related Issue: #
What
Why
How
Checklist
uv run task lint && uv run task lint_types)