Create database route, endpoint and service

[rudream]

Purpose

This PR resolves #271

Create a route and endpoint to for fetching databases. Process the response so that all fields are properly set up and formatted for front-end displaying and searching.

Implementation

Define an api endpoint in config.ts to be used by our database service for fetching databases for a given :clusterId. Create makeDatabase.ts to process the response data such that:

• An undefined labels field defaults to an empty array []
• Labels formatted as [{name: value}] are turned to ["name: value"]
• Type and protocol fields are optimally formatted (eg. 'postgres' -> 'PostgreSQL')

Call this makeDatabase() to process the response when fetching databases in the database service.

The route and route getter I defined in config.ts will be used in the next issue when registering the feature.

Demo

If makeDatabase() is given the following data:

{
    name: 'aurora',
    desc: 'PostgreSQL 11.6: AWS Aurora ',
    protocol: 'postgres',
    type: 'rds',
    uri: 'postgres-aurora-instance-1.c1xpjrob56xs.us-west-1.rds.amazonaws.com:5432',
    labels: [
      { name: 'cluster', value: 'root' },
      { name: 'env', value: 'aws' },
    ],
}

it will return:

{
    name: 'aurora',
    desc: 'PostgreSQL 11.6: AWS Aurora ',
    protocol: 'PostgreSQL',
    type: 'RDS',
    uri: 'postgres-aurora-instance-1.c1xpjrob56xs.us-west-1.rds.amazonaws.com:5432',
    tags: ['cluster: root',  'env: aws']
}

[alex-kovoy]

Lets combine these 2 fields into 1 and call it TYPE and make sure that search works when a user types rds/p for example.

RDS/PosgreSQL
GCP/PosgreSQL
MySQL

[rudream]

Update

Upon @alex-kovoy 's suggestion, the type and protocol fields are now combined.

If makeDatabase() is given:

{
    name: 'aurora',
    desc: 'PostgreSQL 11.6: AWS Aurora ',
    protocol: 'postgres',
    type: 'rds',
    uri: 'postgres-aurora-instance-1.c1xpjrob56xs.us-west-1.rds.amazonaws.com:5432',
    labels: [
      { name: 'cluster', value: 'root' },
      { name: 'env', value: 'aws' },
    ],
}

it will return:

{
    name: 'aurora',
    desc: 'PostgreSQL 11.6: AWS Aurora ',
    type: 'RDS/PostgreSQL',
    uri: 'postgres-aurora-instance-1.c1xpjrob56xs.us-west-1.rds.amazonaws.com:5432',
    tags: ['cluster: root',  'env: aws']
}

Screenshot of new table

[r0mant]

@rudream @kimlisa I think combining type/protocol is a good idea. A couple of suggestions:

• Let's remove the slash? So it would say Self-hosted MySQL, RDS PostgreSQL, etc. which reads a bit better.
• Can we please also rename GCP to Cloud SQL? It would be more accurate. Ideally I need to rename it on the backend as well but I'm stuck with it for now. So for the frontend just translate "gcp" to "Cloud SQL" if possible.

[r0mant]

@rudream @kimlisa Also, didn't we agree not to include the database endpoint (URI) in the table? I don't think it has much value for the user - e.g. tsh db ls doesn't show it by default.

Instead, we should have a Connect button on the very right of each row which would bring up a dialog with instructions for a user how to connect to the database.

[kimlisa]

@r0mant the connect button is in a separate issue: #277 (add database button is also a separate issue)

and @rudream along with other changes, lets remove the URI column, i must've forgotten about removing it, sorry about that :)

[rudream]

Update

After implementing @r0mant 's suggestions:

The DatabaseList no longer displays the URI column.

If makeDatabase() is given:

{
    name: 'aurora',
    desc: 'PostgreSQL 11.6: AWS Aurora ',
    protocol: 'postgres',
    type: 'rds',
    uri: 'postgres-aurora-instance-1.c1xpjrob56xs.us-west-1.rds.amazonaws.com:5432',
    labels: [
      { name: 'cluster', value: 'root' },
      { name: 'env', value: 'aws' },
    ],
}

it will return:

{
    name: 'aurora',
    desc: 'PostgreSQL 11.6: AWS Aurora ',
    type: 'RDS PostgreSQL',
    uri: 'postgres-aurora-instance-1.c1xpjrob56xs.us-west-1.rds.amazonaws.com:5432',
    tags: ['cluster: root',  'env: aws']
}

Screenshot of new table

[rudream]

Update

After removing the uri field as suggested by @kimlisa

If makeDatabase() is given:

{
    name: 'aurora',
    desc: 'PostgreSQL 11.6: AWS Aurora ',
    protocol: 'postgres',
    type: 'rds',
    uri: 'postgres-aurora-instance-1.c1xpjrob56xs.us-west-1.rds.amazonaws.com:5432',
    labels: [
      { name: 'cluster', value: 'root' },
      { name: 'env', value: 'aws' },
    ],
}

it will return:

{
    name: 'aurora',
    desc: 'PostgreSQL 11.6: AWS Aurora ',
    type: 'RDS PostgreSQL',
    tags: ['cluster: root',  'env: aws']
}

[kimlisa]

one small nit: rename services/database/ to services/databases/ and you're good to go!