@azure/msal-node-extensions 1.0.0-alpha.3 → 1.0.0-alpha.31

package/src/utils/Environment.ts

@@ -0,0 +1,101 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import path from "path";
+import { Constants, Platform } from "./Constants";
+import { PersistenceError } from "../error/PersistenceError";
+import { StringUtils } from "@azure/msal-common";
+
+export class Environment {
+    static get homeEnvVar(): string {
+        return this.getEnvironmentVariable(Constants.ENVIRONMENT.HOME);
+    }
+    
+    static get lognameEnvVar(): string {
+        return this.getEnvironmentVariable(Constants.ENVIRONMENT.LOGNAME);
+    }
+
+    static get userEnvVar(): string {
+        return this.getEnvironmentVariable(Constants.ENVIRONMENT.USER);
+    }
+
+    static get lnameEnvVar(): string {
+        return this.getEnvironmentVariable(Constants.ENVIRONMENT.LNAME);
+    }
+
+    static get usernameEnvVar(): string {
+        return this.getEnvironmentVariable(Constants.ENVIRONMENT.USERNAME);
+    }
+
+    static getEnvironmentVariable(name: string): string {
+        return process.env[name];
+    }
+
+    static getEnvironmentPlatform(): string {
+        return process.platform;
+    }
+
+    static isWindowsPlatform(): boolean {
+        return this.getEnvironmentPlatform() === Platform.WINDOWS;
+    }
+
+    static isLinuxPlatform(): boolean {
+        return this.getEnvironmentPlatform() === Platform.LINUX;
+    }
+
+    static isMacPlatform(): boolean {
+        return this.getEnvironmentPlatform() === Platform.MACOS;
+    }
+
+    static isLinuxRootUser(): boolean {
+        return process.getuid() === Constants.LINUX_ROOT_USER_GUID;
+    }
+
+    static getUserRootDirectory(): string {
+        return !this.isWindowsPlatform ?
+            this.getUserHomeDirOnUnix() :
+            this.getUserHomeDirOnWindows();
+    }
+
+    static getUserHomeDirOnWindows(): string {
+        return this.getEnvironmentVariable(Constants.ENVIRONMENT.LOCAL_APPLICATION_DATA);
+    }
+
+    static getUserHomeDirOnUnix(): string | null {
+        if (this.isWindowsPlatform()) {
+            throw PersistenceError.createNotSupportedError(
+                "Getting the user home directory for unix is not supported in windows");
+        }
+
+        if (!StringUtils.isEmpty(this.homeEnvVar)) {
+            return this.homeEnvVar;
+        }
+
+        let username = null;
+        if (!StringUtils.isEmpty(this.lognameEnvVar)) {
+            username = this.lognameEnvVar;
+        } else if (!StringUtils.isEmpty(this.userEnvVar)) {
+            username = this.userEnvVar;
+        } else if (!StringUtils.isEmpty(this.lnameEnvVar)) {
+            username = this.lnameEnvVar;
+        } else if (!StringUtils.isEmpty(this.usernameEnvVar)) {
+            username = this.usernameEnvVar;
+        }
+
+        if (this.isMacPlatform()) {
+            return !StringUtils.isEmpty(username) ? path.join("/Users", username) : null;
+        } else if (this.isLinuxPlatform()) {
+            if (this.isLinuxRootUser()) {
+                return "/root";
+            } else {
+                return !StringUtils.isEmpty(username) ? path.join("/home", username) : null;
+            }
+        } else {
+            throw PersistenceError.createNotSupportedError(
+                "Getting the user home directory for unix is not supported in windows");
+        }
+
+    }
+}

package/CHANGELOG.json

@@ -1,50 +0,0 @@
-{
-  "name": "@azure/msal-node-extensions",
-  "entries": [
-    {
-      "date": "Wed, 23 Sep 2020 21:13:48 GMT",
-      "tag": "@azure/msal-node-extensions_v1.0.0-alpha.3",
-      "version": "1.0.0-alpha.3",
-      "comments": {
-        "prerelease": [
-          {
-            "comment": "Update error message (#2265)",
-            "author": "sagonzal@microsoft.com",
-            "commit": "81d044a2a4640ebfa8b3bd80cb30cc2c602bbef1",
-            "package": "@azure/msal-node-extensions"
-          }
-        ]
-      }
-    },
-    {
-      "date": "Thu, 17 Sep 2020 23:16:22 GMT",
-      "tag": "@azure/msal-node-extensions_v1.0.0",
-      "version": "1.0.0-alpha.2",
-      "comments": {
-        "none": [
-          {
-            "comment": "Update msal-node-extensionst to use central eslint configuration",
-            "author": "janutter@microsoft.com",
-            "commit": "fc49c6f16b3f7a62a67d249107fc484272133305",
-            "package": "@azure/msal-node-extensions"
-          }
-        ]
-      }
-    },
-    {
-      "date": "Thu, 13 Aug 2020 02:20:48 GMT",
-      "tag": "@azure/msal-node-extensions_v1.0.0-alpha.2",
-      "version": "1.0.0-alpha.2",
-      "comments": {
-        "none": [
-          {
-            "comment": "updating files for automated release steps",
-            "author": "prkanher@microsoft.com",
-            "commit": "791409e7c9975218ae2b3a91e6a6a190b59474b1",
-            "package": "@azure/msal-node-extensions"
-          }
-        ]
-      }
-    }
-  ]
-}

package/changelog.md

@@ -1,28 +0,0 @@
-# Change Log - @azure/msal-node-extensions
-
-This log was last generated on Wed, 23 Sep 2020 21:13:48 GMT and should not be manually modified.
-
-<!-- Start content -->
-
-## 1.0.0-alpha.3
-
-Wed, 23 Sep 2020 21:13:48 GMT
-
-### Changes
-
-- Update error message (#2265) (sagonzal@microsoft.com)
-
-# 1.0.0-alpha.2
-- Fix issue where binding.gyp was not being uploaded to npm
-
-# 1.0.0-alpha.1
-- Increment @azure/msal-common version to 1.1.0
-
-# 1.0.0-alpha.0
-
-- Extensions 1: Sets directory structure, adds Windows DPAPI Node addon (#1830)
-- Extensions 2: Add cross process lock (#1831)
-- Extensions 3: Add cache persistence plugin, persistence on Windows, Linux, and Mac (#1832)
-- Extensions 4: Add sample (#1834)
-- Extensions 5: Add documentation, add logger (#1835)
-- Extensions 6: Add tests (#1849)