Merge branch 'v4.x' into heenagupta/jsChangesForMySql

Author: hallvictoria

azure-pipelines/templates/build.yml

@@ -16,6 +16,8 @@ jobs:
             displayName: 'Install Node.js'
           - script: npm ci
             displayName: 'npm ci'
+          - script: npm audit --production
+            displayName: 'Run vulnerability scan'
           - script: npm run updateVersion -- --buildNumber $(Build.BuildNumber)
             displayName: 'npm run updateVersion'
             condition: and(succeeded(), eq(${{ parameters.IsPrerelease }}, true))

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@azure/functions",
-    "version": "4.6.0",
+    "version": "4.6.1",
     "description": "Microsoft Azure Functions NodeJS Framework",
     "keywords": [
         "azure",

package.json

@@ -19,6 +19,7 @@ import {
     StorageQueueFunctionOptions,
     TimerFunctionOptions,
     WarmupFunctionOptions,
+    WebPubSubFunctionOptions,
 } from '@azure/functions';
 import { FunctionCallback } from '@azure/functions-core';
 import { toCoreFunctionMetadata } from './converters/toCoreFunctionMetadata';
@@ -140,6 +141,10 @@ export function mySql(name: string, options: MySqlFunctionOptions): void {
     generic(name, convertToGenericOptions(options, trigger.mySql));
 }
 
+export function webPubSub(name: string, options: WebPubSubFunctionOptions): void {
+    generic(name, convertToGenericOptions(options, trigger.webPubSub));
+}
+
 export function generic(name: string, options: GenericFunctionOptions): void {
     if (!hasSetModel) {
         setProgrammingModel();

src/app.ts

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

src/constants.ts

@@ -4,13 +4,16 @@
 import { serialize as serializeCookie } from 'cookie';
 import { EventEmitter } from 'events';
 import * as http from 'http';
+import * as net from 'net';
 import { AzFuncSystemError, ensureErrorType } from '../errors';
 import { nonNullProp } from '../utils/nonNull';
 import { workerSystemLog } from '../utils/workerSystemLog';
 import { HttpResponse } from './HttpResponse';
 
 const requests: Record<string, http.IncomingMessage> = {};
 const responses: Record<string, http.ServerResponse> = {};
+const minPort = 55000;
+const maxPort = 55025;
 
 const invocRequestEmitter = new EventEmitter();
 
@@ -105,8 +108,24 @@ export async function setupHttpProxy(): Promise<string> {
 
         server.listen(() => {
             const address = server.address();
+            // Valid address has been created
             if (address !== null && typeof address === 'object') {
-                resolve(`http://localhost:${address.port}/`);
+                if (address.port === 0) {
+                    // Auto-assigned port is 0, find and bind to an open port
+                    workerSystemLog('debug', `Port 0 assigned. Finding open port.`);
+                    findOpenPort((openPort: number) => {
+                        // Close the server and re-listen on the found open port
+                        server.close();
+                        server.listen(openPort, () => {
+                            workerSystemLog('debug', `Server is now listening on found open port: ${openPort}`);
+                        });
+                        resolve(`http://localhost:${openPort}/`);
+                    });
+                } else {
+                    // Auto-assigned port is not 0
+                    workerSystemLog('debug', `Auto-assigned port is valid. Port: ${address.port}`);
+                    resolve(`http://localhost:${address.port}/`);
+                }
             } else {
                 reject(new AzFuncSystemError('Unexpected server address during http proxy setup'));
             }
@@ -117,3 +136,38 @@ export async function setupHttpProxy(): Promise<string> {
         });
     });
 }
+
+// Function to find an open port starting from a specified port
+function findOpenPort(callback: (port: number) => void): void {
+    const server = net.createServer();
+
+    function tryPort(port: number) {
+        if (port > maxPort) {
+            // If we've reached the maximum port, throw an error
+            throw new AzFuncSystemError(
+                `No available ports found between ${minPort} and ${maxPort}. To enable HTTP streaming, please open a port in this range.`
+            );
+        }
+
+        server.once('error', () => {
+            // If the port is unavailable, increment and try the next one
+            tryPort(port + 1);
+        });
+
+        // If the port is available, return it
+        server.once('listening', () => {
+            const address = server.address();
+            if (address !== null && typeof address === 'object') {
+                port = address.port;
+                server.close();
+                callback(port);
+            }
+        });
+
+        // Try binding to the given port
+        server.listen(port);
+    }
+
+    // Start trying from the specified starting port
+    tryPort(minPort);
+}

src/http/httpProxy.ts

@@ -14,6 +14,10 @@ import {
     StorageBlobInputOptions,
     TableInput,
     TableInputOptions,
+    WebPubSubConnectionInput,
+    WebPubSubConnectionInputOptions,
+    WebPubSubContextInput,
+    WebPubSubContextInputOptions,
 } from '@azure/functions';
 import { addBindingName } from './addBindingName';
 
@@ -52,6 +56,20 @@ export function mySql(options: MySqlInputOptions): MySqlInput {
     });
 }
 
+export function webPubSubConnection(options: WebPubSubConnectionInputOptions): WebPubSubConnectionInput {
+    return addInputBindingName({
+        ...options,
+        type: 'webPubSubConnection',
+    });
+}
+
+export function webPubSubContext(options: WebPubSubContextInputOptions): WebPubSubContextInput {
+    return addInputBindingName({
+        ...options,
+        type: 'webPubSubContext',
+    });
+}
+
 export function generic(options: GenericInputOptions): FunctionInput {
     return addInputBindingName(options);
 }

src/input.ts

@@ -26,6 +26,8 @@ import {
     StorageQueueOutputOptions,
     TableOutput,
     TableOutputOptions,
+    WebPubSubOutput,
+    WebPubSubOutputOptions,
 } from '@azure/functions';
 import { addBindingName } from './addBindingName';
 
@@ -106,6 +108,13 @@ export function mySql(options: MySqlOutputOptions): MySqlOutput {
     });
 }
 
+export function webPubSub(options: WebPubSubOutputOptions): WebPubSubOutput {
+    return addOutputBindingName({
+        ...options,
+        type: 'webPubSub',
+    });
+}
+
 export function generic(options: GenericOutputOptions): FunctionOutput {
     return addOutputBindingName(options);
 }

src/output.ts

@@ -28,6 +28,8 @@ import {
     TimerTriggerOptions,
     WarmupTrigger,
     WarmupTriggerOptions,
+    WebPubSubTrigger,
+    WebPubSubTriggerOptions,
 } from '@azure/functions';
 import { addBindingName } from './addBindingName';
 
@@ -117,6 +119,13 @@ export function mySql(options: MySqlTriggerOptions): MySqlTrigger {
     });
 }
 
+export function webPubSub(options: WebPubSubTriggerOptions): WebPubSubTrigger {
+    return addTriggerBindingName({
+        ...options,
+        type: 'webPubSubTrigger',
+    });
+}
+
 export function generic(options: GenericTriggerOptions): FunctionTrigger {
     return addTriggerBindingName(options);
 }

src/trigger.ts

@@ -11,6 +11,7 @@ import { ServiceBusQueueOutput, ServiceBusTopicOutput } from './serviceBus';
 import { SqlInput, SqlOutput } from './sql';
 import { StorageBlobInput, StorageBlobOutput, StorageQueueOutput } from './storage';
 import { TableInput, TableOutput } from './table';
+import { WebPubSubOutput } from './webpubsub';
 
 /**
  * Contains metadata and helper methods specific to this invocation
@@ -230,6 +231,13 @@ export interface InvocationContextExtraOutputs {
      */
     set(output: MySqlOutput, items: unknown): void;
 
+    /**
+     * Set a secondary Web PubSub output for this invocation
+     * @output the configuration object for this Web PubSub output
+     * @message the output message(s) value
+     */
+    set(output: WebPubSubOutput, messages: unknown): void;
+
     /**
      * Set a secondary generic output for this invocation
      * @outputOrName the configuration object or name for this output

types/InvocationContext.d.ts

@@ -13,6 +13,7 @@ import { SqlFunctionOptions } from './sql';
 import { StorageBlobFunctionOptions, StorageQueueFunctionOptions } from './storage';
 import { TimerFunctionOptions } from './timer';
 import { WarmupFunctionOptions } from './warmup';
+import { WebPubSubFunctionOptions } from './webpubsub';
 
 /**
  * Optional method to configure the behavior of your app.
@@ -188,4 +189,11 @@ export function mySql(name: string, options: MySqlFunctionOptions): void;
  */
 export function generic(name: string, options: GenericFunctionOptions): void;
 
+/**
+ * Registers a WebPubSub function in your app that will be triggered by WebPubSub events
+ * @param name The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
+ * @param options Configuration options describing the inputs, outputs, and handler for this function
+ */
+export function webPubSub(name: string, options: WebPubSubFunctionOptions): void;
+
 export * as hook from './hooks/registerHook';

types/app.d.ts

@@ -27,6 +27,7 @@ export * from './table';
 export * from './timer';
 export * as trigger from './trigger';
 export * from './warmup';
+export * from './webpubsub';
 
 /**
  * Void if no `return` output is registered

types/index.d.ts

@@ -8,6 +8,12 @@ import { SqlInput, SqlInputOptions } from './sql';
 import { StorageBlobInput, StorageBlobInputOptions } from './storage';
 import { TableInput, TableInputOptions } from './table';
 import { MySqlInput, MySqlInputOptions } from './mySql';
+import {
+    WebPubSubConnectionInput,
+    WebPubSubConnectionInputOptions,
+    WebPubSubContextInput,
+    WebPubSubContextInputOptions,
+} from './webpubsub';
 
 /**
  * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-storage-blob-input?pivots=programming-language-javascript)
@@ -34,6 +40,16 @@ export function sql(options: SqlInputOptions): SqlInput;
  */
 export function mySql(options: MySqlInputOptions): MySqlInput;
 
+/**
+ * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-web-pubsub-input?pivots=programming-language-javascript)
+ */
+export function webPubSubConnection(options: WebPubSubConnectionInputOptions): WebPubSubConnectionInput;
+
+/**
+ * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-web-pubsub-input?pivots=programming-language-javascript)
+ */
+export function webPubSubContext(options: WebPubSubContextInputOptions): WebPubSubContextInput;
+
 /**
  * A generic option that can be used for any input type
  * Use this method if your desired input type does not already have its own method

types/input.d.ts

@@ -17,6 +17,7 @@ import { SqlOutput, SqlOutputOptions } from './sql';
 import { StorageBlobOutput, StorageBlobOutputOptions, StorageQueueOutput, StorageQueueOutputOptions } from './storage';
 import { TableOutput, TableOutputOptions } from './table';
 import { MySqlOutput, MySqlOutputOptions } from './mySql';
+import { WebPubSubOutput, WebPubSubOutputOptions } from './webpubsub';
 
 /**
  * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-http-webhook-output?&pivots=programming-language-javascript)
@@ -73,6 +74,11 @@ export function sql(options: SqlOutputOptions): SqlOutput;
  */
 export function mySql(options: MySqlOutputOptions): MySqlOutput;
 
+/**
+ * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-web-pubsub-output?pivots=programming-language-javascript)
+ */
+export function webPubSub(options: WebPubSubOutputOptions): WebPubSubOutput;
+
 /**
  * A generic option that can be used for any output type
  * Use this method if your desired output type does not already have its own method

types/output.d.ts

@@ -23,6 +23,7 @@ import {
 } from './storage';
 import { TimerTrigger, TimerTriggerOptions } from './timer';
 import { WarmupTrigger, WarmupTriggerOptions } from './warmup';
+import { WebPubSubTrigger, WebPubSubTriggerOptions } from './webpubsub';
 
 /**
  * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-http-webhook-trigger?&pivots=programming-language-javascript)
@@ -84,6 +85,11 @@ export function sql(options: SqlTriggerOptions): SqlTrigger;
  */
 export function mySql(options: MySqlTriggerOptions): MySqlTrigger;
 
+/**
+ * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-web-pubsub-trigger?pivots=programming-language-javascript)
+ */
+export function webPubSub(options: WebPubSubTriggerOptions): WebPubSubTrigger;
+
 /**
  * A generic option that can be used for any trigger type
  * Use this method if your desired trigger type does not already have its own method