Run firebase emulators + vitest at once

Question

I'm trying to run two jobs at the same time. First I need to run firebase emulators and when the ports are open, I need to run vitest.

This is what I'm doing at the moment:

name: Run Tests

on:
  pull_request:
    branches: [develop]
  workflow_dispatch:

jobs:
  job1:
    name: Run Emulator
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Use Node.js 18.14.0
        uses: actions/setup-node@v3
        with:
          node-version: 18.14.0
          cache: 'npm'
      - name: Execute Emulator
        env:
          VITE_RELEASE_STAGE: testing
        run: |
          npm ci
          npm install --save firebase-tools
          npm run emulators
  job2:
    name: Run Unit Tests
    needs: job1
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Use Node.js 18.14.0
        uses: actions/setup-node@v3
        with:
          node-version: 18.14.0
          cache: 'npm'
      - name: Execute Unit Tests
        env:
          VITE_RELEASE_STAGE: testing
        run: |
          npm ci
          npm run test

The doors open perfectly, but the second job never runs.

Here lies my doubt. Because if I don't use needs the two will run at the same time and I will get an error in job2 because the ports will not be open in job 1.

I would like to run job 2 as soon as the emulator ports are open and finish job 1 only after job 2 finishes.

Does anyone know how I can resolve this?

EDIT

These are the two executed scripts that are in my package.json:

"test": "vitest",
"emulators": "firebase emulators:start --project celebrityfanalizer --import emulatorData"

GHA jobs run in different runners. In your workflow, the first job never finishes. You can combine both jobs, run emulators in the background, and then run tests in the same job. — Azeem, Feb 18 '23 at 15:25
I got it, that's my intention. But how do I run emulators in the background? — ARNON, Feb 19 '23 at 19:16
See https://stackoverflow.com/questions/3683910/executing-shell-command-in-background-from-script. — Azeem, Feb 20 '23 at 06:15

score 1 · Accepted Answer · answered Feb 21 '23 at 05:35

In your workflow, the job1 never finishes because the emulators are running in it and that's why the job2 never runs when you add its dependency on job1 i.e. needs: job1.

You need to combine both jobs in one:

set up the environment
start the emulators in the background
wait for the emulators to start
- add some delay (along with a dump of its STDOUT/STDERR to a file and keep checking its contents for success logs e.g. "Emulator hub running")
and, finally, run tests

Here's an example with a delay of 1 minute after starting the emulators in the background:

name: Run Tests in the Emulators

on:
  pull_request:
    branches: [develop]
  workflow_dispatch:

jobs:
  ci:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v3

    - name: Set up NodeJS 18.14.0
      uses: actions/setup-node@v3
      with:
        node-version: 18.14.0
        cache: 'npm'

    - name: Start the emulators and run tests
      env:
        VITE_RELEASE_STAGE: testing
      run: |
        npm ci
        npm install --save firebase-tools
        nohup npm run emulators &> emulators.log &
        sleep 1m
        npm run test

Relevant:

executing shell command in background from script

Apart from that, you can use jobs.<job_id>.services and run the emulators in a container if it's available.

@ARNON: You're welcome! You may observe and adjust `sleep` accordingly. Maybe, you need a lower sleep time in between. I just put `sleep 1m` after looking at `2m 53s` in your snapshot. Most probably, it was due to the fact that you let it run a bit and then took the snapshot. — Azeem, Feb 23 '23 at 10:02

Run firebase emulators + vitest at once

1 Answers1