api.js

/* eslint-disable require-jsdoc */
/*
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */

import * as Environments from './environments/environments.js';
import * as Utils from './utils.js';

const config = {
  things: {
    listConnections: {
      path: '/api/2/solutions/{{solutionId}}/connections',
      method: 'GET',
      body: null,
      unwrapJsonPath: null,
    },
    retrieveConnection: {
      path: '/api/2/solutions/{{solutionId}}/connections/{{connectionId}}',
      method: 'GET',
      body: null,
      unwrapJsonPath: null,
    },
    createConnection: {
      path: '/api/2/solutions/{{solutionId}}/connections',
      method: 'POST',
      body: null,
      unwrapJsonPath: null,
    },
    modifyConnection: {
      path: '/api/2/solutions/{{solutionId}}/connections/{{connectionId}}',
      method: 'PUT',
      body: null,
      unwrapJsonPath: null,
    },
    deleteConnection: {
      path: '/api/2/solutions/{{solutionId}}/connections/{{connectionId}}',
      method: 'DELETE',
      body: null,
      unwrapJsonPath: null,
    },
    retrieveStatus: {
      path: '/api/2/solutions/{{solutionId}}/connections/{{connectionId}}/status',
      method: 'GET',
      body: null,
      unwrapJsonPath: null,
    },
    retrieveConnectionLogs: {
      path: '/api/2/solutions/{{solutionId}}/connections/{{connectionId}}/logs',
      method: 'GET',
      body: null,
      unwrapJsonPath: null,
    },
    retrieveConnectionMetrics: {
      path: '/api/2/solutions/{{solutionId}}/connections/{{connectionId}}/metrics',
      method: 'GET',
      body: null,
      unwrapJsonPath: null,
    },
    connectionCommand: {
      path: '/api/2/solutions/{{solutionId}}/connections/{{connectionId}}/command',
      method: 'POST',
      body: null,
      unwrapJsonPath: null,
    },
  },
  ditto_3: {
    listConnections: {
      path: '/api/2/connections',
      method: 'GET',
      body: null,
      unwrapJsonPath: null,
    },
    retrieveConnection: {
      path: '/api/2/connections/{{connectionId}}',
      method: 'GET',
      body: null,
      unwrapJsonPath: null,
    },
    createConnection: {
      path: '/api/2/connections',
      method: 'POST',
      body: null,
      unwrapJsonPath: null,
    },
    modifyConnection: {
      path: '/api/2/connections/{{connectionId}}',
      method: 'PUT',
      body: null,
      unwrapJsonPath: null,
    },
    deleteConnection: {
      path: '/api/2/connections/{{connectionId}}',
      method: 'DELETE',
      body: null,
      unwrapJsonPath: null,
    },
    retrieveStatus: {
      path: '/api/2/connections/{{connectionId}}/status',
      method: 'GET',
      body: null,
      unwrapJsonPath: null,
    },
    retrieveConnectionLogs: {
      path: '/api/2/connections/{{connectionId}}/logs',
      method: 'GET',
      body: null,
      unwrapJsonPath: null,
    },
    retrieveConnectionMetrics: {
      path: '/api/2/connections/{{connectionId}}/metrics',
      method: 'GET',
      body: null,
      unwrapJsonPath: null,
    },
    connectionCommand: {
      path: '/api/2/connections/{{connectionId}}/command',
      method: 'POST',
      body: null,
      unwrapJsonPath: null,
    },
  },
  ditto_2: {
    listConnections: {
      path: '/devops/piggyback/connectivity',
      method: 'POST',
      body: {
        'targetActorSelection': '/user/connectivityRoot/connectionIdsRetrieval/singleton',
        'headers': {
          'aggregate': false,
        },
        'piggybackCommand': {
          'type': 'connectivity.commands:retrieveAllConnectionIds',
        },
      },
      unwrapJsonPath: '?.?.connectionIds',
    },
    retrieveConnection: {
      path: '/devops/piggyback/connectivity',
      method: 'POST',
      body: {
        'targetActorSelection': '/system/sharding/connection',
        'headers': {
          'aggregate': false,
        },
        'piggybackCommand': {
          'type': 'connectivity.commands:retrieveConnection',
          'connectionId': '{{connectionId}}',
        },
      },
      unwrapJsonPath: '?.?.connection',
    },
    createConnection: {
      path: '/devops/piggyback/connectivity',
      method: 'POST',
      body: {
        'targetActorSelection': '/system/sharding/connection',
        'headers': {
          'aggregate': false,
        },
        'piggybackCommand': {
          'type': 'connectivity.commands:createConnection',
          'connection': '{{connectionJson}}',
        },
      },
      unwrapJsonPath: '?.?.connection',
    },
    modifyConnection: {
      path: '/devops/piggyback/connectivity',
      method: 'POST',
      body: {
        'targetActorSelection': '/system/sharding/connection',
        'headers': {
          'aggregate': false,
        },
        'piggybackCommand': {
          'type': 'connectivity.commands:modifyConnection',
          'connection': '{{connectionJson}}',
        },
      },
      unwrapJsonPath: null,
    },
    deleteConnection: {
      path: '/devops/piggyback/connectivity',
      method: 'POST',
      body: {
        'targetActorSelection': '/system/sharding/connection',
        'headers': {
          'aggregate': false,
        },
        'piggybackCommand': {
          'type': 'connectivity.commands:deleteConnection',
          'connectionId': '{{connectionId}}',
        },
      },
      unwrapJsonPath: null,
    },
    retrieveStatus: {
      path: '/devops/piggyback/connectivity',
      method: 'POST',
      body: {
        'targetActorSelection': '/system/sharding/connection',
        'headers': {
          'aggregate': false,
        },
        'piggybackCommand': {
          'type': 'connectivity.commands:retrieveConnectionStatus',
          'connectionId': '{{connectionId}}',
        },
      },
      unwrapJsonPath: '?.?',
    },
    retrieveConnectionLogs: {
      path: '/devops/piggyback/connectivity',
      method: 'POST',
      body: {
        'targetActorSelection': '/system/sharding/connection',
        'headers': {
          'aggregate': false,
          'is-group-topic': true,
        },
        'piggybackCommand': {
          'type': 'connectivity.commands:retrieveConnectionLogs',
          'connectionId': '{{connectionId}}',
        },
      },
      unwrapJsonPath: '?.?',
    },
    retrieveConnectionMetrics: {
      path: '/devops/piggyback/connectivity',
      method: 'POST',
      body: {
        'targetActorSelection': '/system/sharding/connection',
        'headers': {
          'aggregate': false,
          'is-group-topic': true,
        },
        'piggybackCommand': {
          'type': 'connectivity.commands:retrieveConnectionMetrics',
          'connectionId': '{{connectionId}}',
        },
      },
      unwrapJsonPath: '?.?',
    },
    connectionCommand: {
      path: '/devops/piggyback/connectivity',
      method: 'POST',
      body: {
        'targetActorSelection': '/system/sharding/connection',
        'headers': {
          'aggregate': false,
          'is-group-topic': true,
        },
        'piggybackCommand': {
          'type': '{{command}}',
          'connectionId': '{{connectionId}}',
        },
      },
      unwrapJsonPath: null,
    },
  },
};

let authHeaderKey;
let authHeaderValue;

/**
 * Activates authorization header for api calls
 * @param {boolean} forDevOps if true, the credentials for the dev ops api will be used.
 */
export function setAuthHeader(forDevOps) {
  if (forDevOps) {
    if (Environments.current().devopsAuth === 'basic') {
      authHeaderKey = 'Authorization';
      authHeaderValue = 'Basic ' + window.btoa(Environments.current().usernamePasswordDevOps);
    } else if (Environments.current().devopsAuth === 'bearer') {
      authHeaderKey = 'Authorization';
      authHeaderValue ='Bearer ' + Environments.current().bearerDevOps;
    }
  } else {
    if (Environments.current().mainAuth === 'basic') {
      authHeaderKey = 'Authorization';
      authHeaderValue = 'Basic ' + window.btoa(Environments.current().usernamePassword);
    } else if (Environments.current().mainAuth === 'pre') {
      authHeaderKey = 'x-ditto-pre-authenticated';
      authHeaderValue = Environments.current().dittoPreAuthenticatedUsername;
    } else if (Environments.current().mainAuth === 'bearer') {
      authHeaderKey = 'Authorization';
      authHeaderValue ='Bearer ' + Environments.current().bearer;
    }
  }
}

/**
 * Calls the Ditto api
 * @param {String} method 'POST', 'GET', 'DELETE', etc.
 * @param {String} path of the Ditto call (e.g. '/things')
 * @param {Object} body payload for the api call
 * @param {Object} additionalHeaders object with additional header fields
 * @param {boolean} returnHeaders request full response instead of json content
 * @return {Object} result as json object
 */
export async function callDittoREST(method, path, body, additionalHeaders, returnHeaders = false) {
  let response;
  try {
    response = await fetch(Environments.current().api_uri + '/api/2' + path, {
      method: method,
      headers: {
        'Content-Type': 'application/json',
        [authHeaderKey]: authHeaderValue,
        ...additionalHeaders,
      },
      ...(body) && {body: JSON.stringify(body)},
    });
  } catch (err) {
    Utils.showError(err);
    throw err;
  }
  if (!response.ok) {
    response.json()
        .then((dittoErr) => {
          Utils.showError(dittoErr.message, dittoErr.error, dittoErr.status);
        })
        .catch((err) => {
          Utils.showError('No error details from Ditto', response.statusText, response.status);
        });
    throw new Error('An error occurred: ' + response.status);
  }
  if (response.status !== 204) {
    if (returnHeaders) {
      return response;
    } else {
      return response.json();
    }
  } else {
    return null;
  }
}

export function getEventSource(thingIds, urlParams) {
  return new EventSourcePolyfill(
      `${Environments.current().api_uri}/api/2/things?ids=${thingIds}${urlParams ? '&' + urlParams : ''}`, {
        headers: {
          [authHeaderKey]: authHeaderValue,
        },
      },
  );
}

/**
 * Calls connections api. Uses devops api in case of Ditto and the solutions api in case of Things
 * @param {*} operation connections api operation
 * @param {*} successCallback callback on success
 * @param {*} connectionId connectionId
 * @param {*} connectionJson optional json of connection configuration
 * @param {*} command optional command
 * @return {*} promise to the result
 */
export async function callConnectionsAPI(operation, successCallback, connectionId, connectionJson, command) {
  Utils.assert((env() !== 'things' || Environments.current().solutionId), 'No solutionId configured in environment');
  const params = config[env()][operation];
  let response;
  try {
    response = await fetch(Environments.current().api_uri + params.path.replace('{{solutionId}}',
        Environments.current().solutionId).replace('{{connectionId}}', connectionId), {
      method: params.method,
      headers: {
        'Content-Type': operation === 'connectionCommand' ? 'text/plain' : 'application/json',
        [authHeaderKey]: authHeaderValue,
      },
      body: params.body ?
          JSON.stringify(params.body)
              .replace('{{connectionId}}', connectionId)
              .replace('"{{connectionJson}}"', JSON.stringify(connectionJson))
              .replace('{{command}}', command) :
          connectionJson ? JSON.stringify(connectionJson) : command,
    });
  } catch (err) {
    Utils.showError(err);
    throw err;
  }

  if (!response.ok) {
    response.json()
        .then((dittoErr) => {
          Utils.showError(dittoErr.description, dittoErr.message, dittoErr.status);
        })
        .catch((err) => {
          Utils.showError('No error details from Ditto', response.statusText, response.status);
        });
    throw new Error('An error occured: ' + response.status);
  }
  if (operation !== 'connectionCommand' && response.status !== 204) {
    document.body.style.cursor = 'progress';
    response.json()
        .then((data) => {
          if (data && data['?'] && data['?']['?'].status >= 400) {
            const dittoErr = data['?']['?'].payload;
            Utils.showError(dittoErr.description, dittoErr.message, dittoErr.status);
          } else {
            if (params.unwrapJsonPath) {
              params.unwrapJsonPath.split('.').forEach(function(node) {
                if (node === '?') {
                  node = Object.keys(data)[0];
                }
                data = data[node];
              });
            }
            successCallback(data);
          }
        }).catch((error) => {
          Utils.showError('Error calling connections API', error);
          throw error;
        }).finally(() => {
          document.body.style.cursor = 'default';
        });
  } else {
    successCallback && successCallback();
  }
}

export function env() {
  if (Environments.current().api_uri.startsWith('https://things')) {
    return 'things';
  } else if (Environments.current().ditto_version === '2') {
    return 'ditto_2';
  } else {
    return 'ditto_3';
  }
}