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

[Non-Inclusive Language] Replace master in comments #1778

Merged
merged 1 commit into from
Jun 24, 2022

Conversation

manasvinibs
Copy link
Member

Signed-off-by: manasvinibs [email protected]

Description

As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories.

In this change, we are replacing 'master' in comments with 'cluster_manager'.

Issues Resolved

#1692

Check List

  • New functionality includes testing.
    • All tests pass
      • yarn test:jest
      • yarn test:jest_integration
      • yarn test:ftr
  • New functionality has been documented.
  • Commits are signed per the DCO using --signoff

@manasvinibs manasvinibs requested a review from a team as a code owner June 22, 2022 18:31
@manasvinibs manasvinibs self-assigned this Jun 22, 2022
Comment on lines 53 to 54
async function getLicenseFromLocalOrMaster(opensearchClient: OpenSearchClient) {
// Fetching the local license is cheaper than getting it from the master node and good enough
// Fetching the local license is cheaper than getting it from the cluster_manager node and good enough
Copy link
Member

Choose a reason for hiding this comment

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

It's weird for me to see the comments being updated before the function names. I'm guessing that's planned for another PR, but I'd prefer if they were all together so we could validate that the comments still match the code.

Copy link
Member Author

Choose a reason for hiding this comment

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

It's weird for me to see the comments being updated before the function names. I'm guessing that's planned for another PR, but I'd prefer if they were all together so we could validate that the comments still match the code.

I looked into other open issues related to this task and I don't see any specific issue for updating the function names as such. I think I should have that updated as part of this PR for better readability. Thanks for catching this!

@manasvinibs manasvinibs force-pushed the Issue-1692 branch 2 times, most recently from 15c4e5d to 1ccb8e9 Compare June 23, 2022 01:37
@manasvinibs manasvinibs requested a review from joshuarrrr June 23, 2022 01:38
async function getLicenseFromLocalOrMaster(opensearchClient: OpenSearchClient) {
// Fetching the local license is cheaper than getting it from the master node and good enough
async function getLicenseFromLocalOrClusterManager(opensearchClient: OpenSearchClient) {
// Fetching the local license is cheaper than getting it from the cluster_manager node and good enough
Copy link
Member

Choose a reason for hiding this comment

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

NIT: I think the comments would be main or manager node? But if not, it should definitely be cluster manager node.

Also, can you do me a favor and mark this as deprecated and create an issue to verify if this is in use? We shouldn't have any licensing checks. It's all telemetry.

Copy link
Member Author

Choose a reason for hiding this comment

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

NIT: I think the comments would be main or manager node? But if not, it should definitely be cluster manager node.
Sure! Updated.
Also, can you do me a favor and mark this as deprecated and create an issue to verify if this is in use? We shouldn't have any licensing checks. It's all telemetry.
Created: #1787

joshuarrrr
joshuarrrr previously approved these changes Jun 23, 2022
Copy link
Member

@joshuarrrr joshuarrrr left a comment

Choose a reason for hiding this comment

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

I think we could improve a couple of these comments, but no blockers.

@@ -164,7 +164,7 @@ export class HttpService
* Indicates if http server has configured to start listening on a configured port.
* We shouldn't start http service in two cases:
* 1. If `server.autoListen` is explicitly set to `false`.
* 2. When the process is run as dev cluster master in which case cluster manager
* 2. When the process is run as dev cluster manager in which case cluster manager
Copy link
Member

Choose a reason for hiding this comment

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

nit - "in which case cluster manager" doesn't really make sense to me or add anything useful, so I'd recommend deleting.

Suggested change
* 2. When the process is run as dev cluster manager in which case cluster manager
* 2. When the process is run as dev cluster manager

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated.

// master
// cluster_manager
Copy link
Member

Choose a reason for hiding this comment

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

I have no idea what the purpose of this comment is 😂 - I'd recommend removing as unhelpful

joshuarrrr
joshuarrrr previously approved these changes Jun 23, 2022
@kavilla
Copy link
Member

kavilla commented Jun 23, 2022

@manasvinibs,

Does signing off with your full name works on main? For 2.x manasvinibs fails the DCO check because I believe it is looking at your GitHub name and see you use your full name.

@manasvinibs
Copy link
Member Author

@manasvinibs,

Does signing off with your full name works on main? For 2.x manasvinibs fails the DCO check because I believe it is looking at your GitHub name and see you use your full name.

I just updated my GPG keys with user name matching my full name and re-signed commit with my full name. I hope this gets 'verified' now on 2.x.

@manasvinibs manasvinibs requested a review from joshuarrrr June 23, 2022 21:20
@codecov-commenter
Copy link

Codecov Report

Merging #1778 (31fd295) into main (7c8eee4) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1778      +/-   ##
==========================================
- Coverage   67.51%   67.50%   -0.01%     
==========================================
  Files        3073     3073              
  Lines       59069    59069              
  Branches     8963     8963              
==========================================
- Hits        39881    39877       -4     
- Misses      17006    17008       +2     
- Partials     2182     2184       +2     
Impacted Files Coverage Δ
src/core/server/http/http_service.ts 90.74% <ø> (ø)
...nsearch/version_check/ensure_opensearch_version.ts 86.66% <ø> (ø)
...s_data/request_processors/series/date_histogram.js 100.00% <ø> (ø)
...ic/application/models/sense_editor/sense_editor.ts 64.00% <0.00%> (-1.78%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7c8eee4...31fd295. Read the comment docs.

…nction names

As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories.

Issue - opensearch-project#1692
Signed-off-by: Manasvini B Suryanarayana <[email protected]>
@joshuarrrr joshuarrrr merged commit e32a259 into opensearch-project:main Jun 24, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jun 24, 2022
…nction names (#1778)

As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories.

Issue - #1692
Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit e32a259)
joshuarrrr pushed a commit that referenced this pull request Jun 24, 2022
…nction names (#1778) (#1793)

As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories.

Issue - #1692
Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit e32a259)

Co-authored-by: Manasvini B Suryanarayana <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Non-Inclusive Language] Replace master in comments and variables
4 participants