Merge pull request #274 from levino/feature/test-use-document

chore: add testing

Author: chrisbianca

.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "demo-noop"
+  }
+}

.github/workflows/checks.yml

@@ -0,0 +1,30 @@
+name: build
+on:
+  pull_request:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: npm
+      - name: Install
+        run: npm install
+      - name: Build
+        run: npm run build
+      - name: Test
+        run: npm run test:ci
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: npm
+      - name: Install
+        run: npm install
+      - name: Test
+        run: npm run test:ci

.gitignore

@@ -16,3 +16,5 @@ coverage
 
 #test files
 /example
+fire*.log
+/.idea/

babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', { targets: { node: 'current' } }],
+    '@babel/preset-typescript',
+  ],
+};

firebase.json

@@ -0,0 +1,18 @@
+{
+  "functions": {
+    "runtime": "node16"
+  },
+  "firestore": {
+    "rules": "firestore.rules",
+    "indexes": "firestore.indexes.json"
+  },
+  "emulators": {
+    "firestore": {
+      "port": 8080
+    },
+    "ui": {
+      "enabled": false
+    },
+    "singleProjectMode": true
+  }
+}

firestore.indexes.json

@@ -0,0 +1,26 @@
+{
+  // Example:
+  //
+  // "indexes": [
+  //   {
+  //     "collectionGroup": "widgets",
+  //     "queryScope": "COLLECTION",
+  //     "fields": [
+  //       { "fieldPath": "foo", "arrayConfig": "CONTAINS" },
+  //       { "fieldPath": "bar", "mode": "DESCENDING" }
+  //     ]
+  //   },
+  //
+  //  "fieldOverrides": [
+  //    {
+  //      "collectionGroup": "widgets",
+  //      "fieldPath": "baz",
+  //      "indexes": [
+  //        { "order": "ASCENDING", "queryScope": "COLLECTION" }
+  //      ]
+  //    },
+  //   ]
+  // ]
+  "indexes": [],
+  "fieldOverrides": []
+}

firestore.rules

@@ -0,0 +1,8 @@
+rules_version = '2';
+service cloud.firestore {
+  match /databases/{database}/documents {
+    match /{document=**} {
+      allow read, write: if true;
+    }
+  }
+}

firestore/useDocument.test.ts

@@ -0,0 +1,40 @@
+import { addDoc, collection, doc } from 'firebase/firestore';
+
+import { db } from '../test/firebase';
+import { renderHook } from '@testing-library/react-hooks';
+import { useDocument } from './useDocument';
+
+describe('useDocument hook', () => {
+  test('begins in loading state', async () => {
+    // arrange
+    const { id } = await addDoc(collection(db, 'test'), {});
+
+    // act
+    const { result, unmount } = renderHook(() =>
+      useDocument(doc(collection(db, 'test'), id))
+    );
+
+    //assert
+    expect(result.current[1]).toBeTruthy();
+
+    // clean up
+    unmount();
+  });
+
+  test('loads and returns data from server', async () => {
+    // arrange
+    const { id } = await addDoc(collection(db, 'test'), { name: 'bo' });
+
+    // act
+    const { result, waitFor, unmount } = renderHook(() =>
+      useDocument(doc(collection(db, 'test'), id))
+    );
+    await waitFor(() => result.current[1] === false);
+
+    // assert
+    expect(result.current[0]?.data()).toEqual({ name: 'bo' });
+
+    // clean up
+    unmount();
+  });
+});

jest.config.ts

@@ -0,0 +1,7 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+  testEnvironment: 'node',
+};
+
+export default config;