Implement firebase-functions-test wrapV2 (#131)

* Implement firebase-functions-test wrapV2

* Minor updates (per pr comments.)

This commit makes some minor updates to resolve pr comments.

I still need to go back and clean up the createCloudEvent usecase.

Stay tuned!

* Implement createMockCloudEvent for v2 wrap

This commit implements the createMockCloudEvent.

This simplifies the story of testing the wrapped V2 function.

* Fix how V2 CloudEventSource gets populated

* Fix CloudEvent.subject and CloudEvent.source

* Bumped semver to 1.0.0

* Added support for eventarc custom events

* Fix follow ups from PR feedback

* Handle V2 function behavior within the main.ts#wrap call

* Decouple wrapV1 logic from main.ts#wrap

This cl decouples the implementation logic from wrapping V1 functions
and places it into a separate directory.

I went back and re-exported the same exports from v1 back out to main.ts
to reduce disruption from existing usage.

* Add in Partial Typing instead of CloudEventOverride

* Fix issue with broken typing (CloudBaseEvent isn't exported)

* Follow up items from PR feedback

CloudEvent stuff is being decoupled shortly, stay tuned!™

* Create and Implement MockCloudEvent

This commit introduces MockCloudEvent.

Its very apparent the switch-case shenanigans are too brittle to
handle the growing number of CloudEvents. So Instead, I'm
introducing a wrapper that contains most of the implementation
within `src/mock-cloud-event-partial-definitions.ts`.

The wrapper uses a `match` function to see which implementation of
MockCloudEventPartial to use, and then uses a `generatePartial`
to get the expected Partial<CloudEvent>.

This is not particularly DRY, but it seemed more useful to
keep the building blocks basic rather than being too clever. I'm
happy to be convinced otherwise though.

I'll be breaking / updating other unit tests momentarily.

* Refactor V2 wrap function

This commit refactors the V2 wrap function, removing the need for
the end-user to generate a mock event to pass into the function.

The spec tests are still mostly useless, and we are still missing
data.

I wanted to finish this refactor before implementing the data potion,
otherwise it would be more work to clean up.

* Implemented StorageObjectData and improved typing

* Introduce DeepPartial

Because Partials' don't Partial down recursively.

* Wire up deep merge

* Implement data generation for Alerts

* Fix Types for AppDistributionEvent, BillingEvent, and CrashlyticsEvent

* Split the cloudevent partial definitions to different files

This is a quality-of-life improvement that splits up the giant
`src/mock-cloud-event-partial-definitions.ts` by event type.

`src/mock-cloud-event-partial-definitions.ts` is now just `partials.ts`,
and it returns a list of partials that are all definined in different
files.

Its not the DRYest thing in thr world... but its much more readable.

* Implement mock MessagePublishedData for pubsub

* Update EventArc sample CloudEvent

* Updated Unit tests for PubSub data.message generation

* Update returned type for `Alert.OnAlertPublished` partial

* Remove `param` from default CloudEvent generation

* Fix all the imports (from /lib/v2/providers -> /v2)

* Fix redundant typing

`<FunctionType, EventType>` -> `<EventType>`

* DRY cleanup

* Patch Minor lint issues

* Removed hardcoded json from pubsub partial generator

Removing the hardcoded json from the partial. There needs to be a better pattern.
Stay tuned ™

Author: TheIronDev

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions-test",
-  "version": "0.3.3",
+  "version": "1.0.0",
   "description": "A testing companion to firebase-functions.",
   "main": "lib/index.js",
   "scripts": {
@@ -39,14 +39,15 @@
   "homepage": "https://github.com/firebase/firebase-functions-test#readme",
   "dependencies": {
     "@types/lodash": "^4.14.104",
-    "lodash": "^4.17.5"
+    "lodash": "^4.17.5",
+    "ts-deepmerge": "^2.0.1"
   },
   "devDependencies": {
     "@types/chai": "~4.2.4",
     "@types/mocha": "^5.2.7",
     "chai": "^4.2.0",
     "firebase-admin": "~8.9.0",
-    "firebase-functions": "^3.3.0",
+    "firebase-functions": "^3.20.1",
     "firebase-tools": "^8.9.2",
     "mocha": "^6.2.2",
     "prettier": "^1.19.1",
@@ -55,8 +56,8 @@
     "typescript": "^3.6.4"
   },
   "peerDependencies": {
-    "firebase-functions": ">=2.0.0",
-    "firebase-admin": ">=6.0.0"
+    "firebase-admin": ">=6.0.0",
+    "firebase-functions": ">=3.20.1"
   },
   "engines": {
     "node": ">=8.0.0"

package.json

@@ -0,0 +1,60 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2018 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+import {expect} from 'chai';
+
+import {alerts, storage} from 'firebase-functions/v2';
+import {generateMockCloudEvent} from '../../src/cloudevent/generate';
+
+describe('generate (CloudEvent)', () => {
+  describe('#generateMockCloudEvent', () => {
+    describe('alerts.billing.onPlanAutomatedUpdatePublished()', () => {
+      it('should create CloudEvent with appropriate fields', () => {
+        const cloudFn = alerts.billing.onPlanAutomatedUpdatePublished(() => {
+        });
+        const cloudEvent =
+          generateMockCloudEvent(cloudFn);
+
+        expect(cloudEvent.type).equal(
+          'google.firebase.firebasealerts.alerts.v1.published');
+        expect(cloudEvent.source).equal(
+          '//firebasealerts.googleapis.com/projects/42');
+        expect(cloudEvent.subject).equal(undefined);
+      });
+    });
+    describe('storage.onObjectArchived', () => {
+      it('should create CloudEvent with appropriate fields', () => {
+        const bucketName = 'bucket_name';
+        const cloudFn = storage.onObjectArchived(bucketName, () => {
+        });
+        const cloudEvent =
+          generateMockCloudEvent(cloudFn);
+
+        expect(cloudEvent.type).equal(
+          'google.cloud.storage.object.v1.archived');
+        expect(cloudEvent.source).equal(
+          `//storage.googleapis.com/projects/_/buckets/${bucketName}`);
+        expect(cloudEvent.subject).equal('objects/file_name');
+      });
+    });
+  });
+});

spec/cloudevent/generate.ts

@@ -67,6 +67,8 @@ describe('index', () => {
 
 import './lifecycle.spec';
 import './main.spec';
+import './v2.spec';
+import './cloudevent/generate';
 import './app.spec';
 import './providers/https.spec';
 import './providers/firestore.spec';

spec/index.spec.ts

@@ -33,6 +33,8 @@ import {
 } from '../src/main';
 import { features } from '../src/features';
 import { FirebaseFunctionsTest } from '../src/lifecycle';
+import {alerts} from 'firebase-functions/v2';
+import {wrapV2} from '../src/v2';
 
 describe('main', () => {
   describe('#wrap', () => {
@@ -226,6 +228,17 @@ describe('main', () => {
       });
     });
 
+    describe('v2 functions', () => {
+      it('should invoke wrapV2 wrapper', () => {
+        const handler = (cloudEvent) => ({cloudEvent});
+        const cloudFn = alerts.billing.onPlanAutomatedUpdatePublished(handler);
+        const cloudFnWrap = wrapV2(cloudFn);
+
+        const expectedType = 'google.firebase.firebasealerts.alerts.v1.published';
+        expect(cloudFnWrap().cloudEvent).to.include({type: expectedType});
+      });
+    });
+
     describe('callable functions', () => {
       let wrappedCF;