Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/assets/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
# Dependencies
/node_modules

# Build output
/dist
16 changes: 13 additions & 3 deletions packages/assets/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,17 @@
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/assets#readme",
"keywords": ["assets", "registry", "react-native", "support"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=18"
}
"exports": {
"./path-support": "./src/path-support.js",
"./path-support.js": "./src/path-support.js",
"./registry": "./src/registry.js",
"./registry.js": "./src/registry.js",
"./package.json": "./package.json"
},
"files": [
"dist",
"path-support.js",
"registry.js",
"src"
Comment on lines +22 to +25

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"dist",
"path-support.js",
"registry.js",
"src"
"dist",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion still applies — all other files do not need to be packaged, but are instead present at dev-time.

]
}
85 changes: 3 additions & 82 deletions packages/assets/path-support.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,89 +4,10 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
* @format strict
* @flow
Comment on lines +7 to +8

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this line was accidentally rearranged first!

Also, feel free to use strict-local everywhere, it's slightly more forgiving.

Suggested change
* @formatstrict
* @flow
* @flowstrict-local
* @format

*/

'use strict';

import type {PackagerAsset} from './registry.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}

module.exports = {
getAndroidResourceFolderName,
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');
Comment thread
huntie marked this conversation as resolved.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To enable running from source, let's add babel-register wrapper files for these two entry points. And yeah, actually that means keeping these files around (for Flow's type checker, which sadly doesn't follow "exports").

You can find an example of this pattern in packages/dev-middleware/: https://github.com/facebook/react-native/blob/main/packages/dev-middleware/src/index.js.

And the file structure you'll need:

assets
├── path-support.js.flow # (Flow only) Re-export all types and values
├── registry.js.flow
└── src
├── path-support.js # Entry point - babel-register
├── path-support.flow.js # Implementation
├── registry.js
└── registry.flow.js

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I didn't quite understand what those files were. Makes sense now!

@tido64tido64Sep 14, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So… it looks like flow-check is unable to find .js.flow files. I had to rename them back to .js and fix a bunch of Dependencies of a @flow strict module must also be @flow strict! errors. The check seems to pass locally now.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this pattern works. babel-register cannot be found when the package is consumed outside the repository. Do you have any suggestions for how to address this?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

babel-register cannot be foundwhen the package is consumed outside the repository.

Do you mean you have a setup where another project is consuming a local checkout of the react-native repository from source (e.g. via yarn link)?

This should work. Happy to debug via chat.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
module.exports=require('./src/path-support');
export*from'./src/path-support';

27 changes: 1 addition & 26 deletions packages/assets/registry.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,29 +10,4 @@

'use strict';

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}

module.exports = {registerAsset, getAssetByID};
module.exports = require('./src/registry.flow');
Comment on lines 11 to +13

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'use strict';
exporttypePackagerAsset={
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};
constassets: Array<PackagerAsset> = [];
functionregisterAsset(asset: PackagerAsset): number{
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
returnassets.push(asset);
}
functiongetAssetByID(assetId: number): PackagerAsset{
returnassets[assetId-1];
}
module.exports={registerAsset, getAssetByID};
module.exports=require('./src/registry.flow');
export*from'./src/registry.flow';

84 changes: 84 additions & 0 deletions packages/assets/src/path-support.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
*/

import type {PackagerAsset} from './registry.flow.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

export function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

export function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

export function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}
20 changes: 20 additions & 0 deletions packages/assets/src/path-support.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './path-support.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './path-support.flow';
34 changes: 34 additions & 0 deletions packages/assets/src/registry.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict
* @format
*/

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

export function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

export function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}
20 changes: 20 additions & 0 deletions packages/assets/src/registry.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './registry.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './registry.flow';
1 change: 1 addition & 0 deletions packages/rn-tester/metro.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ const config = {
// Make Metro able to resolve required external dependencies
watchFolders: [
path.resolve(__dirname, '../../node_modules'),
path.resolve(__dirname, '../../scripts/build'), // babel-register.js

@huntiehuntieSep 15, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, @react-native/asset-registry is not a Node package — it's consumed by runtime code in packages/react-native/Libraries/!

This probably means we don't need the babel-register setup at all (just the root .js.flow files redirecting to src/) — since all modules loaded by React Native go through @react-native/babel-preset. This setup is just for run-from-source behaviour within the React Native monorepo.

Back to the PR summary:

Transpile assets-registry so it can be consumed outside of a React Native bundle:

This is technically new ground. I think we want to define a new build target of 'react-native'/'react-native-and-external' in scripts/build/config.js, configuring this to build files using @react-native/babel-preset as its Babel config. Will reach out via DM.

path.resolve(__dirname, '../assets'),
path.resolve(__dirname, '../community-cli-plugin'),
path.resolve(__dirname, '../dev-middleware'),
Expand Down
4 changes: 4 additions & 0 deletions scripts/build/config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,10 @@ export type BuildConfig = $ReadOnly<{
*/
const buildConfig /*: BuildConfig */ = {
packages: {
assets: {
target: 'node',
emitTypeScriptDefs: true,
},
'community-cli-plugin': {
target: 'node',
},
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/assets/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
# Dependencies
/node_modules

# Build output
/dist
16 changes: 13 additions & 3 deletions packages/assets/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,17 @@
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/assets#readme",
"keywords": ["assets", "registry", "react-native", "support"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=18"
}
"exports": {
"./path-support": "./src/path-support.js",
"./path-support.js": "./src/path-support.js",
"./registry": "./src/registry.js",
"./registry.js": "./src/registry.js",
"./package.json": "./package.json"
},
"files": [
"dist",
"path-support.js",
"registry.js",
"src"
Comment on lines +22 to +25

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"dist",
"path-support.js",
"registry.js",
"src"
"dist",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion still applies — all other files do not need to be packaged, but are instead present at dev-time.

]
}
85 changes: 3 additions & 82 deletions packages/assets/path-support.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,89 +4,10 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
* @format strict
* @flow
Comment on lines +7 to +8

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this line was accidentally rearranged first!

Also, feel free to use strict-local everywhere, it's slightly more forgiving.

Suggested change
* @formatstrict
* @flow
* @flowstrict-local
* @format

*/

'use strict';

import type {PackagerAsset} from './registry.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}

module.exports = {
getAndroidResourceFolderName,
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');
Comment thread
huntie marked this conversation as resolved.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To enable running from source, let's add babel-register wrapper files for these two entry points. And yeah, actually that means keeping these files around (for Flow's type checker, which sadly doesn't follow "exports").

You can find an example of this pattern in packages/dev-middleware/: https://github.com/facebook/react-native/blob/main/packages/dev-middleware/src/index.js.

And the file structure you'll need:

assets
├── path-support.js.flow # (Flow only) Re-export all types and values
├── registry.js.flow
└── src
├── path-support.js # Entry point - babel-register
├── path-support.flow.js # Implementation
├── registry.js
└── registry.flow.js

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I didn't quite understand what those files were. Makes sense now!

@tido64tido64Sep 14, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So… it looks like flow-check is unable to find .js.flow files. I had to rename them back to .js and fix a bunch of Dependencies of a @flow strict module must also be @flow strict! errors. The check seems to pass locally now.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this pattern works. babel-register cannot be found when the package is consumed outside the repository. Do you have any suggestions for how to address this?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

babel-register cannot be foundwhen the package is consumed outside the repository.

Do you mean you have a setup where another project is consuming a local checkout of the react-native repository from source (e.g. via yarn link)?

This should work. Happy to debug via chat.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
module.exports=require('./src/path-support');
export*from'./src/path-support';

27 changes: 1 addition & 26 deletions packages/assets/registry.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,29 +10,4 @@

'use strict';

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}

module.exports = {registerAsset, getAssetByID};
module.exports = require('./src/registry.flow');
Comment on lines 11 to +13

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'use strict';
exporttypePackagerAsset={
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};
constassets: Array<PackagerAsset> = [];
functionregisterAsset(asset: PackagerAsset): number{
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
returnassets.push(asset);
}
functiongetAssetByID(assetId: number): PackagerAsset{
returnassets[assetId-1];
}
module.exports={registerAsset, getAssetByID};
module.exports=require('./src/registry.flow');
export*from'./src/registry.flow';

84 changes: 84 additions & 0 deletions packages/assets/src/path-support.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
*/

import type {PackagerAsset} from './registry.flow.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

export function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

export function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

export function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}
20 changes: 20 additions & 0 deletions packages/assets/src/path-support.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './path-support.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './path-support.flow';
34 changes: 34 additions & 0 deletions packages/assets/src/registry.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict
* @format
*/

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

export function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

export function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}
20 changes: 20 additions & 0 deletions packages/assets/src/registry.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './registry.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './registry.flow';
1 change: 1 addition & 0 deletions packages/rn-tester/metro.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ const config = {
// Make Metro able to resolve required external dependencies
watchFolders: [
path.resolve(__dirname, '../../node_modules'),
path.resolve(__dirname, '../../scripts/build'), // babel-register.js

@huntiehuntieSep 15, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, @react-native/asset-registry is not a Node package — it's consumed by runtime code in packages/react-native/Libraries/!

This probably means we don't need the babel-register setup at all (just the root .js.flow files redirecting to src/) — since all modules loaded by React Native go through @react-native/babel-preset. This setup is just for run-from-source behaviour within the React Native monorepo.

Back to the PR summary:

Transpile assets-registry so it can be consumed outside of a React Native bundle:

This is technically new ground. I think we want to define a new build target of 'react-native'/'react-native-and-external' in scripts/build/config.js, configuring this to build files using @react-native/babel-preset as its Babel config. Will reach out via DM.

path.resolve(__dirname, '../assets'),
path.resolve(__dirname, '../community-cli-plugin'),
path.resolve(__dirname, '../dev-middleware'),
Expand Down
4 changes: 4 additions & 0 deletions scripts/build/config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,10 @@ export type BuildConfig = $ReadOnly<{
*/
const buildConfig /*: BuildConfig */ = {
packages: {
assets: {
target: 'node',
emitTypeScriptDefs: true,
},
'community-cli-plugin': {
target: 'node',
},
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/assets/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
# Dependencies
/node_modules

# Build output
/dist
16 changes: 13 additions & 3 deletions packages/assets/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,17 @@
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/assets#readme",
"keywords": ["assets", "registry", "react-native", "support"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=18"
}
"exports": {
"./path-support": "./src/path-support.js",
"./path-support.js": "./src/path-support.js",
"./registry": "./src/registry.js",
"./registry.js": "./src/registry.js",
"./package.json": "./package.json"
},
"files": [
"dist",
"path-support.js",
"registry.js",
"src"
Comment on lines +22 to +25

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"dist",
"path-support.js",
"registry.js",
"src"
"dist",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion still applies — all other files do not need to be packaged, but are instead present at dev-time.

]
}
85 changes: 3 additions & 82 deletions packages/assets/path-support.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,89 +4,10 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
* @format strict
* @flow
Comment on lines +7 to +8

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this line was accidentally rearranged first!

Also, feel free to use strict-local everywhere, it's slightly more forgiving.

Suggested change
* @formatstrict
* @flow
* @flowstrict-local
* @format

*/

'use strict';

import type {PackagerAsset} from './registry.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}

module.exports = {
getAndroidResourceFolderName,
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');
Comment thread
huntie marked this conversation as resolved.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To enable running from source, let's add babel-register wrapper files for these two entry points. And yeah, actually that means keeping these files around (for Flow's type checker, which sadly doesn't follow "exports").

You can find an example of this pattern in packages/dev-middleware/: https://github.com/facebook/react-native/blob/main/packages/dev-middleware/src/index.js.

And the file structure you'll need:

assets
├── path-support.js.flow # (Flow only) Re-export all types and values
├── registry.js.flow
└── src
├── path-support.js # Entry point - babel-register
├── path-support.flow.js # Implementation
├── registry.js
└── registry.flow.js

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I didn't quite understand what those files were. Makes sense now!

@tido64tido64Sep 14, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So… it looks like flow-check is unable to find .js.flow files. I had to rename them back to .js and fix a bunch of Dependencies of a @flow strict module must also be @flow strict! errors. The check seems to pass locally now.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this pattern works. babel-register cannot be found when the package is consumed outside the repository. Do you have any suggestions for how to address this?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

babel-register cannot be foundwhen the package is consumed outside the repository.

Do you mean you have a setup where another project is consuming a local checkout of the react-native repository from source (e.g. via yarn link)?

This should work. Happy to debug via chat.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
module.exports=require('./src/path-support');
export*from'./src/path-support';

27 changes: 1 addition & 26 deletions packages/assets/registry.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,29 +10,4 @@

'use strict';

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}

module.exports = {registerAsset, getAssetByID};
module.exports = require('./src/registry.flow');
Comment on lines 11 to +13

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'use strict';
exporttypePackagerAsset={
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};
constassets: Array<PackagerAsset> = [];
functionregisterAsset(asset: PackagerAsset): number{
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
returnassets.push(asset);
}
functiongetAssetByID(assetId: number): PackagerAsset{
returnassets[assetId-1];
}
module.exports={registerAsset, getAssetByID};
module.exports=require('./src/registry.flow');
export*from'./src/registry.flow';

84 changes: 84 additions & 0 deletions packages/assets/src/path-support.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
*/

import type {PackagerAsset} from './registry.flow.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

export function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

export function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

export function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}
20 changes: 20 additions & 0 deletions packages/assets/src/path-support.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './path-support.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './path-support.flow';
34 changes: 34 additions & 0 deletions packages/assets/src/registry.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict
* @format
*/

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

export function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

export function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}
20 changes: 20 additions & 0 deletions packages/assets/src/registry.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './registry.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './registry.flow';
1 change: 1 addition & 0 deletions packages/rn-tester/metro.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ const config = {
// Make Metro able to resolve required external dependencies
watchFolders: [
path.resolve(__dirname, '../../node_modules'),
path.resolve(__dirname, '../../scripts/build'), // babel-register.js

@huntiehuntieSep 15, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, @react-native/asset-registry is not a Node package — it's consumed by runtime code in packages/react-native/Libraries/!

This probably means we don't need the babel-register setup at all (just the root .js.flow files redirecting to src/) — since all modules loaded by React Native go through @react-native/babel-preset. This setup is just for run-from-source behaviour within the React Native monorepo.

Back to the PR summary:

Transpile assets-registry so it can be consumed outside of a React Native bundle:

This is technically new ground. I think we want to define a new build target of 'react-native'/'react-native-and-external' in scripts/build/config.js, configuring this to build files using @react-native/babel-preset as its Babel config. Will reach out via DM.

path.resolve(__dirname, '../assets'),
path.resolve(__dirname, '../community-cli-plugin'),
path.resolve(__dirname, '../dev-middleware'),
Expand Down
4 changes: 4 additions & 0 deletions scripts/build/config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,10 @@ export type BuildConfig = $ReadOnly<{
*/
const buildConfig /*: BuildConfig */ = {
packages: {
assets: {
target: 'node',
emitTypeScriptDefs: true,
},
'community-cli-plugin': {
target: 'node',
},
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/assets/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
# Dependencies
/node_modules

# Build output
/dist
16 changes: 13 additions & 3 deletions packages/assets/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,17 @@
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/assets#readme",
"keywords": ["assets", "registry", "react-native", "support"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=18"
}
"exports": {
"./path-support": "./src/path-support.js",
"./path-support.js": "./src/path-support.js",
"./registry": "./src/registry.js",
"./registry.js": "./src/registry.js",
"./package.json": "./package.json"
},
"files": [
"dist",
"path-support.js",
"registry.js",
"src"
Comment on lines +22 to +25

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"dist",
"path-support.js",
"registry.js",
"src"
"dist",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion still applies — all other files do not need to be packaged, but are instead present at dev-time.

]
}
85 changes: 3 additions & 82 deletions packages/assets/path-support.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,89 +4,10 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
* @format strict
* @flow
Comment on lines +7 to +8

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this line was accidentally rearranged first!

Also, feel free to use strict-local everywhere, it's slightly more forgiving.

Suggested change
* @formatstrict
* @flow
* @flowstrict-local
* @format

*/

'use strict';

import type {PackagerAsset} from './registry.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}

module.exports = {
getAndroidResourceFolderName,
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');
Comment thread
huntie marked this conversation as resolved.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To enable running from source, let's add babel-register wrapper files for these two entry points. And yeah, actually that means keeping these files around (for Flow's type checker, which sadly doesn't follow "exports").

You can find an example of this pattern in packages/dev-middleware/: https://github.com/facebook/react-native/blob/main/packages/dev-middleware/src/index.js.

And the file structure you'll need:

assets
├── path-support.js.flow # (Flow only) Re-export all types and values
├── registry.js.flow
└── src
├── path-support.js # Entry point - babel-register
├── path-support.flow.js # Implementation
├── registry.js
└── registry.flow.js

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I didn't quite understand what those files were. Makes sense now!

@tido64tido64Sep 14, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So… it looks like flow-check is unable to find .js.flow files. I had to rename them back to .js and fix a bunch of Dependencies of a @flow strict module must also be @flow strict! errors. The check seems to pass locally now.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this pattern works. babel-register cannot be found when the package is consumed outside the repository. Do you have any suggestions for how to address this?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

babel-register cannot be foundwhen the package is consumed outside the repository.

Do you mean you have a setup where another project is consuming a local checkout of the react-native repository from source (e.g. via yarn link)?

This should work. Happy to debug via chat.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
module.exports=require('./src/path-support');
export*from'./src/path-support';

27 changes: 1 addition & 26 deletions packages/assets/registry.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,29 +10,4 @@

'use strict';

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}

module.exports = {registerAsset, getAssetByID};
module.exports = require('./src/registry.flow');
Comment on lines 11 to +13

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'use strict';
exporttypePackagerAsset={
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};
constassets: Array<PackagerAsset> = [];
functionregisterAsset(asset: PackagerAsset): number{
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
returnassets.push(asset);
}
functiongetAssetByID(assetId: number): PackagerAsset{
returnassets[assetId-1];
}
module.exports={registerAsset, getAssetByID};
module.exports=require('./src/registry.flow');
export*from'./src/registry.flow';

84 changes: 84 additions & 0 deletions packages/assets/src/path-support.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
*/

import type {PackagerAsset} from './registry.flow.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

export function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

export function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

export function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}
20 changes: 20 additions & 0 deletions packages/assets/src/path-support.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './path-support.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './path-support.flow';
34 changes: 34 additions & 0 deletions packages/assets/src/registry.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict
* @format
*/

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

export function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

export function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}
20 changes: 20 additions & 0 deletions packages/assets/src/registry.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './registry.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './registry.flow';
1 change: 1 addition & 0 deletions packages/rn-tester/metro.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ const config = {
// Make Metro able to resolve required external dependencies
watchFolders: [
path.resolve(__dirname, '../../node_modules'),
path.resolve(__dirname, '../../scripts/build'), // babel-register.js

@huntiehuntieSep 15, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, @react-native/asset-registry is not a Node package — it's consumed by runtime code in packages/react-native/Libraries/!

This probably means we don't need the babel-register setup at all (just the root .js.flow files redirecting to src/) — since all modules loaded by React Native go through @react-native/babel-preset. This setup is just for run-from-source behaviour within the React Native monorepo.

Back to the PR summary:

Transpile assets-registry so it can be consumed outside of a React Native bundle:

This is technically new ground. I think we want to define a new build target of 'react-native'/'react-native-and-external' in scripts/build/config.js, configuring this to build files using @react-native/babel-preset as its Babel config. Will reach out via DM.

path.resolve(__dirname, '../assets'),
path.resolve(__dirname, '../community-cli-plugin'),
path.resolve(__dirname, '../dev-middleware'),
Expand Down
4 changes: 4 additions & 0 deletions scripts/build/config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,10 @@ export type BuildConfig = $ReadOnly<{
*/
const buildConfig /*: BuildConfig */ = {
packages: {
assets: {
target: 'node',
emitTypeScriptDefs: true,
},
'community-cli-plugin': {
target: 'node',
},
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/assets/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
# Dependencies
/node_modules

# Build output
/dist
16 changes: 13 additions & 3 deletions packages/assets/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,17 @@
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/assets#readme",
"keywords": ["assets", "registry", "react-native", "support"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=18"
}
"exports": {
"./path-support": "./src/path-support.js",
"./path-support.js": "./src/path-support.js",
"./registry": "./src/registry.js",
"./registry.js": "./src/registry.js",
"./package.json": "./package.json"
},
"files": [
"dist",
"path-support.js",
"registry.js",
"src"
Comment on lines +22 to +25

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"dist",
"path-support.js",
"registry.js",
"src"
"dist",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion still applies — all other files do not need to be packaged, but are instead present at dev-time.

]
}
85 changes: 3 additions & 82 deletions packages/assets/path-support.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,89 +4,10 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
* @format strict
* @flow
Comment on lines +7 to +8

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this line was accidentally rearranged first!

Also, feel free to use strict-local everywhere, it's slightly more forgiving.

Suggested change
* @formatstrict
* @flow
* @flowstrict-local
* @format

*/

'use strict';

import type {PackagerAsset} from './registry.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}

module.exports = {
getAndroidResourceFolderName,
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');
Comment thread
huntie marked this conversation as resolved.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To enable running from source, let's add babel-register wrapper files for these two entry points. And yeah, actually that means keeping these files around (for Flow's type checker, which sadly doesn't follow "exports").

You can find an example of this pattern in packages/dev-middleware/: https://github.com/facebook/react-native/blob/main/packages/dev-middleware/src/index.js.

And the file structure you'll need:

assets
├── path-support.js.flow # (Flow only) Re-export all types and values
├── registry.js.flow
└── src
├── path-support.js # Entry point - babel-register
├── path-support.flow.js # Implementation
├── registry.js
└── registry.flow.js

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I didn't quite understand what those files were. Makes sense now!

@tido64tido64Sep 14, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So… it looks like flow-check is unable to find .js.flow files. I had to rename them back to .js and fix a bunch of Dependencies of a @flow strict module must also be @flow strict! errors. The check seems to pass locally now.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this pattern works. babel-register cannot be found when the package is consumed outside the repository. Do you have any suggestions for how to address this?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

babel-register cannot be foundwhen the package is consumed outside the repository.

Do you mean you have a setup where another project is consuming a local checkout of the react-native repository from source (e.g. via yarn link)?

This should work. Happy to debug via chat.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
module.exports=require('./src/path-support');
export*from'./src/path-support';

27 changes: 1 addition & 26 deletions packages/assets/registry.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,29 +10,4 @@

'use strict';

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}

module.exports = {registerAsset, getAssetByID};
module.exports = require('./src/registry.flow');
Comment on lines 11 to +13

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'use strict';
exporttypePackagerAsset={
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};
constassets: Array<PackagerAsset> = [];
functionregisterAsset(asset: PackagerAsset): number{
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
returnassets.push(asset);
}
functiongetAssetByID(assetId: number): PackagerAsset{
returnassets[assetId-1];
}
module.exports={registerAsset, getAssetByID};
module.exports=require('./src/registry.flow');
export*from'./src/registry.flow';

84 changes: 84 additions & 0 deletions packages/assets/src/path-support.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
*/

import type {PackagerAsset} from './registry.flow.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

export function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

export function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

export function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}
20 changes: 20 additions & 0 deletions packages/assets/src/path-support.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './path-support.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './path-support.flow';
34 changes: 34 additions & 0 deletions packages/assets/src/registry.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict
* @format
*/

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

export function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

export function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}
20 changes: 20 additions & 0 deletions packages/assets/src/registry.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './registry.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './registry.flow';
1 change: 1 addition & 0 deletions packages/rn-tester/metro.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ const config = {
// Make Metro able to resolve required external dependencies
watchFolders: [
path.resolve(__dirname, '../../node_modules'),
path.resolve(__dirname, '../../scripts/build'), // babel-register.js

@huntiehuntieSep 15, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, @react-native/asset-registry is not a Node package — it's consumed by runtime code in packages/react-native/Libraries/!

This probably means we don't need the babel-register setup at all (just the root .js.flow files redirecting to src/) — since all modules loaded by React Native go through @react-native/babel-preset. This setup is just for run-from-source behaviour within the React Native monorepo.

Back to the PR summary:

Transpile assets-registry so it can be consumed outside of a React Native bundle:

This is technically new ground. I think we want to define a new build target of 'react-native'/'react-native-and-external' in scripts/build/config.js, configuring this to build files using @react-native/babel-preset as its Babel config. Will reach out via DM.

path.resolve(__dirname, '../assets'),
path.resolve(__dirname, '../community-cli-plugin'),
path.resolve(__dirname, '../dev-middleware'),
Expand Down
4 changes: 4 additions & 0 deletions scripts/build/config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,10 @@ export type BuildConfig = $ReadOnly<{
*/
const buildConfig /*: BuildConfig */ = {
packages: {
assets: {
target: 'node',
emitTypeScriptDefs: true,
},
'community-cli-plugin': {
target: 'node',
},
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/assets/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
# Dependencies
/node_modules

# Build output
/dist
16 changes: 13 additions & 3 deletions packages/assets/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,17 @@
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/assets#readme",
"keywords": ["assets", "registry", "react-native", "support"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=18"
}
"exports": {
"./path-support": "./src/path-support.js",
"./path-support.js": "./src/path-support.js",
"./registry": "./src/registry.js",
"./registry.js": "./src/registry.js",
"./package.json": "./package.json"
},
"files": [
"dist",
"path-support.js",
"registry.js",
"src"
Comment on lines +22 to +25

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"dist",
"path-support.js",
"registry.js",
"src"
"dist",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion still applies — all other files do not need to be packaged, but are instead present at dev-time.

]
}
85 changes: 3 additions & 82 deletions packages/assets/path-support.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,89 +4,10 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
* @format strict
* @flow
Comment on lines +7 to +8

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this line was accidentally rearranged first!

Also, feel free to use strict-local everywhere, it's slightly more forgiving.

Suggested change
* @formatstrict
* @flow
* @flowstrict-local
* @format

*/

'use strict';

import type {PackagerAsset} from './registry.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}

module.exports = {
getAndroidResourceFolderName,
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');
Comment thread
huntie marked this conversation as resolved.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To enable running from source, let's add babel-register wrapper files for these two entry points. And yeah, actually that means keeping these files around (for Flow's type checker, which sadly doesn't follow "exports").

You can find an example of this pattern in packages/dev-middleware/: https://github.com/facebook/react-native/blob/main/packages/dev-middleware/src/index.js.

And the file structure you'll need:

assets
├── path-support.js.flow # (Flow only) Re-export all types and values
├── registry.js.flow
└── src
├── path-support.js # Entry point - babel-register
├── path-support.flow.js # Implementation
├── registry.js
└── registry.flow.js

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I didn't quite understand what those files were. Makes sense now!

@tido64tido64Sep 14, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So… it looks like flow-check is unable to find .js.flow files. I had to rename them back to .js and fix a bunch of Dependencies of a @flow strict module must also be @flow strict! errors. The check seems to pass locally now.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this pattern works. babel-register cannot be found when the package is consumed outside the repository. Do you have any suggestions for how to address this?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

babel-register cannot be foundwhen the package is consumed outside the repository.

Do you mean you have a setup where another project is consuming a local checkout of the react-native repository from source (e.g. via yarn link)?

This should work. Happy to debug via chat.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
module.exports=require('./src/path-support');
export*from'./src/path-support';

27 changes: 1 addition & 26 deletions packages/assets/registry.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,29 +10,4 @@

'use strict';

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}

module.exports = {registerAsset, getAssetByID};
module.exports = require('./src/registry.flow');
Comment on lines 11 to +13

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'use strict';
exporttypePackagerAsset={
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};
constassets: Array<PackagerAsset> = [];
functionregisterAsset(asset: PackagerAsset): number{
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
returnassets.push(asset);
}
functiongetAssetByID(assetId: number): PackagerAsset{
returnassets[assetId-1];
}
module.exports={registerAsset, getAssetByID};
module.exports=require('./src/registry.flow');
export*from'./src/registry.flow';

84 changes: 84 additions & 0 deletions packages/assets/src/path-support.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
*/

import type {PackagerAsset} from './registry.flow.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

export function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

export function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

export function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}
20 changes: 20 additions & 0 deletions packages/assets/src/path-support.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './path-support.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './path-support.flow';
34 changes: 34 additions & 0 deletions packages/assets/src/registry.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict
* @format
*/

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

export function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

export function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}
20 changes: 20 additions & 0 deletions packages/assets/src/registry.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './registry.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './registry.flow';
1 change: 1 addition & 0 deletions packages/rn-tester/metro.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ const config = {
// Make Metro able to resolve required external dependencies
watchFolders: [
path.resolve(__dirname, '../../node_modules'),
path.resolve(__dirname, '../../scripts/build'), // babel-register.js

@huntiehuntieSep 15, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, @react-native/asset-registry is not a Node package — it's consumed by runtime code in packages/react-native/Libraries/!

This probably means we don't need the babel-register setup at all (just the root .js.flow files redirecting to src/) — since all modules loaded by React Native go through @react-native/babel-preset. This setup is just for run-from-source behaviour within the React Native monorepo.

Back to the PR summary:

Transpile assets-registry so it can be consumed outside of a React Native bundle:

This is technically new ground. I think we want to define a new build target of 'react-native'/'react-native-and-external' in scripts/build/config.js, configuring this to build files using @react-native/babel-preset as its Babel config. Will reach out via DM.

path.resolve(__dirname, '../assets'),
path.resolve(__dirname, '../community-cli-plugin'),
path.resolve(__dirname, '../dev-middleware'),
Expand Down
4 changes: 4 additions & 0 deletions scripts/build/config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,10 @@ export type BuildConfig = $ReadOnly<{
*/
const buildConfig /*: BuildConfig */ = {
packages: {
assets: {
target: 'node',
emitTypeScriptDefs: true,
},
'community-cli-plugin': {
target: 'node',
},
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/assets/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
# Dependencies
/node_modules

# Build output
/dist
16 changes: 13 additions & 3 deletions packages/assets/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,17 @@
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/assets#readme",
"keywords": ["assets", "registry", "react-native", "support"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=18"
}
"exports": {
"./path-support": "./src/path-support.js",
"./path-support.js": "./src/path-support.js",
"./registry": "./src/registry.js",
"./registry.js": "./src/registry.js",
"./package.json": "./package.json"
},
"files": [
"dist",
"path-support.js",
"registry.js",
"src"
Comment on lines +22 to +25

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"dist",
"path-support.js",
"registry.js",
"src"
"dist",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion still applies — all other files do not need to be packaged, but are instead present at dev-time.

]
}
85 changes: 3 additions & 82 deletions packages/assets/path-support.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,89 +4,10 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
* @format strict
* @flow
Comment on lines +7 to +8

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this line was accidentally rearranged first!

Also, feel free to use strict-local everywhere, it's slightly more forgiving.

Suggested change
* @formatstrict
* @flow
* @flowstrict-local
* @format

*/

'use strict';

import type {PackagerAsset} from './registry.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}

module.exports = {
getAndroidResourceFolderName,
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');
Comment thread
huntie marked this conversation as resolved.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To enable running from source, let's add babel-register wrapper files for these two entry points. And yeah, actually that means keeping these files around (for Flow's type checker, which sadly doesn't follow "exports").

You can find an example of this pattern in packages/dev-middleware/: https://github.com/facebook/react-native/blob/main/packages/dev-middleware/src/index.js.

And the file structure you'll need:

assets
├── path-support.js.flow # (Flow only) Re-export all types and values
├── registry.js.flow
└── src
├── path-support.js # Entry point - babel-register
├── path-support.flow.js # Implementation
├── registry.js
└── registry.flow.js

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I didn't quite understand what those files were. Makes sense now!

@tido64tido64Sep 14, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So… it looks like flow-check is unable to find .js.flow files. I had to rename them back to .js and fix a bunch of Dependencies of a @flow strict module must also be @flow strict! errors. The check seems to pass locally now.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this pattern works. babel-register cannot be found when the package is consumed outside the repository. Do you have any suggestions for how to address this?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

babel-register cannot be foundwhen the package is consumed outside the repository.

Do you mean you have a setup where another project is consuming a local checkout of the react-native repository from source (e.g. via yarn link)?

This should work. Happy to debug via chat.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
module.exports=require('./src/path-support');
export*from'./src/path-support';

27 changes: 1 addition & 26 deletions packages/assets/registry.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,29 +10,4 @@

'use strict';

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}

module.exports = {registerAsset, getAssetByID};
module.exports = require('./src/registry.flow');
Comment on lines 11 to +13

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'use strict';
exporttypePackagerAsset={
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};
constassets: Array<PackagerAsset> = [];
functionregisterAsset(asset: PackagerAsset): number{
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
returnassets.push(asset);
}
functiongetAssetByID(assetId: number): PackagerAsset{
returnassets[assetId-1];
}
module.exports={registerAsset, getAssetByID};
module.exports=require('./src/registry.flow');
export*from'./src/registry.flow';

84 changes: 84 additions & 0 deletions packages/assets/src/path-support.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
*/

import type {PackagerAsset} from './registry.flow.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

export function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

export function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

export function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}
20 changes: 20 additions & 0 deletions packages/assets/src/path-support.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './path-support.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './path-support.flow';
34 changes: 34 additions & 0 deletions packages/assets/src/registry.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict
* @format
*/

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

export function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

export function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}
20 changes: 20 additions & 0 deletions packages/assets/src/registry.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './registry.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './registry.flow';
1 change: 1 addition & 0 deletions packages/rn-tester/metro.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ const config = {
// Make Metro able to resolve required external dependencies
watchFolders: [
path.resolve(__dirname, '../../node_modules'),
path.resolve(__dirname, '../../scripts/build'), // babel-register.js

@huntiehuntieSep 15, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, @react-native/asset-registry is not a Node package — it's consumed by runtime code in packages/react-native/Libraries/!

This probably means we don't need the babel-register setup at all (just the root .js.flow files redirecting to src/) — since all modules loaded by React Native go through @react-native/babel-preset. This setup is just for run-from-source behaviour within the React Native monorepo.

Back to the PR summary:

Transpile assets-registry so it can be consumed outside of a React Native bundle:

This is technically new ground. I think we want to define a new build target of 'react-native'/'react-native-and-external' in scripts/build/config.js, configuring this to build files using @react-native/babel-preset as its Babel config. Will reach out via DM.

path.resolve(__dirname, '../assets'),
path.resolve(__dirname, '../community-cli-plugin'),
path.resolve(__dirname, '../dev-middleware'),
Expand Down
4 changes: 4 additions & 0 deletions scripts/build/config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,10 @@ export type BuildConfig = $ReadOnly<{
*/
const buildConfig /*: BuildConfig */ = {
packages: {
assets: {
target: 'node',
emitTypeScriptDefs: true,
},
'community-cli-plugin': {
target: 'node',
},
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/assets/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
# Dependencies
/node_modules

# Build output
/dist
16 changes: 13 additions & 3 deletions packages/assets/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,17 @@
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/assets#readme",
"keywords": ["assets", "registry", "react-native", "support"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=18"
}
"exports": {
"./path-support": "./src/path-support.js",
"./path-support.js": "./src/path-support.js",
"./registry": "./src/registry.js",
"./registry.js": "./src/registry.js",
"./package.json": "./package.json"
},
"files": [
"dist",
"path-support.js",
"registry.js",
"src"
Comment on lines +22 to +25

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"dist",
"path-support.js",
"registry.js",
"src"
"dist",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion still applies — all other files do not need to be packaged, but are instead present at dev-time.

]
}
85 changes: 3 additions & 82 deletions packages/assets/path-support.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,89 +4,10 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
* @format strict
* @flow
Comment on lines +7 to +8

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this line was accidentally rearranged first!

Also, feel free to use strict-local everywhere, it's slightly more forgiving.

Suggested change
* @formatstrict
* @flow
* @flowstrict-local
* @format

*/

'use strict';

import type {PackagerAsset} from './registry.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}

module.exports = {
getAndroidResourceFolderName,
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');
Comment thread
huntie marked this conversation as resolved.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To enable running from source, let's add babel-register wrapper files for these two entry points. And yeah, actually that means keeping these files around (for Flow's type checker, which sadly doesn't follow "exports").

You can find an example of this pattern in packages/dev-middleware/: https://github.com/facebook/react-native/blob/main/packages/dev-middleware/src/index.js.

And the file structure you'll need:

assets
├── path-support.js.flow # (Flow only) Re-export all types and values
├── registry.js.flow
└── src
├── path-support.js # Entry point - babel-register
├── path-support.flow.js # Implementation
├── registry.js
└── registry.flow.js

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I didn't quite understand what those files were. Makes sense now!

@tido64tido64Sep 14, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So… it looks like flow-check is unable to find .js.flow files. I had to rename them back to .js and fix a bunch of Dependencies of a @flow strict module must also be @flow strict! errors. The check seems to pass locally now.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this pattern works. babel-register cannot be found when the package is consumed outside the repository. Do you have any suggestions for how to address this?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

babel-register cannot be foundwhen the package is consumed outside the repository.

Do you mean you have a setup where another project is consuming a local checkout of the react-native repository from source (e.g. via yarn link)?

This should work. Happy to debug via chat.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
module.exports=require('./src/path-support');
export*from'./src/path-support';

27 changes: 1 addition & 26 deletions packages/assets/registry.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,29 +10,4 @@

'use strict';

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}

module.exports = {registerAsset, getAssetByID};
module.exports = require('./src/registry.flow');
Comment on lines 11 to +13

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'use strict';
exporttypePackagerAsset={
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};
constassets: Array<PackagerAsset> = [];
functionregisterAsset(asset: PackagerAsset): number{
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
returnassets.push(asset);
}
functiongetAssetByID(assetId: number): PackagerAsset{
returnassets[assetId-1];
}
module.exports={registerAsset, getAssetByID};
module.exports=require('./src/registry.flow');
export*from'./src/registry.flow';

84 changes: 84 additions & 0 deletions packages/assets/src/path-support.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
*/

import type {PackagerAsset} from './registry.flow.js';

const androidScaleSuffix = {
'0.75': 'ldpi',
'1': 'mdpi',
'1.5': 'hdpi',
'2': 'xhdpi',
'3': 'xxhdpi',
'4': 'xxxhdpi',
};

const ANDROID_BASE_DENSITY = 160;

/**
* FIXME: using number to represent discrete scale numbers is fragile in essence because of
* floating point numbers imprecision.
*/
function getAndroidAssetSuffix(scale: number): string {
if (scale.toString() in androidScaleSuffix) {
return androidScaleSuffix[scale.toString()];
}
// NOTE: Android Gradle Plugin does not fully support the nnndpi format.
// See https://issuetracker.google.com/issues/72884435
if (Number.isFinite(scale) && scale > 0) {
return Math.round(scale * ANDROID_BASE_DENSITY) + 'dpi';
}
throw new Error('no such scale ' + scale.toString());
}

// See https://developer.android.com/guide/topics/resources/drawable-resource.html
const drawableFileTypes = new Set([
'gif',
'jpeg',
'jpg',
'ktx',
'png',
'svg',
'webp',
'xml',
]);

export function getAndroidResourceFolderName(
asset: PackagerAsset,
scale: number,
): string | $TEMPORARY$string<'raw'> {
if (!drawableFileTypes.has(asset.type)) {
return 'raw';
}
const suffix = getAndroidAssetSuffix(scale);
if (!suffix) {
throw new Error(
"Don't know which android drawable suffix to use for scale: " +
scale +
'\nAsset: ' +
JSON.stringify(asset, null, '\t') +
'\nPossible scales are:' +
JSON.stringify(androidScaleSuffix, null, '\t'),
);
}
return 'drawable-' + suffix;
}

export function getAndroidResourceIdentifier(asset: PackagerAsset): string {
return (getBasePath(asset) + '/' + asset.name)
.toLowerCase()
.replace(/\//g, '_') // Encode folder structure in file name
.replace(/([^a-z0-9_])/g, '') // Remove illegal chars
.replace(/^assets_/, ''); // Remove "assets_" prefix
}

export function getBasePath(asset: PackagerAsset): string {
const basePath = asset.httpServerLocation;
return basePath.startsWith('/') ? basePath.slice(1) : basePath;
}
20 changes: 20 additions & 0 deletions packages/assets/src/path-support.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './path-support.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './path-support.flow';
34 changes: 34 additions & 0 deletions packages/assets/src/registry.flow.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict
* @format
*/

export type PackagerAsset = {
+__packager_asset: boolean,
+fileSystemLocation: string,
+httpServerLocation: string,
+width: ?number,
+height: ?number,
+scales: Array<number>,
+hash: string,
+name: string,
+type: string,
...
};

const assets: Array<PackagerAsset> = [];

export function registerAsset(asset: PackagerAsset): number {
// `push` returns new array length, so the first asset will
// get id 1 (not 0) to make the value truthy
return assets.push(asset);
}

export function getAssetByID(assetId: number): PackagerAsset {
return assets[assetId - 1];
}
20 changes: 20 additions & 0 deletions packages/assets/src/registry.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
* @oncall react_native
*/

/*::
export type * from './registry.flow';
*/

if (process.env.BUILD_EXCLUDE_BABEL_REGISTER != null) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

export * from './registry.flow';
1 change: 1 addition & 0 deletions packages/rn-tester/metro.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ const config = {
// Make Metro able to resolve required external dependencies
watchFolders: [
path.resolve(__dirname, '../../node_modules'),
path.resolve(__dirname, '../../scripts/build'), // babel-register.js

@huntiehuntieSep 15, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, @react-native/asset-registry is not a Node package — it's consumed by runtime code in packages/react-native/Libraries/!

This probably means we don't need the babel-register setup at all (just the root .js.flow files redirecting to src/) — since all modules loaded by React Native go through @react-native/babel-preset. This setup is just for run-from-source behaviour within the React Native monorepo.

Back to the PR summary:

Transpile assets-registry so it can be consumed outside of a React Native bundle:

This is technically new ground. I think we want to define a new build target of 'react-native'/'react-native-and-external' in scripts/build/config.js, configuring this to build files using @react-native/babel-preset as its Babel config. Will reach out via DM.

path.resolve(__dirname, '../assets'),
path.resolve(__dirname, '../community-cli-plugin'),
path.resolve(__dirname, '../dev-middleware'),
Expand Down
4 changes: 4 additions & 0 deletions scripts/build/config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,10 @@ export type BuildConfig = $ReadOnly<{
*/
const buildConfig /*: BuildConfig */ = {
packages: {
assets: {
target: 'node',
emitTypeScriptDefs: true,
},
'community-cli-plugin': {
target: 'node',
},
Expand Down