Create @chatcops/store-cloudflare (D1, KV and a Durable Object counter)
Maintainer antworten meist innerhalb von 1 Tag
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Feature
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- postgresql, typescript
- Bereich
- backend, database, distributed-systems
Rechercherichtung
Start with packages/core/src/storage/types.ts, runStorageConformance from @chatcops/core/testing, and CONTRIBUTING.md’s “Writing a store package” section; inspect the SQLite store and its tables in issue #247. Use Miniflare from a normal Node test and run conformance against D1 + KV + DO and D1 alone as specified. Done means the acceptance checks pass, including 50 exact Durable Object increments, README Wrangler configuration, a minor changeset, and the listed build, coverage, lint, and publint commands.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
A ChatCops server on Cloudflare Workers keeps everything in memory today, and Workers isolates come and go all the time, so conversations and rate limits barely last. This package stores them in Cloudflare's own services.
This is a bigger one, for someone who has had a few PRs merged here and knows Workers. The interfaces and the tests it has to pass already exist: packages/core/src/storage/types.ts and runStorageConformance from @chatcops/core/testing. CONTRIBUTING.md has a "Writing a store package" section with the package layout.
What to do
Create packages/store-cloudflare:
import { cloudflareStorage, ChatCopsCounter } from '@chatcops/store-cloudflare';
export { ChatCopsCounter }; // the Durable Object class, exported from the Worker
storage: cloudflareStorage({ d1: env.DB, kv: env.CHATCOPS_KV, counters: env.CHATCOPS_COUNTERS })
d1is required:- It stores
conversations(withappend,updateMessage,removeMessage,list,purge) andevents(withquery). - Use the same tables as the SQLite store (see #247). D1 is SQLite, so the schema can be shared later.
- D1 has no interactive transactions, so make
appendatomic withdb.batch(). The version check has to be part of the statements themselves, for exampleUPDATE ... SET version = version + 1 WHERE id = ? AND version = ?, with the inserts conditional on it.
- It stores
counters: a Durable Object namespace when given. Durable Objects run one request at a time, so increments are exact; ship theChatCopsCounterclass. Without one, fall back to a D1UPSERT ... RETURNING. Never use KV for counters: it's eventually consistent.kv: Workers KV when given, otherwise a D1 table. Workers KV can't do an atomicsetIfAbsent, so only offersetIfAbsenton the D1 table.- Include a
wrangler.jsoncsnippet in the README with the D1 binding, the DO binding and its migration. "private": trueinpackage.json. A maintainer publishes it for the first time.
Testing
Use Miniflare from a normal Node test (new Miniflare({ ... d1Databases, kvNamespaces, durableObjects }) and its getD1Database() etc.) rather than the Workers vitest pool, which doesn't mix well with the root vitest projects here. Workers KV has a 60 second minimum TTL, so pass skip: ['kv-ttl'] for the KV-backed run, and run the suite a second time on the D1-only setup without skipping it.
Acceptance criteria
-
runStorageConformancepasses with D1 + KV + DO (skipping onlykv-ttl) and with D1 alone (nothing skipped) - 50 concurrent increments through the Durable Object land exactly
- README with the wrangler config
- Changeset for
@chatcops/store-cloudflare(minor) -
pnpm -r build,pnpm test:coverage(90% lines, 80% branches for store packages),pnpm lintandpnpm publintpass
Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off dev, and open your PR against dev with Closes #<this issue number>. Setup notes (pnpm, build before test) are in CONTRIBUTING.md.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 13
- Forks
- 7
- Ø Merge
- 3 Std. 28 Min.
- Gemergte PRs (30 T.)
- 182
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus codercops/chatcops
-
Type-check the TypeScript samples in the docsEvtl. vergeben @An16og hat das vor 3 Tagen übernommen. Offendocumentation hacktoberfest help wanted testing
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 70/100
codercops/chatcops#201 · 7 Kommentare · 1 zugewiesene Person ·
Maintainer antworten meist innerhalb von 1 Tag
-
hacktoberfest
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 35/100
Maintainer antworten meist innerhalb von 1 Tag
-
Add built-in translations to the widgetEvtl. vergeben @piyusshhjangid hat das vor 2 Tagen übernommen. Offenhelp wanted widget
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 52/100
codercops/chatcops#55 · 3 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in codercops/chatcops
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
awesome-dsh-plugin/awesome-dsh-plugin#9184 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
farion1231/cc-switch#8829 ·
Maintainer antworten meist innerhalb von 1 Tag
-
[core-client] Remove unused hand-maintained transport helpers after the definition-table cutoverOffendoc-audit enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100