OpenFn / OpenFn/adaptors

salesforce: add generic HTTP helpers

Open
#668 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DevX wontfix
Dominant language
JavaScript
Stars
24
Forks
41
Avg merge
3d 13h
Merged PRs (30d)
12

Description

Salesforce exposes request which enables a low-level HTTP request to be made to the salesforce API directly.

The old 4.8 salesforce also exported axios directly (maybe common http too?)

The new API does not.

We need to work out how to expose a generic set of HTTP helpers to call external services. It is critical that these helper do not append salesforce credentials

This may be related to the util pattern #522 . We could export standard functions on util.request. Or we could export a http namespace and have operations like http.get. Maybe even both.

A more seamless API would be to expose a single API (request/get/post) use jsforce.request for relative urls, and common.http for any other absolute URL. The worry there is that the return and error handling are likely to be different - how important is that, and can we consolidate?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the old 4.8 Salesforce exports with the new API, then read the related util pattern in issue #522. The issue leaves the API shape undecided between util.request, an http namespace, or shared request/get/post functions; clarify that design and define how credential handling, return values, and errors should work before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.