@reventlessdev/reventless-seed 1.0.0-alpha.6 → 1.0.0-alpha.8

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 (91) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/lib/bs/.compiler.log +2 -2
  3. package/lib/bs/ReventlessSeed.cmi +0 -0
  4. package/lib/bs/ReventlessSeed.cmt +0 -0
  5. package/lib/bs/ReventlessSeed.mlmap +1 -1
  6. package/lib/bs/compiler-info.json +1 -1
  7. package/lib/bs/src/Seed-ReventlessSeed.cmi +0 -0
  8. package/lib/bs/src/Seed-ReventlessSeed.cmt +0 -0
  9. package/lib/bs/src/Seed.ast +0 -0
  10. package/lib/bs/src/Seed.res +4 -5
  11. package/lib/bs/src/Seed_Client-ReventlessSeed.cmi +0 -0
  12. package/lib/bs/src/Seed_Client-ReventlessSeed.cmj +0 -0
  13. package/lib/bs/src/Seed_Client-ReventlessSeed.cmt +0 -0
  14. package/lib/bs/src/Seed_Client.ast +0 -0
  15. package/lib/bs/src/Seed_Client.res +4 -0
  16. package/lib/bs/src/Seed_Client.res.mjs +5 -0
  17. package/lib/bs/src/Seed_Connect-ReventlessSeed.cmi +0 -0
  18. package/lib/bs/src/Seed_Connect-ReventlessSeed.cmj +0 -0
  19. package/lib/bs/src/Seed_Connect-ReventlessSeed.cmt +0 -0
  20. package/lib/bs/src/Seed_Connect.ast +0 -0
  21. package/lib/bs/src/Seed_Connect.res +13 -49
  22. package/lib/bs/src/Seed_Connect.res.mjs +5 -26
  23. package/lib/bs/src/Seed_Prompt-ReventlessSeed.cmt +0 -0
  24. package/lib/bs/src/Seed_Runner-ReventlessSeed.cmi +0 -0
  25. package/lib/bs/src/Seed_Runner-ReventlessSeed.cmt +0 -0
  26. package/lib/bs/src/Seed_Upload-ReventlessSeed.cmi +0 -0
  27. package/lib/bs/src/Seed_Upload-ReventlessSeed.cmj +0 -0
  28. package/lib/bs/src/Seed_Upload-ReventlessSeed.cmt +0 -0
  29. package/lib/bs/src/Seed_Upload.ast +0 -0
  30. package/lib/bs/src/Seed_Upload.res +39 -100
  31. package/lib/bs/src/Seed_Upload.res.mjs +61 -93
  32. package/lib/bs/tests/Seed_RandomTest-ReventlessSeed.cmi +0 -0
  33. package/lib/bs/tests/Seed_RandomTest-ReventlessSeed.cmj +0 -0
  34. package/lib/bs/tests/Seed_RandomTest-ReventlessSeed.cmt +0 -0
  35. package/lib/bs/tests/Seed_RandomTest.ast +0 -0
  36. package/lib/bs/tests/Seed_RandomTest.res +160 -0
  37. package/lib/bs/tests/Seed_RandomTest.res.mjs +208 -0
  38. package/lib/ocaml/.compiler.log +2 -2
  39. package/lib/ocaml/ReventlessSeed.cmi +0 -0
  40. package/lib/ocaml/ReventlessSeed.cmt +0 -0
  41. package/lib/ocaml/ReventlessSeed.mlmap +1 -1
  42. package/lib/ocaml/Seed-ReventlessSeed.cmi +0 -0
  43. package/lib/ocaml/Seed-ReventlessSeed.cmt +0 -0
  44. package/lib/ocaml/Seed.ast +0 -0
  45. package/lib/ocaml/Seed.res +4 -5
  46. package/lib/ocaml/Seed_Client-ReventlessSeed.cmi +0 -0
  47. package/lib/ocaml/Seed_Client-ReventlessSeed.cmj +0 -0
  48. package/lib/ocaml/Seed_Client-ReventlessSeed.cmt +0 -0
  49. package/lib/ocaml/Seed_Client.ast +0 -0
  50. package/lib/ocaml/Seed_Client.res +4 -0
  51. package/lib/ocaml/Seed_Connect-ReventlessSeed.cmi +0 -0
  52. package/lib/ocaml/Seed_Connect-ReventlessSeed.cmj +0 -0
  53. package/lib/ocaml/Seed_Connect-ReventlessSeed.cmt +0 -0
  54. package/lib/ocaml/Seed_Connect.ast +0 -0
  55. package/lib/ocaml/Seed_Connect.res +13 -49
  56. package/lib/ocaml/Seed_Prompt-ReventlessSeed.cmt +0 -0
  57. package/lib/ocaml/Seed_RandomTest-ReventlessSeed.cmi +0 -0
  58. package/lib/ocaml/Seed_RandomTest-ReventlessSeed.cmj +0 -0
  59. package/lib/ocaml/Seed_RandomTest-ReventlessSeed.cmt +0 -0
  60. package/lib/ocaml/Seed_RandomTest.ast +0 -0
  61. package/lib/ocaml/Seed_RandomTest.res +160 -0
  62. package/lib/ocaml/Seed_Runner-ReventlessSeed.cmi +0 -0
  63. package/lib/ocaml/Seed_Runner-ReventlessSeed.cmt +0 -0
  64. package/lib/ocaml/Seed_Upload-ReventlessSeed.cmi +0 -0
  65. package/lib/ocaml/Seed_Upload-ReventlessSeed.cmj +0 -0
  66. package/lib/ocaml/Seed_Upload-ReventlessSeed.cmt +0 -0
  67. package/lib/ocaml/Seed_Upload.ast +0 -0
  68. package/lib/ocaml/Seed_Upload.res +39 -100
  69. package/package.json +2 -2
  70. package/src/Seed.res +4 -5
  71. package/src/Seed_Client.res +4 -0
  72. package/src/Seed_Client.res.mjs +5 -0
  73. package/src/Seed_Connect.res +13 -49
  74. package/src/Seed_Connect.res.mjs +5 -26
  75. package/src/Seed_Upload.res +39 -100
  76. package/src/Seed_Upload.res.mjs +61 -93
  77. package/tests/Seed_RandomTest.res +160 -0
  78. package/tests/Seed_RandomTest.res.mjs +208 -0
  79. package/lib/bs/tests/UploadEndpointResolutionTest-ReventlessSeed.cmi +0 -0
  80. package/lib/bs/tests/UploadEndpointResolutionTest-ReventlessSeed.cmj +0 -0
  81. package/lib/bs/tests/UploadEndpointResolutionTest-ReventlessSeed.cmt +0 -0
  82. package/lib/bs/tests/UploadEndpointResolutionTest.ast +0 -0
  83. package/lib/bs/tests/UploadEndpointResolutionTest.res +0 -100
  84. package/lib/bs/tests/UploadEndpointResolutionTest.res.mjs +0 -59
  85. package/lib/ocaml/UploadEndpointResolutionTest-ReventlessSeed.cmi +0 -0
  86. package/lib/ocaml/UploadEndpointResolutionTest-ReventlessSeed.cmj +0 -0
  87. package/lib/ocaml/UploadEndpointResolutionTest-ReventlessSeed.cmt +0 -0
  88. package/lib/ocaml/UploadEndpointResolutionTest.ast +0 -0
  89. package/lib/ocaml/UploadEndpointResolutionTest.res +0 -100
  90. package/tests/UploadEndpointResolutionTest.res +0 -100
  91. package/tests/UploadEndpointResolutionTest.res.mjs +0 -59
@@ -9,15 +9,13 @@
9
9
 
10
10
  open Seed_Types
11
11
 
12
- // `uploadEndpoint` is the legacy single presign service (and the local dev
13
- // server's one upload route); `uploadEndpoints` maps the qualified
14
- // `{plugin}.{store}` of each declared store to its own presign endpoint. Both,
15
- // because a deployment may publish either or both — see `Seed_Upload.endpointFor`
16
- // for the resolution between them.
12
+ // Under route B the client mints uploads through the domain API's `Upload_Presign`
13
+ // mutation (authenticated by the same bearer as commands), so a connection needs no
14
+ // upload endpoint — just the authenticated client and whether uploads are skipped this
15
+ // run (`SEED_SKIP_UPLOADS`). Which store an asset uploads into is the caller's `~store`.
17
16
  type connection = {
18
17
  client: Seed_Client.t,
19
- uploadEndpoint: string,
20
- uploadEndpoints: dict<string>,
18
+ uploadsSkipped: bool,
21
19
  label: string,
22
20
  }
23
21
 
@@ -29,48 +27,20 @@ type connection = {
29
27
  let make = async (
30
28
  ~label: string,
31
29
  ~endpoint: string,
32
- ~uploadEndpoint: string,
33
- ~uploadEndpoints: dict<string>=Dict.make(),
34
30
  ~login: (~username: string, ~password: string) => promise<string>,
35
31
  ~localDefaults: bool=false,
36
32
  ): connection => {
37
- // `SEED_SKIP_UPLOADS` forces the connection to carry no upload endpoint at
38
- // all, so a data set's upload phase no-ops the same way it does when a
39
- // deployment serves none. Use it to seed domain data fast, or to skip a
40
- // broken/absent upload path without editing the data set. It is the single
41
- // knob: an empty `REVENTLESS_UPLOAD_ENDPOINT` env reads as "unset" (falls back
42
- // to discovery), so this is the reliable way to disable uploads — which means
43
- // it has to clear the per-store map too, or a declared store keeps uploading
44
- // through it.
45
- let skip = Seed_Prompt.envValue("SEED_SKIP_UPLOADS")->Option.isSome
46
- let uploadEndpoint = skip ? "" : uploadEndpoint
47
- let uploadEndpoints = skip ? Dict.make() : uploadEndpoints
33
+ // `SEED_SKIP_UPLOADS` forces the upload phase to no-op — seed domain data fast, or
34
+ // skip a broken/absent upload path without editing the data set. The data set reads
35
+ // `connection.uploadsSkipped` and reports the skip.
36
+ let uploadsSkipped = Seed_Upload.uploadsSkipped()
48
37
  let (username, password) = await Seed_Prompt.credentials(~localDefaults)
49
38
  let token = await login(~username, ~password)
50
39
  let client = Seed_Client.make(~config={endpoint: endpoint})
51
40
  client->Seed_Client.useToken(token)
52
- {client, uploadEndpoint, uploadEndpoints, label}
41
+ {client, uploadsSkipped, label}
53
42
  }
54
43
 
55
- /**
56
- * The endpoint an asset destined for `store` uploads through, or the reason
57
- * there is none — the message to report when the upload phase skips.
58
- *
59
- * `store` is the qualified `{plugin}.{store}` the asset's field declares, e.g.
60
- * `"Catalog.productImages"`. Resolution is `Seed_Upload.endpointFor`; naming a
61
- * store the deployment does not serve falls back to the legacy single service
62
- * rather than to another store's endpoint.
63
- */
64
- let uploadEndpointFor = (c: connection, ~store: string): result<string, string> =>
65
- switch Seed_Upload.endpointFor(
66
- ~store,
67
- ~uploadEndpoint=c.uploadEndpoint,
68
- ~uploadEndpoints=c.uploadEndpoints,
69
- ) {
70
- | Some(endpoint) => Ok(endpoint)
71
- | None => Error(Seed_Upload.unresolvedReason(~store, ~uploadEndpoints=c.uploadEndpoints))
72
- }
73
-
74
44
  /**
75
45
  * A login function backed by an HTTP login endpoint (the local dev
76
46
  * `/__inmemory/login` shape: POST `{username, password}` → `{token}`). Reuses
@@ -98,24 +68,18 @@ let envOr = (key: string, fallback: string): string =>
98
68
  * defaults baked in and overridable per endpoint (arg, then env var, then
99
69
  * default). Empty input at the credential prompt falls back to `admin`/`admin`.
100
70
  *
101
- * No per-store map: the local dev server serves every store through its one
102
- * upload route, so a data set naming a store resolves to that route by the
103
- * "declares a store with no matching endpoint" row.
71
+ * No upload endpoint: uploads mint through the domain API's `Upload_Presign` mutation
72
+ * on the same `graphql` endpoint, with the store passed per asset.
104
73
  */
105
- let local = (~graphql=?, ~upload=?, ~login=?, ()): (unit => promise<connection>) => {
74
+ let local = (~graphql=?, ~login=?, ()): (unit => promise<connection>) => {
106
75
  let endpoint =
107
76
  graphql->Option.getOr(envOr("REVENTLESS_GRAPHQL_ENDPOINT", "http://localhost:4000/graphql"))
108
- let uploadEndpoint =
109
- upload->Option.getOr(
110
- envOr("REVENTLESS_UPLOAD_ENDPOINT", "http://localhost:4000/__inmemory/upload"),
111
- )
112
77
  let loginEndpoint =
113
78
  login->Option.getOr(envOr("REVENTLESS_LOGIN_ENDPOINT", "http://localhost:4000/__inmemory/login"))
114
79
  () =>
115
80
  make(
116
81
  ~label="local",
117
82
  ~endpoint,
118
- ~uploadEndpoint,
119
83
  ~login=viaLoginEndpoint(~loginEndpoint),
120
84
  ~localDefaults=true,
121
85
  )
Binary file
@@ -0,0 +1,160 @@
1
+ open JestGlobals
2
+
3
+ // `Seed_Random` exists so that two seed runs against a fresh store produce the
4
+ // same data — that is what makes a seeded store usable as a screenshot baseline
5
+ // or a comparison target. Its correctness is therefore not "looks random" but
6
+ // "repeats exactly, and stays inside the bounds it advertises".
7
+ //
8
+ // The suite is written around that: every case below fails for a generator that
9
+ // is subtly non-reproducible or that walks out of its range, and none of them
10
+ // would notice a change of algorithm that kept both properties.
11
+
12
+ describe("Seed_Random:", () => {
13
+ let take = (~seed, ~n) => {
14
+ let r = Seed_Random.make(~seed)
15
+ Array.make(~length=n, 0.0)->Array.map(_ => Seed_Random.float(r))
16
+ }
17
+
18
+ describe("reproducibility — the reason this module exists:", () => {
19
+ testSync("the same seed replays the same sequence", () =>
20
+ expect(take(~seed=42, ~n=25))->toEqual(take(~seed=42, ~n=25))
21
+ )
22
+
23
+ // Without this, a generator that returned a constant would satisfy the
24
+ // case above and nothing else in the suite would catch it.
25
+ testSync("different seeds diverge", () =>
26
+ expect(take(~seed=42, ~n=25) == take(~seed=43, ~n=25))->toBe(false)
27
+ )
28
+
29
+ testSync("a fresh generator does not continue the previous one", () => {
30
+ let r = Seed_Random.make(~seed=7)
31
+ let first = Seed_Random.float(r)
32
+ let _ = Seed_Random.float(r)
33
+ expect(Seed_Random.float(Seed_Random.make(~seed=7)))->toEqual(first)
34
+ })
35
+ })
36
+
37
+ describe("float stays a unit interval:", () => {
38
+ // mulberry32's last step is a signed 32-bit value folded back to unsigned.
39
+ // Get that fold wrong and roughly half the draws come out negative, which
40
+ // every consumer below (int, pick, sampleWeighted) silently mis-scales.
41
+ testSync("every draw is in [0, 1)", () =>
42
+ expect(take(~seed=99, ~n=500)->Array.every(f => f >= 0.0 && f < 1.0))->toBe(true)
43
+ )
44
+
45
+ testSync("and the draws are not all the same value", () => {
46
+ let draws = take(~seed=99, ~n=100)
47
+ expect(draws->Array.some(f => f != draws->Array.getUnsafe(0)))->toBe(true)
48
+ })
49
+ })
50
+
51
+ describe("int is inclusive on both ends, as documented:", () => {
52
+ let draws = (~min, ~max, ~n) => {
53
+ let r = Seed_Random.make(~seed=5)
54
+ Array.make(~length=n, 0)->Array.map(_ => Seed_Random.int(r, ~min, ~max))
55
+ }
56
+
57
+ testSync("never escapes the range", () =>
58
+ expect(draws(~min=3, ~max=7, ~n=500)->Array.every(i => i >= 3 && i <= 7))->toBe(true)
59
+ )
60
+
61
+ // The documented contract is "inclusive on both ends"; an off-by-one in the
62
+ // `max - min + 1` scaling shows up as a bound that is never drawn.
63
+ testSync("reaches both bounds", () => {
64
+ let d = draws(~min=3, ~max=7, ~n=500)
65
+ expect((d->Array.includes(3), d->Array.includes(7)))->toEqual((true, true))
66
+ })
67
+
68
+ testSync("a single-value range is that value", () =>
69
+ expect(draws(~min=4, ~max=4, ~n=10)->Array.every(i => i == 4))->toBe(true)
70
+ )
71
+ })
72
+
73
+ describe("pick:", () => {
74
+ testSync("returns None for an empty array", () =>
75
+ expect(Seed_Random.make(~seed=1)->Seed_Random.pick([]))->toEqual(None)
76
+ )
77
+
78
+ testSync("always lands on a member", () => {
79
+ let r = Seed_Random.make(~seed=2)
80
+ let xs = ["a", "b", "c", "d"]
81
+ let hits = Array.make(~length=200, "")->Array.map(_ =>
82
+ r->Seed_Random.pickOr(~fallback="MISS", xs)
83
+ )
84
+ expect(hits->Array.every(h => xs->Array.includes(h)))->toBe(true)
85
+ })
86
+
87
+ testSync("pickOr falls back only when there is nothing to pick", () =>
88
+ expect(Seed_Random.make(~seed=3)->Seed_Random.pickOr(~fallback="fallback", []))->toBe(
89
+ "fallback",
90
+ )
91
+ )
92
+ })
93
+
94
+ describe("sampleWeighted is without replacement:", () => {
95
+ let equal = xs => xs->Array.map(x => (x, 1.0))
96
+
97
+ // The documented shuffle use: equal weights, count = length. If sampling
98
+ // ever replaced instead of removing, duplicates would appear here.
99
+ testSync("count = length yields a permutation, not a multiset", () => {
100
+ let xs = ["a", "b", "c", "d", "e"]
101
+ let out = Seed_Random.make(~seed=11)->Seed_Random.sampleWeighted(equal(xs), ~count=5)
102
+ let sorted = out->Array.toSorted(String.compare)
103
+ expect((out->Array.length, sorted))->toEqual((5, ["a", "b", "c", "d", "e"]))
104
+ })
105
+
106
+ testSync("count < length returns exactly count distinct items", () => {
107
+ let xs = ["a", "b", "c", "d", "e"]
108
+ let out = Seed_Random.make(~seed=12)->Seed_Random.sampleWeighted(equal(xs), ~count=3)
109
+ let distinct = Set.fromArray(out)->Set.size
110
+ expect((out->Array.length, distinct))->toEqual((3, 3))
111
+ })
112
+
113
+ testSync("count > length clamps to the pool", () =>
114
+ expect(
115
+ Seed_Random.make(~seed=13)
116
+ ->Seed_Random.sampleWeighted(equal(["a", "b"]), ~count=99)
117
+ ->Array.length,
118
+ )->toBe(2)
119
+ )
120
+
121
+ testSync("a zero-weight entry is never chosen while others remain", () => {
122
+ let out =
123
+ Seed_Random.make(~seed=14)->Seed_Random.sampleWeighted(
124
+ [("never", 0.0), ("a", 1.0), ("b", 1.0)],
125
+ ~count=2,
126
+ )
127
+ expect(out->Array.includes("never"))->toBe(false)
128
+ })
129
+
130
+ testSync("is reproducible for a given seed", () => {
131
+ let run = () =>
132
+ Seed_Random.make(~seed=15)->Seed_Random.sampleWeighted(
133
+ equal(["a", "b", "c", "d", "e", "f"]),
134
+ ~count=4,
135
+ )
136
+ expect(run())->toEqual(run())
137
+ })
138
+ })
139
+
140
+ describe("zipfWeights skews toward the head:", () => {
141
+ let weights = Seed_Random.zipfWeights(["a", "b", "c", "d", "e"], ~exponent=1.1)
142
+
143
+ testSync("keeps every item, in order", () =>
144
+ expect(weights->Array.map(((item, _)) => item))->toEqual(["a", "b", "c", "d", "e"])
145
+ )
146
+
147
+ testSync("weight decreases monotonically with rank", () => {
148
+ let ws = weights->Array.map(((_, w)) => w)
149
+ let decreasing =
150
+ ws->Array.everyWithIndex((w, i) => i == 0 || w < ws->Array.getUnsafe(i - 1))
151
+ expect(decreasing)->toBe(true)
152
+ })
153
+
154
+ testSync("the leader is clear — first outweighs last several times over", () => {
155
+ let first = weights->Array.get(0)->Option.mapOr(0.0, ((_, w)) => w)
156
+ let last = weights->Array.get(4)->Option.mapOr(0.0, ((_, w)) => w)
157
+ expect(first > last *. 3.0)->toBe(true)
158
+ })
159
+ })
160
+ })
Binary file
@@ -1,32 +1,26 @@
1
- // Seed-time asset upload against the framework's presign-shaped upload contract.
1
+ // Seed-time asset upload against the framework's upload contract (route B).
2
2
  //
3
- // One code path for both providers: the AWS `Upload_Presign_S3` Function URL and
4
- // the local dev upload route expose the SAME shape — POST `{fileName,contentType}`
5
- // → `{uploadUrl, storageRef}`, then PUT the bytes to `uploadUrl`. `uploadAsset`
6
- // resolves `Ok(storageRef)` — the same same-origin `/{prefix}/{key}` ref a command
7
- // stores and the UI renders.
3
+ // Minting is a GraphQL mutation on the domain API — `Upload_Presign(store, fileName,
4
+ // contentType)` — authenticated by the same bearer the seed already uses for commands
5
+ // (no separate endpoint, no anonymous surface). `uploadAsset` issues it through the
6
+ // shared `Seed_Client`, then PUTs the bytes to the returned `uploadUrl` and resolves
7
+ // `Ok(storageRef)` — the same `/{prefix}/{key}` ref a command stores and the UI renders.
8
8
  //
9
- // The seed runs under Node, so the returned `uploadUrl` is resolved to an
10
- // absolute URL against the endpoint's origin: AWS returns an absolute presigned
11
- // S3 URL (unchanged), while the local route returns a same-origin relative
12
- // `/{prefix}/{key}` that Node's `fetch` cannot PUT to until it is made absolute.
13
- //
14
- // `uploadAsset` is the transport and takes a resolved endpoint. *Which* endpoint
15
- // an asset uses — a deployment now publishes one per declared store — is
16
- // `endpointFor` below, kept separate so the decision is testable without a
17
- // running presign service.
9
+ // The seed runs under Node, so a relative `uploadUrl` (the local dev server returns a
10
+ // same-origin `/{prefix}/{key}`) is resolved to an absolute URL against the client's
11
+ // endpoint origin before the PUT; AWS returns an absolute presigned S3 URL (used as-is).
12
+ // The PUT itself is unauthenticated — presigned on AWS, open on the local route.
18
13
 
19
14
  type fetchInit = {method: string, headers: dict<string>, body: string}
20
15
  type response
21
16
 
22
17
  @val external fetch: (string, fetchInit) => promise<response> = "fetch"
23
- @send external responseJson: response => promise<JSON.t> = "json"
24
18
  @send external responseText: response => promise<string> = "text"
25
19
  @get external responseOk: response => bool = "ok"
26
20
  @get external responseStatus: response => int = "status"
27
21
 
28
- // Resolve a possibly-relative URL against a base (WHATWG URL semantics: an
29
- // absolute `input` ignores `base`, a relative one is resolved against it).
22
+ // Resolve a possibly-relative URL against a base (WHATWG URL semantics: an absolute
23
+ // `input` ignores `base`, a relative one is resolved against it).
30
24
  type url
31
25
  @new external makeUrl: (string, string) => url = "URL"
32
26
  @get external urlHref: url => string = "href"
@@ -43,105 +37,50 @@ let asString = (json: JSON.t): option<string> =>
43
37
  | _ => None
44
38
  }
45
39
 
46
- /**
47
- * Which endpoint an asset destined for `store` uploads through:
48
- *
49
- * declares a store with a matching endpoint → that store's endpoint
50
- * declares a store with no matching endpoint → the legacy single service
51
- * declares no store → the legacy single service
52
- * neither available → `None`
53
- *
54
- * `store` is the qualified `{plugin}.{store}` the platform keys its per-store
55
- * presign endpoints by. The two middle rows are what keep a deployment predating
56
- * per-store endpoints — and the local dev server, which serves one upload route
57
- * — working unchanged.
58
- *
59
- * These are the same four rows the AutoUI renderer resolves an upload field by.
60
- * Resolving one declaration by two different rules is how an asset lands in
61
- * another plugin's bucket with a 2xx and a plausible-looking ref, so a missing
62
- * key falls back to the legacy service rather than to some other store.
63
- */
64
- let endpointFor = (
65
- ~store: option<string>=?,
66
- ~uploadEndpoint: string,
67
- ~uploadEndpoints: dict<string>,
68
- ): option<string> => {
69
- let legacy = uploadEndpoint == "" ? None : Some(uploadEndpoint)
70
- switch store {
71
- | Some(s) => uploadEndpoints->Dict.get(s)->Option.orElse(legacy)
72
- | None => legacy
73
- }
74
- }
75
-
76
- /**
77
- * Why `endpointFor` resolved nothing — the message a data set reports when its
78
- * upload phase skips.
79
- *
80
- * "no upload endpoint" states a fact about the *deployment*; when the deployment
81
- * publishes endpoints the caller could not match, the fact is about the *client*
82
- * and that phrasing sends a reader to the bucket, the presign service and the
83
- * IAM policy, all of which are correct. So the three cases are distinguished and
84
- * the unmatched one names both the store it wanted and the keys it saw.
85
- */
86
- let unresolvedReason = (~store: option<string>=?, ~uploadEndpoints: dict<string>): string => {
87
- let available = uploadEndpoints->Dict.keysToArray
88
- switch (Seed_Prompt.envValue("SEED_SKIP_UPLOADS"), store, available) {
89
- | (Some(_), _, _) => "SEED_SKIP_UPLOADS is set"
90
- | (None, _, []) => "this deployment publishes no upload endpoint"
91
- | (None, Some(s), keys) =>
92
- `this deployment publishes upload endpoints for ${keys->Array.join(", ")}, none for "${s}"`
93
- | (None, None, keys) =>
94
- `this deployment publishes only per-store upload endpoints (${keys->Array.join(
95
- ", ",
96
- )}) and this upload names no store`
97
- }
98
- }
40
+ // Whether this run should skip uploads entirely. `SEED_SKIP_UPLOADS` seeds domain data
41
+ // fast, or skips a broken/absent upload path without editing the data set.
42
+ let uploadsSkipped = (): bool => Seed_Prompt.envValue("SEED_SKIP_UPLOADS")->Option.isSome
99
43
 
100
- // A `fetch` that reports an unreachable endpoint as `Error` instead of throwing,
101
- // so the two-step upload can thread failures without exceptions.
44
+ // A `fetch` that reports an unreachable endpoint as `Error` instead of throwing.
102
45
  let tryFetch = async (url: string, init: fetchInit): result<response, string> =>
103
46
  try Ok(await fetch(url, init)) catch {
104
47
  | _ => Error(`cannot reach ${url}`)
105
48
  }
106
49
 
107
50
  /**
108
- * Uploads `bytes` under `fileName`/`contentType` through `uploadEndpoint` and
51
+ * Uploads `bytes` under `fileName`/`contentType` into `store` (the qualified
52
+ * `{plugin}.{store}` the asset's field declares, e.g. `"Catalog.productImages"`) and
109
53
  * resolves `Ok(storageRef)` (the stored `/{prefix}/{key}` ref), or `Error(msg)`
110
- * describing the step that failed. `authToken`, when supplied, is sent as a
111
- * Bearer on the presign request (the endpoint decides whether it is required;
112
- * the PUT itself is unauthenticated — presigned on AWS, open locally).
54
+ * describing the step that failed. Mints through the domain API's `Upload_Presign`
55
+ * mutation on `client`, then PUTs the bytes to the returned `uploadUrl`.
113
56
  */
114
57
  let uploadAsset = async (
115
- ~uploadEndpoint: string,
58
+ ~client: Seed_Client.t,
59
+ ~store: string,
116
60
  ~bytes: string,
117
61
  ~fileName: string,
118
62
  ~contentType: string,
119
- ~authToken: option<string>=?,
120
63
  ): result<string, string> => {
121
- let presignHeaders = Dict.fromArray([("content-type", "application/json")])
122
- authToken->Option.forEach(t => presignHeaders->Dict.set("authorization", `Bearer ${t}`))
123
- let presignBody = JSON.stringify(
124
- JSON.Encode.object(
125
- Dict.fromArray([
126
- ("fileName", JSON.Encode.string(fileName)),
127
- ("contentType", JSON.Encode.string(contentType)),
128
- ]),
129
- ),
130
- )
64
+ // GraphQL string literals: JSON-quote the argument values (JSON string escaping is a
65
+ // superset-safe subset of GraphQL's for these ASCII-ish inputs).
66
+ let q = s => JSON.stringify(JSON.Encode.string(s))
67
+ let query = `mutation { r: Upload_Presign(store: ${q(store)}, fileName: ${q(fileName)}, contentType: ${q(contentType)}) { uploadUrl storageRef } }`
68
+
69
+ let presign = try Ok(await Seed_Client.gql(client, ~query, ~label="Upload_Presign")) catch {
70
+ | Seed_Types.Failed(m) => Error(m)
71
+ | _ => Error("Upload_Presign: unexpected error")
72
+ }
131
73
 
132
- switch await tryFetch(uploadEndpoint, {method: "POST", headers: presignHeaders, body: presignBody}) {
133
- | Error(m) => Error(`presign: ${m} — is the platform running?`)
134
- | Ok(presignRes) if !(presignRes->responseOk) =>
135
- let detail = await presignRes->responseText
136
- Error(`presign failed with HTTP ${(presignRes->responseStatus)->Int.toString}: ${detail}`)
137
- | Ok(presignRes) =>
138
- let json = await presignRes->responseJson
74
+ switch presign {
75
+ | Error(m) => Error(`presign: ${m}`)
76
+ | Ok(data) =>
77
+ let r = data->field("r")->Option.getOr(JSON.Encode.null)
139
78
  switch (
140
- json->field("uploadUrl")->Option.flatMap(asString),
141
- json->field("storageRef")->Option.flatMap(asString),
79
+ r->field("uploadUrl")->Option.flatMap(asString),
80
+ r->field("storageRef")->Option.flatMap(asString),
142
81
  ) {
143
82
  | (Some(uploadUrl), Some(storageRef)) =>
144
- let putUrl = urlHref(makeUrl(uploadUrl, uploadEndpoint))
83
+ let putUrl = urlHref(makeUrl(uploadUrl, Seed_Client.endpoint(client)))
145
84
  switch await tryFetch(
146
85
  putUrl,
147
86
  {method: "PUT", headers: Dict.fromArray([("content-type", contentType)]), body: bytes},
@@ -152,7 +91,7 @@ let uploadAsset = async (
152
91
  let detail = await putRes->responseText
153
92
  Error(`upload PUT failed with HTTP ${(putRes->responseStatus)->Int.toString}: ${detail}`)
154
93
  }
155
- | _ => Error("presign response missing uploadUrl/storageRef")
94
+ | _ => Error("Upload_Presign response missing uploadUrl/storageRef")
156
95
  }
157
96
  }
158
97
  }
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@reventlessdev/reventless-seed",
3
- "version": "1.0.0-alpha.6",
3
+ "version": "1.0.0-alpha.8",
4
4
  "description": "Reusable harness for seeding a Reventless platform through its public GraphQL command API",
5
5
  "license": "Apache-2.0",
6
6
  "dependencies": {
7
- "@reventlessdev/rescript-node": "2.0.0-alpha.0"
7
+ "@reventlessdev/rescript-node": "2.0.0-alpha.1"
8
8
  },
9
9
  "devDependencies": {
10
10
  "rescript": "12.3.0",
package/src/Seed.res CHANGED
@@ -14,13 +14,12 @@ module Connect = Seed_Connect
14
14
 
15
15
  exception Failed = Seed_Types.Failed
16
16
 
17
- // A live target a data set seeds against: an authenticated client, the
18
- // deployment's upload endpoints (the legacy single service and the per-store
19
- // map, either of which may be empty), and a label.
17
+ // A live target a data set seeds against: an authenticated client, whether uploads
18
+ // are skipped this run, and a label. Uploads mint through the domain API's
19
+ // `Upload_Presign` mutation on the client (route B), so no upload endpoint is carried.
20
20
  type connection = Seed_Connect.connection = {
21
21
  client: Seed_Client.t,
22
- uploadEndpoint: string,
23
- uploadEndpoints: dict<string>,
22
+ uploadsSkipped: bool,
24
23
  label: string,
25
24
  }
26
25
 
@@ -43,6 +43,10 @@ let make = (~config: config): t => {config, token: None}
43
43
  Seed.Upload) can authenticate side-channel requests with the same identity. */
44
44
  let currentToken = (t: t): option<string> => t.token
45
45
 
46
+ /** The GraphQL endpoint this client targets — so `Seed.Upload` can resolve a
47
+ relative presigned `uploadUrl` against the same origin. */
48
+ let endpoint = (t: t): string => t.config.endpoint
49
+
46
50
  /** Injects a bearer obtained out-of-band (e.g. a Cognito id token), instead of
47
51
  minting one via `login`. Provider-agnostic: the harness only cares that the
48
52
  token is a valid bearer for `endpoint`. */
@@ -21,6 +21,10 @@ function currentToken(t) {
21
21
  return t.token;
22
22
  }
23
23
 
24
+ function endpoint(t) {
25
+ return t.config.endpoint;
26
+ }
27
+
24
28
  function useToken(t, token) {
25
29
  t.token = token;
26
30
  }
@@ -266,6 +270,7 @@ export {
266
270
  sleep,
267
271
  make,
268
272
  currentToken,
273
+ endpoint,
269
274
  useToken,
270
275
  field,
271
276
  asString,
@@ -9,15 +9,13 @@
9
9
 
10
10
  open Seed_Types
11
11
 
12
- // `uploadEndpoint` is the legacy single presign service (and the local dev
13
- // server's one upload route); `uploadEndpoints` maps the qualified
14
- // `{plugin}.{store}` of each declared store to its own presign endpoint. Both,
15
- // because a deployment may publish either or both — see `Seed_Upload.endpointFor`
16
- // for the resolution between them.
12
+ // Under route B the client mints uploads through the domain API's `Upload_Presign`
13
+ // mutation (authenticated by the same bearer as commands), so a connection needs no
14
+ // upload endpoint — just the authenticated client and whether uploads are skipped this
15
+ // run (`SEED_SKIP_UPLOADS`). Which store an asset uploads into is the caller's `~store`.
17
16
  type connection = {
18
17
  client: Seed_Client.t,
19
- uploadEndpoint: string,
20
- uploadEndpoints: dict<string>,
18
+ uploadsSkipped: bool,
21
19
  label: string,
22
20
  }
23
21
 
@@ -29,48 +27,20 @@ type connection = {
29
27
  let make = async (
30
28
  ~label: string,
31
29
  ~endpoint: string,
32
- ~uploadEndpoint: string,
33
- ~uploadEndpoints: dict<string>=Dict.make(),
34
30
  ~login: (~username: string, ~password: string) => promise<string>,
35
31
  ~localDefaults: bool=false,
36
32
  ): connection => {
37
- // `SEED_SKIP_UPLOADS` forces the connection to carry no upload endpoint at
38
- // all, so a data set's upload phase no-ops the same way it does when a
39
- // deployment serves none. Use it to seed domain data fast, or to skip a
40
- // broken/absent upload path without editing the data set. It is the single
41
- // knob: an empty `REVENTLESS_UPLOAD_ENDPOINT` env reads as "unset" (falls back
42
- // to discovery), so this is the reliable way to disable uploads — which means
43
- // it has to clear the per-store map too, or a declared store keeps uploading
44
- // through it.
45
- let skip = Seed_Prompt.envValue("SEED_SKIP_UPLOADS")->Option.isSome
46
- let uploadEndpoint = skip ? "" : uploadEndpoint
47
- let uploadEndpoints = skip ? Dict.make() : uploadEndpoints
33
+ // `SEED_SKIP_UPLOADS` forces the upload phase to no-op — seed domain data fast, or
34
+ // skip a broken/absent upload path without editing the data set. The data set reads
35
+ // `connection.uploadsSkipped` and reports the skip.
36
+ let uploadsSkipped = Seed_Upload.uploadsSkipped()
48
37
  let (username, password) = await Seed_Prompt.credentials(~localDefaults)
49
38
  let token = await login(~username, ~password)
50
39
  let client = Seed_Client.make(~config={endpoint: endpoint})
51
40
  client->Seed_Client.useToken(token)
52
- {client, uploadEndpoint, uploadEndpoints, label}
41
+ {client, uploadsSkipped, label}
53
42
  }
54
43
 
55
- /**
56
- * The endpoint an asset destined for `store` uploads through, or the reason
57
- * there is none — the message to report when the upload phase skips.
58
- *
59
- * `store` is the qualified `{plugin}.{store}` the asset's field declares, e.g.
60
- * `"Catalog.productImages"`. Resolution is `Seed_Upload.endpointFor`; naming a
61
- * store the deployment does not serve falls back to the legacy single service
62
- * rather than to another store's endpoint.
63
- */
64
- let uploadEndpointFor = (c: connection, ~store: string): result<string, string> =>
65
- switch Seed_Upload.endpointFor(
66
- ~store,
67
- ~uploadEndpoint=c.uploadEndpoint,
68
- ~uploadEndpoints=c.uploadEndpoints,
69
- ) {
70
- | Some(endpoint) => Ok(endpoint)
71
- | None => Error(Seed_Upload.unresolvedReason(~store, ~uploadEndpoints=c.uploadEndpoints))
72
- }
73
-
74
44
  /**
75
45
  * A login function backed by an HTTP login endpoint (the local dev
76
46
  * `/__inmemory/login` shape: POST `{username, password}` → `{token}`). Reuses
@@ -98,24 +68,18 @@ let envOr = (key: string, fallback: string): string =>
98
68
  * defaults baked in and overridable per endpoint (arg, then env var, then
99
69
  * default). Empty input at the credential prompt falls back to `admin`/`admin`.
100
70
  *
101
- * No per-store map: the local dev server serves every store through its one
102
- * upload route, so a data set naming a store resolves to that route by the
103
- * "declares a store with no matching endpoint" row.
71
+ * No upload endpoint: uploads mint through the domain API's `Upload_Presign` mutation
72
+ * on the same `graphql` endpoint, with the store passed per asset.
104
73
  */
105
- let local = (~graphql=?, ~upload=?, ~login=?, ()): (unit => promise<connection>) => {
74
+ let local = (~graphql=?, ~login=?, ()): (unit => promise<connection>) => {
106
75
  let endpoint =
107
76
  graphql->Option.getOr(envOr("REVENTLESS_GRAPHQL_ENDPOINT", "http://localhost:4000/graphql"))
108
- let uploadEndpoint =
109
- upload->Option.getOr(
110
- envOr("REVENTLESS_UPLOAD_ENDPOINT", "http://localhost:4000/__inmemory/upload"),
111
- )
112
77
  let loginEndpoint =
113
78
  login->Option.getOr(envOr("REVENTLESS_LOGIN_ENDPOINT", "http://localhost:4000/__inmemory/login"))
114
79
  () =>
115
80
  make(
116
81
  ~label="local",
117
82
  ~endpoint,
118
- ~uploadEndpoint,
119
83
  ~login=viaLoginEndpoint(~loginEndpoint),
120
84
  ~localDefaults=true,
121
85
  )