add /v2 imports back in to support firebase-functions versions below 6.x (#252)

Berlioz · web-flow · commit cbf289a01f8d · 2024-12-18T15:59:32.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+- Explicitly import from the v1 namespace to unbreak firebase-functions 6.x (#243).
+- Explciitly import from the v2 namespace so that #243 doesn't break firebase-functions versions below 6.x (#252)
+- Also adds firebase-admin 13.x as a supported version in peer-deps (#252)
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -48,7 +48,7 @@
     "@types/mocha": "^5.2.7",
     "chai": "^4.2.0",
     "firebase-admin": "^12.0.0",
-    "firebase-functions": "^6.0.1",
+    "firebase-functions": "^4.9.0",
     "firebase-tools": "^8.9.2",
     "mocha": "^6.2.2",
     "prettier": "^1.19.1",
@@ -57,8 +57,8 @@
     "typescript": "^4.2.5"
   },
   "peerDependencies": {
-    "firebase-admin": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0",
-    "firebase-functions": ">=6.0.1",
+    "firebase-admin": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0",
+    "firebase-functions": ">=4.9.0",
     "jest": ">=28.0.0"
   },
   "engines": {
diff --git a/spec/cloudevent/generate.ts b/spec/cloudevent/generate.ts
@@ -22,7 +22,7 @@
 
 import { expect } from 'chai';
 
-import { alerts, storage } from 'firebase-functions';
+import { alerts, storage } from 'firebase-functions/v2';
 import { generateMockCloudEvent } from '../../src/cloudevent/generate';
 
 describe('generate (CloudEvent)', () => {
diff --git a/spec/main.spec.ts b/spec/main.spec.ts
@@ -28,7 +28,7 @@ import { mockConfig, makeChange, wrap } from '../src/main';
 import { _makeResourceName, _extractParams } from '../src/v1';
 import { features } from '../src/features';
 import { FirebaseFunctionsTest } from '../src/lifecycle';
-import { alerts } from 'firebase-functions';
+import { alerts } from 'firebase-functions/v2';
 import { wrapV2 } from '../src/v2';
 
 describe('main', () => {
diff --git a/spec/v2.spec.ts b/spec/v2.spec.ts
@@ -35,7 +35,7 @@ import {
   eventarc,
   https,
   firestore,
-} from 'firebase-functions';
+} from 'firebase-functions/v2';
 import { defineString } from 'firebase-functions/params';
 import { makeDataSnapshot } from '../src/providers/database';
 import { makeDocumentSnapshot } from '../src/providers/firestore';
diff --git a/src/cloudevent/generate.ts b/src/cloudevent/generate.ts
@@ -3,7 +3,7 @@ import {
   CloudFunction,
   database,
   pubsub,
-} from 'firebase-functions';
+} from 'firebase-functions/v2';
 import {
   DocumentSnapshot,
   QueryDocumentSnapshot,
diff --git a/src/cloudevent/mocks/alerts/alerts-on-alert-published.ts b/src/cloudevent/mocks/alerts/alerts-on-alert-published.ts
@@ -1,12 +1,12 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
+import { CloudFunction } from 'firebase-functions/v2';
 import {
   APP_ID,
   getBaseCloudEvent,
   getEventType,
   PROJECT_ID,
 } from '../helpers';
-import { FirebaseAlertData, AlertEvent } from 'firebase-functions/alerts';
+import { FirebaseAlertData, AlertEvent } from 'firebase-functions/v2/alerts';
 
 export const alertsOnAlertPublished: MockCloudEventAbstractFactory<AlertEvent<
   FirebaseAlertData
diff --git a/src/cloudevent/mocks/alerts/app-distribution-on-new-tester-ios-device-published.ts b/src/cloudevent/mocks/alerts/app-distribution-on-new-tester-ios-device-published.ts
@@ -1,5 +1,5 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
+import { CloudFunction } from 'firebase-functions/v2';
 import {
   getBaseCloudEvent,
   getEventFilters,
@@ -9,7 +9,7 @@ import {
 import {
   AppDistributionEvent,
   NewTesterDevicePayload,
-} from 'firebase-functions/alerts/appDistribution';
+} from 'firebase-functions/v2/alerts/appDistribution';
 
 export const alertsAppDistributionOnNewTesterIosDevicePublished: MockCloudEventAbstractFactory<AppDistributionEvent<
   NewTesterDevicePayload
diff --git a/src/cloudevent/mocks/alerts/billing-on-plan-automated-update-published.ts b/src/cloudevent/mocks/alerts/billing-on-plan-automated-update-published.ts
@@ -1,10 +1,10 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
-import { FirebaseAlertData } from 'firebase-functions/alerts';
+import { CloudFunction } from 'firebase-functions/v2';
+import { FirebaseAlertData } from 'firebase-functions/v2/alerts';
 import {
   BillingEvent,
   PlanAutomatedUpdatePayload,
-} from 'firebase-functions/alerts/billing';
+} from 'firebase-functions/v2/alerts/billing';
 import {
   getBaseCloudEvent,
   getEventFilters,
diff --git a/src/cloudevent/mocks/alerts/billing-on-plan-update-published.ts b/src/cloudevent/mocks/alerts/billing-on-plan-update-published.ts
@@ -1,10 +1,10 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
-import { FirebaseAlertData } from 'firebase-functions/alerts';
+import { CloudFunction } from 'firebase-functions/v2';
+import { FirebaseAlertData } from 'firebase-functions/v2/alerts';
 import {
   BillingEvent,
   PlanUpdatePayload,
-} from 'firebase-functions/alerts/billing';
+} from 'firebase-functions/v2/alerts/billing';
 import {
   getBaseCloudEvent,
   getEventFilters,
diff --git a/src/cloudevent/mocks/alerts/crashlytics-on-new-anr-issue-published.ts b/src/cloudevent/mocks/alerts/crashlytics-on-new-anr-issue-published.ts
@@ -1,5 +1,5 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
+import { CloudFunction } from 'firebase-functions/v2';
 import {
   getBaseCloudEvent,
   getEventFilters,
@@ -9,8 +9,8 @@ import {
 import {
   CrashlyticsEvent,
   NewAnrIssuePayload,
-} from 'firebase-functions/alerts/crashlytics';
-import { FirebaseAlertData } from 'firebase-functions/alerts';
+} from 'firebase-functions/v2/alerts/crashlytics';
+import { FirebaseAlertData } from 'firebase-functions/v2/alerts';
 
 export const alertsCrashlyticsOnNewAnrIssuePublished: MockCloudEventAbstractFactory<CrashlyticsEvent<
   NewAnrIssuePayload
diff --git a/src/cloudevent/mocks/alerts/crashlytics-on-new-fatal-issue-published.ts b/src/cloudevent/mocks/alerts/crashlytics-on-new-fatal-issue-published.ts
@@ -1,5 +1,5 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
+import { CloudFunction } from 'firebase-functions/v2';
 import {
   getBaseCloudEvent,
   getEventFilters,
@@ -9,8 +9,8 @@ import {
 import {
   CrashlyticsEvent,
   NewFatalIssuePayload,
-} from 'firebase-functions/alerts/crashlytics';
-import { FirebaseAlertData } from 'firebase-functions/alerts';
+} from 'firebase-functions/v2/alerts/crashlytics';
+import { FirebaseAlertData } from 'firebase-functions/v2/alerts';
 
 export const alertsCrashlyticsOnNewFatalIssuePublished: MockCloudEventAbstractFactory<CrashlyticsEvent<
   NewFatalIssuePayload
diff --git a/src/cloudevent/mocks/alerts/crashlytics-on-new-nonfatal-issue-published.ts b/src/cloudevent/mocks/alerts/crashlytics-on-new-nonfatal-issue-published.ts
@@ -1,5 +1,5 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
+import { CloudFunction } from 'firebase-functions/v2';
 import {
   getBaseCloudEvent,
   getEventFilters,
@@ -9,8 +9,8 @@ import {
 import {
   CrashlyticsEvent,
   NewNonfatalIssuePayload,
-} from 'firebase-functions/alerts/crashlytics';
-import { FirebaseAlertData } from 'firebase-functions/alerts';
+} from 'firebase-functions/v2/alerts/crashlytics';
+import { FirebaseAlertData } from 'firebase-functions/v2/alerts';
 
 export const alertsCrashlyticsOnNewNonfatalIssuePublished: MockCloudEventAbstractFactory<CrashlyticsEvent<
   NewNonfatalIssuePayload
diff --git a/src/cloudevent/mocks/alerts/crashlytics-on-regression-alert-published.ts b/src/cloudevent/mocks/alerts/crashlytics-on-regression-alert-published.ts
@@ -1,5 +1,5 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
+import { CloudFunction } from 'firebase-functions/v2';
 import {
   getBaseCloudEvent,
   getEventFilters,
@@ -9,8 +9,8 @@ import {
 import {
   CrashlyticsEvent,
   RegressionAlertPayload,
-} from 'firebase-functions/alerts/crashlytics';
-import { FirebaseAlertData } from 'firebase-functions/alerts';
+} from 'firebase-functions/v2/alerts/crashlytics';
+import { FirebaseAlertData } from 'firebase-functions/v2/alerts';
 
 export const alertsCrashlyticsOnRegressionAlertPublished: MockCloudEventAbstractFactory<CrashlyticsEvent<
   RegressionAlertPayload
diff --git a/src/cloudevent/mocks/alerts/crashlytics-on-stability-digest-published.ts b/src/cloudevent/mocks/alerts/crashlytics-on-stability-digest-published.ts
@@ -1,5 +1,5 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
+import { CloudFunction } from 'firebase-functions/v2';
 import {
   getBaseCloudEvent,
   getEventFilters,
@@ -9,8 +9,8 @@ import {
 import {
   CrashlyticsEvent,
   StabilityDigestPayload,
-} from 'firebase-functions/alerts/crashlytics';
-import { FirebaseAlertData } from 'firebase-functions/alerts';
+} from 'firebase-functions/v2/alerts/crashlytics';
+import { FirebaseAlertData } from 'firebase-functions/v2/alerts';
 
 export const alertsCrashlyticsOnStabilityDigestPublished: MockCloudEventAbstractFactory<CrashlyticsEvent<
   StabilityDigestPayload
diff --git a/src/cloudevent/mocks/alerts/crashlytics-on-velocity-alert-published.ts b/src/cloudevent/mocks/alerts/crashlytics-on-velocity-alert-published.ts
@@ -1,5 +1,5 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
+import { CloudFunction } from 'firebase-functions/v2';
 import {
   getBaseCloudEvent,
   getEventFilters,
@@ -9,8 +9,8 @@ import {
 import {
   CrashlyticsEvent,
   VelocityAlertPayload,
-} from 'firebase-functions/alerts/crashlytics';
-import { FirebaseAlertData } from 'firebase-functions/alerts';
+} from 'firebase-functions/v2/alerts/crashlytics';
+import { FirebaseAlertData } from 'firebase-functions/v2/alerts';
 
 export const alertsCrashlyticsOnVelocityAlertPublished: MockCloudEventAbstractFactory<CrashlyticsEvent<
   VelocityAlertPayload
diff --git a/src/cloudevent/mocks/alerts/performance-on-threshold-alert-published.ts b/src/cloudevent/mocks/alerts/performance-on-threshold-alert-published.ts
@@ -1,17 +1,17 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudFunction } from 'firebase-functions';
+import { CloudFunction } from 'firebase-functions/v2';
 import {
   PerformanceEvent,
   ThresholdAlertPayload,
-} from 'firebase-functions/alerts/performance';
+} from 'firebase-functions/v2/alerts/performance';
 import {
   getBaseCloudEvent,
   getEventFilters,
   getEventType,
   PROJECT_ID,
   APP_ID,
 } from '../helpers';
-import { FirebaseAlertData } from 'firebase-functions/alerts';
+import { FirebaseAlertData } from 'firebase-functions/v2/alerts';
 
 export const performanceThresholdOnThresholdAlertPublished: MockCloudEventAbstractFactory<PerformanceEvent<
   ThresholdAlertPayload
diff --git a/src/cloudevent/mocks/database/database-on-value-created.ts b/src/cloudevent/mocks/database/database-on-value-created.ts
@@ -1,5 +1,5 @@
 import { MockCloudEventAbstractFactory } from '../../types';
-import { CloudEvent, CloudFunction, database } from 'firebase-functions';
+import { CloudEvent, CloudFunction, database } from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { getDatabaseSnapshotCloudEvent } from './helpers';
 
diff --git a/src/cloudevent/mocks/database/database-on-value-deleted.ts b/src/cloudevent/mocks/database/database-on-value-deleted.ts
@@ -1,5 +1,5 @@
 import { MockCloudEventAbstractFactory } from '../../types';
-import { CloudEvent, CloudFunction, database } from 'firebase-functions';
+import { CloudEvent, CloudFunction, database } from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { getDatabaseSnapshotCloudEvent } from './helpers';
 
diff --git a/src/cloudevent/mocks/database/database-on-value-updated.ts b/src/cloudevent/mocks/database/database-on-value-updated.ts
@@ -1,5 +1,5 @@
 import { MockCloudEventAbstractFactory } from '../../types';
-import { CloudEvent, CloudFunction, database } from 'firebase-functions';
+import { CloudEvent, CloudFunction, database } from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { Change } from 'firebase-functions/v1';
 import { getDatabaseChangeSnapshotCloudEvent } from './helpers';
diff --git a/src/cloudevent/mocks/database/database-on-value-written.ts b/src/cloudevent/mocks/database/database-on-value-written.ts
@@ -1,5 +1,5 @@
 import { MockCloudEventAbstractFactory } from '../../types';
-import { CloudEvent, CloudFunction, database } from 'firebase-functions';
+import { CloudEvent, CloudFunction, database } from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { Change } from 'firebase-functions/v1';
 import { getDatabaseChangeSnapshotCloudEvent } from './helpers';
diff --git a/src/cloudevent/mocks/database/helpers.ts b/src/cloudevent/mocks/database/helpers.ts
@@ -1,4 +1,4 @@
-import { CloudFunction, database } from 'firebase-functions';
+import { CloudFunction, database } from 'firebase-functions/v2';
 import { DeepPartial } from '../../types';
 import {
   exampleDataSnapshot,
diff --git a/src/cloudevent/mocks/eventarc/eventarc-on-custom-event-published.ts b/src/cloudevent/mocks/eventarc/eventarc-on-custom-event-published.ts
@@ -1,5 +1,5 @@
 import { DeepPartial, MockCloudEventAbstractFactory } from '../../types';
-import { CloudEvent, CloudFunction } from 'firebase-functions';
+import { CloudEvent, CloudFunction } from 'firebase-functions/v2';
 import { getBaseCloudEvent } from '../helpers';
 
 export const eventarcOnCustomEventPublished: MockCloudEventAbstractFactory<any> = {
diff --git a/src/cloudevent/mocks/firestore/firestore-on-document-created-with-auth-context.ts b/src/cloudevent/mocks/firestore/firestore-on-document-created-with-auth-context.ts
@@ -1,5 +1,5 @@
 import { MockCloudEventAbstractFactory } from '../../types';
-import { CloudEvent, CloudFunction, firestore } from 'firebase-functions';
+import { CloudEvent, CloudFunction, firestore } from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { QueryDocumentSnapshot } from 'firebase-admin/firestore';
 import { getDocumentSnapshotCloudEventWithAuthContext } from './helpers';
diff --git a/src/cloudevent/mocks/firestore/firestore-on-document-created.ts b/src/cloudevent/mocks/firestore/firestore-on-document-created.ts
@@ -1,5 +1,5 @@
 import { MockCloudEventAbstractFactory } from '../../types';
-import { CloudEvent, CloudFunction, firestore } from 'firebase-functions';
+import { CloudEvent, CloudFunction, firestore } from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { QueryDocumentSnapshot } from 'firebase-admin/firestore';
 import { getDocumentSnapshotCloudEvent } from './helpers';
diff --git a/src/cloudevent/mocks/firestore/firestore-on-document-deleted-with-auth-context.ts b/src/cloudevent/mocks/firestore/firestore-on-document-deleted-with-auth-context.ts
@@ -1,5 +1,5 @@
 import { MockCloudEventAbstractFactory } from '../../types';
-import { CloudEvent, CloudFunction, firestore } from 'firebase-functions';
+import { CloudEvent, CloudFunction, firestore } from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { QueryDocumentSnapshot } from 'firebase-admin/firestore';
 import { getDocumentSnapshotCloudEventWithAuthContext } from './helpers';
diff --git a/src/cloudevent/mocks/firestore/firestore-on-document-deleted.ts b/src/cloudevent/mocks/firestore/firestore-on-document-deleted.ts
@@ -1,5 +1,5 @@
 import { MockCloudEventAbstractFactory } from '../../types';
-import { CloudEvent, CloudFunction, firestore } from 'firebase-functions';
+import { CloudEvent, CloudFunction, firestore } from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { QueryDocumentSnapshot } from 'firebase-admin/firestore';
 import { getDocumentSnapshotCloudEvent } from './helpers';
diff --git a/src/cloudevent/mocks/firestore/firestore-on-document-updated-with-auth-context.ts b/src/cloudevent/mocks/firestore/firestore-on-document-updated-with-auth-context.ts
@@ -4,7 +4,7 @@ import {
   CloudEvent,
   CloudFunction,
   firestore,
-} from 'firebase-functions';
+} from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { QueryDocumentSnapshot } from 'firebase-admin/firestore';
 import { getDocumentSnapshotChangeCloudEventWithAuthContext } from './helpers';
diff --git a/src/cloudevent/mocks/firestore/firestore-on-document-updated.ts b/src/cloudevent/mocks/firestore/firestore-on-document-updated.ts
@@ -4,7 +4,7 @@ import {
   CloudEvent,
   CloudFunction,
   firestore,
-} from 'firebase-functions';
+} from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { QueryDocumentSnapshot } from 'firebase-admin/firestore';
 import { getDocumentSnapshotChangeCloudEvent } from './helpers';
diff --git a/src/cloudevent/mocks/firestore/firestore-on-document-written-with-auth-context.ts b/src/cloudevent/mocks/firestore/firestore-on-document-written-with-auth-context.ts
@@ -4,7 +4,7 @@ import {
   CloudEvent,
   CloudFunction,
   firestore,
-} from 'firebase-functions';
+} from 'firebase-functions/v2';
 import { getEventType } from '../helpers';
 import { DocumentSnapshot } from 'firebase-admin/firestore';
 import { getDocumentSnapshotChangeCloudEventWithAuthContext } from './helpers';
diff --git a/src/cloudevent/mocks/firestore/firestore-on-document-written.ts b/src/cloudevent/mocks/firestore/firestore-on-document-written.ts
diff --git a/src/cloudevent/mocks/firestore/helpers.ts b/src/cloudevent/mocks/firestore/helpers.ts
diff --git a/src/cloudevent/mocks/helpers.ts b/src/cloudevent/mocks/helpers.ts
diff --git a/src/cloudevent/mocks/pubsub/pubsub-on-message-published.ts b/src/cloudevent/mocks/pubsub/pubsub-on-message-published.ts
diff --git a/src/cloudevent/mocks/remoteconfig/remote-config-on-config-updated.ts b/src/cloudevent/mocks/remoteconfig/remote-config-on-config-updated.ts
diff --git a/src/cloudevent/mocks/storage/index.ts b/src/cloudevent/mocks/storage/index.ts
diff --git a/src/cloudevent/mocks/storage/storage-data.ts b/src/cloudevent/mocks/storage/storage-data.ts
diff --git a/src/cloudevent/mocks/testlab/test-lab-on-test-matrix-completed.ts b/src/cloudevent/mocks/testlab/test-lab-on-test-matrix-completed.ts
diff --git a/src/cloudevent/types.ts b/src/cloudevent/types.ts
diff --git a/src/main.ts b/src/main.ts
diff --git a/src/v2.ts b/src/v2.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+- Explicitly import from the v1 namespace to unbreak firebase-functions 6.x (#243).`
	`2`	`+- Explciitly import from the v2 namespace so that #243 doesn't break firebase-functions versions below 6.x (#252)`
	`3`	`+- Also adds firebase-admin 13.x as a supported version in peer-deps (#252)`