Unverified Commit fcfaf737 authored by vercel-fleet-prod[bot]'s avatar vercel-fleet-prod[bot] Committed by GitHub

test: make Turbopack portability snapshots deterministic in CI

Co-authored-by: 's avatarTobias Koppers <1365881+sokra@users.noreply.github.com>
parent 26ef468d
import { FileRef, nextTestSetup } from 'e2e-utils' import { FileRef, nextTestSetup } from 'e2e-utils'
import fs from 'fs/promises' import fs from 'fs/promises'
import path from 'path' import path from 'path'
import { getPnpmRealpathWorkaround } from '../../../lib/pnpm-realpath-workaround'
import { import {
executedFunctionNames, executedFunctionNames,
readTaskExecutions, readTaskExecutions,
type TaskExecution, type TaskExecution,
} from './turbo-tasks-trace' } from './turbo-tasks-trace'
// Always install with pnpm's hoisted linker, so the package layout (and with it
// which symlinks are resolved) doesn't depend on the Node.js version. This is
// the layout the Node.js realpath workaround (`getPnpmRealpathWorkaround`)
// uses on affected versions anyway.
const hoistedInstall = { 'pnpm-workspace.yaml': 'nodeLinker: hoisted\n' }
// Cache Components (enabled in CI's experimental runs) reads additional config
// values, so the moved builds have a separate snapshot for it.
const isCacheComponents = process.env.__NEXT_CACHE_COMPONENTS === 'true'
// The Turbopack filesystem cache for `next build` should be portable: moving // The Turbopack filesystem cache for `next build` should be portable: moving
// the project to another directory must not invalidate it. // the project to another directory must not invalidate it.
// //
...@@ -33,7 +42,7 @@ describe('turbopack-portable-build-cache', () => { ...@@ -33,7 +42,7 @@ describe('turbopack-portable-build-cache', () => {
describe('minimal app', () => { describe('minimal app', () => {
const { next } = nextTestSetup({ const { next } = nextTestSetup({
files: path.join(__dirname, 'fixtures/minimal'), files: path.join(__dirname, 'fixtures/minimal'),
overrideFiles: getPnpmRealpathWorkaround(), overrideFiles: hoistedInstall,
skipStart: true, skipStart: true,
}) })
...@@ -48,7 +57,6 @@ describe('turbopack-portable-build-cache', () => { ...@@ -48,7 +57,6 @@ describe('turbopack-portable-build-cache', () => {
[ [
"<DiskFileSystem as FileSystem>::raw_read_dir", "<DiskFileSystem as FileSystem>::raw_read_dir",
"<DiskFileSystem as FileSystem>::read", "<DiskFileSystem as FileSystem>::read",
"<DiskFileSystem as FileSystem>::read_link",
"ProjectContainer::project", "ProjectContainer::project",
"emit_all_output_assets_once_with_issues_operation", "emit_all_output_assets_once_with_issues_operation",
"get_all_written_entrypoints_with_issues_operation", "get_all_written_entrypoints_with_issues_operation",
...@@ -59,11 +67,119 @@ describe('turbopack-portable-build-cache', () => { ...@@ -59,11 +67,119 @@ describe('turbopack-portable-build-cache', () => {
await moveProject(next, next.testDir) await moveProject(next, next.testDir)
const movedExecutions = (await tracedBuild(next)).executions const movedExecutions = (await tracedBuild(next)).executions
expect(executedFunctionNames(movedExecutions)).toMatchInlineSnapshot(` const movedNames = executedFunctionNames(movedExecutions)
if (isCacheComponents) {
expect(movedNames).toMatchInlineSnapshot(`
[
"<DiskFileSystem as FileSystem>::raw_read_dir",
"<DiskFileSystem as FileSystem>::read",
"<DiskFileSystem as FileSystem>::write",
"<DiskFileSystem as turbo_tasks :: ValueToString>::to_string",
"<NftJsonAsset as Asset>::content",
"<ServerNftJsonAsset as Asset>::content",
"DiskFileSystem::new_internal",
"NextConfig::asset_suffix_path",
"NextConfig::base_path",
"NextConfig::bundle_pages_router_dependencies",
"NextConfig::cache_handler",
"NextConfig::cache_handlers",
"NextConfig::cache_kinds",
"NextConfig::client_source_maps",
"NextConfig::client_static_folder_name",
"NextConfig::compiler",
"NextConfig::computed_asset_prefix",
"NextConfig::config_file_path",
"NextConfig::cross_origin",
"NextConfig::css_chunking",
"NextConfig::dist_dir",
"NextConfig::dist_dir_root",
"NextConfig::enable_cache_components",
"NextConfig::enable_concurrent_router_queue",
"NextConfig::enable_durable_use_cache_entries",
"NextConfig::enable_expose_testing_api_in_production_build",
"NextConfig::enable_immutable_assets",
"NextConfig::enable_react_production_profiling",
"NextConfig::enable_taint",
"NextConfig::enable_use_cache",
"NextConfig::enable_use_cache_static_root_param_tracking",
"NextConfig::experimental_sri",
"NextConfig::experimental_swc_env_options",
"NextConfig::experimental_swc_plugins",
"NextConfig::experimental_turbopack_local_postcss_config",
"NextConfig::experimental_turbopack_use_builtin_babel",
"NextConfig::experimental_turbopack_use_builtin_sass",
"NextConfig::explicit_parallel_route_children",
"NextConfig::from_string",
"NextConfig::image_config",
"NextConfig::import_externals",
"NextConfig::inline_css",
"NextConfig::instrumentation_client_inject",
"NextConfig::is_global_not_found_enabled",
"NextConfig::is_standalone",
"NextConfig::is_using_adapter",
"NextConfig::lightningcss_feature_flags",
"NextConfig::mdx_rs",
"NextConfig::modularize_imports",
"NextConfig::module_fragments_enabled_for_foreign_code",
"NextConfig::module_fragments_enabled_for_user_code",
"NextConfig::module_ids",
"NextConfig::optimize_package_imports",
"NextConfig::output",
"NextConfig::output_file_tracing_excludes",
"NextConfig::output_file_tracing_includes",
"NextConfig::output_hash_salt",
"NextConfig::page_extensions",
"NextConfig::react_compiler_options",
"NextConfig::report_system_env_inlining",
"NextConfig::resolve_alias_options",
"NextConfig::resolve_extension",
"NextConfig::rust_react_compiler",
"NextConfig::sass_config",
"NextConfig::server_external_packages",
"NextConfig::server_source_maps",
"NextConfig::should_append_server_deployment_id_at_runtime",
"NextConfig::strict_route_matching",
"NextConfig::transpile_packages",
"NextConfig::turbo_client_minify",
"NextConfig::turbo_nested_async_chunking",
"NextConfig::turbo_scope_hoisting",
"NextConfig::turbo_server_minify",
"NextConfig::turbo_shared_runtime",
"NextConfig::turbopack_chunk_loading_global",
"NextConfig::turbopack_chunking",
"NextConfig::turbopack_cjs_scope_hoisting",
"NextConfig::turbopack_cjs_tree_shaking",
"NextConfig::turbopack_cross_module_constants",
"NextConfig::turbopack_debug_ids",
"NextConfig::turbopack_generate_component_chunks",
"NextConfig::turbopack_ignore_issue_rules",
"NextConfig::turbopack_import_type_bytes",
"NextConfig::turbopack_infer_module_side_effects",
"NextConfig::turbopack_lazy_dynamic_imports",
"NextConfig::turbopack_lazy_dynamic_imports_ssr",
"NextConfig::turbopack_mangle_export_names",
"NextConfig::turbopack_mangle_via_materialized_namespace_object",
"NextConfig::turbopack_plugin_runtime_strategy",
"NextConfig::turbopack_remove_unused_exports",
"NextConfig::turbopack_remove_unused_imports",
"NextConfig::turbopack_worker_asset_prefix",
"NextConfig::typescript_tsconfig_path",
"NextConfig::use_react_experimental",
"NextConfig::webpack_rules",
"ProjectContainer::project",
"emit_all_output_assets_once_with_issues_operation",
"get_all_written_entrypoints_with_issues_operation",
"inner_entrypoints_without_collectibles_operation",
"project_root_path_operation",
"uppercase_env_map",
]
`)
return
}
expect(movedNames).toMatchInlineSnapshot(`
[ [
"<DiskFileSystem as FileSystem>::raw_read_dir", "<DiskFileSystem as FileSystem>::raw_read_dir",
"<DiskFileSystem as FileSystem>::read", "<DiskFileSystem as FileSystem>::read",
"<DiskFileSystem as FileSystem>::read_link",
"<DiskFileSystem as FileSystem>::write", "<DiskFileSystem as FileSystem>::write",
"<DiskFileSystem as turbo_tasks :: ValueToString>::to_string", "<DiskFileSystem as turbo_tasks :: ValueToString>::to_string",
"<NftJsonAsset as Asset>::content", "<NftJsonAsset as Asset>::content",
...@@ -128,8 +244,6 @@ describe('turbopack-portable-build-cache', () => { ...@@ -128,8 +244,6 @@ describe('turbopack-portable-build-cache', () => {
"NextConfig::server_external_packages", "NextConfig::server_external_packages",
"NextConfig::server_source_maps", "NextConfig::server_source_maps",
"NextConfig::should_append_server_deployment_id_at_runtime", "NextConfig::should_append_server_deployment_id_at_runtime",
"NextConfig::skip_proxy_url_normalize",
"NextConfig::skip_trailing_slash_redirect",
"NextConfig::strict_route_matching", "NextConfig::strict_route_matching",
"NextConfig::transpile_packages", "NextConfig::transpile_packages",
"NextConfig::turbo_client_minify", "NextConfig::turbo_client_minify",
...@@ -194,7 +308,7 @@ describe('turbopack-portable-build-cache', () => { ...@@ -194,7 +308,7 @@ describe('turbopack-portable-build-cache', () => {
'../../packages': new FileRef(path.join(fixture, 'packages')), '../../packages': new FileRef(path.join(fixture, 'packages')),
}, },
subDir: 'apps/web', subDir: 'apps/web',
overrideFiles: getPnpmRealpathWorkaround(), overrideFiles: hoistedInstall,
skipStart: true, skipStart: true,
}) })
...@@ -283,7 +397,124 @@ describe('turbopack-portable-build-cache', () => { ...@@ -283,7 +397,124 @@ describe('turbopack-portable-build-cache', () => {
await moveProject(next, workspaceRoot()) await moveProject(next, workspaceRoot())
const moved = await tracedBuild(next) const moved = await tracedBuild(next)
await expectAllFeatures(moved.cliOutput) await expectAllFeatures(moved.cliOutput)
expect(executedFunctionNames(moved.executions)).toMatchInlineSnapshot(` const movedNames = executedFunctionNames(moved.executions)
if (isCacheComponents) {
expect(movedNames).toMatchInlineSnapshot(`
[
"<DiskFileSystem as FileSystem>::raw_read_dir",
"<DiskFileSystem as FileSystem>::read",
"<DiskFileSystem as FileSystem>::read_link",
"<DiskFileSystem as FileSystem>::write",
"<DiskFileSystem as turbo_tasks :: ValueToString>::to_string",
"<EnvMap as ProcessEnv>::read_all",
"<NftJsonAsset as Asset>::content",
"<ServerNftJsonAsset as Asset>::content",
"DiskFileSystem::new_internal",
"NextConfig::asset_suffix_path",
"NextConfig::base_path",
"NextConfig::bundle_pages_router_dependencies",
"NextConfig::cache_handler",
"NextConfig::cache_handlers",
"NextConfig::cache_kinds",
"NextConfig::client_source_maps",
"NextConfig::client_static_folder_name",
"NextConfig::compiler",
"NextConfig::computed_asset_prefix",
"NextConfig::config_file_path",
"NextConfig::cross_origin",
"NextConfig::css_chunking",
"NextConfig::dist_dir",
"NextConfig::dist_dir_root",
"NextConfig::enable_cache_components",
"NextConfig::enable_concurrent_router_queue",
"NextConfig::enable_durable_use_cache_entries",
"NextConfig::enable_expose_testing_api_in_production_build",
"NextConfig::enable_immutable_assets",
"NextConfig::enable_react_production_profiling",
"NextConfig::enable_taint",
"NextConfig::enable_use_cache",
"NextConfig::enable_use_cache_static_root_param_tracking",
"NextConfig::experimental_sri",
"NextConfig::experimental_swc_env_options",
"NextConfig::experimental_swc_plugins",
"NextConfig::experimental_turbopack_local_postcss_config",
"NextConfig::experimental_turbopack_use_builtin_babel",
"NextConfig::experimental_turbopack_use_builtin_sass",
"NextConfig::explicit_parallel_route_children",
"NextConfig::from_string",
"NextConfig::i18n",
"NextConfig::image_config",
"NextConfig::import_externals",
"NextConfig::inline_css",
"NextConfig::instrumentation_client_inject",
"NextConfig::is_global_not_found_enabled",
"NextConfig::is_standalone",
"NextConfig::is_using_adapter",
"NextConfig::lightningcss_feature_flags",
"NextConfig::mdx_rs",
"NextConfig::modularize_imports",
"NextConfig::module_fragments_enabled_for_foreign_code",
"NextConfig::module_fragments_enabled_for_user_code",
"NextConfig::module_ids",
"NextConfig::optimize_package_imports",
"NextConfig::output",
"NextConfig::output_file_tracing_excludes",
"NextConfig::output_file_tracing_includes",
"NextConfig::output_hash_salt",
"NextConfig::page_extensions",
"NextConfig::react_compiler_options",
"NextConfig::report_system_env_inlining",
"NextConfig::resolve_alias_options",
"NextConfig::resolve_extension",
"NextConfig::rust_react_compiler",
"NextConfig::sass_config",
"NextConfig::server_external_packages",
"NextConfig::server_source_maps",
"NextConfig::should_append_server_deployment_id_at_runtime",
"NextConfig::strict_route_matching",
"NextConfig::transpile_packages",
"NextConfig::turbo_client_minify",
"NextConfig::turbo_edge_minify",
"NextConfig::turbo_nested_async_chunking",
"NextConfig::turbo_scope_hoisting",
"NextConfig::turbo_server_minify",
"NextConfig::turbo_shared_runtime",
"NextConfig::turbopack_chunk_loading_global",
"NextConfig::turbopack_chunking",
"NextConfig::turbopack_cjs_scope_hoisting",
"NextConfig::turbopack_cjs_tree_shaking",
"NextConfig::turbopack_cross_module_constants",
"NextConfig::turbopack_debug_ids",
"NextConfig::turbopack_generate_component_chunks",
"NextConfig::turbopack_ignore_issue_rules",
"NextConfig::turbopack_import_type_bytes",
"NextConfig::turbopack_infer_module_side_effects",
"NextConfig::turbopack_lazy_dynamic_imports",
"NextConfig::turbopack_lazy_dynamic_imports_ssr",
"NextConfig::turbopack_mangle_export_names",
"NextConfig::turbopack_mangle_via_materialized_namespace_object",
"NextConfig::turbopack_plugin_runtime_strategy",
"NextConfig::turbopack_remove_unused_exports",
"NextConfig::turbopack_remove_unused_imports",
"NextConfig::turbopack_worker_asset_prefix",
"NextConfig::typescript_tsconfig_path",
"NextConfig::use_react_experimental",
"NextConfig::webpack_rules",
"ProjectContainer::project",
"common_node_env",
"create_evaluate_pool_assets_operation",
"emit_all_output_assets_once_with_issues_operation",
"evaluate_webpack_loader",
"get_all_written_entrypoints_with_issues_operation",
"get_evaluate_pool",
"inner_entrypoints_without_collectibles_operation",
"project_root_path_operation",
"uppercase_env_map",
]
`)
return
}
expect(movedNames).toMatchInlineSnapshot(`
[ [
"<DiskFileSystem as FileSystem>::raw_read_dir", "<DiskFileSystem as FileSystem>::raw_read_dir",
"<DiskFileSystem as FileSystem>::read", "<DiskFileSystem as FileSystem>::read",
...@@ -354,8 +585,6 @@ describe('turbopack-portable-build-cache', () => { ...@@ -354,8 +585,6 @@ describe('turbopack-portable-build-cache', () => {
"NextConfig::server_external_packages", "NextConfig::server_external_packages",
"NextConfig::server_source_maps", "NextConfig::server_source_maps",
"NextConfig::should_append_server_deployment_id_at_runtime", "NextConfig::should_append_server_deployment_id_at_runtime",
"NextConfig::skip_proxy_url_normalize",
"NextConfig::skip_trailing_slash_redirect",
"NextConfig::strict_route_matching", "NextConfig::strict_route_matching",
"NextConfig::transpile_packages", "NextConfig::transpile_packages",
"NextConfig::turbo_client_minify", "NextConfig::turbo_client_minify",
...@@ -413,6 +642,9 @@ const env = { ...@@ -413,6 +642,9 @@ const env = {
// server-action-dependent work, depending on the environment. // server-action-dependent work, depending on the environment.
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: NEXT_SERVER_ACTIONS_ENCRYPTION_KEY:
'cG9ydGFibGUtYnVpbGQtY2FjaGUtdGVzdC1rZXktMzI=', 'cG9ydGFibGUtYnVpbGQtY2FjaGUtdGVzdC1rZXktMzI=',
// Build telemetry reads additional config values, which would make the
// snapshots depend on whether telemetry is enabled.
NEXT_TELEMETRY_DISABLED: '1',
} }
type Next = ReturnType<typeof nextTestSetup>['next'] type Next = ReturnType<typeof nextTestSetup>['next']
......
...@@ -1720,8 +1720,8 @@ impl FileSystem for DiskFileSystem { ...@@ -1720,8 +1720,8 @@ impl FileSystem for DiskFileSystem {
// The error is part of this task's output. Use the location-independent path instead // The error is part of this task's output. Use the location-independent path instead
// of the absolute one, so that the output doesn't change when the project is moved. // of the absolute one, so that the output doesn't change when the project is moved.
Err(err) => { Err(err) => {
return Err(anyhow::Error::new(err) let message = turbofmt!("reading metadata for {fs_path}").await?;
.context(turbofmt!("reading metadata for {fs_path}").await?)); return Err(anyhow::Error::new(err).context(message));
} }
}; };
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment