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

feat: Do not return null as analyticsUrl for CI=true #76

Merged
merged 1 commit into from
Mar 11, 2021

Conversation

pgrzesik
Copy link
Contributor

@pgrzesik pgrzesik commented Mar 10, 2021

We would like to record events from CI as well as we plan to introduce CI detection and enrich analytics events with that information

Note: The plan is to release it as a major version to avoid changing behavior for older versions which won't include information about CI

@pgrzesik pgrzesik self-assigned this Mar 10, 2021
@pgrzesik pgrzesik added the enhancement New feature or request label Mar 10, 2021
@codecov
Copy link

codecov bot commented Mar 10, 2021

Codecov Report

Merging #76 (3350702) into master (41cd2c1) will increase coverage by 1.28%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #76      +/-   ##
==========================================
+ Coverage   90.14%   91.42%   +1.28%     
==========================================
  Files           9        9              
  Lines         213      210       -3     
==========================================
  Hits          192      192              
+ Misses         21       18       -3     
Impacted Files Coverage Δ
analytics-and-notfications-url.js 0.00% <ø> (ø)

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 41cd2c1...b5318af. Read the comment docs.

@pgrzesik pgrzesik requested a review from medikoo March 10, 2021 15:54
Copy link
Contributor

@medikoo medikoo left a comment

Choose a reason for hiding this comment

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

Thanks @pgrzesik

If we want to publish it as breaking change (which triggers new major release), we need to indicate this as breaking change in commit message.

@pgrzesik
Copy link
Contributor Author

pgrzesik commented Mar 10, 2021

Totally 👍 I've also started wondering a bit more about this specific check in wider context and what impact it could have e.g. on components - if I understand correctly, at the moment components only use that to trigger notifications and it totally makes sense to avoid triggering notifications in CI, not only for components but for Framework as well. Do you think it's safe @medikoo to change it as if I'm not mistaken it will report notifications for CI for people now?

@medikoo
Copy link
Contributor

medikoo commented Mar 10, 2021

if I understand correctly, at the moment components only use that to trigger notifications and it totally makes sense to avoid triggering notifications in CI

I'm not sure if it's a big concern. I think main reason for making this a breaking change, is that thanks to that we will not mix untracked and tracked CI events in scope of same version of a Framework, and that will allow us to keep data reliable in metrics service Dynamodb

@pgrzesik
Copy link
Contributor Author

That's correct @medikoo - what I was worried about is that now additonally, for all new versions, notifications can be also triggered for CI deployments, which this setting was preventing in a lot of cases.

@pgrzesik pgrzesik force-pushed the remove-ci-check-for-analytics-url branch 2 times, most recently from 87b3e3a to eaac873 Compare March 11, 2021 09:38
@pgrzesik pgrzesik requested a review from medikoo March 11, 2021 09:45
medikoo
medikoo previously approved these changes Mar 11, 2021
Copy link
Contributor

@medikoo medikoo left a comment

Choose a reason for hiding this comment

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

👍

I would just reword the commit. At least No longer return null feels very internal, and implementation specific.

I think it should be more something as: Expose analytics server URL unconditionally (and not just in non-CI environments)..

This message is expected to land as is in changelog, and unless justified I would not describe changes using JS language specific terms. Ideally if implementation details are black boxed

BREAKING CHANGE: Expose analytics server URL unconditionally (and not just
in non-CI environments) It is breaking as it might impact how analytics
reporting works in older version of the Framework and might pollute data
with unexpected events coming from CI deployments. Additonally, it will
cause notifications to be triggered in CI environments as well.
@pgrzesik
Copy link
Contributor Author

Good suggestion, I've reworded the commit a little bit 👍

Copy link
Contributor

@medikoo medikoo left a comment

Choose a reason for hiding this comment

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

Looks great 👍

@pgrzesik pgrzesik merged commit 9f7143e into master Mar 11, 2021
@pgrzesik pgrzesik deleted the remove-ci-check-for-analytics-url branch March 11, 2021 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants