add native toolchain definition to connector metadata

[paritosh-08]

What

This PR adds the native toolchain definition to the connector metadata.

It also adds two commands in the initial metadata generated by the CLI:

nativeToolchainDefinition:
  commands:
    start:
      type: ShellScript
      bash: |-
        #!/usr/bin/env bash
        set -eu -o pipefail
        HASURA_CONFIGURATION_DIRECTORY="$HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH" ndc-postgres serve
      powershell: ''
    update:
      type: ShellScript
      bash: |-
        #!/usr/bin/env bash
        set -eu -o pipefail
        "$HOME/.ddn/plugins/bin/hasura-ndc_postgres" update
      powershell: ''

Click here for the CLI command output

❯ ndc-postgres-cli initialize --with-metadata
❯ cat .hasura-connector/connector-metadata.yaml
packagingDefinition:
  type: PrebuiltDockerImage
  dockerImage: ghcr.io/hasura/ndc-postgres:343b8b3
supportedEnvironmentVariables:
- name: CONNECTION_URI
  description: The PostgreSQL connection URI
  defaultValue: postgresql://read_only_user:[email protected]:5432/v3-docs-sample-app
- name: CLIENT_CERT
  description: The SSL client certificate (Optional)
  defaultValue: ''
- name: CLIENT_KEY
  description: The SSL client key (Optional)
  defaultValue: ''
- name: ROOT_CERT
  description: The SSL root certificate (Optional)
  defaultValue: ''
commands:
  update: hasura-ndc-postgres update
cliPlugin:
  name: ndc-postgres
  version: 343b8b3
dockerComposeWatch:
- path: ./
  target: /etc/connector
  action: sync+restart
nativeToolchainDefinition:
  commands:
    start:
      type: ShellScript
      bash: |-
        #!/usr/bin/env bash
        set -eu -o pipefail
        HASURA_CONFIGURATION_DIRECTORY="$HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH" ndc-postgres serve
      powershell: ''
    update:
      type: ShellScript
      bash: |-
        #!/usr/bin/env bash
        set -eu -o pipefail
        "$HOME/.ddn/plugins/bin/hasura-ndc_postgres" update
      powershell: ''

How

[daniel-chambers]

Are you sure this will work? This is not what I expect to see passed to bash -c as per the specification for native toolchain commands. This looks like what should be in a script file inside the connector definition's .hasura-connector folder. That's what's done in the nodejs lambda connector.

[SandeepSamba]

Either of them works. The bash field can point to a script file or contain the script itself.

[daniel-chambers]

@SandeepSamba Interesting; that's not in the spec afaik. Do you detect this and run it differently? (ie not "bash -c")

[SandeepSamba]

No, we just dump bash -c "whatever that is there in the field" and it works

[daniel-chambers]

Hrm. When I try this manually in my terminal it doesn't work, which is why I was questioning it.

For example,

bash -c '#!/usr/bin/env bash\nset -eu -o pipefail\necho really\necho test > test.txt'

neither echoes "really" nor writes "test" into test.txt.

[daniel-chambers]

Oh okay, this is just my bad. If I use single quotes, it's not substituting the \ns. If I do this:

bash -c '#!/usr/bin/env bash
set -eu -o pipefail
echo really
echo test > test.txt'

It works. OK all good then!

[SandeepSamba]

Now this is super weird, same result when I tried the command you tried, but if I put the the following in a file test.sh and do bash -c "$(cat ./test.sh)", it works!!!

#!/usr/bin/env bash
set -eu -o pipefail
echo really
echo test > test.txt

[daniel-chambers]

That doesn't surprise me now. My mistake was using single quotes and then using escape sequences. :)

[SandeepSamba]

Great minds think alike :)

[daniel-chambers]

Please implement the same thing in Powershell. We have Windows customers.

[SandeepSamba]

The native runtime for postgres is targeted to be run inside the Native DDN workspace only and this script assumes the binary is present in so and so location, so this is not a general script that all users in UNIX systems can run (Postgres is setup in workspace like this). Also, I don't think there is a windows binary for the Postgres Connector today (I mean the connector itself, not the plugin). So, lets skip the powershell script for now?

[daniel-chambers]

The spec should not be asking for a PowerShell command then. :/

It's trivial to translate that to PowerShell, regardless: $env:HASURA_CONFIGURATION_DIRECTORY=$env:HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH; & ndc-postgres.exe serve.

Who knows, next week maybe someone will ask for Native DDN workspace equivalent for a Windows VM or something. Doing something half-way always comes back to bite you later 🙂