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

Rename apiKey config option to pushApiKey #507

Merged
merged 1 commit into from
Nov 23, 2021
Merged

Rename apiKey config option to pushApiKey #507

merged 1 commit into from
Nov 23, 2021

Conversation

tombruijn
Copy link
Member

@tombruijn tombruijn commented Nov 22, 2021

Rename the apiKey config option to pushApiKey to match the naming in
the other integrations (Ruby & Elixir).

If the apiKey config option is set (which will be the case for
everyone upgrading) the pushApiKey config option will be set with the
apiKey value.

It does only for the apiKey option given to the constructor, the env
var is mapped to the new key by the config keys map.

Rename the `apiKey` config option to `pushApiKey` to match the naming in
the other integrations (Ruby & Elixir).

If the `apiKey` config option is set (which will be the case for
everyone upgrading) the `pushApiKey` config option will be set with the
`apiKey` value.

It does only for the `apiKey` option given to the constructor, the env
var is mapped to the new key by the config keys map.
@tombruijn tombruijn marked this pull request as ready for review November 22, 2021 13:33
@tombruijn tombruijn merged commit 13068b7 into main Nov 23, 2021
tombruijn added a commit to appsignal/appsignal-javascript that referenced this pull request Dec 6, 2021
In PR appsignal/appsignal-nodejs#507
on the Node.js integration we renamed `apiKey` to `pushApiKey` to make
it more consistent with the other integrations. Update the code in the
installer to match.

[skip changeset] as users won't notice this change, it only makes it
more readable for us.
tombruijn added a commit to appsignal/appsignal-javascript that referenced this pull request Dec 6, 2021
In PR appsignal/appsignal-nodejs#507
on the Node.js integration we renamed `apiKey` to `pushApiKey` to make
it more consistent with the other integrations. Update the code in the
installer to match.

[skip changeset] as users won't notice this change, it only makes it
more readable for us.
tombruijn added a commit to appsignal/appsignal-javascript that referenced this pull request Dec 6, 2021
In PR appsignal/appsignal-nodejs#507
on the Node.js integration we renamed `apiKey` to `pushApiKey` to make
it more consistent with the other integrations. Update the code in the
installer to match.

[skip changeset] as users won't notice this change, it only makes it
more readable for us.
tombruijn added a commit to appsignal/appsignal-javascript that referenced this pull request Dec 7, 2021
In PR appsignal/appsignal-nodejs#507
on the Node.js integration we renamed `apiKey` to `pushApiKey` to make
it more consistent with the other integrations. Update the code in the
installer to match.

I've only not updated the `validatePushApiKey` function, because that
meant updating the core package too. I think it would make more sense
to remove that function from the core package and use the Node.js
package's validator instead. Now we only use the core package for this
one function and that function is not used by the core package.

[skip changeset] as users won't notice this change, it only makes it
more readable for us.
[skip review] as it's only a variable name change.
tombruijn added a commit to appsignal/appsignal-javascript that referenced this pull request Dec 7, 2021
In PR appsignal/appsignal-nodejs#507
on the Node.js integration we renamed `apiKey` to `pushApiKey` to make
it more consistent with the other integrations. Update the code in the
installer to match.

I've only not updated the `validatePushApiKey` function, because that
meant updating the core package too. I think it would make more sense
to remove that function from the core package and use the Node.js
package's validator instead. Now we only use the core package for this
one function and that function is not used by the core package.

[skip changeset] as users won't notice this change, it only makes it
more readable for us.
[skip review] as it's only a variable name change.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants