Deploy service #232

purplecabbage · 2026-01-17T03:40:46Z

Description

Switch to calling our own deploy-service instead of S3 directly

Related Issue

ACNA-3810
cdn-next milestone 4

Motivation and Context

Major version of CLI to deploy using CDN Deploy Service
Remove dependency on tvm for getting short lived credentials
Use ims auth so deploys are tied to a user and not just a namespace
remove aws-sdk dependencies

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

This reverts commit 27e548c.

codecov · 2026-01-20T08:18:02Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copilot

Pull request overview

This pull request migrates from direct AWS S3 access to a deployment service API, representing a significant architectural change in how static web files are deployed and managed.

Changes:

Replaced AWS S3 SDK with fetch-based HTTP API calls to a new deployment service
Removed TVM (Token Vending Machine) credential management in favor of direct auth token usage via auth_handler
Updated all deployment and undeployment logic to use the new API endpoints

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 23 comments.

Show a summary per file

File	Description
lib/remote-storage.js	Complete rewrite from S3 SDK to fetch-based HTTP API; removed proxy and credential handling, added new deployment service URL selection
lib/getS3Creds.js	Deleted - credential fetching no longer needed with new auth approach
src/deploy-web.js	Updated to use auth_handler.getAuthHeader() instead of S3 credentials; removed folder existence check and cleanup logic
src/undeploy-web.js	Updated to use auth_handler.getAuthHeader() instead of S3 credentials; changed to use '/' prefix for API calls
test/lib/remote-storage.test.js	Completely rewritten to test new HTTP API instead of S3 SDK; added environment URL selection tests
test/lib/getS3Creds.test.js	Deleted - tests for removed functionality
test/src/deploy-web.test.js	Updated all tests to mock new auth approach and removed S3-specific test scenarios
test/src/undeploy-web.test.js	Updated all tests to mock new auth approach and verify new API call patterns
test/jest.setup.js	Added new test fixtures for auth tokens and namespace configuration
package.json	Replaced @aws-sdk/client-s3 with @adobe/aio-lib-env

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-23T03:49:41Z

lib/remote-storage.js

-        httpsAgent: agent
-      })
+    // Call the list files endpoint (GET /files) - there is no GET /files/:key route
+    const response = await fetch(`${deploymentServiceUrl}/cdn-api/namespaces/${appConfig.ow.namespace}/files`, {


The URL construction on line 54 directly interpolates appConfig.ow.namespace into the URL without any validation or sanitization. If the namespace contains special characters, spaces, or URL-unsafe characters, this could result in malformed URLs. Consider using encodeURIComponent(appConfig.ow.namespace) to properly encode the namespace for use in the URL path.

Suggested change

const response = await fetch(`${deploymentServiceUrl}/cdn-api/namespaces/${appConfig.ow.namespace}/files`, {

const response = await fetch(`${deploymentServiceUrl}/cdn-api/namespaces/${encodeURIComponent(appConfig.ow.namespace)}/files`, {

Copilot · 2026-01-23T03:49:42Z

lib/remote-storage.js

+    // file.name is the path relative to namespace (e.g., 'images/photo.jpg' or 'index.html')
+    // The server will prepend the namespace to create the S3 key: ${namespace}/${file.name}
+    const fileName = path.basename(file)
+    let relativeFilePath = filePath.replace(appConfig.ow.namespace, '')


The logic for constructing relativeFilePath on line 130 appears incorrect. The code replaces appConfig.ow.namespace from filePath, but filePath is the path prefix (like 'somefolder' from config.s3.folder) and is unlikely to contain the namespace. This replacement logic seems misplaced and could cause issues if the namespace string happens to match part of the file path. The purpose of this line is unclear and should be reviewed - it may be attempting to handle a case that doesn't actually occur in practice.

Suggested change

let relativeFilePath = filePath.replace(appConfig.ow.namespace, '')

let relativeFilePath = filePath

Copilot · 2026-01-23T03:49:42Z

lib/remote-storage.js

+    if (typeof prefix !== 'string') {
+      throw new Error('prefix must be a valid string')
    }


The folderExists method comment on line 42 states that the prefix parameter is "unused, kept for API compatibility". However, the parameter is validated as a string on lines 47-49 and would throw an error if undefined. This is inconsistent - if the parameter is truly unused, the validation should be removed, or the comment should be updated to reflect its actual usage. Based on the implementation, it appears the prefix is indeed unused for the actual API call (line 54 doesn't use it), so the validation should probably be removed to match the stated intent.

Suggested change

if (typeof prefix !== 'string') {

throw new Error('prefix must be a valid string')

}

Copilot · 2026-01-23T03:49:42Z

package.json

+    "@adobe/aio-lib-env": "^3.0.1",
    "@smithy/node-http-handler": "^4.0.2",


The AWS SDK dependency @aws-sdk/client-s3 has been removed from package.json (line 35 in the diff), but @smithy/node-http-handler (line 36) and proxy-agent (line 44) remain as dependencies. These packages were used for proxy support with the AWS SDK and are no longer needed with the fetch-based implementation. They should be removed to avoid unnecessary dependencies.

Copilot · 2026-01-23T03:49:42Z

lib/remote-storage.js

+    if (!response.ok) {
+      return false
    }


The folderExists method returns false when the fetch request fails (lines 60-62), which masks potential errors. A network error, authentication failure, or server error would all be interpreted as "folder doesn't exist". This could mislead users about the actual problem. Consider throwing an error for non-404 status codes or logging the error details, so that genuine errors aren't silently treated as "folder doesn't exist".

Suggested change

if (!response.ok) {

return false

}

// 404 means the namespace/folder does not exist -> return false

if (response.status === 404) {

return false

}

// Other non-OK responses indicate an actual error and should not be

// silently treated as "folder doesn't exist"

if (!response.ok) {

throw new Error(`Failed to check if folder exists (status ${response.status} ${response.statusText})`)

}

Copilot · 2026-01-23T03:49:46Z

lib/remote-storage.js

-    if (listedObjects.IsTruncated) {
-      await this.emptyFolder(prefix)
-    }
+    return response.ok


The emptyFolder method returns false when the delete request fails (line 94), silently swallowing any errors. This makes it difficult to diagnose issues - a network error, authentication failure, or server error would all just return false with no indication of what went wrong. Consider throwing an error with details about the failure, or at minimum logging the error information before returning false.

Suggested change

return response.ok

if (!response.ok) {

let errorDetails = ''

try {

const bodyText = await response.text()

if (bodyText) {

errorDetails = ` Response body: ${bodyText}`

}

} catch (e) {

// ignore errors while reading response body; we still have status information

}

const message = `Failed to empty folder at '${url}'. Status: ${response.status} ${response.statusText}.${errorDetails}`

logAndThrow(codes.STORAGE_ERROR, message)

}

return true

Copilot · 2026-01-23T03:49:46Z

test/lib/remote-storage.test.js

-      }
+      })
+
+      await rs.uploadFile('fakeDir/index.js', 'fakeprefix', newConfig, fakeDistRoot, global.fakeAuthToken)


The test calls uploadFile with a fifth authToken parameter that shouldn't exist. This parameter is unused and redundant since RemoteStorage already has the auth token as an instance variable (passed to constructor on line 669). This test should call uploadFile without the auth token parameter: await rs.uploadFile('fakeDir/index.js', 'fakeprefix', newConfig, fakeDistRoot)

Copilot · 2026-01-23T03:49:46Z

test/lib/remote-storage.test.js

+        }
+      })
+
+      await rs.uploadFile(filePath, 'fakeprefix', newConfig, fakeDistRoot, global.fakeAuthToken)


The test calls uploadFile with a fifth authToken parameter that shouldn't exist. This parameter is unused and redundant since RemoteStorage already has the auth token as an instance variable. This test should call uploadFile without the auth token parameter: await rs.uploadFile(filePath, 'fakeprefix', newConfig, fakeDistRoot)

Copilot · 2026-01-23T03:49:46Z

test/lib/remote-storage.test.js

+      const appConfig = createAppConfig()
+      delete appConfig.web // No web.response-headers
+
+      await rs.uploadFile('fakeDir/index.js', 'fakeprefix', appConfig, 'fakeDir', global.fakeAuthToken)


The test calls uploadFile with a fifth authToken parameter that shouldn't exist. This parameter is unused and redundant since RemoteStorage already has the auth token as an instance variable. This test should call uploadFile without the auth token parameter: await rs.uploadFile('fakeDir/index.js', 'fakeprefix', appConfig, 'fakeDir')

Copilot · 2026-01-23T03:49:47Z

lib/remote-storage.js

+    const response = await fetch(`${deploymentServiceUrl}/cdn-api/namespaces/${appConfig.ow.namespace}/files`, {
+      method: 'GET',
+      headers: {
+        Authorization: this._authToken
+      }
+    })
+    if (!response.ok) {
+      return false
    }
-
-    // https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/classes/s3.html#constructor
-    this.s3 = new S3(s3Config)
+    const files = await response.json()
+    // Check if there are any files (folder "exists" if it has content)
+    return Array.isArray(files) && files.length > 0


The folderExists method doesn't handle potential network errors that could occur during the fetch request. While line 63 calls response.json(), if the fetch itself throws (network error, DNS failure, etc.), the exception will propagate uncaught. Consider wrapping the fetch call in a try-catch block to provide better error handling and messaging for network-level failures.

purplecabbage added 9 commits December 8, 2025 13:37

7.1.1

27e548c

beware the environment, no more S3 lib

e518504

no more S3 lib credentials needed

04d92bc

no more s3

3f12bb8

Revert "7.1.1"

0ab2862

This reverts commit 27e548c.

refactor/added authToken to constructor for repeated use

ff79d76

deploy/undeploy files with deploy-service + tests

425228c

remove problematic #class-prop syntax

6ccfa8e

tests passing, env mocking

d371fb0

clean up

5a18204

purplecabbage marked this pull request as ready for review January 23, 2026 03:43

purplecabbage requested a review from Copilot January 23, 2026 03:43

Copilot started reviewing on behalf of purplecabbage January 23, 2026 03:43 View session

Copilot AI reviewed Jan 23, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deploy service #232

Deploy service #232

Uh oh!

purplecabbage commented Jan 17, 2026 •

edited

Loading

Uh oh!

codecov bot commented Jan 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	const response = await fetch(`${deploymentServiceUrl}/cdn-api/namespaces/${appConfig.ow.namespace}/files`, {
	const response = await fetch(`${deploymentServiceUrl}/cdn-api/namespaces/${encodeURIComponent(appConfig.ow.namespace)}/files`, {

	let relativeFilePath = filePath.replace(appConfig.ow.namespace, '')
	let relativeFilePath = filePath

	if (typeof prefix !== 'string') {
	throw new Error('prefix must be a valid string')
	}

		"@adobe/aio-lib-env": "^3.0.1",
		"@smithy/node-http-handler": "^4.0.2",

-    if (!response.ok) {
-      return false
-    }
+    // 404 means the namespace/folder does not exist -> return false
+    if (response.status === 404) {
+      return false
+    }
+    // Other non-OK responses indicate an actual error and should not be
+    // silently treated as "folder doesn't exist"
+    if (!response.ok) {
+      throw new Error(`Failed to check if folder exists (status ${response.status} ${response.statusText})`)
+    }

-    return response.ok
+    if (!response.ok) {
+      let errorDetails = ''
+      try {
+        const bodyText = await response.text()
+        if (bodyText) {
+          errorDetails = ` Response body: ${bodyText}`
+        }
+      } catch (e) {
+        // ignore errors while reading response body; we still have status information
+      }
+      const message = `Failed to empty folder at '${url}'. Status: ${response.status} ${response.statusText}.${errorDetails}`
+      logAndThrow(codes.STORAGE_ERROR, message)
+    }
+    return true

Deploy service #232

Are you sure you want to change the base?

Deploy service #232

Uh oh!

Conversation

purplecabbage commented Jan 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

codecov bot commented Jan 20, 2026

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

purplecabbage commented Jan 17, 2026 •

edited

Loading