tilde-lab/optimade-client

Isomorphic TypeScript / JavaScript client to aggregate all the official Optimade providers

optimade-client's Issues

Do not use CORS proxy by default and only try it if needed

By experience, many Optimade instances now support CORS header, so proxy usage may be not needed anymore. We should refuse of it gradually.

Rewrite *getStructures* to account *meta* (for data_* properties from interface Meta)

This is needed to expose the properties:

• data_returned
• data_available
• more_data_available

to the client users, cf. tilde-lab/optimade.science#21

Prefetch does not work (but then works)

$ node prefetch.js
C:\cygwin64\home\Evgeny\basf\bscience-gui\node_modules\optimade\prefetch.js:24
        const source = Object.keys(optimade.providers).sort().reduce(
                              ^

TypeError: Cannot convert undefined or null to object
    at Function.keys (<anonymous>)
    at C:\cygwin64\home\Evgeny\basf\bscience-gui\node_modules\optimade\prefetch.js:24:24
    at processTicksAndRejections (node:internal/process/task_queues:96:5)

re-running helps

Cannot use via *require*

e.g. like this:

#!/usr/bin/env node

const fs = require('fs');

optimade.prefetch() method

Add optimade.prefetch() method to make custom local cache

const optimade = new Optimade({
  providersUrl: "https://providers.optimade.org/providers.json",
});

optimade.prefetch({
  pathWithFileName: './prefetch.json', 
  excludeProviders: [''],
  batch: false
})

pathWithFileName - path to file output filename.json location
excludeProviders - array for exclude providers from cache
batch - portion statusable prefetching

Change the cache syncing strategy

Now done by prefetch.js with each new release at the npm. This is suboptimal.

Progressive data receiving (reactivity for at least some data received)

Currently it's const results = await optimadeClient.getStructuresAll(providerIds, YOUR_OPTIMADE_QUERY); which leads to a bottleneck described in tilde-lab/optimade.science#30

We need to design a non-blocking way to receive the results.

Set HTTP `User-Agent` header for `isomorphic-unfetch`

It is usually very nice when software presents itself in the HTTP User-Agent header. Web browsers almost always present themselves in a verbose but neat way. This way the server-side developers are informed about what software makes requests to their servers, and may occasionally forward common issues to the client developers. Moreover, usage statistics could be drawn at the server-size, which is nice.

optimade-client seems to be using JS isomorphic-unfetch package for HTTP requests. By default its User-Agent is node-fetch/<version> (+https://github.com/bitinn/node-fetch). Changing this should not be difficult. It would be nice to see tilde-lab-optimade-client/<version> (or something similar) at least.

If user privacy is concern, it should be kept in mind that this is F/LOSS, thus anyone concerned with their privacy are free to patch their copy of the client to their liking.

Introduce AbortController for the fetch timeout

Currently the requests are not aborted via the timeout, this should be achieved with the AbortController.

Unclear error message when the providersUrl is wrong or defunct

const providerArray = Object.values(providersMap);
                             ^
TypeError: Cannot convert undefined or null to object

Some providers (AFLOW, OQMD) are not discovered

Compare https://github.com/tilde-lab/optimade-client/blob/master/prefetch.js output vs. https://www.optimade.org/providers-dashboard

Keeping the response status code for each provider

As mentioned in tilde-lab/optimade.science#31 there might be various status codes possible, however the client is unaware of them...