feat(cloudflare): add d1 adapter (#202)

* feat(cloudflare): add `d1` adapter

* Initial commit (by create-cloudflare CLI)

* feat(cloudflare): add `d1` adapter

* chore(cloudflare): remove token from d1 example

.gitignore

@@ -35,4 +35,6 @@ eggs-debug.log
 .pnpm-store
 .idea
 lerna-debug.log
-# pnpm-lock.yaml
+# pnpm-lock.yaml
+.env
+.wrangler

packages/cloudflare/README.md

@@ -1,4 +1,4 @@
-# Cloudflare storages for grammY
+# Cloudflare KV/D1 storages for grammY
 
 Storage adapter that can be used to
 [store your session data](https://grammy.dev/plugins/session.html) in cloudflare when

packages/cloudflare/examples/d1/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "d1",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "deploy": "wrangler deploy",
+    "dev": "wrangler dev",
+    "start": "wrangler dev"
+  },
+  "devDependencies": {
+    "@cloudflare/workers-types": "^4.20230419.0",
+    "typescript": "^5.0.4",
+    "wrangler": "^3.0.0"
+  }
+}

packages/cloudflare/examples/d1/src/index.ts

@@ -0,0 +1,47 @@
+import { D1Database } from '@cloudflare/workers-types'
+import {
+	type Context,
+	type SessionFlavor,
+	Bot,
+	session,
+	webhookCallback
+} from 'grammy/web'
+
+import { D1Adapter } from '../../../src/index.js'
+
+export interface Env {
+	BOT_TOKEN: string
+	DB: D1Database;
+}
+
+interface SessionData {
+	timestamp: string;
+}
+type MyContext = Context & SessionFlavor<SessionData>;
+
+export default {
+	async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
+		const grammyD1StorageAdapter = await D1Adapter.create<SessionData>(env.DB, 'GrammySessions')
+
+		const bot = new Bot<MyContext>(env.BOT_TOKEN);
+
+		bot.use(session({
+			initial: (): SessionData => {
+				return { timestamp: "World" }
+			},
+			storage: grammyD1StorageAdapter,
+		}))
+
+		bot.use(async (ctx, next) => {
+			ctx.session.timestamp = Date.now().toString();
+
+			await next();
+		})
+
+		bot.command("start", async (ctx: MyContext) => {
+			await ctx.reply(`Hello at ${ctx.session.timestamp}`);
+		})
+
+		return webhookCallback(bot, "cloudflare-mod")(request);
+	},
+};

packages/cloudflare/examples/d1/tsconfig.json

@@ -0,0 +1,101 @@
+{
+	"compilerOptions": {
+		/* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+		/* Projects */
+		// "incremental": true,                              /* Enable incremental compilation */
+		// "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+		// "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+		// "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+		// "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+		// "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+		/* Language and Environment */
+		"target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+		"lib": ["es2021"] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
+		"jsx": "react" /* Specify what JSX code is generated. */,
+		// "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+		// "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+		// "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+		// "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+		// "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+		// "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+		// "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+		// "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+		/* Modules */
+		"module": "es2022" /* Specify what module code is generated. */,
+		// "rootDir": "./",                                  /* Specify the root folder within your source files. */
+		"moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
+		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+		// "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+		"types": ["@cloudflare/workers-types"] /* Specify type package names to be included without being referenced in a source file. */,
+		// "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+		"resolveJsonModule": true /* Enable importing .json files */,
+		// "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+		/* JavaScript Support */
+		"allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
+		"checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
+		// "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+		/* Emit */
+		// "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+		// "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+		// "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+		// "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+		// "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+		// "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+		// "removeComments": true,                           /* Disable emitting comments. */
+		"noEmit": true /* Disable emitting files from a compilation. */,
+		// "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+		// "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+		// "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+		// "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+		// "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+		// "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+		// "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+		// "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+		// "newLine": "crlf",                                /* Set the newline character for emitting files. */
+		// "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+		// "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+		// "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+		// "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+		// "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+		// "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+		/* Interop Constraints */
+		"isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */,
+		"allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
+		// "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
+		// "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+		"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+		/* Type Checking */
+		"strict": true /* Enable all strict type-checking options. */,
+		// "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+		// "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+		// "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+		// "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+		// "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+		// "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+		// "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+		// "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+		// "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+		// "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+		// "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+		// "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+		// "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+		// "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+		// "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+		// "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+		// "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+		// "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+		/* Completeness */
+		// "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+		"skipLibCheck": true /* Skip type checking all .d.ts files. */
+	}
+}

packages/cloudflare/examples/d1/wrangler.toml

@@ -0,0 +1,8 @@
+name = "d1"
+main = "src/index.ts"
+compatibility_date = "2023-10-02"
+
+[[d1_databases]]
+binding = "DB" # i.e. available in your Worker on env.DB
+database_name = "grammy_d1_storage"
+database_id = "b12b44f6-e8ef-4257-9ecf-fe1ebe264f58"

packages/cloudflare/examples/session.ts → packages/cloudflare/examples/kv.ts

@@ -3,17 +3,9 @@ import { ExecutionContext, KVNamespace } from '@cloudflare/workers-types';
 import { KvAdapter } from '@grammyjs/storage-cloudflare';
 
 interface Env {
-    // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
-    // MY_KV_NAMESPACE: KVNamespace;
-    //
-    // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
-    // MY_DURABLE_OBJECT: DurableObjectNamespace;
-    //
-    // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
-    // MY_BUCKET: R2Bucket;
-    BOT_TOKEN: string,
-    MY_KV_NAMESPACE: KVNamespace<string>
-  }
+	BOT_TOKEN: string,
+	MY_KV_NAMESPACE: KVNamespace<string>
+}
 
 interface SessionData {
   name: string;

packages/cloudflare/package.json

@@ -29,7 +29,7 @@
   },
   "homepage": "https://github.com/grammyjs/storages/tree/main/packages/workers-kv#readme",
   "devDependencies": {
-    "@cloudflare/workers-types": "^4.20230115.0",
+    "@cloudflare/workers-types": "^4.20230307.0",
     "grammy": "^1.15.1",
     "wrangler": "^3.0.0"
   }

packages/cloudflare/src/d1.ts

@@ -0,0 +1,62 @@
+import type { D1Database } from '@cloudflare/workers-types';
+import type { StorageAdapter } from 'grammy/web';
+
+const defaultTableName = 'GrammySessions';
+
+export class D1Adapter<T> implements StorageAdapter<T> {
+  private readonly tableName: string;
+  private readonly db: D1Database;
+
+  /**
+	 * @private
+ 	*/
+  private constructor(db: D1Database, tableName?: string) {
+    this.db = db;
+    this.tableName = tableName ?? defaultTableName;
+  }
+
+  static async create<T>(db: D1Database, tableName?: string): Promise<D1Adapter<T>> {
+    const adapter = new D1Adapter<T>(db, tableName);
+    await adapter.#init();
+    return adapter;
+  }
+
+  async #init() {
+    await this.db
+      .exec(`CREATE TABLE IF NOT EXISTS "${this.tableName}" (key TEXT PRIMARY KEY, value TEXT)`);
+
+    await this.db
+      .exec(`CREATE INDEX IF NOT EXISTS "IDX_${this.tableName}" ON ${this.tableName} (key)`);
+  }
+
+  async read(key: string): Promise<T | undefined> {
+    const row = await this.db
+      .prepare(`SELECT value FROM "${this.tableName}" WHERE key = ?`)
+      .bind(key)
+      .first();
+
+    if (!row || typeof row !== 'object') return undefined;
+
+    if (!('value' in row)) {
+      throw new Error(`Unexpected row: ${JSON.stringify(row)}`);
+    }
+
+    return JSON.parse(row.value as string) as unknown as T;
+  }
+
+  async write(key: string, value: T): Promise<void> {
+    const stringified = JSON.stringify(value);
+
+    await this.db
+      .prepare(`INSERT INTO "${this.tableName}" (key, value) VALUES (?, ?) ON CONFLICT (key) DO UPDATE SET value = ?`)
+      .bind(key, stringified, stringified)
+      .run();
+  }
+
+  async delete(key: string): Promise<void> {
+    await this.db
+      .prepare(`DELETE FROM "${this.tableName}" WHERE key = ?`)
+      .bind(key)
+      .run();
+  }
+}

packages/cloudflare/src/index.ts

@@ -1 +1,2 @@
-export * from './kv.js';
+export * from './kv.js';
+export * from './d1.js';