@pbvision/cloud-run-service 0.0.10 → 0.0.11

package/.env

@@ -1,5 +1,6 @@
+CLOUD_TASKS_EMULATOR_PORT=8123
 FIRESTORE_EMULATOR_HOST=[::1]:8404
-GCLOUD_PROJECT=xyz-dev
+GCLOUD_PROJECT=localhost-emulator
 K_REVISION=unittest
 LOCAL_SERVICE_PORT_MAP='{}'
 NODE_ENV=localhost

package/.github/workflows/check-pr.yml

@@ -21,7 +21,7 @@ jobs:
         shell: bash
       - name: 'Setup Firestore Emulator'
         run: |
-          echo '{ "projects": { "default": "xyz-dev" } }' > ./.firebaserc
+          echo '{ "projects": { "default": "localhost-emulator" } }' > ./.firebaserc
           echo '{ "firestore": {} }' > ./firebase.json
           npm install -g firebase-tools
           firebase setup:emulators:firestore

package/README.md

@@ -30,12 +30,17 @@
       - When running it unit tests, it should be`unittest`
         - If this is `unittest` then `isUnitTesting` will be true.
     - `NODE_ENV`
-      - If this is `localhost` then `isLocalhost` will be true.
+      - If this is `localhost` then `isLocalhost` will be true. This is always
+        the case when running locally, even if we're connecting to real cloud resources (like Firestore or Task Queue).
+        - `isCloud` is the opposite of `isLocalhost`.
       - If this is `dev` then `isDev` will be true.
       - If this is `prod` then `isProd` will be true.
     - `REGION` - the region this service's cloud run is located in
     - `SERVICE` - the name of this service
   - Optional:
+    - Emulation (must provide all or none of these) for GCP services:
+      - `CLOUD_TASKS_EMULATOR_PORT`
+      - `FIRESTORE_EMULATOR_HOST`
     - `CLOUD_RUN_HOSTNAME_SUFFIX` - the hostname of our cloud run instances in
       this region, excluding the `SERVICE` name portion at the beginning. Only
       required if using the `callServiceAPI()` function.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/cloud-run-service",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "fastify-firestore-service Web Framework on Cloud Run",
   "license": "Apache-2.0",
   "type": "module",

package/src/main.js

@@ -5,7 +5,7 @@ import { API } from '@pbvision/fastify-firestore-service'
 import { makePBVService } from './app.js'
 import { callServiceAPI } from './call-service-api.js'
 import { port } from './port.js'
-import { isLocalhost } from './utils.js'
+import { isCloud, isLocalhost } from './utils.js'
 
 API.prototype.callServiceAPI = callServiceAPI
 
@@ -17,7 +17,6 @@ function verifyEnvironmentVariables () {
     'GCLOUD_PROJECT', 'K_REVISION', 'NODE_ENV', 'REGION', 'SERVICE']
   // istanbul ignore else
   if (isLocalhost) {
-    assert(process.env.FIRESTORE_EMULATOR_HOST, 'use emulator on localhost')
     assert(['localhost', 'unittest'].indexOf(process.env.K_REVISION) !== -1,
       'K_REVISION must be "localhost" or "unittest" in this environment')
   } else {
@@ -27,8 +26,6 @@ function verifyEnvironmentVariables () {
   for (const k of requiredEnvKeys) {
     assert(process.env[k], `${k} environment variable must be set`)
   }
-  assert(['localhost', 'dev', 'prod'].indexOf(process.env.NODE_ENV) !== -1,
-    `invalid NODE_ENV: ${process.env.NODE_ENV}`)
 }
 
 function makeCustomizeLoggingOptionsFunction () {
@@ -67,7 +64,7 @@ export async function makeService (components) {
 
 // istanbul ignore next
 export async function runService (components) {
-  if (!isLocalhost) {
+  if (isCloud) {
     // if the instance tells us it will shutdown, try to shut down gracefully (for
     // example flushing logs)
     process.on('SIGTERM', () => {

package/src/tasks.js

@@ -1,8 +1,19 @@
 import { CloudTasksClient } from '@google-cloud/tasks'
+import { credentials } from '@grpc/grpc-js'
 
-import { getServiceProtocolAndHost } from './utils.js'
+import { getServiceProtocolAndHost, usingEmulator } from './utils.js'
 
-const tasksClient = new CloudTasksClient()
+const tasksClient = (() => {
+  if (usingEmulator) {
+    return new CloudTasksClient({
+      port: process.env.CLOUD_TASKS_EMULATOR_PORT,
+      servicePath: 'localhost',
+      sslCreds: credentials.createInsecure()
+    })
+  }
+  // istanbul ignore next
+  return new CloudTasksClient()
+})()
 
 /**
  * Add a Task to a Cloud Tasks queue.

package/src/utils.js

@@ -2,15 +2,25 @@ import assert from 'node:assert'
 
 import { port as portForThisService } from './port.js'
 
+// this refers to where the code is running; the database and other services
+// we are connected to depends on GCLOUD_PROJECT
 export const isLocalhost = process.env.NODE_ENV === 'localhost'
+export const isCloud = !isLocalhost
 export const isDev = process.env.NODE_ENV === 'dev'
 export const isProd = process.env.NODE_ENV === 'prod'
 // istanbul ignore next
-assert(isLocalhost || isDev || isProd, 'must be on localhost, dev or prod')
+assert(isLocalhost || isDev || isProd,
+  'invalid NODE_ENV: must be on localhost, dev or prod')
 
 export const isUnitTesting = process.env.K_REVISION === 'unittest'
 assert(!isUnitTesting || isLocalhost, 'must be on localhost if unit testing')
 
+export const usingEmulator = !!process.env.FIRESTORE_EMULATOR_HOST
+assert(!usingEmulator || process.env.CLOUD_TASKS_EMULATOR_PORT,
+  'both firestore and tasks need to be either emulated or not')
+assert(usingEmulator === (process.env.GCLOUD_PROJECT === 'localhost-emulator'),
+  'when using the emulator, GCLOUD_PROJECT should be set to localhost-emulator')
+
 export function getServiceProtocolAndHost (serviceName) {
   const host = getServiceHost(serviceName)
   // istanbul ignore next

package/test/unit-test-tasks.js

@@ -38,16 +38,16 @@ class TestTasks extends BaseTest {
       await promise
     }
     expect(CloudTasksClient.prototype.createTask).toHaveBeenCalledWith({
-      // assuming values for project (xyz-dev) and region (us-central1) and
+      // assuming values for project (localhost-emulator) and region (us-central1) and
       // service (tbd)
-      parent: 'projects/xyz-dev/locations/us-central1/queues/test-queue',
+      parent: 'projects/localhost-emulator/locations/us-central1/queues/test-queue',
       task: {
         httpRequest: {
           body: Buffer.from(JSON.stringify(args.payload)).toString('base64'),
           headers: { 'Content-Type': 'application/json' },
           httpMethod: 'POST',
           oidcToken: {
-            serviceAccountEmail: 'cr-tbd@xyz-dev.iam.gserviceaccount.com'
+            serviceAccountEmail: 'cr-tbd@localhost-emulator.iam.gserviceaccount.com'
           },
           url: 'http://localhost:8888/test_queue'
         },
@@ -63,7 +63,7 @@ class TestTasks extends BaseTest {
   async testEnqueueTaskWithName () {
     await this.check(
       { name: 'x', payload: { x: 3 } },
-      { name: 'projects/xyz-dev/locations/us-central1/queues/test-queue/tasks/x' })
+      { name: 'projects/localhost-emulator/locations/us-central1/queues/test-queue/tasks/x' })
   }
 
   async testEnqueueTaskWithNameThatWasRecentlyUsedNOTOkay () {
@@ -74,7 +74,7 @@ class TestTasks extends BaseTest {
     })
     await this.check(
       { name: 'x', payload: { x: 3 }, ignoreNameAlreadyUsedError: true },
-      { name: 'projects/xyz-dev/locations/us-central1/queues/test-queue/tasks/x' })
+      { name: 'projects/localhost-emulator/locations/us-central1/queues/test-queue/tasks/x' })
   }
 
   async testEnqueueTaskWithNameThatWasRecentlyUsedAndThatsOkay () {
@@ -85,7 +85,7 @@ class TestTasks extends BaseTest {
     })
     await this.check(
       { name: 'x', payload: { x: 3 } },
-      { name: 'projects/xyz-dev/locations/us-central1/queues/test-queue/tasks/x' },
+      { name: 'projects/localhost-emulator/locations/us-central1/queues/test-queue/tasks/x' },
       'task name already used recently: x')
   }
 
@@ -96,7 +96,7 @@ class TestTasks extends BaseTest {
     })
     await this.check(
       { name: 'x', payload: { x: 3 } },
-      { name: 'projects/xyz-dev/locations/us-central1/queues/test-queue/tasks/x' },
+      { name: 'projects/localhost-emulator/locations/us-central1/queues/test-queue/tasks/x' },
       'not in right format')
   }
 }

package/test/unit-test-utils.js

@@ -2,7 +2,7 @@ import { jest } from '@jest/globals'
 
 import { BaseTest, runTests } from '../node_modules/@pbvision/fastify-firestore-service/test/base-test.js'
 import { port } from '../src/port.js'
-import { getServiceHost, isDev, isLocalhost, isProd } from '../src/utils.js'
+import { getServiceHost, isCloud, isDev, isLocalhost, isProd, usingEmulator } from '../src/utils.js'
 
 const ORIG_ENV = process.env
 
@@ -21,8 +21,10 @@ class TestUtils extends BaseTest {
     expect(process.env.K_REVISION).toBe('unittest')
     expect(process.env.NODE_ENV).toBe('localhost')
     expect(isLocalhost).toBe(true)
+    expect(isCloud).toBe(false)
     expect(isProd).toBe(false)
     expect(isDev).toBe(false)
+    expect(usingEmulator).toBe(true)
   }
 
   testGetServiceHost () {