📝 FC-2013 Adjusted docs and integration Tests (#130)

* Simplified integration tests

* adjusted integration test var naming

* Adjusted documentation

* adjust readme

* adjusted docs

Author: eplazaso

.github/workflows/integration-test.yml

@@ -21,21 +21,19 @@ jobs:
     - run: npm run integration
       env:
         ACCOUNT_ID: ${{ secrets.ACCOUNT_ID }}
-        SUCCESS_LAMBDA_UUID: ${{ secrets.SUCCESS_LAMBDA_UUID }}
+        FUNCTION_UUID: ${{ secrets.FUNCTION_UUID }}
         CLIENT_ID: ${{ secrets.CLIENT_ID }}
         CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
         OAUTH_API_KEY: ${{ secrets.OAUTH_API_KEY }}
         OAUTH_API_SECRET: ${{ secrets.OAUTH_API_SECRET }}
         OAUTH_TOKEN_KEY: ${{ secrets.OAUTH_TOKEN_KEY }}
         OAUTH_TOKEN_SECRET: ${{ secrets.OAUTH_TOKEN_SECRET }}
         OAUTH_SIGNATURE_METHOD: ${{ secrets.OAUTH_SIGNATURE_METHOD }}
-        ERROR_LAMBDA_UUID: ${{ secrets.ERROR_LAMBDA_UUID }}
         USER_ID: ${{ secrets.USER_ID }}
         ACCOUNT_ID_V1: ${{ secrets.ACCOUNT_ID_V1 }}
-        SUCCESS_LAMBDA_UUID_V1: ${{ secrets.SUCCESS_LAMBDA_UUID_V1 }}
+        LAMBDA_UUID_V1: ${{ secrets.SUCCESS_LAMBDA_UUID_V1 }}
         CLIENT_ID_V1: ${{ secrets.CLIENT_ID_V1 }}
         CLIENT_SECRET_V1: ${{ secrets.CLIENT_SECRET_V1 }}
-        ERROR_LAMBDA_UUID_V1: ${{ secrets.ERROR_LAMBDA_UUID_V1 }}
         USER_ID_V1: ${{ secrets.USER_ID_V1 }}
         USER_NAME: ${{ secrets.USER_NAME }}
         PASSWORD: ${{ secrets.PASSWORD }}

README.md

@@ -36,7 +36,7 @@ We are excited to announce a **major update** to our client: **Functions V2** is
   - *DefaultConfig* `apiVersion`: not available in V2. Still used for V1.
   - *DefaultConfig* `getLambdasUri`: use `getFunctionsUri` instead.
   - *InvocationMetricData* `externalSystem`: use `lpEventSource` instead.
-  - Method *getLambdas()*: use `getFunctions` instead.
+  - Method *getLambdas()*: Now compatible with V1 and V2. Only for V2 `getFunctions` is recommended.
   - Type *BaseQuery*: not used in V2. Still used for V1.
   - Type *GetLambdasQuery*: replaced by `GetFunctionsQuery` in V2.
   - Type *LambdaRequest*: replaced by `FunctionRequest`in V2.

src/client/baseClient.ts

@@ -113,12 +113,13 @@ export class BaseClient {
     }
   }
 
+  // TODO: Remove once V1 is shut down.
   /**
-   * Lists functions.
-   *
-   * @param lambdaRequestData filtering data
-   * @returns A list of functions.
-   * @deprecated While still compatible with V2 Functions, using 'getFunctions' is recommended.
+   * Lists functions. compatible with V2 and V1 Functions.
+   * Should be used during transition period to V2. Please be aware than some V2 functions properties may be different than V1.
+   * @param lambdaRequestData filtering data.
+   * @returns A list of functions (V2 or V1).
+   * @deprecated Will be replaced by 'getFunctions' in V2.
    */
   async getLambdas(lambdaRequestData: LambdaRequest): Promise<Response> {
     const baseMetrics = this.collectBaseMetricsFrom(lambdaRequestData);
@@ -129,7 +130,6 @@ export class BaseClient {
         this.config.uiCsdsServiceName
       ));
 
-      // TODO: Remove once V1 is shut down.
       const isV2 = this.isV2Domain(domain);
 
       const resp = isV2
@@ -168,6 +168,11 @@ export class BaseClient {
     }
   }
 
+  /**
+   * Lists functions, Only V2.
+   * @param functionRequestData filtering data.
+   * @returns  A list of functions.
+   */
   async getFunctions(functionRequestData: FunctionRequest): Promise<Response> {
     const baseMetrics = this.collectBaseMetricsFrom(functionRequestData);
     const watch = new stopwatch();

test/integration/invoke.test.ts

@@ -4,8 +4,8 @@ import {GetAuthorizationHeader} from '../../src/client/clientConfig';
 import {createHmac} from 'crypto';
 import OAuth from 'oauth-1.0a';
 
-const successLambdaUUID =
-  process.env['SUCCESS_LAMBDA_UUID_V1'] || 'does-not-exist';
+const lambdaUUID =
+  process.env['LAMBDA_UUID_V1'] || 'does-not-exist';
 const accountId = process.env['ACCOUNT_ID_V1'] || 'does-not-exist';
 const clientId = process.env['CLIENT_ID_V1'] || 'does-not-exist';
 const clientSecret = process.env['CLIENT_SECRET_V1'] || 'does-not-exist';
@@ -32,7 +32,7 @@ describe('Invoke by UUID', () => {
     };
 
     const response = await client.invoke({
-      lambdaUuid: successLambdaUUID,
+      lambdaUuid: lambdaUUID,
       externalSystem: 'integration-tests',
       body: {
         headers: [],
@@ -44,7 +44,7 @@ describe('Invoke by UUID', () => {
   });
 
   // Skipped, Oauth1 will be deprecated
- /* it.skip('should invoke and get result via custom Oauth1 implementation', async () => {
+  it.skip('should invoke and get result via custom Oauth1 implementation', async () => {
     // custom auth implementation start
     const getAuthorizationHeader: GetAuthorizationHeader = async ({
       url,
@@ -82,7 +82,7 @@ describe('Invoke by UUID', () => {
     };
 
     const response = await client.invoke({
-      lambdaUuid: successLambdaUUID,
+      lambdaUuid: lambdaUUID,
       externalSystem: 'integration-tests',
       body: {
         headers: [],
@@ -92,7 +92,7 @@ describe('Invoke by UUID', () => {
     });
 
     expect(response.ok).toEqual(true);
-  });*/
+  });
 
   it('should fail if lambda does not exist', async () => {
     const nonExistingLambda = 'c521cadf-d444-4519-ad11-1c1111114415';

test/integration/invoke.v2.test.ts

@@ -6,10 +6,9 @@ import {
 } from '../../src/helper/metricCollector';
 import {Tooling} from '../../src/types/tooling';
 
-const successLambdaUUID =
-  process.env['SUCCESS_LAMBDA_UUID'] || 'does-not-exist';
+const functionUUID =
+  process.env['FUNCTION_UUID'] || 'does-not-exist';
 
-const errorLambdaUUID = process.env['ERROR_LAMBDA_UUID'] || 'does-not-exist';
 const accountId = process.env['ACCOUNT_ID'] || 'does-not-exist';
 const clientId = process.env['CLIENT_ID'] || 'does-not-exist';
 const clientSecret = process.env['CLIENT_SECRET'] || 'does-not-exist';
@@ -60,7 +59,7 @@ describe('V2 Invoke by UUID', () => {
     });
 
     const response = await client.invoke({
-      lambdaUuid: successLambdaUUID,
+      lambdaUuid: functionUUID,
       lpEventSource: 'integration-tests',
       body: {
         headers: [],
@@ -86,18 +85,18 @@ describe('V2 Invoke by UUID', () => {
 
     try {
       await client.invoke({
-        lambdaUuid: errorLambdaUUID,
+        lambdaUuid: functionUUID,
         externalSystem: 'integration-tests',
         body: {
-          headers: [],
+          headers: [{key:"run",value: "error"}],
           payload,
         },
       });
       fail('should fail');
     } catch (error: any) {
       expect(error?.name).toEqual('FaaSLambdaError');
       expect(error?.message).toStartWith(
-        `Failed to invoke lambda : ${errorLambdaUUID}`
+        `Failed to invoke lambda : ${functionUUID}`
       );
     }
   });