refactor: update variable name

Author: eduardoboucas

README.md

@@ -95,8 +95,9 @@ Rather than explicitly passing the configuration context to the `getStore` metho
 environment. This is particularly useful for setups where the configuration data is held by one system and the data
 needs to be accessed in another system, with no direct communication between the two.
 
-To do this, the system that holds the configuration data should set an environment variable called `NETLIFY_BLOBS_1`
-with a Base64-encoded, JSON-stringified representation of an object with the following properties:
+To do this, the system that holds the configuration data should set an environment variable called
+`NETLIFY_BLOBS_CONTEXT` with a Base64-encoded, JSON-stringified representation of an object with the following
+properties:
 
 - `apiURL` (optional) or `edgeURL`: URL of the Netlify API (for [API access](#api-access)) or the edge endpoint (for
   [Edge access](#edge-access))

src/client.ts

@@ -9,7 +9,7 @@ import { BlobInput, HTTPMethod } from './types.ts'
 // of this object, we should bump the version and create a new variable, so
 // that the client knows how to consume the data and can advise the user to
 // update the client if needed.
-export const NETLIFY_CONTEXT_VARIABLE = 'NETLIFY_BLOBS_1'
+export const NETLIFY_CONTEXT_VARIABLE = 'NETLIFY_BLOBS_CONTEXT'
 
 export interface Context {
   apiURL?: string

src/main.test.ts

@@ -4,7 +4,7 @@ import { env, version as nodeVersion } from 'node:process'
 
 import semver from 'semver'
 import tmp from 'tmp-promise'
-import { describe, test, expect, beforeAll } from 'vitest'
+import { describe, test, expect, beforeAll, afterEach } from 'vitest'
 
 import { MockFetch } from '../test/mock_fetch.js'
 import { streamToString } from '../test/util.js'
@@ -26,8 +26,12 @@ beforeAll(async () => {
   }
 })
 
-const deployID = 'abcdef'
-const siteID = '12345'
+afterEach(() => {
+  delete env.NETLIFY_BLOBS_CONTEXT
+})
+
+const deployID = '6527dfab35be400008332a1d'
+const siteID = '9a003659-aaaa-0000-aaaa-63d3720d8621'
 const key = '54321'
 const complexKey = '/artista/canção'
 const value = 'some value'
@@ -191,7 +195,7 @@ describe('get', () => {
     })
   })
 
-  describe('With context credentials', () => {
+  describe('With edge credentials', () => {
     test('Reads from the blob store', async () => {
       const mockStore = new MockFetch()
         .get({
@@ -265,6 +269,53 @@ describe('get', () => {
 
       expect(mockStore.fulfilled).toBeTruthy()
     })
+
+    test('Loads credentials from the environment', async () => {
+      const tokens = ['some-token-1', 'another-token-2']
+      const mockStore = new MockFetch()
+        .get({
+          headers: { authorization: `Bearer ${tokens[0]}` },
+          response: new Response(value),
+          url: `${edgeURL}/${siteID}/images/${key}`,
+        })
+        .get({
+          headers: { authorization: `Bearer ${tokens[0]}` },
+          response: new Response(value),
+          url: `${edgeURL}/${siteID}/images/${key}`,
+        })
+        .get({
+          headers: { authorization: `Bearer ${tokens[1]}` },
+          response: new Response(value),
+          url: `${edgeURL}/${siteID}/images/${key}`,
+        })
+        .get({
+          headers: { authorization: `Bearer ${tokens[1]}` },
+          response: new Response(value),
+          url: `${edgeURL}/${siteID}/images/${key}`,
+        })
+
+      globalThis.fetch = mockStore.fetcher
+
+      for (let index = 0; index <= 1; index++) {
+        const context = {
+          edgeURL,
+          siteID,
+          token: tokens[index],
+        }
+
+        env.NETLIFY_BLOBS_CONTEXT = Buffer.from(JSON.stringify(context)).toString('base64')
+
+        const store = getStore('images')
+
+        const string = await store.get(key)
+        expect(string).toBe(value)
+
+        const stream = await store.get(key, { type: 'stream' })
+        expect(await streamToString(stream as unknown as NodeJS.ReadableStream)).toBe(value)
+      }
+
+      expect(mockStore.fulfilled).toBeTruthy()
+    })
   })
 
   test('Throws when the instance is missing required configuration properties', async () => {
@@ -560,7 +611,7 @@ describe('set', () => {
     })
   })
 
-  describe('With context credentials', () => {
+  describe('With edge credentials', () => {
     test('Writes to the blob store', async () => {
       const mockStore = new MockFetch()
         .put({
@@ -712,7 +763,7 @@ describe('setJSON', () => {
     })
   })
 
-  describe('With context credentials', () => {
+  describe('With edge credentials', () => {
     test('Writes to the blob store', async () => {
       const mockStore = new MockFetch().put({
         body: JSON.stringify({ value }),
@@ -829,7 +880,7 @@ describe('delete', () => {
     })
   })
 
-  describe('With context credentials', () => {
+  describe('With edge credentials', () => {
     test('Deletes from the blob store', async () => {
       const mockStore = new MockFetch().delete({
         headers: { authorization: `Bearer ${edgeToken}` },
@@ -898,51 +949,56 @@ describe('delete', () => {
   })
 })
 
-describe('Global client', () => {
-  test('Reads from the blob store', async () => {
-    const tokens = ['some-token-1', 'another-token-2']
+describe.only('Deploy scope', () => {
+  test('Returns a deploy-scoped store if the `deployID` parameter is supplied', async () => {
+    const mockToken = 'some-token'
     const mockStore = new MockFetch()
       .get({
-        headers: { authorization: `Bearer ${tokens[0]}` },
+        headers: { authorization: `Bearer ${mockToken}` },
         response: new Response(value),
         url: `${edgeURL}/${siteID}/images/${key}`,
       })
       .get({
-        headers: { authorization: `Bearer ${tokens[0]}` },
+        headers: { authorization: `Bearer ${mockToken}` },
         response: new Response(value),
         url: `${edgeURL}/${siteID}/images/${key}`,
       })
       .get({
-        headers: { authorization: `Bearer ${tokens[1]}` },
+        headers: { authorization: `Bearer ${mockToken}` },
         response: new Response(value),
-        url: `${edgeURL}/${siteID}/images/${key}`,
+        url: `${edgeURL}/${siteID}/${deployID}/${key}`,
       })
       .get({
-        headers: { authorization: `Bearer ${tokens[1]}` },
+        headers: { authorization: `Bearer ${mockToken}` },
         response: new Response(value),
-        url: `${edgeURL}/${siteID}/images/${key}`,
+        url: `${edgeURL}/${siteID}/${deployID}/${key}`,
       })
 
     globalThis.fetch = mockStore.fetcher
 
-    for (let index = 0; index <= 1; index++) {
-      const context = {
-        edgeURL,
-        deployID,
-        siteID,
-        token: tokens[index],
-      }
+    const context = {
+      edgeURL,
+      siteID,
+      token: mockToken,
+    }
 
-      env.NETLIFY_BLOBS_1 = Buffer.from(JSON.stringify(context)).toString('base64')
+    env.NETLIFY_BLOBS_CONTEXT = Buffer.from(JSON.stringify(context)).toString('base64')
 
-      const store = getStore('images')
+    const siteStore = getStore('images')
 
-      const string = await store.get(key)
-      expect(string).toBe(value)
+    const string1 = await siteStore.get(key)
+    expect(string1).toBe(value)
 
-      const stream = await store.get(key, { type: 'stream' })
-      expect(await streamToString(stream as unknown as NodeJS.ReadableStream)).toBe(value)
-    }
+    const stream1 = await siteStore.get(key, { type: 'stream' })
+    expect(await streamToString(stream1 as unknown as NodeJS.ReadableStream)).toBe(value)
+
+    const deployStore = getStore({ deployID })
+
+    const string2 = await deployStore.get(key)
+    expect(string2).toBe(value)
+
+    const stream2 = await deployStore.get(key, { type: 'stream' })
+    expect(await streamToString(stream2 as unknown as NodeJS.ReadableStream)).toBe(value)
 
     expect(mockStore.fulfilled).toBeTruthy()
   })

src/store.ts

@@ -179,7 +179,7 @@ interface GetNamedStoreOptions extends Context {
 
 export const getStore: {
   (name: string): Store
-  (options: GetDeployStoreOptions | GetNamedStoreOptions): Store
+  (options: GetDeployStoreOptions | GetNamedStoreOptions | { deployID: string }): Store
 } = (input) => {
   if (typeof input === 'string') {
     const client = new Client()
@@ -188,7 +188,8 @@ export const getStore: {
   }
 
   if ('deployID' in input) {
-    const { deployID, ...context } = input
+    const { deployID, ...otherProps } = input
+    const context = 'siteID' in otherProps && 'token' in otherProps ? otherProps : undefined
     const client = new Client(context)
 
     return new Store({ client, name: deployID })