Consistent logs (@W-15832306@)

[adamraya]

Description

The PR implements a createLogger instance for each package to be used by the logs generated in the PWA Kit packages. The logger uses the console object adding a consistent format to the message we want to print.

1. Proposes a consistent namespace for all default logs generated by PWA Kit to facilitate filtering and analyzing logs. 1.1. The namespace consists of 'packageName.component.action' where the log message is printed. 1.2. The optional additionalProperties defines any other additional properties to include in the log message.

2. Incoming request logs use the log level equivalent to the response status code. i.e. console.info for statusCode<400 console.error for statusCode >= 400

~~3. The environment variable PWAKIT_LOG_LEVEL defines the log level to filter the logs generated by PWA Kit server-side.

4. The environment variable PWAKIT_LOG_FORMAT defines the format in which to print log messages server-side. It can be 'JSON' or 'TEXT'.
5. The createLogger clientConfig object optional parameter allows users to define the format and logLevel for the client-side logs. E.g. createLogger('package-name', clientConfig(format, logLevel)~~

Example using the logger utility: https://github.com/SalesforceCommerceCloud/pwa-kit/blob/05d7c8b0e0f00f48f2af989513b869bd50794290/packages/template-retail-react-app/app/components/_app/index.jsx#L157-L168

Related PR https://github.com/SalesforceCommerceCloud/pwa-kit/pull/1828: Replace all the console statements in PWA Kit with the equivalent logger

Types of Changes

• [ ] Bug fix (non-breaking change that fixes an issue)
• [ ] New feature (non-breaking change that adds functionality)
• [ ] Documentation update
• [ ] Breaking change (could cause existing functionality to not work as expected)
• [ ] Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

• Removing a public function or component or prop
• Adding a required argument to a function
• Changing the data type of a function parameter or return value
• Adding a new peer dependency to package.json

Changes

• Incoming requests using the log Level equivalent to the status code.
• Consistent namespace for all logs generated by default by PWA Kit

How to Test-Drive This PR

• Start the dev server: npm start
• Load the storefront http://localhost:3000/ and observe the logs in the terminal.

Checklists

General

• [ ] Changes are covered by test cases
• [ ] CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

• [ ] There are no changes to UI

or...

• [ ] Changes were tested with a Screen Reader (iOS VoiceOver or Android Talkback) and had no issues
• [ ] Changes comply with WCAG 2.0 guidelines levels A and AA
• [ ] Changes to common UI patterns and interactions comply with WAI-ARIA best practices

Localization

• [ ] Changes include a UI text update in the Retail React App (which requires translation)