feat: web compatibility W-20175875 (#1650)

mshanemc · web-flow · commit f350cd6e719e · 2025-11-20T14:18:39.000-06:00
* fix: deployResponses for non-set cwd

* feat: deploy has FileResponses relative to projectDir if one exists on the CS and doesn't match cwd

* refactor: isWebAppBundle as shared type guard

* chore: empty

* refactor: webappbundle also relative to project path if provided

* chore: test failure on fullname fn

* chore: accidentally removed code

* test: ut for projectDir on CS
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/METADATA_SUPPORT.md b/METADATA_SUPPORT.md
diff --git a/src/client/deployMessages.ts b/src/client/deployMessages.ts
@@ -17,7 +17,8 @@
 import { basename, dirname, extname, join, posix, sep } from 'node:path';
 import { SfError } from '@salesforce/core/sfError';
 import { ensureArray } from '@salesforce/kit';
-import { ComponentLike, SourceComponent } from '../resolve';
+import { SourceComponentWithContent, SourceComponent } from '../resolve/sourceComponent';
+import { ComponentLike } from '../resolve';
 import { registry } from '../registry/registry';
 import {
   BooleanString,
@@ -29,6 +30,7 @@ import {
   MetadataApiDeployStatus,
 } from './types';
 import { parseDeployDiagnostic } from './diagnosticUtil';
+import { isWebAppBundle } from './utils';
 
 type DeployMessageWithComponentType = DeployMessage & { componentType: string };
 /**
@@ -79,50 +81,57 @@ const shouldWalkContent = (component: SourceComponent): boolean =>
       (t) => t.unaddressableWithoutParent === true || t.isAddressable === false
     ));
 
-export const createResponses = (component: SourceComponent, responseMessages: DeployMessage[]): FileResponse[] =>
-  responseMessages.flatMap((message): FileResponse[] => {
-    const state = getState(message);
-    const base = { fullName: component.fullName, type: component.type.name } as const;
-
-    if (state === ComponentStatus.Failed) {
-      return [{ ...base, state, ...parseDeployDiagnostic(component, message) } satisfies FileResponseFailure];
-    } else {
-      const isWebAppBundle =
-        component.type.name === 'DigitalExperienceBundle' &&
-        component.fullName.startsWith('web_app/') &&
-        component.content;
-
-      if (isWebAppBundle) {
-        const walkedPaths = component.walkContent();
-        const bundleResponse: FileResponseSuccess = {
-          fullName: component.fullName,
-          type: component.type.name,
-          state,
-          filePath: component.content!,
-        };
-        const fileResponses: FileResponseSuccess[] = walkedPaths.map((filePath) => {
-          // Normalize paths to ensure relative() works correctly on Windows
-          const normalizedContent = component.content!.split(sep).join(posix.sep);
-          const normalizedFilePath = filePath.split(sep).join(posix.sep);
-          const relPath = posix.relative(normalizedContent, normalizedFilePath);
-          return {
-            fullName: posix.join(component.fullName, relPath),
-            type: 'DigitalExperience',
-            state,
-            filePath,
-          };
-        });
-        return [bundleResponse, ...fileResponses];
+export const createResponses =
+  (projectPath?: string) =>
+  (component: SourceComponent, responseMessages: DeployMessage[]): FileResponse[] =>
+    responseMessages.flatMap((message): FileResponse[] => {
+      const state = getState(message);
+      const base = { fullName: component.fullName, type: component.type.name } as const;
+
+      if (state === ComponentStatus.Failed) {
+        return [{ ...base, state, ...parseDeployDiagnostic(component, message) } satisfies FileResponseFailure];
       }
 
-      return [
-        ...(shouldWalkContent(component)
-          ? component.walkContent().map((filePath): FileResponseSuccess => ({ ...base, state, filePath }))
-          : []),
-        ...(component.xml ? [{ ...base, state, filePath: component.xml } satisfies FileResponseSuccess] : []),
-      ];
-    }
-  });
+      return (
+        isWebAppBundle(component)
+          ? [
+              {
+                ...base,
+                state,
+                filePath: component.content,
+              },
+              ...component.walkContent().map((filePath) => ({
+                fullName: getWebAppBundleContentFullName(component)(filePath),
+                type: 'DigitalExperience',
+                state,
+                filePath,
+              })),
+            ]
+          : [
+              ...(shouldWalkContent(component)
+                ? component.walkContent().map((filePath): FileResponseSuccess => ({ ...base, state, filePath }))
+                : []),
+              ...(component.xml ? [{ ...base, state, filePath: component.xml }] : []),
+            ]
+      ).map((response) => ({
+        ...response,
+        filePath:
+          // deployResults will produce filePaths relative to cwd, which might not be set in all environments
+          // if our CS had a projectDir set, we'll make the results relative to that path
+          projectPath && process.cwd() === projectPath ? response.filePath : join(projectPath ?? '', response.filePath),
+      })) satisfies FileResponseSuccess[];
+    });
+
+const getWebAppBundleContentFullName =
+  (component: SourceComponentWithContent) =>
+  (filePath: string): string => {
+    // Normalize paths to ensure relative() works correctly on Windows
+    const normalizedContent = component.content.split(sep).join(posix.sep);
+    const normalizedFilePath = filePath.split(sep).join(posix.sep);
+    const relPath = posix.relative(normalizedContent, normalizedFilePath);
+    return posix.join(component.fullName, relPath);
+  };
+
 /**
  * Groups messages from the deploy result by component fullName and type
  */
diff --git a/src/client/metadataApiDeploy.ts b/src/client/metadataApiDeploy.ts
@@ -509,11 +509,14 @@ const buildFileResponsesFromComponentSet =
 
     const fileResponses = (cs.getSourceComponents().toArray() ?? [])
       .flatMap((deployedComponent) =>
-        createResponses(deployedComponent, responseMessages.get(toKey(deployedComponent)) ?? []).concat(
+        createResponses(cs.projectDirectory)(
+          deployedComponent,
+          responseMessages.get(toKey(deployedComponent)) ?? []
+        ).concat(
           deployedComponent.type.children
             ? deployedComponent.getChildren().flatMap((child) => {
                 const childMessages = responseMessages.get(toKey(child));
-                return childMessages ? createResponses(child, childMessages) : [];
+                return childMessages ? createResponses(cs.projectDirectory)(child, childMessages) : [];
               })
             : []
         )
diff --git a/src/client/metadataApiRetrieve.ts b/src/client/metadataApiRetrieve.ts
@@ -38,6 +38,7 @@ import {
 import { extract } from './retrieveExtract';
 import { getPackageOptions } from './retrieveExtract';
 import { MetadataApiRetrieveOptions } from './types';
+import { isWebAppBundle } from './utils';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/source-deploy-retrieve', 'sdr');
@@ -101,28 +102,27 @@ export class RetrieveResult implements MetadataTransferResult {
 
     // construct successes
     for (const retrievedComponent of this.components.getSourceComponents()) {
-      const { fullName, type, xml, content } = retrievedComponent;
+      const { fullName, type, xml } = retrievedComponent;
       const baseResponse = {
         fullName,
         type: type.name,
         state: this.localComponents.has(retrievedComponent) ? ComponentStatus.Changed : ComponentStatus.Created,
       } as const;
 
       // Special handling for web_app bundles - they need to walk content and report individual files
-      const isWebAppBundle = type.name === 'DigitalExperienceBundle' && fullName.startsWith('web_app/') && content;
-
-      if (isWebAppBundle) {
-        const walkedPaths = retrievedComponent.walkContent();
+      if (isWebAppBundle(retrievedComponent)) {
         // Add the bundle directory itself
-        this.fileResponses.push({ ...baseResponse, filePath: content } satisfies FileResponseSuccess);
-        // Add each file with its specific path
-        for (const filePath of walkedPaths) {
-          this.fileResponses.push({ ...baseResponse, filePath } satisfies FileResponseSuccess);
-        }
+        this.fileResponses.push(
+          ...[retrievedComponent.content, ...retrievedComponent.walkContent()].map(
+            (filePath) => ({ ...baseResponse, filePath } satisfies FileResponseSuccess)
+          )
+        );
       } else if (!type.children || Object.values(type.children.types).some((t) => t.unaddressableWithoutParent)) {
-        for (const filePath of retrievedComponent.walkContent()) {
-          this.fileResponses.push({ ...baseResponse, filePath } satisfies FileResponseSuccess);
-        }
+        this.fileResponses.push(
+          ...retrievedComponent
+            .walkContent()
+            .map((filePath) => ({ ...baseResponse, filePath } satisfies FileResponseSuccess))
+        );
       }
 
       if (xml) {
diff --git a/src/client/retrieveExtract.ts b/src/client/retrieveExtract.ts
@@ -21,7 +21,7 @@ import { ConvertOutputConfig } from '../convert/types';
 import { MetadataConverter } from '../convert/metadataConverter';
 import { ComponentSet } from '../collections/componentSet';
 import { ZipTreeContainer } from '../resolve/treeContainers';
-import { SourceComponent } from '../resolve/sourceComponent';
+import { SourceComponent, SourceComponentWithContent } from '../resolve/sourceComponent';
 import { fnJoin } from '../utils/path';
 import { ComponentStatus, FileResponse, FileResponseSuccess, PackageOption, PackageOptions } from './types';
 import { MetadataApiRetrieveOptions } from './types';
@@ -147,12 +147,12 @@ const handlePartialDeleteMerges = ({
         });
 };
 
-const supportsPartialDeleteAndHasContent = (comp: SourceComponent): comp is SourceComponent & { content: string } =>
+const supportsPartialDeleteAndHasContent = (comp: SourceComponent): comp is SourceComponentWithContent =>
   supportsPartialDelete(comp) && typeof comp.content === 'string' && fs.statSync(comp.content).isDirectory();
 
 const supportsPartialDeleteAndHasZipContent =
   (tree: ZipTreeContainer) =>
-  (comp: SourceComponent): comp is SourceComponent & { content: string } =>
+  (comp: SourceComponent): comp is SourceComponentWithContent =>
     supportsPartialDelete(comp) && typeof comp.content === 'string' && tree.isDirectory(comp.content);
 
 const supportsPartialDeleteAndIsInMap =
diff --git a/src/client/utils.ts b/src/client/utils.ts
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SourceComponent, SourceComponentWithContent } from '../resolve/sourceComponent';
+
+export const isWebAppBundle = (component: SourceComponent): component is SourceComponentWithContent =>
+  component.type.name === 'DigitalExperienceBundle' &&
+  component.fullName.startsWith('web_app/') &&
+  typeof component.content === 'string';
diff --git a/src/resolve/sourceComponent.ts b/src/resolve/sourceComponent.ts
@@ -47,6 +47,8 @@ export type ComponentProperties = {
   parentType?: MetadataType;
 };
 
+export type SourceComponentWithContent = SourceComponent & { content: string };
+
 /**
  * Representation of a MetadataComponent in a file tree.
  */
diff --git a/test/client/metadataApiDeploy.test.ts b/test/client/metadataApiDeploy.test.ts
@@ -1293,6 +1293,44 @@ describe('MetadataApiDeploy', () => {
         result.getFileResponses();
         expect(spy.callCount).to.equal(1);
       });
+
+      it('should prepend projectDirectory to filePaths when projectDirectory differs from cwd', () => {
+        const component = matchingContentFile.COMPONENT;
+        const projectDir = join('my', 'project', 'dir');
+        const deployedSet = new ComponentSet([component]);
+        deployedSet.projectDirectory = projectDir;
+        const { fullName, type, content, xml } = component;
+        const apiStatus: Partial<MetadataApiDeployStatus> = {
+          details: {
+            componentSuccesses: {
+              changed: 'true',
+              created: 'false',
+              deleted: 'false',
+              fullName,
+              componentType: type.name,
+            } as DeployMessage,
+          },
+        };
+        const result = new DeployResult(apiStatus as MetadataApiDeployStatus, deployedSet);
+
+        const responses = result.getFileResponses();
+        const expected: FileResponse[] = [
+          {
+            fullName,
+            type: type.name,
+            state: ComponentStatus.Changed,
+            filePath: join(projectDir, ensureString(content)),
+          },
+          {
+            fullName,
+            type: type.name,
+            state: ComponentStatus.Changed,
+            filePath: join(projectDir, ensureString(xml)),
+          },
+        ];
+
+        expect(responses).to.deep.equal(expected);
+      });
     });
   });
 
