@hot-updater/server 1.0.0-rc.16 → 1.0.0-rc.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (309) hide show
  1. package/dist/adapters/drizzle.cjs +5 -5
  2. package/dist/adapters/drizzle.mjs +4 -4
  3. package/dist/adapters/kysely.cjs +3 -3
  4. package/dist/adapters/kysely.mjs +2 -2
  5. package/dist/adapters/mongodb.cjs +3 -3
  6. package/dist/adapters/mongodb.mjs +2 -2
  7. package/dist/adapters/mongodbAdapter.cjs +19 -1
  8. package/dist/adapters/mongodbAdapter.mjs +19 -1
  9. package/dist/adapters/prisma.cjs +5 -5
  10. package/dist/adapters/prisma.mjs +4 -4
  11. package/dist/assembly/assemblePlugins.cjs +47 -28
  12. package/dist/assembly/assemblePlugins.d.cts +3 -7
  13. package/dist/assembly/assemblePlugins.d.mts +3 -7
  14. package/dist/assembly/assemblePlugins.mjs +46 -27
  15. package/dist/assembly/clientPlugins.cjs +86 -0
  16. package/dist/assembly/clientPlugins.d.cts +16 -0
  17. package/dist/assembly/clientPlugins.d.mts +16 -0
  18. package/dist/assembly/clientPlugins.mjs +86 -0
  19. package/dist/assembly/configError.cjs +7 -0
  20. package/dist/assembly/configError.d.cts +7 -0
  21. package/dist/assembly/configError.d.mts +7 -0
  22. package/dist/assembly/configError.mjs +7 -0
  23. package/dist/assembly/databasePlugins.cjs +5 -1
  24. package/dist/assembly/databasePlugins.d.cts +5 -5
  25. package/dist/assembly/databasePlugins.d.mts +5 -5
  26. package/dist/assembly/databasePlugins.mjs +5 -1
  27. package/dist/assembly/pluginCli.cjs +125 -0
  28. package/dist/assembly/pluginCli.d.cts +59 -0
  29. package/dist/assembly/pluginCli.d.mts +59 -0
  30. package/dist/assembly/pluginCli.mjs +121 -0
  31. package/dist/createHotUpdaterCore.cjs +14 -16
  32. package/dist/createHotUpdaterCore.d.cts +10 -3
  33. package/dist/createHotUpdaterCore.d.mts +10 -3
  34. package/dist/createHotUpdaterCore.mjs +11 -13
  35. package/dist/database/aggregateBatching.cjs +626 -0
  36. package/dist/database/aggregateBatching.d.cts +10 -0
  37. package/dist/database/aggregateBatching.d.mts +10 -0
  38. package/dist/database/aggregateBatching.mjs +625 -0
  39. package/dist/{insights/errors.cjs → database/busy.cjs} +2 -15
  40. package/dist/database/busy.d.cts +12 -0
  41. package/dist/database/busy.d.mts +12 -0
  42. package/dist/{insights/errors.mjs → database/busy.mjs} +3 -14
  43. package/dist/database/database.cjs +22 -3
  44. package/dist/database/database.d.cts +15 -2
  45. package/dist/database/database.d.mts +15 -2
  46. package/dist/database/database.mjs +22 -3
  47. package/dist/database/definitions.d.cts +10 -0
  48. package/dist/database/definitions.d.mts +10 -0
  49. package/dist/database/engine.d.cts +2 -1
  50. package/dist/database/engine.d.mts +2 -1
  51. package/dist/database/engineAggregates.cjs +7 -4
  52. package/dist/database/engineAggregates.mjs +8 -5
  53. package/dist/database/engineReads.cjs +5 -3
  54. package/dist/database/engineReads.mjs +6 -4
  55. package/dist/database/engineTransaction.cjs +2 -6
  56. package/dist/database/engineTransaction.mjs +2 -6
  57. package/dist/database/fence.cjs +2 -1
  58. package/dist/database/fence.mjs +2 -1
  59. package/dist/database/index.cjs +17 -8
  60. package/dist/database/index.d.cts +5 -4
  61. package/dist/database/index.d.mts +5 -4
  62. package/dist/database/index.mjs +6 -5
  63. package/dist/database/kv/kvAdapter.cjs +15 -3
  64. package/dist/database/kv/kvAdapter.d.cts +8 -0
  65. package/dist/database/kv/kvAdapter.d.mts +8 -0
  66. package/dist/database/kv/kvAdapter.mjs +16 -4
  67. package/dist/database/resolveSchema.cjs +4 -1
  68. package/dist/database/resolveSchema.d.cts +1 -1
  69. package/dist/database/resolveSchema.d.mts +1 -1
  70. package/dist/database/resolveSchema.mjs +4 -1
  71. package/dist/database/retention.cjs +92 -0
  72. package/dist/database/retention.mjs +90 -0
  73. package/dist/database/schema.cjs +5 -2
  74. package/dist/database/schema.d.cts +30 -1
  75. package/dist/database/schema.d.mts +30 -1
  76. package/dist/database/schema.mjs +5 -2
  77. package/dist/database/sql/sqlAdapter.cjs +8 -0
  78. package/dist/database/sql/sqlAdapter.mjs +9 -1
  79. package/dist/database/sql/sqlSchema.cjs +56 -0
  80. package/dist/database/sql/sqlSchema.mjs +55 -1
  81. package/dist/db/coreDatabase.cjs +85 -0
  82. package/dist/db/coreDatabase.d.cts +57 -0
  83. package/dist/db/coreDatabase.d.mts +57 -0
  84. package/dist/db/coreDatabase.mjs +78 -0
  85. package/dist/db/index.cjs +11 -3
  86. package/dist/db/index.d.cts +7 -3
  87. package/dist/db/index.d.mts +7 -3
  88. package/dist/db/index.mjs +6 -3
  89. package/dist/db/types.d.cts +3 -3
  90. package/dist/db/types.d.mts +3 -3
  91. package/dist/diff.cjs +3 -0
  92. package/dist/diff.d.cts +2 -0
  93. package/dist/diff.d.mts +2 -0
  94. package/dist/diff.mjs +2 -0
  95. package/dist/handler.cjs +2 -14
  96. package/dist/handler.mjs +1 -13
  97. package/dist/handlerReleaseCatalogRoutes.cjs +21 -2
  98. package/dist/handlerReleaseCatalogRoutes.mjs +21 -2
  99. package/dist/index.cjs +2 -6
  100. package/dist/index.d.cts +4 -7
  101. package/dist/index.d.mts +4 -7
  102. package/dist/index.mjs +2 -4
  103. package/dist/package.cjs +1 -1
  104. package/dist/package.mjs +1 -1
  105. package/dist/{apiKeys.cjs → plugins/api-keys/apiKeys.cjs} +1 -1
  106. package/dist/{apiKeys.d.cts → plugins/api-keys/apiKeys.d.cts} +2 -2
  107. package/dist/{apiKeys.d.mts → plugins/api-keys/apiKeys.d.mts} +2 -2
  108. package/dist/{apiKeys.mjs → plugins/api-keys/apiKeys.mjs} +1 -1
  109. package/dist/plugins/api-keys/cli.cjs +115 -0
  110. package/dist/plugins/api-keys/cli.mjs +114 -0
  111. package/dist/plugins/api-keys/index.cjs +9 -6
  112. package/dist/plugins/api-keys/index.d.cts +4 -5
  113. package/dist/plugins/api-keys/index.d.mts +4 -5
  114. package/dist/plugins/api-keys/index.mjs +9 -7
  115. package/dist/plugins/api-keys/model.d.cts +20 -2
  116. package/dist/plugins/api-keys/model.d.mts +20 -2
  117. package/dist/plugins/definePlugin.cjs +1 -1
  118. package/dist/plugins/definePlugin.d.cts +130 -3
  119. package/dist/plugins/definePlugin.d.mts +130 -3
  120. package/dist/plugins/definePlugin.mjs +1 -1
  121. package/dist/plugins/index.cjs +25 -4
  122. package/dist/plugins/index.d.cts +7 -4
  123. package/dist/plugins/index.d.mts +7 -4
  124. package/dist/plugins/index.mjs +6 -4
  125. package/dist/plugins/insights/contract.cjs +193 -0
  126. package/dist/plugins/insights/contract.mjs +189 -0
  127. package/dist/{insights → plugins/insights}/domain.d.cts +60 -15
  128. package/dist/{insights → plugins/insights}/domain.d.mts +60 -15
  129. package/dist/plugins/insights/errors.cjs +15 -0
  130. package/dist/plugins/insights/errors.mjs +14 -0
  131. package/dist/{insights → plugins/insights}/eventInput.cjs +155 -22
  132. package/dist/{insights → plugins/insights}/eventInput.mjs +155 -22
  133. package/dist/plugins/insights/eventRow.cjs +49 -0
  134. package/dist/plugins/insights/eventRow.d.cts +64 -0
  135. package/dist/plugins/insights/eventRow.d.mts +64 -0
  136. package/dist/plugins/insights/eventRow.mjs +47 -0
  137. package/dist/plugins/insights/index.cjs +106 -26
  138. package/dist/plugins/insights/index.d.cts +130 -27
  139. package/dist/plugins/insights/index.d.mts +130 -27
  140. package/dist/plugins/insights/index.mjs +106 -29
  141. package/dist/plugins/insights/model.cjs +2 -2
  142. package/dist/plugins/insights/model.d.cts +1 -1
  143. package/dist/plugins/insights/model.d.mts +1 -1
  144. package/dist/plugins/insights/model.mjs +1 -1
  145. package/dist/plugins/insights/modelTypes.d.cts +176 -0
  146. package/dist/plugins/insights/modelTypes.d.mts +176 -0
  147. package/dist/plugins/insights/overview.cjs +109 -0
  148. package/dist/plugins/insights/overview.d.cts +15 -0
  149. package/dist/plugins/insights/overview.d.mts +15 -0
  150. package/dist/plugins/insights/overview.mjs +107 -0
  151. package/dist/{insights → plugins/insights}/provider.cjs +33 -14
  152. package/dist/{insights → plugins/insights}/provider.d.cts +2 -2
  153. package/dist/{insights → plugins/insights}/provider.d.mts +2 -2
  154. package/dist/{insights → plugins/insights}/provider.mjs +30 -11
  155. package/dist/{insights → plugins/insights}/queryInput.cjs +2 -2
  156. package/dist/{insights → plugins/insights}/queryInput.mjs +2 -2
  157. package/dist/plugins/insights/reads.cjs +298 -88
  158. package/dist/plugins/insights/reads.d.cts +61 -0
  159. package/dist/plugins/insights/reads.d.mts +61 -0
  160. package/dist/plugins/insights/reads.mjs +298 -90
  161. package/dist/plugins/insights/recordEvent.cjs +223 -39
  162. package/dist/plugins/insights/recordEvent.d.cts +9 -4
  163. package/dist/plugins/insights/recordEvent.d.mts +9 -4
  164. package/dist/plugins/insights/recordEvent.mjs +221 -37
  165. package/dist/{insights → plugins/insights}/routes.cjs +3 -30
  166. package/dist/{insights → plugins/insights}/routes.mjs +4 -28
  167. package/dist/plugins/insights/schema.cjs +182 -40
  168. package/dist/plugins/insights/schema.d.cts +446 -6
  169. package/dist/plugins/insights/schema.d.mts +446 -6
  170. package/dist/plugins/insights/schema.mjs +180 -41
  171. package/dist/plugins/insights/testing/eventRow.d.mts +64 -0
  172. package/dist/plugins/insights/testing/expectInsightsIndex.mjs +18 -0
  173. package/dist/plugins/insights/testing/fixtures.d.mts +8 -0
  174. package/dist/plugins/insights/testing/fixtures.mjs +25 -0
  175. package/dist/plugins/insights/testing/index.d.mts +24 -0
  176. package/dist/plugins/insights/testing/index.mjs +25 -0
  177. package/dist/plugins/insights/testing/insightsModelTests.mjs +714 -0
  178. package/dist/plugins/insights/testing/modelTypes.d.mts +176 -0
  179. package/dist/plugins/insights/testing/setupInsightsHttpTestSuite.d.mts +11 -0
  180. package/dist/plugins/insights/testing/setupInsightsHttpTestSuite.mjs +107 -0
  181. package/dist/plugins/insights/testing/setupInsightsModelTestSuite.d.mts +11 -0
  182. package/dist/plugins/insights/testing/setupInsightsModelTestSuite.mjs +31 -0
  183. package/dist/plugins/insights/testing/types.d.mts +26 -0
  184. package/dist/{insights → plugins/insights}/types.d.cts +3 -2
  185. package/dist/{insights → plugins/insights}/types.d.mts +3 -2
  186. package/package.json +18 -7
  187. package/src/adapters/drizzle.conformance.integration.spec.ts +2 -2
  188. package/src/adapters/drizzle.readBudgets.integration.spec.ts +6 -4
  189. package/src/adapters/drizzle.spec.ts +15 -7
  190. package/src/adapters/drizzle.ts +6 -6
  191. package/src/adapters/kysely.conformance.integration.spec.ts +2 -2
  192. package/src/adapters/kysely.readBudgets.integration.spec.ts +4 -2
  193. package/src/adapters/kysely.spec.ts +13 -9
  194. package/src/adapters/kysely.ts +2 -2
  195. package/src/adapters/mongodb.integration.spec.ts +98 -7
  196. package/src/adapters/mongodb.ts +2 -2
  197. package/src/adapters/mongodbAdapter.ts +14 -0
  198. package/src/adapters/prisma.conformance.integration.spec.ts +2 -2
  199. package/src/adapters/prisma.integration.spec.ts +16 -8
  200. package/src/adapters/prisma.readBudgets.integration.spec.ts +5 -2
  201. package/src/adapters/prisma.spec.ts +17 -9
  202. package/src/adapters/prisma.ts +6 -6
  203. package/src/adapters/prismaTestClients.ts +8 -1
  204. package/src/assembly/assemblePlugins.ts +73 -40
  205. package/src/assembly/assembly.spec.ts +63 -11
  206. package/src/assembly/assembly.types.spec.ts +50 -2
  207. package/src/assembly/clientPlugins.ts +113 -0
  208. package/src/assembly/configError.ts +4 -0
  209. package/src/assembly/databasePlugins.ts +11 -5
  210. package/src/assembly/pluginCli.spec.ts +254 -0
  211. package/src/assembly/pluginCli.ts +248 -0
  212. package/src/assembly/{builtInRoutes.spec.ts → pluginRoutes.spec.ts} +10 -37
  213. package/src/createHotUpdaterCore.ts +21 -17
  214. package/src/database/aggregateBatching.spec.ts +577 -0
  215. package/src/database/aggregateBatching.ts +803 -0
  216. package/src/{insights/errors.spec.ts → database/busy.spec.ts} +2 -5
  217. package/src/{insights/errors.ts → database/busy.ts} +1 -13
  218. package/src/database/database.ts +39 -8
  219. package/src/database/definitions.ts +4 -0
  220. package/src/database/engineAggregates.spec.ts +4 -7
  221. package/src/database/engineAggregates.ts +5 -9
  222. package/src/database/engineReads.ts +7 -5
  223. package/src/database/engineTransaction.ts +1 -7
  224. package/src/database/fence.spec.ts +5 -5
  225. package/src/database/fence.ts +4 -0
  226. package/src/database/index.ts +13 -7
  227. package/src/database/kv/kvAdapter.batching.integration.spec.ts +15 -0
  228. package/src/database/kv/kvAdapter.conformance.integration.spec.ts +2 -0
  229. package/src/database/kv/kvAdapter.spec.ts +128 -1
  230. package/src/database/kv/kvAdapter.ts +30 -1
  231. package/src/database/kv/kvTestStore.ts +28 -1
  232. package/src/database/resolveSchema.ts +4 -1
  233. package/src/database/retention.spec.ts +314 -0
  234. package/src/database/retention.ts +129 -0
  235. package/src/database/schema.ts +44 -0
  236. package/src/database/sql/sqlAdapter.integration.spec.ts +4 -7
  237. package/src/database/sql/sqlAdapter.readBudgets.integration.spec.ts +18 -4
  238. package/src/database/sql/sqlAdapter.spec.ts +91 -3
  239. package/src/database/sql/sqlAdapter.ts +20 -0
  240. package/src/database/sql/sqlSchema.ts +81 -0
  241. package/src/databaseTestSuite.spec.ts +9 -4
  242. package/src/db/coreDatabase.ts +153 -0
  243. package/src/db/engineSql.spec.ts +8 -7
  244. package/src/db/index.ts +19 -2
  245. package/src/db/pluginTables.spec.ts +57 -27
  246. package/src/db/types.ts +3 -3
  247. package/src/diff.ts +6 -0
  248. package/src/handler-standalone.integration.spec.ts +2 -3
  249. package/src/handler.ts +1 -32
  250. package/src/handlerReleaseCatalogRoutes.ts +26 -2
  251. package/src/index.ts +0 -10
  252. package/src/{apiKeys.integration.spec.ts → plugins/api-keys/apiKeys.integration.spec.ts} +4 -4
  253. package/src/{apiKeys.spec.ts → plugins/api-keys/apiKeys.spec.ts} +3 -3
  254. package/src/{apiKeys.ts → plugins/api-keys/apiKeys.ts} +1 -1
  255. package/src/plugins/api-keys/apiKeysPlugin.spec.ts +11 -15
  256. package/src/plugins/api-keys/cli.spec.ts +187 -0
  257. package/src/plugins/api-keys/cli.ts +140 -0
  258. package/src/plugins/api-keys/index.ts +48 -41
  259. package/src/plugins/api-keys/model.ts +21 -2
  260. package/src/plugins/definePlugin.ts +144 -2
  261. package/src/plugins/index.ts +20 -2
  262. package/src/plugins/insights/contract.spec.ts +285 -0
  263. package/src/plugins/insights/contract.ts +372 -0
  264. package/src/{insights → plugins/insights}/domain.ts +73 -15
  265. package/src/plugins/insights/errors.ts +11 -0
  266. package/src/{insights → plugins/insights}/eventInput.ts +189 -29
  267. package/src/plugins/insights/eventRow.ts +209 -0
  268. package/src/plugins/insights/index.ts +181 -45
  269. package/src/{insights → plugins/insights}/insights.integration.spec.ts +330 -34
  270. package/src/plugins/insights/insightsRollout.integration.spec.ts +1 -2
  271. package/src/plugins/insights/model.spec.ts +3 -5
  272. package/src/plugins/insights/model.ts +2 -3
  273. package/src/plugins/insights/modelTypes.ts +197 -0
  274. package/src/plugins/insights/overview.spec.ts +64 -0
  275. package/src/plugins/insights/overview.ts +214 -0
  276. package/src/{insights → plugins/insights}/provider.spec.ts +21 -10
  277. package/src/{insights → plugins/insights}/provider.ts +58 -21
  278. package/src/{insights → plugins/insights}/queryInput.ts +2 -2
  279. package/src/plugins/insights/reads.spec.ts +340 -52
  280. package/src/plugins/insights/reads.ts +453 -123
  281. package/src/plugins/insights/recordEvent.spec.ts +474 -20
  282. package/src/plugins/insights/recordEvent.ts +301 -63
  283. package/src/plugins/insights/retention.spec.ts +115 -0
  284. package/src/{insights → plugins/insights}/routes.ts +1 -31
  285. package/src/plugins/insights/schema.ts +356 -176
  286. package/src/plugins/insights/testing/expectInsightsIndex.spec.ts +42 -0
  287. package/src/plugins/insights/testing/expectInsightsIndex.ts +20 -0
  288. package/src/plugins/insights/testing/fixtures.ts +30 -0
  289. package/src/plugins/insights/testing/index.ts +45 -0
  290. package/src/plugins/insights/testing/insightsModelTests.ts +860 -0
  291. package/src/plugins/insights/testing/setupInsightsHttpTestSuite.ts +152 -0
  292. package/src/plugins/insights/testing/setupInsightsModelTestSuite.ts +36 -0
  293. package/src/plugins/insights/testing/types.ts +30 -0
  294. package/src/{insights → plugins/insights}/types.ts +1 -1
  295. package/src/readBudgets.testFixtures.ts +2 -2
  296. package/src/releaseCatalogRoutes.integration.spec.ts +7 -0
  297. package/src/retention.spec.ts +73 -0
  298. package/src/runtime.spec.ts +11 -12
  299. package/src/runtime.testFixtures.ts +7 -2
  300. package/src/testUtilsMutation.integration.spec.ts +2 -1
  301. package/src/testUtilsPackage.integration.spec.ts +7 -3
  302. package/dist/db/builtInDatabase.cjs +0 -104
  303. package/dist/db/builtInDatabase.d.cts +0 -38
  304. package/dist/db/builtInDatabase.d.mts +0 -38
  305. package/dist/db/builtInDatabase.mjs +0 -97
  306. package/dist/plugins/builtIn.cjs +0 -7
  307. package/dist/plugins/builtIn.mjs +0 -6
  308. package/src/db/builtInDatabase.ts +0 -149
  309. package/src/plugins/builtIn.ts +0 -5
@@ -2,12 +2,28 @@ import { defineAggregate, defineTable } from "../../database/schema.mjs";
2
2
  //#region src/plugins/insights/schema.ts
3
3
  const HOUR_MS = 36e5;
4
4
  const DAY_MS = 864e5;
5
+ const DEFAULT_INSIGHTS_RETENTION = {
6
+ rawDays: 90,
7
+ dailyDays: 400
8
+ };
9
+ const bucketRetention = (days) => ({
10
+ field: "bucket_start_ms",
11
+ days
12
+ });
5
13
  const MOVEMENTS = /* @__PURE__ */ new Set([
6
14
  "UPDATE_DOWNLOADED",
7
15
  "UPDATE_APPLIED",
8
- "RECOVERED"
16
+ "RECOVERED",
17
+ "UPDATE_FAILED"
9
18
  ]);
10
- const bundleEvents = defineTable({
19
+ /** A failed update check: it names no target bundle, so no bundle list shows it. */
20
+ const isFailedCheck = (row) => row.type === "UPDATE_FAILED" && row.metadata?.failure?.stage === "check";
21
+ /**
22
+ * Downloads, applies, recoveries, and update failures, whole. An UNCHANGED
23
+ * report counts as a launch and moves its installation's head, but no list
24
+ * shows it, so no row keeps it.
25
+ */
26
+ const bundleEvents = (days) => defineTable({
11
27
  id: {
12
28
  type: "string",
13
29
  maxLength: 36
@@ -65,11 +81,14 @@ const bundleEvents = defineTable({
65
81
  type: "string",
66
82
  compute: (row) => MOVEMENTS.has(row.type) ? row.install_id : null
67
83
  },
68
- /** The bundle a bundle filter matches: `from:<bundle>` for RECOVERED, else `to:<bundle>`. */
84
+ /**
85
+ * The bundle a bundle filter matches: `from:<bundle>` for RECOVERED,
86
+ * none for a failed check, else `to:<bundle>`.
87
+ */
69
88
  bundle_ref: {
70
89
  type: "string",
71
90
  multi: true,
72
- compute: (row) => [row.type === "RECOVERED" && row.from_bundle_id !== null ? `from:${row.from_bundle_id}` : `to:${row.to_bundle_id}`]
91
+ compute: (row) => isFailedCheck(row) ? [] : [row.type === "RECOVERED" && row.from_bundle_id !== null ? `from:${row.from_bundle_id}` : `to:${row.to_bundle_id}`]
73
92
  }
74
93
  },
75
94
  indexes: {
@@ -100,10 +119,18 @@ const bundleEvents = defineTable({
100
119
  eq: ["day"],
101
120
  sort: ["received_at_ms"]
102
121
  }
122
+ },
123
+ retention: {
124
+ field: "day",
125
+ days
103
126
  }
104
127
  });
105
- /** Each installation's latest event, whole, so reading it is one point read. */
106
- const bundleEventHeads = defineTable({
128
+ /**
129
+ * Each installation's latest event, whole, so reading it is one point read.
130
+ * Its gauges count it in the UTC day of that event. An update failure moves
131
+ * nothing, so no head holds one.
132
+ */
133
+ const bundleEventHeads = (days) => defineTable({
107
134
  install_id: {
108
135
  type: "string",
109
136
  maxLength: 255
@@ -147,18 +174,17 @@ const bundleEventHeads = defineTable({
147
174
  app_version: { type: "string" },
148
175
  channel: { type: "string" },
149
176
  metadata: { type: "json" },
150
- received_at_ms: { type: "integer" },
151
- current_release_id: {
152
- type: "string",
153
- maxLength: 36,
154
- required: false
155
- }
177
+ received_at_ms: { type: "integer" }
156
178
  }, {
157
179
  key: ["install_id"],
158
180
  indexes: { byUser: {
159
181
  eq: ["user_id"],
160
182
  sort: ["install_id"]
161
- } }
183
+ } },
184
+ retention: {
185
+ field: "received_at_ms",
186
+ days
187
+ }
162
188
  });
163
189
  /**
164
190
  * Shards are keyed by install id. Counters are blind increments and never
@@ -168,6 +194,10 @@ const bundleEventHeads = defineTable({
168
194
  * on DynamoDB Local retried 2–24% at 16, almost all on gauge rows, and 1–5%
169
195
  * with gauges at 32. Sketches stay at 16: each shard row carries 2 KB of
170
196
  * registers that every read merges.
197
+ *
198
+ * Every Insights aggregate is `batched`: on DynamoDB and Firestore, which
199
+ * bill each write, an event's changes apply after it commits, merged with
200
+ * other events' into one write per row, on one shard per writer.
171
201
  */
172
202
  const COUNTER_SHARDS = 8;
173
203
  const GAUGE_SHARDS = 32;
@@ -184,24 +214,108 @@ const window = {
184
214
  eq: ["identity"],
185
215
  sort: ["bucket_start_ms"]
186
216
  };
187
- const insightsOverview = defineAggregate(identityFields, {
217
+ /**
218
+ * Counters of one period kind: hourly, daily, or lifetime at bucket 0. A
219
+ * release or channel row counts downloads, launches, and failed launches,
220
+ * and downloads a patch delivered and those that fell back from one. A
221
+ * release's lifetime row counts its failed updates (`failed_updates`), since
222
+ * no breakdown row outlives the raw period; windowed reads sum
223
+ * `insights_failures` instead.
224
+ */
225
+ const counters = (retention) => defineAggregate(identityFields, {
188
226
  key: ["identity", "bucket_start_ms"],
189
227
  counters: [
190
228
  "downloads",
191
229
  "launches",
192
- "failed_launches"
230
+ "failed_launches",
231
+ "failed_updates",
232
+ "patch_downloads",
233
+ "patch_fallbacks"
193
234
  ],
194
235
  shards: COUNTER_SHARDS,
195
- indexes: { window }
236
+ batched: true,
237
+ indexes: { window },
238
+ ...retention === void 0 ? {} : { retention }
196
239
  });
197
- const insightsSketches = defineAggregate(identityFields, {
240
+ /**
241
+ * Unique-installation sketches of one period kind. Rows of a failure
242
+ * identity (`failure` and `check` scopes) keep only `failed_users`, so a
243
+ * release's launch rows never grow by a failure's registers.
244
+ */
245
+ const sketches = (retention) => defineAggregate(identityFields, {
198
246
  key: ["identity", "bucket_start_ms"],
199
- distinct: ["launch_users", "activity_users"],
247
+ distinct: [
248
+ "launch_users",
249
+ "activity_users",
250
+ "failed_users"
251
+ ],
200
252
  shards: SKETCH_SHARDS,
253
+ batched: true,
254
+ indexes: { window },
255
+ retention
256
+ });
257
+ /** Installations whose update to a release failed, since its first failure: kept, at bucket 0. */
258
+ const lifetimeSketches = () => defineAggregate(identityFields, {
259
+ key: ["identity", "bucket_start_ms"],
260
+ distinct: ["failed_users"],
261
+ shards: SKETCH_SHARDS,
262
+ batched: true,
201
263
  indexes: { window }
202
264
  });
203
- /** Installations counted in the hour of their latest event. */
204
- const insightsDistribution = defineAggregate({
265
+ /**
266
+ * Update failures by what failed, and recoveries by why the crashed process
267
+ * exited, a row an hour. `release_id` is the failed update's target release,
268
+ * or empty for a failed check or an unknown target, and the recovered
269
+ * release for a recovery. A failure's `stage` and `reason` say where and why
270
+ * it failed, and `detail` what else the client knew, as the JSON array
271
+ * `[resource, httpStatus, originCode, transport]`. A recovery's stage is
272
+ * `launch` and its reason the exit reason, with an empty detail. Every index
273
+ * is in key order, so its counters stay blind increments.
274
+ */
275
+ const insightsFailures = (retention) => defineAggregate({
276
+ platform: {
277
+ type: "string",
278
+ maxLength: 16
279
+ },
280
+ channel: { type: "string" },
281
+ bucket_start_ms: { type: "integer" },
282
+ release_id: {
283
+ type: "string",
284
+ maxLength: 36
285
+ },
286
+ stage: {
287
+ type: "string",
288
+ maxLength: 16
289
+ },
290
+ reason: {
291
+ type: "string",
292
+ maxLength: 64
293
+ },
294
+ detail: {
295
+ type: "string",
296
+ maxLength: 160
297
+ }
298
+ }, {
299
+ key: [
300
+ "platform",
301
+ "channel",
302
+ "bucket_start_ms",
303
+ "release_id",
304
+ "stage",
305
+ "reason",
306
+ "detail"
307
+ ],
308
+ counters: ["events"],
309
+ shards: COUNTER_SHARDS,
310
+ batched: true,
311
+ indexes: { byScope: {
312
+ eq: ["platform", "channel"],
313
+ sort: ["bucket_start_ms"]
314
+ } },
315
+ retention
316
+ });
317
+ /** Installations counted in the UTC day of their latest event, so reads sum whole UTC days. */
318
+ const insightsDistribution = (retention) => defineAggregate({
205
319
  channel: { type: "string" },
206
320
  platform: {
207
321
  type: "string",
@@ -223,6 +337,7 @@ const insightsDistribution = defineAggregate({
223
337
  ],
224
338
  gauges: ["latest_installations"],
225
339
  shards: GAUGE_SHARDS,
340
+ batched: true,
226
341
  indexes: {
227
342
  byScope: {
228
343
  eq: ["channel", "platform"],
@@ -236,10 +351,11 @@ const insightsDistribution = defineAggregate({
236
351
  ],
237
352
  sort: ["bucket_start_ms"]
238
353
  }
239
- }
354
+ },
355
+ retention
240
356
  });
241
- /** Latest events by the bundle they came from or went to. */
242
- const insightsLatestByBundle = defineAggregate({
357
+ /** Latest events by the bundle they came from or went to, bucketed like the distribution. */
358
+ const insightsLatestByBundle = (retention) => defineAggregate({
243
359
  platform: {
244
360
  type: "string",
245
361
  maxLength: 16
@@ -269,6 +385,7 @@ const insightsLatestByBundle = defineAggregate({
269
385
  ],
270
386
  gauges: ["installations"],
271
387
  shards: GAUGE_SHARDS,
388
+ batched: true,
272
389
  indexes: { byBundle: {
273
390
  eq: [
274
391
  "platform",
@@ -278,14 +395,16 @@ const insightsLatestByBundle = defineAggregate({
278
395
  "type"
279
396
  ],
280
397
  sort: ["bucket_start_ms"]
281
- } }
398
+ } },
399
+ retention
282
400
  });
283
401
  /**
284
- * Events by outcome and the bundle a bundle filter matches, a row an hour;
285
- * and every event, a row a UTC day (`DAILY_EVENTS`). Bundle counts sum the
286
- * hourly rows, and event lists read either to skip days without events.
402
+ * Stored events by outcome and the bundle a bundle filter matches, a row an
403
+ * hour, which a failed check has none of; and every stored event, a row a UTC
404
+ * day (`DAILY_EVENTS`). Bundle counts sum the hourly rows, and event lists
405
+ * read either to skip days without events.
287
406
  */
288
- const insightsOutcomes = defineAggregate({
407
+ const insightsOutcomes = (retention) => defineAggregate({
289
408
  platform: {
290
409
  type: "string",
291
410
  maxLength: 16
@@ -310,6 +429,7 @@ const insightsOutcomes = defineAggregate({
310
429
  ],
311
430
  counters: ["events"],
312
431
  shards: COUNTER_SHARDS,
432
+ batched: true,
313
433
  indexes: { byRef: {
314
434
  eq: [
315
435
  "platform",
@@ -318,12 +438,13 @@ const insightsOutcomes = defineAggregate({
318
438
  "bundle_ref"
319
439
  ],
320
440
  sort: ["bucket_start_ms"]
321
- } }
441
+ } },
442
+ retention
322
443
  });
323
444
  /**
324
- * The `insights_outcomes` identity that counts every event, for the global
325
- * event list. Its bucket is a UTC day, not an hour. Every event's platform
326
- * is ios or android, so no outcome row of a bundle filter shares it.
445
+ * The `insights_outcomes` identity that counts every stored event, for the
446
+ * global event list. Its bucket is a UTC day, not an hour. Every event's
447
+ * platform is ios or android, so no outcome row of a bundle filter shares it.
327
448
  */
328
449
  const DAILY_EVENTS = {
329
450
  platform: "*",
@@ -331,14 +452,32 @@ const DAILY_EVENTS = {
331
452
  type: "",
332
453
  bundle_ref: ""
333
454
  };
334
- const insightsSchema = {
335
- bundle_events: bundleEvents,
336
- bundle_event_heads: bundleEventHeads,
337
- insights_overview: insightsOverview,
338
- insights_sketches: insightsSketches,
339
- insights_distribution: insightsDistribution,
340
- insights_latest_by_bundle: insightsLatestByBundle,
341
- insights_outcomes: insightsOutcomes
455
+ /**
456
+ * Insights' tables, each expiring after its period. The periods are values
457
+ * the engine applies at runtime; the tables and indexes are the same for
458
+ * any periods.
459
+ */
460
+ const createInsightsSchema = ({ rawDays, dailyDays } = DEFAULT_INSIGHTS_RETENTION) => {
461
+ const hourly = bucketRetention(rawDays);
462
+ const daily = bucketRetention(dailyDays);
463
+ return {
464
+ bundle_events: bundleEvents(rawDays),
465
+ bundle_event_heads: bundleEventHeads(dailyDays),
466
+ /** Hourly counters and sketches: the raw period. */
467
+ insights_overview: counters(hourly),
468
+ insights_sketches: sketches(hourly),
469
+ /** Daily counters and sketches: the daily period. */
470
+ insights_overview_daily: counters(daily),
471
+ insights_sketches_daily: sketches(daily),
472
+ /** A release's counters since its first event, and its failed installations: kept. */
473
+ insights_overview_lifetime: counters(),
474
+ insights_sketches_lifetime: lifetimeSketches(),
475
+ insights_distribution: insightsDistribution(daily),
476
+ insights_latest_by_bundle: insightsLatestByBundle(daily),
477
+ insights_outcomes: insightsOutcomes(hourly),
478
+ insights_failures: insightsFailures(hourly)
479
+ };
342
480
  };
481
+ const insightsSchema = createInsightsSchema();
343
482
  //#endregion
344
- export { DAILY_EVENTS, DAY_MS, HOUR_MS, insightsSchema };
483
+ export { DAILY_EVENTS, DAY_MS, DEFAULT_INSIGHTS_RETENTION, HOUR_MS, createInsightsSchema, insightsSchema, isFailedCheck };
@@ -0,0 +1,64 @@
1
+ import { DatabaseJsonObject, Platform } from "@hot-updater/plugin-core";
2
+ //#region src/plugins/insights/eventRow.d.ts
3
+ /** Where an update failed, and what failed; open sets, `unknown` for any other value. */
4
+ type BundleEventFailureStage = "check" | "download" | "install" | "unknown";
5
+ type BundleEventFailureReason = "network" | "http" | "invalid_response" | "hash_mismatch" | "signature" | "patch" | "extract" | "storage" | "unknown";
6
+ /** An `UPDATE_FAILED` report's failure, as stored. */
7
+ type BundleEventFailure = DatabaseJsonObject & {
8
+ readonly stage: BundleEventFailureStage;
9
+ readonly reason: BundleEventFailureReason;
10
+ /** What the client was fetching or writing. */
11
+ readonly resource?: "catalog" | "artifact" | "manifest" | "file" | "patch" | "archive" | "unknown";
12
+ readonly http_status?: number;
13
+ /** How the connection failed, when it did. */
14
+ readonly transport?: "timeout" | "dns" | "tls" | "connection" | "offline" | "cancelled" | "unknown";
15
+ /** The storage origin's error code, such as `ExpiredToken`. */
16
+ readonly origin_code?: string;
17
+ /** Android's `ApplicationExitInfo` reason for the process before this one. */
18
+ readonly previous_process_exit?: string;
19
+ };
20
+ /** Ancillary report data; queryable identity and lifecycle fields stay on the row. */
21
+ type DatabaseBundleEventMetadata = DatabaseJsonObject & {
22
+ readonly cohort: string;
23
+ readonly update_strategy: "fingerprint" | "appVersion" | null;
24
+ readonly fingerprint_hash: string | null;
25
+ readonly sdk_version: string | null;
26
+ /** `UPDATE_FAILED`: what failed. */
27
+ readonly failure?: BundleEventFailure;
28
+ /** `UPDATE_DOWNLOADED`: how the bundle arrived. */
29
+ readonly delivery?: "patch" | "manifest" | "archive" | "unknown";
30
+ /** `UPDATE_DOWNLOADED`: a patch failed and the full files came instead. */
31
+ readonly patch_fallback?: boolean;
32
+ /** `RECOVERED`: Android's `ApplicationExitInfo` reason for the crashed process. */
33
+ readonly previous_process_exit?: string;
34
+ };
35
+ type BundleEventRowBase = {
36
+ readonly id: string;
37
+ readonly install_id: string;
38
+ readonly user_id: string | null;
39
+ readonly from_release_id: string | null;
40
+ readonly to_release_id: string | null;
41
+ readonly to_bundle_id: string;
42
+ readonly platform: Platform;
43
+ readonly app_version: string;
44
+ readonly channel: string;
45
+ readonly metadata: DatabaseBundleEventMetadata;
46
+ readonly received_at_ms: number;
47
+ };
48
+ type BundleEventRow = BundleEventRowBase & ({
49
+ readonly type: "UPDATE_DOWNLOADED";
50
+ readonly from_bundle_id: string;
51
+ } | {
52
+ readonly type: "UPDATE_APPLIED" | "RECOVERED";
53
+ readonly from_bundle_id: string;
54
+ } |
55
+ /** An update that failed: `from` is the running bundle, `to` the target (for a check, the running bundle). */
56
+ {
57
+ readonly type: "UPDATE_FAILED";
58
+ readonly from_bundle_id: string;
59
+ } | {
60
+ readonly type: "UNCHANGED";
61
+ readonly from_bundle_id: null;
62
+ });
63
+ //#endregion
64
+ export { BundleEventFailure, BundleEventFailureReason, BundleEventFailureStage, BundleEventRow, BundleEventRowBase, DatabaseBundleEventMetadata };
@@ -0,0 +1,18 @@
1
+ import { expect } from "vitest";
2
+ //#region src/plugins/insights/testing/expectInsightsIndex.ts
3
+ /** Allow committed secondary indexes to catch up; query failures still fail. */
4
+ const expectInsightsIndex = async (query, expected) => {
5
+ const deadline = Date.now() + 5e3;
6
+ for (;;) {
7
+ const actual = await query();
8
+ try {
9
+ expect(actual).toEqual(expected);
10
+ return;
11
+ } catch (error) {
12
+ if (Date.now() >= deadline) throw error;
13
+ }
14
+ await new Promise((resolve) => setTimeout(resolve, 50));
15
+ }
16
+ };
17
+ //#endregion
18
+ export { expectInsightsIndex };
@@ -0,0 +1,8 @@
1
+ import { BundleEventRow } from "./eventRow.mjs";
2
+ //#region src/plugins/insights/testing/fixtures.d.ts
3
+ /** An applied update from install `suffix`, received at `receivedAtMs`. */
4
+ declare const createBundleEventRowFixture: (suffix: string, receivedAtMs: number) => Extract<BundleEventRow, {
5
+ type: "UPDATE_APPLIED" | "RECOVERED";
6
+ }>;
7
+ //#endregion
8
+ export { createBundleEventRowFixture };
@@ -0,0 +1,25 @@
1
+ //#region src/plugins/insights/testing/fixtures.ts
2
+ const fixtureId = (suffix) => `00000000-0000-7000-8000-${suffix.padStart(12, "0")}`;
3
+ /** An applied update from install `suffix`, received at `receivedAtMs`. */
4
+ const createBundleEventRowFixture = (suffix, receivedAtMs) => ({
5
+ id: fixtureId(suffix),
6
+ type: "UPDATE_APPLIED",
7
+ install_id: `install-${suffix}`,
8
+ user_id: null,
9
+ metadata: {
10
+ cohort: "0",
11
+ update_strategy: "appVersion",
12
+ fingerprint_hash: null,
13
+ sdk_version: null
14
+ },
15
+ from_bundle_id: fixtureId(`${Number(suffix) + 1e3}`),
16
+ from_release_id: null,
17
+ to_bundle_id: fixtureId(`${Number(suffix) + 2e3}`),
18
+ to_release_id: null,
19
+ platform: "ios",
20
+ app_version: "1.0.0",
21
+ channel: "production",
22
+ received_at_ms: receivedAtMs
23
+ });
24
+ //#endregion
25
+ export { createBundleEventRowFixture };
@@ -0,0 +1,24 @@
1
+ import { InsightsModel } from "./modelTypes.mjs";
2
+ import { DatabaseTestLifecycle, DatabaseTestState, HttpTestClient, HttpTestRequest } from "./types.mjs";
3
+ import { createBundleEventRowFixture } from "./fixtures.mjs";
4
+ import { setupInsightsHttpTestSuite } from "./setupInsightsHttpTestSuite.mjs";
5
+ import { setupInsightsModelTestSuite } from "./setupInsightsModelTestSuite.mjs";
6
+ //#region src/plugins/insights/testing/index.d.ts
7
+ /**
8
+ * The Insights plugin's tests, for `setupDatabaseTestSuite`'s `plugins`: its
9
+ * HTTP routes on the provider's server, which must run `insights()`, and
10
+ * with `createModel` its report contract on the provider's database, such as
11
+ * `(database) => createInsightsModel(createDatabasePluginApis(database,
12
+ * [insights()]).insights)`.
13
+ */
14
+ declare const insightsTestSuite: <TDatabase = unknown>(options?: {
15
+ readonly createModel?: (database: TDatabase) => InsightsModel;
16
+ }) => {
17
+ name: string;
18
+ register: (context: {
19
+ readonly getClient: () => HttpTestClient;
20
+ readonly getDatabase: () => TDatabase;
21
+ }) => void;
22
+ };
23
+ //#endregion
24
+ export { type DatabaseTestLifecycle, type DatabaseTestState, type HttpTestClient, type HttpTestRequest, createBundleEventRowFixture, insightsTestSuite, setupInsightsHttpTestSuite, setupInsightsModelTestSuite };
@@ -0,0 +1,25 @@
1
+ import { createBundleEventRowFixture } from "./fixtures.mjs";
2
+ import { registerInsightsModelTests } from "./insightsModelTests.mjs";
3
+ import { setupInsightsHttpTestSuite } from "./setupInsightsHttpTestSuite.mjs";
4
+ import { setupInsightsModelTestSuite } from "./setupInsightsModelTestSuite.mjs";
5
+ import { describe } from "vitest";
6
+ //#region src/plugins/insights/testing/index.ts
7
+ /**
8
+ * The Insights plugin's tests, for `setupDatabaseTestSuite`'s `plugins`: its
9
+ * HTTP routes on the provider's server, which must run `insights()`, and
10
+ * with `createModel` its report contract on the provider's database, such as
11
+ * `(database) => createInsightsModel(createDatabasePluginApis(database,
12
+ * [insights()]).insights)`.
13
+ */
14
+ const insightsTestSuite = (options = {}) => ({
15
+ name: "Insights plugin",
16
+ register: (context) => {
17
+ setupInsightsHttpTestSuite({ getClient: context.getClient });
18
+ const { createModel } = options;
19
+ if (createModel !== void 0) describe("Insights model", () => {
20
+ registerInsightsModelTests({ getDatabase: () => createModel(context.getDatabase()) });
21
+ });
22
+ }
23
+ });
24
+ //#endregion
25
+ export { createBundleEventRowFixture, insightsTestSuite, setupInsightsHttpTestSuite, setupInsightsModelTestSuite };