@itentialopensource/adapter-jira 1.7.2 → 1.7.5

package/utils/troubleshootingAdapter.js

@@ -0,0 +1,190 @@
+/* @copyright Itential, LLC 2020 */
+/* eslint global-require: warn */
+/* eslint no-console: warn */
+/* eslint import/no-unresolved: warn */
+/* eslint import/no-dynamic-require: warn */
+
+const path = require('path');
+const rls = require('readline-sync');
+const fs = require('fs-extra');
+
+const utils = require(path.join(__dirname, 'tbUtils'));
+const basicGet = require(path.join(__dirname, 'basicGet'));
+const { name } = require(path.join(__dirname, '..', 'package.json'));
+const sampleProperties = require(path.join(__dirname, '..', 'sampleProperties.json'));
+
+// send interactive questions and collection answers
+// return updated connection object
+const collectAnswersSync = (questions, props) => {
+  const answers = [];
+  questions.forEach((q) => {
+    const answer = rls.question(q);
+    answers.push(answer);
+  });
+  return utils.getNewProps(answers, props);
+};
+
+// change object into array of questions
+const confirm = (props) => {
+  const questions = Object.keys(props).map((key) => `${key}: (${props[key]}) `);
+  return collectAnswersSync(questions, props);
+};
+
+// allow user to change auth_method
+const confirmAuthOptions = (authentication) => {
+  const authOptions = ['basic user_password', 'request_token', 'static_token', 'no_authentication'];
+  const displayAuthOptions = utils.getDisplayAuthOptions(authentication.auth_method, authOptions);
+  const index = rls.keyInSelect(displayAuthOptions, 'Which authentication?');
+  if (index === -1) {
+    return authentication.auth_method;
+  }
+  console.log(`${authOptions[index]} is selected.`);
+  return authOptions[index];
+};
+
+// helper function to update auth properties
+const confirmAndUpdate = (auth, config) => {
+  const newAuth = confirm(auth);
+  return utils.updateAuth(newAuth, auth, config);
+};
+
+// extract basic auth properties
+const updateBasicAuth = (config, authentication) => {
+  const auth = {
+    username: authentication.username,
+    password: authentication.password
+  };
+  return confirmAndUpdate(auth, config);
+};
+
+// extract static auth properties
+const updateStaticAuth = (config, authentication) => {
+  const auth = {
+    token: authentication.token,
+    auth_field: authentication.auth_field,
+    auth_field_format: authentication.auth_field_format
+  };
+  return confirmAndUpdate(auth, config);
+};
+
+// troubleshooting connection and healthcheck endpoint setting of adapter
+const VerifyHealthCheckEndpoint = (serviceItem, props, scriptFlag) => {
+  // Updates connectivity params and runs connectivity
+  let connConfig;
+  const result = {};
+  if (scriptFlag) {
+    const connection = utils.getConnection(serviceItem.properties);
+    const newConnection = confirm(connection);
+    utils.runConnectivity(newConnection.host, scriptFlag);
+    connConfig = utils.updateNewConnection(serviceItem, newConnection);
+  } else {
+    let { properties: { properties: { host } } } = serviceItem;
+    if (props.connProps) {
+      connConfig = utils.updateNewConnection(serviceItem, props.connProps);
+      host = connConfig.properties.properties.host;
+    } else {
+      connConfig = serviceItem;
+    }
+    result.connectivity = utils.runConnectivity(host, scriptFlag);
+  }
+  // Updates the healthcheck endpoing
+  const healthcheck = require('../entities/.system/action.json');
+  const healthCheckEndpoint = utils.getHealthCheckEndpoint(healthcheck);
+  let newHealthCheckEndpoint = healthCheckEndpoint;
+  if (scriptFlag) {
+    newHealthCheckEndpoint = confirm(healthCheckEndpoint);
+    utils.getHealthCheckEndpointURL(newHealthCheckEndpoint, connConfig);
+  } else if (props.healthCheckEndpoint) {
+    newHealthCheckEndpoint = props.healthCheckEndpoint;
+  }
+  // Updates the authorization params
+  const { authentication } = connConfig.properties.properties;
+  let updatedAdapter = connConfig;
+  if (scriptFlag) {
+    authentication.auth_method = confirmAuthOptions(authentication);
+    if (authentication.auth_method === 'basic user_password') {
+      updatedAdapter = updateBasicAuth(connConfig, authentication);
+    } else if (authentication.auth_method === 'static_token') {
+      updatedAdapter = updateStaticAuth(connConfig, authentication);
+    } else if (authentication.auth_method === 'request_token') {
+      console.log('current troubleshooting script does not support updating request_token authentication');
+    }
+  } else if (props.auth) {
+    updatedAdapter = utils.updateAuth(props.auth, authentication, connConfig);
+  }
+  // Writes the new healthcheck endpoint into action.json
+  utils.updateHealthCheckEndpoint(newHealthCheckEndpoint, healthCheckEndpoint, healthcheck);
+  return { result, updatedAdapter };
+};
+
+const offline = async () => {
+  console.log('Start offline troubleshooting');
+  const { updatedAdapter } = VerifyHealthCheckEndpoint({ properties: sampleProperties }, {}, true);
+  const a = basicGet.getAdapterInstance(updatedAdapter);
+  const res = await utils.healthCheck(a);
+  if (!res) {
+    console.log('run `npm run troubleshoot` again to update settings');
+    process.exit(0);
+  }
+  console.log('Save changes to sampleProperties.json');
+  await fs.writeFile('sampleProperties.json', JSON.stringify(updatedAdapter.properties, null, 2));
+  if (rls.keyInYN('Test with more GET request')) {
+    await utils.runBasicGet(true);
+  }
+};
+
+const troubleshoot = async (props, scriptFlag, persistFlag, adapter) => {
+  // get database connection and existing adapter config
+  const { database, serviceItem } = await utils.getAdapterConfig();
+  // where troubleshoot should start
+  if (serviceItem) {
+    if (!scriptFlag || rls.keyInYN(`Start verifying the connection and authentication properties for ${name}?`)) {
+      const { result, updatedAdapter } = VerifyHealthCheckEndpoint(serviceItem, props, scriptFlag);
+      let a;
+      if (scriptFlag) {
+        a = basicGet.getAdapterInstance(updatedAdapter);
+      } else {
+        a = adapter;
+      }
+      const healthRes = await utils.healthCheck(a);
+      result.healthCheck = healthRes;
+      if (scriptFlag && !healthRes) {
+        console.log('run `npm run troubleshoot` again to update settings');
+        process.exit(0);
+      }
+
+      if (persistFlag && healthRes) {
+        const update = { $set: { properties: updatedAdapter.properties } };
+        await database.collection(utils.SERVICE_CONFIGS_COLLECTION).updateOne(
+          { model: name }, update
+        );
+        if (scriptFlag) {
+          console.log(`${name} updated.`);
+        }
+      }
+      if (scriptFlag) {
+        if (rls.keyInYN('Test with more GET request')) {
+          await utils.runBasicGet(scriptFlag);
+          process.exit(0);
+        } else {
+          console.log('Exiting');
+          process.exit(0);
+        }
+      } else {
+        result.basicGet = await utils.runBasicGet(scriptFlag);
+        return result;
+      }
+    } else {
+      console.log('You can update healthCheckEndpoint in ./entities/.system/action.json');
+      console.log('You can update authentication credientials under Settings/Services');
+      console.log('Exiting');
+      process.exit(0);
+    }
+  } else {
+    console.log(`${name} not installed`);
+    console.log('run `npm run install:adapter` to install current adapter to IAP first. Exiting...');
+  }
+  return null;
+};
+
+module.exports = { troubleshoot, offline };

package/versions.json

@@ -0,0 +1,142 @@
+{
+  "constructor": -1,
+  "healthCheck": 0,
+  "getWorkflowFunctions": 0,
+  "updateAdapterConfiguration": 0,
+  "findPath": 0,
+  "suspend": 0,
+  "unsuspend": 0,
+  "getQueue": 0,
+  "troubleshoot": 0,
+  "runHealthcheck": 0,
+  "runConnectivity": 0,
+  "runBasicGet": 0,
+  "hasEntity": -1,
+  "verifyCapability": -1,
+  "updateEntityCache": -1,
+  "genericAdapterRequest": 0,
+  "updateMultipleCustomFieldValues": 0,
+  "updateCustomFieldValue": 0,
+  "getCustomFieldConfiguration": 0,
+  "updateCustomFieldConfiguration": 0,
+  "getAttachmentContent": 0,
+  "getAttachmentThumbnail": 0,
+  "createDashboard": 0,
+  "updateDashboard": 0,
+  "deleteDashboard": 0,
+  "copyDashboard": 0,
+  "getEvents": 0,
+  "getChangeLogsByIds": 0,
+  "analyseExpression": 0,
+  "getFieldsPaginated": 0,
+  "updateCustomField": 0,
+  "getContextsForFieldDeprecated": 0,
+  "deleteCustomField": 0,
+  "restoreCustomField": 0,
+  "trashCustomField": 0,
+  "getContextsForField": 0,
+  "createCustomFieldContext": 0,
+  "getDefaultValues": 0,
+  "setDefaultValues": 0,
+  "getIssueTypeMappingsForContexts": 0,
+  "getCustomFieldContextsForProjectsAndIssueTypes": 0,
+  "getProjectContextMapping": 0,
+  "updateCustomFieldContext": 0,
+  "deleteCustomFieldContext": 0,
+  "addIssueTypesToContext": 0,
+  "removeIssueTypesFromContext": 0,
+  "assignProjectsToCustomFieldContext": 0,
+  "removeCustomFieldContextFromProjects": 0,
+  "getOptionsForContext": 0,
+  "updateCustomFieldOption": 0,
+  "createCustomFieldOption": 0,
+  "reorderCustomFieldOptions": 0,
+  "deleteCustomFieldOption": 0,
+  "getScreensForField": 0,
+  "createScreen": 0,
+  "updateScreen": 0,
+  "deleteScreen": 0,
+  "getAllFieldConfigurations": 0,
+  "createFieldConfiguration": 0,
+  "updateFieldConfiguration": 0,
+  "deleteFieldConfiguration": 0,
+  "getFieldConfigurationItems": 0,
+  "updateFieldConfigurationItems": 0,
+  "getAllFieldConfigurationSchemes": 0,
+  "createFieldConfigurationScheme": 0,
+  "getFieldConfigurationSchemeMappings": 0,
+  "getFieldConfigurationSchemeProjectMapping": 0,
+  "assignFieldConfigurationSchemeToProject": 0,
+  "updateFieldConfigurationScheme": 0,
+  "deleteFieldConfigurationScheme": 0,
+  "setFieldConfigurationSchemeMapping": 0,
+  "removeIssueTypesFromGlobalFieldConfigurationScheme": 0,
+  "bulkGetGroups": 0,
+  "getLicense": 0,
+  "bulkSetIssuesPropertiesList": 0,
+  "bulkSetIssuePropertiesByIssue": 0,
+  "getIsWatchingIssueBulk": 0,
+  "getIssueSecurityLevelMembers": 0,
+  "getIssueTypesForProject": 0,
+  "getAllIssueTypeSchemes": 0,
+  "createIssueTypeScheme": 0,
+  "getIssueTypeSchemesMapping": 0,
+  "getIssueTypeSchemeForProjects": 0,
+  "assignIssueTypeSchemeToProject": 0,
+  "updateIssueTypeScheme": 0,
+  "deleteIssueTypeScheme": 0,
+  "addIssueTypesToIssueTypeScheme": 0,
+  "reorderIssueTypesInIssueTypeScheme": 0,
+  "removeIssueTypeFromIssueTypeScheme": 0,
+  "getIssueTypeScreenSchemes": 0,
+  "createIssueTypeScreenScheme": 0,
+  "getIssueTypeScreenSchemeMappings": 0,
+  "getIssueTypeScreenSchemeProjectAssociations": 0,
+  "assignIssueTypeScreenSchemeToProject": 0,
+  "updateIssueTypeScreenScheme": 0,
+  "deleteIssueTypeScreenScheme": 0,
+  "appendMappingsForIssueTypeScreenScheme": 0,
+  "updateDefaultScreenScheme": 0,
+  "removeMappingsFromIssueTypeScreenScheme": 0,
+  "getProjectsForIssueTypeScreenScheme": 0,
+  "getAutoCompletePost": 0,
+  "parseJqlQueries": 0,
+  "matchIssues": 0,
+  "getAllLabels": 0,
+  "getRecent": 0,
+  "archiveProject": 0,
+  "deleteProjectAsynchronously": 0,
+  "restore": 0,
+  "getHierarchy": 0,
+  "getAllAccessibleProjectTypes": 0,
+  "getFeaturesForProject": 0,
+  "toggleFeatureForProject": 0,
+  "getProjectEmail": 0,
+  "updateProjectEmail": 0,
+  "getScreenSchemes": 0,
+  "createScreenScheme": 0,
+  "updateScreenScheme": 0,
+  "deleteScreenScheme": 0,
+  "getAvatarImageByType": 0,
+  "getAvatarImageByID": 0,
+  "getAvatarImageByOwner": 0,
+  "getUserEmail": 0,
+  "getUserEmailBulk": 0,
+  "getAllUsersDefault": 0,
+  "getAllUsers": 0,
+  "getDynamicWebhooksForApp": 0,
+  "registerDynamicWebhooks": 0,
+  "deleteWebhookById": 0,
+  "getFailedWebhooks": 0,
+  "refreshWebhooks": 0,
+  "createWorkflow": 0,
+  "getWorkflowsPaginated": 0,
+  "deleteInactiveWorkflow": 0,
+  "getWorkflowTransitionRuleConfigurations": 0,
+  "updateWorkflowTransitionRuleConfigurations": 0,
+  "deleteWorkflowTransitionRuleConfigurations": 0,
+  "getAllWorkflowSchemes": 0,
+  "getWorkflowSchemeProjectAssociations": 0,
+  "assignSchemeToProject": 0,
+  "publishDraftWorkflowScheme": 0
+}