Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Create basic Plausible import endpoint

Edward Cuid2dacbd00c78
diff --git a/server/src/api/import/plausible.ts b/server/src/api/import/plausible.ts
new file mode 100644
index 000000000..839910533
--- /dev/null
+++ b/server/src/api/import/plausible.ts
@@ -0,0 +1,78 @@
+import { FastifyRequest, FastifyReply } from "fastify";
+import boss from "../../lib/boss.js";
+import { getUserHasAccessToSite } from "../../lib/auth-utils.js";
+
+interface ImportPlausibleRequest {
+ Params: {
+ site: string;
+ };
+}
+
+const MAX_FILES = 10;
+const MAX_FILE_SIZE = 100 * 1024 * 1024; // 100MB
+const ALLOWED_TABLES = [
+ "visitors",
+ "sources",
+ "pages",
+ "entry_pages",
+ "exit_pages",
+ "custom_events",
+ "locations",
+ "devices",
+ "browsers",
+ "operating_systems",
+];
+
+export async function importPlausible(request: FastifyRequest<ImportPlausibleRequest>, reply: FastifyReply) {
+ const { site } = request.params;
+
+ const userHasAccess = await getUserHasAccessToSite(request, site);
+ if (!userHasAccess) {
+ return reply.status(403).send({ error: "Forbidden" });
+ }
+
+ const parts = request.parts();
+ const files = [];
+
+ for await (const part of parts) {
+ if (part.type === "file") {
+ const chunks = [];
+ let totalSize = 0;
+ for await (const chunk of part.file) {
+ totalSize += chunk.length;
+ if (totalSize > MAX_FILE_SIZE) {
+ return reply.status(400).send({ error: `File ${part.filename} is larger than the 100MB limit.` });
+ }
+ chunks.push(chunk);
+ }
+ const fileContent = Buffer.concat(chunks).toString("utf-8");
+ files.push({ fileName: part.filename, fileContent });
+ } else {
+ // Handle other form fields if necessary
+ }
+ }
+
+ if (files.length === 0 || files.length > MAX_FILES) {
+ return reply.status(400).send({ error: `You can upload between 1 and ${MAX_FILES} files.` });
+ }
+
+ for (const file of files) {
+ const fileNameParts = file.fileName.split("_");
+ if (fileNameParts.length !== 4 || fileNameParts[0] !== "imported" || !fileNameParts[3].endsWith(".csv")) {
+ return reply.status(400).send({ error: `Invalid file name format for ${file.fileName}.` });
+ }
+
+ const tableName = fileNameParts[1];
+ if (!ALLOWED_TABLES.includes(tableName)) {
+ return reply.status(400).send({ error: `Invalid table name in file ${file.fileName}.` });
+ }
+ }
+
+ const importId = crypto.randomUUID();
+
+ for (const file of files) {
+ await boss.send("plausible-import", { ...file, site_id: Number(site), importId });
+ }
+
+ reply.send({ success: true, importId });
+}
diff --git a/server/src/index.ts b/server/src/index.ts
index c0ead0afc..f92191e26 100644
--- a/server/src/index.ts
+++ b/server/src/index.ts
@@ -69,6 +69,7 @@ import { IS_CLOUD } from "./lib/const.js";
import { siteConfig } from "./lib/siteConfig.js";
import { trackEvent } from "./tracker/trackEvent.js";
import { extractSiteId, isSitePublic } from "./utils.js";
+import { importPlausible } from "./api/import/plausible.js";
const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);
@@ -280,6 +281,9 @@ server.post("/api/session-replay/record/:site", recordSessionReplay);
server.get("/api/session-replay/list/:site", getSessionReplays);
server.get("/api/session-replay/:sessionId/:site", getSessionReplayEvents);
+// Imports
+server.post("/api/import/plausible/:site", importPlausible);
+
// Administrative
server.get("/api/config", getConfig);
server.post("/api/add-site", addSite);