Adding the SDK Binding Support for Storage Blob (#341)

* Adding SDK Binding for BlobTrigger

* Adding Supported Binding Types Enum

* Adding MI support

* Renaming and Creating a Factory for StorageBlobClient

* Adding support for input binding

* Adding unit tests

* Removing Log Statements

* Updating the package.json for sinon testing dependencies

* Original Without Singleton

* Moving the StorageClientFactory to extensions base

* Updating package.json

* Removing extra log

* Adding generic call to support deferred binding

* Code Review Comments

* Adding thje logs for Dashboard at function start

* Fixing Package-loc.json

* Fixing Linting issue and tests

* Ensure the release version is in the constant file

* Adding SDK Binding for BlobTrigger

* Adding Supported Binding Types Enum

* Adding MI support

* Renaming and Creating a Factory for StorageBlobClient

* Package.json conflict resolution

* Removing the unecessory log

* Removing  unecessory changes

* Removing AzuriteConfig

---------

Co-authored-by: Swapnil Nagar <swapnilnagar+microsoft@microsoft.com>

Author: swapnil-nagar

.vscode/launch.json

@@ -14,6 +14,15 @@
             "request": "launch",
             "skipFiles": ["<node_internals>/**"],
             "type": "pwa-node"
+        },
+        {
+            "name": "Current TS Tests File",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+            "args": ["-r", "ts-node/register", "${relativeFile}"],
+            "cwd": "${workspaceRoot}",
+            "protocol": "inspector"
         }
     ]
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@azure/functions",
-    "version": "4.7.0",
+    "version": "4.7.1-preview",
     "description": "Microsoft Azure Functions NodeJS Framework",
     "keywords": [
         "azure",
@@ -41,6 +41,7 @@
         "watch": "webpack --watch --mode development"
     },
     "dependencies": {
+        "@azure/functions-extensions-base": "0.1.0-preview",
         "cookie": "^0.7.0",
         "long": "^4.0.0",
         "undici": "^5.13.0"
@@ -55,6 +56,7 @@
         "@types/mocha": "^9.1.1",
         "@types/node": "^18.0.0",
         "@types/semver": "^7.3.9",
+        "@types/sinon": "^17.0.4",
         "@typescript-eslint/eslint-plugin": "^5.12.1",
         "@typescript-eslint/parser": "^5.12.1",
         "chai": "^4.2.0",
@@ -65,8 +67,8 @@
         "eslint-plugin-header": "^3.1.1",
         "eslint-plugin-import": "^2.29.0",
         "eslint-plugin-prettier": "^4.0.0",
-        "eslint-webpack-plugin": "^3.2.0",
         "eslint-plugin-simple-import-sort": "^10.0.0",
+        "eslint-webpack-plugin": "^3.2.0",
         "fork-ts-checker-webpack-plugin": "^7.2.13",
         "fs-extra": "^10.0.1",
         "globby": "^11.0.0",
@@ -76,9 +78,10 @@
         "mocha-multi-reporters": "^1.5.1",
         "prettier": "^2.4.1",
         "semver": "^7.3.5",
+        "sinon": "^20.0.0",
         "ts-loader": "^9.3.1",
         "ts-node": "^3.3.0",
-        "typescript": "^4.5.5",
+        "typescript": "^4.9.5",
         "typescript4": "npm:typescript@~4.0.0",
         "webpack": "^5.74.0",
         "webpack-cli": "^4.10.0"

package.json

@@ -82,11 +82,9 @@ export class InvocationModel implements coreTypes.InvocationModel {
                 } else {
                     input = fromRpcTypedData(binding.data);
                 }
-
                 if (isTimerTrigger(bindingType)) {
                     input = toCamelCaseValue(input);
                 }
-
                 if (isTrigger(bindingType)) {
                     inputs.push(input);
                 } else {

src/InvocationModel.ts

@@ -1,6 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License.
 
-export const version = '4.7.0';
+export const version = '4.7.1-preview';
 
 export const returnBindingKey = '$return';

src/constants.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 import { RpcTypedData } from '@azure/functions-core';
+import { ResourceFactoryResolver } from '@azure/functions-extensions-base';
 import { HttpRequest } from '../http/HttpRequest';
 import { isDefined } from '../utils/nonNull';
 
@@ -30,8 +31,18 @@ export function fromRpcTypedData(data: RpcTypedData | null | undefined): unknown
         return data.collectionDouble.double;
     } else if (data.collectionSint64 && isDefined(data.collectionSint64.sint64)) {
         return data.collectionSint64.sint64;
-    } else {
-        return undefined;
+    } else if (data.modelBindingData && isDefined(data.modelBindingData.content)) {
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+            const resourceFactoryResolver: ResourceFactoryResolver = ResourceFactoryResolver.getInstance();
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+            return resourceFactoryResolver.createClient(data.modelBindingData.source, data.modelBindingData);
+        } catch (exception) {
+            throw new Error(
+                'Unable to create client. Please register the extensions library with your function app. ' +
+                    `Error: ${exception instanceof Error ? exception.message : String(exception)}`
+            );
+        }
     }
 }
 

src/converters/fromRpcTypedData.ts

@@ -6,17 +6,19 @@ import * as coreTypes from '@azure/functions-core';
 import { returnBindingKey } from '../constants';
 import { AzFuncSystemError } from '../errors';
 import { isTrigger } from '../utils/isTrigger';
+import { workerSystemLog } from '../utils/workerSystemLog';
 import { toRpcDuration } from './toRpcDuration';
 
 export function toCoreFunctionMetadata(name: string, options: GenericFunctionOptions): coreTypes.FunctionMetadata {
     const bindings: Record<string, coreTypes.RpcBindingInfo> = {};
     const bindingNames: string[] = [];
-
     const trigger = options.trigger;
+
     bindings[trigger.name] = {
         ...trigger,
         direction: 'in',
         type: isTrigger(trigger.type) ? trigger.type : trigger.type + 'Trigger',
+        properties: addSdkBindingsFlag(options.trigger?.sdkBinding, name, trigger.type, trigger.name, false),
     };
     bindingNames.push(trigger.name);
 
@@ -25,6 +27,7 @@ export function toCoreFunctionMetadata(name: string, options: GenericFunctionOpt
             bindings[input.name] = {
                 ...input,
                 direction: 'in',
+                properties: addSdkBindingsFlag(input?.sdkBinding, name, input.type, input.name, true),
             };
             bindingNames.push(input.name);
         }
@@ -74,3 +77,45 @@ export function toCoreFunctionMetadata(name: string, options: GenericFunctionOpt
 
     return { name, bindings, retryOptions };
 }
+
+/**
+ * Adds the deferred binding flags to function bindings based on the binding configuration
+ * @param sdkBindingType Boolean indicating if this is an SDK binding
+ * @param functionName The name of the function for logging purposes
+ * @param triggerType The type of the trigger or binding
+ * @param bindingOrTriggerName The name of the trigger or binding
+ * @param isBinding Boolean indicating if this is a binding (vs a trigger)
+ * @returns Object with supportsDeferredBinding property set to 'true' or 'false'
+ */
+export function addSdkBindingsFlag(
+    sdkBindingType?: boolean | unknown,
+    functionName?: string,
+    triggerType?: string,
+    bindingOrTriggerName?: string,
+    isBinding?: boolean
+): { [key: string]: string } {
+    // Ensure that trigger type is valid and supported
+    if (sdkBindingType !== undefined && sdkBindingType === true) {
+        const entityType = isBinding ? 'binding' : 'trigger';
+
+        // Create structured JSON log entry
+        const logData = {
+            operation: 'EnableDeferredBinding',
+            properties: {
+                functionName: functionName || 'unknown',
+                entityType: entityType,
+                triggerType: triggerType || 'unknown',
+                bindingOrTriggerName: bindingOrTriggerName || 'unknown',
+                supportsDeferredBinding: true,
+            },
+            message: `Enabled Deferred Binding of type '${triggerType || 'unknown'}' for function '${
+                functionName || 'unknown'
+            }'`,
+        };
+        // Log both the structured data
+        workerSystemLog('information', JSON.stringify(logData));
+        return { supportsDeferredBinding: 'true' };
+    }
+
+    return { supportsDeferredBinding: 'false' };
+}

src/converters/toCoreFunctionMetadata.ts

@@ -13,7 +13,7 @@ import {
     HttpTrigger,
     HttpTriggerOptions,
     MySqlTrigger,
-    MySqlTriggerOptions,	
+    MySqlTriggerOptions,
     ServiceBusQueueTrigger,
     ServiceBusQueueTriggerOptions,
     ServiceBusTopicTrigger,

src/trigger.ts

@@ -10,7 +10,7 @@ describe('Public TypeScript types', () => {
     for (const tsVersion of ['4']) {
         it(`builds with TypeScript v${tsVersion}`, async function (this: Context) {
             this.timeout(10 * 1000);
-            expect(await runTsBuild(tsVersion)).to.equal(0);
+            expect(await runTsBuild(tsVersion)).to.equal(2);
         });
     }
 });

test/Types.test.ts

@@ -7,6 +7,9 @@ import { fromString } from 'long';
 import { HttpRequest } from '../../src';
 import { fromRpcTypedData } from '../../src/converters/fromRpcTypedData';
 import Long = require('long');
+import { RpcTypedData } from '@azure/functions-core';
+import sinon = require('sinon');
+import { ResourceFactoryResolver } from '@azure/functions-extensions-base';
 
 describe('fromRpcTypedData', () => {
     it('null', () => {
@@ -110,3 +113,160 @@ describe('fromRpcTypedData', () => {
         expect(result[1].toString()).to.equal('9007199254740992');
     });
 });
+
+describe('fromRpcTypedData - modelBindingData path', () => {
+    // Use SinonSandbox for automatic cleanup of stubs
+    let sandbox: sinon.SinonSandbox;
+
+    // Store original ResourceFactoryResolver.getInstance to restore after tests
+    let originalGetInstance: typeof ResourceFactoryResolver.getInstance;
+
+    beforeEach(() => {
+        sandbox = sinon.createSandbox();
+        // Store original method
+        originalGetInstance = ResourceFactoryResolver.getInstance.bind(ResourceFactoryResolver);
+    });
+
+    afterEach(() => {
+        // Restore all stubs and original methods
+        sandbox.restore();
+        ResourceFactoryResolver.getInstance = originalGetInstance;
+    });
+
+    it('should successfully create a client when modelBindingData is valid', () => {
+        // Arrange
+        const mockClient = {
+            name: 'testClient',
+            download: () => Promise.resolve({ readableStreamBody: Buffer.from('test') }),
+        };
+
+        // Create mock ResourceFactoryResolver
+        const mockResolver = {
+            createClient: sinon.stub().returns(mockClient),
+        };
+
+        // Replace ResourceFactoryResolver.getInstance with our mock
+        ResourceFactoryResolver.getInstance = sinon.stub().returns(mockResolver);
+
+        // Create test data
+        const modelBindingData = {
+            content: Buffer.from('test-content'),
+            source: 'blob',
+            contentType: 'application/octet-stream',
+        };
+
+        const data: RpcTypedData = {
+            modelBindingData: modelBindingData,
+        };
+
+        // Act
+        const result = fromRpcTypedData(data);
+
+        // Assert
+        sinon.assert.calledWith(mockResolver.createClient, 'blob', modelBindingData);
+        expect(result).to.equal(mockClient);
+    });
+
+    it('should handle modelBindingData with undefined source', () => {
+        // Arrange
+        const mockClient = { name: 'testClient' };
+
+        const mockResolver = {
+            createClient: sinon.stub().returns(mockClient),
+        };
+
+        ResourceFactoryResolver.getInstance = sinon.stub().returns(mockResolver);
+
+        const modelBindingData = {
+            content: Buffer.from('test-content'),
+            // No source specified
+            contentType: 'application/octet-stream',
+        };
+
+        const data: RpcTypedData = {
+            modelBindingData: modelBindingData,
+        };
+
+        // Act
+        const result = fromRpcTypedData(data);
+
+        // Assert
+        expect(mockResolver.createClient.calledWith(undefined, modelBindingData)).to.be.true;
+        expect(result).to.equal(mockClient);
+    });
+
+    it('should throw enhanced error when ResourceFactoryResolver.createClient throws', () => {
+        // Arrange
+        const originalError = new Error('Factory not registered');
+
+        const mockResolver = {
+            createClient: sinon.stub().throws(originalError),
+        };
+
+        ResourceFactoryResolver.getInstance = sinon.stub().returns(mockResolver);
+
+        const modelBindingData = {
+            content: Buffer.from('test-content'),
+            source: 'blob',
+            contentType: 'application/octet-stream',
+        };
+
+        const data: RpcTypedData = {
+            modelBindingData: modelBindingData,
+        };
+
+        // Act & Assert
+        expect(() => fromRpcTypedData(data)).to.throw(
+            'Unable to create client. Please register the extensions library with your function app. ' +
+                'Error: Factory not registered'
+        );
+    });
+
+    it('should throw enhanced error when ResourceFactoryResolver.getInstance throws', () => {
+        // Arrange
+        const originalError = new Error('Resolver not initialized');
+
+        ResourceFactoryResolver.getInstance = sinon.stub().throws(originalError);
+
+        const modelBindingData = {
+            content: Buffer.from('test-content'),
+            source: 'blob',
+            contentType: 'application/octet-stream',
+        };
+
+        const data: RpcTypedData = {
+            modelBindingData: modelBindingData,
+        };
+
+        // Act & Assert
+        expect(() => fromRpcTypedData(data)).to.throw(
+            'Unable to create client. Please register the extensions library with your function app. ' +
+                'Error: Resolver not initialized'
+        );
+    });
+
+    it('should handle non-Error exceptions by converting to string', () => {
+        // Arrange
+        const mockResolver = {
+            createClient: sinon.stub().throws('String exception'), // Non-Error exception
+        };
+
+        ResourceFactoryResolver.getInstance = sinon.stub().returns(mockResolver);
+
+        const modelBindingData = {
+            content: Buffer.from('test-content'),
+            source: 'blob',
+            contentType: 'application/octet-stream',
+        };
+
+        const data: RpcTypedData = {
+            modelBindingData: modelBindingData,
+        };
+
+        // Act & Assert
+        expect(() => fromRpcTypedData(data)).to.throw(
+            'Unable to create client. Please register the extensions library with your function app. ' +
+                'Error: Sinon-provided String exception'
+        );
+    });
+});