Sm/nested-lwc (#618)

* fix: support for nested lwc folders

* chore: auto-update metadata coverage in METADATA_SUPPORT.md

* test: ut

* test: ut for deep empties

Author: mshanemc

METADATA_SUPPORT.md

@@ -4,7 +4,7 @@ This list compares metadata types found in Salesforce v55 with the [metadata reg
 
 This repository is used by both the Salesforce CLIs and Salesforce's VSCode Extensions.
 
-Currently, there are 456/494 supported metadata types.
+Currently, there are 456/495 supported metadata types.
 For status on any existing gaps, please search or file an issue in the [Salesforce CLI issues only repo](https://github.com/forcedotcom/cli/issues).
 To contribute a new metadata type, please see the [Contributing Metadata Types to the Registry](./contributing/metadata.md)
 
@@ -41,6 +41,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |ApexTrigger|✅||
 |AppAnalyticsSettings|✅||
 |AppExperienceSettings|✅||
+|AppExplorationDataConsent|❌|Not supported, but support could be added|
 |AppMenu|✅||
 |ApplicationRecordTypeConfig|✅||
 |ApplicationSubtypeDefinition|✅||
@@ -164,7 +165,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |DevHubSettings|✅||
 |DigitalExperience|❌|Not supported, but support could be added (but not for tracking)|
 |DigitalExperienceBundle|❌|Not supported, but support could be added (but not for tracking)|
-|DigitalExperienceBundleSetting|❌|Not supported, but support could be added (but not for tracking)|
+|DigitalExperienceConfig|❌|Not supported, but support could be added (but not for tracking)|
 |DiscoveryAIModel|✅||
 |DiscoveryGoal|✅||
 |DiscoverySettings|✅||
@@ -512,7 +513,6 @@ v56 introduces the following new types.  Here's their current level of support
 
 |Metadata Type|Support|Notes|
 |:---|:---|:---|
-|DigitalExperienceConfig|❌|Not supported, but support could be added (but not for tracking)|
 
 ## Additional Types
 

src/resolve/adapters/mixedContentSourceAdapter.ts

@@ -81,7 +81,7 @@ export class MixedContentSourceAdapter extends BaseSourceAdapter {
    */
   protected trimPathToContent(path: SourcePath): SourcePath {
     const pathParts = path.split(sep);
-    const typeFolderIndex = pathParts.findIndex((part) => part === this.type.directoryName);
+    const typeFolderIndex = pathParts.lastIndexOf(this.type.directoryName);
     const offset = this.type.inFolder ? 3 : 2;
     return pathParts.slice(0, typeFolderIndex + offset).join(sep);
   }

src/resolve/metadataResolver.ts

@@ -230,10 +230,12 @@ export class MetadataResolver {
       const { directoryName, inFolder } = type;
       const parts = dirPath.split(sep);
       const folderOffset = inFolder ? 2 : 1;
-      const typeDirectoryIndex = parts.indexOf(directoryName);
+      const typeDirectoryIndex = parts.lastIndexOf(directoryName);
       if (
         typeDirectoryIndex === -1 ||
         parts.length - folderOffset <= typeDirectoryIndex ||
+        // ex: /lwc/folder/lwc/cmp
+        this.tree.readDirectory(dirPath).includes(type.directoryName) ||
         // types with children may want to resolve them individually
         type.children
       ) {

src/resolve/sourceComponent.ts

@@ -203,7 +203,7 @@ export class SourceComponent implements MetadataComponent {
     // (report, dashboard, emailTemplate, document) and their folder container types:
     // (reportFolder, dashboardFolder, emailFolder, documentFolder)
     if (!suffix || inFolder || folderContentType) {
-      return trimUntil(fsPath, directoryName);
+      return trimUntil(fsPath, directoryName, true);
     }
 
     if (folderType) {

src/utils/path.ts

@@ -47,10 +47,11 @@ export function parentName(fsPath: SourcePath): string {
  *
  * @param fsPath Path to trim
  * @param part Path part to trim up until
+ * @param untilLast Trim until the *last* occurrence of `part`
  */
-export function trimUntil(fsPath: SourcePath, part: string): string {
+export function trimUntil(fsPath: SourcePath, part: string, untilLast = false): string {
   const parts = fsPath.split(sep);
-  const partIndex = parts.findIndex((p) => part === p);
+  const partIndex = untilLast ? parts.lastIndexOf(part) : parts.findIndex((p) => part === p);
   if (partIndex === -1) {
     return fsPath;
   }

test/mock/index.ts

@@ -17,4 +17,5 @@ export {
   nonDecomposed,
   decomposedtoplevel,
   nestedTypes,
+  lwcBundle,
 } from './type-constants';

test/mock/type-constants/index.ts

@@ -15,6 +15,7 @@ import * as decomposed from './customObjectConstant';
 import * as decomposedtoplevel from './customObjectTranslationConstant';
 import * as nonDecomposed from './customlabelsConstant';
 import * as nestedTypes from './territoryConstant';
+import * as lwcBundle from './lwcBundleConstant';
 
 export {
   xmlInFolder,
@@ -28,4 +29,5 @@ export {
   decomposedtoplevel,
   nonDecomposed,
   nestedTypes,
+  lwcBundle,
 };

test/mock/type-constants/lwcBundleConstant.ts

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { join } from 'path';
+import { registry, SourceComponent } from '../../../src';
+
+const type = registry.types.lightningcomponentbundle;
+
+/**
+ * While LWC *can* be identical to Aura bundles, they may also be deeply nested.
+ * ex  projDir/lwc/folder1/lwc/cmpA
+ * and projDir/lwc/cmpB
+ */
+export const TYPE_DIRECTORY = join('path', 'to', type.directoryName, 'folder1', type.directoryName);
+const COMPONENT_NAME = 'cmpA';
+export const CONTENT_PATH = join(TYPE_DIRECTORY, COMPONENT_NAME);
+export const XML_NAME = `${COMPONENT_NAME}.js-meta.xml`;
+export const XML_PATH = join(CONTENT_PATH, XML_NAME);
+export const SUBTYPE_XML_PATH = join(CONTENT_PATH, `${COMPONENT_NAME}.js-meta.xml`);
+export const COMPONENTS = [`${COMPONENT_NAME}.js`, `${COMPONENT_NAME}.css`, `${COMPONENT_NAME}.html`];
+export const SOURCE_PATHS = COMPONENTS.map((cmp) => join(CONTENT_PATH, cmp));
+
+export const COMPONENT = SourceComponent.createVirtualComponent(
+  {
+    name: COMPONENT_NAME,
+    type,
+    xml: XML_PATH,
+    content: CONTENT_PATH,
+  },
+  [
+    {
+      dirPath: TYPE_DIRECTORY,
+      children: [COMPONENT_NAME],
+    },
+    {
+      dirPath: CONTENT_PATH,
+      children: [XML_NAME, ...COMPONENTS],
+    },
+  ]
+);
+
+export const EMPTY_BUNDLE = SourceComponent.createVirtualComponent(
+  {
+    name: COMPONENT_NAME,
+    type,
+    xml: XML_PATH,
+    content: CONTENT_PATH,
+  },
+  [
+    {
+      dirPath: TYPE_DIRECTORY,
+      children: [COMPONENT_NAME],
+    },
+    {
+      dirPath: CONTENT_PATH,
+      children: [],
+    },
+  ]
+);

test/resolve/adapters/bundleSourceAdapter.test.ts

@@ -6,12 +6,13 @@
  */
 
 import { expect } from 'chai';
-import { bundle } from '../../mock';
+import { bundle, lwcBundle } from '../../mock';
 import { BundleSourceAdapter } from '../../../src/resolve/adapters';
 import { CONTENT_PATH } from '../../mock/type-constants/auraBundleConstant';
+import { CONTENT_PATH as LWC_CONTENT_PATH } from '../../mock/type-constants/lwcBundleConstant';
 import { RegistryAccess } from '../../../src';
 
-describe('BundleSourceAdapter', () => {
+describe('BundleSourceAdapter with AuraBundle', () => {
   const registryAccess = new RegistryAccess();
   const adapter = new BundleSourceAdapter(bundle.COMPONENT.type, registryAccess, undefined, bundle.COMPONENT.tree);
 
@@ -37,4 +38,35 @@ describe('BundleSourceAdapter', () => {
     const randomSource = bundle.SOURCE_PATHS[1];
     expect(adapter.getComponent(randomSource)).to.deep.equal(bundle.COMPONENT);
   });
+
+  describe('deeply nested LWC', () => {
+    const lwcAdapter = new BundleSourceAdapter(
+      lwcBundle.COMPONENT.type,
+      registryAccess,
+      undefined,
+      lwcBundle.COMPONENT.tree
+    );
+    it('Should return expected SourceComponent when given a root metadata xml path', () => {
+      expect(lwcAdapter.getComponent(lwcBundle.XML_PATH)).to.deep.equal(lwcBundle.COMPONENT);
+    });
+
+    it('Should return expected SourceComponent when given a lwcBundle directory', () => {
+      expect(lwcAdapter.getComponent(lwcBundle.CONTENT_PATH)).to.deep.equal(lwcBundle.COMPONENT);
+    });
+
+    it('Should return expected SourceComponent when given a source path', () => {
+      const randomSource = lwcBundle.SOURCE_PATHS[1];
+      expect(lwcAdapter.getComponent(randomSource)).to.deep.equal(lwcBundle.COMPONENT);
+    });
+
+    it('Should exclude nested empty bundle directories', () => {
+      const emptyBundleAdapter = new BundleSourceAdapter(
+        lwcBundle.EMPTY_BUNDLE.type,
+        registryAccess,
+        undefined,
+        lwcBundle.EMPTY_BUNDLE.tree
+      );
+      expect(emptyBundleAdapter.getComponent(LWC_CONTENT_PATH)).to.be.undefined;
+    });
+  });
 });

test/utils/path.ts

@@ -31,6 +31,18 @@ describe('Path Utils', () => {
     it('should return trimmed path up until and including the given part', () => {
       expect(trimUntil(root, 'to')).to.equal(join('to', 'whatever'));
     });
+
+    describe('until last', () => {
+      const path = join('proj', 'lwc', 'folder1', 'lwc', 'myCmp');
+
+      it('should return trimmed until first unless last is requested', () => {
+        expect(trimUntil(path, 'lwc')).to.equal(join('lwc', 'folder1', 'lwc', 'myCmp'));
+      });
+
+      it('should return trimmed until last if requested', () => {
+        expect(trimUntil(path, 'lwc', true)).to.equal(join('lwc', 'myCmp'));
+      });
+    });
   });
 
   describe('parseMetadataXml', () => {