Corvid by Wix DB Connectors: External Database Adapter for Google Cloud Firestore with Cloud Run or AppEngine

This project is a Node.js based adapter for Google Cloud Firestore, that lets you integrate an external database with your Corvid enabled Wix site.

You can use this project as a basis for deploying your own adapter to either Google Cloud Run or AppEngine. This project is implementation of the external database collection SPI that has filtering, authorization and error handling support.

You can learn more about working with external database collections in Corvid.

See our SPI documentation.

Getting started

This project assumes you have a Google Cloud Project with billing enabled. If you don't have one, follow this free trial guide.

Enable Firestore in Native Mode

Go to https://console.cloud.google.com/firestore/welcome and select Native Mode

Deploying to Cloud Run using Cloud Console

Follow the instructions in the Google Cloud Run Quickstart Guide.

In the Create service form use the following settings:

Container Image: Use gcr.io/corvid-api/firestore-connector-node.
Deployment Platform: Select Cloud Run (fully managed).
Location: Select us-east1 region.
Authentication: Select Allow unauthenticated invocations. This enables access to the connector from Corvid.
Show Optional Settings: Add an Environment variable named "SECRET_KEY" with your secret key as the value. This value is used for connecting to your Corvid enabled site.
Click Create to deploy the image to Google Cloud Run and wait for the deployment to finish.

Click the displayed URL link to test the deployed connector. In the browser you should see the following, which indicates that the connector is running:

{"message":"Missing request context"}

Copy the service URL. You will need it to connect Firestore to your Corvid enabled Wix site.

Deploying to Google Cloud Run using the gcloud CLI

Install the Google Cloud SDK for your operating system.
Acquire new user credentials to use for Application Default Credentials:
```
gcloud auth application-default login
```
Set your project as the default:
```
gcloud config set project PROJECTID
```
Deploy the Corvid connector container:
```
gcloud run deploy --image gcr.io/corvid-api/firestore-connector-node --platform managed --region us-east1 --set-env-vars SECRET_KEY=[YOUR SECRET KEY]
```
a. At the prompt: Allow unauthenticated invocations to [firestore-connector-node] (Y/N)? Choose "Y".

b. When deployment is successful, the command line output will contain something similar to this:

Service [firestore-connector-node] revision [firestore-connector-node-00001-nep] has been deployed and is serving 100 percent of traffic at https://firestore-connector-node-[autogenerated].run.app

Copy the service URL. You will need it to connect Firestore to your Corvid enabled Wix site.

Deploying to Google App Engine using gcloud CLI

Check out the source code:

 git clone https://github.com/wix-incubator/firestore-connector-node.git
 cd firestore-connector-node

Set the SECRET_KEY in the app.yaml file:

sed -i -e 's/myFirebaseSecret/[YOUR SECRET KEY]/' app.yaml

Deploy the local code and/or configuration of your app to App Engine:

gcloud app deploy

After deployment, access your service at https://<project id>.appspot.com/
Test your adaptor by running

curl --location --request POST 'https://corvid-firestore-connector-dot-<project-id>.uc.r.appspot.com/schemas/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestContext": {
        "settings": {
            "secretKey": [YOUR SECRET KEY]
        }
    }
}'

Connecting Firestore to your Corvid enabled Wix site

Follow the instructions here.

In the connection Dialog settings use the following:

Add an endpoint URL: Use the connector service URL from steps above.
Configuration: Use: {"secretKey":<Your secret key from the deployment step>}

You should now see Firestore collections in the Databases sections of the sidebar in your site.

Developing the adapter

Check out the source code:

 git clone https://github.com/wix-incubator/firestore-connector-node.git
 cd firestore-connector-node

Create a GCP Service account:

gcloud iam service-accounts create corvid --description Corvid Dev account --display-name corvid-dev

Run the following command and copy its output, which you will use in step 4:

gcloud iam service-accounts list

Generate the Service Account key and save it in gcp-sa-key.json:

gcloud iam service-accounts keys create gcp-sa-key.json --iam-account <Service account name from Step 3>

Set an environment variable for GCP client libraries:

export GOOGLE_APPLICATION_CREDENTIALS=$PWD/gcp-sa-key.json

Use the following command to start the Connector. It is a NodeJS express application:

npm install

npm start

Jackiebibili / corvid-external-db-firestore-adapter