René's URL Explorer Experiment


Title: "Isolated" annotation for functions that only act on inputs (distinct from 'pure') · Issue #39949 · microsoft/TypeScript · GitHub

Open Graph Title: "Isolated" annotation for functions that only act on inputs (distinct from 'pure') · Issue #39949 · microsoft/TypeScript

X Title: "Isolated" annotation for functions that only act on inputs (distinct from 'pure') · Issue #39949 · microsoft/TypeScript

Description: Search Terms pure isolated functional testing functions Suggestion I'd like to be able to assert that a function is isolated, which I define as "acts only on arguments passed in as inputs". Isolated functions can be extracted more easily...

Open Graph Description: Search Terms pure isolated functional testing functions Suggestion I'd like to be able to assert that a function is isolated, which I define as "acts only on arguments passed in as inputs". Isolate...

X Description: Search Terms pure isolated functional testing functions Suggestion I'd like to be able to assert that a function is isolated, which I define as "acts only on arguments passed in as inputs&...

Opengraph URL: https://github.com/microsoft/TypeScript/issues/39949

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"\"Isolated\" annotation for functions that only act on inputs (distinct from 'pure')","articleBody":"\u003c!-- 🚨 STOP 🚨 𝗦𝗧𝗢𝗣 🚨 𝑺𝑻𝑶𝑷 🚨\r\n\r\nHalf of all issues filed here are duplicates, answered in the FAQ, or not appropriate for the bug tracker.\r\n\r\nPlease help us by doing the following steps before logging an issue:\r\n  * Search: https://github.com/Microsoft/TypeScript/search?type=Issues\r\n  * Read the FAQ, especially the \"Common Feature Requests\" section: https://github.com/Microsoft/TypeScript/wiki/FAQ\r\n\r\n-->\r\n\r\n## Search Terms\r\n\r\n\u003c!-- List of keywords you searched for before creating this issue. Write them down here so that others can find this suggestion more easily -->\r\npure\r\nisolated\r\nfunctional\r\ntesting\r\nfunctions\r\n\r\n## Suggestion\r\n\r\nI'd like to be able to assert that a function is `isolated`, which I define as \"acts only on arguments passed in as inputs\". Isolated functions can be extracted more easily during refactors and can be tested in isolation from the rest of the codebase, opening the door to things like doctests.\r\n\r\nA function that applies inherited scope to arguments cannot be `isolated`. If you're using jquery for instance, you'd want to pass `$` in as an argument to your isolated functions even if it's available in the global scope.\r\n\r\n**NOTE**: Claiming that a function is `isolated` is not the same thing as claiming that it's `pure`. At first glimpse they seem like synonyms, but I don't see how a `pure` function is possible in javascript given that you can't control the side-effects of invoking methods on arguments, etc. Passing `$` in and then acting on it is by definition *NOT* a pure function, but we can still treat it as isolated! :)\r\n\r\nThe desired behavior is that if a function is annotated as `isolated` there'll be a compiler error thrown if it tries to access a value that's not one of its arguments.\r\n\r\n\r\n## Use Cases\r\n\r\n### Big Win: Easier Refactoring\r\nAn isolated function can be relocated into any source file without worrying about breaking its behavior by changing the scope it's situated in. It carries its own scope with it no matter where it lives. This opens the door too for interesting and novel approaches to the way code inhabits a filesystem. I'm imagining something like the Eve editor, where \"files\" are abstractions that may not be as helpful moving forward as they were in the past.\r\n\r\n### Bigger Win: Testing\r\nIf a function doesn't rely on external scope then testing it becomes trivial - every part of the function's behavior can be explored by tweaking input arguments. This not only makes the functions easier to test in the immediate case (simpler mocking, isolation etc) but also opens the door for things like doctests in the future. (see [Elixir's doctests](https://elixir-lang.org/getting-started/mix-otp/docs-tests-and-with.html#doctests) for an example of what I mean)\r\n\r\n## Examples\r\n\r\nThink of isolation as a less strict purity. Because this is javascript we can't control what happens when we e.g. call a method on an argument to our function. The runtime behavior is unpredictable enough that purity can't be guaranteed without adding significant runtime-breaking constraints.\r\n\r\nWhat we can do, though, is check to see if our function is only acting on inputs. \r\n```\r\n/*\r\n* @isolated \r\n*/\r\nfunction sum(x, y) { return x + y } // this works\r\n\r\n/*\r\n* @isolated\r\n*/\r\nfunction addX(value) { return value + x } // this throws a compiler error\r\n```\r\n\r\n### this\r\nAnything explicitly on `this` counts as an argument input, since you can always call/apply/bind to invoke it and pass a `this` value in. This would complicate refactoring if you're using prototypes, since you'd have to grab all references to the function not just the definition, but it still feels viable and useful to me?\r\n\r\nThis allows us to have the seeming contradiction of `isolated` methods on objects and instances, I _think_. There's probably some complexity here I'm not thinking about?\r\n```\r\n/*\r\n* @isolated \r\n*/\r\nfunction updateModel(delta) {\r\n  this.model.patch(delta)\r\n}\r\n\r\n// and elsewhere\r\n\r\nupdateThisModel = updateModel.bind(model)\r\n```\r\n\r\n### Existing code\r\nBecause this is an opt-in assertion there are no changes to existing codebases. Further, because the goal is to throw a compiler error when isolation is violated there's a happy path for incremental adoption within a codebase. A lot of core behavior should already be fairly isolated, and being able to make that assertion would bring a lot of new stability to the codebase.\r\n\r\n```\r\n/*\r\n* @isolated\r\n*/\r\nfunction myReducer(accumulator, value) { return accumulator.push(value * 2) }\r\n```\r\n\r\n### Purity (and its conspicuous absence)\r\nLet's look at the following isolated function, which just does some JQuery shenanigans. We can assert that this function is `isolated` because `$`, `selector` and `value` are all passed in as arguments. But this code isn't `pure` because invoking jQuery like this has side effects.\r\n\r\nWe still get the benefit of isolation, though, because now we know we can test this function and all we have to do is mock `$`.\r\n\r\n```\r\n/*\r\n* @isolated\r\n*/\r\nfunction setValue($, selector, value) { $(selector).value(value) }\r\n```\r\n\r\n\r\n## Checklist\r\n\r\nMy suggestion meets these guidelines:\r\n\r\n* [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code\r\n* [x] This wouldn't change the runtime behavior of existing JavaScript code\r\n* [x] This could be implemented without emitting different JS based on the types of the expressions\r\n* [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)\r\n* [x] This feature would agree with the rest of [TypeScript's Design Goals](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals).\r\n","author":{"url":"https://github.com/mbilokonsky","@type":"Person","name":"mbilokonsky"},"datePublished":"2020-08-07T15:41:35Z","url":"https://github.com/microsoft/TypeScript/issues/39949"}

react-profiling0
react-import-mapreact,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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:a9895c94-54d5-67d8-f98f-12358c143bd6
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idDC88:21BD98:2B5AAF1:370A02E:6B01E365
html-safe-nonced5485a9f854f5622252ffe288135e6cd69ea845370dcc756df0652e92788fdc4
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEQzg4OjIxQkQ5ODoyQjVBQUYxOjM3MEEwMkU6NkIwMUUzNjUiLCJ2aXNpdG9yX2lkIjoiODQ0NzIzMjE0OTMxMjEwMzI2OSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmacdd2ee2058623952839ffa0fec127bbbc6ae2a4a5b83e576de8c037f7b5774aec
hovercard-subject-tagissue:675098265
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/microsoft/TypeScript/39949/issue_layout
twitter:imagehttps://opengraph.githubassets.com/1e7e284ec5264211eeeb1eea261aeefc0b210052a9a8725c1a3ac34b2dffa909/microsoft/TypeScript/issues/39949
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/1e7e284ec5264211eeeb1eea261aeefc0b210052a9a8725c1a3ac34b2dffa909/microsoft/TypeScript/issues/39949
og:image:altSearch Terms pure isolated functional testing functions Suggestion I'd like to be able to assert that a function is isolated, which I define as "acts only on arguments passed in as inputs". Isolate...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamembilokonsky
hostnamegithub.com
expected-hostnamegithub.com
Nonecc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c
turbo-cache-controlno-preview
go-importgithub.com/microsoft/TypeScript git https://github.com/microsoft/TypeScript.git
octolytics-dimension-user_id6154722
octolytics-dimension-user_loginmicrosoft
octolytics-dimension-repository_id20929025
octolytics-dimension-repository_nwomicrosoft/TypeScript
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id20929025
octolytics-dimension-repository_network_root_nwomicrosoft/TypeScript
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release8c77c9e8439031ad54c75a250694842892f693e1
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/microsoft/TypeScript/issues/39949#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F39949
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F39949
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=microsoft%2FTypeScript
Reloadhttps://github.com/microsoft/TypeScript/issues/39949
Reloadhttps://github.com/microsoft/TypeScript/issues/39949
Reloadhttps://github.com/microsoft/TypeScript/issues/39949
microsofthttps://github.com/microsoft
TypeScripthttps://github.com/microsoft/TypeScript
Codehttps://github.com/microsoft/TypeScript
Issues5k (5k)https://github.com/microsoft/TypeScript/issues
Pull requests312 (312)https://github.com/microsoft/TypeScript/pulls
Actionshttps://github.com/microsoft/TypeScript/actions
Projectshttps://github.com/microsoft/TypeScript/projects
Wikihttps://github.com/microsoft/TypeScript/wiki
Security and qualityhttps://github.com/microsoft/TypeScript/security
Insightshttps://github.com/microsoft/TypeScript/insights
https://github.com/microsoft/TypeScript
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/39949
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/39949
"Isolated" annotation for functions that only act on inputs (distinct from 'pure')https://github.com/microsoft/TypeScript/issues/39949#top
Awaiting More FeedbackThis means we'd like to hear from more people who would be helped by this featurehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Awaiting%20More%20Feedback%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
https://github.com/mbilokonsky
Mykola Bilokonsky (mbilokonsky)https://github.com/mbilokonsky
on Aug 7, 2020https://github.com/microsoft/TypeScript/issues/39949#issue-675098265
Elixir's doctestshttps://elixir-lang.org/getting-started/mix-otp/docs-tests-and-with.html#doctests
TypeScript's Design Goalshttps://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
https://github.com/MartinJohns
Martin Johns (MartinJohns)https://github.com/MartinJohns
on Aug 9, 2020https://github.com/microsoft/TypeScript/issues/39949#issuecomment-671088317
#17818https://github.com/microsoft/TypeScript/issues/17818
#7770https://github.com/microsoft/TypeScript/issues/7770
https://github.com/orta
Orta Therox (orta)https://github.com/orta
on Aug 10, 2020https://github.com/microsoft/TypeScript/issues/39949#issuecomment-671327109
https://github.com/mbilokonsky
Mykola Bilokonsky (mbilokonsky)https://github.com/mbilokonsky
on Aug 11, 2020https://github.com/microsoft/TypeScript/issues/39949#issuecomment-671890264
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
Awaiting More FeedbackThis means we'd like to hear from more people who would be helped by this featurehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Awaiting%20More%20Feedback%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
on Aug 20, 2020https://github.com/microsoft/TypeScript/issues/39949#event-3677460280
https://github.com/mbilokonsky
Mykola Bilokonsky (mbilokonsky)https://github.com/mbilokonsky
on Mar 15, 2021https://github.com/microsoft/TypeScript/issues/39949#issuecomment-799624279
https://github.com/jsejcksn
Jesse Jackson (jsejcksn)https://github.com/jsejcksn
on Jul 10, 2023https://github.com/microsoft/TypeScript/issues/39949#issuecomment-1629711628
purehttps://en.wikipedia.org/wiki/Pure_function
closurehttps://en.wikipedia.org/wiki/Closure_(computer_programming)
https://github.com/senyaak
Senyaak (senyaak)https://github.com/senyaak
on Dec 21, 2023https://github.com/microsoft/TypeScript/issues/39949#issuecomment-1866383238
https://github.com/mbilokonsky
Mykola Bilokonsky (mbilokonsky)https://github.com/mbilokonsky
on Jan 25, 2024https://github.com/microsoft/TypeScript/issues/39949#issuecomment-1910835951
Mykola Bilokonsky (mbilokonsky)https://github.com/mbilokonsky
on Jan 25, 2024https://github.com/microsoft/TypeScript/issues/39949#event-11601457100
https://github.com/jennings
Stephen Jennings (jennings)https://github.com/jennings
on May 15, 2024https://github.com/microsoft/TypeScript/issues/39949#issuecomment-2113517696
static local functions in C#https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/local-functions#local-function-syntax
https://github.com/mbilokonsky
Mykola Bilokonsky (mbilokonsky)https://github.com/mbilokonsky
on Sep 7, 2024https://github.com/microsoft/TypeScript/issues/39949#issuecomment-2335002289
Sign up for freehttps://github.com/signup?return_to=https://github.com/microsoft/TypeScript/issues/39949
Sign in to commenthttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/39949
Awaiting More FeedbackThis means we'd like to hear from more people who would be helped by this featurehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Awaiting%20More%20Feedback%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.