feat: new rawBody type on SvelteKit req (#123)

Author: jthegedus

.github/workflows/test.yaml

@@ -8,8 +8,7 @@ on:
 
 env:
   CI: true
-  # ASDF_DIR: /home/runner/.asdf
-  # FIREBASE_EMULATORS_PATH: ${{ github.workspace }}/emulator-cache
+  FIREBASE_EMULATORS_PATH: ${{ github.workspace }}/emulator-cache
 
 jobs:
   unit:
@@ -22,65 +21,59 @@ jobs:
       - run: pnpm run test
 
   integration:
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
+    needs:
+      - unit
     strategy:
-      fail-fast: false
+      fail-fast: true
       matrix:
-        dirs:
-          - examples/functions_single_site
-          - examples/nested_app_dirs/app
-          - examples/run_custom_build_dir
-          - examples/run_single_site
-        os:
-          - ubuntu-latest
-          - macos-latest
-          - windows-latest
+        params:
+          - {
+              test_dir: "functions_single_site",
+              validation_app_dir: "public/about/index.html",
+              validation_compute_dir: "functions/sveltekit/index.js",
+              nested_dir: "."
+            }
+          - {
+              test_dir: "nested_app_dirs",
+              validation_app_dir: "public/about/index.html",
+              validation_compute_dir: "functions/sveltekit/index.js",
+              nested_dir: "app"
+            }
+          - {
+              test_dir: "run_custom_build_dir",
+              validation_app_dir: "public/about/index.html",
+              validation_compute_dir: "custom-cloud-run-build-dir/index.js",
+              nested_dir: "."
+            }
+          - {
+              test_dir: "run_single_site",
+              validation_app_dir: "public/about/index.html",
+              validation_compute_dir: ".cloudrun/index.js",
+              nested_dir: "."
+            }
+    steps:
+      - uses: actions/checkout@v2
+      - name: install asdf
+        uses: asdf-vm/actions/install@v1
+      - name: Run Integration test for ${{ matrix.params.test_dir }}
+        run: |
+          bash ./tests/integration/integration-test.bash ${{ matrix.params.test_dir }} ${{ matrix.params.validation_app_dir }} ${{ matrix.params.validation_compute_dir }} ${{ matrix.params.nested_dir }}
+
+  end-to-end:
+    runs-on: ubuntu-latest
+    needs:
+      - unit
     steps:
       - uses: actions/checkout@v2
       - name: install asdf
-        if: matrix.os != 'windows-latest'
         uses: asdf-vm/actions/install@v1
-      # START: Windows
-      - name: install Node.js on Windows
-        if: matrix.os == 'windows-latest'
-        uses: actions/setup-node@v2
+      - name: Cache firebase emulators
+        uses: actions/cache@v2
         with:
-          node-version: 14.16.1
-      - name: install pnpm on Windows
-        if: matrix.os == 'windows-latest'
-        run: curl -f https://get.pnpm.io/v6.js | node - add --global pnpm@6
-      # END: Windows
-      - name: Install svelte-adapter-firebase deps
-        run: pnpm install
-      - name: Install example app deps
-        run: pnpm install
-        working-directory: ${{ matrix.dirs }}
-      - name: Build example app
-        run: pnpm run build
-        working-directory: ${{ matrix.dirs }}
-  # end-to-end:
-  #   runs-on: ubuntu-latest
-  #   if: github.event_name == 'push'
-  #   needs: [unit, integration]
-  #   steps:
-  #     - uses: actions/checkout@v2
-  #     - name: install asdf
-  #       uses: asdf-vm/actions/install@v1
-  #       with:
-  #         before_install: bash -c '${ASDF_DATA_DIR:=$HOME/.asdf}/plugins/nodejs/bin/import-release-team-keyring'
-  #     - name: Cache firebase emulators
-  #       uses: actions/cache@v2
-  #       with:
-  #         path: ${{ env.FIREBASE_EMULATORS_PATH }}
-  #         key: ${{ runner.os }}-firebase-emulators-${{ hashFiles('emulator-cache/**') }}
-  #     - name: Install svelte-adapter-firebase deps
-  #       run: pnpm install
-  #     - name: Install example app deps
-  #       run: pnpm install
-  #       working-directory: examples/functions_single_site
-  #     - name: Build example app
-  #       run: pnpm run build
-  #       working-directory: examples/functions_single_site
-  #     - name: E2E tests with Firebase Emulator
-  #       run: firebase emulators:exec --only hosting,functions
-  #       working-directory: examples/functions_single_site '[ "$(curl localhost:5000/ -o /dev/stderr -w "%{http_code}")" -eq 200 ]'
+          path: ${{ env.FIREBASE_EMULATORS_PATH }}
+          key: ${{ runner.os }}-firebase-emulators-${{ hashFiles('emulator-cache/**') }}
+        continue-on-error: true
+      - name: Run end-to-end test script
+        run: |
+          bash ./tests/end-to-end/test.bash

.tool-versions

@@ -1,4 +1,5 @@
-firebase 9.10.2
-nodejs 14.17.0
-pnpm 6.3.0
+firebase 9.16.5
+nodejs 14.17.5
+pnpm 6.13.0
+# use for Firebase Emulator
 java openjdk-14.0.2

CONTRIBUTING.md

@@ -27,3 +27,31 @@ pnpm i
 See the [GitHub Issues](https://github.com/jthegedus/svelte-adatper-firebase/issues) list for any open Issue, especially those marked as `help wanted`
 
 General improvements to any aspect of this adapter are welcome, just ensure major work is preceeded by a conversation in a [GitHub Issue](https://github.com/jthegedus/svelte-adatper-firebase/issues).
+
+## Tests
+
+As an integration point between [SvelteKit](https://kit.svelte.dev) and Firebase Hosting with Function rewrites the tests for this package are **important**.
+
+The test suite is broken into three categories:
+
+- **unit**: test internal functions to the CLI & entrypoint JS code
+- **integration**: runs the `build` command of SvelteKit with demo apps that tests each path of the src/index.js CLI entrypoint.
+- **end-to-end**: runs a shell script which:
+  - creates the SvelteKit Todo skeleton app (via `npm init@svelte <dir>`)
+  - adds Firebase configuration for Hosting & Cloud Functions
+  - adds `svelte-adapter-firebase` (relative add of the repo root, not from `npmjs.com`, to test current code changes before publishing)
+  - creates the Cloud Function which hosts the compiled SvelteKit app (this is the code in `functions/index.js` that the CLI would prompt the user to add)
+  - installs all dependencies for the Todo app & Cloud Functions
+  - builds the app
+  - starts the Firebase Emulator with Hosting & Functions
+  - makes `curl` requests to the Todo app
+    - GET to `/`
+    - GET to `/about`
+    - GET to `/todos`
+    - POST with formdata to `/todos`
+
+- Unit tests are run pre-push. They can be run manually with `pnpm run test`
+- Integration tests are run in CI.
+- End-to-end tests are run in CI. This script can be run locally with `./tests/end-to-end/test.bash`
+
+All test suites are run in CI pipelines on PR creation.