@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
@@ -0,0 +1,254 @@
1
+ import { createMemoryAdapter } from "@hot-updater/plugin-core/internal";
2
+ import { describe, expect, it } from "vitest";
3
+
4
+ import { apiKeys } from "../plugins/api-keys";
5
+ import { definePlugin } from "../plugins/definePlugin";
6
+ import { insights } from "../plugins/insights";
7
+ import {
8
+ clientAuthOf,
9
+ clientPluginsOf,
10
+ generateClientCredential,
11
+ pluginCommandsOf,
12
+ provisionClientCredential,
13
+ } from "./pluginCli";
14
+
15
+ const run = async () => {};
16
+
17
+ const withCommands = (id: string, commands: readonly unknown[]) =>
18
+ ({
19
+ id,
20
+ schemaVersion: "1",
21
+ schema: {},
22
+ init: () => ({ api: {} }),
23
+ cli: { commands },
24
+ }) as never;
25
+
26
+ const notes = definePlugin({
27
+ id: "notes",
28
+ schemaVersion: "1",
29
+ schema: {},
30
+ init: () => ({ api: { count: () => 0 } }),
31
+ cli: {
32
+ commands: [
33
+ {
34
+ name: "notes",
35
+ description: "Manage notes",
36
+ commands: [
37
+ {
38
+ name: "count",
39
+ description: "Count notes",
40
+ async run({ api, ui }) {
41
+ ui.print(String(api.count()));
42
+ },
43
+ },
44
+ ],
45
+ },
46
+ ],
47
+ },
48
+ });
49
+
50
+ describe("pluginCommandsOf", () => {
51
+ it("lists each plugin's top-level commands with its plugin", () => {
52
+ const entries = pluginCommandsOf([notes, apiKeys()]);
53
+ expect(
54
+ entries.map(({ plugin, command }) => [plugin, command.name]),
55
+ ).toEqual([
56
+ ["notes", "notes"],
57
+ ["apiKeys", "api-key"],
58
+ ]);
59
+ expect(pluginCommandsOf([])).toEqual([]);
60
+ });
61
+
62
+ it.each([
63
+ [
64
+ [{ name: "Notes", description: "x", run }],
65
+ 'command "Notes" needs a name of lowercase words joined by hyphens',
66
+ ],
67
+ [[{ name: "notes", run }], "and a description"],
68
+ [
69
+ [{ name: "notes", description: "x" }],
70
+ "needs either subcommands or run, not both",
71
+ ],
72
+ [
73
+ [{ name: "notes", description: "x", run, commands: [] }],
74
+ "needs either subcommands or run, not both",
75
+ ],
76
+ [[{ name: "notes", description: "x", commands: [] }], "at least one"],
77
+ [
78
+ [
79
+ {
80
+ name: "notes",
81
+ description: "x",
82
+ commands: [
83
+ { name: "add", description: "x", run },
84
+ { name: "add", description: "y", run },
85
+ ],
86
+ },
87
+ ],
88
+ 'has two subcommands named "add"',
89
+ ],
90
+ [
91
+ [
92
+ {
93
+ name: "notes",
94
+ description: "x",
95
+ arguments: [{ name: "configPath", description: "x" }],
96
+ run,
97
+ },
98
+ ],
99
+ 'other than "configPath"',
100
+ ],
101
+ [
102
+ [
103
+ {
104
+ name: "notes",
105
+ description: "x",
106
+ options: [{ flags: "-y", description: "x" }],
107
+ run,
108
+ },
109
+ ],
110
+ "needs --flags and a description",
111
+ ],
112
+ ])("refuses a malformed command (%#)", (commands, message) => {
113
+ expect(() => pluginCommandsOf([withCommands("notes", commands)])).toThrow(
114
+ message,
115
+ );
116
+ });
117
+
118
+ it("refuses two plugins that add the same command", () => {
119
+ expect(() =>
120
+ pluginCommandsOf([
121
+ notes,
122
+ withCommands("other", [{ name: "notes", description: "x", run }]),
123
+ ]),
124
+ ).toThrow(
125
+ 'Plugins "notes" and "other" both add the command "notes"; keep one.',
126
+ );
127
+ });
128
+ });
129
+
130
+ describe("clientAuthOf", () => {
131
+ it("is undefined when no plugin provides clientAuth", () => {
132
+ expect(clientAuthOf([notes])).toBeUndefined();
133
+ expect(generateClientCredential([notes])).toBeUndefined();
134
+ });
135
+
136
+ it("reads the policy's headers and the credential an app sends", () => {
137
+ expect(clientAuthOf([notes, apiKeys({ headerName: "X-Key" })])).toEqual({
138
+ plugin: "apiKeys",
139
+ varyHeaders: ["x-key"],
140
+ credential: {
141
+ label: "API key",
142
+ header: "x-key",
143
+ env: "HOT_UPDATER_API_KEY",
144
+ },
145
+ });
146
+ expect(generateClientCredential([apiKeys()])).toMatch(
147
+ /^[A-Za-z0-9_-]{43}$/u,
148
+ );
149
+ });
150
+
151
+ it("refuses a clientAuth plugin that gives init no credential", () => {
152
+ const sso = definePlugin({
153
+ id: "sso",
154
+ provides: { clientAuth: true },
155
+ schemaVersion: "1",
156
+ schema: {},
157
+ init: () => ({
158
+ api: {},
159
+ clientAuth: { varyHeaders: [], authenticate: async () => true },
160
+ }),
161
+ });
162
+ expect(() => clientAuthOf([sso])).toThrow(
163
+ 'Plugin "sso" provides clientAuth but no cli.clientCredential',
164
+ );
165
+ });
166
+ });
167
+
168
+ describe("provisionClientCredential", () => {
169
+ const database = () => ({ name: "memory", adapter: createMemoryAdapter() });
170
+
171
+ it("is undefined when client routes are public", async () => {
172
+ await expect(
173
+ provisionClientCredential(database(), [notes], {
174
+ env: {},
175
+ name: "Init",
176
+ }),
177
+ ).resolves.toBeUndefined();
178
+ });
179
+
180
+ it("registers a saved credential again, and creates one otherwise", async () => {
181
+ const plugins = [apiKeys()];
182
+ const target = database();
183
+ const created = await provisionClientCredential(target, plugins, {
184
+ env: {},
185
+ name: "Init",
186
+ });
187
+ expect(created).toMatchObject({
188
+ label: "API key",
189
+ header: "x-api-key",
190
+ env: "HOT_UPDATER_API_KEY",
191
+ value: expect.stringMatching(/^[A-Za-z0-9_-]{43}$/u),
192
+ });
193
+ const again = await provisionClientCredential(target, plugins, {
194
+ env: { HOT_UPDATER_API_KEY: ` ${created!.value}\n` },
195
+ name: "Init again",
196
+ });
197
+ expect(again?.value).toBe(created!.value);
198
+ });
199
+ });
200
+
201
+ describe("clientPluginsOf", () => {
202
+ const withClientPlugin = (id: string, clientPlugin: unknown) =>
203
+ ({
204
+ id,
205
+ schemaVersion: "1",
206
+ schema: {},
207
+ init: () => ({ api: {} }),
208
+ cli: { clientPlugin },
209
+ }) as never;
210
+
211
+ it("lists each client plugin once, in plugin order", () => {
212
+ expect(clientPluginsOf([notes, apiKeys()])).toEqual([]);
213
+ expect(
214
+ clientPluginsOf([
215
+ withClientPlugin("feedback", { module: "feedback-rn", name: "fb" }),
216
+ insights(),
217
+ apiKeys(),
218
+ withClientPlugin("again", { module: "feedback-rn", name: "fb" }),
219
+ ]),
220
+ ).toEqual([
221
+ { module: "feedback-rn", name: "fb" },
222
+ {
223
+ module: "@hot-updater/react-native/plugins/insights",
224
+ name: "insights",
225
+ },
226
+ ]);
227
+ });
228
+
229
+ it.each([
230
+ [{ module: "", name: "fb" }],
231
+ [{ module: "feedback-rn", name: "fb()" }],
232
+ [{ module: "feedback-rn", name: "default" }],
233
+ [{ module: "feedback-rn", name: "HotUpdater" }],
234
+ [{ module: "feedback-rn", name: "App" }],
235
+ ["feedback-rn"],
236
+ ])("refuses a client plugin the app cannot import (%j)", (value) => {
237
+ expect(() =>
238
+ clientPluginsOf([withClientPlugin("feedback", value)]),
239
+ ).toThrow(
240
+ 'Plugin "feedback" cli.clientPlugin needs a module and an export name the app can import',
241
+ );
242
+ });
243
+
244
+ it("refuses two client plugins with one name from different modules", () => {
245
+ expect(() =>
246
+ clientPluginsOf([
247
+ withClientPlugin("a", { module: "a-rn", name: "fb" }),
248
+ withClientPlugin("b", { module: "b-rn", name: "fb" }),
249
+ ]),
250
+ ).toThrow(
251
+ 'Plugin "b" names the client plugin "fb" from b-rn, but another plugin names it from a-rn.',
252
+ );
253
+ });
254
+ });
@@ -0,0 +1,248 @@
1
+ import { createMemoryAdapter } from "@hot-updater/plugin-core/internal";
2
+
3
+ import type {
4
+ PluginClientCredential,
5
+ PluginCommand,
6
+ } from "../plugins/definePlugin";
7
+ import { assemblePlugins, HotUpdaterConfigError } from "./assemblePlugins";
8
+ import { createDatabasePluginApis } from "./databasePlugins";
9
+
10
+ export { clientPluginsOf, type ClientPluginSpec } from "./clientPlugins";
11
+
12
+ /** A top-level command a plugin adds to `hot-updater`. */
13
+ export interface PluginCommandEntry {
14
+ /** The id of the plugin that adds it. */
15
+ readonly plugin: string;
16
+ readonly command: PluginCommand;
17
+ }
18
+
19
+ /** The credential an app sends to client routes. */
20
+ export interface ClientCredentialSpec {
21
+ /** Its name in output, such as "API key". */
22
+ readonly label: string;
23
+ /** The request header that carries it, lowercase. */
24
+ readonly header: string;
25
+ /** The environment variable init stores it in. */
26
+ readonly env: string;
27
+ }
28
+
29
+ /** The client-route policy a server's plugins set, as tooling needs it. */
30
+ export interface ClientAuthSpec {
31
+ /** The plugin that provides clientAuth. */
32
+ readonly plugin: string;
33
+ /** The request headers its decision reads, lowercase: what caches key on. */
34
+ readonly varyHeaders: readonly string[];
35
+ readonly credential: ClientCredentialSpec;
36
+ }
37
+
38
+ export interface ProvisionedClientCredential extends ClientCredentialSpec {
39
+ readonly value: string;
40
+ }
41
+
42
+ interface PluginLike {
43
+ readonly id?: unknown;
44
+ readonly provides?: { readonly clientAuth?: unknown };
45
+ readonly cli?: {
46
+ readonly commands?: unknown;
47
+ readonly clientCredential?: unknown;
48
+ };
49
+ }
50
+
51
+ const COMMAND_NAME = /^[a-z][a-z0-9]*(-[a-z0-9]+)*$/u;
52
+ const ARGUMENT_NAME = /^[A-Za-z][A-Za-z0-9]*$/u;
53
+ // The CLI appends the server config's path to every command that runs.
54
+ const RESERVED_ARGUMENT = "configPath";
55
+
56
+ const fail = (message: string): never => {
57
+ throw new HotUpdaterConfigError(message);
58
+ };
59
+
60
+ const isRecord = (value: unknown): value is Record<string, unknown> =>
61
+ typeof value === "object" && value !== null && !Array.isArray(value);
62
+
63
+ const pluginsOf = (value: unknown): readonly PluginLike[] =>
64
+ Array.isArray(value)
65
+ ? value.filter(isRecord)
66
+ : fail("plugins must be an array of plugins.");
67
+
68
+ const checkCommand = (
69
+ plugin: string,
70
+ value: unknown,
71
+ path: readonly string[],
72
+ ): PluginCommand => {
73
+ const at = `Plugin "${plugin}" command "${[...path, isRecord(value) ? String(value.name) : "?"].join(" ")}"`;
74
+ if (
75
+ !isRecord(value) ||
76
+ typeof value.name !== "string" ||
77
+ !COMMAND_NAME.test(value.name) ||
78
+ typeof value.description !== "string"
79
+ ) {
80
+ return fail(
81
+ `${at} needs a name of lowercase words joined by hyphens and a description.`,
82
+ );
83
+ }
84
+ const command = value as unknown as PluginCommand;
85
+ if (
86
+ (typeof command.run === "function") ===
87
+ (command.commands !== undefined)
88
+ ) {
89
+ fail(`${at} needs either subcommands or run, not both.`);
90
+ }
91
+ const names = new Set<string>();
92
+ for (const argument of command.arguments ?? []) {
93
+ if (
94
+ !isRecord(argument) ||
95
+ typeof argument.name !== "string" ||
96
+ !ARGUMENT_NAME.test(argument.name) ||
97
+ argument.name === RESERVED_ARGUMENT ||
98
+ names.has(argument.name) ||
99
+ typeof argument.description !== "string"
100
+ ) {
101
+ fail(
102
+ `${at} has an argument that needs a unique camelCase name other than "${RESERVED_ARGUMENT}" and a description.`,
103
+ );
104
+ }
105
+ names.add(argument.name);
106
+ }
107
+ for (const option of command.options ?? []) {
108
+ if (
109
+ !isRecord(option) ||
110
+ typeof option.flags !== "string" ||
111
+ !option.flags.includes("--") ||
112
+ typeof option.description !== "string"
113
+ ) {
114
+ fail(`${at} has an option that needs --flags and a description.`);
115
+ }
116
+ }
117
+ if (command.commands !== undefined) {
118
+ if (!Array.isArray(command.commands) || command.commands.length === 0) {
119
+ fail(`${at} needs at least one subcommand.`);
120
+ }
121
+ const subcommands = new Set<string>();
122
+ for (const subcommand of command.commands) {
123
+ const checked = checkCommand(plugin, subcommand, [...path, command.name]);
124
+ if (subcommands.has(checked.name)) {
125
+ fail(`${at} has two subcommands named "${checked.name}".`);
126
+ }
127
+ subcommands.add(checked.name);
128
+ }
129
+ }
130
+ return command;
131
+ };
132
+
133
+ /**
134
+ * The top-level commands the plugins add, each checked. Two plugins may not
135
+ * add the same command.
136
+ */
137
+ export const pluginCommandsOf = (
138
+ plugins: unknown,
139
+ ): readonly PluginCommandEntry[] => {
140
+ const entries: PluginCommandEntry[] = [];
141
+ for (const plugin of pluginsOf(plugins)) {
142
+ const commands = plugin.cli?.commands;
143
+ if (commands === undefined) continue;
144
+ const id = String(plugin.id);
145
+ if (!Array.isArray(commands)) {
146
+ fail(`Plugin "${id}" cli.commands must be an array.`);
147
+ }
148
+ for (const value of commands as unknown[]) {
149
+ const command = checkCommand(id, value, []);
150
+ const taken = entries.find(
151
+ (entry) => entry.command.name === command.name,
152
+ );
153
+ if (taken !== undefined) {
154
+ fail(
155
+ `Plugins "${taken.plugin}" and "${id}" both add the command "${command.name}"; keep one.`,
156
+ );
157
+ }
158
+ entries.push({ plugin: id, command });
159
+ }
160
+ }
161
+ return entries;
162
+ };
163
+
164
+ /** The clientAuth plugin's credential contribution, checked. */
165
+ const credentialOf = (
166
+ plugins: unknown,
167
+ ):
168
+ | { readonly plugin: string; readonly credential: PluginClientCredential }
169
+ | undefined => {
170
+ const plugin = pluginsOf(plugins).find(
171
+ ({ provides }) => provides?.clientAuth === true,
172
+ );
173
+ if (plugin === undefined) return undefined;
174
+ const id = String(plugin.id);
175
+ const credential = plugin.cli?.clientCredential;
176
+ if (
177
+ !isRecord(credential) ||
178
+ typeof credential.label !== "string" ||
179
+ typeof credential.header !== "string" ||
180
+ typeof credential.env !== "string" ||
181
+ typeof credential.generate !== "function" ||
182
+ typeof credential.provision !== "function"
183
+ ) {
184
+ return fail(
185
+ `Plugin "${id}" provides clientAuth but no cli.clientCredential with a label, header, env, generate, and provision, so init cannot give an app its credential.`,
186
+ );
187
+ }
188
+ return {
189
+ plugin: id,
190
+ credential: credential as unknown as PluginClientCredential,
191
+ };
192
+ };
193
+
194
+ /**
195
+ * The client-route policy the plugins set: the plugin that provides
196
+ * clientAuth, the headers its decision reads, and the credential an app
197
+ * sends. Undefined when client routes are public. The plugins initialize on
198
+ * a throwaway in-memory database, since `varyHeaders` live on the instance.
199
+ */
200
+ export const clientAuthOf = (
201
+ plugins: readonly unknown[],
202
+ ): ClientAuthSpec | undefined => {
203
+ const found = credentialOf(plugins);
204
+ if (found === undefined) return undefined;
205
+ const { clientAuth } = assemblePlugins(plugins, createMemoryAdapter());
206
+ const { label, header, env } = found.credential;
207
+ return {
208
+ plugin: found.plugin,
209
+ varyHeaders: (clientAuth?.varyHeaders ?? []).map((name) =>
210
+ name.toLowerCase(),
211
+ ),
212
+ credential: { label, header: header.toLowerCase(), env },
213
+ };
214
+ };
215
+
216
+ /**
217
+ * A new client credential, made without a database, so tooling can save it
218
+ * before it registers it. Undefined when client routes are public.
219
+ */
220
+ export const generateClientCredential = (
221
+ plugins: readonly unknown[],
222
+ ): string | undefined => credentialOf(plugins)?.credential.generate();
223
+
224
+ /**
225
+ * Provisions the credential an app sends to client routes, through the
226
+ * plugin that provides clientAuth, on the tables the server reads: a
227
+ * credential saved in `env` is registered again rather than replaced.
228
+ * Undefined when client routes are public.
229
+ */
230
+ export const provisionClientCredential = async (
231
+ database: unknown,
232
+ plugins: readonly unknown[],
233
+ input: {
234
+ readonly env: Readonly<Record<string, string | undefined>>;
235
+ /** Names the credential where the plugin stores one. */
236
+ readonly name: string;
237
+ },
238
+ ): Promise<ProvisionedClientCredential | undefined> => {
239
+ const found = credentialOf(plugins);
240
+ if (found === undefined) return undefined;
241
+ const { label, header, env, provision } = found.credential;
242
+ const existing = input.env[env]?.trim();
243
+ const value = await provision(
244
+ createDatabasePluginApis(database, plugins)[found.plugin],
245
+ { ...(existing ? { existing } : {}), name: input.name },
246
+ );
247
+ return { label, header: header.toLowerCase(), env, value };
248
+ };
@@ -3,10 +3,10 @@ import { afterEach, describe, expect, it, vi } from "vitest";
3
3
 
4
4
  import { createHotUpdater } from "../createHotUpdaterCore";
5
5
  import { type HotUpdaterHandlers, listHotUpdaterRoutes } from "../handler";
6
- import { INSIGHTS_OFF_WARNING, INSIGHTS_ROUTES } from "../insights/routes";
7
6
  import { apiKeys } from "../plugins/api-keys";
8
7
  import { definePlugin } from "../plugins/definePlugin";
9
8
  import { insights } from "../plugins/insights";
9
+ import { INSIGHTS_ROUTES } from "../plugins/insights/routes";
10
10
  import { HotUpdaterConfigError } from "./assemblePlugins";
11
11
 
12
12
  const database = () => ({ name: "memory", adapter: createMemoryAdapter() });
@@ -25,7 +25,6 @@ const event = {
25
25
  type: "UNCHANGED",
26
26
  updateStrategy: null,
27
27
  userId: "user-1",
28
- username: "Jane",
29
28
  sdkVersion: "2.0.0",
30
29
  } as const;
31
30
 
@@ -59,7 +58,6 @@ describe("Insights routes with plugins", () => {
59
58
  }),
60
59
  );
61
60
  expect(ingested.status).toBe(204);
62
- expect(ingested.headers.get("x-hot-updater-insights")).toBeNull();
63
61
  const installation = await hotUpdater.handlers.admin(
64
62
  request("/installations/install-1"),
65
63
  );
@@ -73,7 +71,7 @@ describe("Insights routes with plugins", () => {
73
71
  expect(warn).not.toHaveBeenCalled();
74
72
  });
75
73
 
76
- it("answer 204 with x-hot-updater-insights: disabled when plugins leave it out", async () => {
74
+ it("are not mounted when plugins leave it out: core serves no Insights route", async () => {
77
75
  const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
78
76
  const hotUpdater = createHotUpdater({
79
77
  database: database(),
@@ -88,37 +86,12 @@ describe("Insights routes with plugins", () => {
88
86
  ...(method === "POST" ? { body: JSON.stringify(event) } : {}),
89
87
  }),
90
88
  );
91
- expect(response.status, `${method} ${path}`).toBe(204);
92
- expect(response.headers.get("x-hot-updater-insights")).toBe("disabled");
93
- expect(response.headers.get("cache-control")).toBe("private, no-store");
89
+ expect(response.status, `${method} ${path}`).toBe(404);
94
90
  }
95
- expect(listHotUpdaterRoutes(hotUpdater.handlers)).toEqual(
96
- expect.arrayContaining(insightsRoutes),
91
+ expect(listHotUpdaterRoutes(hotUpdater.handlers)).not.toEqual(
92
+ expect.arrayContaining([insightsRoutes[0]]),
97
93
  );
98
- expect(warn).toHaveBeenCalledOnce();
99
- expect(warn).toHaveBeenCalledWith(INSIGHTS_OFF_WARNING);
100
- });
101
-
102
- it("warn once per server, on the first event dropped without insights()", async () => {
103
- const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
104
- const hotUpdater = createHotUpdater({
105
- database: database(),
106
- clientAccess: "public",
107
- });
108
- const report = () =>
109
- hotUpdater.handlers.client(
110
- request("/events", { method: "POST", body: JSON.stringify(event) }),
111
- );
112
-
113
94
  expect(warn).not.toHaveBeenCalled();
114
- expect((await report()).status).toBe(204);
115
- expect((await report()).status).toBe(204);
116
- expect(warn).toHaveBeenCalledOnce();
117
- expect(warn).toHaveBeenCalledWith(
118
- expect.stringContaining(
119
- "Add insights() from @hot-updater/server/plugins/insights to plugins",
120
- ),
121
- );
122
95
  });
123
96
  });
124
97
 
@@ -130,7 +103,7 @@ describe("admin /version", () => {
130
103
  }
131
104
  ).plugins;
132
105
 
133
- it("lists the built-in plugins the server runs, sorted by id", async () => {
106
+ it("lists the plugins the server runs, sorted by id", async () => {
134
107
  await expect(
135
108
  plugins(
136
109
  createHotUpdater({
@@ -150,16 +123,16 @@ describe("admin /version", () => {
150
123
  ).resolves.toEqual(["insights"]);
151
124
  });
152
125
 
153
- it("lists none for a server without plugins, whose Insights routes still say it is off", async () => {
126
+ it("lists none for a server without plugins, which serves no Insights route", async () => {
154
127
  const hotUpdater = createHotUpdater({
155
128
  database: database(),
156
129
  clientAccess: "public",
157
130
  });
158
131
 
159
132
  await expect(plugins(hotUpdater)).resolves.toEqual([]);
160
- const events = await hotUpdater.handlers.admin(request("/events"));
161
- expect(events.status).toBe(204);
162
- expect(events.headers.get("x-hot-updater-insights")).toBe("disabled");
133
+ expect((await hotUpdater.handlers.admin(request("/events"))).status).toBe(
134
+ 404,
135
+ );
163
136
  });
164
137
  });
165
138