only add visible nodes to structured text

Author: annieyw

src/material/tree/testing/shared.spec.ts

@@ -100,23 +100,60 @@ export function runHarnessTests(
   it ('should correctly get tree structure', async () => {
     const trees = await loader.getAllHarnesses(treeHarness);
     const flatTree = trees[0];
-    expect(await flatTree.getStructureText()).toEqual(
+
+    expect(await flatTree.getStructuredText()).toEqual(
+      `Flat Group 1
+Flat Group 2`);
+
+    const firstGroup = (await flatTree.getNodes({text: /Flat Group 1/}))[0];
+    await firstGroup.expand();
+
+    expect(await flatTree.getStructuredText()).toEqual(
       `Flat Group 1
+\tFlat Leaf 1.1
+\tFlat Leaf 1.2
+\tFlat Leaf 1.3
 Flat Group 2`);
+
+    const secondGroup = (await flatTree.getNodes({text: /Flat Group 2/}))[0];
+    await secondGroup.expand();
+
+    expect(await flatTree.getStructuredText()).toEqual(
+      `Flat Group 1
+\tFlat Leaf 1.1
+\tFlat Leaf 1.2
+\tFlat Leaf 1.3
+Flat Group 2
+\tFlat Group 2.1`);
   });
 
   it('should correctly get tree structure', async () => {
     const trees = await loader.getAllHarnesses(treeHarness);
     const nestedTree = trees[1];
-    expect(await nestedTree.getStructureText()).toEqual(
+    expect(await nestedTree.getStructuredText()).toEqual(
+      `Nested Group 1
+Nested Group 2`);
+
+    const firstGroup = (await nestedTree.getNodes({text: /Nested Group 1/}))[0];
+    await firstGroup.expand();
+
+    expect(await nestedTree.getStructuredText()).toEqual(
+      `Nested Group 1
+\tNested Leaf 1.1
+\tNested Leaf 1.2
+\tNested Leaf 1.3
+Nested Group 2`);
+
+    const secondGroup = (await nestedTree.getNodes({text: /Nested Group 2/}))[0];
+    await secondGroup.expand();
+
+    expect(await nestedTree.getStructuredText()).toEqual(
       `Nested Group 1
 \tNested Leaf 1.1
 \tNested Leaf 1.2
 \tNested Leaf 1.3
 Nested Group 2
-\tNested Group 2.1
-\t\tNested Leaf 2.1.1
-\t\tNested Leaf 2.1.2`);
+\tNested Group 2.1`);
   });
 }
 

src/material/tree/testing/tree-harness.ts

@@ -30,9 +30,10 @@ export class MatTreeHarness extends ComponentHarness {
   }
 
   /**
-   * String representation of the tree structure.
+   * String representation of the visible tree structure.
+   * If a node is under an unexpanded node it will not be shown here.
    * Eg.
-   * Tree:
+   * Tree (all nodes expanded):
    * `
    * <mat-tree>
    *   <mat-tree-node>Node 1<mat-tree-node>
@@ -57,17 +58,26 @@ export class MatTreeHarness extends ComponentHarness {
    *     Node 2.1.1
    *   Node 2.2
    */
-  async getStructureText(): Promise<string> {
+  async getStructuredText(): Promise<string> {
     let treeString = '';
     const nodes = await this.getNodes();
-    const levelsAndText = await Promise.all(nodes.map(node => {
-      return Promise.all([node.getLevel(), node.getText()]);
+    const nodeInformation = await Promise.all(nodes.map(node => {
+      return Promise.all([node.getLevel(), node.getText(), node.isExpanded()]);
     }));
+    // initialize as true because the root level nodes are always visible
+    let previousExpanded = true;
+    // initialize as 0 because the root essentially has level 0 even though the tree itself has
+    // no level
+    let previousLevel = 0;
     for (let i = 0; i < nodes.length; i++) {
-      const [level, text] = levelsAndText[i];
-      treeString += i === 0 ? '' : '\n';
-      treeString += '\t'.repeat(level - 1);
-      treeString += text;
+      const [level, text, expanded] = nodeInformation[i];
+      if (previousExpanded || level <= previousLevel) {
+        treeString += i === 0 ? '' : '\n';
+        treeString += '\t'.repeat(level - 1);
+        treeString += text;
+        previousLevel = level;
+        previousExpanded = expanded;
+      }
     }
     return treeString;
   }

tools/public_api_guard/material/tree/testing.d.ts

@@ -1,6 +1,6 @@
 export declare class MatTreeHarness extends ComponentHarness {
     getNodes(filter?: TreeNodeHarnessFilters): Promise<MatTreeNodeHarness[]>;
-    getTreeStructure(): Promise<string>;
+    getStructuredText(): Promise<string>;
     static hostSelector: string;
     static with(options?: TreeHarnessFilters): HarnessPredicate<MatTreeHarness>;
 }