fix(metrics): emit warning when default dimensions are overwritten

[uttam282005]

Summary

Adds warning messages to the Metrics setDefaultDimensions method when overwriting existing default dimensions, ensuring consistency and parity with addDimension/addDimensions methods.

Changes

This pull request improves the robustness of the setDefaultDimensions method in the Metrics utility by:

• Moved setEnvConfig() and setConsole() calls from setOptions() to the constructor to ensure logger is initialized before any method uses it.
• Ensuring it gracefully handles undefined, null, and invalid values for default dimensions.
• Updated the setDefaultDimensions() method in the Metrics utility to emit a warning when a default dimension is being overwritten.
• Logging a warning if an invalid dimension name or value is provided (i.e., non-string or empty).
• Adding new unit tests to verify the above behaviors, including:
  • Ensuring that calling setDefaultDimensions(undefined) results in immediate return, with no warning emitted and only default dimensions applied.
  • Verifying that invalid dimension values (undefined, null, empty strings) or names are skipped, a warning is emitted in the console, and only valid dimensions are set.

This PR addresses #4134 by improving input validation and error reporting for the setDefaultDimensions method in the Metrics module, to prevent invalid dimension names/values from being set.

Issue number: #4134

Tests Added

The following tests were added:

it('returns immediately if dimensions is undefined', () => {
  // Prepare
  const metrics = new Metrics({
    singleMetric: true,
    namespace: DEFAULT_NAMESPACE,
  });
  // Act
  metrics.setDefaultDimensions(undefined);
  metrics.addMetric('myMetric', MetricUnit.Count, 1);
  // Assess: No warning, only default dimensions/service
  expect(console.warn).not.toHaveBeenCalled();
  expect(console.log).toHaveEmittedEMFWith(
    expect.objectContaining({
      service: 'hello-world',
    })
  );
});

it.each([
  { value: undefined, name: 'valid-name' },
  { value: null, name: 'valid-name' },
  { value: '', name: 'valid-name' },
  { value: 'valid-value', name: '' },
])(
  'skips invalid default dimension values in setDefaultDimensions ($name)',
  ({ value, name }) => {
    // Arrange
    const metrics = new Metrics({
      singleMetric: true,
      namespace: DEFAULT_NAMESPACE,
    });

    // Act
    metrics.setDefaultDimensions({
      validDimension: 'valid',
      [name as string]: value as string,
    });

    metrics.addMetric('test', MetricUnit.Count, 1);
    metrics.publishStoredMetrics();

    // Assert
    expect(console.warn).toHaveBeenCalledWith(
      `The dimension ${name} doesn't meet the requirements and won't be added. Ensure the dimension name and value are non empty strings`
    );

    expect(console.log).toHaveEmittedEMFWith(
      expect.objectContaining({ validDimension: 'valid' })
    );

    expect(console.log).toHaveEmittedEMFWith(
      expect.not.objectContaining({ [name]: value })
    );
  }
);

setDefaultDimensions Update

• Modified to emit a warning if a dimension name or value does not meet requirements (non-empty string).

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[sdangol]

Thanks for the PR! I've added a few minor comments

[sdangol]

Thanks a lot for the contribution and for making the changes @uttam282005. Really appreciate it.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[svozza]

Great work @uttam282005! This will be included in today's release.

[sdangol]

Hi @uttam282005, we were trying to do a release today but our e2e tests were failing. We realized that there were duplicate logs being generated. This seems to be because of the setDefaultDimensions method being called in multiple places without invoking it explicitly. I've created an issue for this: #4227
Would you like to work on a fix for this?

[uttam282005]

Thanks for flagging this @sdangol, and apologies for the oversight. I’d be happy to work on a fix.

[svozza]

Absolutely no need to apologise! This is why we have E2E tests because it's very hard to know how all the pieces in a module interact when you're working on a specific piece of the code base.