@pbvision/cloud-run-service 0.0.9 → 0.0.11

package/.env

@@ -0,0 +1,9 @@
+CLOUD_TASKS_EMULATOR_PORT=8123
+FIRESTORE_EMULATOR_HOST=[::1]:8404
+GCLOUD_PROJECT=localhost-emulator
+K_REVISION=unittest
+LOCAL_SERVICE_PORT_MAP='{}'
+NODE_ENV=localhost
+PORT=8080
+REGION=us-central1
+SERVICE=tbd

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

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

package/.vscode/settings.json

@@ -24,10 +24,12 @@
   "standard.autoFixOnSave": true,
   "standard.usePackageJson": true,
   "cSpell.words": [
+    "cloudsdktool",
     "cloudtasks",
     "esbenp",
     "fastify",
     "firestore",
+    "gcloud",
     "gserviceaccount",
     "INDEBUGGER",
     "oidc",

package/Dockerfile

@@ -6,8 +6,8 @@ WORKDIR /app
 COPY .npmrc package.json yarn.lock ./
 RUN yarn install --frozen-lockfile --production
 
-ARG PROJECT
-ENV PROJECT=${PROJECT}
+ARG GCLOUD_PROJECT
+ENV GCLOUD_PROJECT=${GCLOUD_PROJECT}
 ARG GIT_HASH
 ENV GIT_HASH=${GIT_HASH}
 

package/README.md

@@ -11,7 +11,7 @@
 ## Requirements
 
 - Must run with a service account named
-  `cr-${process.env.SERVICE}@${process.env.PROJECT}.iam.gserviceaccount.com`
+  `cr-${process.env.SERVICE}@${process.env.GCLOUD_PROJECT}.iam.gserviceaccount.com`
   with at least these permissions (along with whatever else your service
   requires):
   - `roles/run.invoker` - if the service needs to call other services
@@ -22,18 +22,25 @@
 
 - Environment variables:
   - Required:
+    - `GCLOUD_PROJECT` - the project ID this service is running in; must end in
+      `-dev` or `-prod`
     - `GIT_HASH` - the commit from which the current code was generated
     - `K_REVISION` - provided by cloud run (the revision ID)
-      - Can be `localhost`
+      - When running a local server, it will be `localhost`
+      - 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 return true.
-      - If this is `dev` then `isDev()` will return true.
-      - If this is `prod` then `isProd()` will return true.
-    - `PROJECT` - the project ID this service is running in
-      - Other endings are not allowed.
+      - 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/docs/cloudbuild/preview.example.yaml

@@ -10,7 +10,7 @@ steps:
       [
         "build",
         "--build-arg",
-        "PROJECT=$PROJECT_ID",
+        "GCLOUD_PROJECT=$PROJECT_ID",
         "--build-arg",
         "GIT_HASH=$COMMIT_SHA",
         "--tag",

package/docs/cloudbuild/release.example.yaml

@@ -10,7 +10,7 @@ steps:
       [
         "build",
         "--build-arg",
-        "PROJECT=$PROJECT_ID",
+        "GCLOUD_PROJECT=$PROJECT_ID",
         "--build-arg",
         "GIT_HASH=$COMMIT_SHA",
         "--tag",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/cloud-run-service",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "fastify-firestore-service Web Framework on Cloud Run",
   "license": "Apache-2.0",
   "type": "module",
@@ -10,14 +10,13 @@
   "exports": "./src/index.js",
   "scripts": {
     "coverage": "yarn -s start-local-db && yarn -s test --coverage",
-    "debug": "yarn -s start-local-db && GCLOUD_PROJECT=xyz-dev FIRESTORE_EMULATOR_HOST=[::1]:8404 INDEBUGGER=1 NODE_ENV=localhost PORT=8080 K_REVISION=unittest REGION=us-central1 PROJECT=xyz-dev GIT_HASH=`git rev-parse HEAD` SERVICE=tbd ./node_modules/nodemon/bin/nodemon.js --no-lazy --legacy-watch --watch ./src --watch ./test --inspect=9229 node --experimental-vm-modules ./node_modules/jest/bin/jest.js --config=./jest.config.json --runInBand",
+    "debug": "./node_modules/nodemon/bin/nodemon.js --no-lazy --legacy-watch --watch ./src --watch ./test --inspect=9229 node --experimental-vm-modules --exec yarn test --runInBand",
     "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0",
     "setup": "yarn install --frozen-lockfile",
-    "start-docker": "wd=`pwd`; tag=`basename $wd`; docker build --build-arg PROJECT=xyz-dev --build-arg GIT_HASH=`git rev-parse HEAD` . --tag $tag && docker run -p 127.0.0.1:8080:8080/tcp --env REGION='us-central1' --env PORT=8080 --env K_REVISION=localhost --env SERVICE=tbd $tag:latest && docker run $tag:latest",
     "start-local-db": "./node_modules/@pbvision/firestore-orm/scripts/start-local-db.sh",
+    "start-local": "yarn -s start-local-db && K_REVISION=localhost node --env-file=.env test/main.js",
     "test": "yarn -s start-local-db && yarn -s test-without-starting-db",
-    "test-without-starting-db": "GCLOUD_PROJECT=xyz-dev FIRESTORE_EMULATOR_HOST=${FIRESTORE_EMULATOR_HOST:=[::1]:8404} NODE_ENV=localhost PORT=8080 K_REVISION='unittest' REGION=us-central1 PROJECT=xyz-dev GIT_HASH=`git rev-parse HEAD` SERVICE=tbd node --experimental-vm-modules ./node_modules/jest/bin/jest.js --config=./jest.config.json",
-    "start-local": "yarn -s start-local-db && FIRESTORE_EMULATOR_HOST=[::1]:8404 NODE_ENV=localhost PROJECT=xyz-dev REGION=us-central1 PORT=8080 K_REVISION=localhost PROJECT=xyz-dev GIT_HASH=`git rev-parse HEAD` node src/main.js",
+    "test-without-starting-db": "node --env-file=.env --experimental-vm-modules ./node_modules/jest/bin/jest.js --config=./jest.config.json",
     "watch": "yarn -s test --watch"
   },
   "repository": {
@@ -29,7 +28,7 @@
   },
   "dependencies": {
     "@google-cloud/tasks": "^4.0.1",
-    "@pbvision/fastify-firestore-service": "^0.0.24",
+    "@pbvision/fastify-firestore-service": "^0.0.25",
     "google-auth-library": "^9.4.2"
   },
   "devDependencies": {

package/src/app.js

@@ -4,7 +4,6 @@ import { port } from './port.js'
 import { isProd } from './utils.js'
 
 export async function makePBVService (components, customizePinoOpts) {
-  const isProdEnv = isProd()
   return makeService({
     service: process.env.SERVICE,
     components,
@@ -15,16 +14,16 @@ export async function makePBVService (components, customizePinoOpts) {
       path: '/_healthcheck'
     },
     latencyTracker: {
-      disabled: isProdEnv
+      disabled: isProd
     },
     logging: {
       customizePinoOpts,
-      reportErrorDetail: !isProdEnv,
+      reportErrorDetail: !isProd,
       reportAllErrors: true,
       sentryDSN: process.env.sentryDSN
     },
     swagger: {
-      disabled: isProdEnv,
+      disabled: isProd,
       servers: [`http://localhost:${port}`],
       routePrefix: '/app/docs'
     }

package/src/main.js

@@ -5,20 +5,27 @@ 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 { isCloud, isLocalhost } from './utils.js'
 
 API.prototype.callServiceAPI = callServiceAPI
 
 let service
-const project = process.env.PROJECT
+const project = process.env.GCLOUD_PROJECT
 
 function verifyEnvironmentVariables () {
   const requiredEnvKeys = [
-    'GIT_HASH', 'K_REVISION', 'NODE_ENV', 'PROJECT', 'REGION', 'SERVICE']
+    'GCLOUD_PROJECT', 'K_REVISION', 'NODE_ENV', 'REGION', 'SERVICE']
+  // istanbul ignore else
+  if (isLocalhost) {
+    assert(['localhost', 'unittest'].indexOf(process.env.K_REVISION) !== -1,
+      'K_REVISION must be "localhost" or "unittest" in this environment')
+  } else {
+    // must have GIT_HASH to send to sentry in the cloud
+    requiredEnvKeys.push('GIT_HASH')
+  }
   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 () {
@@ -57,7 +64,7 @@ export async function makeService (components) {
 
 // istanbul ignore next
 export async function runService (components) {
-  if (process.env.K_REVISION !== 'unittest') {
+  if (isCloud) {
     // if the instance tells us it will shutdown, try to shut down gracefully (for
     // example flushing logs)
     process.on('SIGTERM', () => {
@@ -75,8 +82,8 @@ export async function runService (components) {
           console.log('an error happened', err)
         }), 7000)
     })
-    // start the server
-    service = await makeService(components)
-    service.listen({ port, host: '0.0.0.0' })
   }
+  // start the server
+  service = await makeService(components)
+  service.listen({ port, host: '0.0.0.0' })
 }

package/src/placeholder.js

@@ -35,7 +35,7 @@ export class TestCallServiceAPI extends API {
   static RESPONSE = { code: S.int, body: S.str }
 
   async computeResponse () {
-    assert(isUnitTesting())
+    assert(isUnitTesting)
     const resp = await this.callServiceAPI(this.req.body)
     return {
       code: resp.code,

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.
@@ -28,8 +39,9 @@ export async function enqueueCloudTask ({
   service = 'internal',
   name = undefined, ignoreNameAlreadyUsedError = false
 }) {
-  const parent = tasksClient.queuePath(
-    process.env.PROJECT, process.env.REGION, queue)
+  const project = process.env.GCLOUD_PROJECT
+  const region = process.env.REGION
+  const parent = tasksClient.queuePath(project, region, queue)
   const protocolAndHost = getServiceProtocolAndHost(service)
   const task = {
     httpRequest: {
@@ -40,12 +52,12 @@ export async function enqueueCloudTask ({
       url: `${protocolAndHost}/${queue.replace(/-/g, '_')}`,
       body: Buffer.from(JSON.stringify(payload)).toString('base64'),
       oidcToken: {
-        serviceAccountEmail: `cr-${process.env.SERVICE}@${process.env.PROJECT}.iam.gserviceaccount.com`
+        serviceAccountEmail: `cr-${process.env.SERVICE}@${project}.iam.gserviceaccount.com`
       }
     }
   }
   if (name) {
-    const fqName = tasksClient.taskPath(process.env.PROJECT, process.env.REGION, queue, name)
+    const fqName = tasksClient.taskPath(project, region, queue, name)
     task.name = fqName
   }
   const request = { parent, task }

package/src/utils.js

@@ -2,6 +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,
+  '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
@@ -10,11 +29,12 @@ export function getServiceProtocolAndHost (serviceName) {
 }
 
 export function getServiceHost (serviceName) {
-  if (isLocalhost()) {
+  // manually check NODE_ENV for testing purposes
+  if (process.env.NODE_ENV === 'localhost') {
     if (process.env.SERVICE === serviceName) {
       return `localhost:${portForThisService}`
     }
-    const portMapping = JSON.parse(process.env.LOCAL_SERVICE_PORT_MAP ?? 'null')
+    const portMapping = JSON.parse(process.env.LOCAL_SERVICE_PORT_MAP)
     const port = portMapping[serviceName]
     assert(port, `unknown service or missing port for localhost ${serviceName}`)
     return `localhost:${port}`
@@ -23,25 +43,4 @@ export function getServiceHost (serviceName) {
   }
 }
 
-export function isLocalhost () {
-  assert(process.env.NODE_ENV)
-  return process.env.NODE_ENV === 'localhost'
-}
-
-export function isUnitTesting () {
-  const ret = process.env.K_REVISION === 'unittest'
-  assert(!ret || isLocalhost(), 'must on localhost if in unit tests')
-  return ret
-}
-
-export function isProd () {
-  assert(process.env.NODE_ENV)
-  return process.env.NODE_ENV === 'prod'
-}
-
-export function isDev () {
-  assert(process.env.NODE_ENV)
-  return process.env.NODE_ENV === 'dev'
-}
-
 export const now = () => Math.floor(new Date().getTime() / 1000)

package/test/main.js

@@ -0,0 +1,4 @@
+import { runService } from '../src/index.js'
+const { TestAPI, TestCallServiceAPI } = await import('../src/placeholder.js')
+
+await runService({ TestAPI, TestCallServiceAPI })

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
 
@@ -17,21 +17,14 @@ class TestUtils extends BaseTest {
   }
 
   testEnv () {
+    expect(process.env.GIT_HASH).toBe(undefined)
     expect(process.env.K_REVISION).toBe('unittest')
     expect(process.env.NODE_ENV).toBe('localhost')
-    expect(isLocalhost()).toBe(true)
-    expect(isProd()).toBe(false)
-    expect(isDev()).toBe(false)
-
-    process.env.NODE_ENV = 'dev'
-    expect(isLocalhost()).toBe(false)
-    expect(isProd()).toBe(false)
-    expect(isDev()).toBe(true)
-
-    process.env.NODE_ENV = 'prod'
-    expect(isLocalhost()).toBe(false)
-    expect(isProd()).toBe(true)
-    expect(isDev()).toBe(false)
+    expect(isLocalhost).toBe(true)
+    expect(isCloud).toBe(false)
+    expect(isProd).toBe(false)
+    expect(isDev).toBe(false)
+    expect(usingEmulator).toBe(true)
   }
 
   testGetServiceHost () {