Spelling #1508

jsoref · 2022-09-30T22:24:53Z

Overview

Describe the changes present in the pull request

This PR corrects misspellings identified by the check-spelling action.

The misspellings have been reported at jsoref@3c48f73#commitcomment-85517301

The action reports that the changes in this PR would make it happy: jsoref@1186c61

Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately.

Submitter Checklist:

Include a link to the related GitHub issue, if applicable
Include a security review link, if applicable

Testing

The agent includes a suite of unit and functional tests which should be used to
verify your changes don't break existing functionality. These tests will run with
Github Actions when a pull request is made. More details on running the tests locally can be found
here for our unit tests,
and here for our functional tests.
For most contributions it is strongly recommended to add additional tests which
exercise your changes.

Reviewer Checklist

Perform code review
Add performance label
Perform appropriate level of performance testing
Confirm all checks passed
Add version label prior to acceptance

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

CLAassistant · 2022-09-30T22:24:59Z

All committers have signed the CLA.

jsoref

Most corrections suggested by Google Sheets. All fault mine.

jsoref · 2022-09-30T22:25:58Z

.github/actions/annotate/action.yml

-description: 'Annotates errors if an errrors.txt file is present'
+description: 'Annotates errors if an errors.txt file is present'


Sometimes projects try to be cute. Often even if a project tries to be cute, it still contains typos. This appears to be the latter.

jsoref · 2022-09-30T22:26:57Z

.github/actions/simplecov-report/action.yml

@@ -18,7 +18,7 @@ inputs:
    default: "coverage/.last_run.json"
    required: false
  token:
-    description: "Github token"
+    description: "GitHub token"


Brand.

I'm not sure where this thing comes from, but the project has a number of typos, and assuming it isn't original to this repo, I'd like to send a PR for it.

I've actively dropped a couple of changes to associated files.

jsoref · 2022-09-30T22:27:20Z

.github/workflows/scripts/setup_bundler_multiverse

+  echo "DEBUG: running 'gem install strscan'"
  gem install --default strscan:3.0.4


This matches the code...

CHANGELOG.md

jsoref · 2022-09-30T22:37:43Z

test/new_relic/agent/javascript_instrumentor_test.rb

-  def test_html_safe_if_needed_unsafed
+  def test_html_safe_if_needed_unsafe


I'm not sure what this is trying to say (nor the next one)

I think it's broken down like this:
test_: required minitest prefix for all tests
html_safe_if_needed: method name

newrelic-ruby-agent/lib/new_relic/agent/javascript_instrumentor.rb

Lines 199 to 202 in ab2cf23

def html_safe_if_needed(string)

string = string.html_safe if string.respond_to?(:html_safe)

string

end

_unsafe/safe: way of breaking up the test cases into strings that are not html safe and strings that are html safe

ok. so, it sounds like the d isn't needed/wanted. In which case I'm happy w/ this change.

jsoref · 2022-09-30T22:38:25Z

test/new_relic/agent/new_relic_service_test.rb

-      'whereever.com'
+      'wherever.com'


Insert standard disclaimer for https://example.com/

test/new_relic/agent/obfuscator_test.rb

test/new_relic/agent/transaction/segment_test.rb

jsoref · 2022-09-30T22:40:25Z

test/new_relic/agent/transaction/trace_node_test.rb

-  def test_to_debug_str_multichild
+  def test_to_debug_str_multi_child


This didn't seem to be used in enough places to justify treatment as a word (there were a number of things I accepted as merged...)

jsoref · 2022-09-30T22:42:55Z

Oh, I should perhaps note that https://github.com/newrelic/newrelic-ruby-agent/blob/dev/.github/workflows/label_community_cards.yml is hostile to forks w/ locked down configurations.

It should have explicit permissions: for the things it uses. I may make a PR for it, or not, but likely not anytime soon.

kaylareopelle

Thank you for brightening our Friday afternoons with this PR!

We're impressed with this action and would welcome another PR to introduce it to our repository as a regular part of our workflow.

Are you participating in Hacktoberfest? If so, I'd be happy to hold the merge until the start of the month.

kaylareopelle · 2022-09-30T22:38:34Z

lib/new_relic/agent/configuration/default_source.rb

@@ -940,7 +940,7 @@ def self.enforce_fallback(allowed_values: nil, fallback: nil)
          :type => String,
          :dynamic_name => true,
          :allowed_from_server => false,
-          :description => "Controls auto-instrumentation of the Thread class at start up to allow the agent to correctly nest spans inside of an asyncronous transaction. This does not enable the agent to automatically trace all threads created (see `instrumentation.thread.tracing`). May be one of [auto|prepend|chain|disabled]."


Maintainer note: We'll need to regenerate the configuration documentation for the docs-website repo to apply this spelling correction there.

kaylareopelle · 2022-09-30T22:46:09Z

test/fixtures/cross_agent_tests/distributed_tracing/trace_context.json

@@ -185,7 +185,7 @@
  {
    "test_name": "spans_disabled_in_parent",
    "comment": [ "If the parent is a New Relic agent with span events disabled it SHOULD omit span",
-      "id from the tracestate. This verifies agents propogate Trace Context payloads when the",


Maintainer note: These files need to be updated in the GHE cross-agent-tests repo to avoid regression.

CHANGELOG.md

kaylareopelle · 2022-09-30T23:04:55Z

CHANGELOG.md

-  the ControllerInstrumentation module in to both the `Base` and `API`
+  the ControllerInstrumentation module into both the `Base` and `API`


I think the single word makes more sense here. Seems like an interesting coding problem to solve!

config.dot

test/new_relic/agent/configuration/high_security_source_test.rb

kaylareopelle · 2022-09-30T23:31:17Z

test/new_relic/agent/database_test.rb

-    config = {:uri => "jdbc:postgresql://host/database?user=posgres"}
+    config = {:uri => "jdbc:postgresql://host/database?user=postgres"}


Huh. Should be fine. We'll see failures in our JRuby tests if not.

kaylareopelle · 2022-09-30T23:39:16Z

test/new_relic/agent/javascript_instrumentor_test.rb

-  def test_html_safe_if_needed_unsafed
+  def test_html_safe_if_needed_unsafe


I think it's broken down like this:
test_: required minitest prefix for all tests
html_safe_if_needed: method name

newrelic-ruby-agent/lib/new_relic/agent/javascript_instrumentor.rb

Lines 199 to 202 in ab2cf23

def html_safe_if_needed(string)

string = string.html_safe if string.respond_to?(:html_safe)

string

end

_unsafe/safe: way of breaking up the test cases into strings that are not html safe and strings that are html safe

test/new_relic/agent/obfuscator_test.rb

test/new_relic/agent/transaction/segment_test.rb

jsoref · 2022-10-02T02:26:21Z

I try to remember to participate. I'll have to sign up. Thanks for the reminder. Signed up!

I do these year-round because they exercise my tool and I like to help.

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

kaylareopelle

Thank you for this great contribution! 🎉

kaylareopelle · 2022-10-03T17:34:34Z

@jsoref, when you have the time, we'd love to have your action added to our workflows. Thanks for introducing us to it and correcting our spelling. 😄

jsoref added 30 commits September 29, 2022 20:05

spelling: about

23dbb80

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: accessible

4ad69ec

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: algorithm

7cc8b21

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: any

7e7645d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: arguments

209eeb3

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: asynchronous

ba2c51d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: available

c114eba

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: between

e6ba81e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: certificate

acc348d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: command

301e9b9

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: compatibility

80f11d3

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: condition

05b132d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: configuration

15f012d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: constraints

abc6ae0

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: controller

25ee23b

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: cross_process

53d286d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: data structure

7aba843

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: delimiter

0ab68c9

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: diagnosing

a2f28f0

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: encoding

cdc3b77

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: environments

72d73bc

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: erroneously

51372ed

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: errors

869d72e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: evaluate

bceb560

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: evaluated

4067b33

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: exception

2237310

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: exceptions

b1b5356

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: exchange

21b92ed

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: execution

c4a8308

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: falsely

7a36924

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref added 15 commits September 30, 2022 11:48

spelling: specifics

592019e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: statement

f6060cd

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: strscan

933dea1

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: supportability

b0880bd

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: temporary

78321b6

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: the

8443a88

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: they

97d85db

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: threshold

b4e4601

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: tracing

2d31ea1

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: transaction

230e630

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: unencrypted

299daba

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: unsuccessful

4260bbf

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: version

8178b16

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: visibility

455a462

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: wherever

1f433ad

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

github-actions bot added the community To tag external issues and PRs submitted by the community label Sep 30, 2022

jsoref commented Sep 30, 2022

View reviewed changes

kaylareopelle previously approved these changes Sep 30, 2022

View reviewed changes

spelling: _payload (unused argument)

ecfdda6

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref dismissed kaylareopelle’s stale review via ecfdda6 October 2, 2022 12:47

kaylareopelle added the hacktoberfest-accepted label Oct 3, 2022

kaylareopelle approved these changes Oct 3, 2022

View reviewed changes

kaylareopelle merged commit 0cc75c5 into newrelic:dev Oct 3, 2022

jsoref deleted the spelling branch October 3, 2022 17:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Spelling #1508

Spelling #1508

jsoref commented Sep 30, 2022

CLAassistant commented Sep 30, 2022 •

edited

Loading

jsoref left a comment

jsoref Sep 30, 2022

jsoref Sep 30, 2022

jsoref Sep 30, 2022

jsoref Sep 30, 2022

kaylareopelle Sep 30, 2022

jsoref Oct 2, 2022

jsoref Sep 30, 2022

jsoref Sep 30, 2022

jsoref commented Sep 30, 2022

kaylareopelle left a comment

kaylareopelle Sep 30, 2022

kaylareopelle Sep 30, 2022

kaylareopelle Sep 30, 2022

kaylareopelle Sep 30, 2022

kaylareopelle Sep 30, 2022

jsoref commented Oct 2, 2022

kaylareopelle left a comment

kaylareopelle commented Oct 3, 2022

		description: 'Annotates errors if an errrors.txt file is present'
		description: 'Annotates errors if an errors.txt file is present'

		echo "DEBUG: running 'gem install strscan'"
		gem install --default strscan:3.0.4

		def test_html_safe_if_needed_unsafed
		def test_html_safe_if_needed_unsafe

	def html_safe_if_needed(string)
	string = string.html_safe if string.respond_to?(:html_safe)
	string
	end

		def test_to_debug_str_multichild
		def test_to_debug_str_multi_child

		the ControllerInstrumentation module in to both the `Base` and `API`
		the ControllerInstrumentation module into both the `Base` and `API`

		config = {:uri => "jdbc:postgresql://host/database?user=posgres"}
		config = {:uri => "jdbc:postgresql://host/database?user=postgres"}

Spelling #1508

Spelling #1508

Conversation

jsoref commented Sep 30, 2022

Overview

Testing

Reviewer Checklist

CLAassistant commented Sep 30, 2022 • edited Loading

jsoref left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoref commented Sep 30, 2022

kaylareopelle left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoref commented Oct 2, 2022

kaylareopelle left a comment

Choose a reason for hiding this comment

kaylareopelle commented Oct 3, 2022

CLAassistant commented Sep 30, 2022 •

edited

Loading