chore: Scala client for certified events

[saileshbaidya]

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Scala client for certified events api hosted on ML workload Admin endpoint.

How is this patch tested?

• I have written tests (not required for typo or doc fix) and confirmed the proposed feature/bug-fix/change works.

Does this PR change any dependencies?

• [* ] No. You can skip this section.
• Yes. Make sure the dependencies are resolved correctly, and list changes here.

Does this PR add a new feature? If so, have you added samples on website?

• [ *] No. You can skip this section.
• Yes. Make sure you have added samples following below steps.

1. Find the corresponding markdown file for your new feature in website/docs/documentation folder.
   Make sure you choose the correct class estimators/transformers and namespace.
2. Follow the pattern in markdown file and add another section for your new API, including pyspark, scala (and .NET potentially) samples.
3. Make sure the DocTable points to correct API link.
4. Navigate to website folder, and run yarn run start to make sure the website renders correctly.
5. Don't forget to add <!--pytest-codeblocks:cont--> before each python code blocks to enable auto-tests for python samples.
6. Make sure the WebsiteSamplesTests job pass in the pipeline.

[github-actions]

Hey @saileshbaidya 👋!
Thank you so much for contributing to our repository 🙌.
Someone from SynapseML Team will be reviewing this pull request soon.

We use semantic commit messages to streamline the release process.
Before your pull request can be merged, you should make sure your first commit and PR title start with a semantic prefix.
This helps us to create release messages and credit you for your hard work!

Examples of commit messages with semantic prefixes:

• fix: Fix LightGBM crashes with empty partitions
• feat: Make HTTP on Spark back-offs configurable
• docs: Update Spark Serving usage
• build: Add codecov support
• perf: improve LightGBM memory usage
• refactor: make python code generation rely on classes
• style: Remove nulls from CNTKModel
• test: Add test coverage for CNTKModel

To test your commit locally, please follow our guild on building from source.
Check out the developer guide for additional guidance on testing your change.

[github-actions]

Summary by GPT-4

The code changes include updates to the logging functionality in the SynapseML library. The updates include:

• Adding new classes and methods for handling JWT (JSON Web Tokens) and making HTTP requests.
• Updating existing logging methods to include a new parameter logCertifiedEvent which defaults to false. This parameter is used to determine whether or not to log a certified event.
• Adding new tests for the JWT token parser and host endpoint utilities.

The changes also remove an unnecessary newline character from two files: .gitignore and environment.yml.

Suggestions

The changes in this PR look good. However, there are a few suggestions for improvement:

1. In the SynapseMLLogging.scala file, the logBase method has been updated to include a new parameter logCertifiedEvent. It would be helpful to add comments explaining what this new parameter is for and how it affects the method's behavior.

2. In the same file, the logVerb method has been updated to include two new parameters: columns and logCertifiedEvent. Again, adding comments explaining these parameters would be beneficial.

3. The newly added files under the logging/Usage directory lack comments explaining their purpose and functionality. Adding such comments would improve code readability and maintainability.

4. In the test files (FabricTokenParserTests.scala, HostEndpointUtilsTests.scala), it would be helpful to add more detailed descriptions of what each test is checking for in a comment above each test.

5. There are several instances where lines of code have been removed from .gitignore, environment.yml, and manifest.yaml. If these changes are intentional, it might be helpful to explain why in the PR description.

6. Lastly, ensure that all new methods have appropriate unit tests to maintain code coverage.

[saileshbaidya]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[codecov-commenter]

Codecov Report

Merging #2045 (6a760a9) into master (21cff04) will decrease coverage by 10.86%.
The diff coverage is 41.17%.

❗ Current head 6a760a9 differs from pull request most recent head 5ef7c59. Consider uploading reports for the commit 5ef7c59 to get more accurate results

@@             Coverage Diff             @@
##           master    #2045       +/-   ##
===========================================
- Coverage   87.02%   76.16%   -10.86%     
===========================================
  Files         306      309        +3     
  Lines       16162    16259       +97     
  Branches      824      831        +7     
===========================================
- Hits        14065    12384     -1681     
- Misses       2097     3875     +1778     

Files	Coverage Δ
...ft/azure/synapse/ml/logging/SynapseMLLogging.scala	91.66% <91.66%> (-0.79%)	⬇️
...re/synapse/ml/logging/common/PlatformDetails.scala	70.58% <70.58%> (ø)
...ft/azure/synapse/ml/logging/fabric/RESTUtils.scala	0.00% <0.00%> (ø)
...napse/ml/logging/fabric/CertifiedEventClient.scala	33.92% <33.92%> (ø)

... and 61 files with indirect coverage changes

[saileshbaidya]

/azp run

[saileshbaidya]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[mhamilton723]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[mhamilton723]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).