fix: couple of small fixes (#72)

Author: eduardoboucas

src/main.test.ts

@@ -916,19 +916,9 @@ describe('delete', () => {
 })
 
 describe('Deploy scope', () => {
-  test('Returns a deploy-scoped store if the `deployID` parameter is supplied', async () => {
+  test('Returns a deploy-scoped store if the `deployID` parameter is supplied and the environment context is present', async () => {
     const mockToken = 'some-token'
     const mockStore = new MockFetch()
-      .get({
-        headers: { authorization: `Bearer ${mockToken}` },
-        response: new Response(value),
-        url: `${edgeURL}/${siteID}/images/${key}`,
-      })
-      .get({
-        headers: { authorization: `Bearer ${mockToken}` },
-        response: new Response(value),
-        url: `${edgeURL}/${siteID}/images/${key}`,
-      })
       .get({
         headers: { authorization: `Bearer ${mockToken}` },
         response: new Response(value),
@@ -950,26 +940,52 @@ describe('Deploy scope', () => {
 
     env.NETLIFY_BLOBS_CONTEXT = Buffer.from(JSON.stringify(context)).toString('base64')
 
-    const siteStore = getStore('images')
+    const deployStore = getStore({ deployID })
 
-    const string1 = await siteStore.get(key)
-    expect(string1).toBe(value)
+    const string = await deployStore.get(key)
+    expect(string).toBe(value)
 
-    const stream1 = await siteStore.get(key, { type: 'stream' })
-    expect(await streamToString(stream1 as unknown as NodeJS.ReadableStream)).toBe(value)
+    const stream = await deployStore.get(key, { type: 'stream' })
+    expect(await streamToString(stream as unknown as NodeJS.ReadableStream)).toBe(value)
 
-    const deployStore = getStore({ deployID })
+    expect(mockStore.fulfilled).toBeTruthy()
+  })
+
+  test('Returns a deploy-scoped store if the `deployID` parameter is supplied and the environment context is not present', async () => {
+    const mockStore = new MockFetch()
+      .get({
+        headers: { authorization: `Bearer ${apiToken}` },
+        response: new Response(JSON.stringify({ url: signedURL })),
+        url: `https://api.netlify.com/api/v1/sites/${siteID}/blobs/${key}?context=deploy:${deployID}`,
+      })
+      .get({
+        response: new Response(value),
+        url: signedURL,
+      })
+      .get({
+        headers: { authorization: `Bearer ${apiToken}` },
+        response: new Response(JSON.stringify({ url: signedURL })),
+        url: `https://api.netlify.com/api/v1/sites/${siteID}/blobs/${key}?context=deploy:${deployID}`,
+      })
+      .get({
+        response: new Response(value),
+        url: signedURL,
+      })
+
+    globalThis.fetch = mockStore.fetch
 
-    const string2 = await deployStore.get(key)
-    expect(string2).toBe(value)
+    const deployStore = getStore({ deployID, siteID, token: apiToken })
 
-    const stream2 = await deployStore.get(key, { type: 'stream' })
-    expect(await streamToString(stream2 as unknown as NodeJS.ReadableStream)).toBe(value)
+    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 deploy-scoped store if the `getDeployStore` method is called', async () => {
+  test('Returns a deploy-scoped store if the `getDeployStore` method is called and the environment context is present', async () => {
     const mockToken = 'some-token'
     const mockStore = new MockFetch()
       .get({
@@ -1004,6 +1020,40 @@ describe('Deploy scope', () => {
 
     expect(mockStore.fulfilled).toBeTruthy()
   })
+
+  test('Returns a deploy-scoped store if the `getDeployStore` method is called and the environment context is not present', async () => {
+    const mockStore = new MockFetch()
+      .get({
+        headers: { authorization: `Bearer ${apiToken}` },
+        response: new Response(JSON.stringify({ url: signedURL })),
+        url: `https://api.netlify.com/api/v1/sites/${siteID}/blobs/${key}?context=deploy:${deployID}`,
+      })
+      .get({
+        response: new Response(value),
+        url: signedURL,
+      })
+      .get({
+        headers: { authorization: `Bearer ${apiToken}` },
+        response: new Response(JSON.stringify({ url: signedURL })),
+        url: `https://api.netlify.com/api/v1/sites/${siteID}/blobs/${key}?context=deploy:${deployID}`,
+      })
+      .get({
+        response: new Response(value),
+        url: signedURL,
+      })
+
+    globalThis.fetch = mockStore.fetch
+
+    const deployStore = getDeployStore({ deployID, siteID, token: apiToken })
+
+    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()
+  })
 })
 
 describe('Custom `fetch`', () => {
@@ -1050,4 +1100,24 @@ describe(`getStore`, () => {
       }),
     ).toThrowError(MissingBlobsEnvironmentError)
   })
+
+  test('Throws when the name of the store is not provided', async () => {
+    const { fetch } = new MockFetch()
+
+    globalThis.fetch = fetch
+
+    // @ts-expect-error Ignoring types, which expect an argument
+    expect(() => getStore()).toThrowError(
+      'The `getStore` method requires the name of the store as a string or as the `name` property of an options object',
+    )
+
+    expect(() =>
+      getStore({
+        token: apiToken,
+        siteID,
+      }),
+    ).toThrowError(
+      'The `getStore` method requires the name of the store as a string or as the `name` property of an options object',
+    )
+  })
 })

src/store_factory.ts

@@ -2,12 +2,16 @@ import { Client, ClientOptions, getClientOptions } from './client.ts'
 import { getEnvironmentContext, MissingBlobsEnvironmentError } from './environment.ts'
 import { Store } from './store.ts'
 
+interface GetDeployStoreOptions extends Partial<ClientOptions> {
+  deployID?: string
+}
+
 /**
  * Gets a reference to a deploy-scoped store.
  */
-export const getDeployStore = (options: Partial<ClientOptions> = {}): Store => {
+export const getDeployStore = (options: GetDeployStoreOptions = {}): Store => {
   const context = getEnvironmentContext()
-  const { deployID } = context
+  const deployID = options.deployID ?? context.deployID
 
   if (!deployID) {
     throw new MissingBlobsEnvironmentError(['deployID'])
@@ -40,7 +44,7 @@ export const getStore: {
     return new Store({ client, name: input })
   }
 
-  if (typeof input.name === 'string') {
+  if (typeof input?.name === 'string') {
     const { name } = input
     const clientOptions = getClientOptions(input)
 
@@ -53,7 +57,7 @@ export const getStore: {
     return new Store({ client, name })
   }
 
-  if (typeof input.deployID === 'string') {
+  if (typeof input?.deployID === 'string') {
     const clientOptions = getClientOptions(input)
     const { deployID } = input
 
@@ -66,5 +70,7 @@ export const getStore: {
     return new Store({ client, deployID })
   }
 
-  throw new Error('`getStore()` requires a `name` or `siteID` properties.')
+  throw new Error(
+    'The `getStore` method requires the name of the store as a string or as the `name` property of an options object',
+  )
 }