chore(firestore-stripe-payments): added initial test setup and basic tests (#364)

Author: dackers86

.github/workflows/test.yml

@@ -1,20 +1,40 @@
-name: Test
+name: Testing
 
 on:
+  push:
+    branches:
+      - "**"
   pull_request:
-    paths:
-      - "firestore-stripe-web-sdk/**"
     branches:
       - "**"
 
 jobs:
-  testing:
+  nodejs:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: ["12", "14"]
+    name: node.js_${{ matrix.node }}_test
     steps:
-      - uses: actions/checkout@v1
-      - name: NPM Install
-        run: npm i
-      - name: Unit Test
-        run: lerna run --scope @stripe/firestore-stripe-payments test
-      - name: API Report
-        run: lerna run --scope @stripe/firestore-stripe-payments api-extractor
+      - uses: actions/checkout@v2
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+      - name: NPM install
+        run: npm install
+      - name: Install firebase CLI
+        uses: nick-invision/retry@v1
+        with:
+          timeout_minutes: 10
+          retry_wait_seconds: 60
+          max_attempts: 3
+          command: npm i -g firebase-tools
+      - name: Use extension commands
+        run: firebase --open-sesame extdev
+      - name: mask env paramaters
+        run: echo "::add-mask::$STRIPE_WEBHOOK_SECRET"
+      - name: Run tests with coverage
+        run: npm run test
+        env:
+          STRIPE_API_KEY: ${{ secrets.STRIPE_API_KEY }}

firestore-stripe-invoices/functions/package.json

@@ -6,7 +6,7 @@
     "clean": "rimraf lib",
     "compile": "tsc",
     "generate-readme": "firebase ext:info .. --markdown > ../README.md",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 0"
   },
   "author": "Stripe (https://stripe.com/)",
   "license": "Apache-2.0",
@@ -25,4 +25,4 @@
     "printWidth": 80
   },
   "private": true
-}
+}

firestore-stripe-payments/functions/__tests__/createCheckoutSession.test.ts

@@ -0,0 +1,73 @@
+import * as admin from 'firebase-admin';
+import { DocumentReference, DocumentData } from '@google-cloud/firestore';
+import { UserRecord } from 'firebase-functions/v1/auth';
+import setupEmulator from './helpers/setupEmulator';
+import { generateRecurringPrice } from './helpers/setupProducts';
+import {
+  createFirebaseUser,
+  waitForDocumentToExistInCollection,
+  waitForDocumentToExistWithField,
+} from './helpers/utils';
+
+admin.initializeApp({ projectId: 'demo-project' });
+setupEmulator();
+
+const firestore = admin.firestore();
+
+describe('createCheckoutSession', () => {
+  let user: UserRecord;
+  let price = null;
+
+  beforeEach(async () => {
+    price = await generateRecurringPrice();
+    user = await createFirebaseUser();
+  });
+
+  afterEach(async () => {
+    await admin.auth().deleteUser(user.uid);
+  });
+
+  describe('using a web client', () => {
+    test('successfully creates a checkout session', async () => {
+      const collection = firestore.collection('customers');
+
+      const customer: DocumentData = await waitForDocumentToExistInCollection(
+        collection,
+        'email',
+        user.email
+      );
+
+      const checkoutSessionCollection = collection
+        .doc(customer.doc.id)
+        .collection('checkout_sessions');
+
+      const checkoutSessionDocument: DocumentReference =
+        await checkoutSessionCollection.add({
+          success_url: 'http://test.com/success',
+          cancel_url: 'http://test.com/cancel',
+          line_items: [
+            {
+              price: price.id,
+              quantity: 1,
+            },
+          ],
+        });
+
+      const customerDoc = await waitForDocumentToExistWithField(
+        checkoutSessionDocument,
+        'created'
+      );
+
+      const { client, success_url } = customerDoc.data();
+
+      expect(client).toBe('web');
+      expect(success_url).toBe('http://test.com/success');
+    });
+
+    test.skip('throws an error when success_url has not been provided', async () => {});
+
+    test.skip('throws an error when cancel_url has not been provided', async () => {});
+    test.skip('throws an error when a line items parameter has not been provided', async () => {});
+    test.skip('throws an error when a subscription data array parameter has not been provided', async () => {});
+  });
+});

firestore-stripe-payments/functions/__tests__/createCustomer.test.ts

@@ -0,0 +1,35 @@
+import * as admin from 'firebase-admin';
+import { DocumentData } from '@google-cloud/firestore';
+
+import setupEmulator from './helpers/setupEmulator';
+import { UserRecord } from 'firebase-functions/v1/auth';
+import {
+  createFirebaseUser,
+  waitForDocumentToExistInCollection,
+} from './helpers/utils';
+
+admin.initializeApp({ projectId: 'demo-project' });
+setupEmulator();
+
+const firestore = admin.firestore();
+
+describe('createCustomer', () => {
+  let user: UserRecord;
+  beforeEach(async () => {
+    user = await createFirebaseUser();
+  });
+
+  test('successfully creates a new customers', async () => {
+    const collection = firestore.collection('customers');
+
+    const customer: DocumentData = await waitForDocumentToExistInCollection(
+      collection,
+      'email',
+      user.email
+    );
+
+    const doc = collection.doc(customer.doc.id);
+
+    expect(doc.id).toBeDefined();
+  });
+});

firestore-stripe-payments/functions/__tests__/createPortalLink.test.ts

@@ -0,0 +1,63 @@
+import * as admin from 'firebase-admin';
+import { DocumentData } from '@google-cloud/firestore';
+import functions from 'firebase-functions-test';
+import * as cloudFunctions from '../src';
+import setupEmulator from './helpers/setupEmulator';
+
+import {
+  createFirebaseUser,
+  waitForDocumentToExistInCollection,
+  waitForDocumentToExistWithField,
+} from './helpers/utils';
+import { UserRecord } from 'firebase-functions/v1/auth';
+
+const testEnv = functions({ projectId: 'demo-project' });
+const createPortalLink = testEnv.wrap(cloudFunctions.createPortalLink);
+setupEmulator();
+
+const firestore = admin.firestore();
+
+function request(uid: string, returnUrl: string) {
+  return createPortalLink(
+    { returnUrl },
+    {
+      auth: {
+        uid,
+        token: 'test',
+      },
+    }
+  );
+}
+
+describe('createPortalLink', () => {
+  let user: UserRecord;
+  beforeEach(async () => {
+    user = await createFirebaseUser();
+  });
+
+  afterEach(async () => {
+    await admin.auth().deleteUser(user.uid);
+  });
+
+  test('successfully creates a new portal link', async () => {
+    const collection = firestore.collection('customers');
+
+    const customer: DocumentData = await waitForDocumentToExistInCollection(
+      collection,
+      'email',
+      user.email
+    );
+
+    const doc = collection.doc(customer.doc.id);
+    const customerDoc = await waitForDocumentToExistWithField(doc, 'stripeId');
+
+    const returnUrl = 'http://test.com';
+    const result = await request(customerDoc.id, returnUrl);
+
+    expect(result.object).toBe('billing_portal.session');
+    expect(result.customer).toBe(customerDoc.data().stripeId);
+    expect(result.livemode).toBe(false);
+    expect(result.return_url).toBe(returnUrl);
+    expect(result.url).toBeDefined();
+  });
+});

firestore-stripe-payments/functions/__tests__/customerDataDeleted.test.ts

@@ -0,0 +1,42 @@
+import * as admin from 'firebase-admin';
+import { DocumentData } from '@google-cloud/firestore';
+import setupEmulator from './helpers/setupEmulator';
+import { findCustomer } from './helpers/stripeApi/customers';
+import {
+  repeat,
+  waitForDocumentToExistWithField,
+  waitForDocumentToExistInCollection,
+  createFirebaseUser,
+} from './helpers/utils';
+import { UserRecord } from 'firebase-functions/v1/auth';
+
+admin.initializeApp({ projectId: 'demo-project' });
+setupEmulator();
+
+const firestore = admin.firestore();
+
+describe('customerDataDeleted', () => {
+  let user: UserRecord;
+  beforeEach(async () => {
+    user = await createFirebaseUser();
+  });
+
+  test('successfully deletes a stripe customer', async () => {
+    const collection = firestore.collection('customers');
+
+    const customer: DocumentData = await waitForDocumentToExistInCollection(
+      collection,
+      'email',
+      user.email
+    );
+
+    const doc = collection.doc(customer.doc.id);
+    const userDoc = await waitForDocumentToExistWithField(doc, 'stripeId');
+
+    await admin.auth().deleteUser(customer.doc.id);
+
+    const check = ($) => $?.deleted;
+    const toRun = () => findCustomer(userDoc.data().stripeId);
+    await repeat(toRun, check, 5, 2000);
+  });
+});

firestore-stripe-payments/functions/__tests__/firebase.json

@@ -0,0 +1,23 @@
+{
+  "functions": {
+    "source": "functions"
+  },
+  "emulators": {
+    "functions": {
+      "port": 5001
+    },
+    "firestore": {
+      "port": 8080
+    },
+    "auth": {
+      "port": 9099
+    },
+    "ui": {
+      "enabled": true
+    }
+  },
+  "firestore": {
+    "rules": "firestore.rules",
+    "indexes": "firestore.indexes.json"
+  }
+}

firestore-stripe-payments/functions/__tests__/firestore.rules

@@ -0,0 +1,19 @@
+rules_version = '2';
+service cloud.firestore {
+
+   match /databases/{database}/documents {
+
+    match /products/{id} {
+      allow read, write;
+    }
+
+    match /checkouts/{id} {
+      allow read, write;
+    }
+
+    match /customers/{id} {
+      allow read, write;
+    }
+    
+  }
+}

firestore-stripe-payments/functions/__tests__/handleWebhookEvents.test.ts

@@ -0,0 +1,51 @@
+import * as admin from 'firebase-admin';
+import { DocumentData } from '@google-cloud/firestore';
+import { Product } from '../src/interfaces';
+import setupEmulator from './helpers/setupEmulator';
+
+import { createRandomProduct, updateProduct } from './helpers/setupProducts';
+import {
+  waitForDocumentToExistInCollection,
+  waitForDocumentUpdate,
+} from './helpers/utils';
+
+admin.initializeApp({ projectId: 'demo-project' });
+setupEmulator();
+
+const firestore = admin.firestore();
+
+describe('webhook events', () => {
+  describe('products', () => {
+    let product: Product;
+
+    beforeEach(async () => {
+      product = await createRandomProduct();
+    });
+    test('successfully creates a new product', async () => {
+      const collection = firestore.collection('products');
+      const productDoc: DocumentData = await waitForDocumentToExistInCollection(
+        collection,
+        'name',
+        product.name
+      );
+
+      expect(productDoc.doc.data().name).toBe(product.name);
+    });
+
+    test('successfully updates an existing product', async () => {
+      const updatedProduct: Product = await updateProduct(product.id, {
+        name: `updated_${product.name}`,
+      });
+
+      const doc = firestore.collection('products').doc(product.id);
+
+      const updated = await waitForDocumentUpdate(
+        doc,
+        'name',
+        `updated_${product.name}`
+      );
+
+      expect(updated.data().name).toBe(updatedProduct.name);
+    });
+  });
+});

firestore-stripe-payments/functions/__tests__/helpers/setupEmulator.ts

@@ -0,0 +1,5 @@
+export default () => {
+  process.env.FIRESTORE_EMULATOR_HOST = 'localhost:8080';
+  process.env.FIREBASE_FIRESTORE_EMULATOR_ADDRESS = 'localhost:8080';
+  process.env.FIREBASE_AUTH_EMULATOR_HOST = 'localhost:9099';
+};