Skip to content

Commit 6734751

Browse files
eduardoboucaseduardoboucas
authored
feat: add experimental support for region selection (#158)
1 parent c599473 commit 6734751

File tree

4 files changed

+225
-4
lines changed

4 files changed

+225
-4
lines changed

‎src/client.ts‎

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ export interface ClientOptions {
2727
uncachedEdgeURL?: string
2828
}
2929

30+
interface InternalClientOptions extends ClientOptions {
31+
region?: string
32+
}
33+
3034
interface GetFinalRequestOptions {
3135
consistency?: ConsistencyMode
3236
key: string | undefined
@@ -41,15 +45,17 @@ export class Client {
4145
private consistency: ConsistencyMode
4246
private edgeURL?: string
4347
private fetch: Fetcher
48+
private region?: string
4449
private siteID: string
4550
private token: string
4651
private uncachedEdgeURL?: string
4752

48-
constructor({ apiURL, consistency, edgeURL, fetch, siteID, token, uncachedEdgeURL }: ClientOptions) {
53+
constructor({ apiURL, consistency, edgeURL, fetch, region, siteID, token, uncachedEdgeURL }: InternalClientOptions) {
4954
this.apiURL = apiURL
5055
this.consistency = consistency ?? 'eventual'
5156
this.edgeURL = edgeURL
5257
this.fetch = fetch ?? globalThis.fetch
58+
this.region = region
5359
this.siteID = siteID
5460
this.token = token
5561
this.uncachedEdgeURL = uncachedEdgeURL
@@ -95,6 +101,10 @@ export class Client {
95101
headers[METADATA_HEADER_INTERNAL] = encodedMetadata
96102
}
97103

104+
if (this.region) {
105+
urlPath = `/region:${this.region}${urlPath}`
106+
}
107+
98108
const url = new URL(urlPath, consistency === 'strong' ? this.uncachedEdgeURL : this.edgeURL)
99109

100110
for (const key in parameters) {
@@ -114,6 +124,10 @@ export class Client {
114124
url.searchParams.set(key, parameters[key])
115125
}
116126

127+
if (this.region) {
128+
url.searchParams.set('region', this.region)
129+
}
130+
117131
// If there is no store name, we're listing stores. If there's no key,
118132
// we're listing blobs. Both operations are implemented directly in the
119133
// Netlify API.
@@ -205,9 +219,9 @@ export class Client {
205219
* @param contextOverride Context to be used instead of the environment object
206220
*/
207221
export const getClientOptions = (
208-
options: Partial<ClientOptions>,
222+
options: Partial<InternalClientOptions>,
209223
contextOverride?: EnvironmentContext,
210-
): ClientOptions => {
224+
): InternalClientOptions => {
211225
const context = contextOverride ?? getEnvironmentContext()
212226
const siteID = context.siteID ?? options.siteID
213227
const token = context.token ?? options.token
@@ -216,11 +230,12 @@ export const getClientOptions = (
216230
throw new MissingBlobsEnvironmentError(['siteID', 'token'])
217231
}
218232

219-
const clientOptions = {
233+
const clientOptions: InternalClientOptions = {
220234
apiURL: context.apiURL ?? options.apiURL,
221235
consistency: options.consistency,
222236
edgeURL: context.edgeURL ?? options.edgeURL,
223237
fetch: options.fetch,
238+
region: options.region,
224239
siteID,
225240
token,
226241
uncachedEdgeURL: context.uncachedEdgeURL ?? options.uncachedEdgeURL,

‎src/environment.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ export interface EnvironmentContext {
5858
apiURL?: string
5959
deployID?: string
6060
edgeURL?: string
61+
primaryRegion?: string
6162
siteID?: string
6263
token?: string
6364
uncachedEdgeURL?: string

‎src/main.test.ts‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1522,3 +1522,181 @@ describe(`getStore`, () => {
15221522
)
15231523
})
15241524
})
1525+
1526+
describe('Region configuration', () => {
1527+
describe('With `experimentalRegion: "auto"`', () => {
1528+
test('The client sends a `region=auto` parameter to API calls', async () => {
1529+
const mockStore = new MockFetch()
1530+
.get({
1531+
headers: { authorization: `Bearer ${apiToken}` },
1532+
response: new Response(JSON.stringify({ url: signedURL })),
1533+
url: `https://api.netlify.com/api/v1/blobs/${siteID}/deploy:${deployID}/${key}?region=auto`,
1534+
})
1535+
.get({
1536+
response: new Response(value),
1537+
url: signedURL,
1538+
})
1539+
.get({
1540+
headers: { authorization: `Bearer ${apiToken}` },
1541+
response: new Response(JSON.stringify({ url: signedURL })),
1542+
url: `https://api.netlify.com/api/v1/blobs/${siteID}/deploy:${deployID}/${key}?region=auto`,
1543+
})
1544+
.get({
1545+
response: new Response(value),
1546+
url: signedURL,
1547+
})
1548+
1549+
globalThis.fetch = mockStore.fetch
1550+
1551+
const deployStore = getDeployStore({ deployID, siteID, token: apiToken, experimentalRegion: 'auto' })
1552+
1553+
const string = await deployStore.get(key)
1554+
expect(string).toBe(value)
1555+
1556+
const stream = await deployStore.get(key, { type: 'stream' })
1557+
expect(await streamToString(stream as unknown as NodeJS.ReadableStream)).toBe(value)
1558+
1559+
expect(mockStore.fulfilled).toBeTruthy()
1560+
})
1561+
1562+
test('Throws when used with `edgeURL`', async () => {
1563+
const mockRegion = 'us-east-2'
1564+
const mockToken = 'some-token'
1565+
const mockStore = new MockFetch()
1566+
.get({
1567+
headers: { authorization: `Bearer ${mockToken}` },
1568+
response: new Response(value),
1569+
url: `${edgeURL}/region:${mockRegion}/${siteID}/deploy:${deployID}/${key}`,
1570+
})
1571+
.get({
1572+
headers: { authorization: `Bearer ${mockToken}` },
1573+
response: new Response(value),
1574+
url: `${edgeURL}/region:${mockRegion}/${siteID}/deploy:${deployID}/${key}`,
1575+
})
1576+
1577+
globalThis.fetch = mockStore.fetch
1578+
1579+
expect(() =>
1580+
getDeployStore({ deployID, edgeURL, siteID, token: mockToken, experimentalRegion: 'auto' }),
1581+
).toThrowError()
1582+
expect(mockStore.fulfilled).toBeFalsy()
1583+
})
1584+
})
1585+
1586+
describe('With `experimentalRegion: "context"`', () => {
1587+
test('Adds a `region` parameter to API calls with the value set in the context', async () => {
1588+
const mockStore = new MockFetch()
1589+
.get({
1590+
headers: { authorization: `Bearer ${apiToken}` },
1591+
response: new Response(JSON.stringify({ url: signedURL })),
1592+
url: `https://api.netlify.com/api/v1/blobs/${siteID}/deploy:${deployID}/${key}?region=us-east-1`,
1593+
})
1594+
.get({
1595+
response: new Response(value),
1596+
url: signedURL,
1597+
})
1598+
.get({
1599+
headers: { authorization: `Bearer ${apiToken}` },
1600+
response: new Response(JSON.stringify({ url: signedURL })),
1601+
url: `https://api.netlify.com/api/v1/blobs/${siteID}/deploy:${deployID}/${key}?region=us-east-1`,
1602+
})
1603+
.get({
1604+
response: new Response(value),
1605+
url: signedURL,
1606+
})
1607+
1608+
const context = {
1609+
deployID,
1610+
siteID,
1611+
primaryRegion: 'us-east-1',
1612+
token: apiToken,
1613+
}
1614+
1615+
env.NETLIFY_BLOBS_CONTEXT = Buffer.from(JSON.stringify(context)).toString('base64')
1616+
1617+
globalThis.fetch = mockStore.fetch
1618+
1619+
const deployStore = getDeployStore({ experimentalRegion: 'context' })
1620+
1621+
const string = await deployStore.get(key)
1622+
expect(string).toBe(value)
1623+
1624+
const stream = await deployStore.get(key, { type: 'stream' })
1625+
expect(await streamToString(stream as unknown as NodeJS.ReadableStream)).toBe(value)
1626+
1627+
expect(mockStore.fulfilled).toBeTruthy()
1628+
})
1629+
1630+
test('Adds a `region:` segment to the edge URL path with the value set in the context', async () => {
1631+
const mockRegion = 'us-east-2'
1632+
const mockToken = 'some-token'
1633+
const mockStore = new MockFetch()
1634+
.get({
1635+
headers: { authorization: `Bearer ${mockToken}` },
1636+
response: new Response(value),
1637+
url: `${edgeURL}/region:${mockRegion}/${siteID}/deploy:${deployID}/${key}`,
1638+
})
1639+
.get({
1640+
headers: { authorization: `Bearer ${mockToken}` },
1641+
response: new Response(value),
1642+
url: `${edgeURL}/region:${mockRegion}/${siteID}/deploy:${deployID}/${key}`,
1643+
})
1644+
1645+
globalThis.fetch = mockStore.fetch
1646+
1647+
const context = {
1648+
deployID,
1649+
edgeURL,
1650+
primaryRegion: mockRegion,
1651+
siteID,
1652+
token: mockToken,
1653+
}
1654+
1655+
env.NETLIFY_BLOBS_CONTEXT = Buffer.from(JSON.stringify(context)).toString('base64')
1656+
1657+
globalThis.fetch = mockStore.fetch
1658+
1659+
const deployStore = getDeployStore({ experimentalRegion: 'context' })
1660+
1661+
const string = await deployStore.get(key)
1662+
expect(string).toBe(value)
1663+
1664+
const stream = await deployStore.get(key, { type: 'stream' })
1665+
expect(await streamToString(stream as unknown as NodeJS.ReadableStream)).toBe(value)
1666+
1667+
expect(mockStore.fulfilled).toBeTruthy()
1668+
})
1669+
1670+
test('Throws an error when there is no region set in the context', async () => {
1671+
const mockRegion = 'us-east-2'
1672+
const mockToken = 'some-token'
1673+
const mockStore = new MockFetch()
1674+
.get({
1675+
headers: { authorization: `Bearer ${mockToken}` },
1676+
response: new Response(value),
1677+
url: `${edgeURL}/region:${mockRegion}/${siteID}/deploy:${deployID}/${key}`,
1678+
})
1679+
.get({
1680+
headers: { authorization: `Bearer ${mockToken}` },
1681+
response: new Response(value),
1682+
url: `${edgeURL}/region:${mockRegion}/${siteID}/deploy:${deployID}/${key}`,
1683+
})
1684+
1685+
globalThis.fetch = mockStore.fetch
1686+
1687+
const context = {
1688+
deployID,
1689+
edgeURL,
1690+
siteID,
1691+
token: mockToken,
1692+
}
1693+
1694+
env.NETLIFY_BLOBS_CONTEXT = Buffer.from(JSON.stringify(context)).toString('base64')
1695+
1696+
globalThis.fetch = mockStore.fetch
1697+
1698+
expect(() => getDeployStore({ experimentalRegion: 'context' })).toThrowError()
1699+
expect(mockStore.fulfilled).toBeFalsy()
1700+
})
1701+
})
1702+
})

‎src/store_factory.ts‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,16 @@ import { Client, ClientOptions, getClientOptions } from './client.ts'
22
import { getEnvironmentContext, MissingBlobsEnvironmentError } from './environment.ts'
33
import { Store } from './store.ts'
44

5+
type ExperimentalRegion =
6+
// Sets "region=auto", which is supported by our API in deploy stores.
7+
| 'auto'
8+
9+
// Loads the region from the environment context and throws if not found.
10+
| 'context'
11+
512
interface GetDeployStoreOptions extends Partial<ClientOptions> {
613
deployID?: string
14+
experimentalRegion?: ExperimentalRegion
715
}
816

917
/**
@@ -18,6 +26,25 @@ export const getDeployStore = (options: GetDeployStoreOptions = {}): Store => {
1826
}
1927

2028
const clientOptions = getClientOptions(options, context)
29+
30+
if (options.experimentalRegion === 'context') {
31+
if (!context.primaryRegion) {
32+
throw new Error(
33+
'The Netlify Blobs client was initialized with `experimentalRegion: "context"` but there is no region configured in the environment',
34+
)
35+
}
36+
37+
clientOptions.region = context.primaryRegion
38+
} else if (options.experimentalRegion === 'auto') {
39+
if (clientOptions.edgeURL) {
40+
throw new Error(
41+
'The Netlify Blobs client was initialized with `experimentalRegion: "auto"` which is not compatible with the `edgeURL` property; consider using `apiURL` instead',
42+
)
43+
}
44+
45+
clientOptions.region = options.experimentalRegion
46+
}
47+
2148
const client = new Client(clientOptions)
2249

2350
return new Store({ client, deployID })

0 commit comments

Comments
 (0)