cacheBackend.js

/**
 * This node script get's executed on every deploy. It updates the file `/src/apiData.json`
 * with some data from the backend that we want to have available without doing additional requests
 * every time some page is loaded.
 */

const axios = require('axios');
const fs = require('fs');

const version = process.env.VERSION || '0.0.0';
const ApiVersion = 'v1';
const ApiHost = `${process.env.REACT_APP_API_HOST ||
  'https://api.refine.bio'}/${ApiVersion}`;

// Call scripts at deploy time
cacheServerData();

async function cacheServerData() {
  console.log(`Fetching data to be cached from endpoint: ${ApiHost}`);
  const [
    stats,
    aboutStats,
    { organism, apiVersion },
    qnTargets,
    platforms,
  ] = await Promise.all([
    getStats(),
    getAboutStats(),
    getSamplesPerOrganism(),
    getQnTargets(),
    getPlatforms(),
  ]);
  const cache = {
    version, // remove `v` at the start of each version
    apiVersion,
    stats,
    aboutStats,
    organism,
    qnTargets,
    platforms,
  };
  fs.writeFileSync(`src/apiData.json`, JSON.stringify(cache));
}

async function getAboutStats() {
  try {
    const { data } = await axios.get(`${ApiHost}/stats-about/`);
    return data;
  } catch {
    // these numbers are important for the about page, if the requests fails
    // use these numbers instead.
    return {
      samples_available: 904953 + 391022,
      total_size_in_bytes: 832195361132962,
      supported_organisms: 43 + 159,
      experiments_processed: 35785 + 8661,
    };
  }
}

/**
 * Fetch stats for the last year, this is used for the graphs in the landing page
 */
async function getStats() {
  try {
    const { data: stats } = await axios.get(`${ApiHost}/stats/?range=year`);
    return stats;
  } catch (e) {
    try {
      console.log('Error fetching stats with ranges, trying again...');
      // try getting general stats if the range fails
      const { data: stats } = await axios.get(`${ApiHost}/stats/`);
      return stats;
    } catch (e1) {
      // return nothing if that also fails
      console.log('Error fetching stats.');
      return false;
    }
  }
}

/**
 * Retrieves the platforms from the api and formats them into an object
 * where the keys are the platform accession codes and the values
 * are the platform names.
 */
async function getPlatforms() {
  try {
    const { data: platforms } = await axios.get(`${ApiHost}/platforms`);
    return platforms.reduce(
      (accum, { platform_name, platform_accession_code }) => ({
        ...accum,
        [platform_accession_code]: platform_name,
      }),
      {}
    );
  } catch (e) {
    console.log('Error fetching platforms');
    return {};
  }
}

async function getQnTargets() {
  try {
    const { data: qnTargets } = await axios.get(`${ApiHost}/qn_targets`);
    return qnTargets.reduce(
      (accum, { name: organismName }) => ({
        ...accum,
        [organismName]: true,
      }),
      {}
    );
  } catch {
    console.log('Error fetching qn targets');
    return false;
  }
}

async function getSamplesPerOrganism() {
  try {
    const response = await axios.get(`${ApiHost}/search/?limit=1&offset=0`);
    return {
      organism: response.data.facets.downloadable_organism_names,
      apiVersion: response.headers['x-source-revision'],
    };
  } catch {
    return {};
  }
}