Skip to content
This repository was archived by the owner on Feb 26, 2024. It is now read-only.

Commit 8ee88da

Browse files
JiaLiPassionmhevery
authored andcommitted
feat(patch): fix #1011, patch ResizeObserver (#1012)
1 parent 6b6b38a commit 8ee88da

File tree

5 files changed

+168
-2
lines changed

5 files changed

+168
-2
lines changed

Diff for: NON-STANDARD-APIS.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ In electron, we patched the following APIs with `zone.js`
170170

171171
## Usage.
172172

173-
add/update following line into `polyfill.ts`.
173+
add following line into `polyfill.ts` after loading zone-mix.
174174

175175
```
176176
//import 'zone.js/dist/zone'; // originally added by angular-cli, comment it out
@@ -194,7 +194,6 @@ user need to patch `io` themselves just like following code.
194194
</script>
195195
```
196196

197-
198197
please reference the sample repo [zone-socketio](https://github.com/JiaLiPassion/zone-socketio) about
199198
detail usage.
200199

@@ -217,3 +216,14 @@ Zone['__zone_symbol__jsonp']({
217216
failedFuncName: 'jsonpFailedCallback'
218217
});
219218
```
219+
* ResizeObserver
220+
221+
Currently only `Chrome 64` native support this feature.
222+
you can add the following line into `polyfill.ts` after loading `zone.js`.
223+
224+
```
225+
import 'zone.js/dist/zone';
226+
import 'zone.js/dist/zone-patch-resize-observer';
227+
```
228+
229+
there is a sample repo [zone-resize-observer](https://github.com/JiaLiPassion/zone-resize-observer) here

Diff for: gulpfile.js

+10
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,14 @@ gulp.task('build/zone-patch-promise-testing.min.js', ['compile-esm'], function(c
228228
return generateScript('./lib/testing/promise-testing.ts', 'zone-patch-promise-test.min.js', true, cb);
229229
});
230230

231+
gulp.task('build/zone-patch-resize-observer.js', ['compile-esm'], function(cb) {
232+
return generateScript('./lib/browser/webapis-resize-observer.ts', 'zone-patch-resize-observer.js', false, cb);
233+
});
234+
235+
gulp.task('build/zone-patch-resize-observer.min.js', ['compile-esm'], function(cb) {
236+
return generateScript('./lib/browser/webapis-resize-observer.ts', 'zone-patch-resize-observer.min.js', true, cb);
237+
});
238+
231239
gulp.task('build/bluebird.js', ['compile-esm'], function(cb) {
232240
return generateScript('./lib/extra/bluebird.ts', 'zone-bluebird.js', false, cb);
233241
});
@@ -354,6 +362,8 @@ gulp.task('build', [
354362
'build/zone-patch-socket-io.min.js',
355363
'build/zone-patch-promise-testing.js',
356364
'build/zone-patch-promise-testing.min.js',
365+
'build/zone-patch-resize-observer.js',
366+
'build/zone-patch-resize-observer.min.js',
357367
'build/zone-mix.js',
358368
'build/bluebird.js',
359369
'build/bluebird.min.js',

Diff for: lib/browser/webapis-resize-observer.ts

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
/**
2+
* @license
3+
* Copyright Google Inc. All Rights Reserved.
4+
*
5+
* Use of this source code is governed by an MIT-style license that can be
6+
* found in the LICENSE file at https://angular.io/license
7+
*/
8+
Zone.__load_patch('ResizeObserver', (global: any, Zone: any, api: _ZonePrivate) => {
9+
const ResizeObserver = global['ResizeObserver'];
10+
if (!ResizeObserver) {
11+
return;
12+
}
13+
14+
const resizeObserverSymbol = api.symbol('ResizeObserver');
15+
16+
api.patchMethod(global, 'ResizeObserver', (delegate: Function) => (self: any, args: any[]) => {
17+
const callback = args.length > 0 ? args[0] : null;
18+
if (callback) {
19+
args[0] = function(entries: any, observer: any) {
20+
const zones: {[zoneName: string]: any} = {};
21+
const currZone = Zone.current;
22+
for (let entry of entries) {
23+
let zone = entry.target[resizeObserverSymbol];
24+
if (!zone) {
25+
zone = currZone;
26+
}
27+
let zoneEntriesInfo = zones[zone.name];
28+
if (!zoneEntriesInfo) {
29+
zones[zone.name] = zoneEntriesInfo = {entries: [], zone: zone};
30+
}
31+
zoneEntriesInfo.entries.push(entry);
32+
}
33+
34+
Object.keys(zones).forEach(zoneName => {
35+
const zoneEntriesInfo = zones[zoneName];
36+
if (zoneEntriesInfo.zone !== Zone.current) {
37+
zoneEntriesInfo.zone.run(
38+
callback, this, [zoneEntriesInfo.entries, observer], 'ResizeObserver');
39+
} else {
40+
callback.call(this, zoneEntriesInfo.entries, observer);
41+
}
42+
});
43+
};
44+
}
45+
return args.length > 0 ? new ResizeObserver(args[0]) : new ResizeObserver();
46+
});
47+
48+
api.patchMethod(ResizeObserver.prototype, 'observe', (delegate: Function) => (self: any, args: any[]) => {
49+
const target = args.length > 0 ? args[0] : null;
50+
if (!target) {
51+
return delegate.apply(self, args);
52+
}
53+
let targets = self[resizeObserverSymbol];
54+
if (!targets) {
55+
targets = self[resizeObserverSymbol] = [];
56+
}
57+
targets.push(target);
58+
target[resizeObserverSymbol] = Zone.current;
59+
return delegate.apply(self, args);
60+
});
61+
62+
api.patchMethod(ResizeObserver.prototype, 'unobserve', (delegate: Function) => (self: any, args: any[]) => {
63+
const target = args.length > 0 ? args[0] : null;
64+
if (!target) {
65+
return delegate.apply(self, args);
66+
}
67+
let targets = self[resizeObserverSymbol];
68+
if (targets) {
69+
for (let i = 0; i < targets.length; i ++) {
70+
if (targets[i] === target) {
71+
targets.splice(i, 1);
72+
break;
73+
}
74+
}
75+
}
76+
target[resizeObserverSymbol] = undefined;
77+
return delegate.apply(self, args);
78+
});
79+
80+
api.patchMethod(ResizeObserver.prototype, 'disconnect', (delegate: Function) => (self: any, args: any[]) => {
81+
const targets = self[resizeObserverSymbol];
82+
if (targets) {
83+
targets.forEach((target: any) => {target[resizeObserverSymbol] = undefined;});
84+
self[resizeObserverSymbol] = undefined;
85+
}
86+
return delegate.apply(self, args);
87+
});
88+
});

Diff for: test/browser-zone-setup.ts

+1
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@ import '../lib/zone-spec/task-tracking';
2020
import '../lib/zone-spec/wtf';
2121
import '../lib/extra/cordova';
2222
import '../lib/testing/promise-testing';
23+
import '../lib/browser/webapis-resize-observer';

Diff for: test/browser/browser.spec.ts

+57
Original file line numberDiff line numberDiff line change
@@ -2470,6 +2470,62 @@ describe('Zone', function() {
24702470
});
24712471
}));
24722472

2473+
describe('ResizeObserver', ifEnvSupports('ResizeObserver', () => {
2474+
it('ResizeObserver callback should be in zone', (done) => {
2475+
const ResizeObserver = (window as any)['ResizeObserver'];
2476+
const div = document.createElement('div');
2477+
const zone = Zone.current.fork({
2478+
name: 'observer'
2479+
});
2480+
const observer = new ResizeObserver((entries: any, ob: any) => {
2481+
expect(Zone.current.name).toEqual(zone.name);
2482+
2483+
expect(entries.length).toBe(1);
2484+
expect(entries[0].target).toBe(div);
2485+
done();
2486+
});
2487+
2488+
zone.run(() => {
2489+
observer.observe(div);
2490+
});
2491+
2492+
document.body.appendChild(div);
2493+
});
2494+
2495+
it('ResizeObserver callback should be able to in different zones which when they were observed', (done) => {
2496+
const ResizeObserver = (window as any)['ResizeObserver'];
2497+
const div1 = document.createElement('div');
2498+
const div2 = document.createElement('div');
2499+
const zone = Zone.current.fork({
2500+
name: 'observer'
2501+
});
2502+
let count = 0;
2503+
const observer = new ResizeObserver((entries: any, ob: any) => {
2504+
entries.forEach((entry: any) => {
2505+
if (entry.target === div1) {
2506+
expect(Zone.current.name).toEqual(zone.name);
2507+
} else {
2508+
expect(Zone.current.name).toEqual('<root>');
2509+
}
2510+
});
2511+
count ++;
2512+
if (count === 2) {
2513+
done();
2514+
}
2515+
});
2516+
2517+
zone.run(() => {
2518+
observer.observe(div1);
2519+
});
2520+
Zone.root.run(() => {
2521+
observer.observe(div2);
2522+
});
2523+
2524+
document.body.appendChild(div1);
2525+
document.body.appendChild(div2);
2526+
});
2527+
}));
2528+
24732529
xdescribe('getUserMedia', () => {
24742530
it('navigator.mediaDevices.getUserMedia should in zone',
24752531
ifEnvSupportsWithDone(
@@ -2516,6 +2572,7 @@ describe('Zone', function() {
25162572
});
25172573
});
25182574
}));
2575+
25192576
});
25202577
});
25212578
});

0 commit comments

Comments
 (0)