Merge pull request #19 from mojisdev/improve-local-dx

chore: improve local dx

Author: luxass

README.md

@@ -1 +1,38 @@
 # api.mojis.dev
+
+A RESTful API for accessing emoji data.
+
+## 📦 Installation
+
+```sh
+git clone https://github.com/mojis-dev/api.mojis.dev.git
+cd api.mojis.dev
+pnpm install
+```
+
+## 🚀 Usage
+
+```sh
+pnpm run dev
+```
+
+> [!NOTE]
+> This will copy the emoji data from [mojis/emoji-data](https://github.com/mojis-dev/emoji-data) to the `node_modules/.emoji-data` directory.
+> If you want to update this, you can run `pnpm run copy:emoji-data`.
+
+## 📖 API Documentation
+
+The API documentation is available at [api.mojis.dev](https://api.mojis.dev) using Scalar.
+
+## 🔧 Development
+
+The project uses:
+
+- [Hono](https://hono.dev/) for the web framework
+- [Cloudflare Workers](https://workers.cloudflare.com/) for deployment
+- [Vitest](https://vitest.dev/) for testing
+- [Scalar](https://scalar.com/) for API documentation
+
+## 📄 License
+
+Published under [MIT License](./LICENSE).

package.json

@@ -7,7 +7,9 @@
     "dev": "wrangler dev",
     "build": "wrangler deploy --dry-run --outdir=dist",
     "build:openapi": "tsx ./scripts/build-openapi",
-    "predev": "tsx ./scripts/copy-emoji-data",
+    "predev": "pnpm run copy:emoji-data && pnpm run setup:emoji-data",
+    "setup:emoji-data": "tsx ./scripts/setup-dev/setup.ts",
+    "copy:emoji-data": "tsx ./scripts/copy-emoji-data",
     "deploy": "wrangler deploy",
     "test": "pnpm vitest --run",
     "test:watch": "pnpm vitest",

scripts/copy-emoji-data.ts

@@ -1,10 +1,16 @@
+import { existsSync } from "node:fs";
+import { mkdir, writeFile } from "node:fs/promises";
 import path from "node:path";
 import process from "node:process";
-import { unstable_startWorker } from "wrangler";
+import { parseTarGzip } from "nanotar";
 
 const root = path.resolve(import.meta.dirname, "../");
 
 async function run() {
+  if (!existsSync(path.join(root.toString(), "./node_modules/.emoji-data"))) {
+    await mkdir(path.join(root.toString(), "./node_modules/.emoji-data"), { recursive: true });
+  }
+
   const res = await fetch("https://github.com/mojisdev/emoji-data/archive/refs/heads/main.tar.gz");
 
   if (!res.ok) {
@@ -13,21 +19,28 @@ async function run() {
 
   const blob = await res.blob();
 
-  const worker = await unstable_startWorker({
-    config: path.join(root.toString(), "./wrangler.jsonc"),
-    entrypoint: path.join(root.toString(), "./scripts/emoji-data-setup-app.ts"),
-  });
+  const filePrefix = "emoji-data-main/data/";
 
-  const formData = new FormData();
-  formData.append("file", blob, "emoji-data.tar.gz");
+  const tar = await parseTarGzip(await blob.arrayBuffer(), {
+    filter(file) {
+      if (!file.name.startsWith(filePrefix) || !file.name.endsWith(".json")) {
+        return false;
+      }
 
-  await worker.fetch("https://api.mojis.dev/upload", {
-    method: "POST",
-    // @ts-expect-error hmmm
-    body: formData,
+      // remove the file prefix
+      file.name = file.name.slice(filePrefix.length);
+
+      return true;
+    },
   });
 
-  await worker.dispose();
+  for await (const file of tar) {
+    const filePath = path.join(root.toString(), "./node_modules/.emoji-data", file.name);
+    await mkdir(path.dirname(filePath), { recursive: true });
+    await writeFile(filePath, file.text);
+  }
+
+  console.log("emoji data copied");
 }
 
 run().catch((err) => {

scripts/emoji-data-setup-app.ts renamed to scripts/setup-dev/setup-worker.ts

@@ -51,13 +51,17 @@ app.post(
       promises.push(c.env.EMOJI_DATA.put(normalizedEntryName, entry.text));
     }
 
-    c.executionCtx.waitUntil(
-      Promise.all(promises),
-    );
-
-    return c.json({
-      message: "Files uploaded",
-    });
+    try {
+      await Promise.all(promises);
+      return c.json({
+        message: "Files uploaded",
+      });
+    } catch (err) {
+      console.error(err);
+      return c.json({
+        message: "Failed to upload files",
+      }, 500);
+    }
   },
 );
 

scripts/setup-dev/setup.ts

@@ -0,0 +1,38 @@
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import process from "node:process";
+import { unstable_startWorker } from "wrangler";
+
+const root = path.resolve(import.meta.dirname, "../..");
+
+async function run() {
+  const worker = await unstable_startWorker({
+    config: path.join(root.toString(), "./wrangler.jsonc"),
+    entrypoint: path.join(root.toString(), "./scripts/setup-dev/setup-worker.ts"),
+  });
+
+  const file = await readFile(path.join(root.toString(), "./node_modules/.emoji-data/emoji-data.tar.gz"));
+  const blob = new Blob([file]);
+
+  const formData = new FormData();
+  formData.append("file", blob, "emoji-data.tar.gz");
+
+  console.log("sending request to worker");
+  const res = await worker.fetch("https://api.mojis.dev/upload", {
+    method: "POST",
+    // @ts-expect-error hmmm
+    body: formData,
+  });
+
+  const json = await res.json();
+
+  console.log("received response from worker");
+  console.log(json);
+
+  await worker.dispose();
+}
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

worker-configuration.d.ts

@@ -1,5 +1,5 @@
 // Generated by Wrangler by running `wrangler types --env-interface CloudflareBindings` (hash: c476c03844aa0429b0aacf2d2d7c8815)
-// Runtime types generated with workerd@1.20250317.0 2025-03-13 
+// Runtime types generated with workerd@1.20250319.0 2025-03-13 
 declare namespace Cloudflare {
 	interface Env {
 		API_VERSION: "x.y.z";
@@ -4613,6 +4613,20 @@ interface D1Meta {
     last_row_id: number;
     changed_db: boolean;
     changes: number;
+    /**
+     * The region of the database instance that executed the query.
+     */
+    served_by_region?: string;
+    /**
+     * True if-and-only-if the database instance that executed the query was the primary.
+     */
+    served_by_primary?: boolean;
+    timings?: {
+        /**
+         * The duration of the SQL query execution by the database instance. It doesn't include any network time.
+         */
+        sql_duration_ms: number;
+    };
 }
 interface D1Response {
     success: true;