refactor: update salesforce:publish API call to not use APIClient (#106)

* refactor: update salesforce:publish API call to not use APIClient

* fix: fix publish API URL

* test: remove legacy salesforce:publish tests

* fix: fix error message printing

* fix: update name of metadata

* refactor: zip file using deflate instead of gzip

* fix: use adm-zip to zip files for salesforce:publish

Author: k80bowman

package.json

@@ -10,11 +10,14 @@
     "@heroku-cli/schema": "^1.0.25",
     "@oclif/core": "^2.16.0",
     "@oclif/plugin-help": "^5",
+    "adm-zip": "^0.5.16",
+    "axios": "^1.9.0",
     "open": "^8.4.2",
     "tsheredoc": "^1"
   },
   "devDependencies": {
     "@oclif/test": "^2.3.28",
+    "@types/adm-zip": "^0.5.7",
     "@types/mocha": "^10",
     "@types/nock": "^11",
     "@types/node": "22.14.1",

src/commands/salesforce/publish.ts

@@ -1,11 +1,12 @@
 import {color} from '@heroku-cli/color'
 import {flags} from '@heroku-cli/command'
 import {ux, Args} from '@oclif/core'
+import axios from 'axios'
 import fs from 'fs'
 import path from 'path'
-import {gzipSync} from 'zlib'
 import Command from '../../lib/base'
 import * as AppLink from '../../lib/applink/types'
+import AdmZip from 'adm-zip'
 
 export default class Publish extends Command {
   static description = 'publish an app\'s API specification to an authenticated Salesforce org'
@@ -25,6 +26,12 @@ export default class Publish extends Command {
     api_spec_file_dir: Args.file({required: true, description: 'path to OpenAPI 3.x spec file (JSON or YAML format)'}),
   }
 
+  protected createZipArchive = async (files: AppLink.FileEntry[]) => {
+    const zipArchive = new AdmZip()
+    files.forEach(file => zipArchive.addFile(file.name, file.content))
+    return zipArchive.toBuffer()
+  }
+
   public async run(): Promise<void> {
     const {flags, args} = await this.parse(Publish)
     const {app, addon, 'client-name': clientName, 'connection-name': connectionName, 'authorization-connected-app-name': authorizationConnectedAppName, 'authorization-permission-set-name': authorizationPermissionSetName, 'metadata-dir': metadataDir} = flags
@@ -82,32 +89,48 @@ export default class Publish extends Command {
       }
     }
 
-    const filesForJson = files.map(file => ({
-      name: file.name,
-      content: file.content.toString('base64'),
+    const compressedContent = await this.createZipArchive(files)
+    const appRequestContent = {
+      client_name: clientName,
+      authorization_connected_app_name: authorizationConnectedAppName,
+      authorization_permission_set_name: authorizationPermissionSetName,
+    }
+    const formData = new FormData()
+    formData.append('metadata', new Blob([
+      compressedContent,
+    ], {
+      type: 'application/zip',
+    }
+    ))
+    formData.append('app_request', new Blob([
+      JSON.stringify(appRequestContent),
+    ], {
+      type: 'application/json',
     }))
 
-    const compressedContent = gzipSync(JSON.stringify(filesForJson))
-    const binaryMetadataZip = compressedContent.toString('base64')
-
     await this.configureAppLinkClient(app, addon)
 
-    ux.action.start(`Publishing ${color.app(app)} to ${color.yellow(connectionName)} as ${color.yellow(clientName)}`)
-
-    await this.applinkClient.post<AppLink.AppPublish>(
-      `/addons/${this.addonId}/connections/salesforce/${connectionName}/apps`,
-      {
-        headers: {authorization: `Bearer ${this._applinkToken}`},
-        body: {
-          app_request: {
-            client_name: clientName,
-            authorization_connected_app_name: authorizationConnectedAppName,
-            authorization_permission_set_name: authorizationPermissionSetName,
-          },
-          metadata_zip: binaryMetadataZip,
-        },
-        retryAuth: false,
-      })
+    const publishURL = `https://${this._applink.defaults.host}/addons/${this.addonId}/connections/salesforce/${connectionName}/apps`
+    const headers = this._applink.defaults.headers || {}
+
+    ux.action.start(`Publishing ${color.app(app)} to ${color.yellow(connectionName)} as ${color.yellow(clientName)} via ${publishURL}`)
+
+    await axios.post(publishURL, formData, {
+      headers: {
+        accept: 'application/json',
+        'Content-Type': 'multipart/form-data',
+        Authorization: `Bearer ${this._applinkToken}`,
+        'x-addon-sso': headers['x-addon-sso'],
+        'x-app-uuid': headers['x-app-uuid'],
+        'User-Agent': headers['user-agent'],
+      },
+    }).catch(error => {
+      if (error.response.data && error.response.data.message) {
+        ux.error(error.response.data.message, {exit: 1})
+      } else {
+        throw error
+      }
+    })
 
     ux.action.stop()
   }

src/lib/base.ts

@@ -6,8 +6,8 @@ import {ux} from '@oclif/core'
 import heredoc from 'tsheredoc'
 
 export default abstract class extends Command {
-  private _applink!: APIClient
   private _addonId!: string
+  _applink!: APIClient
   _addonName!: string
   _appId!: string
   _applinkToken!: string

test/commands/salesforce/publish.test.ts

@@ -5,7 +5,6 @@ import {runCommand} from '../../run-command'
 import Cmd from '../../../src/commands/salesforce/publish'
 import {
   addon,
-  legacyAddon,
   sso_response,
 } from '../../helpers/fixtures'
 import stripAnsi from '../../helpers/strip-ansi'
@@ -60,51 +59,6 @@ describe('salesforce:publish', function () {
     })
   })
 
-  context('when config var is set to the legacy HEROKU_INTEGRATION_API_URL', function () {
-    let integrationApi: nock.Scope
-
-    beforeEach(function () {
-      process.env = {}
-      api = nock('https://api.heroku.com')
-        .get('/apps/my-app/addons')
-        .reply(200, [legacyAddon])
-        .get('/apps/my-app/config-vars')
-        .reply(200, {
-          HEROKU_INTEGRATION_API_URL: 'https://integration-api.heroku.com/addons/01234567-89ab-cdef-0123-456789abcdef',
-          HEROKU_INTEGRATION_TOKEN: 'token',
-        })
-        .get('/apps/my-app/addons/01234567-89ab-cdef-0123-456789abcdef/sso')
-        .reply(200, sso_response)
-      integrationApi = nock('https://integration-api.heroku.com')
-    })
-
-    afterEach(function () {
-      process.env = env
-      api.done()
-      integrationApi.done()
-      nock.cleanAll()
-    })
-
-    it('successfully publishes an API spec file', async function () {
-      integrationApi
-        .post('/addons/01234567-89ab-cdef-0123-456789abcdef/connections/salesforce/myorg/apps')
-        .reply(201, [])
-
-      const filePath = `${__dirname}/../../helpers/openapi.json`
-
-      await runCommand(Cmd, [
-        filePath,
-        '--app=my-app',
-        '--addon=heroku-integration-vertical-01234',
-        '--client-name=AccountAPI',
-        '--connection-name=myorg',
-      ])
-
-      expect(stripAnsi(stderr.output)).to.contain('Publishing my-app to myorg as AccountAPI')
-      expect(stdout.output).to.equal('')
-    })
-  })
-
   it('throws an error when API spec file is not found', async function () {
     const nonExistentPath = `${__dirname}/non-existent-file.json`