@lage-run/cache 1.1.7 → 1.3.0

package/CHANGELOG.json

@@ -2,7 +2,37 @@
   "name": "@lage-run/cache",
   "entries": [
     {
-      "date": "Thu, 23 May 2024 18:14:47 GMT",
+      "date": "Tue, 18 Jun 2024 00:31:16 GMT",
+      "version": "1.3.0",
+      "tag": "@lage-run/cache_v1.3.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "brunoru@microsoft.com",
+            "package": "@lage-run/cache",
+            "commit": "e937af3a04e0af29a2ad36e57b2f4169d4d5c628",
+            "comment": "Default fallback with optional pre-set credentials"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Mon, 10 Jun 2024 23:50:39 GMT",
+      "version": "1.2.0",
+      "tag": "@lage-run/cache_v1.2.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "brunoru@microsoft.com",
+            "package": "@lage-run/cache",
+            "commit": "0894d97ebfedc339b77161c40fa8643d93e4486d",
+            "comment": "Add support for DefaultAzureCredentials when storage endpoint is passed in."
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 23 May 2024 18:15:05 GMT",
       "version": "1.1.7",
       "tag": "@lage-run/cache_v1.1.7",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,28 @@
 # Change Log - @lage-run/cache
 
-This log was last generated on Thu, 23 May 2024 18:14:47 GMT and should not be manually modified.
+This log was last generated on Tue, 18 Jun 2024 00:31:16 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.3.0
+
+Tue, 18 Jun 2024 00:31:16 GMT
+
+### Minor changes
+
+- Default fallback with optional pre-set credentials (brunoru@microsoft.com)
+
+## 1.2.0
+
+Mon, 10 Jun 2024 23:50:39 GMT
+
+### Minor changes
+
+- Add support for DefaultAzureCredentials when storage endpoint is passed in. (brunoru@microsoft.com)
+
 ## 1.1.7
 
-Thu, 23 May 2024 18:14:47 GMT
+Thu, 23 May 2024 18:15:05 GMT
 
 ### Patches
 

package/README.md

@@ -32,7 +32,7 @@ const remoteFallbackCacheProviderOptions = {
       cacheStorageOptions: {
         provider: "azure-blob",
         options: {
-          connectionString: "asdfasdfasdfafds";
+          connectionString: "asdfasdfasdfafds"; // Providing an un-authenitcated Blob Service Endpoint will force use of Azure DefualtAzureCredentials
           container: "container";
           maxSize?: 150;
         }

package/lib/CredentialCache.d.ts

@@ -0,0 +1,5 @@
+import { DefaultAzureCredential } from "@azure/identity";
+export declare class CredentialCache {
+    private static credential;
+    static getInstance(): DefaultAzureCredential;
+}

package/lib/CredentialCache.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "CredentialCache", {
+    enumerable: true,
+    get: function() {
+        return CredentialCache;
+    }
+});
+const _identity = require("@azure/identity");
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+class CredentialCache {
+    static getInstance() {
+        if (!this.credential) {
+            this.credential = new _identity.DefaultAzureCredential();
+        }
+        return this.credential;
+    }
+}
+_define_property(CredentialCache, "credential", null);

package/lib/backfillWrapper.d.ts

@@ -1,11 +1,12 @@
 /**
  * Backfill wrappers: some functions that uses the `backfill` library that doesn't require them to be inside a class
  */
+import { CacheStorageConfig } from "backfill-config";
 import type { Logger as BackfillLogger } from "backfill-logger";
 import type { CacheOptions } from "./types/CacheOptions.js";
 export declare function createBackfillLogger(): BackfillLogger;
 export declare function createBackfillCacheConfig(cwd: string, cacheOptions: Partial<CacheOptions> | undefined, backfillLogger: BackfillLogger): {
-    cacheStorageConfig: import("backfill-config").CacheStorageConfig;
+    cacheStorageConfig: CacheStorageConfig;
     clearOutput: boolean;
     internalCacheFolder: string;
     logFolder: string;

package/lib/backfillWrapper.js

@@ -21,6 +21,7 @@ _export(exports, {
 const _os = /*#__PURE__*/ _interop_require_wildcard(require("os"));
 const _backfillconfig = require("backfill-config");
 const _backfilllogger = require("backfill-logger");
+const _CredentialCache = require("./CredentialCache.js");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -79,9 +80,32 @@ function createBackfillLogger() {
 }
 function createBackfillCacheConfig(cwd, cacheOptions = {}, backfillLogger) {
     const envConfig = (0, _backfillconfig.getEnvConfig)(backfillLogger);
-    return {
+    // To avoid weakmap issues, we need to store the credential and restore post-merge
+    const credentialStash = getCredentialStash(cacheOptions);
+    const mergedConfig = {
         ...(0, _backfillconfig.createDefaultConfig)(cwd),
         ...cacheOptions,
         ...envConfig
     };
+    applyCredentialStashToMergedConfig(mergedConfig, credentialStash);
+    return mergedConfig;
+}
+function getCredentialStash(cacheOptions) {
+    if (cacheOptions.cacheStorageConfig && cacheOptions.cacheStorageConfig.provider === "azure-blob" && cacheOptions.cacheStorageConfig.options.credential) {
+        const stashedCredential = cacheOptions.cacheStorageConfig.options.credential;
+        delete cacheOptions.cacheStorageConfig.options.credential;
+        return stashedCredential;
+    }
+    return null;
+}
+function applyCredentialStashToMergedConfig(mergedConfig, credentialStash) {
+    if (mergedConfig.cacheStorageConfig.provider === "azure-blob") {
+        const connectionString = mergedConfig.cacheStorageConfig.options.connectionString;
+        if (connectionString && !isTokenConnectionString(connectionString)) {
+            mergedConfig.cacheStorageConfig.options.credential = credentialStash || _CredentialCache.CredentialCache.getInstance();
+        }
+    }
+}
+function isTokenConnectionString(connectionString) {
+    return connectionString.includes("SharedAccessSignature");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lage-run/cache",
-  "version": "1.1.7",
+  "version": "1.3.0",
   "description": "Cache for Lage",
   "repository": {
     "type": "git",
@@ -17,6 +17,7 @@
     "lint": "monorepo-scripts lint"
   },
   "dependencies": {
+    "@azure/identity": "^4.0.1",
     "@lage-run/target-graph": "^0.8.9",
     "@lage-run/logger": "^1.3.0",
     "backfill-cache": "5.8.0",