Skip to content

feat: support named deploy-scoped stores #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 1, 2024
Merged

feat: support named deploy-scoped stores #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f74334
feat: support named deploy-scoped stores
eduardoboucas Jul 1, 2024
b54810f
chore: fix test names
eduardoboucas Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions src/main.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1384,6 +1384,80 @@ describe('Deploy scope', () => {
expect(mockStore.fulfilled).toBeTruthy()
})

test('Returns a named deploy-scoped store if `getDeployStore` receives a string parameter', async () => {
const mockToken = 'some-token'
const mockStoreName = 'my-store'
const mockStore = new MockFetch()
.get({
headers: { authorization: `Bearer ${mockToken}` },
response: new Response(value),
url: `${edgeURL}/${siteID}/deploy:${deployID}:${mockStoreName}/${key}`,
})
.get({
headers: { authorization: `Bearer ${mockToken}` },
response: new Response(value),
url: `${edgeURL}/${siteID}/deploy:${deployID}:${mockStoreName}/${key}`,
})

globalThis.fetch = mockStore.fetch

const context = {
deployID,
edgeURL,
siteID,
token: mockToken,
}

env.NETLIFY_BLOBS_CONTEXT = Buffer.from(JSON.stringify(context)).toString('base64')

const deployStore = getDeployStore(mockStoreName)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are these 2 test names switched?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What?! The idea that I would do such a silly mistake is ludicrous.

(Yes. Yes, they were. b54810f)


const string = await deployStore.get(key)
expect(string).toBe(value)

const stream = await deployStore.get(key, { type: 'stream' })
expect(await streamToString(stream as unknown as NodeJS.ReadableStream)).toBe(value)

expect(mockStore.fulfilled).toBeTruthy()
})

test('Returns a named deploy-scoped store if `getDeployStore` receives an object with a `name` property', async () => {
const mockToken = 'some-token'
const mockStoreName = 'my-store'
const mockStore = new MockFetch()
.get({
headers: { authorization: `Bearer ${mockToken}` },
response: new Response(value),
url: `${edgeURL}/${siteID}/deploy:${deployID}:${mockStoreName}/${key}`,
})
.get({
headers: { authorization: `Bearer ${mockToken}` },
response: new Response(value),
url: `${edgeURL}/${siteID}/deploy:${deployID}:${mockStoreName}/${key}`,
})

globalThis.fetch = mockStore.fetch

const context = {
deployID,
edgeURL,
siteID,
token: mockToken,
}

env.NETLIFY_BLOBS_CONTEXT = Buffer.from(JSON.stringify(context)).toString('base64')

const deployStore = getDeployStore({ name: mockStoreName })

const string = await deployStore.get(key)
expect(string).toBe(value)

const stream = await deployStore.get(key, { type: 'stream' })
expect(await streamToString(stream as unknown as NodeJS.ReadableStream)).toBe(value)

expect(mockStore.fulfilled).toBeTruthy()
})

test('Throws if the deploy ID fails validation', async () => {
const mockToken = 'some-token'
const mockStore = new MockFetch()
Expand Down
9 changes: 8 additions & 1 deletion src/store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ interface BaseStoreOptions {

interface DeployStoreOptions extends BaseStoreOptions {
deployID: string
name?: string
}

interface NamedStoreOptions extends BaseStoreOptions {
Expand Down Expand Up @@ -74,7 +75,13 @@ export class Store {
if ('deployID' in options) {
Store.validateDeployID(options.deployID)

this.name = DEPLOY_STORE_PREFIX + options.deployID
let name = DEPLOY_STORE_PREFIX + options.deployID

if (options.name) {
name += `:${options.name}`
}

this.name = name
} else if (options.name.startsWith(LEGACY_STORE_INTERNAL_PREFIX)) {
const storeName = options.name.slice(LEGACY_STORE_INTERNAL_PREFIX.length)

Expand Down
6 changes: 4 additions & 2 deletions src/store_factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,16 @@ type ExperimentalRegion =

interface GetDeployStoreOptions extends Partial<ClientOptions> {
deployID?: string
name?: string
experimentalRegion?: ExperimentalRegion
}

/**
* Gets a reference to a deploy-scoped store.
*/
export const getDeployStore = (options: GetDeployStoreOptions = {}): Store => {
export const getDeployStore = (input: GetDeployStoreOptions | string = {}): Store => {
const context = getEnvironmentContext()
const options = typeof input === 'string' ? { name: input } : input
const deployID = options.deployID ?? context.deployID

if (!deployID) {
Expand Down Expand Up @@ -47,7 +49,7 @@ export const getDeployStore = (options: GetDeployStoreOptions = {}): Store => {

const client = new Client(clientOptions)

return new Store({ client, deployID })
return new Store({ client, deployID, name: options.name })
}

interface GetStoreOptions extends Partial<ClientOptions> {
Expand Down
Loading