office-addin-usage-data/src/usageDataSettings.ts

Provides infrastructure to send usage data events and exceptions.

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

import fs from "fs";
import * as defaults from "./defaults";
import { UsageDataLevel } from "./usageData";
import { v4 as uuidv4 } from "uuid";

/**
 * Allows developer to check if the program has already prompted before
 * @param groupName Group name of the usage data object
 * @returns Boolean of whether the program should prompt
 */
export function needToPromptForUsageData(groupName: string): boolean {
  return !groupNameExists(groupName);
}

/**
 * Allows developer to add or modify a specific property to the group
 * @param groupName Group name of property
 * @param property Property that will be created or modified
 * @param value Property's value that will be assigned
 */
export function modifyUsageDataJsonData(groupName: string, property: any, value: any): void {
  try {
    if (readUsageDataJsonData()) {
      const usageDataJsonData = readUsageDataJsonData();
      if (!groupNameExists(groupName)) {
        usageDataJsonData.usageDataInstances[groupName] = {
          usageDataLevel: String,
        };
      }
      usageDataJsonData.usageDataInstances[groupName][property] = value;
      if (!usageDataJsonData.usageDataInstances["deviceID"]) {
        usageDataJsonData.usageDataInstances["deviceID"] = uuidv4();
      }
      fs.writeFileSync(defaults.usageDataJsonFilePath, JSON.stringify(usageDataJsonData, null, 2));
    } else {
      let usageDataJsonData = {};
      usageDataJsonData[groupName] = value;
      usageDataJsonData = { usageDataInstances: usageDataJsonData };
      usageDataJsonData = {
        usageDataInstances: { [groupName]: { [property]: value }, deviceID: uuidv4() },
      };
      fs.writeFileSync(defaults.usageDataJsonFilePath, JSON.stringify(usageDataJsonData, null, 2));
    }
  } catch (err) {
    throw new Error(err);
  }
}
/**
 * Returns the session identifier
 * @returns The uuid of the session identifier
 */
export function readDeviceID(): string {
  const jsonData = readUsageDataJsonData();
  return jsonData?.usageDataInstances.deviceID ?? "";
}
/**
 * Reads data from the usage data json config file
 * @returns Parsed object from json file if it exists
 */
export function readUsageDataJsonData(): any {
  if (fs.existsSync(defaults.usageDataJsonFilePath)) {
    const jsonData = fs.readFileSync(defaults.usageDataJsonFilePath, "utf8");
    return JSON.parse(jsonData.toString());
  }
}
/**
 * Returns whether usage data is enabled on the usage data object
 * @param groupName Group name to search for in the specified json data
 * @returns Whether usage data is enabled specific to the group name
 */
export function readUsageDataLevel(groupName: string): UsageDataLevel {
  const jsonData = readUsageDataJsonData();
  return jsonData.usageDataInstances[groupName].usageDataLevel;
}
/**
 * Returns whether usage data is enabled on the usage data object
 * @param groupName Group name to search for in the specified json data
 * @param propertyName Property name that will be used to access and return the associated value
 * @returns Property of the specific group name
 */
export function readUsageDataObjectProperty(groupName: string, propertyName: string): any {
  const jsonData = readUsageDataJsonData();
  return jsonData.usageDataInstances[groupName][propertyName];
}
/**
 * Writes to usage data config file either appending to already existing file or creating new file
 * @param groupName Group name of usage data object
 * @param level usageDataLevel Whether user is sending none or full usage data
 */

export function writeUsageDataJsonData(groupName: string, level: UsageDataLevel): void {
  if (
    fs.existsSync(defaults.usageDataJsonFilePath) &&
    fs.readFileSync(defaults.usageDataJsonFilePath, "utf8") !== "" &&
    fs.readFileSync(defaults.usageDataJsonFilePath, "utf8") !== "undefined"
  ) {
    if (groupNameExists(groupName)) {
      modifyUsageDataJsonData(groupName, "usageDataLevel", level);
    } else {
      const usageDataJsonData = readUsageDataJsonData();
      usageDataJsonData.usageDataInstances[groupName] = {
        usageDataLevel: String,
      };
      usageDataJsonData.usageDataInstances[groupName].usageDataLevel = level;
      if (!usageDataJsonData.usageDataInstances["deviceID"]) {
        usageDataJsonData.usageDataInstances["deviceID"] = uuidv4();
      }
      fs.writeFileSync(defaults.usageDataJsonFilePath, JSON.stringify(usageDataJsonData, null, 2));
    }
  } else {
    let usageDataJsonData = {};
    usageDataJsonData[groupName] = level;
    usageDataJsonData = { usageDataInstances: usageDataJsonData };
    usageDataJsonData = {
      usageDataInstances: { [groupName]: { ["usageDataLevel"]: level }, deviceID: uuidv4() },
    };

    fs.writeFileSync(defaults.usageDataJsonFilePath, JSON.stringify(usageDataJsonData, null, 2));
  }
}
/**
 * Checks to see if the given group name exists in the specified json data
 * @param groupName Group name to search for in the specified json data
 * @returns Boolean of whether group name exists
 */
export function groupNameExists(groupName: string): boolean {
  if (
    fs.existsSync(defaults.usageDataJsonFilePath) &&
    fs.readFileSync(defaults.usageDataJsonFilePath, "utf8") !== "" &&
    fs.readFileSync(defaults.usageDataJsonFilePath, "utf8") !== "undefined"
  ) {
    const jsonData = readUsageDataJsonData();
    return Object.getOwnPropertyNames(jsonData.usageDataInstances).includes(groupName);
  }
  return false;
}
/**
 * Reads usage data settings from the usage data json config file for a specific group
 * @returns Settings for the specified group
 */
export function readUsageDataSettings(groupName = defaults.groupName): object | undefined {
  if (fs.existsSync(defaults.usageDataJsonFilePath)) {
    return readUsageDataJsonData().usageDataInstances[groupName];
  } else {
    return undefined;
  }
}