Add Cloudflare KV Storage

.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: "weekly"
     -   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/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_dynamodb:
+    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,29 @@
+on:
+  push:
+    branches:
+      - master
+      - main
+    paths:
+      - "cloudflarekv/**"
+  pull_request:
+    paths:
+      - "cloudflarekv/**"
+name: "Tests Cloudflare KV"
+jobs:
+  Tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version:
+          - 1.19.x
+          - 1.20.x
+          - 1.21.x
+    steps:
+      - name: Fetch Repository
+        uses: actions/checkout@v4
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "${{ matrix.go-version }}"
+      - name: Run Test
+        run: cd ./cloudflarekv && go test ./... -v -race

cloudflarekv/README.md

@@ -0,0 +1,119 @@
+---
+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 kv storage driver using [cloudflare/cloudflare-go](https://github.com/cloudflare/cloudflare-go).
+
+**Note: Requires Go 1.19 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
+```
+
+### Installation
+
+Cloudflare KV is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet:
+
+```bash
+go mod init github.com/<user>/<repo>
+```
+
+And then install the Cloudflare KV implementation:
+
+```bash
+go get github.com/gofiber/storage/cloudflarekv/v2
+```
+
+### Examples
+
+Import the storage package.
+
+```go
+import "github.com/gofiber/storage/cloudflarekv/v2"
+```
+
+You can use the following possibilities to create a storage.
+
+Key must be an API Token generated with at least `Account.Workers KV Storage` permission.
+
+Check [Create API Token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) docs to generate.
+
+```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,
+}
+```

cloudflarekv/cloudflarekv.go

@@ -0,0 +1,124 @@
+package cloudflarekv
+
+import (
+	"context"
+	"log"
+	"time"
+
+	"github.com/cloudflare/cloudflare-go"
+)
+
+type Storage struct {
+	api         *cloudflare.API
+	email       string
+	accountID   string
+	namespaceID string
+}
+
+func New(config ...Config) *Storage {
+
+	cfg := configDefault(config...)
+
+	api, err := cloudflare.NewWithAPIToken(cfg.Key)
+
+	if err != nil {
+		log.Println("Error with cloudflare api initialization")
+	}
+
+	storage := &Storage{
+		api:         api,
+		email:       cfg.Email,
+		accountID:   cfg.AccountID,
+		namespaceID: cfg.NamespaceID,
+	}
+
+	return storage
+}
+
+func (s *Storage) Get(key string) ([]byte, error) {
+	resp, err := s.api.GetWorkersKV(context.Background(), cloudflare.AccountIdentifier(s.accountID), cloudflare.GetWorkersKVParams{NamespaceID: s.namespaceID, Key: key})
+
+	if err != nil {
+		log.Println("Error occur in GetWorkersKV")
+		log.Fatal(err)
+	}
+
+	return resp, nil
+}
+
+func (s *Storage) Set(key string, val []byte, exp time.Duration) error {
+
+	_, err := s.api.WriteWorkersKVEntry(context.Background(), cloudflare.AccountIdentifier(s.accountID), cloudflare.WriteWorkersKVEntryParams{
+		NamespaceID: s.namespaceID,
+		Key:         key,
+		Value:       val,
+	})
+
+	if err != nil {
+		log.Println("Error occur in WriteWorkersKVEntry")
+		log.Fatal(err)
+	}
+
+	return nil
+}
+
+func (s *Storage) Delete(key string) error {
+	_, err := s.api.DeleteWorkersKVEntry(context.Background(), cloudflare.AccountIdentifier(s.accountID), cloudflare.DeleteWorkersKVEntryParams{
+		NamespaceID: s.namespaceID,
+		Key:         key,
+	})
+
+	if err != nil {
+		log.Println("Error occur in WriteWorkersKVEntry")
+		log.Fatal(err)
+	}
+
+	return nil
+}
+
+func (s *Storage) Reset() error {
+
+	var cursor string
+
+	for {
+		resp, err := s.api.ListWorkersKVKeys(context.Background(), cloudflare.AccountIdentifier(s.accountID), cloudflare.ListWorkersKVsParams{
+			NamespaceID: s.namespaceID,
+			Cursor:      cursor,
+		})
+
+		if err != nil {
+			log.Println("Error occur in ListWorkersKVKeys")
+			log.Fatal(err)
+		}
+
+		keys := []string{}
+
+		for _, element := range resp.Result {
+			name := element.Name
+			keys = append(keys, name)
+		}
+
+		_, err = s.api.DeleteWorkersKVEntries(context.Background(), cloudflare.AccountIdentifier(s.accountID), cloudflare.DeleteWorkersKVEntriesParams{
+			NamespaceID: s.namespaceID,
+			Keys:        keys,
+		})
+
+		if err != nil {
+			log.Println("Error occur in DeleteWorker")
+			log.Fatal(err)
+		}
+
+		if len(resp.Cursor) == 0 {
+			log.Println("No keys left in the namespace")
+			break
+		}
+
+		cursor = resp.Cursor
+	}
+
+	return nil
+}
+
+func (s *Storage) Close() error {
+	return nil
+}