add cli plugin (#18)

* update cli plugin

* update dockerfile

* add run docker run command

* update ndc-test command

* wip: add start command

* wip: add start command

* Add command to run the connector from the CLI

* Fix the CLI

* update package-lock file

* wip: fix ci tests

* wip: fix ci tests try 2

* add comment

* try to fic ci error

* run the connector without any explicit command

* update connector dockerfile

* update sequence of enpoint details in the config file

* minor update to dockerfile

* add start command

* Exit with status 0 after update

* add start command to connector-metadata.yaml file + remove jaeger

* wait for config generation to complete

---------

Co-authored-by: Karthikeyan C <[email protected]>

.github/workflows/ci.yml

@@ -52,4 +52,5 @@ jobs:
 
       - name: Run ndc-test
         working-directory: ndc-spec
-        run: cargo run --bin ndc-test -- replay --endpoint http://0.0.0.0:8080 --snapshots-dir ../cosmos/ndc-test-snapshots
+        # temporary-solution: the --no-validate-responses flag is used to avoid the errors from the changes in ndc-spec in [PR:141](https://github.com/hasura/ndc-spec/pull/141)
+        run: cargo run --bin ndc-test -- replay --endpoint http://0.0.0.0:8080 --snapshots-dir ../cosmos/ndc-test-snapshots --no-validate-responses

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 dist
 .env
+config.json

Dockerfile

@@ -0,0 +1,12 @@
+FROM node:20
+
+COPY ./ /app
+WORKDIR /app
+
+RUN npm install
+RUN npm run install-bin
+
+RUN mkdir /etc/connector/
+WORKDIR /etc/connector/
+
+ENTRYPOINT [ "ndc-azure-cosmos" ]

README.md

@@ -3,14 +3,20 @@
 The Azuer Cosmos DB connector allows you to query data present in your Azure Cosmos DB containers as NDC models
 for use in your Hasura DDN subgraphs.
 
-## Steps for setting up the local development
+## Steps for building and running the connector 
+
+### Using docker
+
+
+
+### Using CLI
 
 1. Make sure NodeJS v18+ is installed.
 
 2. Run the following command to install all the required dependencies:
 
 ```sh
-npm install -g
+npm i
 ```
 
 3. To build the connector,
@@ -30,7 +36,8 @@ export AZURE_COSMOS_DB_NAME=<YOUR_AZURE_DB_NAME>
 5. Generate the configuration required to run the connector:
 
 ```sh
-ndc-azure-cosmos-config update
+npm install -g
+ndc-azure-cosmos update
 ```
 
 This will generate a `config.json` file in the root directory, by default. The
@@ -39,15 +46,15 @@ location of this file can be configured by providing the `--output-directory` co
 4. To start the connector,
 
 ```sh
-npm run start serve --configuration .
+npm run start serve -- --configuration .
 ```
 
 The `--configuration` directory should contain the configuration file generated in the previous step.
 
 Alternatively, to use a local Azure Cosmos emulator, start the connector with the following command,
 
 ```sh
-npm run start serve --configuration connector_config_emulator.json
+npm run start serve -- --configuration connector_config_emulator.json
 ```
 
 The emulator can be setup by following [this](https://learn.microsoft.com/en-us/azure/cosmos-db/how-to-develop-emulator?pivots=api-nosql&tabs=windows%2Ccsharp) link.
@@ -68,13 +75,13 @@ node app.js
 
 ```sh
 npm run build
-npm run start serve --configuration connector_config_emulator.json
+npm run start serve -- --configuration connector_config_emulator.json
 ```
 
 4. Checkout to the [ndc-spec repository](https://github.com/hasura/ndc-spec) and run
 
 ```sh
-cargo run --bin ndc-test -- replay --endpoint http://localhost:8080 --snapshots-dir ../ndc-azure-cosmos-connector/ndc-test-snapshots
+cargo run --bin ndc-test -- replay --endpoint http://localhost:8080 --snapshots-dir ../ndc-azure-cosmos-connector/ndc-test-snapshots --no-validate-responses
 ```
 
 Note:

connector-definition/.hasura-connector/.dockerignore

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

.hasura-connector/Dockerfile → connector-definition/.hasura-connector/Dockerfile

@@ -1,30 +1,7 @@
 # Use Node.js 20 as the base image
-FROM node:20 as build-stage
+FROM ghcr.io/hasura/ndc-azure-cosmos:v0.1.0
 
-WORKDIR /usr/src/app
-
-COPY package*.json ./
-
-# Install dependencies only first
-RUN npm install
-
-RUN npm install -g typescript
-
-COPY . .
-
-RUN tsc
-
-FROM node:20 as production
-
-WORKDIR /usr/src/app
-
-COPY package*.json ./
-
-RUN npm install
-
-COPY --from=build-stage /usr/src/app/dist ./dist
-
-RUN mkdir /etc/connector
+WORKDIR /app
 
 # Define the environment variable for configuration directory with a default value, which can be overridden
 ENV HASURA_CONFIGURATION_DIRECTORY=/etc/connector

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

@@ -12,3 +12,4 @@ supportedEnvironmentVariables:
     default: "100"
 commands:
   update: docker run --rm -e AZURE_COSMOS_KEY="$AZURE_COSMOS_KEY" -e AZURE_COSMOS_DB_NAME="$AZURE_COSMOS_DB_NAME" -e AZURE_COSMOS_ENDPOINT="$AZURE_COSMOS_ENDPOINT" -v "$HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH":/etc/connector ghcr.io/hasura/ndc-azure-cosmos:v0.1.0 update
+  start: docker run --rm -e AZURE_COSMOS_KEY="$AZURE_COSMOS_KEY" -e AZURE_COSMOS_DB_NAME="$AZURE_COSMOS_DB_NAME" -e AZURE_COSMOS_ENDPOINT="$AZURE_COSMOS_ENDPOINT" -v "$HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH":/etc/connector ghcr.io/hasura/ndc-azure-cosmos:v0.1.0 start

package.json

@@ -3,12 +3,14 @@
   "version": "1.0.0",
   "description": "NDC connector for the Azure Cosmos database",
   "bin": {
-    "ndc-azure-cosmos-config": "./dist/cli/index.js"
+    "ndc-azure-cosmos": "./dist/cli/index.js"
   },
   "scripts": {
     "test": "mocha",
     "build": "rimraf ./build && tsc",
-    "start": "npm run build && ts-node ./src/index.ts"
+    "start": "npm run build && ts-node ./src/index.ts",
+    "install-bin": "tsc && npm install -g",
+    "cli": "ts-node ./src/cli/index.ts"
   },
   "author": "Karthikeyan Chinnakonda",
   "license": "ISC",
@@ -22,18 +24,18 @@
     "@types/mocha": "^10.0.6",
     "@types/node": "^20.11.17",
     "chai-as-promised": "^7.1.1",
-    "commander": "^12.0.0",
+    "commander": "^11.0.0",
     "mocha": "^10.3.0",
     "nodemon": "^3.1.0",
     "nyc": "^15.1.0",
-    "rimraf": "^5.0.5"
+    "rimraf": "^5.0.7"
   },
   "dependencies": {
     "@azure/cosmos": "^4.0.0",
     "@azure/identity": "^4.0.1",
     "dotenv": "^16.4.5",
     "quicktype-core": "^23.0.104",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.5"
   }
 }

src/cli/config.ts

@@ -245,10 +245,18 @@ export async function generateConnectorConfig(outputConfigDir: string) {
     const rowsToFetch = process.env["AZURE_COSMOS_NO_OF_ROWS_TO_FETCH"] ?? "100";
 
     try {
-        const dbClient = constructCosmosDbClient();
-        const schema = await getCollectionsSchema(dbClient, parseInt(rowsToFetch));
+        const client = constructCosmosDbClient();
+        const schema = await getCollectionsSchema(client.dbClient, parseInt(rowsToFetch));
+        const cosmosKey = client.connectionDetails.key;
+        const cosmosEndpoint = client.connectionDetails.endpoint;
+        const cosmosDbName = client.connectionDetails.databaseName;
 
         const response: any = {
+            connection: {
+                endpoint: cosmosEndpoint,
+                key: cosmosKey,
+                databaseName: cosmosDbName
+            },
             schema
         };
 

src/cli/index.ts

@@ -1,12 +1,20 @@
 #! /usr/bin/env node
 
-import { Command } from "commander";
+import { Command, Option } from "commander";
 import * as updateCmd from "./update";
+import * as startCmd from "./start";
+import { createConnector } from "../connector";
+import { version } from "../../package.json"
+import * as sdk from "@hasura/ndc-sdk-typescript";
 
-export const program = new Command()
-    .version("0.0.1")
-    .description("Azure Cosmos Connector CLI")
-    // .addCommand(initCmd.cmd) TODO: Enable when required by the CLI spec
-    .addCommand(updateCmd.cmd);
+function main() {
+    const program = new Command().name("ndc-azure-cosmos").version(version);
 
-program.parse(process.argv);
+    program.addCommand(updateCmd.cmd);
+
+    program.addCommand(startCmd.cmd);
+
+    program.parse(process.argv);
+}
+
+main()