Prevent refresh loop on services example loading + cleanup

Signed-off-by: Seb Julliand <[email protected]>

Author: sebjulliand

package-lock.json

@@ -1,18 +1,16 @@
-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, ServiceInfoLabel } from ".";
-import { OSData, fetchSystemInfo } from "../../config";
+import { Event, EventEmitter, ExtensionContext, MarkdownString, ThemeIcon, TreeDataProvider, TreeItem, TreeItemCollapsibleState, commands, window, workspace } from "vscode";
+import { Examples, SQLExample, ServiceInfoLabel } from ".";
 import { getInstance } from "../../base";
+import { OSData, fetchSystemInfo } from "../../config";
 import { getServiceInfo } from "../../database/serviceInfo";
 
 const openExampleCommand = `vscode-db2i.examples.open`;
 
 export class ExampleBrowser implements TreeDataProvider<any> {
   private _onDidChangeTreeData: EventEmitter<TreeItem | undefined | null | void> = new EventEmitter<TreeItem | undefined | null | void>();
   readonly onDidChangeTreeData: Event<TreeItem | undefined | null | void> = this._onDidChangeTreeData.event;
-  
-  private currentFilter: string|undefined;
+
+  private currentFilter: string | undefined;
 
   constructor(context: ExtensionContext) {
     context.subscriptions.push(
@@ -49,9 +47,9 @@ export class ExampleBrowser implements TreeDataProvider<any> {
         // Refresh the examples when we have it, so we only display certain examples
         this.refresh();
       })
-    }) 
+    })
   }
-  
+
   refresh() {
     this._onDidChangeTreeData.fire();
   }
@@ -60,59 +58,35 @@ export class ExampleBrowser implements TreeDataProvider<any> {
     return element;
   }
 
-  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();
-      })
+  async getChildren(element?: ExampleGroupItem): Promise<SQLExampleItem[]> {
+    if (element) {
+      return element.getChildren();
     }
-
-    if (this.currentFilter) {
-      // If there is a filter, then show all examples that include this criteria
-      let items: SQLExampleItem[] = [];
-
-      const upperFilter = this.currentFilter.toUpperCase();
-
-      for (const exampleName in Examples) {
-        items.push(
-          ...Examples[exampleName]
-            .filter(example => exampleWorksForOnOS(example))
-            .filter(example => example.name.toUpperCase().includes(upperFilter) || example.content.some(line => line.toUpperCase().includes(upperFilter)))
-            .map(example => new SQLExampleItem(example))
-        )
+    else {
+      // Unlike the bulk of the examples which are defined in views/examples/index.ts, the services examples are retrieved dynamically
+      if (!Examples[ServiceInfoLabel]) {
+        Examples[ServiceInfoLabel] = await getServiceInfo();
       }
 
-      return items;
-
-    } else {
-      if (element) {
-        return element.getChildren();
-      } else {
-        let items: ExampleGroupItem[] = [];
-
-        for (const exampleName in Examples) {
-          items.push(
-            new ExampleGroupItem(exampleName, Examples[exampleName])
-          )
-        }
-
-        return items;
+      if (this.currentFilter) {
+        // If there is a filter, then show all examples that include this criteria
+        const upperFilter = this.currentFilter.toUpperCase();
+        return Object.values(Examples)
+          .flatMap(examples => examples.filter(exampleWorksForOnOS))
+          .filter(example => example.name.toUpperCase().includes(upperFilter) || example.content.some(line => line.toUpperCase().includes(upperFilter)))
+          .map(example => new SQLExampleItem(example));
+      }
+      else {
+        return Object.entries(Examples).map(([name, examples]) => new ExampleGroupItem(name, examples));
       }
     }
   }
-
-  getParent?(element: any) {
-    throw new Error("Method not implemented.");
-  }
 }
 
 class ExampleGroupItem extends TreeItem {
   constructor(name: string, private group: SQLExample[]) {
     super(name, TreeItemCollapsibleState.Collapsed);
-
-    this.iconPath = new ThemeIcon(`folder`);
+    this.iconPath = ThemeIcon.Folder;
   }
 
   getChildren(): SQLExampleItem[] {
@@ -125,8 +99,7 @@ class ExampleGroupItem extends TreeItem {
 class SQLExampleItem extends TreeItem {
   constructor(example: SQLExample) {
     super(example.name, TreeItemCollapsibleState.None);
-
-    this.iconPath = new ThemeIcon(`file`);
+    this.iconPath = ThemeIcon.File;
 
     this.tooltip = new MarkdownString(['```sql', example.content.join(`\n`), '```'].join(`\n`));
 
@@ -142,11 +115,11 @@ function exampleWorksForOnOS(example: SQLExample): boolean {
   if (OSData) {
     const myOsVersion = OSData.version;
 
-    // If this example has specific system requirements defined..
-    if (example.requirements && example.requirements[myOsVersion]) {
-      if (OSData.db2Level < example.requirements[myOsVersion]) {
-        return false;
-      }
+    // If this example has specific system requirements defined
+    if (example.requirements &&
+      example.requirements[myOsVersion] &&
+      OSData.db2Level < example.requirements[myOsVersion]) {
+      return false;
     }
   }
 

src/views/examples/exampleBrowser.ts

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