Merge updates from main (#2818)

* release v8.11.2 (#2793) * v8.11.2 * Fix scripting errors * Bump heroku-color (#2797) * fix(authorizations): surface api warnings in temporary fix (#2804) * Surface api warnings for authorizations:create * Surface remaining api warnings for authorizations command * Add api warning header test for authorizations:create * Update response type in authorizations:info * release v8.11.3 (#2807) * v8.11.3 * Fix scripting errors * chore(telemetry): add environment variable to optionally disable telemetry (#2810) * Add DISABLE_TELEMETRY env variable & functionality * WIP create test for DISABLE_TELEMETRY env variable * Update DISABLE_TELEMETRY and remove wip test * Clean code up * release v8.11.4 (#2811) * v8.11.4 * Fix scripting errors * Fix failing test --------- Co-authored-by: Eric <eblack@salesforce.com>
heroku · Apr 18, 2024 · 0f4a72f · 0f4a72f
1 parent b133cfe
commit 0f4a72f
Show file tree

Hide file tree

Showing 13 changed files with 86 additions and 14 deletions.
diff --git a/docs/auth.md b/docs/auth.md
@@ -1,7 +1,7 @@
 `heroku auth`
 =============
 
-check 2fa status
+manage authentication for your Heroku account
 
 * [`heroku auth:2fa`](#heroku-auth2fa)
 * [`heroku auth:2fa:disable`](#heroku-auth2fadisable)

diff --git a/packages/certs-v5/package.json b/packages/certs-v5/package.json
@@ -15,7 +15,7 @@
     "repositoryPrefix": "<%- repo %>/blob/v<%- version %>/packages/certs-v5/<%- commandPath %>"
   },
   "dependencies": {
-    "@heroku-cli/color": "^1.1.14",
+    "@heroku-cli/color": "^2.0.1",
     "@heroku-cli/notifications": "^1.2.4",
     "date-fns": "^1.29.0",
     "heroku-cli-util": "^8.0.11",

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -6,7 +6,7 @@
   "bin": "./bin/run",
   "bugs": "https://github.com/heroku/cli/issues",
   "dependencies": {
-    "@heroku-cli/color": "1.1.14",
+    "@heroku-cli/color": "2.0.1",
     "@heroku-cli/command": "^10.0.0",
     "@heroku-cli/command-v9": "npm:@heroku-cli/command@^9.0.2",
     "@heroku-cli/notifications": "^1.2.4",

diff --git a/packages/cli/src/commands/authorizations/create.ts b/packages/cli/src/commands/authorizations/create.ts
@@ -25,7 +25,7 @@ export default class AuthorizationsCreate extends Command {
 
     ux.action.start('Creating OAuth Authorization')
 
-    const {body: auth} = await this.heroku.post<Heroku.OAuthAuthorization>('/oauth/authorizations', {
+    const {body: auth, headers} = await this.heroku.post<Heroku.OAuthAuthorization>('/oauth/authorizations', {
       body: {
         description: flags.description,
         scope: flags.scope ? flags.scope.split(',') : undefined,
@@ -35,6 +35,12 @@ export default class AuthorizationsCreate extends Command {
 
     ux.action.stop()
 
+    const apiWarnings = headers['warning-message'] as string || ''
+
+    if (apiWarnings) {
+      ux.warn(apiWarnings)
+    }
+
     if (flags.short) {
       ux.log(auth.access_token && auth.access_token.token)
     } else if (flags.json) {

diff --git a/packages/cli/src/commands/authorizations/info.ts b/packages/cli/src/commands/authorizations/info.ts
@@ -18,10 +18,16 @@ export default class AuthorizationsInfo extends Command {
   async run() {
     const {args, flags} = await this.parse(AuthorizationsInfo)
 
-    const {body: authentication} = await this.heroku.get<Heroku.OAuthClient>(
+    const {body: authentication, headers} = await this.heroku.get<Heroku.OAuthAuthorization>(
       `/oauth/authorizations/${args.id}`,
     )
 
+    const apiWarnings = headers['warning-message'] as string || ''
+
+    if (apiWarnings) {
+      ux.warn(apiWarnings)
+    }
+
     if (flags.json) {
       ux.styledJSON(authentication)
     } else {

diff --git a/packages/cli/src/commands/authorizations/revoke.ts b/packages/cli/src/commands/authorizations/revoke.ts
@@ -21,10 +21,16 @@ export default class AuthorizationsRevoke extends Command {
 
     ux.action.start('Revoking OAuth Authorization')
 
-    const {body: auth} = await this.heroku.delete<Heroku.OAuthAuthorization>(
+    const {body: auth, headers} = await this.heroku.delete<Heroku.OAuthAuthorization>(
       `/oauth/authorizations/${encodeURIComponent(args.id)}`,
     )
 
+    const apiWarnings = headers['warning-message'] as string || ''
+
+    if (apiWarnings) {
+      ux.warn(apiWarnings)
+    }
+
     ux.action.stop(`done, revoked authorization from ${color.cyan(auth.description)}`)
   }
 }
diff --git a/packages/cli/src/commands/authorizations/rotate.ts b/packages/cli/src/commands/authorizations/rotate.ts
@@ -16,10 +16,16 @@ export default class AuthorizationsRotate extends Command {
 
     ux.action.start('Rotating OAuth Authorization')
 
-    const {body: authorization} = await this.heroku.post<Heroku.OAuthAuthorization>(
+    const {body: authorization, headers} = await this.heroku.post<Heroku.OAuthAuthorization>(
       `/oauth/authorizations/${encodeURIComponent(args.id)}/actions/regenerate-tokens`,
     )
 
+    const apiWarnings = headers['warning-message'] as string || ''
+
+    if (apiWarnings) {
+      ux.warn(apiWarnings)
+    }
+
     ux.action.stop()
 
     display(authorization)

diff --git a/packages/cli/src/commands/authorizations/update.ts b/packages/cli/src/commands/authorizations/update.ts
@@ -30,7 +30,7 @@ export default class AuthorizationsUpdate extends Command {
       }
     }
 
-    const {body: authentication} = await this.heroku.patch<Heroku.OAuthAuthorization>(
+    const {body: authentication, headers} = await this.heroku.patch<Heroku.OAuthAuthorization>(
       `/oauth/authorizations/${args.id}`,
       {
         body: {
@@ -40,6 +40,12 @@ export default class AuthorizationsUpdate extends Command {
       },
     )
 
+    const apiWarnings = headers['warning-message'] as string || ''
+
+    if (apiWarnings) {
+      ux.warn(apiWarnings)
+    }
+
     ux.action.stop()
 
     display(authentication)

diff --git a/packages/cli/src/global_telemetry.ts b/packages/cli/src/global_telemetry.ts
@@ -13,6 +13,7 @@ const {version} = require('../package.json')
 
 const root = path.resolve(__dirname, '../package.json')
 const isDev = process.env.IS_DEV_ENVIRONMENT === 'true'
+const isTelemetryDisabled = process.env.DISABLE_TELEMETRY === 'true'
 
 function getToken() {
   const config = new Config({root})
@@ -152,6 +153,10 @@ export function reportCmdNotFound(config: any) {
 
 export async function sendTelemetry(currentTelemetry: any,  rollbarCb?: () => void) {
   // send telemetry to honeycomb and rollbar
+  if (isTelemetryDisabled) {
+    return
+  }
+
   const telemetry = currentTelemetry
 
   if (telemetry instanceof Error) {

diff --git a/packages/cli/test/unit/commands/addons/upgrade.unit.test.ts b/packages/cli/test/unit/commands/addons/upgrade.unit.test.ts
@@ -5,6 +5,7 @@ import * as nock from 'nock'
 import {AddOn} from '@heroku-cli/schema'
 import {expect} from 'chai'
 import * as chalk from 'chalk'
+import stripAnsi = require('strip-ansi')
 
 describe('addons:upgrade', () => {
   let api: ReturnType<typeof nock>
@@ -178,7 +179,7 @@ describe('addons:upgrade', () => {
       ])
     } catch (error) {
       if (error instanceof Error) {
-        expect(error.message).to.equal('Couldn\'t find either the add-on service or the add-on plan of "heroku-db1:invalid".\n\nHere are the available plans for heroku-db1:\nheroku-db1:free\nheroku-db1:basic\nheroku-db1:premium-0\n\nSee more plan information with heroku addons:plans heroku-db1\n\nhttps://devcenter.heroku.com/articles/managing-add-ons')
+        expect(stripAnsi(error.message)).to.equal('Couldn\'t find either the add-on service or the add-on plan of "heroku-db1:invalid".\n\nHere are the available plans for heroku-db1:\nheroku-db1:free\nheroku-db1:basic\nheroku-db1:premium-0\n\nSee more plan information with heroku addons:plans heroku-db1\n\nhttps://devcenter.heroku.com/articles/managing-add-ons')
       }
     }
   })

diff --git a/packages/cli/test/unit/commands/authorizations/create.unit.test.ts b/packages/cli/test/unit/commands/authorizations/create.unit.test.ts
@@ -39,4 +39,19 @@ describe('authorizations:create', () => {
         expect(json.scope).to.contain('global')
       })
   })
+
+  context('API warning headers', () => {
+    test
+      .stderr()
+      .stdout()
+      .nock('https://api.heroku.com:443', api => {
+        api
+          .post('/oauth/authorizations', {description: 'awesome'})
+          .reply(201, {scope: ['global'], access_token: {token: 'secrettoken'}}, {'warning-message': 'this is an API warning message example'})
+      })
+      .command(['authorizations:create', '--description', 'awesome'])
+      .it('outputs API warning message', ctx => {
+        expect(ctx.stderr).contains('this is an API warning message example')
+      })
+  })
 })
diff --git a/packages/run-v5/package.json b/packages/run-v5/package.json
@@ -18,7 +18,7 @@
     "repositoryPrefix": "<%- repo %>/blob/v<%- version %>/packages/run-v5/<%- commandPath %>"
   },
   "dependencies": {
-    "@heroku-cli/color": "^1.1.14",
+    "@heroku-cli/color": "^2.0.1",
     "@heroku-cli/command": "^9.0.2",
     "@heroku-cli/notifications": "^1.2.4",
     "@heroku/eventsource": "^1.0.7",

diff --git a/yarn.lock b/yarn.lock
@@ -1142,7 +1142,19 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@heroku-cli/color@npm:1.1.14, @heroku-cli/color@npm:^1.1.14, @heroku-cli/color@npm:^1.1.3":
+"@heroku-cli/color@npm:2.0.1, @heroku-cli/color@npm:^2.0.1":
+  version: 2.0.1
+  resolution: "@heroku-cli/color@npm:2.0.1"
+  dependencies:
+    ansi-styles: ^4.3.0
+    chalk: ^4.1.2
+    supports-color: ^7.2.0
+    tslib: ^1.9.3
+  checksum: 3f2591fab0d28a88592b78b8b6e171cafd927e8b6ea1b807878ad3a9b46636c07e63d6983b64b94ec47f05a5a9fe2db80f95d5f381e4b6c14dac48c4aab7ba93
+  languageName: node
+  linkType: hard
+
+"@heroku-cli/color@npm:^1.1.14, @heroku-cli/color@npm:^1.1.3":
   version: 1.1.14
   resolution: "@heroku-cli/color@npm:1.1.14"
   dependencies:
@@ -1261,7 +1273,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@heroku-cli/plugin-certs-v5@workspace:packages/certs-v5"
   dependencies:
-    "@heroku-cli/color": ^1.1.14
+    "@heroku-cli/color": ^2.0.1
     "@heroku-cli/notifications": ^1.2.4
     "@oclif/plugin-legacy": ^1.3.0
     chai: ^4.2.0
@@ -1383,7 +1395,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@heroku-cli/plugin-run-v5@workspace:packages/run-v5"
   dependencies:
-    "@heroku-cli/color": ^1.1.14
+    "@heroku-cli/color": ^2.0.1
     "@heroku-cli/command": ^9.0.2
     "@heroku-cli/notifications": ^1.2.4
     "@heroku/eventsource": ^1.0.7
@@ -10915,7 +10927,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "heroku@workspace:packages/cli"
   dependencies:
-    "@heroku-cli/color": 1.1.14
+    "@heroku-cli/color": 2.0.1
     "@heroku-cli/command": ^10.0.0
     "@heroku-cli/command-v9": "npm:@heroku-cli/command@^9.0.2"
     "@heroku-cli/notifications": ^1.2.4
@@ -17874,6 +17886,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"supports-color@npm:^7.2.0":
+  version: 7.2.0
+  resolution: "supports-color@npm:7.2.0"
+  dependencies:
+    has-flag: ^4.0.0
+  checksum: 3dda818de06ebbe5b9653e07842d9479f3555ebc77e9a0280caf5a14fb877ffee9ed57007c3b78f5a6324b8dbeec648d9e97a24e2ed9fdb81ddc69ea07100f4a
+  languageName: node
+  linkType: hard
+
 "supports-hyperlinks@npm:^1.0.1":
   version: 1.0.1
   resolution: "supports-hyperlinks@npm:1.0.1"