Title: emitDecoratorMetadata should emit type resolvers · Issue #41201 · microsoft/TypeScript · GitHub
Open Graph Title: emitDecoratorMetadata should emit type resolvers · Issue #41201 · microsoft/TypeScript
X Title: emitDecoratorMetadata should emit type resolvers · Issue #41201 · microsoft/TypeScript
Description: TypeScript Version: 4.1.0-dev.20201022 Search Terms: emitDecoratorMetadata, decorators, design:type, type, resolver, reflection Code: Suppose we are doing Node.js code and have a plain old circular dependency: classOne.ts import { proper...
Open Graph Description: TypeScript Version: 4.1.0-dev.20201022 Search Terms: emitDecoratorMetadata, decorators, design:type, type, resolver, reflection Code: Suppose we are doing Node.js code and have a plain old circular...
X Description: TypeScript Version: 4.1.0-dev.20201022 Search Terms: emitDecoratorMetadata, decorators, design:type, type, resolver, reflection Code: Suppose we are doing Node.js code and have a plain old circular...
Opengraph URL: https://github.com/microsoft/TypeScript/issues/41201
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"emitDecoratorMetadata should emit type resolvers","articleBody":"**TypeScript Version:** 4.1.0-dev.20201022\r\n\r\n\u003c!-- Search terms you tried before logging this (so others can find this issue more easily) -->\r\n**Search Terms:** emitDecoratorMetadata, decorators, design:type, type, resolver, reflection\r\n\r\n**Code:**\r\n\r\nSuppose we are doing [Node.js](https://nodejs.org/en/) code and have a plain old circular dependency: \r\n#### **`classOne.ts`**\r\n```ts\r\nimport { property } from './utils';\r\nimport ClassTwo from './classTwo';\r\n\r\nexport default class ClassOne {\r\n @property\r\n property: ClassTwo;\r\n}\r\n```\r\n#### **`classTwo.ts`**\r\n```ts\r\nimport { property } from './utils';\r\nimport ClassOne from './classOne';\r\n\r\nexport default class ClassTwo {\r\n @property\r\n property: ClassOne;\r\n}\r\n```\r\nand suppose we want to bring a bit of reflection in our code:\r\n\r\n#### **`index.ts`**\r\n```ts\r\nimport 'reflect-metadata';\r\nimport { getDesignType } from './utils';\r\nimport ClassOne from './classOne';\r\nimport ClassTwo from './classTwo';\r\n\r\nconsole.log(`Hello World! ${ClassOne.name} and ${ClassTwo.name};)`);\r\n\r\nconsole.log(`--`);\r\n\r\nconsole.log(`${ClassOne.name} property is of type ${getDesignType(ClassOne, 'property')}`);\r\nconsole.log(`${ClassTwo.name} property is of type ${getDesignType(ClassTwo, 'property')}`);\r\n```\r\n#### **`utils.ts`**\r\n```ts\r\n/**\r\n * Use typescript emited metadata to get the type\r\n *\r\n * @param ctor\r\n * @param key\r\n */\r\nexport const getDesignType = (ctor: Function, key: string) => {\r\n const type = Reflect.getMetadata('design:type', ctor.prototype, key);\r\n return type?.name;\r\n}\r\n\r\n/**\r\n * Dummy decorator\r\n *\r\n * @param target\r\n * @param key\r\n */\r\nexport const property = (target: any, key: string) => { }\r\n```\r\n\r\n**Expected behavior:**\r\n```console\r\nfoo@bar:~$ node ./dist\r\nHello World! ClassOne and ClassTwo;)\r\n--\r\nClassOne property is of type ClassTwo\r\nClassTwo property is of type ClassOne\r\n```\r\n**Actual behavior:**\r\n```console\r\nfoo@bar:~$ node ./dist\r\nHello World! ClassOne and ClassTwo;)\r\n--\r\nClassOne property is of type ClassTwo\r\nClassTwo property is of type undefined\r\n```\r\n**Explanation:**\r\n\r\nWell it's not much a surprise, we are running into a circular import issue:\r\n- **index.ts** is importing **ClassOne**\r\n- **ClassOne** is importing **ClassTwo**\r\n- **ClassTwo** is importing **ClassOne**\r\n- Since ClassOne is being read, return the **cached value** of ClassOne\r\n- `__metadata(\"design:type\", classOne_1.default) ` is evaluated\r\n- `classOne_1.default` is evaluated to **undefined**\r\n- ...\r\n\r\n**Workaround:**\r\n\r\nThere is a simple workaround and it's already used by many libraries but unfortunately not by typescript. The idea is not to emit the type but to emit a **type resolver** ie. instead of emitting `ClassFoo` one should emit `() => ClassFoo`. This way we can evaluate the **type resolver** in _index.ts_ at a time where **ClassOne** import is already done.\r\n\r\n**Playground Link:** \u003c!-- A link to a TypeScript Playground \"Share\" link which demonstrates this behavior -->\r\n\r\nhttps://github.com/paeolo/typescript-emit-resolver\r\n\r\n**Related Issues:** \u003c!-- Did you find other bugs that looked similar? -->\r\n\r\nThis issue is the root of many issues. Solving this will enable a much better code where reflection is used by not introducing the type resolver as a redondancy.\r\n\r\nPlease note that trying to solve the circular import is not a good solution. Sometimes circular import are inherents and it's very hard to both focus on code and trying to solve every \"circular import\" related problems. tslib would benefit a lot from being more resilient to such issues.","author":{"url":"https://github.com/paeolo","@type":"Person","name":"paeolo"},"datePublished":"2020-10-22T18:12:53Z","url":"https://github.com/microsoft/TypeScript/issues/41201"}
| 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:af2ee80b-0c22-f5bb-dedd-a607ba1f252e |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 94FC:399E4B:2E885D9:3DCCD7B:6B01CE1F |
| html-safe-nonce | b5d14e900b191c7aa4d7d3488de6a7a026d9897ef703366338ced1193ae9b631 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5NEZDOjM5OUU0QjoyRTg4NUQ5OjNEQ0NEN0I6NkIwMUNFMUYiLCJ2aXNpdG9yX2lkIjoiMzExNDQ3MTYzMDcwMTcxMDg3OSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 5ce14b0dba1537761dbf85b8459eeafc6adc93ffb79409e3d9868d10970f713a |
| hovercard-subject-tag | issue:727613841 |
| 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/microsoft/TypeScript/41201/issue_layout |
| twitter:image | https://opengraph.githubassets.com/69edd9d1b30ef4eb68d799d9e51a7e8eaa8ab20578904c5c191ef38e6a1ae5d4/microsoft/TypeScript/issues/41201 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/69edd9d1b30ef4eb68d799d9e51a7e8eaa8ab20578904c5c191ef38e6a1ae5d4/microsoft/TypeScript/issues/41201 |
| og:image:alt | TypeScript Version: 4.1.0-dev.20201022 Search Terms: emitDecoratorMetadata, decorators, design:type, type, resolver, reflection Code: Suppose we are doing Node.js code and have a plain old circular... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | paeolo |
| hostname | github.com |
| expected-hostname | github.com |
| None | cc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c |
| turbo-cache-control | no-preview |
| go-import | github.com/microsoft/TypeScript git https://github.com/microsoft/TypeScript.git |
| octolytics-dimension-user_id | 6154722 |
| octolytics-dimension-user_login | microsoft |
| octolytics-dimension-repository_id | 20929025 |
| octolytics-dimension-repository_nwo | microsoft/TypeScript |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 20929025 |
| octolytics-dimension-repository_network_root_nwo | microsoft/TypeScript |
| 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 | 8c77c9e8439031ad54c75a250694842892f693e1 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width