Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use template strings for string concatenation in JS code in dags.html #13957

Merged
merged 1 commit into from
Jan 28, 2021

Conversation

XD-DENG
Copy link
Member

@XD-DENG XD-DENG commented Jan 28, 2021

  • use template strings over '+', for cleaner code.
  • fix bugs caused by '+' concatenation (please refer to my in-line comment below.)

^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.

- use template strings over '+'
- fix bugs caused by '+' concatenation
@XD-DENG XD-DENG added the area:UI Related to UI/UX. For Frontend Developers. label Jan 28, 2021
@XD-DENG XD-DENG added this to the Airflow 2.0.1 milestone Jan 28, 2021
@boring-cyborg boring-cyborg bot added the area:webserver Webserver related Issues label Jan 28, 2021
@XD-DENG XD-DENG removed the area:webserver Webserver related Issues label Jan 28, 2021
})
.append('circle')
.attr('id', function(d) {return 'run-' + dag_id.replace(/\./g, '_') + d.state || 'none'})
Copy link
Member Author

@XD-DENG XD-DENG Jan 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the bug I'm referring to.

When d.state is null or undefined, it's like:

'a-' + null || 'none'

This gives us a-null, while we actually expect a-none. So this should be

'a-' + (null || 'none')

But of course this is fixed if we use template string for this.

})
.append('circle')
.attr('id', function(d) {return 'task-' + dag_id.replace(/\./g, '_') + d.state || 'none'})
Copy link
Member Author

@XD-DENG XD-DENG Jan 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same issue here

Copy link
Contributor

@ryanahamilton ryanahamilton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much appreciated cleanup @XD-DENG!

I had started on integrating/enforcing ESLint that would ensure this pattern is always used—I need to pick that work back up soon.

@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Jan 28, 2021
@github-actions
Copy link

The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest master or amend the last commit of the PR, and push it with --force-with-lease.

@XD-DENG
Copy link
Member Author

XD-DENG commented Jan 28, 2021

Much appreciated cleanup @XD-DENG!

I had started on integrating/enforcing ESLint that would ensure this pattern is always used—I need to pick that work back up soon.

Thanks @ryanahamilton :)

The Jinja template usage mixed inside may cause difficulty to automate that? Would be interested to know & learn how this will be done👍

@XD-DENG XD-DENG merged commit 4d4aa9e into apache:master Jan 28, 2021
@XD-DENG XD-DENG deleted the template-literals branch January 28, 2021 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:UI Related to UI/UX. For Frontend Developers. okay to merge It's ok to merge this PR as it does not require more tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants