chore: build a JSON blueprint to redact object values #33113
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GavinZZ
force-pushed
the
yuanhaoz/feat/metadata-collection-importer2
branch
from
9584b0d to
6eccb25
Compare
GavinZZ
changed the base branch from
main
to
yuanhaoz/feat/metadata-collection
GavinZZ
force-pushed
the
yuanhaoz/feat/metadata-collection-importer2
branch
from
6eccb25 to
5940fc3
Compare
GavinZZ
changed the base branch from
yuanhaoz/feat/metadata-collection
to
main
GavinZZ
force-pushed
the
yuanhaoz/feat/metadata-collection-importer2
branch
from
5940fc3 to
91bd497
Compare
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
aws-cdk-automation
added
the
pr/needs-maintainer-review
GavinZZ
changed the base branch from
main
to
yuanhaoz/feat/metadata-collection
xazhao
reviewed
Jan 24, 2025
xazhao
approved these changes
Jan 28, 2025
| if (Array.isArray(data)) { | ||
| // Handle arrays by recursively redacting each element | ||
| return data.map((item) => redactTelemetryDataHelper(item, visited)); | ||
| // Do not redact boolean value |
Contributor
There was a problem hiding this comment.
Suggested change
| // Do not redact boolean value | |
| // Do not redact enum value |
QuantumNeuralCoder
merged commit 11dd8cf
into
yuanhaoz/feat/metadata-collection
8 checks passed
QuantumNeuralCoder
deleted the
yuanhaoz/feat/metadata-collection-importer2
branch
Contributor
|
Comments on closed issues and PRs are hard for our team to see. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reason for this change
We want to identify the difference between built-in objects vs customer input objects.
For built-in objects, we want to recursively log the content and redact the values.
However, for property keys and values that customer uniquely create, the entire object will be redacted. For example, if you use InlineApiDefinition to define an OpenAPI specification and pass it into a RestApi construct, the entire
InlineApiDefinitionobject will be redacted.Description of changes
Build a workflow (that will be linked to GHA in the future) and when redacting, redact based on the value. The workflow on run will parse all files in aws-cdk repository and built a JSON file that contains all constructs and loggable properties of the construct.
When redacting, only log the property key if the key exists in the JSON file. The value will be logged only if the value is not a
*in the JSON file. Everything else is redacted for safely.Description of how you validated changes
Unit tests added to test the updater tool as well as unit tests for modules.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license