@reventlessdev/reventless-seed 1.0.0-alpha.4 → 1.0.0-alpha.6
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.
- package/CHANGELOG.md +15 -0
- package/lib/bs/.compiler.log +2 -2
- package/lib/bs/.sourcedirs.json +1 -0
- package/lib/bs/ReventlessSeed.cmi +0 -0
- package/lib/bs/ReventlessSeed.cmt +0 -0
- package/lib/bs/ReventlessSeed.mlmap +1 -0
- package/lib/bs/compiler-info.json +2 -2
- package/lib/bs/src/Seed-ReventlessSeed.cmi +0 -0
- package/lib/bs/src/Seed-ReventlessSeed.cmt +0 -0
- package/lib/bs/src/Seed.ast +0 -0
- package/lib/bs/src/Seed.res +4 -2
- package/lib/bs/src/Seed_Client-ReventlessSeed.cmt +0 -0
- package/lib/bs/src/Seed_Connect-ReventlessSeed.cmi +0 -0
- package/lib/bs/src/Seed_Connect-ReventlessSeed.cmj +0 -0
- package/lib/bs/src/Seed_Connect-ReventlessSeed.cmt +0 -0
- package/lib/bs/src/Seed_Connect.ast +0 -0
- package/lib/bs/src/Seed_Connect.res +49 -11
- package/lib/bs/src/Seed_Connect.res.mjs +24 -3
- package/lib/bs/src/Seed_Prompt-ReventlessSeed.cmi +0 -0
- package/lib/bs/src/Seed_Prompt-ReventlessSeed.cmt +0 -0
- package/lib/bs/src/Seed_Prompt.ast +0 -0
- package/lib/bs/src/Seed_Prompt.res +10 -20
- package/lib/bs/src/Seed_Prompt.res.mjs +1 -1
- package/lib/bs/src/Seed_Random-ReventlessSeed.cmt +0 -0
- package/lib/bs/src/Seed_Runner-ReventlessSeed.cmi +0 -0
- package/lib/bs/src/Seed_Runner-ReventlessSeed.cmt +0 -0
- package/lib/bs/src/Seed_Runner.ast +0 -0
- package/lib/bs/src/Seed_Runner.res +5 -7
- package/lib/bs/src/Seed_Types-ReventlessSeed.cmt +0 -0
- package/lib/bs/src/Seed_Upload-ReventlessSeed.cmi +0 -0
- package/lib/bs/src/Seed_Upload-ReventlessSeed.cmj +0 -0
- package/lib/bs/src/Seed_Upload-ReventlessSeed.cmt +0 -0
- package/lib/bs/src/Seed_Upload.ast +0 -0
- package/lib/bs/src/Seed_Upload.res +59 -0
- package/lib/bs/src/Seed_Upload.res.mjs +29 -1
- package/lib/bs/tests/UploadEndpointResolutionTest-ReventlessSeed.cmi +0 -0
- package/lib/bs/tests/UploadEndpointResolutionTest-ReventlessSeed.cmj +0 -0
- package/lib/bs/tests/UploadEndpointResolutionTest-ReventlessSeed.cmt +0 -0
- package/lib/bs/tests/UploadEndpointResolutionTest.ast +0 -0
- package/lib/bs/tests/UploadEndpointResolutionTest.res +100 -0
- package/lib/bs/tests/UploadEndpointResolutionTest.res.mjs +59 -0
- package/lib/ocaml/.compiler.log +2 -2
- package/lib/ocaml/ReventlessSeed.cmi +0 -0
- package/lib/ocaml/ReventlessSeed.cmt +0 -0
- package/lib/ocaml/ReventlessSeed.mlmap +1 -0
- package/lib/ocaml/Seed-ReventlessSeed.cmi +0 -0
- package/lib/ocaml/Seed-ReventlessSeed.cmt +0 -0
- package/lib/ocaml/Seed.ast +0 -0
- package/lib/ocaml/Seed.res +4 -2
- package/lib/ocaml/Seed_Client-ReventlessSeed.cmt +0 -0
- package/lib/ocaml/Seed_Connect-ReventlessSeed.cmi +0 -0
- package/lib/ocaml/Seed_Connect-ReventlessSeed.cmj +0 -0
- package/lib/ocaml/Seed_Connect-ReventlessSeed.cmt +0 -0
- package/lib/ocaml/Seed_Connect.ast +0 -0
- package/lib/ocaml/Seed_Connect.res +49 -11
- package/lib/ocaml/Seed_Prompt-ReventlessSeed.cmi +0 -0
- package/lib/ocaml/Seed_Prompt-ReventlessSeed.cmt +0 -0
- package/lib/ocaml/Seed_Prompt.ast +0 -0
- package/lib/ocaml/Seed_Prompt.res +10 -20
- package/lib/ocaml/Seed_Random-ReventlessSeed.cmt +0 -0
- package/lib/ocaml/Seed_Runner-ReventlessSeed.cmi +0 -0
- package/lib/ocaml/Seed_Runner-ReventlessSeed.cmt +0 -0
- package/lib/ocaml/Seed_Runner.ast +0 -0
- package/lib/ocaml/Seed_Runner.res +5 -7
- package/lib/ocaml/Seed_Types-ReventlessSeed.cmt +0 -0
- package/lib/ocaml/Seed_Upload-ReventlessSeed.cmi +0 -0
- package/lib/ocaml/Seed_Upload-ReventlessSeed.cmj +0 -0
- package/lib/ocaml/Seed_Upload-ReventlessSeed.cmt +0 -0
- package/lib/ocaml/Seed_Upload.ast +0 -0
- package/lib/ocaml/Seed_Upload.res +59 -0
- package/lib/ocaml/UploadEndpointResolutionTest-ReventlessSeed.cmi +0 -0
- package/lib/ocaml/UploadEndpointResolutionTest-ReventlessSeed.cmj +0 -0
- package/lib/ocaml/UploadEndpointResolutionTest-ReventlessSeed.cmt +0 -0
- package/lib/ocaml/UploadEndpointResolutionTest.ast +0 -0
- package/lib/ocaml/UploadEndpointResolutionTest.res +100 -0
- package/package.json +6 -2
- package/rescript.json +9 -1
- package/src/Seed.res +4 -2
- package/src/Seed_Connect.res +49 -11
- package/src/Seed_Connect.res.mjs +24 -3
- package/src/Seed_Prompt.res +10 -20
- package/src/Seed_Prompt.res.mjs +1 -1
- package/src/Seed_Runner.res +5 -7
- package/src/Seed_Upload.res +59 -0
- package/src/Seed_Upload.res.mjs +29 -1
- package/tests/UploadEndpointResolutionTest.res +100 -0
- package/tests/UploadEndpointResolutionTest.res.mjs +59 -0
package/src/Seed_Connect.res
CHANGED
|
@@ -1,15 +1,25 @@
|
|
|
1
1
|
// Turns endpoints plus a login function into a ready `connection`.
|
|
2
2
|
//
|
|
3
3
|
// A connection is what a data set seeds against: an authenticated GraphQL
|
|
4
|
-
// client, the upload
|
|
5
|
-
// a human label for the target. `make` is provider-agnostic — it prompts for
|
|
4
|
+
// client, the deployment's upload endpoints (empty when it serves no uploads),
|
|
5
|
+
// and a human label for the target. `make` is provider-agnostic — it prompts for
|
|
6
6
|
// credentials, calls the supplied `login` to obtain a bearer, and wires it onto
|
|
7
7
|
// the client via `useToken`. Where the bearer comes from (a local `/login`
|
|
8
8
|
// round-trip, a Cognito id token) is the caller's concern.
|
|
9
9
|
|
|
10
10
|
open Seed_Types
|
|
11
11
|
|
|
12
|
-
|
|
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.
|
|
17
|
+
type connection = {
|
|
18
|
+
client: Seed_Client.t,
|
|
19
|
+
uploadEndpoint: string,
|
|
20
|
+
uploadEndpoints: dict<string>,
|
|
21
|
+
label: string,
|
|
22
|
+
}
|
|
13
23
|
|
|
14
24
|
/**
|
|
15
25
|
* Prompts for credentials, calls `login` to mint a bearer, and returns a
|
|
@@ -20,23 +30,47 @@ let make = async (
|
|
|
20
30
|
~label: string,
|
|
21
31
|
~endpoint: string,
|
|
22
32
|
~uploadEndpoint: string,
|
|
33
|
+
~uploadEndpoints: dict<string>=Dict.make(),
|
|
23
34
|
~login: (~username: string, ~password: string) => promise<string>,
|
|
24
35
|
~localDefaults: bool=false,
|
|
25
36
|
): connection => {
|
|
26
|
-
// `SEED_SKIP_UPLOADS` forces the connection to carry no upload endpoint
|
|
27
|
-
// data set's upload phase no-ops the same way it does when a
|
|
28
|
-
// none. Use it to seed domain data fast, or to skip a
|
|
29
|
-
// without editing the data set. It is the single
|
|
30
|
-
// `REVENTLESS_UPLOAD_ENDPOINT` env reads as "unset" (falls back
|
|
31
|
-
// so this is the reliable way to disable uploads
|
|
32
|
-
|
|
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
48
|
let (username, password) = await Seed_Prompt.credentials(~localDefaults)
|
|
34
49
|
let token = await login(~username, ~password)
|
|
35
50
|
let client = Seed_Client.make(~config={endpoint: endpoint})
|
|
36
51
|
client->Seed_Client.useToken(token)
|
|
37
|
-
{client, uploadEndpoint, label}
|
|
52
|
+
{client, uploadEndpoint, uploadEndpoints, label}
|
|
38
53
|
}
|
|
39
54
|
|
|
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
|
+
|
|
40
74
|
/**
|
|
41
75
|
* A login function backed by an HTTP login endpoint (the local dev
|
|
42
76
|
* `/__inmemory/login` shape: POST `{username, password}` → `{token}`). Reuses
|
|
@@ -63,6 +97,10 @@ let envOr = (key: string, fallback: string): string =>
|
|
|
63
97
|
* A ready `connect` thunk for the local dev platform, with the localhost
|
|
64
98
|
* defaults baked in and overridable per endpoint (arg, then env var, then
|
|
65
99
|
* default). Empty input at the credential prompt falls back to `admin`/`admin`.
|
|
100
|
+
*
|
|
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.
|
|
66
104
|
*/
|
|
67
105
|
let local = (~graphql=?, ~upload=?, ~login=?, ()): (unit => promise<connection>) => {
|
|
68
106
|
let endpoint =
|
package/src/Seed_Connect.res.mjs
CHANGED
|
@@ -4,10 +4,14 @@ import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
|
|
|
4
4
|
import * as Seed_Types$ReventlessSeed from "./Seed_Types.res.mjs";
|
|
5
5
|
import * as Seed_Client$ReventlessSeed from "./Seed_Client.res.mjs";
|
|
6
6
|
import * as Seed_Prompt$ReventlessSeed from "./Seed_Prompt.res.mjs";
|
|
7
|
+
import * as Seed_Upload$ReventlessSeed from "./Seed_Upload.res.mjs";
|
|
7
8
|
|
|
8
|
-
async function make(label, endpoint, uploadEndpoint, login, localDefaultsOpt) {
|
|
9
|
+
async function make(label, endpoint, uploadEndpoint, uploadEndpointsOpt, login, localDefaultsOpt) {
|
|
10
|
+
let uploadEndpoints = uploadEndpointsOpt !== undefined ? uploadEndpointsOpt : ({});
|
|
9
11
|
let localDefaults = localDefaultsOpt !== undefined ? localDefaultsOpt : false;
|
|
10
|
-
let
|
|
12
|
+
let skip = Stdlib_Option.isSome(Seed_Prompt$ReventlessSeed.envValue("SEED_SKIP_UPLOADS"));
|
|
13
|
+
let uploadEndpoint$1 = skip ? "" : uploadEndpoint;
|
|
14
|
+
let uploadEndpoints$1 = skip ? ({}) : uploadEndpoints;
|
|
11
15
|
let match = await Seed_Prompt$ReventlessSeed.credentials(localDefaults);
|
|
12
16
|
let token = await login(match[0], match[1]);
|
|
13
17
|
let client = Seed_Client$ReventlessSeed.make({
|
|
@@ -17,10 +21,26 @@ async function make(label, endpoint, uploadEndpoint, login, localDefaultsOpt) {
|
|
|
17
21
|
return {
|
|
18
22
|
client: client,
|
|
19
23
|
uploadEndpoint: uploadEndpoint$1,
|
|
24
|
+
uploadEndpoints: uploadEndpoints$1,
|
|
20
25
|
label: label
|
|
21
26
|
};
|
|
22
27
|
}
|
|
23
28
|
|
|
29
|
+
function uploadEndpointFor(c, store) {
|
|
30
|
+
let endpoint = Seed_Upload$ReventlessSeed.endpointFor(store, c.uploadEndpoint, c.uploadEndpoints);
|
|
31
|
+
if (endpoint !== undefined) {
|
|
32
|
+
return {
|
|
33
|
+
TAG: "Ok",
|
|
34
|
+
_0: endpoint
|
|
35
|
+
};
|
|
36
|
+
} else {
|
|
37
|
+
return {
|
|
38
|
+
TAG: "Error",
|
|
39
|
+
_0: Seed_Upload$ReventlessSeed.unresolvedReason(store, c.uploadEndpoints)
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
24
44
|
function viaLoginEndpoint(loginEndpoint) {
|
|
25
45
|
return async (username, password) => {
|
|
26
46
|
let client = Seed_Client$ReventlessSeed.make({
|
|
@@ -50,11 +70,12 @@ function local(graphql, upload, login, param) {
|
|
|
50
70
|
let endpoint = Stdlib_Option.getOr(graphql, Stdlib_Option.getOr(Seed_Prompt$ReventlessSeed.envValue("REVENTLESS_GRAPHQL_ENDPOINT"), "http://localhost:4000/graphql"));
|
|
51
71
|
let uploadEndpoint = Stdlib_Option.getOr(upload, Stdlib_Option.getOr(Seed_Prompt$ReventlessSeed.envValue("REVENTLESS_UPLOAD_ENDPOINT"), "http://localhost:4000/__inmemory/upload"));
|
|
52
72
|
let loginEndpoint = Stdlib_Option.getOr(login, Stdlib_Option.getOr(Seed_Prompt$ReventlessSeed.envValue("REVENTLESS_LOGIN_ENDPOINT"), "http://localhost:4000/__inmemory/login"));
|
|
53
|
-
return () => make("local", endpoint, uploadEndpoint, viaLoginEndpoint(loginEndpoint), true);
|
|
73
|
+
return () => make("local", endpoint, uploadEndpoint, undefined, viaLoginEndpoint(loginEndpoint), true);
|
|
54
74
|
}
|
|
55
75
|
|
|
56
76
|
export {
|
|
57
77
|
make,
|
|
78
|
+
uploadEndpointFor,
|
|
58
79
|
viaLoginEndpoint,
|
|
59
80
|
envOr,
|
|
60
81
|
local,
|
package/src/Seed_Prompt.res
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// One shared readline interface for every interactive prompt in a seed run.
|
|
2
2
|
//
|
|
3
3
|
// The reason this module exists: creating and closing a fresh `readline`
|
|
4
|
-
// interface per prompt leaves stdin paused after the first `close`, so the
|
|
4
|
+
// interface per prompt leaves NodeProcess.stdin paused after the first `close`, so the
|
|
5
5
|
// second prompt (password after username) never fires and the run hangs. A
|
|
6
6
|
// single interface, created lazily and closed exactly once, avoids that — and a
|
|
7
7
|
// `muted` gate on its output lets password entry reuse the same interface
|
|
@@ -14,18 +14,8 @@ open Seed_Types
|
|
|
14
14
|
|
|
15
15
|
// ── Node bindings ─────────────────────────────────────────────────────────────
|
|
16
16
|
|
|
17
|
-
type stream
|
|
18
|
-
@val @scope("process") external stdin: stream = "stdin"
|
|
19
|
-
@val @scope("process") external stdout: stream = "stdout"
|
|
20
|
-
@send external writeStream: (stream, string) => unit = "write"
|
|
21
|
-
@get external isTTY: stream => bool = "isTTY"
|
|
22
|
-
@send external pauseStream: stream => unit = "pause"
|
|
23
|
-
@send external unrefStream: stream => unit = "unref"
|
|
24
|
-
|
|
25
|
-
@scope("process") @val external processEnv: dict<string> = "env"
|
|
26
|
-
|
|
27
17
|
type rl
|
|
28
|
-
type rlOptions = {input: stream, output: stream, terminal?: bool}
|
|
18
|
+
type rlOptions = {input: NodeProcess.stream, output: NodeProcess.stream, terminal?: bool}
|
|
29
19
|
@module("node:readline") external createInterface: rlOptions => rl = "createInterface"
|
|
30
20
|
@send external question: (rl, string, string => unit) => unit = "question"
|
|
31
21
|
@send external closeRl: rl => unit = "close"
|
|
@@ -42,10 +32,10 @@ let iface = (): rl =>
|
|
|
42
32
|
switch rlRef.contents {
|
|
43
33
|
| Some(rl) => rl
|
|
44
34
|
| None =>
|
|
45
|
-
let rl = createInterface({input: stdin, output: stdout, terminal: true})
|
|
35
|
+
let rl = createInterface({input: NodeProcess.stdin, output: NodeProcess.stdout, terminal: true})
|
|
46
36
|
rl->setWriteToOutput(s =>
|
|
47
37
|
if !muted.contents {
|
|
48
|
-
stdout->
|
|
38
|
+
NodeProcess.stdout->NodeProcess.write(s)
|
|
49
39
|
}
|
|
50
40
|
)
|
|
51
41
|
rlRef := Some(rl)
|
|
@@ -58,23 +48,23 @@ let close = (): unit =>
|
|
|
58
48
|
rl->closeRl
|
|
59
49
|
rlRef := None
|
|
60
50
|
// Closing the interface is not enough: a terminal-mode readline leaves
|
|
61
|
-
// stdin resumed and reffed, which keeps the event loop alive so the CLI
|
|
51
|
+
// NodeProcess.stdin resumed and reffed, which keeps the event loop alive so the CLI
|
|
62
52
|
// never exits after seeding. Release it explicitly.
|
|
63
|
-
stdin->
|
|
64
|
-
stdin->
|
|
53
|
+
NodeProcess.stdin->NodeProcess.pause
|
|
54
|
+
NodeProcess.stdin->NodeProcess.unref
|
|
65
55
|
| None => ()
|
|
66
56
|
}
|
|
67
57
|
|
|
68
58
|
// ── Env + TTY ─────────────────────────────────────────────────────────────────
|
|
69
59
|
|
|
70
60
|
let envValue = (key: string): option<string> =>
|
|
71
|
-
switch
|
|
61
|
+
switch NodeProcess.env->Dict.get(key) {
|
|
72
62
|
| Some(v) if v->String.trim != "" => Some(v->String.trim)
|
|
73
63
|
| _ => None
|
|
74
64
|
}
|
|
75
65
|
|
|
76
66
|
let requireTty = (): unit =>
|
|
77
|
-
if !(stdin->isTTY) {
|
|
67
|
+
if !(NodeProcess.stdin->NodeProcess.isTTY->Option.getOr(false)) {
|
|
78
68
|
throw(
|
|
79
69
|
Failed(
|
|
80
70
|
"no TTY for an interactive prompt — set the documented SEED_* / REVENTLESS_DEMO_* " ++
|
|
@@ -101,7 +91,7 @@ let askHidden = (query: string): promise<string> =>
|
|
|
101
91
|
let rl = iface()
|
|
102
92
|
rl->question(query, answer => {
|
|
103
93
|
muted := false
|
|
104
|
-
stdout->
|
|
94
|
+
NodeProcess.stdout->NodeProcess.write("\n")
|
|
105
95
|
resolve(answer)
|
|
106
96
|
})
|
|
107
97
|
muted := true
|
package/src/Seed_Prompt.res.mjs
CHANGED
package/src/Seed_Runner.res
CHANGED
|
@@ -2,11 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
open Seed_Types
|
|
4
4
|
|
|
5
|
-
@scope("process") @val external exit: int => unit = "exit"
|
|
6
|
-
@scope("process") @val external env: dict<string> = "env"
|
|
7
5
|
|
|
8
6
|
let envOr = (key: string, fallback: string): string =>
|
|
9
|
-
env->Dict.get(key)->Option.getOr(fallback)
|
|
7
|
+
NodeProcess.env->Dict.get(key)->Option.getOr(fallback)
|
|
10
8
|
|
|
11
9
|
/** One line of progress per phase, so a slow run never looks hung. */
|
|
12
10
|
let report = (line: string): unit => Console.log(` ${line}`)
|
|
@@ -127,7 +125,7 @@ let run = async (main: unit => promise<unit>): unit =>
|
|
|
127
125
|
// Exit cleanly: HTTP keep-alive sockets (and, on the interactive path, the
|
|
128
126
|
// readline/stdin handle) can otherwise keep the event loop alive so the CLI
|
|
129
127
|
// appears to hang after a successful run.
|
|
130
|
-
exit(0)
|
|
128
|
+
NodeProcess.exit(0)
|
|
131
129
|
} catch {
|
|
132
130
|
| Failed(message) =>
|
|
133
131
|
Console.error("")
|
|
@@ -135,7 +133,7 @@ let run = async (main: unit => promise<unit>): unit =>
|
|
|
135
133
|
Console.error("fresh store once the cause below is fixed.")
|
|
136
134
|
Console.error("")
|
|
137
135
|
Console.error(message)
|
|
138
|
-
exit(1)
|
|
136
|
+
NodeProcess.exit(1)
|
|
139
137
|
| exn =>
|
|
140
138
|
Console.error("")
|
|
141
139
|
Console.error("Seeding aborted with an unexpected error:")
|
|
@@ -143,7 +141,7 @@ let run = async (main: unit => promise<unit>): unit =>
|
|
|
143
141
|
Console.error(
|
|
144
142
|
exn->JsExn.fromException->Option.flatMap(JsExn.message)->Option.getOr("unknown"),
|
|
145
143
|
)
|
|
146
|
-
exit(1)
|
|
144
|
+
NodeProcess.exit(1)
|
|
147
145
|
}
|
|
148
146
|
|
|
149
147
|
/**
|
|
@@ -172,7 +170,7 @@ let abortStartup = (message: string): unit => {
|
|
|
172
170
|
Console.error("Seeding did not start — nothing was written. Fix the cause below and re-run.")
|
|
173
171
|
Console.error("")
|
|
174
172
|
Console.error(message)
|
|
175
|
-
exit(1)
|
|
173
|
+
NodeProcess.exit(1)
|
|
176
174
|
}
|
|
177
175
|
|
|
178
176
|
/**
|
package/src/Seed_Upload.res
CHANGED
|
@@ -10,6 +10,11 @@
|
|
|
10
10
|
// absolute URL against the endpoint's origin: AWS returns an absolute presigned
|
|
11
11
|
// S3 URL (unchanged), while the local route returns a same-origin relative
|
|
12
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.
|
|
13
18
|
|
|
14
19
|
type fetchInit = {method: string, headers: dict<string>, body: string}
|
|
15
20
|
type response
|
|
@@ -38,6 +43,60 @@ let asString = (json: JSON.t): option<string> =>
|
|
|
38
43
|
| _ => None
|
|
39
44
|
}
|
|
40
45
|
|
|
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
|
+
}
|
|
99
|
+
|
|
41
100
|
// A `fetch` that reports an unreachable endpoint as `Error` instead of throwing,
|
|
42
101
|
// so the two-step upload can thread failures without exceptions.
|
|
43
102
|
let tryFetch = async (url: string, init: fetchInit): result<response, string> =>
|
package/src/Seed_Upload.res.mjs
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
// Generated by ReScript, PLEASE EDIT WITH CARE
|
|
2
2
|
|
|
3
3
|
import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
|
|
4
|
+
import * as Seed_Prompt$ReventlessSeed from "./Seed_Prompt.res.mjs";
|
|
4
5
|
|
|
5
6
|
function field(json, key) {
|
|
6
7
|
if (typeof json === "object" && json !== null && !Array.isArray(json)) {
|
|
@@ -14,6 +15,31 @@ function asString(json) {
|
|
|
14
15
|
}
|
|
15
16
|
}
|
|
16
17
|
|
|
18
|
+
function endpointFor(store, uploadEndpoint, uploadEndpoints) {
|
|
19
|
+
let legacy = uploadEndpoint === "" ? undefined : uploadEndpoint;
|
|
20
|
+
if (store !== undefined) {
|
|
21
|
+
return Stdlib_Option.orElse(uploadEndpoints[store], legacy);
|
|
22
|
+
} else {
|
|
23
|
+
return legacy;
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
function unresolvedReason(store, uploadEndpoints) {
|
|
28
|
+
let available = Object.keys(uploadEndpoints);
|
|
29
|
+
let match = Seed_Prompt$ReventlessSeed.envValue("SEED_SKIP_UPLOADS");
|
|
30
|
+
if (match !== undefined) {
|
|
31
|
+
return "SEED_SKIP_UPLOADS is set";
|
|
32
|
+
} else if (available.length !== 0) {
|
|
33
|
+
if (store !== undefined) {
|
|
34
|
+
return `this deployment publishes upload endpoints for ` + available.join(", ") + `, none for "` + store + `"`;
|
|
35
|
+
} else {
|
|
36
|
+
return `this deployment publishes only per-store upload endpoints (` + available.join(", ") + `) and this upload names no store`;
|
|
37
|
+
}
|
|
38
|
+
} else {
|
|
39
|
+
return "this deployment publishes no upload endpoint";
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
17
43
|
async function tryFetch(url, init) {
|
|
18
44
|
try {
|
|
19
45
|
return {
|
|
@@ -112,7 +138,9 @@ async function uploadAsset(uploadEndpoint, bytes, fileName, contentType, authTok
|
|
|
112
138
|
export {
|
|
113
139
|
field,
|
|
114
140
|
asString,
|
|
141
|
+
endpointFor,
|
|
142
|
+
unresolvedReason,
|
|
115
143
|
tryFetch,
|
|
116
144
|
uploadAsset,
|
|
117
145
|
}
|
|
118
|
-
/*
|
|
146
|
+
/* Seed_Prompt-ReventlessSeed Not a pure module */
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
// Which endpoint an asset uploads through once a deployment publishes one per
|
|
2
|
+
// declared store, and what a data set is told when none resolves.
|
|
3
|
+
//
|
|
4
|
+
// The four rows are the same ones the AutoUI renderer resolves an upload field
|
|
5
|
+
// by. They are pinned here because the two middle ones are what keep a
|
|
6
|
+
// deployment predating per-store endpoints — and the local dev server, which
|
|
7
|
+
// serves a single upload route — working unchanged, and because the row that
|
|
8
|
+
// falls back to the legacy service must never fall back to *another store*: that
|
|
9
|
+
// uploads into a different plugin's bucket with a 2xx and a plausible ref.
|
|
10
|
+
|
|
11
|
+
open JestGlobals
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
// `unresolvedReason` reads the knob, so the ambient environment has to be quiet.
|
|
15
|
+
let clearSkip = () => NodeProcess.env->Dict.set("SEED_SKIP_UPLOADS", "")
|
|
16
|
+
|
|
17
|
+
let perStore = Dict.fromArray([
|
|
18
|
+
("Catalog.productImages", "https://catalog.example/"),
|
|
19
|
+
("Ordering.invoices", "https://ordering.example/"),
|
|
20
|
+
])
|
|
21
|
+
|
|
22
|
+
describe("Seed.Upload.endpointFor", () => {
|
|
23
|
+
testSync("a declared store with a matching endpoint uses that store's endpoint", () =>
|
|
24
|
+
expect(
|
|
25
|
+
Seed.Upload.endpointFor(
|
|
26
|
+
~store="Catalog.productImages",
|
|
27
|
+
~uploadEndpoint="https://legacy.example/",
|
|
28
|
+
~uploadEndpoints=perStore,
|
|
29
|
+
),
|
|
30
|
+
)->toEqual(Some("https://catalog.example/"))
|
|
31
|
+
)
|
|
32
|
+
|
|
33
|
+
// Not "https://ordering.example/" — a wrong guess here is a silent
|
|
34
|
+
// wrong-bucket write.
|
|
35
|
+
testSync("a declared store with no matching endpoint falls back to the legacy service", () =>
|
|
36
|
+
expect(
|
|
37
|
+
Seed.Upload.endpointFor(
|
|
38
|
+
~store="Catalog.brochures",
|
|
39
|
+
~uploadEndpoint="https://legacy.example/",
|
|
40
|
+
~uploadEndpoints=perStore,
|
|
41
|
+
),
|
|
42
|
+
)->toEqual(Some("https://legacy.example/"))
|
|
43
|
+
)
|
|
44
|
+
|
|
45
|
+
testSync("naming no store uses the legacy service", () =>
|
|
46
|
+
expect(
|
|
47
|
+
Seed.Upload.endpointFor(~uploadEndpoint="https://legacy.example/", ~uploadEndpoints=perStore),
|
|
48
|
+
)->toEqual(Some("https://legacy.example/"))
|
|
49
|
+
)
|
|
50
|
+
|
|
51
|
+
testSync("neither available resolves nothing", () =>
|
|
52
|
+
expect(
|
|
53
|
+
Seed.Upload.endpointFor(
|
|
54
|
+
~store="Catalog.brochures",
|
|
55
|
+
~uploadEndpoint="",
|
|
56
|
+
~uploadEndpoints=Dict.make(),
|
|
57
|
+
),
|
|
58
|
+
)->toEqual(None)
|
|
59
|
+
)
|
|
60
|
+
|
|
61
|
+
// The local dev server's shape: one upload route, no per-store map, and a data
|
|
62
|
+
// set that names its store all the same.
|
|
63
|
+
testSync("a single-route deployment serves a store-naming data set", () =>
|
|
64
|
+
expect(
|
|
65
|
+
Seed.Upload.endpointFor(
|
|
66
|
+
~store="Catalog.productImages",
|
|
67
|
+
~uploadEndpoint="http://localhost:4000/__inmemory/upload",
|
|
68
|
+
~uploadEndpoints=Dict.make(),
|
|
69
|
+
),
|
|
70
|
+
)->toEqual(Some("http://localhost:4000/__inmemory/upload"))
|
|
71
|
+
)
|
|
72
|
+
})
|
|
73
|
+
|
|
74
|
+
// "no upload endpoint" states a fact about the deployment. When the deployment
|
|
75
|
+
// publishes endpoints the caller could not match, the fact is about the client,
|
|
76
|
+
// and that phrasing sends a reader to the bucket, the presign service and the
|
|
77
|
+
// IAM policy — all of which are correct.
|
|
78
|
+
describe("Seed.Upload.unresolvedReason", () => {
|
|
79
|
+
beforeEach(clearSkip)
|
|
80
|
+
|
|
81
|
+
testSync("no endpoints at all reads as a fact about the deployment", () =>
|
|
82
|
+
expect(
|
|
83
|
+
Seed.Upload.unresolvedReason(~store="Catalog.productImages", ~uploadEndpoints=Dict.make()),
|
|
84
|
+
)->toBe("this deployment publishes no upload endpoint")
|
|
85
|
+
)
|
|
86
|
+
|
|
87
|
+
testSync("an unmatched store names the store and the keys that were available", () => {
|
|
88
|
+
let msg = Seed.Upload.unresolvedReason(~store="Catalog.brochures", ~uploadEndpoints=perStore)
|
|
89
|
+
expect(msg)->toContain("Catalog.brochures")
|
|
90
|
+
expect(msg)->toContain("Catalog.productImages")
|
|
91
|
+
expect(msg)->toContain("Ordering.invoices")
|
|
92
|
+
})
|
|
93
|
+
|
|
94
|
+
testSync("the knob outranks both, so a skipped run is never read as a broken one", () => {
|
|
95
|
+
NodeProcess.env->Dict.set("SEED_SKIP_UPLOADS", "1")
|
|
96
|
+
expect(
|
|
97
|
+
Seed.Upload.unresolvedReason(~store="Catalog.productImages", ~uploadEndpoints=perStore),
|
|
98
|
+
)->toBe("SEED_SKIP_UPLOADS is set")
|
|
99
|
+
})
|
|
100
|
+
})
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
// Generated by ReScript, PLEASE EDIT WITH CARE
|
|
2
|
+
|
|
3
|
+
import * as Seed_Upload$ReventlessSeed from "../src/Seed_Upload.res.mjs";
|
|
4
|
+
|
|
5
|
+
function clearSkip() {
|
|
6
|
+
process.env["SEED_SKIP_UPLOADS"] = "";
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
let perStore = Object.fromEntries([
|
|
10
|
+
[
|
|
11
|
+
"Catalog.productImages",
|
|
12
|
+
"https://catalog.example/"
|
|
13
|
+
],
|
|
14
|
+
[
|
|
15
|
+
"Ordering.invoices",
|
|
16
|
+
"https://ordering.example/"
|
|
17
|
+
]
|
|
18
|
+
]);
|
|
19
|
+
|
|
20
|
+
globalThis.describe("Seed.Upload.endpointFor", () => {
|
|
21
|
+
globalThis.test("a declared store with a matching endpoint uses that store's endpoint", () => {
|
|
22
|
+
globalThis.expect(Seed_Upload$ReventlessSeed.endpointFor("Catalog.productImages", "https://legacy.example/", perStore)).toEqual("https://catalog.example/");
|
|
23
|
+
});
|
|
24
|
+
globalThis.test("a declared store with no matching endpoint falls back to the legacy service", () => {
|
|
25
|
+
globalThis.expect(Seed_Upload$ReventlessSeed.endpointFor("Catalog.brochures", "https://legacy.example/", perStore)).toEqual("https://legacy.example/");
|
|
26
|
+
});
|
|
27
|
+
globalThis.test("naming no store uses the legacy service", () => {
|
|
28
|
+
globalThis.expect(Seed_Upload$ReventlessSeed.endpointFor(undefined, "https://legacy.example/", perStore)).toEqual("https://legacy.example/");
|
|
29
|
+
});
|
|
30
|
+
globalThis.test("neither available resolves nothing", () => {
|
|
31
|
+
globalThis.expect(Seed_Upload$ReventlessSeed.endpointFor("Catalog.brochures", "", {})).toEqual(undefined);
|
|
32
|
+
});
|
|
33
|
+
globalThis.test("a single-route deployment serves a store-naming data set", () => {
|
|
34
|
+
globalThis.expect(Seed_Upload$ReventlessSeed.endpointFor("Catalog.productImages", "http://localhost:4000/__inmemory/upload", {})).toEqual("http://localhost:4000/__inmemory/upload");
|
|
35
|
+
});
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
globalThis.describe("Seed.Upload.unresolvedReason", () => {
|
|
39
|
+
globalThis.beforeEach(clearSkip);
|
|
40
|
+
globalThis.test("no endpoints at all reads as a fact about the deployment", () => {
|
|
41
|
+
globalThis.expect(Seed_Upload$ReventlessSeed.unresolvedReason("Catalog.productImages", {})).toBe("this deployment publishes no upload endpoint");
|
|
42
|
+
});
|
|
43
|
+
globalThis.test("an unmatched store names the store and the keys that were available", () => {
|
|
44
|
+
let msg = Seed_Upload$ReventlessSeed.unresolvedReason("Catalog.brochures", perStore);
|
|
45
|
+
globalThis.expect(msg).toContain("Catalog.brochures");
|
|
46
|
+
globalThis.expect(msg).toContain("Catalog.productImages");
|
|
47
|
+
globalThis.expect(msg).toContain("Ordering.invoices");
|
|
48
|
+
});
|
|
49
|
+
globalThis.test("the knob outranks both, so a skipped run is never read as a broken one", () => {
|
|
50
|
+
process.env["SEED_SKIP_UPLOADS"] = "1";
|
|
51
|
+
globalThis.expect(Seed_Upload$ReventlessSeed.unresolvedReason("Catalog.productImages", perStore)).toBe("SEED_SKIP_UPLOADS is set");
|
|
52
|
+
});
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
export {
|
|
56
|
+
clearSkip,
|
|
57
|
+
perStore,
|
|
58
|
+
}
|
|
59
|
+
/* perStore Not a pure module */
|