Merge pull request #259 from senacor/feature/add-logging-capabilities

Provide Logging-Capabilities

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [ 14.x, 15.x, 16.x ]
+        node-version: [ 15.x, 16.x ]
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/integration.yaml

@@ -10,7 +10,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     container:
-      image:  mcr.microsoft.com/azure-functions/node:3.0-node12
+      image:  mcr.microsoft.com/azure-functions/node:4-node18
       env:
         FUNCTIONS_WORKER_RUNTIME: node
 
@@ -24,7 +24,7 @@ jobs:
         shell: bash
         working-directory: ./example
         run: |
-          npm ci && npm install -g azure-functions-core-tools@3 --unsafe-perm true
+          npm ci && npm install -g azure-functions-core-tools@4 --unsafe-perm true
       - name: start-test-function
         shell: bash
         working-directory: ./example

.github/workflows/release.yml

@@ -2,15 +2,17 @@ name: Release
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - master
+      - 'alpha/**'
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [ 14.x ]
+        node-version: [ 16.x ]
 
     steps:
       - uses: actions/checkout@v3
@@ -38,3 +40,4 @@ jobs:
         with:
           name: Release v${{ steps.publish.outputs.version }}
           tag_name: v${{ steps.publish.outputs.version }}
+          prerelease: ${{ contains(github.head_ref, 'alpha') }}

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 2.0.0 (01.04.2023)
+- Added auto-logging functionality to the library that enhances searchability of saved log statements in Azure AppInsights by storing context properties in commonProperties. 
+- Removed the MiddlewareFunction-Type in favor for the azure-built-in one 
+- There are now two types of middleware available: one with error handling and one without. This is helpful because durable functions must throw their errors, otherwise the orchestrator will not restart a failed function.
+
+
 ## 1.5.0 (27.03.2023)
 
 - Added additional helper function to authentication requests by header parameters
@@ -28,5 +34,5 @@
 Features:
 
   - add middleware for azure function to use generic functionality across multiple azure functions
-  - add [joi](https://github.com/sideway/joi) validation as integration for the middleware to validate incomming requests against a schema
+  - add [joi](https://github.com/sideway/joi) validation as integration for the middleware to validate incoming requests against a schema
   - add JWT authorization as integration for the middleware to authorize requests against a passed JWT

README.md

@@ -122,3 +122,17 @@ const afterFunction = (context: Context, request: HttpRequest): Promise<void> =>
 
 export default middleware(functionHandler, [], [afterFunction]);
 ```
+
+### Logging and Tracing with appInsights
+
+To enhance the logging and tracing with appInsights you can wrap your function with the appInsightWrapper. Currently, this will log the query-parameter
+and binding-context of request into the customProperties, which will make your logs more searchable.
+
+Use the `AppInsightForHttpTrigger` for your http-functions:
+```typescript
+import {AppInsightForHttpTrigger} from "./appInsightsWrapper";
+
+export default middleware([AppInsightForHttpTrigger.setup], handler, [AppInsightForHttpTrigger.finalizeAppInsight])
+```
+
+and the `AppInsightForNonHttpTrigger` for functions with different kinds of trigger (e.g. `activityTrigger` or `timerTrigger`).

example/.nvmrc

@@ -1 +1 @@
-v14.18.1
+18.15.0

example/test-header-authentication-function/test-header-authentication-function.ts

@@ -7,4 +7,4 @@ const functionHandler = async (context: Context): Promise<void> => {
     context.res = { status: 204 };
 };
 
-export default middleware(functionHandler, [headerAuthentication()]);
+export default middleware([headerAuthentication()], functionHandler, []);

example/test-jwt-authorization-function/test-jwt-authorization-function.ts

@@ -7,11 +7,15 @@ const functionHandler = async (context: Context): Promise<void> => {
     context.res = { status: 204 };
 };
 
-export default middleware(functionHandler, [
-    authorization([
-        {
-            parameterExtractor: (parameters: ContextBindingData) => parameters.id,
-            jwtExtractor: (jwt: { userId: string }) => jwt.userId,
-        },
-    ]),
-]);
+export default middleware(
+    [
+        authorization([
+            {
+                parameterExtractor: (parameters: ContextBindingData) => parameters.id,
+                jwtExtractor: (jwt: { userId: string }) => jwt.userId,
+            },
+        ]),
+    ],
+    functionHandler,
+    [],
+);

example/test-validation-function/test-validation-function.ts

@@ -18,4 +18,4 @@ const afterFunction = (context: Context): Promise<void> => {
     return;
 };
 
-export default middleware(functionHandler, [validation(schema)], [afterFunction]);
+export default middleware([validation(schema)], functionHandler, [afterFunction]);

jest.config.js

@@ -2,8 +2,6 @@ module.exports = {
     clearMocks: true,
     preset: 'ts-jest',
     testEnvironment: 'node',
-    testPathIgnorePatterns: ["/node_modules/", "/dist/", "/config/"],
-    moduleDirectories: [
-        "node_modules"
-    ],
-}
+    testPathIgnorePatterns: ['/node_modules/', '/dist/', '/config/'],
+    moduleDirectories: ['node_modules'],
+};

jest.integration.config.js

@@ -1,15 +1,11 @@
 module.exports = {
     preset: 'ts-jest',
     testEnvironment: 'node',
-    testMatch: [
-        '**/*.integration.ts'
-    ],
-    testPathIgnorePatterns: ["/node_modules/", "/dist/", "/config/"],
-    moduleDirectories: [
-        "node_modules"
-    ],
-    testTimeout: 10000,
+    testMatch: ['**/*.integration.ts'],
+    testPathIgnorePatterns: ['/node_modules/', '/dist/', '/config/'],
+    moduleDirectories: ['node_modules'],
+    testTimeout: 30000,
     moduleNameMapper: {
-        "axios": "axios/dist/node/axios.cjs"
-    }
-}
+        axios: 'axios/dist/node/axios.cjs',
+    },
+};