@heroku/plugin-compute 0.3.1 → 0.3.2

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 (72) hide show
  1. package/lib/commands/compute/create/telemetry-drain.d.ts +1 -0
  2. package/lib/commands/compute/create/telemetry-drain.js +2 -1
  3. package/lib/commands/compute/create/telemetry-drain.js.map +1 -1
  4. package/lib/commands/compute/delete/telemetry-drain.d.ts +20 -0
  5. package/lib/commands/compute/delete/telemetry-drain.js +60 -0
  6. package/lib/commands/compute/delete/telemetry-drain.js.map +1 -0
  7. package/lib/commands/compute/deploy.d.ts +5 -11
  8. package/lib/commands/compute/deploy.js +7 -65
  9. package/lib/commands/compute/deploy.js.map +1 -1
  10. package/lib/commands/compute/display/telemetry-drain.d.ts +1 -0
  11. package/lib/commands/compute/display/telemetry-drain.js +4 -3
  12. package/lib/commands/compute/display/telemetry-drain.js.map +1 -1
  13. package/lib/commands/compute/display.d.ts +1 -0
  14. package/lib/commands/compute/display.js +2 -1
  15. package/lib/commands/compute/display.js.map +1 -1
  16. package/lib/commands/compute/get/build-log.d.ts +1 -0
  17. package/lib/commands/compute/get/build-log.js +2 -1
  18. package/lib/commands/compute/get/build-log.js.map +1 -1
  19. package/lib/commands/compute/get/config.d.ts +1 -0
  20. package/lib/commands/compute/get/config.js +2 -1
  21. package/lib/commands/compute/get/config.js.map +1 -1
  22. package/lib/commands/compute/get/runtime-log.d.ts +1 -0
  23. package/lib/commands/compute/get/runtime-log.js +14 -3
  24. package/lib/commands/compute/get/runtime-log.js.map +1 -1
  25. package/lib/commands/compute/list/config.d.ts +1 -0
  26. package/lib/commands/compute/list/config.js +2 -1
  27. package/lib/commands/compute/list/config.js.map +1 -1
  28. package/lib/commands/compute/list/telemetry-drain.d.ts +1 -0
  29. package/lib/commands/compute/list/telemetry-drain.js +2 -1
  30. package/lib/commands/compute/list/telemetry-drain.js.map +1 -1
  31. package/lib/commands/compute/list.d.ts +1 -0
  32. package/lib/commands/compute/list.js +2 -1
  33. package/lib/commands/compute/list.js.map +1 -1
  34. package/lib/commands/compute/scale.d.ts +1 -0
  35. package/lib/commands/compute/scale.js +2 -1
  36. package/lib/commands/compute/scale.js.map +1 -1
  37. package/lib/commands/compute/set/config.d.ts +1 -0
  38. package/lib/commands/compute/set/config.js +2 -1
  39. package/lib/commands/compute/set/config.js.map +1 -1
  40. package/lib/commands/compute/source/retrieve.d.ts +1 -0
  41. package/lib/commands/compute/source/retrieve.js +2 -1
  42. package/lib/commands/compute/source/retrieve.js.map +1 -1
  43. package/lib/commands/compute/tail/runtime-log.d.ts +1 -0
  44. package/lib/commands/compute/tail/runtime-log.js +22 -6
  45. package/lib/commands/compute/tail/runtime-log.js.map +1 -1
  46. package/lib/commands/compute/unset/config.d.ts +1 -0
  47. package/lib/commands/compute/unset/config.js +2 -1
  48. package/lib/commands/compute/unset/config.js.map +1 -1
  49. package/lib/commands/compute/update/telemetry-drain.d.ts +1 -0
  50. package/lib/commands/compute/update/telemetry-drain.js +2 -1
  51. package/lib/commands/compute/update/telemetry-drain.js.map +1 -1
  52. package/lib/shared/computeGenerateSkeletons.js +4 -2
  53. package/lib/shared/computeGenerateSkeletons.js.map +1 -1
  54. package/lib/shared/computeLogStream.d.ts +6 -1
  55. package/lib/shared/computeLogStream.js +30 -3
  56. package/lib/shared/computeLogStream.js.map +1 -1
  57. package/lib/shared/computeTelemetryDrain.d.ts +1 -0
  58. package/lib/shared/computeTelemetryDrain.js +5 -8
  59. package/lib/shared/computeTelemetryDrain.js.map +1 -1
  60. package/messages/compute.create.telemetry-drain.md +1 -1
  61. package/messages/compute.delete.telemetry-drain.md +41 -0
  62. package/messages/compute.deploy.md +12 -70
  63. package/messages/compute.display.telemetry-drain.md +1 -0
  64. package/messages/compute.errors.md +15 -5
  65. package/messages/compute.get.runtime-log.md +19 -0
  66. package/messages/compute.source.retrieve.md +1 -1
  67. package/messages/compute.update.telemetry-drain.md +1 -1
  68. package/npm-shrinkwrap.json +147 -504
  69. package/oclif.manifest.json +202 -19
  70. package/package.json +4 -4
  71. package/schemas/compute-delete-telemetry__drain.json +22 -0
  72. package/schemas/compute-deploy.json +0 -30
@@ -0,0 +1,41 @@
1
+ # summary
2
+
3
+ Delete a compute telemetry drain.
4
+
5
+ # description
6
+
7
+ Removes a single OpenTelemetry drain by its ID, so its compute app stops
8
+ forwarding logs, metrics, and traces to the drain's endpoint. This can't be
9
+ undone; to forward telemetry again, create a new drain. You're asked to
10
+ confirm first unless you pass --no-prompt. Use sf compute list telemetry-drain
11
+ to find a drain's ID.
12
+
13
+ # args.id.summary
14
+
15
+ ID of the telemetry drain to delete.
16
+
17
+ # flags.no-prompt.summary
18
+
19
+ Don't ask for confirmation before deleting.
20
+
21
+ # info.confirm
22
+
23
+ Delete telemetry drain %s? This stops forwarding telemetry to its endpoint.
24
+
25
+ # info.aborted
26
+
27
+ Telemetry drain %s was not deleted.
28
+
29
+ # info.deleted
30
+
31
+ Deleted telemetry drain %s.
32
+
33
+ # examples
34
+
35
+ - Delete a telemetry drain, confirming first:
36
+
37
+ <%= config.bin %> <%= command.id %> 01234567-89ab-cdef-0123-456789abcdef --target-org my-org
38
+
39
+ - Delete a telemetry drain without the confirmation prompt, for scripts:
40
+
41
+ <%= config.bin %> <%= command.id %> 01234567-89ab-cdef-0123-456789abcdef --target-org my-org --no-prompt
@@ -1,84 +1,26 @@
1
1
  # summary
2
2
 
3
- Deploy a compute app's source and metadata to an org.
3
+ Show how to deploy a compute app.
4
4
 
5
5
  # description
6
6
 
7
- Packages the compute app's source (everything under its directory except the
8
- compute metadata file and .forceignore) together with its api-spec.yaml into
9
- a deployment bundle, uploads it to the org through the Connect API, then
10
- deploys the app's <name>.compute-meta.xml through the
11
- Metadata API to trigger the build. The metadata deploy itself returns a job
12
- ID that can be checked independently with "sf project deploy report
13
- --job-id <id>". Deploy is asynchronous: this command returns once the build
14
- has been enqueued, it doesn't wait for the build to finish.
15
-
16
- Files matching patterns in a .forceignore are excluded from the source
17
- bundle. Both the compute app's own .forceignore and the one at the project
18
- root (next to sfdx-project.json) are applied, if present. api-spec.yaml and
19
- project.toml are always included, since the build can't succeed without them.
20
-
21
- # flags.source-dir.summary
22
-
23
- Directory containing the compute app to deploy. Defaults to the current directory.
7
+ This command no longer deploys compute apps. Install the Compute variant of
8
+ the deploy-retrieve plugin and use project deploy start from your Salesforce
9
+ DX project instead.
24
10
 
25
11
  # examples
26
12
 
27
- - Deploy a compute app to an org, from inside the app's own directory:
28
-
29
- cd force-app/main/default/platformComputeApps/CreditRatingScorer
30
-
31
- <%= config.bin %> <%= command.id %> --target-org my-org
32
-
33
- - Deploy a compute app to an org, from anywhere, by pointing --source-dir at it:
34
-
35
- <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/platformComputeApps/CreditRatingScorer --target-org my-org
36
-
37
- # error.notAppDir
38
-
39
- This directory has no %s.compute-meta.xml. Run this command from inside the compute app's own directory (the one "sf compute generate" created).
40
-
41
- # error.notAppDir.actions
42
-
43
- - cd into the compute app's directory (e.g. force-app/main/default/platformComputeApps/<AppName>) and run the command again.
44
- - Run sf compute generate first if the app hasn't been scaffolded yet.
45
-
46
- # error.noProcfile
47
-
48
- %s has no Procfile. A compute app needs a Procfile to define how it starts.
49
-
50
- # error.noProcfile.actions
51
-
52
- - Add a Procfile to the app directory before deploying.
53
-
54
- # error.noApiSpec
55
-
56
- %s has no api-spec.yaml. A compute app needs an OpenAPI spec to describe its external service.
57
-
58
- # error.noApiSpec.actions
59
-
60
- - Add an api-spec.yaml to the app directory before deploying.
61
-
62
- # info.preparing
63
-
64
- Preparing deployment for %s...
65
-
66
- # info.packaging
67
-
68
- packaging source (%s files, %s)... done
69
-
70
- # info.uploading
71
-
72
- uploading source... done
13
+ - Install the plugin and deploy a compute app:
73
14
 
74
- # info.deployingMetadata
15
+ <%= config.bin %> plugins install @salesforce/plugin-deploy-retrieve@compute
75
16
 
76
- Deploying metadata to %s...
17
+ <%= config.bin %> project deploy start --metadata PlatformComputeApp:my_app --target-org my-org
77
18
 
78
- # info.deployedMetaFile
19
+ # error.migrate
79
20
 
80
- %s... done (%s)
21
+ This command no longer deploys compute apps.
81
22
 
82
- # info.buildEnqueued
23
+ # error.migrate.actions
83
24
 
84
- Build enqueued.
25
+ - Run sf plugins install @salesforce/plugin-deploy-retrieve@compute.
26
+ - From your Salesforce DX project, run sf project deploy start --metadata PlatformComputeApp:<app-name> --target-org <org>.
@@ -7,6 +7,7 @@ Show the full detail of a single compute telemetry drain.
7
7
  Shows a single OpenTelemetry drain in full: the compute app it belongs to,
8
8
  the signals it forwards, and its exporter endpoint, transport, and headers.
9
9
  Use sf compute list telemetry-drain to find a drain's ID.
10
+ Header values are redacted in both human-readable and --json output; header keys are preserved.
10
11
 
11
12
  # args.id.summary
12
13
 
@@ -39,7 +39,8 @@ No compute app named %s was found in the org. It may not have been deployed yet,
39
39
 
40
40
  # error.appNotFoundInOrg.actions
41
41
 
42
- - cd into the compute app's directory and run sf compute deploy --target-org <org> to deploy it.
42
+ - Run sf plugins install @salesforce/plugin-deploy-retrieve@compute.
43
+ - From your Salesforce DX project, run sf project deploy start --metadata PlatformComputeApp:%s --target-org <org>.
43
44
  - Check that the app's directory name matches the DeveloperName used when it was deployed.
44
45
 
45
46
  # error.ambiguousName
@@ -77,6 +78,15 @@ Couldn't read the log stream: %s
77
78
  - Run the command again; the log session may have expired.
78
79
  - If the problem persists, check your network connection to logplex.heroku.com.
79
80
 
81
+ # error.logFetchTimedOut
82
+
83
+ Timed out waiting for the log output after %s seconds.
84
+
85
+ # error.logFetchTimedOut.actions
86
+
87
+ - Run the command again.
88
+ - To watch the live log instead of a snapshot, use sf compute tail runtime-log.
89
+
80
90
  # error.herokuAppNotFound
81
91
 
82
92
  Heroku didn't find an app named %s.
@@ -130,7 +140,7 @@ Compute app %s doesn't have a Heroku app identifier yet.
130
140
  # error.herokuAppIdentifierUnavailable.actions
131
141
 
132
142
  - Wait for the app's current build to finish, then run the command again.
133
- - If the app has never had a successful build, run sf compute deploy first.
143
+ - If the app has never had a successful build, deploy it first with project deploy start.
134
144
 
135
145
  # error.configVarNotFound
136
146
 
@@ -146,7 +156,7 @@ Couldn't retrieve metadata for compute app %s: %s
146
156
 
147
157
  # error.metadataRetrieveFailed.actions
148
158
 
149
- - Confirm the app has been deployed to this org (run sf compute deploy first).
159
+ - Confirm the app has been deployed to this org (run project deploy start first).
150
160
  - Check that --name matches the DeveloperName used when it was deployed.
151
161
 
152
162
  # error.sourceDownloadFailed
@@ -156,7 +166,7 @@ Couldn't download the compute app's source: %s
156
166
  # error.sourceDownloadFailed.actions
157
167
 
158
168
  - Confirm the target org has compute apps enabled and that you have the DeployCompute or ManageCompute permission.
159
- - Confirm the app has been deployed to this org (run sf compute deploy first).
169
+ - Confirm the app has been deployed to this org (run project deploy start first).
160
170
 
161
171
  # error.sourceBundleMalformed
162
172
 
@@ -209,7 +219,7 @@ The telemetry transport "%s" isn't valid. Use one of: %s.
209
219
 
210
220
  # error.invalidHeader
211
221
 
212
- The telemetry header "%s" isn't valid. Headers must be passed as key=value.
222
+ A telemetry header isn't valid. Headers must be passed as key=value.
213
223
 
214
224
  # error.invalidHeader.actions
215
225
 
@@ -11,6 +11,12 @@ build-log for that.
11
11
  This prints the most recent log lines and exits. To keep the session open and
12
12
  stream new lines as they arrive, use compute tail runtime-log.
13
13
 
14
+ The recent lines come from the Cedar log buffer (about 1500 lines at most), so
15
+ --num can't return more than that. Fir apps keep no log history, so this
16
+ command isn't supported for them; use compute tail runtime-log instead. The
17
+ command stops waiting after 30 seconds and prints whatever log lines it has
18
+ received by then; if none arrived, it fails with a timeout error.
19
+
14
20
  This is an org-mediated operation by --name (the app's DeveloperName) -- the
15
21
  org creates a log session with Heroku on your behalf and hands back a
16
22
  short-lived, pre-authorized URL that the CLI reads from directly. It doesn't
@@ -27,6 +33,19 @@ directory's app name if that isn't set either.
27
33
 
28
34
  Number of recent log lines to print.
29
35
 
36
+ # error.firNoLogHistory
37
+
38
+ Fir apps keep no log history, so there is no recent log to fetch for %s.
39
+
40
+ # error.firNoLogHistory.actions
41
+
42
+ - Run sf compute tail runtime-log to watch the live log instead.
43
+ - To learn how Fir differs from Cedar, see https://devcenter.heroku.com/articles/generations.
44
+
45
+ # warning.logFetchPartial
46
+
47
+ The log output didn't finish arriving in time, so only the lines received so far are shown.
48
+
30
49
  # info.noBuildsFound
31
50
 
32
51
  Compute app %s has no builds yet, so it has no logs.
@@ -7,7 +7,7 @@ Retrieve a compute app's source and metadata from an org into your local Salesfo
7
7
  Creates the compute app's directory under force-app/main/default/platformComputeApps/<name>/
8
8
  (or --output-dir), retrieves its <name>.compute-meta.xml through the Metadata
9
9
  API, then downloads its source code through the Connect API and extracts it
10
- into that same directory. This is the inverse of sf compute deploy.
10
+ into that same directory. Deploy it with project deploy start.
11
11
 
12
12
  # flags.name.summary
13
13
 
@@ -32,7 +32,7 @@ Header to send with each export, as key=value.
32
32
 
33
33
  Repeat the flag to send more than one header. A header you pass adds
34
34
  or overwrites the one with the same name; the drain's other headers are kept. Header values often carry credentials; they are
35
- never printed to the terminal, but are included in --json output.
35
+ never printed to the terminal or --json output; header keys are preserved with redacted values.
36
36
 
37
37
  # error.nothingToUpdate
38
38