@sanity/runtime-cli 17.2.0 → 17.3.0
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/README.md +35 -26
- package/dist/actions/blueprints/assets.js +15 -24
- package/dist/actions/blueprints/pre-deploy.d.ts +29 -0
- package/dist/actions/blueprints/pre-deploy.js +164 -0
- package/dist/commands/functions/env/add.d.ts +3 -0
- package/dist/commands/functions/env/add.js +6 -2
- package/dist/commands/functions/env/list.d.ts +3 -0
- package/dist/commands/functions/env/list.js +9 -3
- package/dist/commands/functions/env/remove.d.ts +3 -0
- package/dist/commands/functions/env/remove.js +9 -3
- package/dist/constants.d.ts +1 -0
- package/dist/constants.js +1 -0
- package/dist/cores/blueprints/deploy.js +16 -64
- package/dist/utils/functions/child-process-wrapper.js +13 -171
- package/dist/utils/functions/child-runtime/console.d.ts +1 -0
- package/dist/utils/functions/child-runtime/console.js +50 -0
- package/dist/utils/functions/child-runtime/invoke.d.ts +4 -0
- package/dist/utils/functions/child-runtime/invoke.js +47 -0
- package/dist/utils/functions/child-runtime/resources.d.ts +4 -0
- package/dist/utils/functions/child-runtime/resources.js +59 -0
- package/dist/utils/studios/prepare-asset.d.ts +6 -0
- package/dist/utils/studios/prepare-asset.js +139 -0
- package/dist/utils/types.d.ts +4 -7
- package/dist/utils/types.js +2 -3
- package/oclif.manifest.json +932 -932
- package/package.json +10 -4
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ $ npm install -g @sanity/runtime-cli
|
|
|
20
20
|
$ sanity-run COMMAND
|
|
21
21
|
running command...
|
|
22
22
|
$ sanity-run (--version)
|
|
23
|
-
@sanity/runtime-cli/17.
|
|
23
|
+
@sanity/runtime-cli/17.3.0 linux-x64 node-v24.18.0
|
|
24
24
|
$ sanity-run --help [COMMAND]
|
|
25
25
|
USAGE
|
|
26
26
|
$ sanity-run COMMAND
|
|
@@ -103,7 +103,7 @@ EXAMPLES
|
|
|
103
103
|
$ sanity-run blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
-
_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
106
|
+
_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/add.ts)_
|
|
107
107
|
|
|
108
108
|
## `sanity-run blueprints config`
|
|
109
109
|
|
|
@@ -140,7 +140,7 @@ EXAMPLES
|
|
|
140
140
|
$ sanity-run blueprints config --edit --project-id <projectId> --stack <name-or-id>
|
|
141
141
|
```
|
|
142
142
|
|
|
143
|
-
_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
143
|
+
_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/config.ts)_
|
|
144
144
|
|
|
145
145
|
## `sanity-run blueprints deploy`
|
|
146
146
|
|
|
@@ -194,7 +194,7 @@ EXAMPLES
|
|
|
194
194
|
$ sanity-run blueprints deploy --new-stack-name <new-name>
|
|
195
195
|
```
|
|
196
196
|
|
|
197
|
-
_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
197
|
+
_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/deploy.ts)_
|
|
198
198
|
|
|
199
199
|
## `sanity-run blueprints destroy`
|
|
200
200
|
|
|
@@ -232,7 +232,7 @@ EXAMPLES
|
|
|
232
232
|
$ sanity-run blueprints destroy --stack <name-or-id> --project-id <projectId> --force --no-wait
|
|
233
233
|
```
|
|
234
234
|
|
|
235
|
-
_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
235
|
+
_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/destroy.ts)_
|
|
236
236
|
|
|
237
237
|
## `sanity-run blueprints doctor`
|
|
238
238
|
|
|
@@ -264,7 +264,7 @@ EXAMPLES
|
|
|
264
264
|
$ sanity-run blueprints doctor --fix
|
|
265
265
|
```
|
|
266
266
|
|
|
267
|
-
_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
267
|
+
_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/doctor.ts)_
|
|
268
268
|
|
|
269
269
|
## `sanity-run blueprints info`
|
|
270
270
|
|
|
@@ -301,7 +301,7 @@ EXAMPLES
|
|
|
301
301
|
$ sanity-run blueprints info --organization-id <orgId> --stack <name-or-id>
|
|
302
302
|
```
|
|
303
303
|
|
|
304
|
-
_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
304
|
+
_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/info.ts)_
|
|
305
305
|
|
|
306
306
|
## `sanity-run blueprints init [DIR]`
|
|
307
307
|
|
|
@@ -365,7 +365,7 @@ EXAMPLES
|
|
|
365
365
|
$ sanity-run blueprints init old-stack --type <json|js|ts> --project-id <projectId> --stack-id <existingStackId>
|
|
366
366
|
```
|
|
367
367
|
|
|
368
|
-
_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
368
|
+
_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/init.ts)_
|
|
369
369
|
|
|
370
370
|
## `sanity-run blueprints logs`
|
|
371
371
|
|
|
@@ -411,7 +411,7 @@ EXAMPLES
|
|
|
411
411
|
$ sanity-run blueprints logs --before 2026-05-01T00:00:00Z
|
|
412
412
|
```
|
|
413
413
|
|
|
414
|
-
_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
414
|
+
_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/logs.ts)_
|
|
415
415
|
|
|
416
416
|
## `sanity-run blueprints mint-deploy-token`
|
|
417
417
|
|
|
@@ -456,7 +456,7 @@ EXAMPLES
|
|
|
456
456
|
$ sanity-run blueprints mint-deploy-token --organization-id <orgId>
|
|
457
457
|
```
|
|
458
458
|
|
|
459
|
-
_See code: [src/commands/blueprints/mint-deploy-token.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
459
|
+
_See code: [src/commands/blueprints/mint-deploy-token.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/mint-deploy-token.ts)_
|
|
460
460
|
|
|
461
461
|
## `sanity-run blueprints plan`
|
|
462
462
|
|
|
@@ -489,7 +489,7 @@ EXAMPLES
|
|
|
489
489
|
$ sanity-run blueprints plan --organization-id <orgId> --stack <name-or-id>
|
|
490
490
|
```
|
|
491
491
|
|
|
492
|
-
_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
492
|
+
_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/plan.ts)_
|
|
493
493
|
|
|
494
494
|
## `sanity-run blueprints promote`
|
|
495
495
|
|
|
@@ -525,7 +525,7 @@ EXAMPLES
|
|
|
525
525
|
$ sanity-run blueprints promote --new-stack-name <new-name>
|
|
526
526
|
```
|
|
527
527
|
|
|
528
|
-
_See code: [src/commands/blueprints/promote.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
528
|
+
_See code: [src/commands/blueprints/promote.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/promote.ts)_
|
|
529
529
|
|
|
530
530
|
## `sanity-run blueprints stacks`
|
|
531
531
|
|
|
@@ -561,7 +561,7 @@ EXAMPLES
|
|
|
561
561
|
$ sanity-run blueprints stacks --organization-id <organizationId> --include-projects
|
|
562
562
|
```
|
|
563
563
|
|
|
564
|
-
_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
564
|
+
_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/blueprints/stacks.ts)_
|
|
565
565
|
|
|
566
566
|
## `sanity-run functions add`
|
|
567
567
|
|
|
@@ -613,7 +613,7 @@ EXAMPLES
|
|
|
613
613
|
$ sanity-run functions add --name my-function --type document-create --type document-update --lang js
|
|
614
614
|
```
|
|
615
615
|
|
|
616
|
-
_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
616
|
+
_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/functions/add.ts)_
|
|
617
617
|
|
|
618
618
|
## `sanity-run functions dev`
|
|
619
619
|
|
|
@@ -648,7 +648,7 @@ EXAMPLES
|
|
|
648
648
|
$ sanity-run functions dev --timeout 60
|
|
649
649
|
```
|
|
650
650
|
|
|
651
|
-
_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
651
|
+
_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/functions/dev.ts)_
|
|
652
652
|
|
|
653
653
|
## `sanity-run functions env add NAME KEY VALUE`
|
|
654
654
|
|
|
@@ -656,7 +656,7 @@ Add or set an environment variable for a deployed function
|
|
|
656
656
|
|
|
657
657
|
```
|
|
658
658
|
USAGE
|
|
659
|
-
$ sanity-run functions env add NAME KEY VALUE [--json]
|
|
659
|
+
$ sanity-run functions env add NAME KEY VALUE [--json] [--stack <value>]
|
|
660
660
|
|
|
661
661
|
ARGUMENTS
|
|
662
662
|
NAME The name of the Sanity Function
|
|
@@ -664,7 +664,8 @@ ARGUMENTS
|
|
|
664
664
|
VALUE The value of the environment variable
|
|
665
665
|
|
|
666
666
|
FLAGS
|
|
667
|
-
--json
|
|
667
|
+
--json Format output as json
|
|
668
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
668
669
|
|
|
669
670
|
DESCRIPTION
|
|
670
671
|
Add or set an environment variable for a deployed function
|
|
@@ -676,9 +677,11 @@ DESCRIPTION
|
|
|
676
677
|
|
|
677
678
|
EXAMPLES
|
|
678
679
|
$ sanity-run functions env add MyFunction API_URL https://api.example.com/
|
|
680
|
+
|
|
681
|
+
$ sanity-run functions env add --stack <name-or-id> MyFunction API_URL https://api.example.com/
|
|
679
682
|
```
|
|
680
683
|
|
|
681
|
-
_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
684
|
+
_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/functions/env/add.ts)_
|
|
682
685
|
|
|
683
686
|
## `sanity-run functions env list NAME`
|
|
684
687
|
|
|
@@ -686,13 +689,14 @@ List environment variables for a deployed function
|
|
|
686
689
|
|
|
687
690
|
```
|
|
688
691
|
USAGE
|
|
689
|
-
$ sanity-run functions env list NAME [--json]
|
|
692
|
+
$ sanity-run functions env list NAME [--json] [--stack <value>]
|
|
690
693
|
|
|
691
694
|
ARGUMENTS
|
|
692
695
|
NAME The name of the Sanity Function
|
|
693
696
|
|
|
694
697
|
FLAGS
|
|
695
|
-
--json
|
|
698
|
+
--json Format output as json
|
|
699
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
696
700
|
|
|
697
701
|
DESCRIPTION
|
|
698
702
|
List environment variables for a deployed function
|
|
@@ -703,9 +707,11 @@ DESCRIPTION
|
|
|
703
707
|
|
|
704
708
|
EXAMPLES
|
|
705
709
|
$ sanity-run functions env list MyFunction
|
|
710
|
+
|
|
711
|
+
$ sanity-run functions env list --stack <name-or-id> MyFunction
|
|
706
712
|
```
|
|
707
713
|
|
|
708
|
-
_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
714
|
+
_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/functions/env/list.ts)_
|
|
709
715
|
|
|
710
716
|
## `sanity-run functions env remove NAME KEY`
|
|
711
717
|
|
|
@@ -713,14 +719,15 @@ Remove an environment variable from a deployed function
|
|
|
713
719
|
|
|
714
720
|
```
|
|
715
721
|
USAGE
|
|
716
|
-
$ sanity-run functions env remove NAME KEY [--json]
|
|
722
|
+
$ sanity-run functions env remove NAME KEY [--json] [--stack <value>]
|
|
717
723
|
|
|
718
724
|
ARGUMENTS
|
|
719
725
|
NAME The name of the Sanity Function
|
|
720
726
|
KEY The name of the environment variable
|
|
721
727
|
|
|
722
728
|
FLAGS
|
|
723
|
-
--json
|
|
729
|
+
--json Format output as json
|
|
730
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
724
731
|
|
|
725
732
|
DESCRIPTION
|
|
726
733
|
Remove an environment variable from a deployed function
|
|
@@ -732,9 +739,11 @@ DESCRIPTION
|
|
|
732
739
|
|
|
733
740
|
EXAMPLES
|
|
734
741
|
$ sanity-run functions env remove MyFunction API_URL
|
|
742
|
+
|
|
743
|
+
$ sanity-run functions env remove --stack <name-or-id> MyFunction API_URL
|
|
735
744
|
```
|
|
736
745
|
|
|
737
|
-
_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
746
|
+
_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/functions/env/remove.ts)_
|
|
738
747
|
|
|
739
748
|
## `sanity-run functions logs [NAME]`
|
|
740
749
|
|
|
@@ -774,7 +783,7 @@ EXAMPLES
|
|
|
774
783
|
$ sanity-run functions logs <name> --delete
|
|
775
784
|
```
|
|
776
785
|
|
|
777
|
-
_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
786
|
+
_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/functions/logs.ts)_
|
|
778
787
|
|
|
779
788
|
## `sanity-run functions test [NAME]`
|
|
780
789
|
|
|
@@ -831,7 +840,7 @@ EXAMPLES
|
|
|
831
840
|
$ sanity-run functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
|
|
832
841
|
```
|
|
833
842
|
|
|
834
|
-
_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v17.
|
|
843
|
+
_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v17.3.0/src/commands/functions/test.ts)_
|
|
835
844
|
|
|
836
845
|
## `sanity-run help [COMMAND]`
|
|
837
846
|
|
|
@@ -1,48 +1,52 @@
|
|
|
1
1
|
import crypto from 'node:crypto';
|
|
2
2
|
import fs from 'node:fs';
|
|
3
|
+
import { readFile } from 'node:fs/promises';
|
|
3
4
|
import AdmZip from 'adm-zip';
|
|
4
5
|
import { blueprintsUrl } from '../../config.js';
|
|
5
6
|
import { CONVERT_BYTES_TO_MB, MAX_ASSET_SIZE } from '../../constants.js';
|
|
6
7
|
import { prepareAsset as prepareFunctionAsset } from '../../utils/functions/prepare-asset.js';
|
|
7
8
|
import getHeaders from '../../utils/get-headers.js';
|
|
9
|
+
import { prepareStudioAsset } from '../../utils/studios/prepare-asset.js';
|
|
8
10
|
import { createTracedFetch } from '../../utils/traced-fetch.js';
|
|
9
11
|
import { isLocalFunctionResource, isStudioResource } from '../../utils/types.js';
|
|
10
12
|
const assetsUrl = blueprintsUrl('assets');
|
|
11
13
|
export const assetCheckUrl = `${assetsUrl}/check`;
|
|
12
14
|
export const assetStashUrl = `${assetsUrl}/stash`;
|
|
13
15
|
export async function stashAsset({ resource, auth, blueprintFileDir, logger, installer, }) {
|
|
16
|
+
let cleanup = async () => { };
|
|
14
17
|
try {
|
|
15
18
|
let b64;
|
|
16
19
|
let hash;
|
|
17
20
|
let extension;
|
|
18
|
-
let cleanup;
|
|
19
21
|
if (isLocalFunctionResource(resource)) {
|
|
20
22
|
const prepResult = await prepareFunctionAsset({ resource, blueprintFileDir, installer });
|
|
21
23
|
if (prepResult.success === false) {
|
|
24
|
+
await prepResult.cleanup();
|
|
22
25
|
return {
|
|
23
26
|
success: false,
|
|
24
27
|
error: prepResult.error,
|
|
25
28
|
};
|
|
26
29
|
}
|
|
30
|
+
cleanup = prepResult.cleanup;
|
|
27
31
|
const zipResult = await pathToB64ZipHash(prepResult.outputPath);
|
|
28
32
|
b64 = zipResult.b64;
|
|
29
33
|
hash = zipResult.hash;
|
|
30
34
|
extension = 'zip';
|
|
31
|
-
cleanup = prepResult.cleanup;
|
|
32
35
|
}
|
|
33
36
|
else if (isStudioResource(resource)) {
|
|
34
|
-
const prepResult = await prepareStudioAsset({ resource });
|
|
37
|
+
const prepResult = await prepareStudioAsset({ resource, blueprintFileDir });
|
|
35
38
|
if (prepResult.success === false) {
|
|
39
|
+
await prepResult.cleanup();
|
|
36
40
|
return {
|
|
37
41
|
success: false,
|
|
38
42
|
error: prepResult.error,
|
|
39
43
|
};
|
|
40
44
|
}
|
|
41
|
-
|
|
45
|
+
cleanup = prepResult.cleanup;
|
|
46
|
+
const buffer = await readFile(prepResult.outputPath);
|
|
42
47
|
b64 = buffer.toString('base64');
|
|
43
48
|
hash = hashBuffer(buffer);
|
|
44
49
|
extension = 'tar.gz';
|
|
45
|
-
cleanup = prepResult.cleanup;
|
|
46
50
|
}
|
|
47
51
|
else {
|
|
48
52
|
return {
|
|
@@ -61,28 +65,15 @@ export async function stashAsset({ resource, auth, blueprintFileDir, logger, ins
|
|
|
61
65
|
});
|
|
62
66
|
}
|
|
63
67
|
catch (err) {
|
|
68
|
+
try {
|
|
69
|
+
await cleanup();
|
|
70
|
+
}
|
|
71
|
+
catch {
|
|
72
|
+
// ignore clean up errors
|
|
73
|
+
}
|
|
64
74
|
return { success: false, error: err instanceof Error ? err.message : `${err}` };
|
|
65
75
|
}
|
|
66
76
|
}
|
|
67
|
-
async function prepareStudioAsset({ resource, }) {
|
|
68
|
-
if (!fs.existsSync(resource.src)) {
|
|
69
|
-
return {
|
|
70
|
-
success: false,
|
|
71
|
-
async cleanup() {
|
|
72
|
-
// no op
|
|
73
|
-
},
|
|
74
|
-
error: `Property 'src' on resource with type '${resource.type}' must be a directory`,
|
|
75
|
-
};
|
|
76
|
-
}
|
|
77
|
-
return {
|
|
78
|
-
success: true,
|
|
79
|
-
async cleanup() {
|
|
80
|
-
// no op
|
|
81
|
-
},
|
|
82
|
-
// studio must be pre built (e.g. with `npm run build`) and tarred/gzipped
|
|
83
|
-
outputPath: resource.src,
|
|
84
|
-
};
|
|
85
|
-
}
|
|
86
77
|
async function stashSingleAsset({ b64, hash, cleanup, resource, auth, logger, extension = 'zip', }) {
|
|
87
78
|
const fetchFn = createTracedFetch(logger);
|
|
88
79
|
try {
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { BlueprintResource } from '@sanity/blueprints';
|
|
2
|
+
import type { Logger } from '../../utils/logger.js';
|
|
3
|
+
import { type AuthParams, type InstallerType, type ScopeType } from '../../utils/types.js';
|
|
4
|
+
type PreDeployResult = {
|
|
5
|
+
success: false;
|
|
6
|
+
error: string;
|
|
7
|
+
code?: string;
|
|
8
|
+
exitCode?: number;
|
|
9
|
+
suggestions?: string[];
|
|
10
|
+
} | {
|
|
11
|
+
success: true;
|
|
12
|
+
};
|
|
13
|
+
type PreDeployResourceOptions = {
|
|
14
|
+
auth: AuthParams;
|
|
15
|
+
blueprintFileDir: string;
|
|
16
|
+
installer: InstallerType;
|
|
17
|
+
log: Logger;
|
|
18
|
+
};
|
|
19
|
+
type PreDeployOptions = {
|
|
20
|
+
scopeType: ScopeType;
|
|
21
|
+
scopeId: string;
|
|
22
|
+
resources: BlueprintResource[];
|
|
23
|
+
stackId: string;
|
|
24
|
+
stackName: string;
|
|
25
|
+
bin: string;
|
|
26
|
+
verbose: boolean | undefined;
|
|
27
|
+
} & PreDeployResourceOptions;
|
|
28
|
+
export declare function preDeploy(options: PreDeployOptions): Promise<PreDeployResult>;
|
|
29
|
+
export {};
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
import { env } from 'node:process';
|
|
2
|
+
import { resolveDeployedResources } from '../../utils/blueprints/resolve-deployed-resources.js';
|
|
3
|
+
import { niceId } from '../../utils/display/presenters.js';
|
|
4
|
+
import { CODE_OPERATION_UNCONFIRMED, EXIT_OPERATION_UNCONFIRMED } from '../../utils/exit-codes.js';
|
|
5
|
+
import { styleText } from '../../utils/style-text.js';
|
|
6
|
+
import { isAssetResource, } from '../../utils/types.js';
|
|
7
|
+
import { stashAsset } from './assets.js';
|
|
8
|
+
import { updateStack } from './stacks.js';
|
|
9
|
+
import { waitForOperation } from './wait-for-operation.js';
|
|
10
|
+
const DEFAULT_ASSET_TIMEOUT = 180;
|
|
11
|
+
const assetTimeoutS = Number(process.env.SANITY_ASSET_TIMEOUT) || DEFAULT_ASSET_TIMEOUT;
|
|
12
|
+
const assetTimeoutMs = assetTimeoutS * 1000;
|
|
13
|
+
const warnTimeoutMs = assetTimeoutMs / 3;
|
|
14
|
+
export async function preDeploy(options) {
|
|
15
|
+
const { resources, stackId, auth, blueprintFileDir, installer, log } = options;
|
|
16
|
+
const hasAssetResources = resources.some(isAssetResource);
|
|
17
|
+
if (hasAssetResources) {
|
|
18
|
+
let assetResources;
|
|
19
|
+
if (env.SANITY_BLUEPRINTS_PRE_DEPLOY_ENABLED === 'true') {
|
|
20
|
+
const preDeployStackResult = await preDeployStack(options);
|
|
21
|
+
if (!preDeployStackResult.success) {
|
|
22
|
+
return preDeployStackResult;
|
|
23
|
+
}
|
|
24
|
+
/** Look up resources from the back-end and attach the externalId if possible */
|
|
25
|
+
const resolvedResources = await resolveDeployedResources({
|
|
26
|
+
resources,
|
|
27
|
+
stackId,
|
|
28
|
+
auth,
|
|
29
|
+
logger: log,
|
|
30
|
+
});
|
|
31
|
+
assetResources = resolvedResources.filter(isAssetResource);
|
|
32
|
+
}
|
|
33
|
+
else {
|
|
34
|
+
assetResources = resources.filter(isAssetResource);
|
|
35
|
+
}
|
|
36
|
+
log('Processing assets...');
|
|
37
|
+
for (const resource of assetResources) {
|
|
38
|
+
const preDeployResult = await preDeployResource(resource, {
|
|
39
|
+
auth,
|
|
40
|
+
blueprintFileDir,
|
|
41
|
+
installer,
|
|
42
|
+
log,
|
|
43
|
+
});
|
|
44
|
+
if (!preDeployResult.success)
|
|
45
|
+
return preDeployResult;
|
|
46
|
+
const idx = resources.findIndex((r) => r.name === resource.name);
|
|
47
|
+
if (idx === -1)
|
|
48
|
+
throw new Error('Unable to update resource asset');
|
|
49
|
+
resources[idx] = preDeployResult.resource;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
return { success: true };
|
|
53
|
+
}
|
|
54
|
+
async function preDeployStack(options) {
|
|
55
|
+
const { scopeType, scopeId, stackId, stackName, resources, auth, log, bin, verbose } = options;
|
|
56
|
+
const spinner = log.ora('Starting pre-deploy...').start();
|
|
57
|
+
const stackMutation = {
|
|
58
|
+
scopeType,
|
|
59
|
+
scopeId,
|
|
60
|
+
name: stackName,
|
|
61
|
+
preDeploy: true,
|
|
62
|
+
document: { resources },
|
|
63
|
+
};
|
|
64
|
+
const { ok: deployOk, stack, error: deployError, } = await updateStack({ stackId, stackMutation, auth, logger: log });
|
|
65
|
+
if (!deployOk) {
|
|
66
|
+
spinner.fail(`${styleText('red', 'Failed')} to complete Stack pre-deployment`);
|
|
67
|
+
return {
|
|
68
|
+
success: false,
|
|
69
|
+
error: deployError || 'Failed to complete Stack pre-deployment',
|
|
70
|
+
suggestions: [
|
|
71
|
+
`Run \`npx ${bin} blueprints plan\` to preview changes before deploying.`,
|
|
72
|
+
`Run \`npx ${bin} blueprints doctor\` to check your configuration.`,
|
|
73
|
+
],
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
spinner.stop().clear();
|
|
77
|
+
log(styleText('dim', 'Stack deployment progress:'));
|
|
78
|
+
log('');
|
|
79
|
+
const outcome = await waitForOperation({
|
|
80
|
+
stackId,
|
|
81
|
+
operationId: stack.operationId,
|
|
82
|
+
auth,
|
|
83
|
+
log,
|
|
84
|
+
bin,
|
|
85
|
+
verbose,
|
|
86
|
+
progressNoun: 'pre-deployment',
|
|
87
|
+
});
|
|
88
|
+
if (outcome.type === 'completed') {
|
|
89
|
+
log(styleText(['bold', 'green'], 'Stack pre-deployment completed!'));
|
|
90
|
+
}
|
|
91
|
+
else if (outcome.type === 'unconfirmed') {
|
|
92
|
+
return {
|
|
93
|
+
success: false,
|
|
94
|
+
error: `Stack pre-deployment was accepted but completion could not be confirmed${outcome.error ? ` (${outcome.error})` : ''}.`,
|
|
95
|
+
code: CODE_OPERATION_UNCONFIRMED,
|
|
96
|
+
exitCode: EXIT_OPERATION_UNCONFIRMED,
|
|
97
|
+
suggestions: [
|
|
98
|
+
'The pre-deployment may or may not have finished on Sanity servers.',
|
|
99
|
+
`Run \`npx ${bin} blueprints info\` to check status.`,
|
|
100
|
+
`Run \`npx ${bin} blueprints logs --watch\` to keep streaming logs.`,
|
|
101
|
+
],
|
|
102
|
+
};
|
|
103
|
+
}
|
|
104
|
+
else {
|
|
105
|
+
return {
|
|
106
|
+
success: false,
|
|
107
|
+
error: 'Stack pre-deployment failed',
|
|
108
|
+
suggestions: [
|
|
109
|
+
...outcome.logHints,
|
|
110
|
+
'Review the pre-deployment output above for error details.',
|
|
111
|
+
`Run \`npx ${bin} blueprints logs --verbose\` for more context.`,
|
|
112
|
+
`Run \`npx ${bin} blueprints plan\` to identify issues with your Blueprint.`,
|
|
113
|
+
],
|
|
114
|
+
};
|
|
115
|
+
}
|
|
116
|
+
return { success: true };
|
|
117
|
+
}
|
|
118
|
+
async function preDeployResource(resource, options) {
|
|
119
|
+
const { auth, blueprintFileDir, installer, log } = options;
|
|
120
|
+
const fnSpinner = log.ora({ text: `Processing ${resource.name}...`, prefixText: ' ' }).start();
|
|
121
|
+
const warnTimer = setTimeout(() => {
|
|
122
|
+
fnSpinner.text = `Still processing ${resource.name}, this can take a moment...`;
|
|
123
|
+
}, warnTimeoutMs);
|
|
124
|
+
let assetTimeoutTimer;
|
|
125
|
+
let result;
|
|
126
|
+
try {
|
|
127
|
+
result = await Promise.race([
|
|
128
|
+
stashAsset({ resource, blueprintFileDir, auth, logger: log, installer }),
|
|
129
|
+
new Promise((_, reject) => {
|
|
130
|
+
assetTimeoutTimer = setTimeout(() => {
|
|
131
|
+
reject(new Error(`Processing ${resource.name} timed out after ${assetTimeoutS}s`));
|
|
132
|
+
}, assetTimeoutMs);
|
|
133
|
+
}),
|
|
134
|
+
]);
|
|
135
|
+
}
|
|
136
|
+
catch (err) {
|
|
137
|
+
const msg = err instanceof Error ? err.message : String(err);
|
|
138
|
+
fnSpinner.fail(msg);
|
|
139
|
+
return { success: false, error: msg };
|
|
140
|
+
}
|
|
141
|
+
finally {
|
|
142
|
+
clearTimeout(warnTimer);
|
|
143
|
+
clearTimeout(assetTimeoutTimer);
|
|
144
|
+
}
|
|
145
|
+
if (result.success && result.assetId) {
|
|
146
|
+
const updatedResource = { ...resource, src: result.assetId };
|
|
147
|
+
fnSpinner.succeed(`${updatedResource.name} ${niceId(result.assetId)}`);
|
|
148
|
+
log(` Source: ${updatedResource.src}`);
|
|
149
|
+
if (result.hash) {
|
|
150
|
+
if (result.hash.length > 24) {
|
|
151
|
+
log.verbose(` Hash: ${result.hash.slice(0, 8)}...${result.hash.slice(-12)}`);
|
|
152
|
+
}
|
|
153
|
+
else {
|
|
154
|
+
log.verbose(` Hash: ${result.hash}`);
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
if (result.exists)
|
|
158
|
+
log.verbose(' Asset unchanged');
|
|
159
|
+
return { success: true, resource: updatedResource };
|
|
160
|
+
}
|
|
161
|
+
const errorMsg = `Failed uploading ${resource.name} asset, deploy has stopped`;
|
|
162
|
+
fnSpinner.fail(errorMsg);
|
|
163
|
+
return { success: false, error: result.error || 'Failed to process asset' };
|
|
164
|
+
}
|
|
@@ -8,6 +8,9 @@ export default class EnvAddCommand extends ResolvedCommand<typeof EnvAddCommand>
|
|
|
8
8
|
key: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
|
|
9
9
|
value: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
|
|
10
10
|
};
|
|
11
|
+
static flags: {
|
|
12
|
+
stack: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
13
|
+
};
|
|
11
14
|
static examples: string[];
|
|
12
15
|
run(): Promise<Record<string, unknown> | undefined>;
|
|
13
16
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { Args } from '@oclif/core';
|
|
2
|
-
import { ResolvedCommand } from '../../../baseCommands.js';
|
|
1
|
+
import { Args, Flags } from '@oclif/core';
|
|
2
|
+
import { ResolvedCommand, stackFlagConfig } from '../../../baseCommands.js';
|
|
3
3
|
import { functionEnvAddCore } from '../../../cores/functions/env/add.js';
|
|
4
4
|
import { Logger } from '../../../utils/logger.js';
|
|
5
5
|
export default class EnvAddCommand extends ResolvedCommand {
|
|
@@ -13,8 +13,12 @@ Environment variables are useful for API keys, configuration values, and other s
|
|
|
13
13
|
key: Args.string({ description: 'The name of the environment variable', required: true }),
|
|
14
14
|
value: Args.string({ description: 'The value of the environment variable', required: true }),
|
|
15
15
|
};
|
|
16
|
+
static flags = {
|
|
17
|
+
stack: Flags.string({ ...stackFlagConfig }),
|
|
18
|
+
};
|
|
16
19
|
static examples = [
|
|
17
20
|
'<%= config.bin %> <%= command.id %> MyFunction API_URL https://api.example.com/',
|
|
21
|
+
'<%= config.bin %> <%= command.id %> --stack <name-or-id> MyFunction API_URL https://api.example.com/',
|
|
18
22
|
];
|
|
19
23
|
async run() {
|
|
20
24
|
const result = await functionEnvAddCore({
|
|
@@ -6,6 +6,9 @@ export default class EnvListCommand extends ResolvedCommand<typeof EnvListComman
|
|
|
6
6
|
static args: {
|
|
7
7
|
name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
|
|
8
8
|
};
|
|
9
|
+
static flags: {
|
|
10
|
+
stack: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
11
|
+
};
|
|
9
12
|
static examples: string[];
|
|
10
13
|
run(): Promise<Record<string, unknown> | undefined>;
|
|
11
14
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { Args } from '@oclif/core';
|
|
2
|
-
import { ResolvedCommand } from '../../../baseCommands.js';
|
|
1
|
+
import { Args, Flags } from '@oclif/core';
|
|
2
|
+
import { ResolvedCommand, stackFlagConfig } from '../../../baseCommands.js';
|
|
3
3
|
import { functionEnvListCore } from '../../../cores/functions/env/list.js';
|
|
4
4
|
import { Logger } from '../../../utils/logger.js';
|
|
5
5
|
export default class EnvListCommand extends ResolvedCommand {
|
|
@@ -11,7 +11,13 @@ Use 'functions env add' to set variables or 'functions env remove' to delete the
|
|
|
11
11
|
static args = {
|
|
12
12
|
name: Args.string({ description: 'The name of the Sanity Function', required: true }),
|
|
13
13
|
};
|
|
14
|
-
static
|
|
14
|
+
static flags = {
|
|
15
|
+
stack: Flags.string({ ...stackFlagConfig }),
|
|
16
|
+
};
|
|
17
|
+
static examples = [
|
|
18
|
+
'<%= config.bin %> <%= command.id %> MyFunction',
|
|
19
|
+
'<%= config.bin %> <%= command.id %> --stack <name-or-id> MyFunction',
|
|
20
|
+
];
|
|
15
21
|
async run() {
|
|
16
22
|
const result = await functionEnvListCore({
|
|
17
23
|
bin: this.config.bin,
|
|
@@ -7,6 +7,9 @@ export default class EnvRemoveCommand extends ResolvedCommand<typeof EnvRemoveCo
|
|
|
7
7
|
name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
|
|
8
8
|
key: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
|
|
9
9
|
};
|
|
10
|
+
static flags: {
|
|
11
|
+
stack: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
12
|
+
};
|
|
10
13
|
static examples: string[];
|
|
11
14
|
run(): Promise<Record<string, unknown> | undefined>;
|
|
12
15
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { Args } from '@oclif/core';
|
|
2
|
-
import { ResolvedCommand } from '../../../baseCommands.js';
|
|
1
|
+
import { Args, Flags } from '@oclif/core';
|
|
2
|
+
import { ResolvedCommand, stackFlagConfig } from '../../../baseCommands.js';
|
|
3
3
|
import { functionEnvRemoveCore } from '../../../cores/functions/env/remove.js';
|
|
4
4
|
import { Logger } from '../../../utils/logger.js';
|
|
5
5
|
export default class EnvRemoveCommand extends ResolvedCommand {
|
|
@@ -12,7 +12,13 @@ Use 'functions env list' to see current variables before removing.`;
|
|
|
12
12
|
name: Args.string({ description: 'The name of the Sanity Function', required: true }),
|
|
13
13
|
key: Args.string({ description: 'The name of the environment variable', required: true }),
|
|
14
14
|
};
|
|
15
|
-
static
|
|
15
|
+
static flags = {
|
|
16
|
+
stack: Flags.string({ ...stackFlagConfig }),
|
|
17
|
+
};
|
|
18
|
+
static examples = [
|
|
19
|
+
'<%= config.bin %> <%= command.id %> MyFunction API_URL',
|
|
20
|
+
'<%= config.bin %> <%= command.id %> --stack <name-or-id> MyFunction API_URL',
|
|
21
|
+
];
|
|
16
22
|
async run() {
|
|
17
23
|
const result = await functionEnvRemoveCore({
|
|
18
24
|
bin: this.config.bin,
|
package/dist/constants.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ export declare const SANITY_PROJECT = "sanity.project";
|
|
|
9
9
|
export declare const SANITY_PROJECT_CORS = "sanity.project.cors";
|
|
10
10
|
export declare const SANITY_PROJECT_DATASET = "sanity.project.dataset";
|
|
11
11
|
export declare const SANITY_PROJECT_WEBHOOK = "sanity.project.webhook";
|
|
12
|
+
export declare const SANITY_STUDIO = "sanity.studio";
|
|
12
13
|
export declare const EVENT_DOCUMENT_PUBLISH = "document-publish";
|
|
13
14
|
export declare const EVENT_DOCUMENT_CREATE = "document-create";
|
|
14
15
|
export declare const EVENT_DOCUMENT_UPDATE = "document-update";
|
package/dist/constants.js
CHANGED
|
@@ -9,6 +9,7 @@ export const SANITY_PROJECT = 'sanity.project';
|
|
|
9
9
|
export const SANITY_PROJECT_CORS = 'sanity.project.cors';
|
|
10
10
|
export const SANITY_PROJECT_DATASET = 'sanity.project.dataset';
|
|
11
11
|
export const SANITY_PROJECT_WEBHOOK = 'sanity.project.webhook';
|
|
12
|
+
export const SANITY_STUDIO = 'sanity.studio';
|
|
12
13
|
export const EVENT_DOCUMENT_PUBLISH = 'document-publish';
|
|
13
14
|
export const EVENT_DOCUMENT_CREATE = 'document-create';
|
|
14
15
|
export const EVENT_DOCUMENT_UPDATE = 'document-update';
|