zuplo 7.0.0 → 7.0.1
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/docs/articles/ci-cd-azure/basic-deployment.mdx +2 -2
- package/docs/articles/ci-cd-azure/deploy-and-test.mdx +1 -1
- package/docs/articles/ci-cd-azure/local-testing.mdx +2 -2
- package/docs/articles/ci-cd-azure/multi-stage-deployment.mdx +3 -3
- package/docs/articles/ci-cd-azure/pr-preview-environments.mdx +1 -1
- package/docs/articles/ci-cd-azure/tag-based-releases.mdx +1 -1
- package/docs/articles/ci-cd-bitbucket/basic-deployment.mdx +1 -1
- package/docs/articles/ci-cd-bitbucket/deploy-and-test.mdx +1 -1
- package/docs/articles/ci-cd-bitbucket/local-testing.mdx +1 -1
- package/docs/articles/ci-cd-bitbucket/multi-stage-deployment.mdx +1 -1
- package/docs/articles/ci-cd-bitbucket/pr-preview-environments.mdx +1 -1
- package/docs/articles/ci-cd-bitbucket/tag-based-releases.mdx +1 -1
- package/docs/articles/ci-cd-circleci/basic-deployment.mdx +1 -1
- package/docs/articles/ci-cd-circleci/deploy-and-test.mdx +1 -1
- package/docs/articles/ci-cd-circleci/local-testing.mdx +2 -2
- package/docs/articles/ci-cd-circleci/multi-stage-deployment.mdx +3 -3
- package/docs/articles/ci-cd-circleci/pr-preview-environments.mdx +1 -1
- package/docs/articles/ci-cd-circleci/tag-based-releases.mdx +1 -1
- package/docs/articles/ci-cd-github/basic-deployment.mdx +1 -1
- package/docs/articles/ci-cd-github/cleanup-on-branch-delete.mdx +2 -2
- package/docs/articles/ci-cd-github/deploy-and-test.mdx +1 -1
- package/docs/articles/ci-cd-github/local-testing.mdx +2 -2
- package/docs/articles/ci-cd-github/multi-stage-deployment.mdx +3 -3
- package/docs/articles/ci-cd-github/pr-preview-environments.mdx +2 -2
- package/docs/articles/ci-cd-github/tag-based-releases.mdx +1 -1
- package/docs/articles/ci-cd-gitlab/basic-deployment.mdx +1 -1
- package/docs/articles/ci-cd-gitlab/deploy-and-test.mdx +1 -1
- package/docs/articles/ci-cd-gitlab/local-testing.mdx +1 -1
- package/docs/articles/ci-cd-gitlab/mr-preview-environments.mdx +1 -1
- package/docs/articles/ci-cd-gitlab/multi-stage-deployment.mdx +1 -1
- package/docs/articles/ci-cd-gitlab/tag-based-releases.mdx +1 -1
- package/docs/articles/github-deployment-testing.mdx +1 -1
- package/docs/articles/graphql-caching.mdx +2 -0
- package/docs/articles/local-development.mdx +4 -4
- package/docs/articles/monorepo-deployment.mdx +3 -3
- package/docs/articles/sharing-code-across-projects.mdx +2 -2
- package/docs/articles/step-1-setup-basic-gateway-local.mdx +1 -1
- package/docs/articles/testing.mdx +5 -5
- package/docs/articles/troubleshooting-slow-responses.mdx +5 -0
- package/docs/articles/update-zup-in-github-action.mdx +1 -1
- package/docs/caching/cdn-caching.mdx +397 -0
- package/docs/caching/custom-caching-policy.mdx +426 -0
- package/docs/caching/dynamic-cache-rules.mdx +427 -0
- package/docs/caching/gateway-caching.mdx +308 -0
- package/docs/caching/overview.mdx +150 -0
- package/docs/caching/partial-response-caching.mdx +641 -0
- package/docs/cli/overview.mdx +2 -3
- package/docs/dedicated/akamai/caching.mdx +245 -140
- package/docs/dev-portal/local-development.mdx +1 -1
- package/docs/dev-portal/migration.mdx +1 -1
- package/docs/mcp-gateway/quickstart-local.mdx +1 -1
- package/docs/policies/api-key-inbound/schema.json +4 -2
- package/docs/programmable-api/cache.mdx +7 -0
- package/docs/programmable-api/memory-zone-read-through-cache.mdx +2 -0
- package/docs/programmable-api/streaming-zone-cache.mdx +2 -0
- package/docs/programmable-api/zone-cache.mdx +7 -0
- package/package.json +5 -5
|
@@ -15,7 +15,7 @@ pool:
|
|
|
15
15
|
steps:
|
|
16
16
|
- task: NodeTool@0
|
|
17
17
|
inputs:
|
|
18
|
-
versionSpec: "
|
|
18
|
+
versionSpec: "24.x"
|
|
19
19
|
displayName: "Install Node.js"
|
|
20
20
|
|
|
21
21
|
- script: npm install
|
|
@@ -28,7 +28,7 @@ steps:
|
|
|
28
28
|
This pipeline:
|
|
29
29
|
|
|
30
30
|
1. Triggers on pushes to the `main` branch
|
|
31
|
-
2. Sets up Node.js
|
|
31
|
+
2. Sets up Node.js 24
|
|
32
32
|
3. Installs dependencies
|
|
33
33
|
4. Deploys to Zuplo using the branch name as the environment name
|
|
34
34
|
|
|
@@ -20,7 +20,7 @@ stages:
|
|
|
20
20
|
steps:
|
|
21
21
|
- task: NodeTool@0
|
|
22
22
|
inputs:
|
|
23
|
-
versionSpec: "
|
|
23
|
+
versionSpec: "24.x"
|
|
24
24
|
displayName: "Install Node.js"
|
|
25
25
|
|
|
26
26
|
- script: npm install
|
|
@@ -44,7 +44,7 @@ stages:
|
|
|
44
44
|
steps:
|
|
45
45
|
- task: NodeTool@0
|
|
46
46
|
inputs:
|
|
47
|
-
versionSpec: "
|
|
47
|
+
versionSpec: "24.x"
|
|
48
48
|
|
|
49
49
|
- script: npm install
|
|
50
50
|
|
|
@@ -20,7 +20,7 @@ stages:
|
|
|
20
20
|
steps:
|
|
21
21
|
- task: NodeTool@0
|
|
22
22
|
inputs:
|
|
23
|
-
versionSpec: "
|
|
23
|
+
versionSpec: "24.x"
|
|
24
24
|
|
|
25
25
|
- script: npm install
|
|
26
26
|
|
|
@@ -45,7 +45,7 @@ stages:
|
|
|
45
45
|
steps:
|
|
46
46
|
- task: NodeTool@0
|
|
47
47
|
inputs:
|
|
48
|
-
versionSpec: "
|
|
48
|
+
versionSpec: "24.x"
|
|
49
49
|
|
|
50
50
|
- script: npm install
|
|
51
51
|
|
|
@@ -66,7 +66,7 @@ stages:
|
|
|
66
66
|
|
|
67
67
|
- task: NodeTool@0
|
|
68
68
|
inputs:
|
|
69
|
-
versionSpec: "
|
|
69
|
+
versionSpec: "24.x"
|
|
70
70
|
|
|
71
71
|
- script: npm install
|
|
72
72
|
|
|
@@ -11,7 +11,7 @@ version: 2.1
|
|
|
11
11
|
jobs:
|
|
12
12
|
local-test:
|
|
13
13
|
docker:
|
|
14
|
-
- image: cimg/node:
|
|
14
|
+
- image: cimg/node:24.0
|
|
15
15
|
steps:
|
|
16
16
|
- checkout
|
|
17
17
|
- run: npm install
|
|
@@ -25,7 +25,7 @@ jobs:
|
|
|
25
25
|
|
|
26
26
|
deploy:
|
|
27
27
|
docker:
|
|
28
|
-
- image: cimg/node:
|
|
28
|
+
- image: cimg/node:24.0
|
|
29
29
|
steps:
|
|
30
30
|
- checkout
|
|
31
31
|
- run: npm install
|
|
@@ -11,7 +11,7 @@ version: 2.1
|
|
|
11
11
|
jobs:
|
|
12
12
|
deploy-staging:
|
|
13
13
|
docker:
|
|
14
|
-
- image: cimg/node:
|
|
14
|
+
- image: cimg/node:24.0
|
|
15
15
|
steps:
|
|
16
16
|
- checkout
|
|
17
17
|
- run: npm install
|
|
@@ -30,7 +30,7 @@ jobs:
|
|
|
30
30
|
|
|
31
31
|
test-staging:
|
|
32
32
|
docker:
|
|
33
|
-
- image: cimg/node:
|
|
33
|
+
- image: cimg/node:24.0
|
|
34
34
|
steps:
|
|
35
35
|
- checkout
|
|
36
36
|
- attach_workspace:
|
|
@@ -44,7 +44,7 @@ jobs:
|
|
|
44
44
|
|
|
45
45
|
deploy-production:
|
|
46
46
|
docker:
|
|
47
|
-
- image: cimg/node:
|
|
47
|
+
- image: cimg/node:24.0
|
|
48
48
|
steps:
|
|
49
49
|
- checkout
|
|
50
50
|
- run: npm install
|
|
@@ -25,7 +25,7 @@ jobs:
|
|
|
25
25
|
|
|
26
26
|
- uses: actions/setup-node@v4
|
|
27
27
|
with:
|
|
28
|
-
node-version:
|
|
28
|
+
node-version: 24
|
|
29
29
|
|
|
30
30
|
- name: Install dependencies
|
|
31
31
|
run: npm install
|
|
@@ -93,7 +93,7 @@ jobs:
|
|
|
93
93
|
|
|
94
94
|
- uses: actions/setup-node@v4
|
|
95
95
|
with:
|
|
96
|
-
node-version:
|
|
96
|
+
node-version: 24
|
|
97
97
|
|
|
98
98
|
- name: Install dependencies
|
|
99
99
|
run: npm install
|
|
@@ -24,7 +24,7 @@ jobs:
|
|
|
24
24
|
|
|
25
25
|
- uses: actions/setup-node@v4
|
|
26
26
|
with:
|
|
27
|
-
node-version:
|
|
27
|
+
node-version: 24
|
|
28
28
|
|
|
29
29
|
- name: Install dependencies
|
|
30
30
|
run: npm install
|
|
@@ -58,7 +58,7 @@ jobs:
|
|
|
58
58
|
|
|
59
59
|
- uses: actions/setup-node@v4
|
|
60
60
|
with:
|
|
61
|
-
node-version:
|
|
61
|
+
node-version: 24
|
|
62
62
|
|
|
63
63
|
- name: Install dependencies
|
|
64
64
|
run: npm install
|
|
@@ -27,7 +27,7 @@ jobs:
|
|
|
27
27
|
|
|
28
28
|
- uses: actions/setup-node@v4
|
|
29
29
|
with:
|
|
30
|
-
node-version:
|
|
30
|
+
node-version: 24
|
|
31
31
|
|
|
32
32
|
- name: Install dependencies
|
|
33
33
|
run: npm install
|
|
@@ -50,7 +50,7 @@ jobs:
|
|
|
50
50
|
|
|
51
51
|
- uses: actions/setup-node@v4
|
|
52
52
|
with:
|
|
53
|
-
node-version:
|
|
53
|
+
node-version: 24
|
|
54
54
|
|
|
55
55
|
- name: Install dependencies
|
|
56
56
|
run: npm install
|
|
@@ -73,7 +73,7 @@ jobs:
|
|
|
73
73
|
|
|
74
74
|
- uses: actions/setup-node@v4
|
|
75
75
|
with:
|
|
76
|
-
node-version:
|
|
76
|
+
node-version: 24
|
|
77
77
|
|
|
78
78
|
- name: Install dependencies
|
|
79
79
|
run: npm install
|
|
@@ -45,7 +45,7 @@ jobs:
|
|
|
45
45
|
|
|
46
46
|
- uses: actions/setup-node@v4
|
|
47
47
|
with:
|
|
48
|
-
node-version:
|
|
48
|
+
node-version: 24
|
|
49
49
|
|
|
50
50
|
- name: Install dependencies
|
|
51
51
|
run: npm install
|
|
@@ -89,7 +89,7 @@ jobs:
|
|
|
89
89
|
|
|
90
90
|
- uses: actions/setup-node@v4
|
|
91
91
|
with:
|
|
92
|
-
node-version:
|
|
92
|
+
node-version: 24
|
|
93
93
|
|
|
94
94
|
- name: Install dependencies
|
|
95
95
|
run: npm install
|
|
@@ -94,3 +94,5 @@ for the full option matrix, including how credentialed requests fail safe.
|
|
|
94
94
|
- [GraphQL on Zuplo](./graphql.mdx) — set up the endpoint and Dev Portal docs
|
|
95
95
|
- [GraphQL analytics](../analytics/tabs/graphql.md) — watch hit rates and
|
|
96
96
|
latency once traffic flows
|
|
97
|
+
- [Caching in Zuplo](../caching/overview.mdx) — the other caching layers a
|
|
98
|
+
GraphQL API can use, and when each one wins
|
|
@@ -8,7 +8,7 @@ development purposes using your favorite code editor.
|
|
|
8
8
|
|
|
9
9
|
## Requirements
|
|
10
10
|
|
|
11
|
-
- [Node.js](https://nodejs.org/en/download)
|
|
11
|
+
- [Node.js](https://nodejs.org/en/download) 24.0.0 or higher
|
|
12
12
|
- Linux, Mac OS X, Windows, or Windows Subsystem for Linux (WSL)
|
|
13
13
|
|
|
14
14
|
## Getting Started
|
|
@@ -36,12 +36,12 @@ development purposes using your favorite code editor.
|
|
|
36
36
|
|
|
37
37
|
### Import your existing project
|
|
38
38
|
|
|
39
|
-
If you have been
|
|
40
|
-
|
|
39
|
+
If you have been working in the _Zuplo Portal_, you can import your project into
|
|
40
|
+
your local machine.
|
|
41
41
|
|
|
42
42
|
<Stepper>
|
|
43
43
|
|
|
44
|
-
1. Connect your project to a Git repository from the _Zuplo
|
|
44
|
+
1. Connect your project to a Git repository from the _Zuplo Portal_.
|
|
45
45
|

|
|
46
46
|
1. Clone your project from your Git provider to your local machine.
|
|
47
47
|
1. Install the necessary dependencies:
|
|
@@ -108,7 +108,7 @@ jobs:
|
|
|
108
108
|
|
|
109
109
|
- uses: actions/setup-node@v4
|
|
110
110
|
with:
|
|
111
|
-
node-version:
|
|
111
|
+
node-version: 24
|
|
112
112
|
|
|
113
113
|
- name: Install dependencies
|
|
114
114
|
run: npm install
|
|
@@ -165,7 +165,7 @@ jobs:
|
|
|
165
165
|
|
|
166
166
|
- uses: actions/setup-node@v4
|
|
167
167
|
with:
|
|
168
|
-
node-version:
|
|
168
|
+
node-version: 24
|
|
169
169
|
|
|
170
170
|
- name: Install dependencies
|
|
171
171
|
run: npm install
|
|
@@ -207,7 +207,7 @@ jobs:
|
|
|
207
207
|
|
|
208
208
|
- uses: actions/setup-node@v4
|
|
209
209
|
with:
|
|
210
|
-
node-version:
|
|
210
|
+
node-version: 24
|
|
211
211
|
|
|
212
212
|
- name: Install dependencies
|
|
213
213
|
run: npm install
|
|
@@ -69,10 +69,10 @@ Configure your `package.json` to include the TypeScript source files and a
|
|
|
69
69
|
"postinstall": "node ./scripts/copy-to-modules.mjs"
|
|
70
70
|
},
|
|
71
71
|
"peerDependencies": {
|
|
72
|
-
"@zuplo/runtime": "^
|
|
72
|
+
"@zuplo/runtime": "^7.0.0"
|
|
73
73
|
},
|
|
74
74
|
"devDependencies": {
|
|
75
|
-
"@zuplo/runtime": "^
|
|
75
|
+
"@zuplo/runtime": "^7.0.0",
|
|
76
76
|
"typescript": "^5.0.0"
|
|
77
77
|
}
|
|
78
78
|
}
|
|
@@ -222,7 +222,7 @@ jobs:
|
|
|
222
222
|
- uses: actions/checkout@v4
|
|
223
223
|
- uses: actions/setup-node@v4
|
|
224
224
|
with:
|
|
225
|
-
node-version:
|
|
225
|
+
node-version: 24
|
|
226
226
|
- name: Install dependencies
|
|
227
227
|
run: npm install
|
|
228
228
|
- name: Start local server and run tests
|
|
@@ -244,7 +244,7 @@ jobs:
|
|
|
244
244
|
- uses: actions/checkout@v4
|
|
245
245
|
- uses: actions/setup-node@v4
|
|
246
246
|
with:
|
|
247
|
-
node-version:
|
|
247
|
+
node-version: 24
|
|
248
248
|
- name: Install dependencies
|
|
249
249
|
run: npm install
|
|
250
250
|
- name: Deploy to Zuplo
|
|
@@ -511,9 +511,9 @@ If you are running unit tests in a Node.js environment, you may need to polyfill
|
|
|
511
511
|
some globals. Zuplo itself doesn't run on Node.js, but because Zuplo is built on
|
|
512
512
|
standard API, testing in Node.js is possible.
|
|
513
513
|
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
code runs.
|
|
514
|
+
Node.js 24, the minimum version the Zuplo CLI supports, includes the `webcrypto`
|
|
515
|
+
module, which polyfills the `crypto` global. You must register this polyfill
|
|
516
|
+
before any Zuplo code runs.
|
|
517
517
|
|
|
518
518
|
```js
|
|
519
519
|
import { webcrypto } from "node:crypto";
|
|
@@ -135,6 +135,9 @@ from it. If latency scales with geographic distance, this is the cause.
|
|
|
135
135
|
- Deploy your backend in multiple regions
|
|
136
136
|
- Use Zuplo's [Caching policy](../policies/caching-inbound.mdx) to serve cached
|
|
137
137
|
responses from the edge without reaching the backend
|
|
138
|
+
- Put a CDN in front of the gateway so a hit returns from a POP near the caller
|
|
139
|
+
and never crosses the distance at all — see
|
|
140
|
+
[Cache at the CDN](../caching/cdn-caching.mdx)
|
|
138
141
|
- For internal or single-cloud traffic, consider
|
|
139
142
|
[Managed Dedicated](../dedicated/overview.mdx) deployment, which runs Zuplo
|
|
140
143
|
within your cloud provider's network for reduced latency by keeping traffic
|
|
@@ -367,6 +370,8 @@ back-and-forth diagnostic questions.
|
|
|
367
370
|
benchmark and compare gateway performance accurately
|
|
368
371
|
- [Proactive Monitoring](./monitoring-your-gateway.mdx) — Setting up health
|
|
369
372
|
checks and monitoring for your gateway
|
|
373
|
+
- [Caching in Zuplo](../caching/overview.mdx) — Picking the caching layer that
|
|
374
|
+
removes the latency instead of moving it
|
|
370
375
|
- [ZoneCache](../programmable-api/zone-cache.mdx) — Low-latency caching API for
|
|
371
376
|
frequently accessed data
|
|
372
377
|
- [Caching Policy](../policies/caching-inbound.mdx) — Built-in response caching
|