-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[App Configuration] - Snapshot Reference #36105
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
Open
zhiyuanliang-ms
wants to merge
3
commits into
Azure:main
Choose a base branch
from
zhiyuanliang-ms:zhiyuanliang/snapshot-reference
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+377
−14
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -4,6 +4,11 @@ | |||||||||
|
|
||||||||||
| ### Features Added | ||||||||||
|
|
||||||||||
| - Support snapshot referece. | ||||||||||
| - New types for SnapshotReference - `ConfigurationSetting<SnapshotReferenceValue>` and `ConfigurationSetting<SecretReferenceValue>` | ||||||||||
| - Upon using `getConfigurationSetting`(or add/update), use `parseSnapshotReference` methods to access the properties(to translate `ConfigurationSetting` into the types above). | ||||||||||
|
Comment on lines
+8
to
+9
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The second type should be
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||||||
| - Helper method `isSnapshotReference` checks the contentType and return boolean values. | ||||||||||
|
|
||||||||||
| ### Breaking Changes | ||||||||||
|
|
||||||||||
| ### Bugs Fixed | ||||||||||
|
|
||||||||||
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
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
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
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
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
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
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
91 changes: 91 additions & 0 deletions
91
sdk/appconfiguration/app-configuration/src/snapshotReference.ts
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,91 @@ | ||||||
| // Copyright (c) Microsoft Corporation. | ||||||
| // Licensed under the MIT License. | ||||||
|
|
||||||
| import type { ConfigurationSetting, ConfigurationSettingParam } from "./models.js"; | ||||||
| import type { JsonSnapshotReferenceValue } from "./internal/jsonModels.js"; | ||||||
| import { logger } from "./logger.js"; | ||||||
|
|
||||||
| /** | ||||||
| * content-type for the snapshot reference. | ||||||
| */ | ||||||
| export const snapshotReferenceContentType = | ||||||
| 'application/json; profile="https://azconfig.io/mime-profiles/snapshot-ref"; charset=utf-8'; | ||||||
|
|
||||||
| /** | ||||||
| * Necessary fields for updating or creating a new snapshot reference. | ||||||
| */ | ||||||
| export interface SnapshotReferenceValue { | ||||||
| /** | ||||||
| * snapshot name. | ||||||
| */ | ||||||
| snapshotName: string; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @internal | ||||||
| */ | ||||||
| export const SnapshotReferenceHelper = { | ||||||
| /** | ||||||
| * Takes the SnapshotReference (JSON) and returns a ConfigurationSetting (with the props encodeed in the value). | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Corrected spelling of 'encodeed' to 'encoded'.
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||
| */ | ||||||
| toConfigurationSettingParam: ( | ||||||
| snapshotReference: ConfigurationSettingParam<SnapshotReferenceValue>, | ||||||
| ): ConfigurationSettingParam => { | ||||||
| logger.info("Encoding SnapshotReference value in a ConfigurationSetting:", snapshotReference); | ||||||
| if (!snapshotReference.value) { | ||||||
| logger.error(`SnapshotReference has an unexpected value`, snapshotReference); | ||||||
| throw new TypeError(`SnapshotReference has an unexpected value - ${snapshotReference.value}`); | ||||||
| } | ||||||
|
|
||||||
| const jsonSnapshotReferenceValue: JsonSnapshotReferenceValue = { | ||||||
| snapshot_name: snapshotReference.value.snapshotName, | ||||||
| }; | ||||||
|
|
||||||
| const configSetting = { | ||||||
| ...snapshotReference, | ||||||
| value: JSON.stringify(jsonSnapshotReferenceValue), | ||||||
| }; | ||||||
| return configSetting; | ||||||
| }, | ||||||
| }; | ||||||
|
|
||||||
| /** | ||||||
| * Takes the ConfigurationSetting as input and returns the ConfigurationSetting<SnapshotReferenceValue> by parsing the value string. | ||||||
| */ | ||||||
| export function parseSnapshotReference( | ||||||
| setting: ConfigurationSetting, | ||||||
| ): ConfigurationSetting<SnapshotReferenceValue> { | ||||||
| logger.info( | ||||||
| "[parseSnapshotReference] Parsing the value to return the SnapshotReferenceValue", | ||||||
| setting, | ||||||
| ); | ||||||
| if (!isSnapshotReference(setting)) { | ||||||
| logger.error("Invalid SnapshotReference input", setting); | ||||||
| throw TypeError( | ||||||
| `Setting with key ${setting.key} is not a valid SnapshotReference, make sure to have the correct content-type and a valid non-null value.`, | ||||||
| ); | ||||||
| } | ||||||
|
|
||||||
| const jsonSnapshotReferenceValue = JSON.parse(setting.value) as JsonSnapshotReferenceValue; | ||||||
|
|
||||||
| const snapshotReference: ConfigurationSetting<SnapshotReferenceValue> = { | ||||||
| ...setting, | ||||||
| value: { snapshotName: jsonSnapshotReferenceValue.snapshot_name }, | ||||||
| }; | ||||||
| return snapshotReference; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Lets you know if the ConfigurationSetting is a snapshot reference. | ||||||
| * | ||||||
| * [Checks if the content type is snapshotReferenceContentType `"application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8"`] | ||||||
| */ | ||||||
| export function isSnapshotReference( | ||||||
| setting: ConfigurationSetting, | ||||||
| ): setting is ConfigurationSetting & Required<Pick<ConfigurationSetting, "value">> { | ||||||
| return ( | ||||||
| setting && | ||||||
| setting.contentType === snapshotReferenceContentType && | ||||||
| typeof setting.value === "string" | ||||||
| ); | ||||||
| } | ||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Corrected spelling of 'referece' to 'reference'.
Copilot uses AI. Check for mistakes.