Move from using request to alternative for HTTP

borpin · 30 December 2021 15:55

On the basis that request is deprecated, as part of looking at the fitbit node (Fitbit nodes - working? - #4 by borpin), I thought the first step might be to move the module away from request and to node-fetch (looking at the various docs, this seems the best alternative, but not wedded to that).

The current module uses client-oauth2 and request to generate the HTTP requests.

Before I dive in and reinvent the wheel, does anyone have a readymade update to this that will work? Looking through the code, it seems this is the only point that request is actually used, however, I do appreciate that the overall structure might be inappropriate when not using request so may need a more fundamental rewrite (which is probably beyond my skills).

github.com

borpin/node-red-contrib-fitbit/blob/2b956f8eb82c0a470f4d4eb6384f7481f730d300/oauth-helper.js#L47-L60

    
      
          function _makeRequest(method, url, token) {
              return new Promise((resolve, reject) => {
                  request(token.sign({
                      method: method,
                      url: url
                  }), (err, response, _body) => {
                      if (err) {
                          reject(err);
                      } else {
                          resolve(response);
                      }
                  });
              });
          }

BartButenaers · 30 December 2021 16:22

Hi @borpin,
Don't know if you have noticed that the http-request node has moved some time ago from 'request' to got. Perhaps that can also be an alternative for you too? I haven't looked whether it supports oauth...
Bart

borpin · 30 December 2021 16:44

Yes, that is my point; request has been deprecated and an alternative is required. got is one of the options to replace it.

I'm just looking to make the migration as painless as possible!

borpin · 30 December 2021 18:01

I've decided I hate got as it is impossible to search for examples and help. What an absurd name for a package!

dceejay · 30 December 2021 21:28

One of the reasons we chose it for core was that the API was most similar to request, but of course you can use whatever works for you.

bakman2 · 30 December 2021 21:40

They have quite extensive documentation ?

borpin · 31 December 2021 08:07

IS got therefore the preferred replacement? I'd not seen anything suggesting that directly?

borpin · 31 December 2021 08:09

Yes true, but when searching for examples and answers to questions is it one of the worst names possible. Why not http-got. Other names than are in the same positon was the UK firm Thus (didn't last long as a brand) and JC (which is really useful but too few letters to search on).

Steve-Mcl · 31 December 2021 08:19

I agree not the best name for searches. Luckily, Google is pretty good with context so you can add other key words like node, rest, http, endpoint etc

For example, try searching node got post example or got get http

borpin · 31 December 2021 08:33

For my specific purpose (linking with OAuth2) there is nothing that I can see, that helps.

For an experienced user the docs are OK (possibly), but for a relatively new starter, they are not sufficient.

Perhaps this is why the take-up of got is significantly lower than node-fetch.

Yes, it does help, but is still likely to not find a lot of examples :(.

Guessing no one has anything that can help my original question though.

Steve-Mcl · 31 December 2021 09:06

Looking at the SRC you linked to in the OP, the node uses OAuth2. If you search the issues for OAuth2 on the got repository there are quite a few clues. For example this: How to OAuth · Issue #219 · sindresorhus/got · GitHub

borpin · 31 December 2021 09:14

Moving from request is not going to be done by me - simply do not have the knowledge.

The issue is that this Fitbit node currently used the require syntax to import and the got module requires the import syntax.

The 2 cannot coexist (it seems) so I'll have to stick with request.

Yes I have now found that source of info - thanks. Again though, I'd suggest finding this under 'issues' is perhaps not the most user-friendly way . [edit] Also, that post was 2016 and refers to Oauth1!

I'd also point out that the NPM page for got is basically blank (got - npm). This doesn't help its cause.

I'll just have to move on and see if I can adapt what is there for the newer API syntax.

Steve-Mcl · 31 December 2021 09:24

Looks quite extensive to me...

If you (or whoever) targets v11.x of got then you can require got just like node-red does: node-red/packages/node_modules/@node-red/nodes/core/network/21-httprequest.js at master · node-red/node-red · GitHub

borpin · 31 December 2021 09:45

Odd - I see this

If I do that, I get the following;

Dec 31 09:35:55 nrtest Node-RED[1041]: 31 Dec 09:35:55 - [info] Node-RED version: v2.1.4
Dec 31 09:35:55 nrtest Node-RED[1041]: 31 Dec 09:35:55 - [info] Node.js  version: v16.13.1
Dec 31 09:35:55 nrtest Node-RED[1041]: 31 Dec 09:35:55 - [info] Linux 5.4.78-2-pve x64 LE
Dec 31 09:35:58 nrtest Node-RED[1041]: 31 Dec 09:35:58 - [info] Loading palette nodes
Dec 31 09:35:58 nrtest Node-RED[1041]: 31 Dec 09:35:58 - [debug] Module: node-red-contrib-fitbit 1.0.9 /root/.node-red/node_modules/node-red-contrib-fitbit
Dec 31 09:36:04 nrtest Node-RED[1041]: 31 Dec 09:36:04 - [warn] ------------------------------------------------------
Dec 31 09:36:04 nrtest Node-RED[1041]: 31 Dec 09:36:04 - [warn] [node-red-contrib-fitbit/fitbit-credentials] Error [ERR_REQUIRE_ESM]: require() of ES Module /root/.node-red/node_modules/got/dist/source/index.js from /root/.node-red/node_modules/node-red-contrib-fitbit/oauth-helper.js not supported.
Dec 31 09:36:04 nrtest Node-RED[1041]: Instead change the require of index.js in /root/.node-red/node_modules/node-red-contrib-fitbit/oauth-helper.js to a dynamic import() which is available in all CommonJS modules. (line:2)
Dec 31 09:36:04 nrtest Node-RED[1041]: 31 Dec 09:36:04 - [warn] [node-red-contrib-fitbit/fitbit] Error [ERR_REQUIRE_ESM]: require() of ES Module /root/.node-red/node_modules/got/dist/source/index.js from /root/.node-red/node_modules/node-red-contrib-fitbit/oauth-helper.js not supported.
Dec 31 09:36:04 nrtest Node-RED[1041]: Instead change the require of index.js in /root/.node-red/node_modules/node-red-contrib-fitbit/oauth-helper.js to a dynamic import() which is available in all CommonJS modules. (line:52)

:~/.node-red# npm list got
node-red-project@0.0.1 /root/.node-red
`-- got@12.0.0

I'm definitely missing something .

I note the example from core has the require under the module.exports = function (RED) statement. I have tried it there (and in other places to see if it would work).

The error message points to this in another file.

github.com

borpin/node-red-contrib-fitbit/blob/2b956f8eb82c0a470f4d4eb6384f7481f730d300/fitbit.js#L52-L52


      
          const oauth = require('./oauth-helper')(RED);

Steve-Mcl · 31 December 2021 09:48

You are targeting V12.

When you npm install got, use the same version as node-red. (or specify ^11.0.0 in package file of Fitbit node)

Steve-Mcl · 31 December 2021 09:51

Actually, you might get away with a peer dependency of ^11 of got in your fork & when a user installs the node, it should (might) pick up the got version installed by node-red (unsure/untested)

borpin · 31 December 2021 09:59

Ah, OK. I'd read that as ^11.0.0 but you mean specifically V11.

That bit lost me, I'm afraid. How can I tell which version Node-red uses? Can I just use that without installing it again?

Not keen on having to use a specific version of got as a workaround - seems worse than sticking with request.

Steve-Mcl · 31 December 2021 10:05

Look in the node-red package.json

Yes, I agree.

So perhaps try the peer deps...

 "peerDependencies": {
    "got": "11.x"
  }

hardillb · 31 December 2021 10:05

Got made the change to using ESM modules after 99.9% of the work to move to it from request in the http-request node had been done so we pinned it at v11.x rather than start again with another new library.

borpin · 31 December 2021 10:22

Thanks for all your help and patience.

For now, I'll stick with request.

Topic		Replies	Views
Should node-red nodes use HTTP request() or got()? Developing Nodes	5	1852	27 June 2020
Replacement for package "request-promise"? General http-request , javascript	4	219	10 July 2023
FYI - Fetch API in NodeJs 17 Developing Nodes	5	533	17 December 2022
Http request in a function node Developing Nodes http-request	1	1158	31 March 2022
Http post request General	1	635	17 September 2019

Move from using request to alternative for HTTP

Related topics