Build assets-registry for general consumption - #39440

Closed
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry
Closed

Build assets-registry for general consumption#39440
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry

Conversation

@tido64

@tido64tido64 commented Sep 14, 2023

Copy link
Copy Markdown
Collaborator

Summary:

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

  • Copied root .js files into src
  • Declared exports in package.json
  • To keep backwards compatibility, the root .js files re-export the corresponding files in the src folder

This is a follow-up to #38795 (comment). Let me know if this looks feasible to you.

Changelog:

[INTERNAL] [CHANGED] - Transpile assets-registry so it can be consumed outside of a React Native bundle

Test Plan:

n/a

@facebook-github-botfacebook-github-bot added CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. p: Microsoft Partner: Microsoft Partner Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. labels Sep 14, 2023
@analysis-bot

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,970,014+19
androidhermesarmeabi-v7an/a--
androidhermesx86n/a--
androidhermesx86_64n/a--
androidjscarm64-v8a9,562,448+50
androidjscarmeabi-v7an/a--
androidjscx86n/a--
androidjscx86_64n/a--

Base commit: b29b393
Branch: main

@cortinico

Copy link
Copy Markdown
Contributor

cc @huntie

@huntiehuntie left a comment

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.

Thanks for migrating this package into the shared build setup 😄.

nit: Changelog in PR summary can be reduced to Changelog: [Internal].

Comment threadpackages/assets/path-support.js
Comment threadpackages/assets/package.json Outdated
Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

Comment thread.circleci/configurations/jobs.yml Outdated
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

@tido64
tido64force-pushed the tido/build-assets-registry branch from ade331e to 16a72c5CompareSeptember 14, 2023 18:36
@github-actions

Copy link
Copy Markdown
Warnings
⚠️One hour and a half have passed and the E2E jobs haven't finished yet.

Generated by 🚫 dangerJS against 9ba56eb

Comment on lines +7 to +8
* @format strict
* @flow

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

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

Comment on lines 11 to +13
'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');

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';

Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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';

// 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.

@zhairui

Copy link
Copy Markdown

cc @huntie

I meet an error , pls help . thanks ! here is the error stack:

[TypeError: _$$_REQUIRE(_dependencyMap[7], "(...)ssets-registry/path-support.js") is not a function (it is Object)] {"componentStack": "
in BaseImage (created by ImageBackground)
in RCTView (created by View)
in View (created by ImageBackground)
....

@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@react-native-botreact-native-bot added the Stale There has been a lack of activity on this issue and it may be closed soon. label Jul 24, 2024
@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR was closed because it has been stalled for 7 days with no activity.

@tido64
tido64 deleted the tido/build-assets-registry branch February 11, 2025 12:58
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.p: MicrosoftPartner: MicrosoftPartnerShared with MetaApplied via automation to indicate that an Issue or Pull Request has been shared with the team.StaleThere has been a lack of activity on this issue and it may be closed soon.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@tido64@analysis-bot@cortinico@zhairui@react-native-bot@huntie@facebook-github-bot
, '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

Build assets-registry for general consumption - #39440

Closed
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry
Closed

Build assets-registry for general consumption#39440
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry

Conversation

@tido64

@tido64tido64 commented Sep 14, 2023

Copy link
Copy Markdown
Collaborator

Summary:

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

  • Copied root .js files into src
  • Declared exports in package.json
  • To keep backwards compatibility, the root .js files re-export the corresponding files in the src folder

This is a follow-up to #38795 (comment). Let me know if this looks feasible to you.

Changelog:

[INTERNAL] [CHANGED] - Transpile assets-registry so it can be consumed outside of a React Native bundle

Test Plan:

n/a

@facebook-github-botfacebook-github-bot added CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. p: Microsoft Partner: Microsoft Partner Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. labels Sep 14, 2023
@analysis-bot

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,970,014+19
androidhermesarmeabi-v7an/a--
androidhermesx86n/a--
androidhermesx86_64n/a--
androidjscarm64-v8a9,562,448+50
androidjscarmeabi-v7an/a--
androidjscx86n/a--
androidjscx86_64n/a--

Base commit: b29b393
Branch: main

@cortinico

Copy link
Copy Markdown
Contributor

cc @huntie

@huntiehuntie left a comment

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.

Thanks for migrating this package into the shared build setup 😄.

nit: Changelog in PR summary can be reduced to Changelog: [Internal].

Comment threadpackages/assets/path-support.js
Comment threadpackages/assets/package.json Outdated
Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

Comment thread.circleci/configurations/jobs.yml Outdated
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

@tido64
tido64force-pushed the tido/build-assets-registry branch from ade331e to 16a72c5CompareSeptember 14, 2023 18:36
@github-actions

Copy link
Copy Markdown
Warnings
⚠️One hour and a half have passed and the E2E jobs haven't finished yet.

Generated by 🚫 dangerJS against 9ba56eb

Comment on lines +7 to +8
* @format strict
* @flow

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

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

Comment on lines 11 to +13
'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');

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';

Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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';

// 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.

@zhairui

Copy link
Copy Markdown

cc @huntie

I meet an error , pls help . thanks ! here is the error stack:

[TypeError: _$$_REQUIRE(_dependencyMap[7], "(...)ssets-registry/path-support.js") is not a function (it is Object)] {"componentStack": "
in BaseImage (created by ImageBackground)
in RCTView (created by View)
in View (created by ImageBackground)
....

@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@react-native-botreact-native-bot added the Stale There has been a lack of activity on this issue and it may be closed soon. label Jul 24, 2024
@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR was closed because it has been stalled for 7 days with no activity.

@tido64
tido64 deleted the tido/build-assets-registry branch February 11, 2025 12:58
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.p: MicrosoftPartner: MicrosoftPartnerShared with MetaApplied via automation to indicate that an Issue or Pull Request has been shared with the team.StaleThere has been a lack of activity on this issue and it may be closed soon.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@tido64@analysis-bot@cortinico@zhairui@react-native-bot@huntie@facebook-github-bot
, '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

Build assets-registry for general consumption - #39440

Closed
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry
Closed

Build assets-registry for general consumption#39440
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry

Conversation

@tido64

@tido64tido64 commented Sep 14, 2023

Copy link
Copy Markdown
Collaborator

Summary:

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

  • Copied root .js files into src
  • Declared exports in package.json
  • To keep backwards compatibility, the root .js files re-export the corresponding files in the src folder

This is a follow-up to #38795 (comment). Let me know if this looks feasible to you.

Changelog:

[INTERNAL] [CHANGED] - Transpile assets-registry so it can be consumed outside of a React Native bundle

Test Plan:

n/a

@facebook-github-botfacebook-github-bot added CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. p: Microsoft Partner: Microsoft Partner Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. labels Sep 14, 2023
@analysis-bot

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,970,014+19
androidhermesarmeabi-v7an/a--
androidhermesx86n/a--
androidhermesx86_64n/a--
androidjscarm64-v8a9,562,448+50
androidjscarmeabi-v7an/a--
androidjscx86n/a--
androidjscx86_64n/a--

Base commit: b29b393
Branch: main

@cortinico

Copy link
Copy Markdown
Contributor

cc @huntie

@huntiehuntie left a comment

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.

Thanks for migrating this package into the shared build setup 😄.

nit: Changelog in PR summary can be reduced to Changelog: [Internal].

Comment threadpackages/assets/path-support.js
Comment threadpackages/assets/package.json Outdated
Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

Comment thread.circleci/configurations/jobs.yml Outdated
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

@tido64
tido64force-pushed the tido/build-assets-registry branch from ade331e to 16a72c5CompareSeptember 14, 2023 18:36
@github-actions

Copy link
Copy Markdown
Warnings
⚠️One hour and a half have passed and the E2E jobs haven't finished yet.

Generated by 🚫 dangerJS against 9ba56eb

Comment on lines +7 to +8
* @format strict
* @flow

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

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

Comment on lines 11 to +13
'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');

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';

Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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';

// 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.

@zhairui

Copy link
Copy Markdown

cc @huntie

I meet an error , pls help . thanks ! here is the error stack:

[TypeError: _$$_REQUIRE(_dependencyMap[7], "(...)ssets-registry/path-support.js") is not a function (it is Object)] {"componentStack": "
in BaseImage (created by ImageBackground)
in RCTView (created by View)
in View (created by ImageBackground)
....

@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@react-native-botreact-native-bot added the Stale There has been a lack of activity on this issue and it may be closed soon. label Jul 24, 2024
@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR was closed because it has been stalled for 7 days with no activity.

@tido64
tido64 deleted the tido/build-assets-registry branch February 11, 2025 12:58
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.p: MicrosoftPartner: MicrosoftPartnerShared with MetaApplied via automation to indicate that an Issue or Pull Request has been shared with the team.StaleThere has been a lack of activity on this issue and it may be closed soon.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@tido64@analysis-bot@cortinico@zhairui@react-native-bot@huntie@facebook-github-bot
, '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

Build assets-registry for general consumption - #39440

Closed
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry
Closed

Build assets-registry for general consumption#39440
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry

Conversation

@tido64

@tido64tido64 commented Sep 14, 2023

Copy link
Copy Markdown
Collaborator

Summary:

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

  • Copied root .js files into src
  • Declared exports in package.json
  • To keep backwards compatibility, the root .js files re-export the corresponding files in the src folder

This is a follow-up to #38795 (comment). Let me know if this looks feasible to you.

Changelog:

[INTERNAL] [CHANGED] - Transpile assets-registry so it can be consumed outside of a React Native bundle

Test Plan:

n/a

@facebook-github-botfacebook-github-bot added CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. p: Microsoft Partner: Microsoft Partner Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. labels Sep 14, 2023
@analysis-bot

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,970,014+19
androidhermesarmeabi-v7an/a--
androidhermesx86n/a--
androidhermesx86_64n/a--
androidjscarm64-v8a9,562,448+50
androidjscarmeabi-v7an/a--
androidjscx86n/a--
androidjscx86_64n/a--

Base commit: b29b393
Branch: main

@cortinico

Copy link
Copy Markdown
Contributor

cc @huntie

@huntiehuntie left a comment

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.

Thanks for migrating this package into the shared build setup 😄.

nit: Changelog in PR summary can be reduced to Changelog: [Internal].

Comment threadpackages/assets/path-support.js
Comment threadpackages/assets/package.json Outdated
Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

Comment thread.circleci/configurations/jobs.yml Outdated
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

@tido64
tido64force-pushed the tido/build-assets-registry branch from ade331e to 16a72c5CompareSeptember 14, 2023 18:36
@github-actions

Copy link
Copy Markdown
Warnings
⚠️One hour and a half have passed and the E2E jobs haven't finished yet.

Generated by 🚫 dangerJS against 9ba56eb

Comment on lines +7 to +8
* @format strict
* @flow

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

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

Comment on lines 11 to +13
'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');

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';

Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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';

// 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.

@zhairui

Copy link
Copy Markdown

cc @huntie

I meet an error , pls help . thanks ! here is the error stack:

[TypeError: _$$_REQUIRE(_dependencyMap[7], "(...)ssets-registry/path-support.js") is not a function (it is Object)] {"componentStack": "
in BaseImage (created by ImageBackground)
in RCTView (created by View)
in View (created by ImageBackground)
....

@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@react-native-botreact-native-bot added the Stale There has been a lack of activity on this issue and it may be closed soon. label Jul 24, 2024
@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR was closed because it has been stalled for 7 days with no activity.

@tido64
tido64 deleted the tido/build-assets-registry branch February 11, 2025 12:58
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.p: MicrosoftPartner: MicrosoftPartnerShared with MetaApplied via automation to indicate that an Issue or Pull Request has been shared with the team.StaleThere has been a lack of activity on this issue and it may be closed soon.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@tido64@analysis-bot@cortinico@zhairui@react-native-bot@huntie@facebook-github-bot
, '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

Build assets-registry for general consumption - #39440

Closed
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry
Closed

Build assets-registry for general consumption#39440
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry

Conversation

@tido64

@tido64tido64 commented Sep 14, 2023

Copy link
Copy Markdown
Collaborator

Summary:

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

  • Copied root .js files into src
  • Declared exports in package.json
  • To keep backwards compatibility, the root .js files re-export the corresponding files in the src folder

This is a follow-up to #38795 (comment). Let me know if this looks feasible to you.

Changelog:

[INTERNAL] [CHANGED] - Transpile assets-registry so it can be consumed outside of a React Native bundle

Test Plan:

n/a

@facebook-github-botfacebook-github-bot added CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. p: Microsoft Partner: Microsoft Partner Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. labels Sep 14, 2023
@analysis-bot

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,970,014+19
androidhermesarmeabi-v7an/a--
androidhermesx86n/a--
androidhermesx86_64n/a--
androidjscarm64-v8a9,562,448+50
androidjscarmeabi-v7an/a--
androidjscx86n/a--
androidjscx86_64n/a--

Base commit: b29b393
Branch: main

@cortinico

Copy link
Copy Markdown
Contributor

cc @huntie

@huntiehuntie left a comment

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.

Thanks for migrating this package into the shared build setup 😄.

nit: Changelog in PR summary can be reduced to Changelog: [Internal].

Comment threadpackages/assets/path-support.js
Comment threadpackages/assets/package.json Outdated
Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

Comment thread.circleci/configurations/jobs.yml Outdated
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

@tido64
tido64force-pushed the tido/build-assets-registry branch from ade331e to 16a72c5CompareSeptember 14, 2023 18:36
@github-actions

Copy link
Copy Markdown
Warnings
⚠️One hour and a half have passed and the E2E jobs haven't finished yet.

Generated by 🚫 dangerJS against 9ba56eb

Comment on lines +7 to +8
* @format strict
* @flow

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

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

Comment on lines 11 to +13
'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');

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';

Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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';

// 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.

@zhairui

Copy link
Copy Markdown

cc @huntie

I meet an error , pls help . thanks ! here is the error stack:

[TypeError: _$$_REQUIRE(_dependencyMap[7], "(...)ssets-registry/path-support.js") is not a function (it is Object)] {"componentStack": "
in BaseImage (created by ImageBackground)
in RCTView (created by View)
in View (created by ImageBackground)
....

@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@react-native-botreact-native-bot added the Stale There has been a lack of activity on this issue and it may be closed soon. label Jul 24, 2024
@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR was closed because it has been stalled for 7 days with no activity.

@tido64
tido64 deleted the tido/build-assets-registry branch February 11, 2025 12:58
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.p: MicrosoftPartner: MicrosoftPartnerShared with MetaApplied via automation to indicate that an Issue or Pull Request has been shared with the team.StaleThere has been a lack of activity on this issue and it may be closed soon.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@tido64@analysis-bot@cortinico@zhairui@react-native-bot@huntie@facebook-github-bot
, '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

Build assets-registry for general consumption - #39440

Closed
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry
Closed

Build assets-registry for general consumption#39440
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry

Conversation

@tido64

@tido64tido64 commented Sep 14, 2023

Copy link
Copy Markdown
Collaborator

Summary:

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

  • Copied root .js files into src
  • Declared exports in package.json
  • To keep backwards compatibility, the root .js files re-export the corresponding files in the src folder

This is a follow-up to #38795 (comment). Let me know if this looks feasible to you.

Changelog:

[INTERNAL] [CHANGED] - Transpile assets-registry so it can be consumed outside of a React Native bundle

Test Plan:

n/a

@facebook-github-botfacebook-github-bot added CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. p: Microsoft Partner: Microsoft Partner Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. labels Sep 14, 2023
@analysis-bot

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,970,014+19
androidhermesarmeabi-v7an/a--
androidhermesx86n/a--
androidhermesx86_64n/a--
androidjscarm64-v8a9,562,448+50
androidjscarmeabi-v7an/a--
androidjscx86n/a--
androidjscx86_64n/a--

Base commit: b29b393
Branch: main

@cortinico

Copy link
Copy Markdown
Contributor

cc @huntie

@huntiehuntie left a comment

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.

Thanks for migrating this package into the shared build setup 😄.

nit: Changelog in PR summary can be reduced to Changelog: [Internal].

Comment threadpackages/assets/path-support.js
Comment threadpackages/assets/package.json Outdated
Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

Comment thread.circleci/configurations/jobs.yml Outdated
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

@tido64
tido64force-pushed the tido/build-assets-registry branch from ade331e to 16a72c5CompareSeptember 14, 2023 18:36
@github-actions

Copy link
Copy Markdown
Warnings
⚠️One hour and a half have passed and the E2E jobs haven't finished yet.

Generated by 🚫 dangerJS against 9ba56eb

Comment on lines +7 to +8
* @format strict
* @flow

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

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

Comment on lines 11 to +13
'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');

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';

Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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';

// 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.

@zhairui

Copy link
Copy Markdown

cc @huntie

I meet an error , pls help . thanks ! here is the error stack:

[TypeError: _$$_REQUIRE(_dependencyMap[7], "(...)ssets-registry/path-support.js") is not a function (it is Object)] {"componentStack": "
in BaseImage (created by ImageBackground)
in RCTView (created by View)
in View (created by ImageBackground)
....

@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@react-native-botreact-native-bot added the Stale There has been a lack of activity on this issue and it may be closed soon. label Jul 24, 2024
@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR was closed because it has been stalled for 7 days with no activity.

@tido64
tido64 deleted the tido/build-assets-registry branch February 11, 2025 12:58
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.p: MicrosoftPartner: MicrosoftPartnerShared with MetaApplied via automation to indicate that an Issue or Pull Request has been shared with the team.StaleThere has been a lack of activity on this issue and it may be closed soon.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@tido64@analysis-bot@cortinico@zhairui@react-native-bot@huntie@facebook-github-bot
, '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

Build assets-registry for general consumption - #39440

Closed
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry
Closed

Build assets-registry for general consumption#39440
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry

Conversation

@tido64

@tido64tido64 commented Sep 14, 2023

Copy link
Copy Markdown
Collaborator

Summary:

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

  • Copied root .js files into src
  • Declared exports in package.json
  • To keep backwards compatibility, the root .js files re-export the corresponding files in the src folder

This is a follow-up to #38795 (comment). Let me know if this looks feasible to you.

Changelog:

[INTERNAL] [CHANGED] - Transpile assets-registry so it can be consumed outside of a React Native bundle

Test Plan:

n/a

@facebook-github-botfacebook-github-bot added CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. p: Microsoft Partner: Microsoft Partner Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. labels Sep 14, 2023
@analysis-bot

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,970,014+19
androidhermesarmeabi-v7an/a--
androidhermesx86n/a--
androidhermesx86_64n/a--
androidjscarm64-v8a9,562,448+50
androidjscarmeabi-v7an/a--
androidjscx86n/a--
androidjscx86_64n/a--

Base commit: b29b393
Branch: main

@cortinico

Copy link
Copy Markdown
Contributor

cc @huntie

@huntiehuntie left a comment

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.

Thanks for migrating this package into the shared build setup 😄.

nit: Changelog in PR summary can be reduced to Changelog: [Internal].

Comment threadpackages/assets/path-support.js
Comment threadpackages/assets/package.json Outdated
Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

Comment thread.circleci/configurations/jobs.yml Outdated
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

@tido64
tido64force-pushed the tido/build-assets-registry branch from ade331e to 16a72c5CompareSeptember 14, 2023 18:36
@github-actions

Copy link
Copy Markdown
Warnings
⚠️One hour and a half have passed and the E2E jobs haven't finished yet.

Generated by 🚫 dangerJS against 9ba56eb

Comment on lines +7 to +8
* @format strict
* @flow

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

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

Comment on lines 11 to +13
'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');

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';

Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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';

// 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.

@zhairui

Copy link
Copy Markdown

cc @huntie

I meet an error , pls help . thanks ! here is the error stack:

[TypeError: _$$_REQUIRE(_dependencyMap[7], "(...)ssets-registry/path-support.js") is not a function (it is Object)] {"componentStack": "
in BaseImage (created by ImageBackground)
in RCTView (created by View)
in View (created by ImageBackground)
....

@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@react-native-botreact-native-bot added the Stale There has been a lack of activity on this issue and it may be closed soon. label Jul 24, 2024
@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR was closed because it has been stalled for 7 days with no activity.

@tido64
tido64 deleted the tido/build-assets-registry branch February 11, 2025 12:58
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.p: MicrosoftPartner: MicrosoftPartnerShared with MetaApplied via automation to indicate that an Issue or Pull Request has been shared with the team.StaleThere has been a lack of activity on this issue and it may be closed soon.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@tido64@analysis-bot@cortinico@zhairui@react-native-bot@huntie@facebook-github-bot
, '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

Build assets-registry for general consumption - #39440

Closed
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry
Closed

Build assets-registry for general consumption#39440
tido64 wants to merge 8 commits into
mainfrom
tido/build-assets-registry

Conversation

@tido64

@tido64tido64 commented Sep 14, 2023

Copy link
Copy Markdown
Collaborator

Summary:

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

  • Copied root .js files into src
  • Declared exports in package.json
  • To keep backwards compatibility, the root .js files re-export the corresponding files in the src folder

This is a follow-up to #38795 (comment). Let me know if this looks feasible to you.

Changelog:

[INTERNAL] [CHANGED] - Transpile assets-registry so it can be consumed outside of a React Native bundle

Test Plan:

n/a

@facebook-github-botfacebook-github-bot added CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. p: Microsoft Partner: Microsoft Partner Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. labels Sep 14, 2023
@analysis-bot

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,970,014+19
androidhermesarmeabi-v7an/a--
androidhermesx86n/a--
androidhermesx86_64n/a--
androidjscarm64-v8a9,562,448+50
androidjscarmeabi-v7an/a--
androidjscx86n/a--
androidjscx86_64n/a--

Base commit: b29b393
Branch: main

@cortinico

Copy link
Copy Markdown
Contributor

cc @huntie

@huntiehuntie left a comment

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.

Thanks for migrating this package into the shared build setup 😄.

nit: Changelog in PR summary can be reduced to Changelog: [Internal].

Comment threadpackages/assets/path-support.js
Comment threadpackages/assets/package.json Outdated
Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

Comment thread.circleci/configurations/jobs.yml Outdated
getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

@tido64
tido64force-pushed the tido/build-assets-registry branch from ade331e to 16a72c5CompareSeptember 14, 2023 18:36
@github-actions

Copy link
Copy Markdown
Warnings
⚠️One hour and a half have passed and the E2E jobs haven't finished yet.

Generated by 🚫 dangerJS against 9ba56eb

Comment on lines +7 to +8
* @format strict
* @flow

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

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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.

Comment on lines 11 to +13
'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');

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';

Comment on lines +20 to +23
"dist",
"path-support.js",
"registry.js",
"src"

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.

getAndroidResourceIdentifier,
getBasePath,
};
module.exports = require('./src/path-support');

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';

// 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.

@zhairui

Copy link
Copy Markdown

cc @huntie

I meet an error , pls help . thanks ! here is the error stack:

[TypeError: _$$_REQUIRE(_dependencyMap[7], "(...)ssets-registry/path-support.js") is not a function (it is Object)] {"componentStack": "
in BaseImage (created by ImageBackground)
in RCTView (created by View)
in View (created by ImageBackground)
....

@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@react-native-botreact-native-bot added the Stale There has been a lack of activity on this issue and it may be closed soon. label Jul 24, 2024
@react-native-bot

Copy link
Copy Markdown
Collaborator

This PR was closed because it has been stalled for 7 days with no activity.

@tido64
tido64 deleted the tido/build-assets-registry branch February 11, 2025 12:58
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.p: MicrosoftPartner: MicrosoftPartnerShared with MetaApplied via automation to indicate that an Issue or Pull Request has been shared with the team.StaleThere has been a lack of activity on this issue and it may be closed soon.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@tido64@analysis-bot@cortinico@zhairui@react-native-bot@huntie@facebook-github-bot