Merge pull request #21 from OldSneerJaw/heroku-auth-identity

Require identity scope for Heroku authorizations
OldSneerJaw · Oct 30, 2021 · cde6120 · cde6120
2 parents 8d23686 + 02b67d3
commit cde6120
Show file tree

Hide file tree

Showing 8 changed files with 11 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/). All notable changes will be documented in this file.
 
+## [Unreleased](https://github.com/OldSneerJaw/borealis-pg-cli/compare/v0.4.0...HEAD)
+- Require "identity" scope for Heroku authorizations
+
 ## [0.4.0](https://github.com/OldSneerJaw/borealis-pg-cli/compare/v0.3.1...v0.4.0)
 - Clarified in the `borealis-pg:tunnel` command's output that it does not accept keyboard input
 - Handle port conflicts for secure tunnels on Windows

diff --git a/src/commands/borealis-pg/extensions/index.test.ts b/src/commands/borealis-pg/extensions/index.test.ts
@@ -15,7 +15,7 @@ const baseTestContext = test.stdout()
     .post('/oauth/authorizations', {
       description: 'Borealis PG CLI plugin temporary auth token',
       expires_in: 180,
-      scope: ['read'],
+      scope: ['read', 'identity'],
     })
     .reply(201, {id: fakeHerokuAuthId, access_token: {token: fakeHerokuAuthToken}})
     .delete(`/oauth/authorizations/${fakeHerokuAuthId}`)

diff --git a/src/commands/borealis-pg/extensions/install.test.ts b/src/commands/borealis-pg/extensions/install.test.ts
@@ -22,7 +22,7 @@ const baseTestContext = test.stdout()
       .post('/oauth/authorizations', {
         description: 'Borealis PG CLI plugin temporary auth token',
         expires_in: 180,
-        scope: ['read'],
+        scope: ['read', 'identity'],
       })
       .reply(201, {id: fakeHerokuAuthId, access_token: {token: fakeHerokuAuthToken}})
       .delete(`/oauth/authorizations/${fakeHerokuAuthId}`)

diff --git a/src/commands/borealis-pg/extensions/remove.test.ts b/src/commands/borealis-pg/extensions/remove.test.ts
@@ -17,7 +17,7 @@ const baseTestContext = test.stdout()
     api => api.post('/oauth/authorizations', {
       description: 'Borealis PG CLI plugin temporary auth token',
       expires_in: 180,
-      scope: ['read'],
+      scope: ['read', 'identity'],
     })
       .reply(201, {id: fakeHerokuAuthId, access_token: {token: fakeHerokuAuthToken}})
       .delete(`/oauth/authorizations/${fakeHerokuAuthId}`)

diff --git a/src/commands/borealis-pg/run.ts b/src/commands/borealis-pg/run.ts
@@ -157,7 +157,7 @@ an add-on Postgres database.`
     usePersonalUser: boolean,
     enableWriteAccess: boolean,
     showSpinner: boolean): Promise<[SshConnectionInfo, DbConnectionInfo]> {
-    const authorization = await createHerokuAuth(this.heroku, true)
+    const authorization = await createHerokuAuth(this.heroku)
     try {
       const dbConnInfoPromise =
         !usePersonalUser ?

diff --git a/src/commands/borealis-pg/tunnel.ts b/src/commands/borealis-pg/tunnel.ts
@@ -77,7 +77,7 @@ add-on Postgres database.`
   private async createPersonalUsers(
     addonName: string,
     enableWriteAccess: boolean): Promise<[SshConnectionInfo, DbConnectionInfo]> {
-    const authorization = await createHerokuAuth(this.heroku, true)
+    const authorization = await createHerokuAuth(this.heroku)
     const accessLevelName = enableWriteAccess ? 'read/write' : 'read-only'
     try {
       const [sshConnInfoResult, dbConnInfoResult] = await applyActionSpinner(

diff --git a/src/heroku-api.test.ts b/src/heroku-api.test.ts
@@ -23,27 +23,11 @@ describe('createHerokuAuth', () => {
     mockHerokuApiClientInstance = instance(mockHerokuApiClientType)
   })
 
-  it('requests an authorization without the "identity" scope by default', async () => {
+  it('requests a Heroku authorization', async () => {
     const result = await createHerokuAuth(mockHerokuApiClientInstance)
 
     expect(result).to.equal(fakeAuthorization)
 
-    verify(mockHerokuApiClientType.post<OAuthAuthorization>(
-      '/oauth/authorizations',
-      deepEqual({
-        body: {
-          description: 'Borealis PG CLI plugin temporary auth token',
-          expires_in: 180,
-          scope: ['read'],
-        },
-      }))).once()
-  })
-
-  it('requests an authorization with the "identity" scope', async () => {
-    const result = await createHerokuAuth(mockHerokuApiClientInstance, true)
-
-    expect(result).to.equal(fakeAuthorization)
-
     verify(mockHerokuApiClientType.post<OAuthAuthorization>(
       '/oauth/authorizations',
       deepEqual({

diff --git a/src/heroku-api.ts b/src/heroku-api.ts
@@ -8,17 +8,14 @@ import {HTTPError} from 'http-call'
  * @param herokuApiClient The Heroku API client
  * @param includeIdentityScope Whether the authorization should include the "identity" scope
  */
-export async function createHerokuAuth(
-  herokuApiClient: APIClient,
-  includeIdentityScope = false): Promise<OAuthAuthorization> {
-  const scopes = includeIdentityScope ? ['read', 'identity'] : ['read']
+export async function createHerokuAuth(herokuApiClient: APIClient): Promise<OAuthAuthorization> {
   const response = await herokuApiClient.post<OAuthAuthorization>(
     '/oauth/authorizations',
     {
       body: {
         description: 'Borealis PG CLI plugin temporary auth token',
         expires_in: 180,
-        scope: scopes,
+        scope: ['read', 'identity'],
       },
     })