Merge pull request #1298 from Geun-Oh/main

Add Cloudflare KV Storage

Author: ReneWerner87

.github/dependabot.yml

@@ -26,6 +26,12 @@ updates:
             - "🤖 Dependencies"
         schedule:
             interval: "daily"
+    -   package-ecosystem: "gomod"
+        directory: "/cloudflarekv/" # Location of package manifests
+        labels:
+            - "🤖 Dependencies"
+        schedule:
+            interval: "daily"
     -   package-ecosystem: "gomod"
         directory: "/couchbase/" # Location of package manifests
         labels:

.github/release-drafter-cloudflarekv.yml

@@ -0,0 +1,44 @@
+name-template: "CloudflareKV - v$RESOLVED_VERSION"
+tag-template: "cloudflarekv/v$RESOLVED_VERSION"
+tag-prefix: cloudflarekv/v
+include-paths:
+  - cloudflarekv
+categories:
+  - title: "🚀 New"
+    labels:
+      - "✏️ Feature"
+  - title: "🧹 Updates"
+    labels:
+      - "🧹 Updates"
+      - "🤖 Dependencies"
+  - title: "🐛 Fixes"
+    labels:
+      - "☢️ Bug"
+  - title: "📚 Documentation"
+    labels:
+      - "📒 Documentation"
+change-template: "- $TITLE (#$NUMBER)"
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+exclude-contributors:
+  - dependabot
+  - dependabot[bot]
+version-resolver:
+  major:
+    labels:
+      - "major"
+  minor:
+    labels:
+      - "minor"
+      - "✏️ Feature"
+  patch:
+    labels:
+      - "patch"
+      - "📒 Documentation"
+      - "☢️ Bug"
+      - "🤖 Dependencies"
+      - "🧹 Updates"
+  default: patch
+template: |
+  $CHANGES
+  **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...cloudflarekv/v$RESOLVED_VERSION
+  Thank you $CONTRIBUTORS for making this update possible.

.github/scripts/initialize-wrangler.sh

@@ -0,0 +1,107 @@
+#!/bin/bash
+
+# generate cloudflarekv/index.ts
+cat <<EOF > cloudflarekv/index.ts
+export default { async fetch(Request, env) {
+
+  const namespace = env.TEST_NAMESPACE1;
+
+  if (Request.url === "http://localhost:8787/health") {
+    return new Response("Success");
+  }
+
+  if (Request.url === "http://localhost:8787/writeworkerskvkeyvaluepair") {
+    const res = await Request.json();
+    const { key, val } = res;
+    WriteWorkersKVKeyValuePair(namespace, key, val);
+    return new Response("Success");
+  }
+
+  else if (Request.url === "http://localhost:8787/listworkerskvkeys") {
+    const resp = await Request.json();
+    const { limit, prefix, cursor } = resp;
+    const list = await ListWorkersKVKeys(namespace, limit, prefix, cursor);
+    return new Response(list);
+  }
+
+  else if (Request.url === "http://localhost:8787/deleteworkerskvpairbykey") {
+    const res = await Request.json();
+    const { key } = res;
+    await DeleteWorkersKVPairByKey(namespace, key);
+
+    return new Response(key)
+  }
+
+  else if (Request.url === "http://localhost:8787/getworkerskvvaluebykey") {
+    const key = (await Request.json()).key;
+    const res = await GetWorkersKVValueByKey(namespace, key);
+
+    return new Response(res);
+  }
+
+  else if (Request.url === "http://localhost:8787/deleteworkerskventries") {
+    const res = await Request.json();
+    const { keys } = res;
+    const newKeys = keys.filter(x => x.length > 0);
+    await DeleteWorkersKVEntries(namespace, newKeys);
+
+    return new Response("Success")
+  }
+}
+}
+
+const GetWorkersKVValueByKey = async (NAMESPACE, key) => {
+  const val = await NAMESPACE.get(key);
+
+  return val;
+}
+
+const WriteWorkersKVKeyValuePair = async (NAMESPACE, key, val) => {
+  await NAMESPACE.put(key, val);
+
+  return "Wrote Successfully"
+}
+
+const DeleteWorkersKVPairByKey = async (NAMESPACE, key) => {
+  await NAMESPACE.delete(key);
+
+  return "Delete Successfully"
+}
+
+const ListWorkersKVKeys = async (NAMESPACE, limit, prefix, cursor) => {
+  const resp = await NAMESPACE.list({ limit, prefix, cursor });
+
+  return JSON.stringify(resp.keys);
+}
+
+const DeleteWorkersKVEntries = async (NAMESPACE, keys) => {
+  for (let key of keys) {
+    await NAMESPACE.delete(key);
+  }
+
+  return "Delete Successfully"
+}
+
+
+EOF
+
+echo "index.ts generated"
+
+# generate cloudflarekv/wrangler.toml
+cat <<EOF > cloudflarekv/wrangler.toml
+main = "index.ts"
+
+kv_namespaces = [
+  { binding = "TEST_NAMESPACE1", id = "hello", preview_id = "world" },
+]
+
+workers_dev = true
+
+compatibility_date = "2024-03-20"
+
+[dev]
+port = 8787
+local_protocol = "http"
+EOF
+
+echo "wrangler.toml generated"

.github/workflows/benchmark.yml

@@ -88,10 +88,21 @@ jobs:
           # NOTE: Keep this in sync with the version from go.mod
           go-version: "1.20.x"
 
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
       - name: Install Azurite
         run: |
           docker run -d -p 10000:10000 mcr.microsoft.com/azure-storage/azurite azurite-blob --blobHost 0.0.0.0 --blobPort 10000
 
+      - name: Install Cloudflare Worker
+        run : |
+          .github/scripts/initialize-wrangler.sh
+          cd cloudflarekv && npx wrangler dev &
+          npx wait-on tcp:8787
+
       - name: Install Coherence
         run: |
           docker run -d -p 1408:1408 -p 30000:30000 ghcr.io/oracle/coherence-ce:22.06.5
@@ -144,8 +155,10 @@ jobs:
           set -o pipefail
           for d in */ ; do
             [[ $d == "tls/" ]] && continue
+            [[ $d == "node_modules/" ]] && continue
 
             cd "$d"
+            echo "Bench dir: $d"
             go test ./... -benchmem -run=^$ -bench . | tee -a ../output.txt
             cd ..
           done

.github/workflows/release-drafter-cloudflarekv.yml

@@ -0,0 +1,19 @@
+name: Release Drafter Cloudflare KV
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+      - main
+    paths:
+      - "cloudflarekv/**"
+jobs:
+  draft_release_cloudflarekv:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: release-drafter/release-drafter@v6
+        with:
+          config-name: release-drafter-cloudflarekv.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test-cloudflarekv.yml

@@ -0,0 +1,41 @@
+name: Tests CloudflareKV
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  Tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+          go-version:
+              - 1.21.x
+              - 1.22.x
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Start Wrangler Dev
+        run: |
+          .github/scripts/initialize-wrangler.sh
+          cd cloudflarekv && npx wrangler dev &
+          npx wait-on tcp:8787
+
+      - name: Run Go Tests
+        run: cd cloudflarekv && go test ./... -v -race

.gitignore

@@ -28,6 +28,7 @@
 vendor/
 vendor
 /Godeps/
+node_modules/
 
 # Go specific
 go.work*

README.md

@@ -54,6 +54,7 @@ type Storage interface {
 - [AzureBlob](./azureblob/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Azure+Blob%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-azureblob.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
 - [Badger](./badger/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Badger%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-badger.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
 - [Bbolt](./bbolt) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Bbolt%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-bbolt.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [CloudflareKV](./cloudflarekv/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+CloudflareKV%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-cloudflarekv.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
 - [Coherence](./coherence/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Coherence%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-coherence.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
 - [Couchbase](./couchbase/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Couchbase%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-couchbase.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
 - [DynamoDB](./dynamodb/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+DynamoDB%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-dynamodb.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>

cloudflarekv/.gitignore

@@ -0,0 +1,2 @@
+index.ts
+wrangler.toml

cloudflarekv/README.md

@@ -0,0 +1,114 @@
+---
+id: cloudflarekv
+title: Cloudflare KV
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=cloudflarekv*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-cloudflarekv.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)
+
+A Cloudflare KV storage driver using [cloudflare/cloudflare-go](https://github.com/cloudflare/cloudflare-go).
+
+**Note: Requires Go 1.21 and above**
+
+### Table of Contents
+
+- [Signatures](#signatures)
+- [Installation](#installation)
+- [Examples](#examples)
+- [Config](#config)
+- [Default Config](#default-config)
+
+### Signatures
+
+```go
+func New(config ...Config) Storage
+func (s *Storage) Get(key string) ([]byte, error)
+func (s *Storage) Set(key string, val []byte, exp time.Duration) error
+func (s *Storage) Delete(key string) error
+func (s *Storage) Reset() error
+func (s *Storage) Close() error
+func (s *Storage) Conn() *cloudflare.API
+```
+
+### Installation
+
+```bash
+go mod init github.com/<user>/<repo>
+```
+
+And then install the Cloudflare KV implementation:
+
+```bash
+go get github.com/gofiber/storage/cloudflarekv
+```
+
+### Examples
+
+Import the storage package.
+
+```go
+import "github.com/gofiber/storage/cloudflarekv"
+```
+
+You can use the following methods to create storage. The Key must be an API Token generated with at least `Account.Workers KV Storage` permission. Check the [Create API Token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) documentation to generate one.
+
+```go
+// Initialize default config
+store := cloudflarekv.New()
+
+store := cloudflarekv.New(cloudflarekv.Config{
+    Key: "",
+    Email: "",
+    AccountID: "fiber",
+    NamespaceID: "fiber",
+    Reset: false,
+})
+
+```
+
+### Config
+
+```go
+type Config struct {
+
+	// Cloudflare Auth Token
+	//
+	// Optional. Default is ""
+	Key string
+
+	// Cloudflare Email
+	//
+	// Optional. Default is ""
+	Email string
+
+	// Account id
+	//
+	// Optional. Default is "fiber"
+	AccountID string
+
+	// Namespace id
+	//
+	// Optional. Default is "fiber"
+	NamespaceID string
+
+	// Reset clears any existing keys in existing Table
+	//
+	// Optional. Default is false
+	Reset bool
+}
+```
+
+### Default Config
+
+```go
+var ConfigDefault = Config{
+	Key:         "",
+	Email:       "",
+	AccountID:   "fiber",
+	NamespaceID: "fiber",
+	Reset:       false,
+}
+```