Title: Typescript generator function assumes asynchronous global Promise · Issue #19909 · microsoft/TypeScript · GitHub
Open Graph Title: Typescript generator function assumes asynchronous global Promise · Issue #19909 · microsoft/TypeScript
X Title: Typescript generator function assumes asynchronous global Promise · Issue #19909 · microsoft/TypeScript
Description: This may sound like a silly report -- please bear with me (: I'm the author of synchronous-promise, an A+ Promise-like implementation which doesn't defer (and allows pausing and resuming), so makes testing certain scenarios clearer / eas...
Open Graph Description: This may sound like a silly report -- please bear with me (: I'm the author of synchronous-promise, an A+ Promise-like implementation which doesn't defer (and allows pausing and resuming), so makes...
X Description: This may sound like a silly report -- please bear with me (: I'm the author of synchronous-promise, an A+ Promise-like implementation which doesn't defer (and allows pausing and resuming), ...
Opengraph URL: https://github.com/microsoft/TypeScript/issues/19909
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Typescript generator function assumes asynchronous global Promise","articleBody":"This may sound like a silly report -- please bear with me (:\r\n\r\nI'm the author of [synchronous-promise](https://github.com/fluffynuts/synchronous-promise), an A+ Promise-_like_ implementation which doesn't defer (and allows pausing and resuming), so makes testing certain scenarios clearer / easier. Mostly, it's worked well with TypeScript because of how awesome TypeScript's async/await logic is.\r\n\r\nThe problem is _very_ specific is this: if `SynchronousPromise` is installed globally (overriding `Promise` -- and we could do this so that client code returning a `Promise` actually returns a `SynchronousPromise`, during test-time), _and_ a `SynchronousPromise` resolution happens in a `setTimeout`, the TS generator function also makes use of `SynchronousPromise` and doesn't complete awaiting the following:\r\n\r\n```ts\r\nimport { SynchronousPromise } from \"./index\";\r\nimport { expect } from 'chai';\r\n\r\n// install SynchronousPromise globally\r\nglobal.Promise = SynchronousPromise;\r\n\r\ndescribe(\"typescript async/await\", () => {\r\n it(\"should not hang\", async function() {\r\n // Arrange\r\n // Act\r\n await new SynchronousPromise(function(resolve, reject) {\r\n setTimeout(() => {\r\n resolve(\"done!\");\r\n }, 0);\r\n });\r\n })\r\n});\r\n```\r\n\r\nThe problem seems to track down to the generated `generator` code which expects a `P` (short-handed global `Promise`) to defer. If I comment out the line:\r\n```ts\r\n// global.Promise = SynchronousPromise;\r\n```\r\nthen the test completes, as expected.\r\n\r\nNow, I realise that there is a valid argument that `SynchronousPromise`, being _not_ async in nature, violates the A+ specification and that this whole issue shouldn't be the problem of TypeScript at all. This is a fair argument, which has a counter-argument: that all TypeScript is a super-set of Javascript. The following Javascript works fine:\r\n```js\r\n\"use strict\";\r\nvar\r\n expect = require(\"chai\").expect,\r\n sut = require(\"./index\"),\r\n SynchronousPromise = sut.SynchronousPromise,\r\ndescribe(\"with timeout in ctor\", () => {\r\n it(\"should complete when the timeout does\", (done) => {\r\n // Arrange\r\n var\r\n captured,\r\n sut = new SynchronousPromise(function(resolve, reject) {\r\n setTimeout(function() {\r\n resolve(\"moo\");\r\n }, 0);\r\n }).then(function(result) {\r\n captured = result;\r\n });\r\n // Act\r\n // Assert\r\n setTimeout(function() {\r\n expect(captured).to.equal(\"moo\");\r\n done();\r\n }, 500);\r\n });\r\n});\r\n```\r\n\r\nAnd debugging the prior snippet has shown that all promises (even the TS-generated / wrapper ones created for async/await) are resolved. Execution is simply not continued by the generator.\r\n\r\n**Expected behavior:**\r\nThe first snippet (TypeScript) should complete like the second snippet (Javascript)\r\n\r\n**Actual behavior:**\r\nThe Javascript completes where the TypeScript does not\r\n\r\n**Proposed solutions.**\r\n1) Since the generator function requires deferral, perhaps use `setTimeout` -- however, this is subject to the same problems as testing frameworks like `jasmine` can install a testing clock which has to be manually advanced by the test code.\r\n2) \"var off\" the global Promise implementation before allowing client code to run and use that version inside the generator code. This seems to be the lowest-hanging fruit for solving this problem, from my point of view.\r\n\r\nOf course, the response could also be that this is just an issue with `synchronous-promise`, but it also highlights that TS compiled execution can be interfered with by client code -- which may not be optimal.\r\n","author":{"url":"https://github.com/fluffynuts","@type":"Person","name":"fluffynuts"},"datePublished":"2017-11-10T13:47:46Z","url":"https://github.com/microsoft/TypeScript/issues/19909"}
| 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:00ec965d-90e6-993b-daa2-319f66b44567 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | EA78:2564D8:81DC76:AE2320:6B00DD31 |
| html-safe-nonce | c2ac6086349b2de75fd31c68ef30550f05dbd8b57a3e67c03c266a181e79fb1e |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFQTc4OjI1NjREODo4MURDNzY6QUUyMzIwOjZCMDBERDMxIiwidmlzaXRvcl9pZCI6IjYzMjk3Mzc2NjM3Nzk3NTczNjIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | b64ed9c8a269e831fbad5464fe2ddb9a0eb7ad9f983b39133243093686b49cc3 |
| hovercard-subject-tag | issue:272937619 |
| 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/19909/issue_layout |
| twitter:image | https://opengraph.githubassets.com/885a92faa48778179dec487ff11ecc02e6d02b1c870376aff784bcf0765e97c9/microsoft/TypeScript/issues/19909 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/885a92faa48778179dec487ff11ecc02e6d02b1c870376aff784bcf0765e97c9/microsoft/TypeScript/issues/19909 |
| og:image:alt | This may sound like a silly report -- please bear with me (: I'm the author of synchronous-promise, an A+ Promise-like implementation which doesn't defer (and allows pausing and resuming), so makes... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | fluffynuts |
| hostname | github.com |
| expected-hostname | github.com |
| None | 043c3f30fbcbe2c6c8e729e10cbbbc90c406546f9fbbb67c648d38f6b7d16daf |
| 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 | 5425dc24e8bd8d6fca9641a12afc984825a43875 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width