Skip to content

refactor: Use early return pattern to avoid nested conditions#428

Merged
dmitry-shibanov merged 2 commits into
actions:mainfrom
jongwooo:refactor/use-early-return-pattern
Dec 16, 2022
Merged

refactor: Use early return pattern to avoid nested conditions#428
dmitry-shibanov merged 2 commits into
actions:mainfrom
jongwooo:refactor/use-early-return-pattern

Conversation

@jongwooo

@jongwooo jongwooo commented Dec 12, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Signed-off-by: jongwooo jongwooo.han@gmail.com
Issue #420

Description

Return early is the way of writing functions or methods so that the expected positive result is returned at the end of the function and the rest of the code terminates the execution (by returning or throwing an exception) when conditions are not met.

See actions/cache#1012, actions/setup-node#639

In util.ts:

AS-IS

export function isCacheFeatureAvailable(): boolean {
  if (!cache.isFeatureAvailable()) {
    if (isGhes()) {
      throw new Error(
        'Caching is only supported on GHES version >= 3.5...'
      );
    } else {
      core.warning('The runner was not able to contact...');
    }

    return false;
  }

  return true;
}

TO-BE

export function isCacheFeatureAvailable(): boolean {
  if (cache.isFeatureAvailable()) {
    return true;
  }

  if (isGhes()) {
    throw new Error(
        'Caching is only supported on GHES version >= 3.5...'
    );
  }

  core.warning('The runner was not able to contact...');
  return false;
}

Check list:

  • Mark if documentation changes are required.
  • Mark if tests were added or updated to cover the changes.

@jongwooo
refactor: Use early return pattern
32b1479 
Signed-off-by: jongwooo <jongwooo.han@gmail.com>
@jongwooo jongwooo changed the title refactor: Use early return pattern refactor: Use early return pattern to avoid nested conditions Dec 12, 2022
@panticmilos

panticmilos commented Dec 12, 2022

Copy link
Copy Markdown
Contributor

hi @jongwooo, thank you for the PR. We will take a look at it

jongwooo
jongwooo commented Dec 12, 2022
View reviewed changes
Comment thread src/util.ts Outdated
@jongwooo jongwooo requested review from Xraduu and panticmilos and removed request for Xraduu and panticmilos December 15, 2022 14:22
@jongwooo
fix: Replace throw with warn
0423e93 
Signed-off-by: jongwooo <jongwooo.han@gmail.com>
@dmitry-shibanov dmitry-shibanov merged commit 545223a into actions:main Dec 16, 2022
@jongwooo jongwooo deleted the refactor/use-early-return-pattern branch December 16, 2022 14:13
yeikel pushed a commit to yeikel/setup-java that referenced this pull request Feb 12, 2023
@jongwooo @yeikel
refactor: Use early return pattern to avoid nested conditions (action…
9a294a2 
…s#428)
fniephaus pushed a commit to graalvm/setup-java that referenced this pull request Jun 20, 2023
@jongwooo @fniephaus
refactor: Use early return pattern to avoid nested conditions (action…
dc5efc9 
…s#428)
tdfacer pushed a commit to ifit/setup-java that referenced this pull request Oct 7, 2025
@jongwooo
refactor: Use early return pattern to avoid nested conditions (action…
0ad658e 
…s#428)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@panticmilos panticmilos Awaiting requested review from panticmilos

5 more reviewers

@dmitry-shibanov dmitry-shibanov dmitry-shibanov approved these changes

@MaksimZhukov MaksimZhukov MaksimZhukov approved these changes

@marko-zivic-93 marko-zivic-93 marko-zivic-93 approved these changes

@e-korolevskii e-korolevskii e-korolevskii approved these changes

@Xraduu Xraduu Xraduu approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@jongwooo @panticmilos @dmitry-shibanov @MaksimZhukov @marko-zivic-93 @e-korolevskii @Xraduu