[App Configuration] - Snapshot Reference #36105
Open
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
zhiyuanliang-ms
requested review from
bterlson,
a team,
minhanh-phan,
jimmyca15,
zhenlan,
juniwang and
RichardChen820
as code owners
github-actions
bot
added
the
App Configuration
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for snapshot references in the Azure App Configuration SDK, introducing a new configuration setting type alongside existing feature flags and secret references.
Key Changes:
- Adds new
SnapshotReferenceValuetype and supporting infrastructure - Implements parsing, serialization, and type checking utilities for snapshot references
- Updates existing type definitions to include the new snapshot reference type
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/snapshotReference.ts |
Core implementation with types, helper functions, and content type definition |
src/models.ts |
Updated generic type constraints to include SnapshotReferenceValue |
src/internal/jsonModels.ts |
Added JsonSnapshotReferenceValue interface for serialization |
src/internal/helpers.ts |
Added serialization logic for snapshot reference settings |
src/appConfigurationClient.ts |
Updated method signatures to support snapshot reference parameters |
src/index.ts |
Exported new snapshot reference utilities |
test/public/snapshotReference.spec.ts |
Comprehensive test coverage for snapshot reference functionality |
review/app-configuration-node.api.md |
Updated public API surface with new types and methods |
CHANGELOG.md |
Added feature announcement |
assets.json |
Updated asset tag |
|
|
||
| ### Features Added | ||
|
|
||
| - Support snapshot referece. |
There was a problem hiding this comment.
Corrected spelling of 'referece' to 'reference'.
Suggested change
| - Support snapshot referece. | |
| - Support snapshot reference. |
Copilot uses AI. Check for mistakes.
Comment on lines
+8
to
+9
| - 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). |
There was a problem hiding this comment.
The second type should be ConfigurationSetting<SnapshotReferenceValue> instead of ConfigurationSetting<SecretReferenceValue> as this is documenting snapshot reference support, not secret reference.
Suggested change
| - 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). | |
| - New type for SnapshotReference - `ConfigurationSetting<SnapshotReferenceValue>` | |
| - Upon using `getConfigurationSetting`(or add/update), use `parseSnapshotReference` methods to access the properties (to translate `ConfigurationSetting` into the type above). |
Copilot uses AI. Check for mistakes.
| */ | ||
| 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.
Corrected spelling of 'encodeed' to 'encoded'.
Suggested change
| * Takes the SnapshotReference (JSON) and returns a ConfigurationSetting (with the props encodeed in the value). | |
| * Takes the SnapshotReference (JSON) and returns a ConfigurationSetting (with the props encoded in the value). |
Copilot uses AI. Check for mistakes.
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Packages impacted by this PR
@azure/app-configuration
Issues associated with this PR
Describe the problem that is addressed by this PR
Support new snapshot reference type
What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?
Are there test cases added in this PR? (If not, why?)
Provide a list of related PRs (if any)
Command used to generate this PR:**(Applicable only to SDK release request PRs)
Checklists