@heroku-cli/heroku-connect-plugin 0.11.0

package/LICENSE.md

@@ -0,0 +1,206 @@
+Apache License Version 2.0
+
+Copyright (c) 2023 Salesforce, Inc.
+All rights reserved.
+
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2023 Salesforce, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,93 @@
+Heroku Connect CLI Plugin
+==================
+
+# Install
+
+    $ heroku plugins:install heroku-connect-plugin
+
+
+# Help  
+
+    heroku help connect 
+
+# Commands
+
+    heroku connect:db:set                  - Set database parameters
+    heroku connect:diagnose                - Display diagnostic information about a connection
+    heroku connect:export                  - Export a mapping configuration JSON file
+    heroku connect:import FILE             - Import a mapping configuration JSON file
+    heroku connect:info                    - Display connection information 
+    heroku connect:mapping:state MAPPING   - Return the state of a mapping
+    heroku connect:mapping:delete MAPPING  - Delete an existing mapping
+    heroku connect:mapping:reload MAPPING  - Reload a mapping's data from Salesforce
+    heroku connect:pause                   - Pause a connection
+    heroku connect:resume                  - Resume a connection
+    heroku connect:restart                 - Restart a connection
+    heroku connect:sf:auth                 - Authenticate a connection to Salesforce
+    heroku connect:state                   - Return the state flag for a single connection
+
+# Examples
+
+Download an existing mapping configuration
+
+    $ heroku connect:export
+    Saved config-file: app-name-resource-name.json
+
+# Tutorial
+
+Make sure you have a Heroku app, with a Postgres database attached
+
+## Add the Heroku Connect add-on to your app
+
+    $ heroku addons:create herokuconnect
+
+## Link the new connection (the Heroku Connect add-on instance) to your Heroku user
+
+    $ heroku connect:info
+
+## Now link the connection to the database, specifying the config var and schema name
+
+    $ heroku connect:db:set --db=DATABASE_URL --schema=salesforce
+    settings database parameters... done
+    db_key:      DATABASE_URL
+    schema_name: salesforce
+
+If either option is not supplied, this command will ask for a value.
+
+## Authorize the connection to access your Salesforce organization
+
+    $ heroku connect:sf:auth
+    Launching Salesforce for authorization. If your browser doesn't open, please copy the following URL to proceed:
+
+    https://login.salesforce.com/services/oauth2/authorize?…
+
+This will launch your browser for an interactive authorization session.
+
+## Verify that connection is now in 'IDLE' state
+
+    $ heroku connect:state
+    IDLE
+
+## Now restore the exported configuration
+
+This could be exported using the `connect:export` command or directly through the Heroku Connect dashboard. By editing this configuration file, you can add and edit existing mappings easily.
+
+    $ heroku connect:import app-name-resource-name.json
+    Upload complete
+
+If you need to delete a mapping after the configuration has been imported, you can use a separate command for that:
+
+    $ heroku connect:mapping:delete Contact
+
+## Connect to your database to see the data
+
+    $ heroku pg:psql
+    > select * from salesforce.contact;
+
+## Contributing
+
+Read the following:
+
+- [Developing CLI Plugins](https://devcenter.heroku.com/articles/developing-cli-plugins)
+- [Testing CLI Plugins](https://devcenter.heroku.com/articles/testing-cli-plugins)
+- [CLI Style Guide](https://devcenter.heroku.com/articles/cli-style-guide)

package/commands/connect/db-set.js

@@ -0,0 +1,69 @@
+'use strict'
+const api = require('../../lib/connect/api.js')
+const cli = require('@heroku/heroku-cli-util')
+const co = require('co')
+const inquirer = require('inquirer')
+
+const fetchKeys = co.wrap(function * (appName, context) {
+  const url = '/api/v3/apps/' + appName
+  const response = yield api.request(context, 'GET', url)
+  const keys = []// new Array(response.json.db_keys.length);
+  response.data.db_keys.forEach(function (key) {
+    const plan = (key.addon ? key.addon.plan : null) || 'Unknown Plan'
+    keys.push({
+      name: `${key.name} (${plan})`,
+      value: key.name
+    })
+  })
+  return yield Promise.resolve(keys)
+})
+
+module.exports = {
+  topic: 'connect',
+  command: 'db:set',
+  description: 'Set database parameters',
+  help: "Set a connection's database config var and schema name",
+  flags: [
+    { name: 'resource', description: 'specific connection resource name', hasValue: true },
+    { name: 'db', description: 'Database config var name', hasValue: true },
+    { name: 'schema', description: 'Database schema name', hasValue: true }
+  ],
+  needsApp: true,
+  needsAuth: true,
+  run: cli.command(co.wrap(function * (context, heroku) {
+    const data = {
+      db_key: context.flags.db,
+      schema_name: context.flags.schema
+    }
+
+    const connection = yield api.withConnection(context, heroku)
+    context.region = connection.region_url
+
+    inquirer.prompt([
+      {
+        name: 'db_key',
+        type: 'list',
+        message: "Select the config var that points to the database you'd like to use",
+        choices: yield fetchKeys(connection.app_name, context),
+        when: !context.flags.db
+      },
+      {
+        name: 'schema_name',
+        message: "Enter a schema name you'd like to use for the conneted data",
+        default: context.flags.schema || 'salesforce',
+        when: !context.flags.schema
+      }
+    ]).then(co.wrap(function * (answers) {
+      for (const key in answers) {
+        data[key] = answers[key]
+      }
+
+      yield cli.action('setting database parameters', co(function * () {
+        const url = '/api/v3/connections/' + connection.id
+        yield api.request(context, 'PATCH', url, data)
+      }))
+
+      cli.styledHash(data)
+    }))
+  }))
+}

package/commands/connect/diagnose.js

@@ -0,0 +1,108 @@
+'use strict'
+const api = require('../../lib/connect/api.js')
+const cli = require('@heroku/heroku-cli-util')
+const co = require('co')
+
+function displayResults (results, flags) {
+  results.errors.forEach(displayResult('RED', 'red'))
+  results.warnings.forEach(displayResult('YELLOW', 'yellow'))
+  if (flags.verbose) {
+    results.passes.forEach(displayResult('GREEN', 'green', false))
+    results.skips.forEach(displayResult('SKIPPED', 'dim', false))
+  }
+}
+
+function shouldDisplay (results, flags) {
+  return (results.errors.length > 0 || results.warnings.length > 0 || flags.verbose)
+}
+
+function displayResult (label, color, displayMessages) {
+  // Default to displaying messages, unless overridden
+  if (displayMessages === undefined) {
+    displayMessages = true
+  }
+  return function (result) {
+    cli.log(cli.color[color](`${label}: ${result.display_name}`))
+    if (displayMessages) {
+      cli.log(result.message)
+      if (result.doc_url) {
+        cli.log(result.doc_url)
+      }
+    }
+  }
+}
+
+function timeout (duration) {
+  return new Promise(resolve => {
+    setTimeout(resolve, duration)
+  })
+}
+
+module.exports = {
+  topic: 'connect',
+  command: 'diagnose',
+  description: 'Display diagnostic information about a connection',
+  help: 'Checks a connection for common configuration errors. ',
+  flags: [
+    { name: 'resource', description: 'specific connection resource name', hasValue: true },
+    { name: 'verbose', char: 'v', description: 'display passed and skipped check information as well' }
+  ],
+  needsApp: true,
+  needsAuth: true,
+  run: cli.command(co.wrap(function * (context, heroku) {
+    let mappingResults
+    let didDisplayAnything = false
+    const connection = yield api.withConnection(context, heroku)
+    context.region = connection.region_url
+    const results = yield cli.action('Diagnosing connection', co(function * () {
+      const url = '/api/v3/connections/' + connection.id + '/validations'
+      try {
+        const { data: { result_url: resultUrl } } = yield api.request(context, 'POST', url)
+
+        let i = 0
+
+        while (true) {
+          if (i > 600) {
+            cli.error('There was an issue retrieving validations')
+            break
+          }
+          const response = yield api.request(context, 'GET', resultUrl)
+
+          if (response.status === 200) {
+            return response.data
+          }
+
+          i++
+
+          yield timeout(500)
+        }
+      } catch (err) {
+        cli.error(err)
+      }
+    }))
+
+    cli.log() // Blank line to separate each section
+    cli.styledHeader(`Connection: ${connection.name || connection.internal_name}`)
+    if (shouldDisplay(results, context.flags)) {
+      didDisplayAnything = true
+      displayResults(results, context.flags)
+    }
+
+    for (const objectName in results.mappings) {
+      mappingResults = results.mappings[objectName]
+      if (shouldDisplay(mappingResults, context.flags)) {
+        didDisplayAnything = true
+        cli.log() // Blank line to separate each section
+        cli.styledHeader(objectName)
+        displayResults(mappingResults, context.flags)
+      }
+    }
+
+    if (!didDisplayAnything && !context.flags.verbose) {
+      cli.log(cli.color.green('Everything appears to be fine'))
+    }
+  })),
+
+  // Additional exports for code sharing
+  displayResults: displayResults
+}

package/commands/connect/export.js

@@ -0,0 +1,35 @@
+'use strict'
+const api = require('../../lib/connect/api.js')
+const cli = require('@heroku/heroku-cli-util')
+const co = require('co')
+const fs = require('fs')
+
+module.exports = {
+  topic: 'connect',
+  command: 'export',
+  description: 'Export configuration from a connection',
+  help: 'Exports the mapping configuration from a connection as a json file',
+  flags: [
+    { name: 'resource', description: 'specific connection resource name', hasValue: true }
+  ],
+  needsApp: true,
+  needsAuth: true,
+  run: cli.command(co.wrap(function * (context, heroku) {
+    let connection, response
+
+    yield cli.action('fetching configuration', co(function * () {
+      connection = yield api.withConnection(context, heroku)
+      context.region = connection.region_url
+      const url = '/api/v3/connections/' + connection.id + '/actions/export'
+      response = yield api.request(context, 'GET', url)
+    }))
+
+    const fName = connection.app_name + '-' + (connection.resource_name || '') + '.json'
+
+    yield cli.action('writing configuration to file', {
+      success: fName
+    }, co(function * () {
+      fs.writeFileSync(fName, JSON.stringify(response.data, null, 4))
+    }))
+  }))
+}

package/commands/connect/import.js

@@ -0,0 +1,30 @@
+'use strict'
+const api = require('../../lib/connect/api.js')
+const cli = require('@heroku/heroku-cli-util')
+const co = require('co')
+const fs = require('fs')
+
+module.exports = {
+  topic: 'connect',
+  command: 'import',
+  description: 'Import configuration from an export file',
+  help: 'Imports the mapping configuration from a json export file',
+  args: [
+    { name: 'file', desciption: 'JSON export file name' }
+  ],
+  flags: [
+    { name: 'resource', description: 'specific connection resource name', hasValue: true }
+  ],
+  needsApp: true,
+  needsAuth: true,
+  run: cli.command(co.wrap(function * (context, heroku) {
+    const fName = context.args.file
+    yield cli.action(`uploading ${fName}`, co(function * () {
+      const connection = yield api.withConnection(context, heroku)
+      context.region = connection.region_url
+      const url = '/api/v3/connections/' + connection.id + '/actions/import'
+      const data = JSON.parse(fs.readFileSync(fName, 'utf8'))
+      yield api.request(context, 'POST', url, data)
+    }))
+  }))
+}

package/commands/connect/info.js

@@ -0,0 +1,55 @@
+'use strict'
+const api = require('../../lib/connect/api.js')
+const cli = require('@heroku/heroku-cli-util')
+const co = require('co')
+
+module.exports = {
+  topic: 'connect',
+  command: 'info',
+  default: false,
+  description: 'display connection information',
+  help: 'display connection information',
+  flags: [
+    { name: 'resource', description: 'specific connection resource name', hasValue: true },
+    { name: 'check-for-new', char: 'c', description: 'check for access to any new connections', hasValue: false }
+  ],
+  needsApp: true,
+  needsAuth: true,
+  run: cli.command(co.wrap(function * (context, heroku) {
+    let connections
+    if (context.flags['check-for-new']) {
+      connections = yield api.requestAppAccess(context, context.app, context.flags, true, heroku)
+    } else {
+      connections = yield api.withUserConnections(context, context.app, context.flags, true, heroku)
+      if (connections.length === 0) {
+        connections = yield api.requestAppAccess(context, context.app, context.flags, true, heroku)
+      }
+    }
+
+    if (connections.length === 0) {
+      const instanceName = process.env.CONNECT_ADDON === 'connectqa' ? 'connectqa' : 'herokuconnect'
+      cli.error('No connection found. You may need to use addons:open to make it accessible to the CLI.')
+      cli.error('')
+      cli.error('For Example:')
+      cli.error(`heroku addons:open ${instanceName} -a ${context.app}`)
+    } else {
+      connections.forEach(function (connection) {
+        cli.styledHeader(`Connection [${connection.id}] / ${connection.resource_name} (${connection.state})`)
+        cli.log()
+        if (connection.mappings.length > 0) {
+          cli.table(
+            connection.mappings, {
+              columns: [
+                { key: 'object_name', label: 'Object Name' },
+                { key: 'state', label: 'State' }
+              ]
+            }
+          )
+        } else {
+          cli.log('No mappings')
+        }
+        cli.log()
+      })
+    }
+  }))
+}

package/commands/connect/mapping-delete.js

@@ -0,0 +1,33 @@
+'use strict'
+const api = require('../../lib/connect/api.js')
+const cli = require('@heroku/heroku-cli-util')
+const co = require('co')
+
+module.exports = {
+  topic: 'connect:mapping',
+  command: 'delete',
+  description: 'Delete an existing mapping',
+  help: 'Delete an existing mapping',
+  args: [
+    { name: 'mapping' }
+  ],
+  flags: [
+    { name: 'resource', description: 'specific connection resource name', hasValue: true },
+    { name: 'confirm', hasValue: true }
+  ],
+  needsApp: true,
+  needsAuth: true,
+  run: cli.command(co.wrap(function * (context, heroku) {
+    yield cli.confirmApp(context.app, context.flags.confirm)
+
+    yield cli.action('deleting mapping', co(function * () {
+      const connection = yield api.withConnection(context, heroku)
+      context.region = connection.region_url
+      const mapping = yield api.withMapping(connection, context.args.mapping)
+      const response = yield api.request(context, 'DELETE', '/api/v3/mappings/' + mapping.id)
+      if (response.status !== 204) {
+        throw new Error(response.data.message || 'unknown error')
+      }
+    }))
+  }))
+}

package/commands/connect/mapping-diagnose.js

@@ -0,0 +1,33 @@
+'use strict'
+const api = require('../../lib/connect/api.js')
+const cli = require('@heroku/heroku-cli-util')
+const co = require('co')
+const diagnose = require('./diagnose')
+
+module.exports = {
+  topic: 'connect:mapping',
+  command: 'diagnose',
+  description: 'Display diagnostic information about a mapping',
+  help: 'Checks a mapping for common configuration errors. ',
+  args: [
+    { name: 'mapping' }
+  ],
+  flags: [
+    { name: 'resource', description: 'specific connection resource name', hasValue: true },
+    { name: 'verbose', char: 'v', description: 'display passed and skipped check information as well' }
+  ],
+  needsApp: true,
+  needsAuth: true,
+  run: cli.command(co.wrap(function * (context, heroku) {
+    const connection = yield api.withConnection(context, heroku)
+    context.region = connection.region_url
+    const mapping = yield api.withMapping(connection, context.args.mapping)
+    const results = yield cli.action('Diagnosing mapping', co(function * () {
+      const url = '/api/v3/mappings/' + mapping.id + '/validations'
+      return yield api.request(context, 'GET', url)
+    }))
+    cli.log() // Blank line to separate each section
+    cli.styledHeader(mapping.object_name)
+    diagnose.displayResults(results.data, context.flags)
+  }))
+}