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
heroku · Apr 15, 2024 · 33f8aac · 33f8aac
1 parent 381575f
commit 33f8aac
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 5 deletions.
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/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')
+      })
+  })
 })