Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

fix backwards compatibility metadataQueryParser

Steven Tey3dea82532e27
diff --git a/apps/web/lib/analytics/get-analytics.ts b/apps/web/lib/analytics/get-analytics.ts
index 6c2cf40f4e..b98c46b686 100644
--- a/apps/web/lib/analytics/get-analytics.ts
+++ b/apps/web/lib/analytics/get-analytics.ts
@@ -17,7 +17,7 @@ import {
extractWorkspaceLinkFilters,
prepareFiltersForPipe,
} from "./filter-helpers";
-import { queryParser } from "./query-parser";
+import { metadataQueryParser } from "./metadata-query-parser";
import { AnalyticsFilters } from "./types";
import { formatUTCDateTimeClickhouse } from "./utils/format-utc-datetime-clickhouse";
import { getStartEndDates } from "./utils/get-start-end-dates";
@@ -120,7 +120,7 @@ export const getAnalytics = async (params: AnalyticsFilters) => {
}),
});
- const metadataFilters = queryParser(query) || [];
+ const metadataFilters = metadataQueryParser(query) || [];
const advancedFilters = buildAdvancedFilters({
...params,
diff --git a/apps/web/lib/analytics/get-events.ts b/apps/web/lib/analytics/get-events.ts
index fbe9e718e8..ed7f2a252c 100644
--- a/apps/web/lib/analytics/get-events.ts
+++ b/apps/web/lib/analytics/get-events.ts
@@ -27,7 +27,7 @@ import {
extractWorkspaceLinkFilters,
prepareFiltersForPipe,
} from "./filter-helpers";
-import { queryParser } from "./query-parser";
+import { metadataQueryParser } from "./metadata-query-parser";
import { EventsFilters } from "./types";
import { formatUTCDateTimeClickhouse } from "./utils/format-utc-datetime-clickhouse";
import { getStartEndDates } from "./utils/get-start-end-dates";
@@ -83,7 +83,7 @@ export const getEvents = async (params: EventsFilters) => {
}[eventType] ?? clickEventSchemaTBEndpoint,
});
- const metadataFilters = queryParser(query) || [];
+ const metadataFilters = metadataQueryParser(query) || [];
// Build advanced filters for event-level dimensions
const advancedFilters = buildAdvancedFilters({
diff --git a/apps/web/lib/analytics/query-parser.ts b/apps/web/lib/analytics/metadata-query-parser.ts
similarity index 85%
rename from apps/web/lib/analytics/query-parser.ts
rename to apps/web/lib/analytics/metadata-query-parser.ts
index a4cf010824..d882b74d93 100644
--- a/apps/web/lib/analytics/query-parser.ts
+++ b/apps/web/lib/analytics/metadata-query-parser.ts
@@ -13,10 +13,7 @@ interface InternalFilter {
}
// Query parser that can parse the query string into a list of filters
-export const queryParser = (
- query: EventsFilters["query"],
- allowedOperands = ["metadata"],
-) => {
+export const metadataQueryParser = (query: EventsFilters["query"]) => {
if (!query) {
return undefined;
}
@@ -40,22 +37,6 @@ export const queryParser = (
continue;
}
- const isAllowed = allowedOperands.some((allowed) => {
- if (filter.operand === allowed) {
- return true;
- }
-
- if (filter.operand.startsWith(`${allowed}.`)) {
- return true;
- }
-
- return false;
- });
-
- if (!isAllowed) {
- continue;
- }
-
filters.push(filter);
}
@@ -92,8 +73,8 @@ function parseCondition(condition: string): InternalFilter | null {
.replace(/['"]\]/g, ""); // Remove trailing '] or "]
// Security: Validate metadata key contains only safe characters
- // Only allow alphanumeric and underscore (no dots — nested keys are not supported)
- if (!/^[a-zA-Z0-9_]+$/.test(extractedKey)) return null;
+ // Only allow alphanumeric and underscore and dots
+ if (!/^[a-zA-Z0-9_.]+$/.test(extractedKey)) return null;
operand = `metadata.${extractedKey}`;
} else {
diff --git a/apps/web/tests/analytics/query-parser.test.ts b/apps/web/tests/analytics/metadata-query-parser.test.ts
similarity index 67%
rename from apps/web/tests/analytics/query-parser.test.ts
rename to apps/web/tests/analytics/metadata-query-parser.test.ts
index 156af8a8e2..bd9f7783e2 100644
--- a/apps/web/tests/analytics/query-parser.test.ts
+++ b/apps/web/tests/analytics/metadata-query-parser.test.ts
@@ -1,23 +1,26 @@
-import { queryParser } from "@/lib/analytics/query-parser";
+import { metadataQueryParser } from "@/lib/analytics/metadata-query-parser";
import { describe, expect, it } from "vitest";
describe("Analytics Query Parser", () => {
it("should parse simple nested property", () => {
- const result = queryParser("metadata['key']:value");
+ const result = metadataQueryParser("metadata['key']:value");
expect(result).toEqual([
{ operand: "metadata.key", operator: "equals", value: "value" },
]);
});
it("should parse nested property with double quotes", () => {
- const result = queryParser('metadata["key"]:"quoted value"');
+ const result = metadataQueryParser('metadata["key"]:"quoted value"');
expect(result).toEqual([
{ operand: "metadata.key", operator: "equals", value: "quoted value" },
]);
});
it("should parse deeply nested property", () => {
- const result = queryParser("metadata['level1']['level2']['level3']:value");
+ const result = metadataQueryParser(
+ "metadata['level1']['level2']['level3']:value",
+ );
+ console.log(result);
expect(result).toEqual([
{
operand: "metadata.level1.level2.level3",
@@ -28,7 +31,9 @@ describe("Analytics Query Parser", () => {
});
it("should parse nested property with complex path", () => {
- const result = queryParser("metadata['user']['preferences']['theme']:dark");
+ const result = metadataQueryParser(
+ "metadata['user']['preferences']['theme']:dark",
+ );
expect(result).toEqual([
{
operand: "metadata.user.preferences.theme",
@@ -39,36 +44,36 @@ describe("Analytics Query Parser", () => {
});
it("should parse equals operator (:) for nested property", () => {
- const result = queryParser("metadata['key']:value");
+ const result = metadataQueryParser("metadata['key']:value");
expect(result).toEqual([
{ operand: "metadata.key", operator: "equals", value: "value" },
]);
});
it("should parse not equals operator for nested property", () => {
- const result = queryParser("metadata['status']!=completed");
+ const result = metadataQueryParser("metadata['status']!=completed");
expect(result).toEqual([
{ operand: "metadata.status", operator: "notEquals", value: "completed" },
]);
});
it("should handle empty query", () => {
- const result = queryParser("");
+ const result = metadataQueryParser("");
expect(result).toBeUndefined();
});
it("should handle null query", () => {
- const result = queryParser(null as any);
+ const result = metadataQueryParser(null as any);
expect(result).toBeUndefined();
});
it("should handle undefined query", () => {
- const result = queryParser(undefined as any);
+ const result = metadataQueryParser(undefined as any);
expect(result).toBeUndefined();
});
it("should handle whitespace-only query", () => {
- const result = queryParser(" ");
+ const result = metadataQueryParser(" ");
expect(result).toBeUndefined();
});
});