Connector packaging (#1)

* Expect service account file path in env var

* Dump API metadata into intermediate configuration.json file

* Add Dockerfile to build the connector

* GH_TOKEN -> GITHUB_TOKEN

* Expand root .dockerignore with git related stuff

* Update package-lock.json

* Fix Dockerfile and file path append

* Update README

* Add date format in field descriptions

* Push down dimension and metrics filters to APIs

* Implement more filters

* Include descriptions of dimensions and metrics in the schema

Author: rakeshkky

.dockerignore

@@ -0,0 +1,17 @@
+google_auth_config.json
+configuration.json
+node_modules/
+dist/
+.env
+.DS_Store
+*.log
+*.tmp
+coverage/
+.vscode/
+.idea/
+*.swp
+*.bak
+*.orig
+.gitignore
+.git
+.github

.github/workflows/build-and-push.yml

@@ -0,0 +1,43 @@
+name: Build and Push Multi-arch Docker Image
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to build and push'
+        required: true
+        type: string
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: hasura/ndc-promptql-ga4
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        env:
+          VERSION: ${{ inputs.version }}
+        run: |
+          docker buildx build \
+            --platform linux/amd64,linux/arm64 \
+            --tag ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.VERSION }} \
+            --push .

.gitignore

@@ -1,4 +1,5 @@
-config.json
+google_auth_config.json
+configuration.json
 node_modules/
 dist/
 .env
@@ -10,4 +11,4 @@ coverage/
 .idea/
 *.swp
 *.bak
-*.orig
+*.orig

Dockerfile

@@ -0,0 +1,16 @@
+FROM node:20-alpine
+
+RUN apk add --no-cache bash
+
+RUN npm update -g npm
+
+COPY ./ /app/
+WORKDIR /app
+
+RUN --mount=type=cache,target=/root/.npm npm ci
+RUN npm run install-bin
+
+RUN mkdir /etc/connector
+WORKDIR /etc/connector
+
+CMD ["ga4-connector", "serve", "--configuration", "configuration.json"]

README.md

@@ -1,10 +1,23 @@
 # promptql-GA4
 
-Requires config.json to be added in the root directory
+Requires `google_auth_config.json` to be added in the root directory
+
+```json
+{
+    "property_id": "123456789",
+    "domain": "example.com",
+    "credentials": { <service account json credentials> }
+}
+```
 
 ### To compile:
- `npx ts`
 
+`npm run build`
+
+### To generate `configuration.json`:
+
+`npm run generate-config`
+
+### To start connector:
 
-### To run locally:
- `node dist/index.js serve --port 8200 --configuration config.json`
+`npm run start`

connector-definition/.dockerignore

@@ -0,0 +1,2 @@
+*.hml
+.hasura-connector/

connector-definition/.gitignore

@@ -0,0 +1 @@
+google_auth_config.json

connector-definition/.hasura-connector/connector-metadata.yaml

@@ -0,0 +1,34 @@
+version: v2
+ndcSpecGeneration: v0.2
+packagingDefinition:
+  type: PrebuiltDockerImage
+  dockerImage: ghcr.io/hasura/ndc-promptql-ga4:v0.1.0
+supportedEnvironmentVariables:
+  - name: GOOGLE_AUTH_CONFIG_FILEPATH
+    description: Filepath for the Google Auth config file relative to the connector directory.
+    required: false
+    defaultValue: "google_auth_config.json"
+commands:
+  update:
+    type: Dockerized
+    dockerImage: ghcr.io/hasura/ndc-promptql-ga4:v0.1.0
+    commandArgs:
+      - "ga4-connector-cli"
+      - "update"
+      - "--outfile"
+      - "/etc/connector/configuration.json"
+cliPlugin:
+  type: Docker
+  dockerImage: ghcr.io/hasura/ndc-promptql-ga4:v0.1.0
+dockerComposeWatch:
+  # Rebuild the container if a new package restore is required because package[-lock].json changed
+  - path: package.json
+    target: /app/package.json
+    action: rebuild
+  - path: package-lock.json
+    target: /app/package-lock.json
+    action: rebuild
+  # For any other file change, simply copy it into the existing container and restart it
+  - path: ./
+    target: /app
+    action: sync+restart

package-lock.json

@@ -1,9 +1,17 @@
 {
   "name": "ga4-connector",
-  "version": "1.0.0",
-  "main": "index.js",
+  "version": "0.1.0",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "format": "npx prettier --write src/**/*.ts",
+    "build": "tsc",
+    "generate-config": "HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH=./ GOOGLE_AUTH_CONFIG_FILEPATH=google_auth_config.json node dist/cli.js update --output configuration.json",
+    "start": "HASURA_CONFIGURATION_DIRECTORY=./ GOOGLE_AUTH_CONFIG_FILEPATH=google_auth_config.json node dist/index.js serve --port 8200 --configuration configuration.json",
+    "install-bin": "npm run build && npm install -g ."
+  },
+  "bin": {
+    "ga4-connector": "./dist/index.js",
+    "ga4-connector-cli": "./dist/cli.js"
   },
   "keywords": [],
   "author": "",
@@ -12,6 +20,7 @@
   "dependencies": {
     "@google-analytics/data": "^5.1.0",
     "@hasura/ndc-sdk-typescript": "^7.1.0",
+    "commander": "^14.0.0",
     "google-auth-library": "^10.1.0",
     "undici": "^7.13.0",
     "undici-types": "^7.13.0"