Merge pull request #135 from halcyon-tech/feature/examples_sevice_info

`service_info` available from Examples view

Author: worksofliam

src/config.ts

@@ -6,6 +6,7 @@ import { ServerComponent, UpdateStatus } from "./connection/serverComponent";
 import { JobManagerView } from "./views/jobManager/jobManagerView";
 import Configuration from "./configuration";
 import { ConfigManager } from "./views/jobManager/ConfigManager";
+import { Examples, ServiceInfoLabel } from "./views/examples";
 
 interface IBMiLevels {
   version: number;
@@ -67,6 +68,9 @@ export function setupConfig(context: ExtensionContext) {
   getInstance().onEvent(`disconnected`, async () => {
     JobManagerView.setVisible(false);
     await JobManager.endAll();
+
+    // Remove old service examples
+    delete Examples[ServiceInfoLabel];
   });
 }
 

src/database/serviceInfo.ts

@@ -0,0 +1,17 @@
+import { SQLExample } from "../views/examples";
+import { JobManager } from "../config";
+import Statement from "./statement";
+
+export async function getServiceInfo(): Promise<SQLExample[]|undefined> {
+  // The reason we check for a selection is because we don't want it to prompt the user to start one here
+  if (JobManager.getSelection()) {
+    const resultSet = await JobManager.runSQL<{SERVICE_NAME: string, EXAMPLE: string}>(`select SERVICE_NAME, EXAMPLE from qsys2.services_info`);
+
+    return resultSet.map(r => ({
+      name: Statement.prettyName(r.SERVICE_NAME),
+      content: [r.EXAMPLE],
+    }))
+  } else {
+    return undefined;
+  }
+}

src/extension.ts

@@ -9,7 +9,7 @@ import * as resultsProvider from "./views/results";
 import { loadBase } from "./base";
 import { JobManager, setupConfig } from "./config";
 import { queryHistory } from "./views/queryHistoryView";
-import { ExampleBrowser } from "./views/exampleBrowser";
+import { ExampleBrowser } from "./views/examples/exampleBrowser";
 import { languageInit } from "./language";
 import { initialise } from "./testing";
 import { JobManagerView } from "./views/jobManager/jobManagerView";

src/views/exampleBrowser.ts renamed to src/views/examples/exampleBrowser.ts

@@ -1,9 +1,10 @@
 import { EventEmitter, MarkdownString, workspace } from "vscode";
 import { window } from "vscode";
 import { CancellationToken, Event, ExtensionContext, ProviderResult, ThemeIcon, TreeDataProvider, TreeItem, TreeItemCollapsibleState, commands } from "vscode";
-import { SQLExample, Examples } from "./examples";
-import { OSData, fetchSystemInfo } from "../config";
-import { getInstance } from "../base";
+import { SQLExample, Examples, ServiceInfoLabel } from ".";
+import { OSData, fetchSystemInfo } from "../../config";
+import { getInstance } from "../../base";
+import { getServiceInfo } from "../../database/serviceInfo";
 
 const openExampleCommand = `vscode-db2i.examples.open`;
 
@@ -59,7 +60,15 @@ export class ExampleBrowser implements TreeDataProvider<any> {
     return element;
   }
 
-  getChildren(element?: ExampleGroupItem): ProviderResult<any[]> {
+  async getChildren(element?: ExampleGroupItem): Promise<any[]> {
+    // Unlike the bulk of the examples which are defined in views/examples/index.ts, the services examples are retrieved dynamically
+    if (!Examples[ServiceInfoLabel]) {
+      getServiceInfo().then(serviceExamples => {
+        Examples[ServiceInfoLabel] = serviceExamples;
+        this.refresh();
+      })
+    }
+
     if (this.currentFilter) {
       // If there is a filter, then show all examples that include this criteria
       let items: SQLExampleItem[] = [];

src/views/examples/index.ts

@@ -13,7 +13,10 @@ export interface SQLExample {
   requirements?: ExampleSystemRequirements;
 };
 
-export const Examples: SQLExamplesList = {
+    // Unlike the bulk of the examples defined below, the services examples are retrieved dynamically
+    export const ServiceInfoLabel = `IBM i (SQL) Services`;
+
+export let Examples: SQLExamplesList = {
   "Data Definition Language (DDL)": [
     {
       "name": "Create Schema",