chore: move validation left, standard headers, util methods

Author: WillieRuemmele

messages/rest.md

@@ -10,7 +10,26 @@ Make an authenticated HTTP request to Salesforce REST API and print the response
 
 - Get the response in XML format by specifying the "Accept" HTTP header:
 
-  <%= config.bin %> <%= command.id %> 'services/data/v56.0/limits' --target-org my-org --header 'Accept: application/xml',
+  <%= config.bin %> <%= command.id %> 'services/data/v56.0/limits' --target-org my-org --header 'Accept: application/xml'
+
+- POST to create an Account object
+
+  <%= config.bin %> <%= command.id %> '/services/data/v46.0/sobjects/account' --body "{\"Name\" : \"Account from REST API\",\"ShippingCity\" : \"Boise\"}" --method POST
+
+- or with a file 'info.json' containing
+
+```json
+{
+  "Name": "Demo",
+  "ShippingCity": "Boise"
+}
+```
+
+<%= config.bin %> <%= command.id %> '/services/data/v46.0/sobjects/account' --body info.json --method POST
+
+- Update object
+
+  <%= config.bin %> <%= command.id %> '/services/data/v46.0/sobjects/account/<Account ID>' --body "{\"BillingCity\": \"San Francisco\"}" --method PATCH
 
 # flags.include.summary
 

src/commands/api/request/rest.ts

@@ -4,15 +4,16 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { EOL } from 'node:os';
-import { createWriteStream } from 'node:fs';
-import got, { Headers } from 'got';
+import { createWriteStream, readFileSync, existsSync } from 'node:fs';
+import { join } from 'node:path';
+import got from 'got';
 import type { AnyJson } from '@salesforce/ts-types';
 import { ProxyAgent } from 'proxy-agent';
 import { Flags, SfCommand } from '@salesforce/sf-plugins-core';
-import { Messages, Org, SfError } from '@salesforce/core';
+import { Messages, Org, SFDX_HTTP_HEADERS, SfError } from '@salesforce/core';
 import { Args } from '@oclif/core';
 import ansis from 'ansis';
+import { getHeaders } from '../../../shared/methods.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-api', 'rest');
@@ -23,12 +24,7 @@ export class Rest extends SfCommand<void> {
   public static state = 'beta';
   public static enableJsonFlag = false;
   public static readonly flags = {
-    // TODO: getting a false positive from this eslint rule.
-    // summary is already set in the org flag.
-    // eslint-disable-next-line sf-plugin/flag-summary
-    'target-org': Flags.requiredOrg({
-      helpValue: 'username',
-    }),
+    'target-org': Flags.requiredOrg(),
     include: Flags.boolean({
       char: 'i',
       summary: messages.getMessage('flags.include.summary'),
@@ -67,45 +63,38 @@ export class Rest extends SfCommand<void> {
     }),
   };
 
-  private static getHeaders(keyValPair: string[]): Headers {
-    const headers: { [key: string]: string } = {};
-
-    for (const header of keyValPair) {
-      const [key, ...rest] = header.split(':');
-      const value = rest.join(':').trim();
-      if (!key || !value) {
-        throw new SfError(`Failed to parse HTTP header: "${header}".`, 'Failed To Parse HTTP Header', [
-          'Make sure the header is in a "key:value" format, e.g. "Accept: application/json"',
-        ]);
-      }
-      headers[key] = value;
-    }
-
-    return headers;
-  }
-
   public async run(): Promise<void> {
     const { flags, args } = await this.parse(Rest);
 
     const org = flags['target-org'];
     const streamFile = flags['stream-to-file'];
+    const headers = flags.header ? getHeaders(flags.header) : {};
+
+    const url = new URL(`${org.getField<string>(Org.Fields.INSTANCE_URL)}/${args.endpoint}`);
+    const body =
+      flags.method === 'GET'
+        ? undefined
+        : // if they've passed in a file name, check and read it
+        existsSync(join(process.cwd(), flags.body ?? ''))
+        ? readFileSync(join(process.cwd(), flags.body ?? ''))
+        : // otherwise it's a stdin, and we use it directly
+          flags.body;
 
     await org.refreshAuth();
 
-    const url = `${org.getField<string>(Org.Fields.INSTANCE_URL)}/${args.endpoint}`;
-
     const options = {
       agent: { https: new ProxyAgent() },
       method: flags.method,
       headers: {
+        ...SFDX_HTTP_HEADERS,
         Authorization: `Bearer ${
           // we don't care about apiVersion here, just need to get the access token.
           // eslint-disable-next-line sf-plugin/get-connection-with-version
           org.getConnection().getConnectionOptions().accessToken!
         }`,
-        ...(flags.header ? Rest.getHeaders(flags.header) : {}),
+        ...headers,
       },
-      body: flags.method === 'GET' ? undefined : flags.body,
+      body,
       throwHttpErrors: false,
       followRedirect: false,
     };
@@ -127,12 +116,10 @@ export class Rest extends SfCommand<void> {
 
       // Print HTTP response status and headers.
       if (flags.include) {
-        let httpInfo = `HTTP/${res.httpVersion} ${res.statusCode} ${EOL}`;
-
-        for (const [header] of Object.entries(res.headers)) {
-          httpInfo += `${ansis.blue.bold(header)}: ${res.headers[header] as string}${EOL}`;
-        }
-        this.log(httpInfo);
+        this.log(`HTTP/${res.httpVersion} ${res.statusCode}`);
+        Object.entries(res.headers).map(([header, value]) => {
+          this.log(`${ansis.blue.bold(header)}: ${Array.isArray(value) ? value.join(',') : value ?? '<undefined>'}`);
+        });
       }
 
       try {

src/shared/methods.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { SfError } from '@salesforce/core';
+import type { Headers } from 'got';
+
+export function getHeaders(keyValPair: string[]): Headers {
+  const headers: { [key: string]: string } = {};
+
+  for (const header of keyValPair) {
+    const [key, ...rest] = header.split(':');
+    const value = rest.join(':').trim();
+    if (!key || !value) {
+      throw new SfError(`Failed to parse HTTP header: "${header}".`, 'Failed To Parse HTTP Header', [
+        'Make sure the header is in a "key:value" format, e.g. "Accept: application/json"',
+      ]);
+    }
+    headers[key] = value;
+  }
+
+  return headers;
+}

test/commands/api/request/rest.test.ts

@@ -7,12 +7,14 @@
 import fs from 'node:fs';
 import * as process from 'node:process';
 import path from 'node:path';
+import * as assert from 'node:assert';
 import { SfError } from '@salesforce/core';
 import { expect } from 'chai';
 import stripAnsi from 'strip-ansi';
 import { MockTestOrgData, TestContext } from '@salesforce/core/testSetup';
 import { sleep } from '@salesforce/kit';
 import nock = require('nock');
+import { stubUx } from '@salesforce/sf-plugins-core';
 import { Rest } from '../../../../src/commands/api/request/rest.js';
 
 describe('rest', () => {
@@ -21,8 +23,7 @@ describe('rest', () => {
     username: '[email protected]',
   });
 
-  let stdoutSpy: sinon.SinonSpy;
-
+  let uxStub: ReturnType<typeof stubUx>;
   const orgLimitsResponse = {
     ActiveScratchOrgs: {
       Max: 200,
@@ -32,8 +33,7 @@ describe('rest', () => {
 
   beforeEach(async () => {
     await $$.stubAuths(testOrg);
-
-    stdoutSpy = $$.SANDBOX.stub(process.stdout, 'write');
+    uxStub = stubUx($$.SANDBOX);
   });
 
   afterEach(() => {
@@ -45,21 +45,31 @@ describe('rest', () => {
 
     await Rest.run(['services/data/v56.0/limits', '--target-org', '[email protected]']);
 
-    const output = stripAnsi(stdoutSpy.args.flat().join(''));
+    expect(uxStub.styledJSON.args[0][0]).to.deep.equal(orgLimitsResponse);
+  });
 
-    expect(JSON.parse(output)).to.deep.equal(orgLimitsResponse);
+  it('should throw error for invalid header args', async () => {
+    try {
+      await Rest.run(['services/data/v56.0/limits', '--target-org', '[email protected]', '-H', 'myInvalidHeader']);
+      assert.fail('the above should throw');
+    } catch (e) {
+      expect((e as SfError).name).to.equal('Failed To Parse HTTP Header');
+      expect((e as SfError).message).to.equal('Failed to parse HTTP header: "myInvalidHeader".');
+      expect((e as SfError).actions).to.deep.equal([
+        'Make sure the header is in a "key:value" format, e.g. "Accept: application/json"',
+      ]);
+    }
   });
 
   it('should redirect to file', async () => {
     nock(testOrg.instanceUrl).get('/services/data/v56.0/limits').reply(200, orgLimitsResponse);
-
+    const writeSpy = $$.SANDBOX.stub(process.stdout, 'write');
     await Rest.run(['services/data/v56.0/limits', '--target-org', '[email protected]', '--stream-to-file', 'myOutput.txt']);
 
     // gives it a second to resolve promises and close streams before we start asserting
     await sleep(1000);
-    const output = stripAnsi(stdoutSpy.args.flat().join(''));
 
-    expect(output).to.deep.equal('File saved to myOutput.txt' + '\n');
+    expect(writeSpy.args.flat().join('')).to.deep.equal('File saved to myOutput.txt' + '\n');
     expect(JSON.parse(fs.readFileSync('myOutput.txt', 'utf8'))).to.deep.equal(orgLimitsResponse);
 
     after(() => {
@@ -76,6 +86,7 @@ describe('rest', () => {
 		<Remaining>198</Remaining>
 	</ActiveScratchOrgs>
 </LimitsSnapshot>`;
+    const writeSpy = $$.SANDBOX.stub(process.stdout, 'write');
 
     nock(testOrg.instanceUrl, {
       reqheaders: {
@@ -87,7 +98,7 @@ describe('rest', () => {
 
     await Rest.run(['services/data', '--header', 'Accept: application/xml', '--target-org', '[email protected]']);
 
-    const output = stripAnsi(stdoutSpy.args.flat().join(''));
+    const output = stripAnsi(writeSpy.args.flat().join(''));
 
     // https://github.com/oclif/core/blob/ff76400fb0bdfc4be0fa93056e86183b9205b323/src/command.ts#L248-L253
     expect(output).to.equal(xmlRes + '\n');
@@ -117,8 +128,6 @@ describe('rest', () => {
 
     await Rest.run(['services/data/v56.0/limites', '--target-org', '[email protected]']);
 
-    const output = stripAnsi(stdoutSpy.args.flat().join(''));
-
-    expect(JSON.parse(output)).to.deep.equal(orgLimitsResponse);
+    expect(uxStub.styledJSON.args[0][0]).to.deep.equal(orgLimitsResponse);
   });
 });