Merge pull request #680 from jpogran/maint-refactor-extensionts

jpogran · web-flow · commit 8dd1a817774c · 2020-06-10T21:05:43.000-04:00
(maint) Refactor Forge calls to API
diff --git a/src/extension.ts b/src/extension.ts
@@ -16,6 +16,7 @@ import { PuppetNodeGraphFeature } from './feature/PuppetNodeGraphFeature';
 import { PuppetResourceFeature } from './feature/PuppetResourceFeature';
 import { PuppetStatusBarFeature } from './feature/PuppetStatusBarFeature';
 import { UpdateConfigurationFeature } from './feature/UpdateConfigurationFeature';
+import { getPDKVersion } from './forge';
 import { ConnectionHandler } from './handler';
 import { StdioConnectionHandler } from './handlers/stdio';
 import { TcpConnectionHandler } from './handlers/tcp';
@@ -26,9 +27,6 @@ import { reporter } from './telemetry';
 import { PuppetFactsProvider } from './views/facts';
 import { PuppetfileProvider } from './views/puppetfile';
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const axios = require('axios');
-
 export const puppetLangID = 'puppet'; // don't change this
 export const puppetFileLangID = 'puppetfile'; // don't change this
 const debugType = 'Puppet'; // don't change this
@@ -287,11 +285,7 @@ async function notifyIfNewPDKVersion(context: vscode.ExtensionContext, settings:
     return;
   }
 
-  axios
-    .get('https://s3.amazonaws.com/puppet-pdk/pdk/LATEST')
-    .then((response) => {
-      return response.data;
-    })
+  getPDKVersion(logger)
     .then((latestVersion) => {
       if (version !== latestVersion) {
         return vscode.window.showWarningMessage(
diff --git a/src/feature/FormatDocumentFeature.ts b/src/feature/FormatDocumentFeature.ts
@@ -1,12 +1,13 @@
 'use strict';
 
 import * as vscode from 'vscode';
+import { IAggregateConfiguration } from '../configuration';
 import { IFeature } from '../feature';
-import { ILogger } from '../logging';
+import { ConnectionHandler } from '../handler';
 import { ConnectionStatus } from '../interfaces';
+import { ILogger } from '../logging';
 import * as messages from '../messages';
-import { ConnectionHandler } from '../handler';
-import { IAggregateConfiguration } from '../configuration';
+import { reporter } from '../telemetry';
 
 class RequestParams implements messages.PuppetFixDiagnosticErrorsRequestParams {
   documentUri: string;
@@ -32,6 +33,10 @@ class FormatDocumentProvider {
       return [];
     }
 
+    if (reporter) {
+      reporter.sendTelemetryEvent('puppet/FormatDocument');
+    }
+
     const requestParams = new RequestParams();
     requestParams.documentUri = document.uri.toString(false);
     requestParams.alwaysReturnContent = false;
diff --git a/src/feature/PuppetModuleHoverFeature.ts b/src/feature/PuppetModuleHoverFeature.ts
@@ -1,7 +1,9 @@
 import { getLocation } from 'jsonc-parser';
 import * as vscode from 'vscode';
 import { IFeature } from '../feature';
+import { buildMarkdown, getModuleInfo } from '../forge';
 import { ILogger } from '../logging';
+import { reporter } from '../telemetry';
 
 export class PuppetModuleHoverFeature implements IFeature {
   constructor(public context: vscode.ExtensionContext, public logger: ILogger) {
@@ -17,11 +19,11 @@ export class PuppetModuleHoverFeature implements IFeature {
 export class PuppetModuleHoverProvider implements vscode.HoverProvider {
   constructor(public logger: ILogger) {}
 
-  provideHover(
+  async provideHover(
     document: vscode.TextDocument,
     position: vscode.Position,
     token: vscode.CancellationToken,
-  ): Thenable<vscode.Hover> | null {
+  ): Promise<vscode.Hover> | null {
     const offset = document.offsetAt(position);
     const location = getLocation(document.getText(), offset);
 
@@ -37,56 +39,20 @@ export class PuppetModuleHoverProvider implements vscode.HoverProvider {
       return;
     }
 
+    if (reporter) {
+      reporter.sendTelemetryEvent('metadataJSON/Hover');
+    }
+
     const range = document.getWordRangeAtPosition(position);
     const word = document.getText(range);
 
     this.logger.debug('Metadata hover info found ' + word + ' module');
 
     const name = word.replace('"', '').replace('"', '').replace('/', '-');
 
-    return this.getModuleInfo(name).then(function (result: any) {
-      const msg: string[] = [];
-      msg.push(`### ${result.slug}`);
-
-      const releaseDate = new Date(result.releases[0].created_at);
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
-      const dateformat = require('dateformat');
-      msg.push(`\nLatest version: ${result.releases[0].version} (${dateformat(releaseDate, 'dS mmmm yyyy')})`);
-
-      if (result.endorsement !== null) {
-        const endorsementCapitalized = result.endorsement.charAt(0).toUpperCase() + result.endorsement.slice(1);
-        msg.push(`\nEndorsement: ${endorsementCapitalized}`);
-      }
-
-      msg.push(`\nOwner: ${result.owner.slug}`);
-
-      const forgeUri = `https://forge.puppet.com/${result.owner.username}/${result.name}`;
-      msg.push(`\nForge: [${forgeUri}](${forgeUri})\n`);
-
-      if (result.homepage_url !== null) {
-        msg.push(`\nProject: [${result.homepage_url}](${result.homepage_url})\n`);
-      }
-
-      const md = msg.join('\n');
-
-      return Promise.resolve(new vscode.Hover(new vscode.MarkdownString(md), range));
-    });
-  }
-
-  private getModuleInfo(name: string) {
-    const options = {
-      url: `https://forgeapi.puppet.com/v3/modules/${name}?exclude_fields=readme%20changelog%20license%20reference`,
-    };
-    return new Promise(function (resolve, reject) {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
-      const request = require('request');
-      request.get(options, function (err, resp, body) {
-        if (err) {
-          reject(err);
-        } else {
-          resolve(JSON.parse(body));
-        }
-      });
-    });
+    const info = await getModuleInfo(name, this.logger);
+    const markdown = buildMarkdown(info);
+    const hoverinfo = new vscode.Hover(markdown, range);
+    return hoverinfo;
   }
 }
diff --git a/src/feature/PuppetfileHoverFeature.ts b/src/feature/PuppetfileHoverFeature.ts
@@ -1,24 +1,9 @@
 // const axios = require('axios');
-import axios from 'axios';
 import * as vscode from 'vscode';
 import { IFeature } from '../feature';
+import { buildMarkdown, getModuleInfo } from '../forge';
 import { ILogger } from '../logging';
-
-interface PuppetForgeModuleInfo {
-  uri: string;
-  slug: string;
-  name: string;
-  downloads: number;
-  score: number;
-  created: Date;
-  updated: Date;
-  endorsement: string;
-  owner: { slug: string; username: string };
-  forgeUrl: string;
-  homepageUrl: string;
-  version: number;
-  summary: string;
-}
+import { reporter } from '../telemetry';
 
 class PuppetfileHoverProvider implements vscode.HoverProvider {
   constructor(public readonly logger: ILogger) {}
@@ -38,81 +23,22 @@ class PuppetfileHoverProvider implements vscode.HoverProvider {
       return null;
     }
 
+    if (reporter) {
+      reporter.sendTelemetryEvent('puppetfile/Hover');
+    }
+
     const text = line.text
       .replace(new RegExp('mod\\s+'), '')
       .replace(new RegExp(",\\s+'\\d.\\d.\\d\\'"), '')
       .replace(new RegExp(',\\s+:latest'), '')
       .replace("'", '')
       .replace("'", '');
 
-    const info = await this.getModuleInfo(text);
-    const markdown = this.buildmarkdown(info);
+    const info = await getModuleInfo(text, this.logger);
+    const markdown = buildMarkdown(info);
     const hoverinfo = new vscode.Hover(markdown, range);
     return hoverinfo;
   }
-
-  private buildmarkdown(info: PuppetForgeModuleInfo): vscode.MarkdownString {
-    const message = `## ${info.name}\n
-${info.summary}\n
-**Latest version:** ${info.version} (${info.created.toDateString()})\n
-**Forge**: [${info.forgeUrl}](${info.forgeUrl})\n
-**Project**: [${info.homepageUrl}](${info.homepageUrl})\n
-**Owner:** ${info.owner.username}\n
-**Endorsement:** ${info.endorsement?.toLocaleUpperCase()}\n
-**Score:** ${info.score}\n
-`;
-    return new vscode.MarkdownString(message);
-  }
-
-  private getModuleInfo(title: string): Promise<PuppetForgeModuleInfo> {
-    return new Promise((resolve) => {
-      return axios
-        .get(`https://forgeapi.puppet.com/v3/modules/${title}`, {
-          params: {
-            // eslint-disable-next-line @typescript-eslint/camelcase
-            exclude_fields: 'readme changelog license reference',
-          },
-          headers: {
-            'Content-Type': 'application/json;charset=UTF-8',
-            'User-Agent': 'puppet-vscode/0.27.0',
-          },
-        })
-        .then((response) => {
-          if (response.status !== 200) {
-            this.logger.error(`Error getting Puppet forge data. Status: ${response.status}:${response.statusText}`);
-            resolve();
-          }
-
-          const info = response.data;
-          const module = {
-            uri: info.uri,
-            slug: info.slug,
-            name: info.name,
-            downloads: info.downloads,
-            score: info.feedback_score,
-            created: new Date(info.created_at),
-            updated: new Date(info.updated_at),
-            endorsement: info.endorsement ?? '',
-            forgeUrl: `https://forge.puppet.com/${info.owner.username}/${info.name}`,
-            homepageUrl: info.homepage_url ?? '',
-            version: info.current_release.version,
-            owner: {
-              uri: info.owner.uri,
-              slug: info.owner.slug,
-              username: info.owner.username,
-              gravatar: info.owner.gravatar_id,
-            },
-            summary: info.current_release.metadata.summary,
-          };
-
-          resolve(module);
-        })
-        .catch((error) => {
-          this.logger.error(`Error getting Puppet forge data: ${error}`);
-          resolve();
-        });
-    });
-  }
 }
 
 export class PuppetfileHoverFeature implements IFeature {
diff --git a/src/forge.ts b/src/forge.ts
@@ -0,0 +1,105 @@
+import axios from 'axios';
+import { MarkdownString } from 'vscode';
+import { ILogger } from './logging';
+
+export interface PuppetForgeModuleInfo {
+  uri: string;
+  slug: string;
+  name: string;
+  downloads: number;
+  score: number;
+  created: Date;
+  updated: Date;
+  endorsement: string;
+  owner: { slug: string; username: string };
+  forgeUrl: string;
+  homepageUrl: string;
+  version: number;
+  summary: string;
+}
+
+export function buildMarkdown(info: PuppetForgeModuleInfo): MarkdownString {
+  const message = `## ${info.name}\n
+${info.summary}\n
+**Latest version:** ${info.version} (${info.created.toDateString()})\n
+**Forge**: [${info.forgeUrl}](${info.forgeUrl})\n
+**Project**: [${info.homepageUrl}](${info.homepageUrl})\n
+**Owner:** ${info.owner.username}\n
+**Endorsement:** ${info.endorsement?.toLocaleUpperCase()}\n
+**Score:** ${info.score}\n
+`;
+  return new MarkdownString(message);
+}
+
+export function getPDKVersion(logger: ILogger): Promise<string> {
+  return new Promise((resolve) => {
+    return axios
+      .get('https://s3.amazonaws.com/puppet-pdk/pdk/LATEST', {
+        params: {
+          // eslint-disable-next-line @typescript-eslint/camelcase
+          exclude_fields: 'readme changelog license reference',
+        },
+        headers: {
+          'Content-Type': 'application/json;charset=UTF-8',
+          'User-Agent': 'puppet-vscode/0.27.1',
+        },
+      })
+      .then((response) => {
+        if (response.status !== 200) {
+          logger.error(`Error getting Puppet forge data. Status: ${response.status}:${response.statusText}`);
+          resolve();
+        }
+        return response.data;
+      });
+  });
+}
+
+export function getModuleInfo(title: string, logger: ILogger): Promise<PuppetForgeModuleInfo> {
+  return new Promise((resolve) => {
+    return axios
+      .get(`https://forgeapi.puppet.com/v3/modules/${title}`, {
+        params: {
+          // eslint-disable-next-line @typescript-eslint/camelcase
+          exclude_fields: 'readme changelog license reference',
+        },
+        headers: {
+          'Content-Type': 'application/json;charset=UTF-8',
+          'User-Agent': 'puppet-vscode/0.27.1',
+        },
+      })
+      .then((response) => {
+        if (response.status !== 200) {
+          logger.error(`Error getting Puppet forge data. Status: ${response.status}:${response.statusText}`);
+          resolve();
+        }
+
+        const info = response.data;
+        const module = {
+          uri: info.uri,
+          slug: info.slug,
+          name: info.name,
+          downloads: info.downloads,
+          score: info.feedback_score,
+          created: new Date(info.created_at),
+          updated: new Date(info.updated_at),
+          endorsement: info.endorsement ?? '',
+          forgeUrl: `https://forge.puppet.com/${info.owner.username}/${info.name}`,
+          homepageUrl: info.homepage_url ?? '',
+          version: info.current_release.version,
+          owner: {
+            uri: info.owner.uri,
+            slug: info.owner.slug,
+            username: info.owner.username,
+            gravatar: info.owner.gravatar_id,
+          },
+          summary: info.current_release.metadata.summary,
+        };
+
+        resolve(module);
+      })
+      .catch((error) => {
+        logger.error(`Error getting Puppet forge data: ${error}`);
+        resolve();
+      });
+  });
+}
