You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Making HTTP Requests Within an Application](#making-http-requests-within-an-application)
@@ -232,10 +233,14 @@ However, the wildcard implies that the component requires _all other_ components
232
233
233
234
To make an HTTP request to another route with your application, you can pass just the route as the URL. For example, if you make an outbound HTTP request to `/api/customers/`, Spin prepends the route with whatever host the application is running on. It also replaces the URL scheme (`http` or `https`) with the scheme of the current HTTP request. For example, if the application is running in the cloud, Spin changes `/api` to `https://.../api`.
234
235
236
+
> You can also use the special host `self.alt` to perform self-requests by route. This is important for the JavaScript `fetch` wrapper, which handles relative requests in a way that doesn't work with `allowed_outbound_hosts`. For example, you would write `fetch('http://self.alt/api')`.
237
+
235
238
In this way of doing self-requests, the request undergoes normal HTTP processing once Spin has prepended the host. For example, in a cloud deployment, the request passes through the network, and potentially back in through a load balancer or other gateway. The benefit of this is that it allows load to be distributed across the environment, but it may count against your use of bandwidth.
236
239
237
-
You must still grant permission by including `self` in `allowed_outbound_hosts`:
240
+
You must still grant permission by including `self`or `self.alt`in `allowed_outbound_hosts`:
-[Intra-Application Requests in JavaScript](#intra-application-requests-in-javascript)
14
15
-[Storing Data in Redis From JS/TS Components](#storing-data-in-redis-from-jsts-components)
15
16
-[Routing in a Component](#routing-in-a-component)
16
17
-[Storing Data in the Spin Key-Value Store](#storing-data-in-the-spin-key-value-store)
@@ -155,7 +156,7 @@ The important things to note in the implementation above:
155
156
156
157
## Sending Outbound HTTP Requests
157
158
158
-
If allowed, Spin components can send outbound HTTP requests.
159
+
If allowed, Spin components can send outbound HTTP requests using the `fetch` function.
159
160
Let's see an example of a component that makes a request to [an API that returns random animal facts](https://random-data-api.fermyon.app/animals/json)
160
161
161
162
```javascript
@@ -233,6 +234,19 @@ This can be the basis for building components that communicate with external
233
234
databases or storage accounts, or even more specialized components like HTTP
234
235
proxies or URL shorteners.
235
236
237
+
### Intra-Application Requests in JavaScript
238
+
239
+
JavaScript's `fetch` function handles relative URLs in a way that doesn't work well with Spin's fine-grained outbound HTTP permissions.
240
+
Therefore, when [making a request to another route within the same application](./http-outbound#intra-application-http-requests-by-route),
241
+
you must use the special pseudo-host `self.alt` rather than a relative route. For example:
242
+
243
+
```javascript
244
+
awaitfetch('/api'); // Avoid!
245
+
awaitfetch('http://self.alt/api'); // Prefer!
246
+
```
247
+
248
+
You must [add `http://self` or `http://self.alt` to the component's `allowed_outbound_hosts`](./http-outbound#intra-application-http-requests-by-route).
0 commit comments