Skip to content

Commit 1656567

Browse files
committed
fix(cloudflare): respect datasets the zone's plan does not include
Zone discovery re-enabled every dataset on a watched zone, including ones\nwhose Cloudflare settings deny collection (e.g. `firewallEventsAdaptiveGroups`\non Free-plan zones: `enabled: false` / `maxDuration: 0`). Those rows planned no\npoll window, kept a stale error forever, and CFG-INTEG-02 failed permanently.\n\n- `@maple/domain/cloudflare-analytics`: `cloudflareDatasetUnavailable`, true only\n for an explicit denial (`enabled === false` or `maxDuration === 0`); missing or\n malformed settings stay unknown. No plan-name checks.\n- Discovery and zone-watch resume keep capability-denied datasets disabled; the\n daily settings refresh still covers them and re-enables a dataset once\n Cloudflare allows it; a vanished zone drops its cached settings.\n- A valid connection clears the stale error on capability-denied rows.\n- CFG-INTEG-02 lists unavailable datasets as such (pass with detail when nothing\n else fails) while real errors on available datasets still fail.
1 parent 5d9f5cf commit 1656567

8 files changed

Lines changed: 509 additions & 26 deletions

File tree

‎packages/backend/src/services/integrations/CloudflareAnalyticsService.test.ts‎

Lines changed: 276 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,9 @@ interface HyperdriveConfigFixture {
222222
}
223223

224224
interface FetchOptions {
225+
settingsData?: unknown
226+
zoneData?: unknown
227+
225228
readonly zones?: ReadonlyArray<typeof zoneFixture>
226229
/**
227230
* When set, the `/zones` listing serves only the zones of the account whose id appears
@@ -368,11 +371,11 @@ const mockCloudflareFetch = (options: FetchOptions = {}): typeof globalThis.fetc
368371
errors: options.graphqlFirstErrorOnly ? errors.slice(0, 1) : errors,
369372
})
370373
}
371-
if (Str.includes("MapleCfDatasetSettings")(body.query))
372-
return jsonResponse({ data: settingsData })
373-
if (Str.includes("MapleCfZoneAnalytics")(body.query)) return jsonResponse({ data: httpData })
374-
if (Str.includes("MapleCfAccountAnalytics")(body.query))
375-
return jsonResponse({ data: workersData })
374+
if (body.query.includes("MapleCfDatasetSettings"))
375+
return jsonResponse({ data: options.settingsData ?? settingsData })
376+
if (body.query.includes("MapleCfZoneAnalytics"))
377+
return jsonResponse({ data: options.zoneData ?? httpData })
378+
if (body.query.includes("MapleCfAccountAnalytics")) return jsonResponse({ data: workersData })
376379
return jsonResponse({ data: null, errors: [{ message: "unknown query" }] })
377380
}
378381
if (Str.includes("/hyperdrive/configs")(url)) {
@@ -1473,6 +1476,274 @@ describe("CloudflareAnalyticsService", () => {
14731476
}).pipe(Effect.provide(makeLayer(testDb, captured)))
14741477
})
14751478

1479+
for (const unavailable of [
1480+
{ enabled: false, maxDuration: 3600 },
1481+
{ enabled: true, maxDuration: 0 },
1482+
]) {
1483+
it.effect(
1484+
`cached unavailable ${JSON.stringify(unavailable)} survives discovery and clears stale connection error`,
1485+
() => {
1486+
const testDb = createTestDb(trackedDbs)
1487+
const queries: string[] = []
1488+
const enabledDuringRequests: boolean[] = []
1489+
return Effect.gen(function* () {
1490+
yield* TestClock.setTime(T0)
1491+
yield* seedConnection()
1492+
yield* seedStateRow({
1493+
dataset: "firewall_events",
1494+
enabled: unavailable.enabled,
1495+
zoneId: ZONE_ID,
1496+
zoneName: ZONE_NAME,
1497+
settingsJson: JSON.stringify(unavailable),
1498+
settingsFetchedAt: T0 - 5 * MIN,
1499+
lastError: "Cloudflare OAuth request timed out",
1500+
lastErrorAt: T0 - MIN,
1501+
})
1502+
const summary = yield* CloudflareAnalyticsService.use((service) => service.pollOrg(ORG))
1503+
const row = (yield* loadStateRows).find((row) => row.dataset === "firewall_events")!
1504+
assert.isFalse(row.enabled)
1505+
assert.isAbove(enabledDuringRequests.length, 0)
1506+
assert.isFalse(enabledDuringRequests.some(Boolean))
1507+
assert.isNull(row.lastError)
1508+
assert.isNull(row.lastErrorAt)
1509+
assert.isNull(row.lastSuccessAt)
1510+
assert.strictEqual(summary.failures.length, 0)
1511+
assert.isFalse(
1512+
queries.some(
1513+
(query) =>
1514+
query.includes("MapleCfZoneAnalytics") &&
1515+
query.includes("firewallEventsAdaptiveGroups"),
1516+
),
1517+
)
1518+
}).pipe(
1519+
Effect.provide(
1520+
makeLayer(testDb, [], {
1521+
graphqlQueries: queries,
1522+
onGraphql: async () => {
1523+
const row = await queryFirstRow<{ enabled: boolean }>(
1524+
testDb,
1525+
"SELECT enabled FROM cloudflare_analytics_state WHERE dataset = 'firewall_events'",
1526+
)
1527+
enabledDuringRequests.push(row!.enabled)
1528+
},
1529+
}),
1530+
),
1531+
)
1532+
},
1533+
)
1534+
}
1535+
1536+
it.effect(
1537+
"unavailable settings refresh after 24h resumes polling without discovery re-enabling the row",
1538+
() => {
1539+
const testDb = createTestDb(trackedDbs)
1540+
const queries: string[] = []
1541+
const options: FetchOptions = {
1542+
zoneData: { viewer: { zones: [{ zoneTag: ZONE_ID, firewall: [] }] } },
1543+
graphqlQueries: queries,
1544+
settingsData: {
1545+
viewer: {
1546+
...settingsData.viewer,
1547+
zones: [
1548+
{
1549+
zoneTag: ZONE_ID,
1550+
settings: {
1551+
...settingsData.viewer.zones[0]!.settings,
1552+
firewallEventsAdaptiveGroups: {
1553+
enabled: true,
1554+
maxDuration: 3600,
1555+
notOlderThan: 7200,
1556+
},
1557+
},
1558+
},
1559+
],
1560+
},
1561+
},
1562+
}
1563+
return Effect.gen(function* () {
1564+
yield* TestClock.setTime(T0)
1565+
yield* seedConnection()
1566+
yield* seedStateRow({
1567+
dataset: "workers_invocations",
1568+
discoveredAt: T0,
1569+
settingsFetchedAt: T0,
1570+
})
1571+
yield* seedStateRow({
1572+
dataset: "firewall_events",
1573+
zoneId: ZONE_ID,
1574+
zoneName: ZONE_NAME,
1575+
enabled: false,
1576+
settingsJson: JSON.stringify({ enabled: false, maxDuration: 0 }),
1577+
settingsFetchedAt: T0 - 25 * 60 * MIN,
1578+
})
1579+
yield* CloudflareAnalyticsService.use((service) => service.pollOrg(ORG))
1580+
const row = (yield* loadStateRows).find((row) => row.dataset === "firewall_events")!
1581+
assert.isTrue(row.enabled)
1582+
assert.strictEqual(row.lastSuccessAt, T0)
1583+
assert.isNotNull(row.watermarkAt)
1584+
assert.isTrue(queries.some((query) => query.includes("MapleCfDatasetSettings")))
1585+
assert.isTrue(
1586+
queries.some(
1587+
(query) =>
1588+
query.includes("MapleCfZoneAnalytics") &&
1589+
query.includes("firewallEventsAdaptiveGroups"),
1590+
),
1591+
)
1592+
}).pipe(Effect.provide(makeLayer(testDb, [], options)))
1593+
},
1594+
)
1595+
1596+
for (const next of [null, { enabled: false, maxDuration: 0 }, { enabled: true, maxDuration: 3600 }]) {
1597+
it.effect(`unavailable settings refresh preserves a paused zone ${JSON.stringify(next)}`, () => {
1598+
const testDb = createTestDb(trackedDbs)
1599+
const queries: string[] = []
1600+
return Effect.gen(function* () {
1601+
yield* TestClock.setTime(T0)
1602+
yield* seedConnection()
1603+
yield* seedStateRow({
1604+
dataset: "workers_invocations",
1605+
discoveredAt: T0,
1606+
settingsFetchedAt: T0,
1607+
})
1608+
yield* seedStateRow({
1609+
dataset: "firewall_events",
1610+
zoneId: ZONE_ID,
1611+
zoneName: ZONE_NAME,
1612+
enabled: false,
1613+
settingsJson: JSON.stringify({ enabled: false, maxDuration: 0 }),
1614+
settingsFetchedAt: T0 - 25 * 60 * MIN,
1615+
})
1616+
const database = yield* Database
1617+
yield* database.execute((db) =>
1618+
db.run(
1619+
PG.insertInto(CloudflareZoneSettings).values({
1620+
orgId: ORG,
1621+
accountId: ACCOUNT_ID,
1622+
watchNewZones: false,
1623+
zoneOverrides: {},
1624+
createdAt: T0,
1625+
updatedAt: T0,
1626+
}),
1627+
),
1628+
)
1629+
yield* CloudflareAnalyticsService.use((service) => service.pollOrg(ORG))
1630+
const row = (yield* loadStateRows).find((row) => row.dataset === "firewall_events")!
1631+
assert.isFalse(row.enabled)
1632+
assert.isFalse(queries.some((query) => query.includes("MapleCfZoneAnalytics")))
1633+
}).pipe(
1634+
Effect.provide(
1635+
makeLayer(testDb, [], {
1636+
graphqlQueries: queries,
1637+
settingsData: {
1638+
viewer: {
1639+
...settingsData.viewer,
1640+
zones: [
1641+
{ zoneTag: ZONE_ID, settings: { firewallEventsAdaptiveGroups: next } },
1642+
],
1643+
},
1644+
},
1645+
}),
1646+
),
1647+
)
1648+
})
1649+
}
1650+
1651+
it.effect("unavailable settings refresh does not resume on an unknown upstream settings node", () => {
1652+
const testDb = createTestDb(trackedDbs)
1653+
const queries: string[] = []
1654+
return Effect.gen(function* () {
1655+
yield* TestClock.setTime(T0)
1656+
yield* seedConnection()
1657+
yield* seedStateRow({ dataset: "workers_invocations", discoveredAt: T0, settingsFetchedAt: T0 })
1658+
yield* seedStateRow({
1659+
dataset: "firewall_events",
1660+
zoneId: ZONE_ID,
1661+
zoneName: ZONE_NAME,
1662+
enabled: false,
1663+
settingsJson: JSON.stringify({ enabled: false, maxDuration: 0 }),
1664+
settingsFetchedAt: T0 - 25 * 60 * MIN,
1665+
})
1666+
yield* CloudflareAnalyticsService.use((service) => service.pollOrg(ORG))
1667+
const row = (yield* loadStateRows).find((row) => row.dataset === "firewall_events")!
1668+
assert.include(row.settingsJson!, '"enabled":false')
1669+
assert.isFalse(row.enabled)
1670+
assert.isFalse(queries.some((query) => query.includes("MapleCfZoneAnalytics")))
1671+
}).pipe(
1672+
Effect.provide(
1673+
makeLayer(testDb, [], {
1674+
graphqlQueries: queries,
1675+
settingsData: {
1676+
viewer: {
1677+
...settingsData.viewer,
1678+
zones: [{ zoneTag: ZONE_ID, settings: { firewallEventsAdaptiveGroups: null } }],
1679+
},
1680+
},
1681+
}),
1682+
),
1683+
)
1684+
})
1685+
1686+
it.effect("resuming a watched zone respects cached unavailable capability", () => {
1687+
const testDb = createTestDb(trackedDbs)
1688+
return Effect.gen(function* () {
1689+
yield* TestClock.setTime(T0)
1690+
yield* seedConnection()
1691+
yield* seedStateRow({
1692+
dataset: "firewall_events",
1693+
zoneId: ZONE_ID,
1694+
zoneName: ZONE_NAME,
1695+
enabled: false,
1696+
settingsJson: JSON.stringify({ enabled: false, maxDuration: 0 }),
1697+
settingsFetchedAt: T0,
1698+
})
1699+
const database = yield* Database
1700+
yield* database.execute((db) =>
1701+
db.run(
1702+
PG.insertInto(CloudflareZoneSettings).values({
1703+
orgId: ORG,
1704+
accountId: ACCOUNT_ID,
1705+
watchNewZones: false,
1706+
zoneOverrides: {},
1707+
createdAt: T0,
1708+
updatedAt: T0,
1709+
}),
1710+
),
1711+
)
1712+
yield* CloudflareAnalyticsService.use((service) =>
1713+
service.setZoneSettings(ORG, Schema.decodeUnknownSync(UserId)("user_1"), {
1714+
accountId: ACCOUNT_ID,
1715+
watchNewZones: true,
1716+
zones: [{ zoneId: ZONE_ID, watched: true }],
1717+
}),
1718+
)
1719+
const row = (yield* loadStateRows).find((row) => row.dataset === "firewall_events")!
1720+
assert.isFalse(row.enabled)
1721+
}).pipe(Effect.provide(makeLayer(testDb, [])))
1722+
})
1723+
1724+
it.effect("disappeared unavailable zones invalidate settings and remain unpolled", () => {
1725+
const testDb = createTestDb(trackedDbs)
1726+
const queries: string[] = []
1727+
return Effect.gen(function* () {
1728+
yield* TestClock.setTime(T0)
1729+
yield* seedConnection()
1730+
yield* seedStateRow({
1731+
dataset: "firewall_events",
1732+
zoneId: ZONE_ID,
1733+
zoneName: ZONE_NAME,
1734+
enabled: false,
1735+
settingsJson: JSON.stringify({ enabled: false, maxDuration: 0 }),
1736+
settingsFetchedAt: T0,
1737+
})
1738+
yield* CloudflareAnalyticsService.use((service) => service.pollOrg(ORG))
1739+
const row = (yield* loadStateRows).find((row) => row.dataset === "firewall_events")!
1740+
assert.isFalse(row.enabled)
1741+
assert.isNull(row.settingsJson)
1742+
assert.isNull(row.settingsFetchedAt)
1743+
assert.isFalse(queries.some((query) => query.includes("MapleCfZoneAnalytics")))
1744+
}).pipe(Effect.provide(makeLayer(testDb, [], { zones: [], graphqlQueries: queries })))
1745+
})
1746+
14761747
it.effect("pollOrg disables state rows for vanished zones", () => {
14771748
const testDb = createTestDb(trackedDbs)
14781749
const captured: CapturedIngest[] = []

0 commit comments

Comments
 (0)