Releases · microsoft/ApplicationInsights-JS

This release includes support for a new Offline Channel which has changed the IChannelsControls interface to include additional support for the new offline channel. This change is to support the new offline channel and is a breaking change for any custom channels that implement the IChannelsControls interface. If you have a custom channel that implements the IChannelsControls interface you will need to update your implementation to include the new offline channel.

Configuration default changes

As this is a minor version bump we have also change some default values for the following configuration options:

disableUserInitMessage is now true by default to disable the user init message.

Potential breaking change

This release contains a potential break change with 'tags' type change

While the interface changes are breaking changes, the changes are not expected to affect the majority of users as when the code attempted to serialize the tags property it would have failed due to the Tags[] type being used instead of the correct Tags type.

Old

    tags?: Tags & Tags[];

New

    tags?: Tags;

New Offline Channel

This release also includes the new offline channel which is a new channel that is designed to support offline scenarios. The offline channel is designed to store telemetry items in local storage and then send them when the user comes back online.
To take full advantage of the initial version you will need to implement your own IOfflineListener to handle situations where you may have "network" connectivity but not internet access. As the navigator.onLine property if available will only tell you if you have network connectivity and not internet access.

Changelog

#2186 [main] offlineListener preparation
#2241 [Main][Task]26451789: Add Offline Support
#2259 [Main][Task]26694421: Add Offline Support Publish Group
#2267 [Main][Task]26681220: Better handle timers in offline channel
#2028 [BUG] AI (Internal): 72 tracking
- Sets the default value for the disableUserInitMessage to true (was previously false since adding)
#2193 [main] Add extra config in sender to let users define transports type
#2200 [main] [doc] Highlight an issue with the default UMD module format when loading from the CDN into an environment that may have require.js
#2208 [Main][Task]26079397: Add disableBeaconSplit sender config and fix potential duplicated events during unload/fallback sender
- #2236 [Main][Task]26396663: Set default disableBeaconSplit to true
#2204 [BUG] Beacon sender reports error for success when diagnostics are enabled
#2214 [main] Merge Release-3.0 to main
#2221 [main] Fixup the ci.yml to address internal hash changes between different node versions
#2216 [Main][Task]26138416: Fix FetchKeepAliveSender send duplicated events during unload
#2228 [main] minor release preparation
#2229 [main] [doc] add requireJs problem in SdkLoadFailure.md
#2132 [BUG] Submitting NaN via trackEvent results in HTTP 400 Error Code
#2238 [Main] Merge release-3.0 to main
#2244 Internal Task: Update npm pack sequence
#2249 [main][1ds] Enhance Retry Policy Testing for Alignment with Collector Policy
#2245 [main] [snippet update] add functions to set configs of snippet
#2250 [main] [doc] minor comment update for avoidOptions
#2251 [Main][1DS][Post] Add support for the ext.metadata to NOT be included
#2253 [Main] Update Tests to support upcoming change in nevware21/tsutils dumpObj to better support JSON stringify and handle PURE comments
#2255 [main] #2225 pass customer exception id into telemetry
#2247 [main] [1ds-post] export add header func for auth-plugin to consume
#2209 [BUG] stopTrackEvent requires property values to be strings
- #2268 [main] Add example of how to use stopTrackEvent #2209
- #2270 [main] correct types define for stopTrackEvent and stopTrackPage for #2209
#2258 [BUG] ITelemetryItem uses intersection type instead of union type for tags property
- #2269 [main] [Possible Break] Removed Tags[] from ITelemetryItem as this was breaking later versions of TypeScript by using the intersection type instead of union type for tags property
#2272 [release 3.0.8] Fix channel test
#2271 Cherry-pick from release-3.0 branch
- [Release-3.0] [Release] Increase version to 3.0.8 ([Release-3.0] [Release] Increase version to 3.0.8 #2264)
- [Release-3.0] Update namespaced types (DTS) generation to include referenced bundles

What's Changed

[Main] Include Config sync in publish group by @MSNev in #2160
[main] update snippet ver to 7 and set gbl moudle as default by @siyuniu-ms in #2156
[main] use proper URL for tracking when fetch is passed an empty string by @jorupp in #2165
[main] correct throttle configdefault setting in aisku by @siyuniu-ms in #2166
[Main][Task]16238553: Provide an override option for the Sender by @Karlie-777 in #2113
[Main][Task]24499167: add cfgSync plugin doc by @Karlie-777 in #2168
[Main][Task]24499172: add throttle manager doc by @Karlie-777 in #2169
[Main][Task]24499174: Add service notification doc by @Karlie-777 in #2170
[main] test aisku config could correctly merge new config fetch from cdn by @siyuniu-ms in #2171
[main] Update Service Notifications to not send message twice by @siyuniu-ms in #2175
Add Issue state reporting script by @MSNev in #2173
[main] remove double slash for endPointUrl by @siyuniu-ms in #2174
[main] use helper func to get window by @siyuniu-ms in #2178
[Main]Set CfgSync version to 3.0.3 by @siyuniu-ms in #2177
[main] fix startTime timestamp by @siyuniu-ms in #2183
[Main][Release] Increase version to 3.0.4 by @siyuniu-ms in #2176
[main] retrieve reponseText when fetch in HttpManager by @siyuniu-ms in #2185
[main] deactive send beacon when local storage is available by @siyuniu-ms in #2184
[main] generate typedoc by @siyuniu-ms in #2188
[Main][Task]25648004: Export ISenderConfig from Sender by @Karlie-777 in #2190
[Main][Task]25649658: Update AISKU Light to add default baseType and baseData when calling track function by @Karlie-777 in #2191
[Main][Release] Increase version to 3.0.5 by @siyuniu-ms in #2192
[main] offlineListener preparation by @siyuniu-ms in #2186
[main] Add config to let user disable the UserAgent AI Internal for #2028 by @siyuniu-ms in #2196
[main] Add extra config in sender to let users define transports type by @siyuniu-ms in #2193
[main] [doc] Highlight an issue with the default UMD module format when loading from the CDN into an environment that may have require.js #14493816 by @siyuniu-ms in #2200
[main] fix 3.0.3 release note for missing pr by @siyuniu-ms in #2206
[Main][Task]26079397: Add disableBeaconSplit sender config and fix potential duplicated events during unload/fallback sender by @Karlie-777 in #2208
[Main][BUG] Beacon sender reports error for success when diagnostics are enabled #2204 by @MSNev in #2212
[main] Merge Release-3.0 to main by @MSNev in #2214
[main] Fixup the ci.yml to address internal hash changes between different node versions by @MSNev in #2221
[Main][Task]26138416: Fix FetchKeepAliveSender send duplicated events during unload by @Karlie-777 in #2216
[main] disable sdk load error send #1672 by @siyuniu-ms in #2207
[main] minor release preparation by @siyuniu-ms in #2228
[main] [doc] add requireJs problem in SdkLoadFailure.md by @siyuniu-ms in #2229
[Main] v3.1.x change Disable UserAgent config to true by default #2028 by @siyuniu-ms in #2231
[Main][Task]26396663: Set default disableBeaconSplit to true by @Karlie-777 in #2236
[main] [BUG] Submit...

Contributors

jorupp, MSNev, and 3 other contributors

Assets 2

07 Feb 17:20

MSNev

3.0.8

153bded

3.0.8

This release changes the new beacon splitting code (added in 3.0.4) to be disabled by default. This change is to address the issue where the SDK was splitting the payload into multiple requests when the payload size exceeded the maximum allowed size for a single request. This issue was introduced in the 3.0.4 release and only affects the sendBeacon usage during page unload, it does not affect the fetch usage during page unload. This change is to address the issue where the SDK was splitting the payload into multiple requests when the payload size exceeded the maximum allowed size for a single request. This issue was introduced in the 3.0.4 release and only affects the sendBeacon usage during page unload, it does not affect the fetch usage during page unload.

Changelog

#2235 [BUG] - CRITICAL - Application runs out of memory
- #2236 [release-3.0] Cherry-Pick: [Main][Task]26396663: Set default disableBeaconSplit to true
#2242 [release-3.0] Update components
- Update @microsoft/dynamicProto-js to address possible prototype pollution issue
#2254 [Release3.0] Update Tests to support upcoming change in nevware21/tsutils dumpObj to better support JSON stringify and handle PURE comments
[Release 3.0] Update components for release #2261
- Update @nevware21/ts-utils version for better minification support

What's Changed

[release-3.0] Cherry-Pick: [Main][Task]26396663: Set default disableBeaconSplit to true (#2236) by @MSNev in #2239
[release-3.0] Update components by @MSNev in #2242
[Release3.0] Update Tests to support upcoming change in nevware21/tsutils dumpObj to ... by @nev21 in #2254
[Release 3.0] Update components for release by @MSNev in #2261
[Release-3.0] [Release] Increase version to 3.0.8 by @MSNev in #2264

Full Changelog: 3.0.7...3.0.8

Contributors

MSNev and nev21

Assets 2

07 Feb 17:05

MSNev

2.8.17

1a87442

2.8.17

Changelog

#2163 [Master] [BUG] Using App Insights connection string leads to double slash
#2260 [Master] Bump @microsoft/dynamicProto-js to ^1.1.11 from ^1.1.9
- Addresses a potential prototype pollution issue

What's Changed

[Master] Bump @microsoft/dynamicProto-js to ^1.1.11 from ^1.1.9 by @MSNev in #2260
[Master] [BUG] Using App Insights connection string leads to double slash #2163 by @MSNev in #2262
[Master][Release] Increase version to 2.8.17 by @MSNev in #2263

Full Changelog: 2.8.16...2.8.17

Contributors

MSNev

Assets 2

14 Dec 18:55

MSNev

3.0.7

ac9c516

3.0.7

This release is a hotfix for issue #2216, which is simular to the issue fixed in 3.0.6 but for the fetch (with the keep-alive flag).

Changelog

#2216 [release-3.0] Cherrypick (main): fix fetchkeepalive
#2221 [release-3.0] Cherrypick (main): Fixup the ci.yml to address internal hash changes between different node versions

What's Changed

[release-3.0] Fixup v3.0.6 release notes by @MSNev in #2213
[release-3.0] Fixup the ci.yml to address internal hash changes between different node versions (#2221) by @MSNev in #2222
[release-3.0] Cherrypick: fix fetchkeepalive (#2216) by @MSNev in #2223
[release-3.0][Release] Increase version to 3.0.7 by @MSNev in #2224

Full Changelog: 3.0.6...3.0.7

Contributors

MSNev

Assets 2

07 Dec 20:20

MSNev

3.0.6

a564e42

3.0.6

This release fixes an issue with the sendBeacon usage during page unload, where the SDK was not correctly splitting the payload into multiple requests when the payload size exceeded the maximum allowed size for a single request. This issue was introduced in the 3.0.4 release and only affects the sendBeacon usage during page unload, it does not affect the fetch usage during page unload.

Changelog

#2195 [BUG] Beacon sender causes flood of thousands of requests on page unload
#2201 [BUG] applicationinsights.azure.com/v2/track making hundreds of thousands of requests when third party cookies are disabled
#2205 [BUG] Duplicate customEvent entries
#2204 [BUG] Beacon sender reports error for success when diagnostics are enabled

What's Changed

[Main][Task]26079397: Add disableBeaconSplit sender config and fix potential duplicated events during unload/fallback sender (#2208) by @MSNev in #2210
[Release-3.0][Release] Increase version to 3.0.6 by @MSNev in #2211

Full Changelog: 3.0.5...3.0.6

Contributors

MSNev

Assets 2

02 Nov 23:29

siyuniu-ms

3.0.5

9dda05c

3.0.5

3.0.5 (Nov 1st, 2023)

Changelog

#2184 [main] deactive send beacon when local storage is available
#2185 [main] retrieve reponseText when fetch in HttpManager
#2188 [main] generate typedoc
#2190 [Main][Task]25648004: Export ISenderConfig from Sender
#2191 [Main][Task]25649658: Update AISKU Light to add default baseType and baseData when calling track function

What's Changed

[main] retrieve reponseText when fetch in HttpManager by @siyuniu-ms in #2185
[main] deactive send beacon when local storage is available by @siyuniu-ms in #2184
[main] generate typedoc by @siyuniu-ms in #2188
[Main][Task]25648004: Export ISenderConfig from Sender by @Karlie-777 in #2190
[Main][Task]25649658: Update AISKU Light to add default baseType and baseData when calling track function by @Karlie-777 in #2191
[Main][Release] Increase version to 3.0.5 by @siyuniu-ms in #2192

Full Changelog: 3.0.4...3.0.5

Contributors

Karlie-777 and siyuniu-ms

Assets 2

23 Oct 23:12

siyuniu-ms

3.0.4

e535c94

3.0.4

3.0.4 (Oct 16th, 2023)

Changelog

#2162 [BUG] window is not defined at _getStackFromErrorObj
#2163 [BUG] Using App Insights connection string leads to double slash
#2164 [BUG] Fetch with empty string as first parameter does not include traceparent and does not successfully save dependency to Application Insights
#2180 [BUG] Same timestamp on multiple pageView-events after upgrade to 3.0.3
CfgSyncPlugin improvment
- #2166 [main] correct throttle configdefault setting in aisku
- #2168 [Main][Task]24499167: add cfgSync plugin doc
- #2171 [main] test aisku config could correctly merge new config fetch from cdn
- #2175 [main] Update Service Notifications to not send message twice
- #2177 [Main]Set CfgSync version to 3.0.3
- #2160 [Main] Include Config sync in publish group
Documentation update
- #2169 [Main][Task]24499172: add throttle manager doc
- #2170 [Main][Task]24499174: Add service notification doc
Github workflow improvement
- #2173 Add Issue state reporting script
Sender Update
- #2113 [Main][Task]16238553: Provide an override option for the Sender

What's Changed

[Main][Task]16238553: Provide an override option for the Sender by @Karlie-777 in #2113
[Main] Include Config sync in publish group by @MSNev in #2160
[main] update snippet ver to 7 and set gbl moudle as default by @siyuniu-ms in #2156
[main] use proper URL for tracking when fetch is passed an empty string by @jorupp in #2165
[main] correct throttle configdefault setting in aisku by @siyuniu-ms in #2166
[Main][Task]16238553: Provide an override option for the Sender by @Karlie-777 in #2113
[Main][Task]24499167: add cfgSync plugin doc by @Karlie-777 in #2168
[Main][Task]24499172: add throttle manager doc by @Karlie-777 in #2169
[Main][Task]24499174: Add service notification doc by @Karlie-777 in #2170
[main] test aisku config could correctly merge new config fetch from cdn by @siyuniu-ms in #2171
[main] Update Service Notifications to not send message twice by @siyuniu-ms in #2175
Add Issue state reporting script by @MSNev in #2173
[main] remove double slash for endPointUrl by @siyuniu-ms in #2174
[main] use helper func to get window by @siyuniu-ms in #2178
[Main]Set CfgSync version to 3.0.3 by @siyuniu-ms in #2177
[main] fix startTime timestamp by @siyuniu-ms in #2183
[Main][Release] Increase version to 3.0.4 by @siyuniu-ms in #2176

Full Changelog: 3.0.3...3.0.4

Contributors

jorupp, MSNev, and 2 other contributors

Assets 2

21 Sep 20:12

MSNev

3.0.3

4eabbbb

3.0.3

Changelog

#2157 [Main] Bug New minified bundles are corrupting global scope
#2120 Missing traceparent header when running multiple SDK instances
- #2144 [Main][Part 2] Missing traceparent header when running multiple SDK instances #2120
- #2141 [Main][Bug] Missing traceparent header when running multiple SDK instances #2120
#2149 [BUG] Fetch with empty string as first parameter ignores second parameter when fetch tracking is enabled
- #2152 [main] allow empty string as first parameter to fetch
#2127 [Main] Add automated ability to reset the npm latest tag to a specific build
#2106 Consider export IClickAnalyticsConfiguration from the click plugin?
#2086 [BUG] Field 'fileName' on type 'StackFrame' is too long. Expected: 1024 characters
- #2118 [Main] [BUG] Field 'fileName' on type 'StackFrame' is too long. Expected: 1024 characters #2086
#2094 _getVerifiedStorageObject - contentious sessionStorage element
- #2110 [main] add prefix before storage name when setting it
#2137 [Main] Fix: edge case where the navigation entry is not present
#2135 Update @nevware21 base versions
#2104 [main] Use the navigation entry timeing for page load event start time
#2116 [Main] Fixup setVersion to support automated nightly release
#2097 disablePageUnloadEvents lost somewhere #2097
Internal Task 15757413: [VSCode] [1DS] Move 1DS Core and 1DS Post to GitHub #2102
#2089 [BUG] The v3.x exporting of the TelemetryContext does not export the sessionManager "type"
[BUG] Readme Issue for perfmarkmeasure @microsoft/applicationinsights-applicationinsights-perfmarkmeasure-js@ #2150
#2139 V3 Public CDN URL
#2093 Update project clean to make faster
Add support for service level notifications (disabled by default in this release, will be enabled by default in a future release)
- #2147 [main] throttle manager in aisku sending message
- #2133 [Main][Task]24841107: Refactor throttleMgr to support multiple message keys
- #2090 [Main][Task]17874465:Support Config sync across instances
- #2125 [Main][Task]24677395:add configurations for CDN to enable specific users opt-in implementation
- #2115 [Main][Task]24662146: cfgSync plugin improvement: timer handling for fetch/xhr
SDK Loader Updates (version 7 - will be published after this release is deployed to the CDN)
- #2091 rework web snippet (Convert to TypeScript)
- #2099 change loader src when detect IE
- #2098 Extend the config part in Min
- #2131 [main] Adding round robin retry for snippet script src loading

What's Changed

[Main] Reformat release notes by @MSNev in #2085
rework web snippet by @siyuniu-ms in #2091
Update project clean to make faster by @MSNev in #2093
change loader src when detect IE by @siyuniu-ms in #2099
Extend the config part in Min by @siyuniu-ms in #2098
[Main][Task]17874465:Support Config sync across instances by @Karlie-777 in #2090
Internal Task 15757413: [VSCode] [1DS] Move 1DS Core and 1DS Post to GitHub by @MSNev in #2102
Consider export IClickAnalyticsConfiguration from the click plugin? #2106 by @MSNev in #2108
[BUG] The v3.x exporting of the TelemetryContext does not export the sessionManager "type" #2089 by @MSNev in #2112
disablePageUnloadEvents lost somewhere #2097 by @MSNev in #2111
[main] add prefix before storage name when setting it by @siyuniu-ms in #2110
[Main][Task]24662146: cfgSync plugin improvement: timer handling for fetch/xhr by @Karlie-777 in #2115
[Main] Fixup setVersion to support automated nightly release by @MSNev in #2116
[main] assign LoadEventStart time to Time by @siyuniu-ms in #2104
[Main] [BUG] Field 'fileName' on type 'StackFrame' is too long. Expected: 1024 characters #2086 by @MSNev in #2118
[main] test version conflict and wirte documentation by @siyuniu-ms in #2123
[Main] Add automated ability to reset the npm latest tag to a specific build by @MSNev in #2127
[Main][Task]24841107: Refactor throttleMgr to support multiple message keys by @Karlie-777 in #2133
Update @nevware21 base versions by @MSNev in #2135
[Main] Fix: edge case where the navigation entry is not present by @MSNev in #2137
[Main][Task]24841107: Refactor throttleMgr to support multiple message keys by @Karlie-777 in #2142
[Main][Bug] Missing traceparent header when running multiple SDK instances #2120 by @MSNev in #2141
[main] Adding round robin retry for snippet script src loading by @siyuniu-ms in #2131
[Main][Part 2] Missing traceparent header when running multiple SDK instances #2120 by @MSNev in #2144
[Main][Task]24677395:add configurations for CDN to enable specific users opt-in implementation by @Karlie-777 in #2125
[Main][Task]25113121: Add isFeatureEnable helper function to core by @Karlie-777 in #2148
[main] throttle manager in aisku sending message by @siyuniu-ms in #2147
[Main] Bug New minified bundles are corrupting global scope by @MSNev in #2157
[main] allow empty string as first parameter to fetch by @jorupp in #2152
[Main][Release] Increase version to 3.0.3 by @MSNev in #2159

New Contributors

@jorupp made their first contribution in #2152

Full Changelog: 3.0.2...3.0.3

Contributors

jorupp, MSNev, and 3 other contributors

Assets 2

19 Sep 19:46

MSNev

2.8.16

feb5ad7

2.8.16

Changelog

#2155 [Master] Bug [AI/1DS] New minified bundles are corrupting global scope (p1 issue)
#2151 Bug 25182794: [AI] Minified CDN version has an extra "use strict" outside of the closure
#2120 Missing traceparent header when running multiple SDK instances
- #2140 [Master][Bug] Missing traceparent header when running multiple SDK instances #2120
- #2143 [Master][Part 2] Missing traceparent header when running multiple SDK instances #2120
#2149 [BUG] Fetch with empty string as first parameter ignores second parameter when fetch tracking is enabled
- #2154 [Master][BUG] Fetch with empty string as first parameter ignores second parameter when fetch tracking is enabled #2149
#2128 [Master] Update publishing config to avoid resetting the "latest" version for older releases

What's Changed

[Master] Update publishing config to avoid resetting the "latest" version for older releases by @MSNev in #2128
[Master][Bug] Missing traceparent header when running multiple SDK instances #2120 by @MSNev in #2140
[Master][Part 2] Missing traceparent header when running multiple SDK instances #2120 by @MSNev in #2143
Bug 25182794: [AI] Minified CDN version has an extra "use strict" outside of the closure by @MSNev in #2151
[Master][BUG] Fetch with empty string as first parameter ignores second parameter when fetch tracking is enabled #2149 by @MSNev in #2154
[Master] Bug [AI/1DS] New minified bundles are corrupting global scope by @MSNev in #2155
[Master][Release] Increase version to 2.8.16 by @MSNev in #2158

Full Changelog: 2.8.15...2.8.16

Contributors

MSNev

Assets 2

Releases: microsoft/ApplicationInsights-JS

2.8.18

Changelog

What's Changed

Contributors

3.1.0

Changelog

Interface changes / Breaking changes

Configuration default changes

Potential breaking change

Old

New

New Offline Channel

Changelog

What's Changed

Contributors

3.0.8

Changelog

What's Changed

Contributors

2.8.17

Changelog

What's Changed

Contributors

3.0.7

Changelog

What's Changed

Contributors

3.0.6

Changelog

What's Changed

Contributors

3.0.5

3.0.5 (Nov 1st, 2023)

Changelog

What's Changed

Contributors

3.0.4

3.0.4 (Oct 16th, 2023)

Changelog

What's Changed

Contributors

3.0.3

Changelog

What's Changed

New Contributors

Contributors

2.8.16

Changelog

What's Changed

Contributors