Followup for [Beta][Task]15982357: Dynamic config for Properties extension #1972 #1976

MSNev · 2023-01-27T00:16:03Z

Add ability to tag Dynamic Config properties as referenced to support updating extensionConfig in-place with a new object instance
Add IUnloadHookContainer to allow passing extension level unload hook container to sub-components

MSNev · 2023-01-27T00:17:51Z

extensions/applicationinsights-properties-js/Tests/Unit/src/SessionManager.Tests.ts

@@ -64,13 +64,12 @@ export class SessionManagerTests extends AITestClass {
            test: () => {

                var sessionPrefix = newId();
-                var config = {
+                var config = createDynamicConfig({


As the Session Manager now supports onConfigChange the passed in configuration needs to already be a dynamic configuration instance (which it will be already when initialized via the Core).

So for testing we need to simulate the same situation.

MSNev · 2023-01-27T00:22:21Z

extensions/applicationinsights-properties-js/Tests/Unit/src/properties.tests.ts

+                } as IPropertiesConfig;
+
+                core.config.extensionConfig =  core.config.extensionConfig?  core.config.extensionConfig : {};
+                core.config.extensionConfig[id] = newConfig;


This is the "Key" change from the previous test, where this will cause the properties of newConfig to be copied to core.config.extensionConfig[id] rather than getting directly assigned (and overwriting) the previous value.
This occurs because the extensionConfig and its properties are marked as referenced (using the new ref()) as part of the dynamic configuration.

This is required because the PropertiesPlugin passes down it's configuration to its supporting components, and if this allowed the config to be "replaced" those support components would never be notified or receive the "updated/changed" configuration values (because they would be a different object instance)

MSNev · 2023-01-27T00:24:04Z

extensions/applicationinsights-properties-js/Tests/Unit/src/properties.tests.ts

@@ -962,7 +1180,6 @@ export class PropertiesTests extends AITestClass {

    private getTelemetryConfig(): IPropertiesConfig {
        return {
-            instrumentationKey: "",


This should never have been on the IPropertiesConfig as it's never used or referenced from here, it's only ever used from the root (IConfiguration) definition -- So the removal is just removing dead code (defaults) and definitions.

MSNev · 2023-01-27T00:28:02Z

extensions/applicationinsights-properties-js/src/Context/Internal.ts

            let prefix =  config.sdkExtension;
            this.sdkVersion = (prefix ? prefix + "_" : "") + "javascript:" + Version;
        });
+
+        unloadHookContainer && unloadHookContainer.add(unloadHook);


We always need to "register" (add()) the returned value from the onConfigChange() because it has internal side-effects that indirectly cause the callback function (the listener) to be associated with and referenced configuration item. And if the unloadHook is never called all of these internal references would cause this class instance to never be garbage collected, which would result in a "memory leak" (because of the possibility of multiple instances getting left behind as referenced -- lots of assumptions in this statement and this edge case)

MSNev · 2023-01-27T00:29:02Z

extensions/applicationinsights-properties-js/src/Context/Session.ts


        dynamicProto(_SessionManager, self, (_self) => {

            if (!config) {
                config = ({} as any);
            }

+            let unloadHook = onConfigChange(config, (details) => {
+                _sessionExpirationMs = config.sessionExpirationMs || ACQUISITION_SPAN;


Just converting these back to local variables to avoid function calls on every usage (this was what the TODO was about)

MSNev · 2023-01-27T00:30:46Z

shared/AppInsightsCore/Tests/Unit/src/DynamicConfig.Tests.ts

@@ -553,6 +561,196 @@ export class DynamicConfigTests extends AITestClass {
            }
        });

+        this.testCase({


Additional tests to validate the new ref() and rdOnly() functionality for dynamic configuration items.

MSNev · 2023-01-27T00:32:51Z

shared/AppInsightsCore/src/Config/DynamicProperty.ts

            target[name] = value;
        }
+
+        // Assign the optional flags if true


By-design that once "marked" as referenced or read-only there is no going back (ie. there is no unref or read-write option).

MSNev · 2023-01-27T00:33:10Z

shared/AppInsightsCore/src/Config/DynamicState.ts

- * @internal
- * @ignore
- */
-interface _IWaitingHandlers<T> {


Not used anymore

MSNev · 2023-01-27T00:37:28Z

shared/AppInsightsCore/src/JavaScriptSDK/BaseTelemetryPlugin.ts

            proxyFunctionAs(_self, "_addUnloadCb", () => _unloadHandlerContainer, "add");
+            proxyFunctionAs(_self, "_addHook", () => _hookContainer, "add");
+            objDefine(_self, "_unloadHooks" as keyof BaseTelemetryPlugin, { g: () => _hookContainer });


Using objDefine instead of just assigning for

supporting unload / re-initializing a plugin which will change the value or _hookContainer without re-defining in initialize

Using objDefine means we can explicitly enforce the read-only nature of this property so it can never be externally changed.

…nsion #1972 - Add ability to tag Dynamic Config properties as referenced to support updating extensionConfig in-place with a new object instance - Add IUnloadHookContainer to allow passing extension level unload hook container to sub-components

MSNev requested review from ramthi, hectorhdzg, JacksonWeber and Karlie-777 January 27, 2023 00:16

MSNev commented Jan 27, 2023

View reviewed changes

MSNev requested a review from siyuniu-ms January 27, 2023 00:38

MSNev force-pushed the MSNev/ExtCfgIssue branch from 8602e08 to 6ac4186 Compare January 27, 2023 16:10

MSNev force-pushed the MSNev/ExtCfgIssue branch from 6ac4186 to e1ca5e2 Compare January 27, 2023 16:11

Karlie-777 approved these changes Jan 27, 2023

View reviewed changes

MSNev merged commit af91881 into beta Jan 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Followup for [Beta][Task]15982357: Dynamic config for Properties extension #1972 #1976

Followup for [Beta][Task]15982357: Dynamic config for Properties extension #1972 #1976

MSNev commented Jan 27, 2023

MSNev Jan 27, 2023

MSNev Jan 27, 2023

MSNev Jan 27, 2023

MSNev Jan 27, 2023

MSNev Jan 27, 2023

MSNev Jan 27, 2023

MSNev Jan 27, 2023

MSNev Jan 27, 2023

MSNev Jan 27, 2023

Followup for [Beta][Task]15982357: Dynamic config for Properties extension #1972 #1976

Followup for [Beta][Task]15982357: Dynamic config for Properties extension #1972 #1976

Conversation

MSNev commented Jan 27, 2023

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