Refactor DB view descriptions

[keckelt]

closes #181

[thinkh]

We agreed in a personal meeting for the following changes:

• Rename IViewDesc to IDatabaseViewDesc
• Unify return values for API routes /tdp/db/publicdb/ and /tdp/db/publicdb/myview/desc so that they match the IDatabaseViewDesc
• IViewDescription is only used by the PhoveaDataAdapter and should be moved there
• ARankingView and AEmbeddedRankingView should use the IDatabaseViewDesc instead

@keckelt Please change the code accordingly and notify @lehnerchristian. Afterwards he will test the changes in different apps.

[keckelt]

@lehnerchristian @thinkh I changed the points we discussed, except:

• IViewDescription is only used by the PhoveaDataAdapter and should be moved there
• ARankingView and AEmbeddedRankingView should use the IDatabaseViewDesc instead

The RankingViews only use the interface to get the column description,so using the IDatabaseViewDesc is an overkill.
Actually it might be better to just return IServerColumn[] there, but I left it untouched for now as that might be best handled in another PR imo.

[lehnerchristian]

only two minor things. the rest looks good

[lehnerchristian]

TODO after merging: also merge dependent PRs where typings change

[keckelt]

Ah, jetzt wo ich die member von IViewDescription optional gemacht habe ist natürlich IDatabaseViewDesc keine richtige Erweiterung:

Type 'Promise<Readonly<IDatabaseViewDesc>>' is not assignable to type 'Promise<IViewDescription>'.
  Type 'Readonly<IDatabaseViewDesc>' is not assignable to type 'IViewDescription'.
    Property 'idType' is optional in type 'Readonly<IDatabaseViewDesc>' but required in type 'IViewDescription'.

[lehnerchristian]

in which project do you get the error? I've checked your branch out in my local version of Ordino and I don't get any compile errors

[keckelt]

In Ordino, I have errors in the subclasses of ARankingView like: https://github.com/Caleydo/tdp_publicdb/blob/master/src/views/ACombinedDependentTable.ts#L77

I think we should change the return type of loadColumnDesc, but don't know how much work that would be (e.g. to IServerCoumn[]), or if that is better in another PR.

[keckelt]

Return of /api/tdp/db/<db>/<view>/desc before and after
Old:

{
  "idType": null,
  "columns": []
}

New:

{
  "description": "",
  "arguments": [
    "query",
    "query",
    "species",
    "column",
    "limit",
    "offset"
  ],
  "query": "SELECT s as id, s as text FROM (SELECT distinct {column} AS s FROM tissue.tdp_tissue WHERE LOWER({column}) LIKE :query AND species = :species) ORDER BY {column} ASC LIMIT {limit} OFFSET {offset}",
  "type": "helper",
  "columns": [],
  "name": "tissue_unique"
}

[keckelt]

Hi @lehnerchristian, I decided to not make the IViewDescription properties optional because they are always returned by the API (idType can be null/the array can be empty though).

[lehnerchristian]

ok, thank you. I'll have a look

[lehnerchristian]

sorry, I'll need to have a look at all projects, because this PR has some breaking changes. I talked to @thinkh and we're checking how we release it: a new major version + probably renaming of IViewDescription to IViewDesc

[lehnerchristian]

I've checked this PR with several projects especially if there are some RankingViews returning only columns without IDTypes . I'll need to check some other projects, which I'm not involved in with some colleagues tomorrow and then I can hopefully merge this PR

[lehnerchristian]

@dg-datavisyn will test this with his projects, too and then this change will be in the next release in 2 weeks

in the meantime we'll merge this into develop after the release we'll create now.

thank you for the changes and sorry that it took me so long, @keckelt 😉

[lehnerchristian]

I've tested this PR with another project and it works for me. @thinkh , there are some comments to your comments

[lehnerchristian]

as soon as it's renamed as @thinkh suggested we'll merge it

[lehnerchristian]

@keckelt , can you rename the interfaces as @thinkh suggested?

[keckelt]

@lehnerchristian Done 🙂