Merge pull request #632 from jpogran/GH-630-puppet-toolbar

GH 630 Puppet Toolbar and Puppet Facts View

Author: James Pogran

CHANGELOG.md

@@ -6,6 +6,11 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Unreleased]
 
+### Added
+
+- ([GH-630](https://github.com/puppetlabs/puppet-vscode/issues/630)) Add Puppet ToolBar
+- ([GH-631](https://github.com/puppetlabs/puppet-vscode/issues/631)) Add Puppet Facts View
+
 ## [0.25.2] - 2020-03-27
 
 ### Fixed

assets/icons/dark/sync.svg

@@ -197,8 +197,33 @@
         "command": "puppet-bolt.OpenUserInventoryFile",
         "title": "Open Bolt User Inventory File",
         "category": "Puppet"
+      },
+      {
+        "command": "puppet.refreshFacts",
+        "title": "Refresh",
+        "icon": {
+          "light": "assets/icons/light/sync.svg",
+          "dark": "assets/icons/dark/sync.svg"
+        }
       }
     ],
+    "viewsContainers": {
+      "activitybar": [
+        {
+          "id": "puppet-toolbar",
+          "title": "Puppet Toolbar",
+          "icon": "images/puppet-dag-dark.svg"
+        }
+      ]
+    },
+    "views": {
+      "puppet-toolbar": [
+        {
+          "id": "puppetFacts",
+          "name": "Facts"
+        }
+      ]
+    },
     "menus": {
       "commandPalette": [
         {
@@ -296,6 +321,13 @@
           "command": "extension.puppetResource",
           "group": "puppet"
         }
+      ],
+      "view/title": [
+        {
+          "command": "puppet.refreshFacts",
+          "when": "view == puppetFacts",
+          "group": "navigation"
+        }
       ]
     },
     "configurationDefaults": {

assets/icons/light/sync.svg

@@ -143,7 +143,7 @@ export class AggregateConfiguration implements IAggregateConfiguration {
         if (settings.editorService.tcp.address === '127.0.0.1' ||
             settings.editorService.tcp.address === 'localhost' ||
             settings.editorService.tcp.address === '') {
-              return ConnectionType.Remote;
+          return ConnectionType.Local;
         } else {
           return ConnectionType.Remote;
         }

package.json

@@ -21,6 +21,7 @@ import { legacySettings, SettingsFromWorkspace } from './settings';
 import { reporter } from './telemetry';
 import { PuppetModuleHoverFeature } from './feature/PuppetModuleHoverFeature';
 import { PuppetNodeGraphFeature } from './feature/PuppetNodeGraphFeature';
+import { PuppetFactsProvider } from './views/facts';
 
 const axios = require('axios');
 
@@ -116,6 +117,10 @@ export function activate(context: vscode.ExtensionContext) {
   if (settings.hover.showMetadataInfo) {
     extensionFeatures.push(new PuppetModuleHoverFeature(extContext, logger));
   }
+
+  let facts = new PuppetFactsProvider(connectionHandler);
+  vscode.window.registerTreeDataProvider('puppetFacts', facts);
+
 }
 
 export function deactivate() {

src/configuration.ts

@@ -76,7 +76,7 @@ export class TcpConnectionHandler extends ConnectionHandler {
           this.config.workspace.editorService.tcp.address === 'localhost' ||
           this.config.workspace.editorService.tcp.address === ''
         ) {
-          return ConnectionType.Remote;
+          return ConnectionType.Local;
         } else {
           return ConnectionType.Remote;
         }

src/extension.ts

@@ -0,0 +1,105 @@
+import {
+  TreeItem,
+  TreeItemCollapsibleState,
+  ThemeIcon,
+  TreeDataProvider,
+  Event,
+  EventEmitter,
+  commands,
+  ProviderResult,
+  window,
+} from 'vscode';
+import { RequestType, RequestType0 } from 'vscode-languageclient';
+import { ConnectionHandler } from '../handler';
+import { PuppetVersionRequest } from '../messages';
+
+class PuppetFact extends TreeItem {
+  constructor(
+    public readonly label: string,
+    private value: string,
+    public readonly collapsibleState: TreeItemCollapsibleState,
+    public readonly children?: Array<[string, PuppetFact]>
+  ) {
+    super(label, collapsibleState);
+    if (children) {
+      this.iconPath = ThemeIcon.Folder;
+    } else {
+      this.iconPath = ThemeIcon.File;
+    }
+  }
+
+  get tooltip(): string {
+    return `${this.label}-${this.value}`;
+  }
+
+  get description(): string {
+    return this.value;
+  }
+}
+
+interface PuppetFactResponse {
+  facts: string;
+  error: string;
+}
+
+export class PuppetFactsProvider implements TreeDataProvider<PuppetFact> {
+  private elements: Array<[string, PuppetFact]> = [];
+  private _onDidChangeTreeData: EventEmitter<PuppetFact | undefined> = new EventEmitter<PuppetFact | undefined>();
+  readonly onDidChangeTreeData: Event<PuppetFact | undefined> = this._onDidChangeTreeData.event;
+
+  constructor(protected handler: ConnectionHandler) {
+    commands.registerCommand('puppet.refreshFacts', () => this.refresh());
+  }
+
+  refresh(): void {
+    this._onDidChangeTreeData.fire();
+  }
+
+  getTreeItem(element: PuppetFact): TreeItem | Thenable<PuppetFact> {
+    return element;
+  }
+
+  getChildren(element?: PuppetFact): Promise<PuppetFact[]> {
+    if (element) {
+      return Promise.resolve(element.children.map((e) => e[1]));
+    } else {
+      return this.getFactsFromLanguageServer();
+    }
+  }
+
+  private async getFactsFromLanguageServer(): Promise<PuppetFact[]> {
+    /*
+      this is problematic because we both store this and return the value
+      but this allows us to cache the info for quick expands of the node.
+      if we didn't cache, we would have to call out for each expand and getting
+      facts is slow.
+    */
+    await this.handler.languageClient.onReady();
+    const results = await this.handler.languageClient.sendRequest(
+      new RequestType0<PuppetFactResponse, void, void>('puppet/getFacts')
+    );
+    this.elements = this.toList(results.facts);
+    return this.elements.map((e) => e[1]);
+  }
+
+  getParent?(element: PuppetFact): ProviderResult<PuppetFact> {
+    throw new Error('Method not implemented.');
+  }
+
+  toList(data: any): Array<[string, PuppetFact]> {
+    let things: Array<[string, PuppetFact]> = [];
+
+    for (let key of Object.keys(data)) {
+      let value = data[key];
+      if (Object.prototype.toString.call(value) === '[object Object]') {
+        let children = this.toList(value);
+        const item = new PuppetFact(key, value, TreeItemCollapsibleState.Collapsed, children);
+        things.push([key, item]);
+      } else {
+        things.push([key, new PuppetFact(key, value.toString(), TreeItemCollapsibleState.None)]);
+      }
+    }
+
+    return things;
+  }
+}