Improve `getInput` types #929

Ethan-Arrowood · 2023-04-21T19:04:07Z

getInput throws when required is set to true. This commit improves the typing to reflect that.

…ent-version Add TFS 2017 Update 3 agent version.

Deep Dive on Building Custom Build or Deploy Tasks

* Add task.json schema file * Allow any "connectedService:" type of input * Added the "id" field

…cefiles Allow multiple resource files

Properly escape property value to handle non string types

* Error on multiline secret * v2.3.0

…t#325) * Update dependencies to prevent warnings during npm install. * Remove package-lock until we fully upgrade.

* Add supported commands to TaskLibAnswers * Remove stray semicolon * Typescript -> TypeScript

* Revert updates to dependency versions. * Add package-lock.json. * Remove root package lock. * Try to get node_modules output. * Cleanup. * Fix make.ks. * Add third party notice generator. * Update docs. * Add third party notice. * Copy node_modules to _build. * Copy ThirdPartyNotices.txt to _build directory. * Prune dev dependencies in _build. * Remove node_modules copy, shouldn't need to be there. * Cleanup. * Clean. * Clean.

…FileAndTool Add option to pipe to file and another tool

* added formatted proxy URL * version increment

* version bump

Co-authored-by: microsoft-github-policy-service[bot] <77245923+microsoft-github-policy-service[bot]@users.noreply.github.com> Co-authored-by: Konstantin Tyukalov <[email protected]>

…t#848) * Update pipeline * Update azure-pipelines.yml * nodeversion as variable Co-authored-by: Andrey Ivanov <[email protected]>

Co-authored-by: Andrey Ivanov <[email protected]>

…ted agent, or not. (microsoft#869) * Added function getAgentMode * Function getAgentMode added to documentation * Fix of documentation

* Updated PSLIB_InvalidPattern0 to be more readable * Update LegacyFindFunctions.ps1 Co-authored-by: Kirill Ivlev <[email protected]>

* Added localization pipeline and LocProject.json * Removed en-US * Update localize-pipeline.yml for Azure Pipelines * Update localize-pipeline.yml for Azure Pipelines * Made letter case consistent for languages * LEGO: check in for Localization to temporary branch. (microsoft#703) * LEGO: check in for Localization to temporary branch. (microsoft#714) * LEGO: check in for Localization to temporary branch. (microsoft#720) * Temp renaming * Renamed localization files * Applied enhancements for the localization pipeline (microsoft#733) [skip ci] * [Localization] Fixed localization pipeline issue with already localized strings replaced (microsoft#737) * Localized file check-in by OneLocBuild Task: Build definition ID 10947: Build ID 14646607 Localized file check-in by OneLocBuild Task * LEGO: check in for Localization to temporary branch. (microsoft#740) * LEGO: check in for Localization to temporary branch. (microsoft#741) * LEGO: check in for Localization to temporary branch. (microsoft#742) * LEGO: check in for Localization to temporary branch. (microsoft#743) * Temporary renamed files - to resolve conflicts * Temporary renamed * LEGO: check in for Localization to temporary branch. (microsoft#745) Co-authored-by: csigs <[email protected]> * LEGO: check in for Localization to temporary branch. (microsoft#746) Co-authored-by: csigs <[email protected]> * LEGO: check in for Localization to temporary branch. (microsoft#747) Co-authored-by: csigs <[email protected]> * LEGO: check in for Localization to temporary branch. (microsoft#748) Co-authored-by: csigs <[email protected]> * Localized file check-in by OneLocBuild Task: Build definition ID 10947: Build ID 14905562 Localized file check-in by OneLocBuild Task * Returned back original names * Removed redundant locale - test * Removed redundant folders * Localized file check-in by OneLocBuild Task: Build definition ID 10947: Build ID 14906155 Localized file check-in by OneLocBuild Task * Returned back changes. Removed redundant * Create PR in OneLocBuild task only on third week of sprint (microsoft#755) * Fix localization pipeline * Add missed change * Added option to disable PR creation * Add OneLocBuild removal to the localization pipeline (microsoft#804) * Add OneLocBuild removal to the pipeline * fix ignore error to double if Co-authored-by: Ilya Kuleshov <[email protected]> * Localization update (microsoft#802) * Removing Localize folder * Revert "Removing Localize folder" Co-authored-by: Ilya Kuleshov <[email protected]> * Removed OneLocBuild folder * Move notifications about Task-lib Localization PR from Slack to MS Teams - Part 1 (microsoft#816) * Localized file check-in by OneLocBuild Task: Build definition ID 10947: Build ID 18673037 (microsoft#879) * Juno: check in to lego/hb_a4aa9cc4-603b-418e-91f1-700184175625_20221105085105779. (microsoft#881) * Juno: check in to lego/hb_a4aa9cc4-603b-418e-91f1-700184175625_20221106085044954. (microsoft#882) * Localized file check-in by OneLocBuild Task: Build definition ID 10947: Build ID 18697074 (microsoft#883) * Update LocProject file * Update LocProject * Remove lowercase loc strings on windows * Removing Localize and OneLocBuild folder Co-authored-by: Anatolii Bolshakov (Akvelon INC) <[email protected]> Co-authored-by: csigs <[email protected]> Co-authored-by: Egor Bryzgalov <[email protected]> Co-authored-by: Anatoly Bolshakov <[email protected]> Co-authored-by: csigs <[email protected]> Co-authored-by: Nikita Ezzhev <[email protected]> Co-authored-by: kuleshovilya <[email protected]> Co-authored-by: Ilya Kuleshov <[email protected]> Co-authored-by: Denis Tikhomirov <[email protected]> Co-authored-by: Maksim Petrov <[email protected]>

…#895)

* Pipeline fixing * Indentation fix * Formating * Node version was reverted

* Migrating to Node 16 (microsoft#844) * create new release/4.x branch * release for 4 version * update pipeline * update package.json * fix test and build commands * fixed tests on node18 * change image version for linux * fix test for linux * add separete test for linux * node v16.13 * add v16.13.0 to test * test on windows-2022, macOS-11 * separate branch for node16 * remove temporary code * update package.json * changed pipeline * updated pipeline * Microsoft mandatory file (microsoft#839) * Update pipeline to include a step for publishing artifacts. (microsoft#848) (microsoft#849) * Update pipeline * Update azure-pipelines.yml * nodeversion as variable * Added node16 to schema (microsoft#852) Co-authored-by: Andrey Ivanov <[email protected]> * bump version (microsoft#862) Co-authored-by: Andrey Ivanov <[email protected]> * Update ci-cd for publishing npm package (microsoft#863) * fix npm publish Co-authored-by: Andrey Ivanov <[email protected]> * fix add registry (microsoft#864) Co-authored-by: Andrey Ivanov <[email protected]> * fix ToolRunner - _getSpawnSyncOptions (microsoft#873) * Mockery version is updated from 1.7.0 to 2.1.0 because of vulnerability (microsoft#878) * Fixed release path (microsoft#888) * Improvement of the release condition (microsoft#889) * Added test task with test condition. Negative test * Added test task with test condition. Positive test * Fix path * Fix path * Fix path * Changed build.sourcebranchname -> build.sourcebranch and path to branch * Fix path * Version changed (microsoft#894) * Pipeline fixing (microsoft#893) * Token test * Test token * Publish test * call order changed * Nmp token syntax reverted * Changed windows job * Script clearing * Uncommented condition * Token changed * Test - off publish condition * Switched on publish condition * Package version was reverted * Add escape for more correct working * Add changelog * Update package-lock version * Bump tl version to 4.1.0 * Update changelog * Remove PS task lib changes from node changelog * Update changelog for 4.0.1-preview Co-authored-by: AndreyIvanov42 <[email protected]> Co-authored-by: Andrey Ivanov <[email protected]> Co-authored-by: Denis Rumyantsev <[email protected]> Co-authored-by: Roman-Shchukin <[email protected]>

The event "unhandledRejection" was added on process.on because when Promise is rejected and there is no catch the error will not be thrown and process.on('uncaughtException') won't call for Node10 but it will emit "uncaughtException" for node 16. So we need to listen to "unhandledRejection" and throw the error to make sure the error is thrown and the result will be similar.

* Improve types for argIf command * Bump package version * Update changelog

…s 6.9.4. Severity: High #4370 (microsoft#924) - Bumped qs version

* Remove note about v4 task lib status * Fix formatting

`getInput` throws when `required` is set to `true`. This commit improves the typing to reflect that.

ivanduplenskikh · 2023-05-29T13:59:12Z

node/task.ts

@@ -238,6 +238,7 @@ export interface VariableInfo {
 * @param     required whether input is required.  optional, defaults to false
 * @returns   string
 */
+export function getInput(name: string, require: true): string


The function has a second argument which is optional and its name is required but you had overloaded require argument with true type.
Could you provide cases that you want to handle for a better understanding?
Why did you use true as a type?

That is a spelling mistake; I'll fix that momentarily.

The type results in a better UX:

Given the code

const foo = getInput('foo', true);

Currently, foo would be typed as string | undefined, but if the input 'foo' is actually undefined, getInput will throw an error. So actually, the variable foo should have a type of string here, not undefined.

The overload accomplishes this by stating that the type literal true should have a return type of string explicitly. Meanwhile, the catch-all overload satisfies the alternate condition:

const bar = getInput('bar'); // or const fuzz = getInput('fuzz', false);

Where neither of these calls to getInput will throw an error if the input isn't found; thus, the resulting type for bar or fuzz should be string | undefined.

stephenmichaelf and others added 30 commits November 15, 2017 10:09

Remove commented code.

c41ab80

Remove unnecessary code.

954f052

Add TFS 2017 Update 3 agent version.

306ddaa

Update yml config.

86fbbed

Fix mac pool.

924b02e

Merge pull request microsoft#300 from Microsoft/users/stfrance/add-ag…

671a240

…ent-version Add TFS 2017 Update 3 agent version.

Added video (microsoft#301)

a4be372

Deep Dive on Building Custom Build or Deploy Tasks

Add task.json schema file (microsoft#146)

0217b3a

* Add task.json schema file * Allow any "connectedService:" type of input * Added the "id" field

remove extra schema info (microsoft#308)

ad4047c

link to task json schema (microsoft#309)

2ea9157

Merge pull request microsoft#295 from Microsoft/users/stfrance/resour…

91e03a1

…cefiles Allow multiple resource files

Fix escaping property values. (microsoft#311)

b7b47e4

Properly escape property value to handle non string types

Error on multiline secret (microsoft#315)

bfddff3

* Error on multiline secret * v2.3.0

Handback. (microsoft#316)

c70eaca

add trigger into yaml

00f310f

change queues

72eb910

Refactor compile exe helper functions

1bbd289

Update dependencies to prevent warnings during npm install. (microsof…

bda1c27

…t#325) * Update dependencies to prevent warnings during npm install. * Remove package-lock until we fully upgrade.

Update dependency versions. (microsoft#327)

0811d35

Update dependency versions. (microsoft#328)

216fed2

Add option to pipe to file and another tool

22e9d33

Update TaskLibAnswers to have all supported commands (microsoft#332)

54cba4e

* Add supported commands to TaskLibAnswers * Remove stray semicolon * Typescript -> TypeScript

PR feedback, add tests

4c75ff7

close filestream correctly

288a43f

guard for timing issues where filestream of first tool is not closed

953cf2e

add error message for linux

05038e6

Refactor as per offline discussion with Eric

d99b570

close stream after setting returncode

057056b

Merge pull request microsoft#329 from Microsoft/users/madhurig/pipeTo…

f22b24b

…FileAndTool Add option to pipe to file and another tool

SvetlanaMaliugina and others added 24 commits May 17, 2022 12:50

Bump patch version (microsoft#837)

7486d51

added formatted proxy URL (microsoft#834)

fb34438

* added formatted proxy URL * version increment

Update minimatch to version 3.0.5 to fix vulnerability (microsoft#836)

b72e14a

* version bump

Microsoft mandatory file (microsoft#839)

ad2d00f

Co-authored-by: microsoft-github-policy-service[bot] <77245923+microsoft-github-policy-service[bot]@users.noreply.github.com> Co-authored-by: Konstantin Tyukalov <[email protected]>

Update pipeline to include a step for publishing artifacts. (microsof…

d4cc533

…t#848) * Update pipeline * Update azure-pipelines.yml * nodeversion as variable Co-authored-by: Andrey Ivanov <[email protected]>

Update contributing.md (microsoft#847)

333a5f9

updated docs (microsoft#853)

35bcc3f

Co-authored-by: Andrey Ivanov <[email protected]>

[Repo config] Add CODEOWNERS file (microsoft#855)

ee582bc

Enable task authors to determine whether the task is running on a hos…

5adadae

…ted agent, or not. (microsoft#869) * Added function getAgentMode * Function getAgentMode added to documentation * Fix of documentation

Updated mockery and mocha because of vulnerabilities (microsoft#875)

22ba7dd

Updated PSLIB_InvalidPattern0 to be more readable (microsoft#876)

e05ff6f

* Updated PSLIB_InvalidPattern0 to be more readable * Update LegacyFindFunctions.ps1 Co-authored-by: Kirill Ivlev <[email protected]>

Include uncought exceptions stack trace to the output logs (microsoft…

50bd431

…#895)

Pipeline fixing (microsoft#897)

73e9515

* Pipeline fixing * Indentation fix * Formating * Node version was reverted

Fixed Readme for npm package (microsoft#904)

5f76bee

Updated CHANGELOG.md (microsoft#915)

7d04ce6

Described types for argIf (microsoft#920)

149de35

* Improve types for argIf command * Bump package version * Update changelog

Update autoAssignAbtt workflow (microsoft#923)

6505de9

[Bug 2029503](P2): [Component Governance Alert] - CVE-2022-24999 in q…

2915809

…s 6.9.4. Severity: High #4370 (microsoft#924) - Bumped qs version

Remove note about v4 task lib status (microsoft#919)

f7e1795

* Remove note about v4 task lib status * Fix formatting

update ubuntu image (microsoft#925)

eac6dd4

Update task.ts

63845fb

`getInput` throws when `required` is set to `true`. This commit improves the typing to reflect that.

Ethan-Arrowood requested review from a team as code owners April 21, 2023 19:04

Ethan-Arrowood mentioned this pull request May 24, 2023

What is the purpose of setting a message for setResult(TaskResult.Succeeded, "Success"); calls? #940

Closed

ivanduplenskikh reviewed Jul 11, 2023

View reviewed changes

Update task.ts

29048bd

DergachevE force-pushed the master branch from 70d4711 to f886362 Compare April 26, 2024 10:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve `getInput` types #929

Improve `getInput` types #929

Ethan-Arrowood commented Apr 21, 2023

ivanduplenskikh May 29, 2023

Ethan-Arrowood Jul 11, 2023

Improve getInput types #929

Are you sure you want to change the base?

Improve getInput types #929

Conversation

Ethan-Arrowood commented Apr 21, 2023

ivanduplenskikh May 29, 2023

Choose a reason for hiding this comment

Ethan-Arrowood Jul 11, 2023

Choose a reason for hiding this comment

Improve `getInput` types #929

Improve `getInput` types #929