Convert to v2, addon. Just wrap `fetch`. #754

NullVoxPopuli · 2024-11-05T23:04:13Z

This PR is (what I think is) the goal.
We can decide if we want to move towards this goal incrementally or deciding that this is what we want and skip all the in-between.

To move incrementally, we'd need to resolve the following PRs:

Which... we can do -- I'm not sure it's worth keeping CI green through all that though. ember-fetch is in a bit of disrepair.

Support:

3.28+ (easily), maybe 3.4+
ember-auto-import @ v2+ or embroider
@ember/test-waiters v3+
any node (node doesn't matter anymore)
continue the renamed-modules support (import from fetch)

I'm not sure what the fastboot support story would be, but Node natively has fetch, AbortController, etc.

Dropped Support:

Configuration: PREFER_NATIVE, NATIVE_PROMISE
jQuery AJAX
You no longer import AbortController. AbortController exists on globalThis
You no longer import Headers. Headers exists on globalThis
You no longer import Response. Response exists on globalThis

Since ember-auto-import tests against 3.4.0, and ember-auto-import is the only real requirement for this change, there is no change in supported ember-source.

If anything, the constraining function is @ember/test-waiters

Changes:

delete the old addon
create new fetch export
copy over old utils as separate exports
- remove './types', because these exist all natively
- remove './utils/determine-body-promise' because it used jQuery AJAX options
- remove './utils/mung-fetch-options' because it used jQuery AJAX options
no build -- folks can just point at git to test this
separate test app
yarn -> pnpm

After this PR:

Add release plan
remove release-it

bertdeblock · 2024-11-06T18:39:53Z

src/utils/serialize-query-params.js

+function isPlainObject(obj) {
+  return Object.prototype.toString.call(obj) === '[object Object]';
+}
+
 /**
 * Helper function that turns the data/body of a request into a query param string.
 * This is directly copied from jQuery.param.


There's also https://github.com/knowledgecode/jquery-param, so wondering if we should still include this in ember-fetch?

NullVoxPopuli · 2024-12-05T21:40:17Z

Todo (RFC):

remove ember-fetch from blueprints
write docs for the guides on "centralized place to manage requests"

Todo (This PR):

waitForPromise around the response.json() and response.body()
get reviewed, merge

esbanarango · 2025-01-07T13:31:52Z

This is great!

I'm getting this TS error trying out this branch:

error TS2307: Cannot find module 'ember-fetch' or its corresponding type declarations.
[lint:glint]   There are types at '/Users/esbanarango/.../node_modules/ember-fetch/src/index.d.ts', but this result could not be resolved under your current 'moduleResolution' setting. Consider updating to 'node16', 'nodenext', or 'bundler'.
[lint:glint] 
[lint:glint] 2 import fetch from 'ember-fetch';

mansona · 2025-01-19T10:41:11Z

src/index.js

+  });
+}
+
+export default wrappedFetch;


I mean why not just add the default to line 3 😂

My brain doesn't like it haha

fivetanley · 2025-04-17T22:32:54Z

src/index.js

+      let original = Reflect.get(target, prop, receiver);
+
+      if (['json', 'text', 'arrayBuffer', 'blob', 'formData'].includes(prop)) {
+        return (...args) => {
+          let parsePromise = original(...args);
+
+          return waitForPromise(parsePromise);
+        };
+      }


This didn't work in Safari for our application. It turns out that's because some properties use "internal slots" for property access, so you have to wrangle the this value to be the right thing. I lifted the implementation from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy#no_private_property_forwarding

Suggested change

let original = Reflect.get(target, prop, receiver);

if (['json', 'text', 'arrayBuffer', 'blob', 'formData'].includes(prop)) {

return (...args) => {

let parsePromise = original(...args);

return waitForPromise(parsePromise);

};

}

let original = target[prop];

if (typeof original === 'function') {

return function (...args) {

let maybePromise = original.apply(this === receiver ? target : this, args);

// only wait for promise if it is a promise

if (maybePromise && typeof maybePromise.then === 'function') {

return waitForPromise(maybePromise);

}

return maybePromise;

};

}

Since there are other properties like toString etc which can get accessed, I made it only waitForPromise if we have a promise-like return value as well.

The conditional use of waitForPromise makes it so it only gets called on promises. if waitForPromise is called with a non-promise, it seems to error and hang the test suite with a waiter that never resolves.

rfc has it as

let parsePromise = original.call(target, ...args);

which I've successfully used

NullVoxPopuli · 2025-04-18T21:02:00Z

The RFC landed on

https://github.com/emberjs/ember-test-waiters/blob/master/addon/src/wait-for-fetch.ts

So I'm going to close this and open a deprecation pr on the readme of ember fetch

NullVoxPopuli added 2 commits November 5, 2024 17:47

Just wrap fetch

4f8c508

Delete most of the old ember-fetch, show an ideal new version

3f7b708

NullVoxPopuli added the breaking label Nov 5, 2024

NullVoxPopuli added 21 commits November 5, 2024 18:22

Add test-app

061807b

Move old tests into the test-app

43412c3

Move old tests into the test-app

33f69b5

Fix workflow

a3cbc17

Add errors and serialize-query-params

5b91d51

Delete the code that was in the dummy app, it was toooo deprecated

545e53b

Delete tests for deleted utils

3edf034

Remove ember-data

b9e4556

Don't import AbortController

689dc9e

Update tests

33a9273

Remove pretender and related testing

56ef4a9

Don't block tests on lints

511b800

Don't block tests on lints

c0cd6f7

Re-add the ember-try config

b888455

Delete dummy app

8b464af

Tell emebr-try to usePnpm

e62bd5d

Lint:Fix the serialize query params test

dd0c220

Delete AbortController test, we don't need to test built ins

4554211

Set the ember-cli versions for older ember

de60890

Set the ember-cli versions for older ember

2560847

Update ember-try for 3.28

e87fe0a

NullVoxPopuli marked this pull request as ready for review November 6, 2024 16:20

bertdeblock reviewed Nov 6, 2024

View reviewed changes

Update index.js

4d1da70

Update implementation based on RFC emberjs/rfcs#1065

47726be

ope, lints

7abae8f

NullVoxPopuli mentioned this pull request Jan 18, 2025

Deprecate ember-fetch emberjs/rfcs#1065

Merged

11 tasks

mansona reviewed Jan 19, 2025

View reviewed changes

fivetanley reviewed Apr 17, 2025

View reviewed changes

NullVoxPopuli closed this Apr 18, 2025

NullVoxPopuli deleted the v2-addon branch April 18, 2025 21:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert to v2, addon. Just wrap `fetch`. #754

Convert to v2, addon. Just wrap `fetch`. #754

NullVoxPopuli commented Nov 5, 2024 •

edited

Loading

bertdeblock Nov 6, 2024

NullVoxPopuli commented Dec 5, 2024 •

edited

Loading

esbanarango commented Jan 7, 2025 •

edited

Loading

mansona Jan 19, 2025

NullVoxPopuli Jan 19, 2025

fivetanley Apr 17, 2025

fivetanley Apr 17, 2025

void-mAlex Apr 18, 2025

NullVoxPopuli commented Apr 18, 2025

-      let original = Reflect.get(target, prop, receiver);
-      if (['json', 'text', 'arrayBuffer', 'blob', 'formData'].includes(prop)) {
-        return (...args) => {
-          let parsePromise = original(...args);
-          return waitForPromise(parsePromise);
-        };
-      }
+      let original = target[prop];
+      if (typeof original === 'function') {
+        return function (...args) {
+          let maybePromise = original.apply(this === receiver ? target : this, args);
+          // only wait for promise if it is a promise
+          if (maybePromise && typeof maybePromise.then === 'function') {
+            return waitForPromise(maybePromise);
+          }
+          return maybePromise;
+        };
+      }

Convert to v2, addon. Just wrap fetch. #754

Convert to v2, addon. Just wrap fetch. #754

Conversation

NullVoxPopuli commented Nov 5, 2024 • edited Loading

bertdeblock Nov 6, 2024

Choose a reason for hiding this comment

NullVoxPopuli commented Dec 5, 2024 • edited Loading

esbanarango commented Jan 7, 2025 • edited Loading

mansona Jan 19, 2025

Choose a reason for hiding this comment

NullVoxPopuli Jan 19, 2025

Choose a reason for hiding this comment

fivetanley Apr 17, 2025

Choose a reason for hiding this comment

fivetanley Apr 17, 2025

Choose a reason for hiding this comment

void-mAlex Apr 18, 2025

Choose a reason for hiding this comment

NullVoxPopuli commented Apr 18, 2025

Convert to v2, addon. Just wrap `fetch`. #754

Convert to v2, addon. Just wrap `fetch`. #754

NullVoxPopuli commented Nov 5, 2024 •

edited

Loading

NullVoxPopuli commented Dec 5, 2024 •

edited

Loading

esbanarango commented Jan 7, 2025 •

edited

Loading