Skip to content

Commit 2209131

Browse files
Zahan MalkaniFacebook Github Bot 7
Zahan Malkani
authored and
Facebook Github Bot 7
committed
Introduce custom asset resolver to resolveAssetSource(..)
Reviewed By: frantic Differential Revision: D2989112 fb-gh-sync-id: a678d091aeb6904448c890653f57dd7944ce95c3 shipit-source-id: a678d091aeb6904448c890653f57dd7944ce95c3
1 parent a97127b commit 2209131

File tree

3 files changed

+248
-97
lines changed

3 files changed

+248
-97
lines changed

‎Libraries/Image/AssetSourceResolver.js

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
/**
2+
* Copyright (c) 2015-present, Facebook, Inc.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree. An additional grant
7+
* of patent rights can be found in the PATENTS file in the same directory.
8+
*
9+
* @providesModule AssetSourceResolver
10+
* @flow
11+
*/
12+
13+
export type ResolvedAssetSource = {
14+
__packager_asset: boolean,
15+
width: number,
16+
height: number,
17+
uri: string,
18+
scale: number,
19+
};
20+
21+
import type { PackagerAsset } from 'AssetRegistry';
22+
23+
const PixelRatio = require('PixelRatio');
24+
const Platform = require('Platform');
25+
26+
const assetPathUtils = require('../../local-cli/bundle/assetPathUtils');
27+
const invariant = require('invariant');
28+
29+
/**
30+
* Returns a path like 'assets/AwesomeModule/icon@2x.png'
31+
*/
32+
function getScaledAssetPath(asset): string {
33+
var scale = AssetSourceResolver.pickScale(asset.scales, PixelRatio.get());
34+
var scaleSuffix = scale === 1 ? '' : '@' + scale + 'x';
35+
var assetDir = assetPathUtils.getBasePath(asset);
36+
return assetDir + '/' + asset.name + scaleSuffix + '.' + asset.type;
37+
}
38+
39+
/**
40+
* Returns a path like 'drawable-mdpi/icon.png'
41+
*/
42+
function getAssetPathInDrawableFolder(asset): string {
43+
var scale = AssetSourceResolver.pickScale(asset.scales, PixelRatio.get());
44+
var drawbleFolder = assetPathUtils.getAndroidDrawableFolderName(asset, scale);
45+
var fileName = assetPathUtils.getAndroidResourceIdentifier(asset);
46+
return drawbleFolder + '/' + fileName + '.' + asset.type;
47+
}
48+
49+
class AssetSourceResolver {
50+
51+
serverUrl: ?string;
52+
// where the bundle is being run from
53+
bundlePath: ?string;
54+
// the asset to resolve
55+
asset: PackagerAsset;
56+
57+
constructor(serverUrl: ?string, bundlePath: ?string, asset: PackagerAsset) {
58+
this.serverUrl = serverUrl;
59+
this.bundlePath = bundlePath;
60+
this.asset = asset;
61+
}
62+
63+
isLoadedFromServer(): boolean {
64+
return !!this.serverUrl;
65+
}
66+
67+
isLoadedFromFileSystem(): boolean {
68+
return !!this.bundlePath;
69+
}
70+
71+
defaultAsset(): ResolvedAssetSource {
72+
if (this.isLoadedFromServer()) {
73+
return this.assetServerURL();
74+
}
75+
76+
if (Platform.OS === 'android') {
77+
return this.isLoadedFromFileSystem() ?
78+
this.drawableFolderInBundle() :
79+
this.resourceIdentifierWithoutScale();
80+
} else {
81+
return this.scaledAssetPathInBundle();
82+
}
83+
}
84+
85+
/**
86+
* Returns an absolute URL which can be used to fetch the asset
87+
* from the devserver
88+
*/
89+
assetServerURL(): ResolvedAssetSource {
90+
invariant(!!this.serverUrl, 'need server to load from');
91+
return this.fromSource(
92+
this.serverUrl + getScaledAssetPath(this.asset) +
93+
'?platform=' + Platform.OS + '&hash=' + this.asset.hash
94+
);
95+
}
96+
97+
/**
98+
* Resolves to just the scaled asset filename
99+
* E.g. 'assets/AwesomeModule/icon@2x.png'
100+
*/
101+
scaledAssetPath(): ResolvedAssetSource {
102+
return this.fromSource(getScaledAssetPath(this.asset));
103+
}
104+
105+
/**
106+
* Resolves to where the bundle is running from, with a scaled asset filename
107+
* E.g. '/sdcard/bundle/assets/AwesomeModule/icon@2x.png'
108+
*/
109+
scaledAssetPathInBundle(): ResolvedAssetSource {
110+
const path = this.bundlePath || '';
111+
return this.fromSource(path + getScaledAssetPath(this.asset));
112+
}
113+
114+
/**
115+
* The default location of assets bundled with the app, located by
116+
* resource identifier
117+
* The Android resource system picks the correct scale.
118+
* E.g. 'assets_awesomemodule_icon'
119+
*/
120+
resourceIdentifierWithoutScale(): ResolvedAssetSource {
121+
invariant(Platform.OS === 'android', 'resource identifiers work on Android');
122+
return this.fromSource(assetPathUtils.getAndroidResourceIdentifier(this.asset));
123+
}
124+
125+
/**
126+
* If the jsbundle is running from a sideload location, this resolves assets
127+
* relative to its location
128+
* E.g. 'file:///sdcard/AwesomeModule/drawable-mdpi/icon.png'
129+
*/
130+
drawableFolderInBundle(): ResolvedAssetSource {
131+
const path = this.bundlePath || '';
132+
return this.fromSource(
133+
'file://' + path + getAssetPathInDrawableFolder(this.asset)
134+
);
135+
}
136+
137+
fromSource(source: string): ResolvedAssetSource {
138+
return {
139+
__packager_asset: true,
140+
width: this.asset.width,
141+
height: this.asset.height,
142+
uri: source,
143+
scale: AssetSourceResolver.pickScale(this.asset.scales, PixelRatio.get()),
144+
};
145+
}
146+
147+
static pickScale(scales: Array<number>, deviceScale: number): number {
148+
// Packager guarantees that `scales` array is sorted
149+
for (var i = 0; i < scales.length; i++) {
150+
if (scales[i] >= deviceScale) {
151+
return scales[i];
152+
}
153+
}
154+
155+
// If nothing matches, device scale is larger than any available
156+
// scales, so we return the biggest one. Unless the array is empty,
157+
// in which case we default to 1
158+
return scales[scales.length - 1] || 1;
159+
}
160+
161+
}
162+
163+
module.exports = AssetSourceResolver;

‎Libraries/Image/__tests__/resolveAssetSource-test.js

+55
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
jest
1212
.dontMock('AssetRegistry')
13+
.dontMock('AssetSourceResolver')
1314
.dontMock('../resolveAssetSource')
1415
.dontMock('../../../local-cli/bundle/assetPathUtils');
1516

@@ -217,6 +218,60 @@ describe('resolveAssetSource', () => {
217218
});
218219
});
219220

221+
describe('source resolver can be customized', () => {
222+
beforeEach(() => {
223+
NativeModules.SourceCode.scriptURL =
224+
'file:///sdcard/Path/To/Simulator/main.bundle';
225+
Platform.OS = 'android';
226+
});
227+
228+
it('uses bundled source, event when js is sideloaded', () => {
229+
resolveAssetSource.setCustomSourceTransformer(
230+
(resolver) => resolver.resourceIdentifierWithoutScale(),
231+
);
232+
expectResolvesAsset({
233+
__packager_asset: true,
234+
fileSystemLocation: '/root/app/module/a',
235+
httpServerLocation: '/assets/AwesomeModule/Subdir',
236+
width: 100,
237+
height: 200,
238+
scales: [1],
239+
hash: '5b6f00f',
240+
name: '!@Logo#1_€',
241+
type: 'png',
242+
}, {
243+
__packager_asset: true,
244+
width: 100,
245+
height: 200,
246+
uri: 'awesomemodule_subdir_logo1_',
247+
scale: 1,
248+
});
249+
});
250+
251+
it('allows any customization', () => {
252+
resolveAssetSource.setCustomSourceTransformer(
253+
(resolver) => resolver.fromSource('TEST')
254+
);
255+
expectResolvesAsset({
256+
__packager_asset: true,
257+
fileSystemLocation: '/root/app/module/a',
258+
httpServerLocation: '/assets/AwesomeModule/Subdir',
259+
width: 100,
260+
height: 200,
261+
scales: [1],
262+
hash: '5b6f00f',
263+
name: '!@Logo#1_€',
264+
type: 'png',
265+
}, {
266+
__packager_asset: true,
267+
width: 100,
268+
height: 200,
269+
uri: 'TEST',
270+
scale: 1,
271+
});
272+
});
273+
});
274+
220275
});
221276

222277
describe('resolveAssetSource.pickScale', () => {

0 commit comments

Comments
 (0)