Fetch summary

Author: patrick91

src/core/api.ts

@@ -1,33 +1,38 @@
 import { getCache } from "../cache";
-import { fetchLatestVersion } from "./pypi";
+import { fetchLibrary } from "./pypi";
 
 const ONE_HOUR = 60 * 60 * 1000;
+const CACHE_PREFIX = "v1";
 
-export const getVersion = async (library: string) => {
+const getCacheKey = (library: string) => `${CACHE_PREFIX}-${library}`;
+
+export const getInfo = async (
+    library: string,
+): Promise<{ version: string; summary: string }> => {
     const cache = getCache();
+    const key = getCacheKey(library);
 
-    const info = cache.get(library, null);
+    let info = cache.get(key, null);
 
     if (info) {
-        const { version, date } = JSON.parse(info);
-        const parsedDate = new Date(date);
+        const data = JSON.parse(info);
+        const parsedDate = new Date(data.date);
 
         if (new Date().getTime() - parsedDate.getTime() < ONE_HOUR) {
-            console.log("Not fetching new value for", library);
+            console.info("Not fetching new value for", library);
 
-            return version;
+            return data.info;
         }
     }
 
-    const version = await fetchLatestVersion(library);
+    const data = await fetchLibrary(library);
+
+    info = {
+        version: data.info.version as string,
+        summary: data.info.summary as string,
+    };
 
-    await cache.put(
-        library,
-        JSON.stringify({
-            version,
-            date: new Date(),
-        }),
-    );
+    await cache.put(key, JSON.stringify({ info, date: new Date() }));
 
-    return version;
+    return info;
 };

src/core/decorations.ts

@@ -2,12 +2,9 @@ import { MarkdownString, Position, Range, ThemeColor } from "vscode";
 import { Dependency } from "../types";
 
 export const getDecoration = (dep: Dependency) => {
-    const message = new MarkdownString(
-        `**this is a new update lololol**`,
-        true,
-    );
+    const message = new MarkdownString(`**${dep.name}**`, true);
     message.appendText("\n");
-    message.appendMarkdown("$(globe)");
+    message.appendMarkdown(dep.summary || "No information for this library");
     message.isTrusted = true;
 
     const prefix = dep.version.latest === dep.version.installed ? "✅" : "⚠️";

src/core/listener.ts

@@ -2,7 +2,7 @@ import { TextEditor, window, TextEditorDecorationType } from "vscode";
 import { Dependency } from "../types";
 import { findDependencies } from "../utils/parsing";
 import { getInstalledVersions } from "./poetry";
-import { getVersion } from "./api";
+import { getInfo } from "./api";
 import { getDecoration } from "./decorations";
 import { dirname } from "path";
 
@@ -14,10 +14,11 @@ const updateVersions = (
 ) => {
     return Promise.all(
         deps.map(async (dep) => {
-            const version = await getVersion(dep.name);
+            const info = await getInfo(dep.name);
 
             dep.version.installed = installedVersions[dep.name];
-            dep.version.latest = version;
+            dep.version.latest = info.version;
+            dep.summary = info.summary;
         }),
     );
 };

src/core/pypi.ts

@@ -1,8 +1,7 @@
 import fetch from "node-fetch";
 
-export const fetchLatestVersion = async (library: string) => {
+export const fetchLibrary = async (library: string) => {
     const x = await fetch(`https://pypi.org/pypi/${library}/json`);
-    const data = await x.json();
 
-    return (data.info?.version as string) ?? "unknown";
+    return await x.json();
 };

src/types.ts

@@ -5,6 +5,7 @@ export type Dependency = {
         installed?: string;
         latest?: string;
     };
+    summary?: string;
     line: number;
     rawText: string;
 };