Disk usage upgrades (#433)

* feat(vscode-disk-usage): log tenant plan

* feat: disk usage monitor more sub-folders

Author: bd82

.changeset/odd-dingos-rhyme.md

@@ -0,0 +1,5 @@
+---
+"vscode-disk-usage": minor
+---
+
+additional sub-folders and pack info

packages/vscode-disk-usage/src/flows/run-reports.ts

@@ -1,5 +1,9 @@
 import type { DiskUsageReport } from "../types";
-import { getTenantPlan, getWsID } from "../helper-logic/constants";
+import {
+  getTenantPlan,
+  getTenantPack,
+  getWsID,
+} from "../helper-logic/constants";
 import { knownTechnicalFoldersReport } from "../reports/known-home-folders";
 import { allVscodeJavaRedHatReport } from "../reports/all-vscode-java-redhat";
 import { allNodeModulesReport } from "../reports/all-node-modules";
@@ -17,6 +21,7 @@ async function runReports(homeFolder: string): Promise<DiskUsageReport> {
     timestamp: new Date().getTime(),
     workspaceId: getWsID(),
     tenantPlan: getTenantPlan(),
+    tenantPack: getTenantPack(),
     allJavaRedHat: allJavaRedHat,
     allNodeModules: allNodeModules,
     allNoneHidden: allNoneHidden,

packages/vscode-disk-usage/src/helper-logic/constants.ts

@@ -1,4 +1,10 @@
-export { HOME_DIR, DISK_USAGE_TIMESTAMP, getWsID, getTenantPlan };
+export {
+  HOME_DIR,
+  DISK_USAGE_TIMESTAMP,
+  getWsID,
+  getTenantPlan,
+  getTenantPack,
+};
 
 // "~" did not work perfectly for all shell commands
 // using `/` is safe as this extension is only meant to run under linux
@@ -16,3 +22,9 @@ function getTenantPlan(): string {
   const plan = tenantPlanRaw ? tenantPlanRaw.replace("plan-", "") : "unknown";
   return plan;
 }
+
+function getTenantPack(): string {
+  const tenantPackRaw = process.env.TENANT_PACK;
+  const pack = tenantPackRaw ? tenantPackRaw : "unknown";
+  return pack;
+}

packages/vscode-disk-usage/src/reports/known-home-folders.ts

@@ -17,14 +17,25 @@ async function knownTechnicalFoldersReport(
     dot: -1,
     projects: -1,
     dot_ui5: -1,
+    // this `/` is safe because this code is only meant to run on linux
+    "dot_ui5/framework": -1,
     dot_continue: -1,
     dot_m2: -1,
+    dot_npm: -1,
     dot_node_modules_global: -1,
+    dot_asdf: -1,
     "dot_asdf-inst": -1,
     dot_nvm: -1,
     "dot_vscode-server": -1,
+    dot_vscode: -1,
     dot_fioritools: -1,
     dot_yarn: -1,
+    dot_hanatools: -1,
+    dot_cache: -1,
+    dot_mscan: -1,
+    dot_hdb: -1,
+    dot_local: -1,
+    dot_notary: -1,
   };
 
   for (const [reportFolderKey] of Object.entries(report)) {

packages/vscode-disk-usage/src/types.ts

@@ -8,6 +8,7 @@ export type DiskUsageReport = {
   timestamp: number;
   workspaceId: string;
   tenantPlan: string;
+  tenantPack: string;
   // Size (recursive) of all `node_modules` folders in the home folder:
   allNodeModules: number;
   // Size of none hidden (dot) folders in `home/user`
@@ -24,12 +25,22 @@ export type KnownHomeFoldersReport = {
   dot: number;
   projects: number;
   dot_ui5: number;
+  "dot_ui5/framework": number;
   dot_continue: number;
   dot_m2: number;
+  dot_npm: number;
   dot_node_modules_global: number;
+  dot_asdf: number;
   "dot_asdf-inst": number;
   dot_nvm: number;
   "dot_vscode-server": number;
+  dot_vscode: number;
   dot_fioritools: number;
   dot_yarn: number;
+  dot_hanatools: number;
+  dot_cache: number;
+  dot_mscan: number;
+  dot_hdb: number;
+  dot_local: number;
+  dot_notary: number;
 };

packages/vscode-disk-usage/test/helper-logic/constants.spec.ts

@@ -1,5 +1,9 @@
 import { expect } from "chai";
-import { getWsID, getTenantPlan } from "../../src/helper-logic/constants";
+import {
+  getWsID,
+  getTenantPlan,
+  getTenantPack,
+} from "../../src/helper-logic/constants";
 
 describe("Constants module", () => {
   context("getWsID function", () => {
@@ -41,4 +45,24 @@ describe("Constants module", () => {
       expect(getTenantPlan()).to.equal("abc123");
     });
   });
+
+  context("getTenantPack function", () => {
+    const orgTenantPlan = process.env["TENANT_PACK"];
+    before(() => {
+      delete process.env["TENANT_PACK"];
+    });
+
+    after(() => {
+      process.env["TENANT_PACK"] = orgTenantPlan;
+    });
+
+    it("should return `unknown` pack when no `TENANT_PACK` env variable set", () => {
+      expect(getTenantPack()).to.equal("unknown");
+    });
+
+    it("should return the actual pack when `TENANT_PACK` env variable is set", () => {
+      process.env["TENANT_PACK"] = "pack-abc123";
+      expect(getTenantPack()).to.equal("pack-abc123");
+    });
+  });
 });