Title: ngc does not handle barrel files properly in many situations · Issue #33121 · angular/angular · GitHub
Open Graph Title: ngc does not handle barrel files properly in many situations · Issue #33121 · angular/angular
X Title: ngc does not handle barrel files properly in many situations · Issue #33121 · angular/angular
Description: 🐞 bug report Affected Package The issued is caused by package @angular/compiler-cli Is this a regression? No Description Note: PR #22856 by @jeffora lay the groundwork for proper barrel file support Right now, any path depth with barrel ...
Open Graph Description: 🐞 bug report Affected Package The issued is caused by package @angular/compiler-cli Is this a regression? No Description Note: PR #22856 by @jeffora lay the groundwork for proper barrel file suppor...
X Description: 🐞 bug report Affected Package The issued is caused by package @angular/compiler-cli Is this a regression? No Description Note: PR #22856 by @jeffora lay the groundwork for proper barrel file suppor...
Opengraph URL: https://github.com/angular/angular/issues/33121
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"ngc does not handle barrel files properly in many situations","articleBody":"# 🐞 bug report\r\n\r\n### Affected Package\r\nThe issued is caused by package @angular/compiler-cli\r\n\r\n### Is this a regression?\r\nNo\r\n\r\n### Description\r\nNote: PR #22856 by @jeffora lay the groundwork for proper barrel file support\r\n\r\nRight now, any path depth with barrel files fails because `MetadataBundler.resolveModuleName` and a few other methods do not keep track of the parent paths, mostly leading to intermediate paths disappearing.\r\n\r\nWith the following example, no decorator metadata gets added to metadata.json file, and the `MetadataBundler` processes `repro.module` as if it was at `src/repro.module.ts` rather than `src/lib/repro.module.ts` (because `path.dirname(from)` returns `.` for `./lib`, thus losing the path in the process when then joining with `repro.module`).\r\n\r\n\u003cpre>\u003ccode>\r\n// src/public-api.ts\r\nimport * from './lib';\r\n\r\n// src/lib/index.ts\r\nexport {ReproModule} from './repro.module';\r\n\r\n// src/lib/repro.module.ts\r\nimport {NgModule} from '@angular/core';\r\n@NgModule({})\r\nclass ReproModule;\r\nexport {ReproModule};\r\n\u003c/code>\u003c/pre>\r\n\r\nThis is only the case for metadata retrieval, the classes/etc. are properly exported. The metadata.json does not hold any metadata information though.\r\n\r\nWithout barrel files, the metadata.json file is (html tags removed):\r\n\r\n\u003cpre>\u003ccode>\r\n{\r\n \"__symbolic\": \"module\",\r\n \"version\": 4,\r\n \"metadata\": {\r\n \"ReproService\": {\r\n \"__symbolic\": \"class\",\r\n \"decorators\": [{\r\n \"__symbolic\": \"call\",\r\n \"expression\": {\r\n \"__symbolic\": \"reference\",\r\n \"module\": \"@angular/core\",\r\n \"name\": \"Injectable\",\r\n \"line\": 2,\r\n \"character\": 1\r\n },\r\n \"arguments\": [{\r\n \"providedIn\":\"root\"\r\n }]\r\n }],\r\n \"members\": {\r\n \"__ctor__\": [{\r\n \"__symbolic\": \"constructor\"\r\n }]\r\n },\r\n \"statics\": {\r\n \"ngInjectableDef\": {}\r\n }\r\n },\r\n ....\r\n}\r\n\u003c/code>\u003c/pre>\r\n\r\nWith barrel files, the metadata.json file is:\r\n\r\n\u003cpre>\u003ccode>\r\n{\r\n \"__symbolic\": \"module\",\r\n \"version\": 4,\r\n \"exports\": [{\r\n \"from\": \"./repro.service\"\r\n }, {\r\n \"from\": \"./repro.component\"\r\n }, {\r\n \"from\": \"./repro.module\"\r\n }],\r\n \"metadata\": {},\r\n \"origins\": {},\r\n \"importAs\": \"repro\"\r\n}\r\n\u003c/code>\u003c/pre>\r\n\r\n## 🔬 Minimal Reproduction\r\n\u003cpre>\u003ccode>\r\ngit clone https://github.com/rraziel/ngc-barrel-repo\r\ncd ngc-barrel-repo; npm i\r\nng build repro\r\ncat dist/repro/repro.metadata.json\r\n\u003c/code>\u003c/pre>\r\n\r\nThe project was created with:\r\n\u003cpre>\u003ccode>\r\nng new ngc-barrel-repro\r\nng generate library repro\r\nadd an index.ts next to repro.module.ts that exports what is exported from public-api.ts\r\nmodify public-api.ts to use index.ts implicitly\r\n\u003c/code>\u003c/pre>\r\n\r\nRelevant files:\r\n- https://github.com/rraziel/ngc-barrel-repo/blob/master/projects/repro/src/public-api.ts\r\n- https://github.com/rraziel/ngc-barrel-repo/blob/master/projects/repro/src/lib/index.ts\r\n\r\n## 🔥 Exception or Error\r\nThe generated *metadata.json file does not contain metadata information (e.g. the NgModule decorator).\r\nMany other issues can also arise depending on how files are imported and generally end up with undefined error messages (undefined module, duplicate undefined keys, etc.).\r\n\r\n## 🌍 Your Environment\r\n\r\n**Angular Version:**\r\n\u003cpre>\u003ccode>\r\nAngular CLI: 8.3.8\r\nNode: 11.8.0\r\nOS: win32 x64\r\nAngular: 8.2.10\r\n... animations, common, compiler, compiler-cli, core, forms\r\n... language-service, platform-browser, platform-browser-dynamic\r\n... router\r\n\r\nPackage Version\r\n------------------------------------------------------------\r\n@angular-devkit/architect 0.803.8\r\n@angular-devkit/build-angular 0.803.8\r\n@angular-devkit/build-ng-packagr 0.803.8\r\n@angular-devkit/build-optimizer 0.803.8\r\n@angular-devkit/build-webpack 0.803.8\r\n@angular-devkit/core 8.3.8\r\n@angular-devkit/schematics 8.3.8\r\n@angular/cdk 8.2.3\r\n@angular/cli 8.3.8\r\n@ngtools/webpack 8.3.8\r\n@schematics/angular 8.3.8\r\n@schematics/update 0.803.8\r\nng-packagr 5.6.1\r\nrxjs 6.5.3\r\ntypescript 3.5.3\r\nwebpack 4.39.2\r\n\u003c/code>\u003c/pre>\r\n\r\n**Anything else relevant?**\r\nThis issue makes it very difficult to work with a monorepo (unless going through all the files and manually appending index for all the barrel imports), especially with the current `module undefined` messages as I mostly end up commenting out imports until the build works. Or just adding a console.log with the module name to the bundler code.\r\n","author":{"url":"https://github.com/rraziel","@type":"Person","name":"rraziel"},"datePublished":"2019-10-12T05:00:36Z","url":"https://github.com/angular/angular/issues/33121"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:e68a369d-1845-c430-1dab-4f4e423ce437 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | E9A0:7A60E:A2B3DE:D3E621:6B00E5A4 |
| html-safe-nonce | b6fcc861dd41d4fb326efd9c5bbb5f7ba53be9ad19e81830851cd3e183551e21 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFOUEwOjdBNjBFOkEyQjNERTpEM0U2MjE6NkIwMEU1QTQiLCJ2aXNpdG9yX2lkIjoiNDI5NTQ0MzI5MTg0MDc2NzM5NyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 7d191ba0ab0dc0e2a384b75d1332b5d443ee703d3578f06db24c429231877e99 |
| hovercard-subject-tag | issue:506132820 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/angular/angular/33121/issue_layout |
| twitter:image | https://opengraph.githubassets.com/223a7ee8932931e45de9a760fa5613e8171570c3def0c685e3a8c723dc1b5a11/angular/angular/issues/33121 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/223a7ee8932931e45de9a760fa5613e8171570c3def0c685e3a8c723dc1b5a11/angular/angular/issues/33121 |
| og:image:alt | 🐞 bug report Affected Package The issued is caused by package @angular/compiler-cli Is this a regression? No Description Note: PR #22856 by @jeffora lay the groundwork for proper barrel file suppor... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | rraziel |
| hostname | github.com |
| expected-hostname | github.com |
| None | 27088b6977484d0d3321d9a11c907c6d6637b315cfa359ef7952dbf6292f9b14 |
| turbo-cache-control | no-preview |
| go-import | github.com/angular/angular git https://github.com/angular/angular.git |
| octolytics-dimension-user_id | 139426 |
| octolytics-dimension-user_login | angular |
| octolytics-dimension-repository_id | 24195339 |
| octolytics-dimension-repository_nwo | angular/angular |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 24195339 |
| octolytics-dimension-repository_network_root_nwo | angular/angular |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 624179fb8b88d26ba5bba08894eb60a1c5a1d93d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width