fix: wrap error from fast-xml-parser when invalid xml parsed (#518)

* fix: wrap error from fast-xml-parser when invalid xml parsed

* chore: adding types for SDR

* chore: fix test titles

* chore: remove METADATA_SUPPORT.md change

* chore: adding types for SDR

* chore: adding types for SDR

* chore: better argument names

Author: WillieRuemmele

METADATA_SUPPORT.md

@@ -482,6 +482,7 @@ v55 introduces the following new types.  Here's their current level of support
 
 |Metadata Type|Support|Notes|
 |:---|:---|:---|
+|Experience|undefined|undefined|
 
 ## Additional Types
 

src/i18n/i18n.ts

@@ -65,4 +65,5 @@ export const messages = {
   error_no_job_id: 'The %s operation is missing a job ID. Initialize an operation with an ID, or start a new job.',
   tapi_deploy_component_limit_error: 'This deploy method only supports deploying one metadata component at a time',
   warn_unresolved_source_for_components: 'The following components will not be deployed due to unresolved source: %s',
+  invalid_xml_parsing: 'error parsing %s due to:\n  message: %s\n  line: %s\n  code: %s',
 };

src/resolve/sourceComponent.ts

@@ -5,13 +5,13 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { basename, join } from 'path';
-import { parse } from 'fast-xml-parser';
+import { parse, validate } from 'fast-xml-parser';
 import { get, getString, JsonMap } from '@salesforce/ts-types';
 import { baseName, normalizeToArray, parseMetadataXml, trimUntil } from '../utils';
 import { DEFAULT_PACKAGE_ROOT_SFDX } from '../common';
 import { SfdxFileFormat } from '../convert';
 import { MetadataType } from '../registry';
-import { TypeInferenceError } from '../errors';
+import { LibraryError, TypeInferenceError } from '../errors';
 import { DestructiveChangesType } from '../collections';
 import { filePathsFromMetadataComponent } from '../utils/filePathGenerator';
 import { MetadataComponent, VirtualDirectory } from './types';
@@ -116,17 +116,17 @@ export class SourceComponent implements MetadataComponent {
   public async parseXml<T = JsonMap>(xmlFilePath?: string): Promise<T> {
     const xml = xmlFilePath ?? this.xml;
     if (xml) {
-      const contents = await this.tree.readFile(xml);
-      return this.parse<T>(contents.toString());
+      const contents = (await this.tree.readFile(xml)).toString();
+      return this.parseAndValidateXML(contents, xml);
     }
     return {} as T;
   }
 
   public parseXmlSync<T = JsonMap>(xmlFilePath?: string): T {
     const xml = xmlFilePath ?? this.xml;
     if (xml) {
-      const contents = this.tree.readFileSync(xml);
-      return this.parse<T>(contents.toString());
+      const contents = this.tree.readFileSync(xml).toString();
+      return this.parseAndValidateXML(contents, xml);
     }
     return {} as T;
   }
@@ -232,6 +232,24 @@ export class SourceComponent implements MetadataComponent {
     }
   }
 
+  private parseAndValidateXML<T = JsonMap>(contents: string, path: string): T {
+    try {
+      return this.parse<T>(contents);
+    } catch (e) {
+      // only attempt validating once there's an error to avoid the performance hit of validating every file
+      const validation = validate(contents);
+      if (validation !== true) {
+        throw new LibraryError('invalid_xml_parsing', [
+          path,
+          validation.err.msg,
+          validation.err.line.toString(),
+          validation.err.code,
+        ]);
+      }
+      throw e;
+    }
+  }
+
   private getDecomposedChildren(dirPath: string): SourceComponent[] {
     const children: SourceComponent[] = [];
     for (const fsPath of this.walk(dirPath)) {

test/resolve/sourceComponent.test.ts

@@ -117,6 +117,37 @@ describe('SourceComponent', () => {
       });
     });
 
+    it('should handle improperly formatted xml and throw a helpful message (async)', async () => {
+      const component = COMPONENT;
+      env
+        .stub(component.tree, 'readFile')
+        .resolves(Buffer.from('</CustomLabels xmlns="http://soap.sforce.com/2006/04/metadata"></CustomLabels>'));
+      try {
+        await component.parseXml();
+      } catch (e) {
+        expect(e.message).to.include(`error parsing ${component.xml} due to:`);
+        expect(e.message).to.include("message: Closing tag 'CustomLabels' can't have attributes or invalid starting.");
+        expect(e.message).to.include('line: 1');
+        expect(e.message).to.include('code: InvalidTag');
+      }
+    });
+
+    it('should handle improperly formatted xml and throw a helpful message (sync)', async () => {
+      const component = COMPONENT;
+      env
+        .stub(component.tree, 'readFile')
+        .resolves(Buffer.from('</CustomLabels xmlns="http://soap.sforce.com/2006/04/metadata"></CustomLabels>'));
+
+      try {
+        component.parseXmlSync();
+      } catch (e) {
+        expect(e.message).to.include(`error parsing ${component.xml} due to:`);
+        expect(e.message).to.include("message: Closing tag 'CustomLabels' can't have attributes or invalid starting.");
+        expect(e.message).to.include('line: 1');
+        expect(e.message).to.include('code: InvalidTag');
+      }
+    });
+
     it('should parse the child components xml content to js object', async () => {
       const component = new SourceComponent({
         name: 'nondecomposedchild',