Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: A base scrubber and a "Shared Access Signature" Scrubber #1939

Merged
merged 9 commits into from
Apr 27, 2023

Conversation

saileshbaidya
Copy link
Contributor

Related Issues/PRs

Task: 2363740
Close #2363740

#xxx

What changes are proposed in this pull request?

Our telemetry system has to avoid logging prohibited information like Shared Access Token, Secrets, etc.
This PR includes a foundational base class for Scrubbers. I am also adding a concrete scrubber SASScrubber to address the latest reported SAS token leaks.

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
Copy link

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.

@saileshbaidya
Copy link
Contributor Author

saileshbaidya commented Apr 25, 2023

/azp run


In reply to: 1522368604

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@codecov-commenter
Copy link

codecov-commenter commented Apr 25, 2023

Codecov Report

Merging #1939 (30550ba) into master (80430f1) will decrease coverage by 0.03%.
The diff coverage is 60.00%.

@@            Coverage Diff             @@
##           master    #1939      +/-   ##
==========================================
- Coverage   86.87%   86.84%   -0.03%     
==========================================
  Files         301      302       +1     
  Lines       15783    15786       +3     
  Branches      848      852       +4     
==========================================
- Hits        13712    13710       -2     
- Misses       2071     2076       +5     
Impacted Files Coverage Δ
...oft/azure/synapse/ml/logging/common/Scrubber.scala 0.00% <0.00%> (ø)
...crosoft/azure/synapse/ml/io/http/HTTPClients.scala 75.00% <100.00%> (ø)
...ft/azure/synapse/ml/logging/SynapseMLLogging.scala 80.00% <100.00%> (+0.83%) ⬆️

... and 2 files with indirect coverage changes

Copy link
Collaborator

@mhamilton723 mhamilton723 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done! Minor nits only

@saileshbaidya
Copy link
Contributor Author

saileshbaidya commented Apr 26, 2023

/azp run


In reply to: 1522686698

@azure-pipelines
Copy link

azure-pipelines bot commented Apr 26, 2023

Azure Pipelines successfully started running 1 pipeline(s).

In reply to: 1522686792

mhamilton723
mhamilton723 previously approved these changes Apr 26, 2023
@saileshbaidya
Copy link
Contributor Author

saileshbaidya commented Apr 26, 2023

/azp run


In reply to: 1523841003

@azure-pipelines
Copy link

azure-pipelines bot commented Apr 26, 2023

Azure Pipelines successfully started running 1 pipeline(s).

In reply to: 1523841245

@azure-pipelines
Copy link

Command 'run

In' is not supported by Azure Pipelines.



Supported commands

  • help:
    • Get descriptions, examples and documentation about supported commands
    • Example: help "command_name"
  • list:
    • List all pipelines for this repository using a comment.
    • Example: "list"
  • run:
    • Run all pipelines or specific pipelines for this repository using a comment. Use this command by itself to trigger all related pipelines, or specify specific pipelines to run.
    • Example: "run" or "run pipeline_name, pipeline_name, pipeline_name"
  • where:
    • Report back the Azure DevOps orgs that are related to this repository and org
    • Example: "where"

See additional documentation.

2 similar comments
@azure-pipelines
Copy link

Command 'run

In' is not supported by Azure Pipelines.



Supported commands

  • help:
    • Get descriptions, examples and documentation about supported commands
    • Example: help "command_name"
  • list:
    • List all pipelines for this repository using a comment.
    • Example: "list"
  • run:
    • Run all pipelines or specific pipelines for this repository using a comment. Use this command by itself to trigger all related pipelines, or specify specific pipelines to run.
    • Example: "run" or "run pipeline_name, pipeline_name, pipeline_name"
  • where:
    • Report back the Azure DevOps orgs that are related to this repository and org
    • Example: "where"

See additional documentation.

@azure-pipelines
Copy link

Command 'run

In' is not supported by Azure Pipelines.



Supported commands

  • help:
    • Get descriptions, examples and documentation about supported commands
    • Example: help "command_name"
  • list:
    • List all pipelines for this repository using a comment.
    • Example: "list"
  • run:
    • Run all pipelines or specific pipelines for this repository using a comment. Use this command by itself to trigger all related pipelines, or specify specific pipelines to run.
    • Example: "run" or "run pipeline_name, pipeline_name, pipeline_name"
  • where:
    • Report back the Azure DevOps orgs that are related to this repository and org
    • Example: "where"

See additional documentation.

@mhamilton723
Copy link
Collaborator

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@mhamilton723 mhamilton723 merged commit 60eb95c into microsoft:master Apr 27, 2023
@saileshbaidya saileshbaidya deleted the saibai/SASTokenScrubber branch April 27, 2023 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants