Add supportedFields property#25
Merged
Merged
Conversation
added 3 commits
July 9, 2026 23:02
…ScriptImporter into maryanne/compare_description_field
There was a problem hiding this comment.
Pull request overview
Adds an explicit capability flag (supportsDescriptionField) to ConfigurationSettingsSource so the importer can conditionally include the App Configuration description field when computing updates.
Changes:
- Introduces
supportsDescriptionFieldonConfigurationSettingsSourceand sets it across all built-in sources (String/ReadableStream/Iterable/Changes). - Extends
isConfigSettingEqualand change detection to optionally comparedescriptionbased on the source capability. - Updates unit tests to include
descriptionin test data and pass the new equality parameter.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| libraries/azure-app-configuration-importer/tests/util.spec.ts | Updates equality tests to include description and pass the new “description supported” flag. |
| libraries/azure-app-configuration-importer/tests/appConfigurationImporter.spec.ts | Updates ConfigurationChangesSource construction to pass the new description-support flag. |
| libraries/azure-app-configuration-importer/src/settingsImport/stringConfigurationSettingsSource.ts | Adds and initializes supportsDescriptionField based on profile (Default vs KvSet). |
| libraries/azure-app-configuration-importer/src/settingsImport/readableStreamConfigurationSettingsSource.ts | Adds and initializes supportsDescriptionField based on profile (Default vs KvSet). |
| libraries/azure-app-configuration-importer/src/settingsImport/iterableConfigurationSettingsSource.ts | Adds supportsDescriptionField (currently always true) for iterable sources. |
| libraries/azure-app-configuration-importer/src/settingsImport/configurationSettingsSource.ts | Extends the public ConfigurationSettingsSource interface with supportsDescriptionField. |
| libraries/azure-app-configuration-importer/src/settingsImport/configurationChangesSource.ts | Adds supportsDescriptionField to the changes source and updates constructor signature. |
| libraries/azure-app-configuration-importer/src/internal/utils.ts | Extends isConfigSettingEqual to optionally compare description. |
| libraries/azure-app-configuration-importer/src/appConfigurationImporter.ts | Passes source capability into equality checks when determining updates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
added 2 commits
July 12, 2026 12:41
jimmyca15
reviewed
Jul 14, 2026
MaryanneNjeri
commented
Jul 20, 2026
jimmyca15
reviewed
Jul 20, 2026
jimmyca15
approved these changes
Jul 21, 2026
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
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.
This PR
App Configuration recently added support for description field. Importer library also needs an update to support importing description field. Not all configuration sources support importing description field (eg: Importing from a file with content profile as default).
Proposed solution
Adds the
supportedFieldsproperty toConfigurationSettingsSource. We support a couple of configuration settings source including:- StringConfigurationSettingsSource
- IterableConfigurationSettingsSource
- ReadableConfigurationSettingsSource
- ConfigurationChangeSource
With the addition of the
supportedFieldsproperty we are able to distinguish which configuration setting source support which fieldsUsage example