chore: update to latest launchdarkly api #180

suthar26 · 2025-12-17T14:11:11Z

add proper support for the newest version of the API

src/api/LDApiWrapper.ts

        const encodedProjectKey = encodeURIComponent(projectKey)
        const response = await fetch(
-            `${LD_BASE_URL}/flags/${encodedProjectKey}?summary=0`,
+            `${LD_BASE_URL}/projects/${encodedProjectKey}/environments`,


src/api/LDApiWrapper.ts

+            url += `&${envParams}`
+        } 
+
+        const response = await fetch(url, {


luxscious · 2025-12-17T14:14:00Z

src/resources/features/LDFeatureImporter.ts

-                     + ' Please use API version 20220603 when creating the API access token.'
+                    `Feature '${feature.key}' is missing environments. ` +
+                    'This may indicate that the feature flags were not fetched with environment data. ' +
+                    'Please use API version 20240415 when creating the API access token.' 


Is there a way to not hardcode the version

its better to hardcode since that is expected, if we dont it uses the version that was used when creating the token, this way we know the expected outcome and readme is clear to get the latest version api token

Copilot

Pull request overview

This PR updates the LaunchDarkly API integration from version 20220603 to 20240415 to support proper environment data fetching for feature flags. The update introduces a caching mechanism for environments and modifies how feature flags are retrieved to include environment-specific query parameters.

Updates LaunchDarkly API version constant and related documentation
Implements environment caching in the API wrapper to optimize feature flag requests
Updates error messages to reflect the new API version requirement

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File	Description
src/api/LDApiWrapper.ts	Updates API version to 20240415, adds environment caching mechanism, introduces getEnvironments method, and modifies getFeatureFlagsForProject to use cached environment keys in query parameters
src/resources/features/LDFeatureImporter.ts	Updates error message to reference API version 20240415 and provides clearer context about missing environment data
README.md	Updates documentation to reflect API version 20240415, adds formatting improvements including blank lines and JSON indentation consistency

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-17T14:15:38Z

src/api/LDApiWrapper.ts

        )
        await this.handleErrors(response)
+        const environments = await response.json()
+        this.cachedEnvironments = environments.items.map((env: { key: string }) => env.key) ?? []


The nullish coalescing operator (??) will never be used here because the map operation always returns an array (never undefined or null). If environments.items is undefined or null, the code will throw an error before reaching the ?? operator. Consider adding proper error handling or using optional chaining on the map operation.

Suggested change

this.cachedEnvironments = environments.items.map((env: { key: string }) => env.key) ?? []

this.cachedEnvironments = environments.items?.map((env: { key: string }) => env.key) ?? []

Copilot · 2025-12-17T14:15:39Z

src/api/LDApiWrapper.ts

+    private async getEnvironments(projectKey: string) {
        const headers = await this.getHeaders()
        const encodedProjectKey = encodeURIComponent(projectKey)
        const response = await fetch(
-            `${LD_BASE_URL}/flags/${encodedProjectKey}?summary=0`,
+            `${LD_BASE_URL}/projects/${encodedProjectKey}/environments`,
            {
                method: 'GET',
                headers,
            }
        )
        await this.handleErrors(response)
+        const environments = await response.json()
+        this.cachedEnvironments = environments.items.map((env: { key: string }) => env.key) ?? []
+    }


The getEnvironments method does not return a value but it's modifying instance state that is checked later. If environments.items is null or undefined, this will throw an error. Consider adding error handling or making the method return a value that can be checked.

Copilot · 2025-12-17T14:15:39Z

src/resources/features/LDFeatureImporter.ts

+                    `Feature '${feature.key}' is missing environments. ` +
+                    'This may indicate that the feature flags were not fetched with environment data. ' +
+                    'Please use API version 20240415 when creating the API access token.' 


There's a trailing space at the end of the string concatenation. This should be removed to maintain clean error messages.

Suggested change

`Feature '${feature.key}' is missing environments. ` +

'This may indicate that the feature flags were not fetched with environment data. ' +

'Please use API version 20240415 when creating the API access token.'

`Feature '${feature.key}' is missing environments. This may indicate that the feature flags were not fetched with environment data. Please use API version 20240415 when creating the API access token.`

Copilot · 2025-12-17T14:15:39Z

src/api/LDApiWrapper.ts

+                .map((key) => `env=${encodeURIComponent(key)}`)
+                .join('&')
+            url += `&${envParams}`
+        } 


There's a trailing space at the end of line 93. This should be removed to maintain clean code formatting.

Suggested change

}

}

Copilot · 2025-12-17T14:15:40Z

src/api/LDApiWrapper.ts

        this.apiToken = apiToken
    }
    apiToken: string
+    private cachedEnvironments: string[]


The cachedEnvironments property is declared but never initialized. If getProject is never called or if it's called but project.environments?.items is falsy, cachedEnvironments will remain undefined. The check on line 83 (!this.cachedEnvironments) will then trigger a call to getEnvironments, but if that also fails to set cachedEnvironments properly (e.g., if environments.items is null), the subsequent code will still reference an undefined value. Consider initializing this property to an empty array in the constructor.

Copilot · 2025-12-17T14:15:40Z

src/api/LDApiWrapper.ts

+    private async getEnvironments(projectKey: string) {
        const headers = await this.getHeaders()
        const encodedProjectKey = encodeURIComponent(projectKey)
        const response = await fetch(
-            `${LD_BASE_URL}/flags/${encodedProjectKey}?summary=0`,
+            `${LD_BASE_URL}/projects/${encodedProjectKey}/environments`,
            {
                method: 'GET',
                headers,
            }
        )
        await this.handleErrors(response)
+        const environments = await response.json()
+        this.cachedEnvironments = environments.items.map((env: { key: string }) => env.key) ?? []
+    }
+
+    async getFeatureFlagsForProject(projectKey: string) {
+        const headers = await this.getHeaders()
+        const encodedProjectKey = encodeURIComponent(projectKey)
+        if (!this.cachedEnvironments) {
+            await this.getEnvironments(projectKey)
+        }
+
+        let url = `${LD_BASE_URL}/flags/${encodedProjectKey}?summary=0`
+        if (this.cachedEnvironments && this.cachedEnvironments.length > 0) {
+            const envParams = this.cachedEnvironments
+                .map((key) => `env=${encodeURIComponent(key)}`)
+                .join('&')
+            url += `&${envParams}`
+        } 


The new environment caching mechanism and getEnvironments method lack test coverage. Consider adding tests to verify: 1) environments are properly cached from getProject calls, 2) the fallback to getEnvironments works correctly when cachedEnvironments is undefined, 3) the URL construction with environment parameters works as expected, and 4) edge cases like empty or missing environments.items are handled correctly.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/api/LDApiWrapper.ts

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-18T16:07:28Z

src/configs.ts

 * Validates a key to prevent injection attacks in URL construction
- * Keys should only contain lowercase alphanumeric characters, hyphens, underscores, and periods
+ * Keys should only contain alphanumeric characters (uppercase or lowercase), hyphens, underscores, and periods
+ * only the source Project Key can contain capital letters


Comment capitalization inconsistency. The comment on line 39 starts with a lowercase letter "only" while other comments in the block start with capital letters. This should be capitalized for consistency: "Only the source Project Key can contain capital letters".

Suggested change

* only the source Project Key can contain capital letters

* Only the source Project Key can contain capital letters

Copilot · 2025-12-18T16:07:28Z

src/api/LDApiWrapper.ts

+
+        // Cache environment keys for use in feature flag requests
+        if (project.environments?.items) {
+            this.cachedEnvironments[projectKey] = project.environments?.items?.map(


Redundant optional chaining operator. The code already checks project.environments?.items in the if condition on line 39, so the second ?. on project.environments?.items?.map is unnecessary. The items property is already guaranteed to exist at this point.

Suggested change

this.cachedEnvironments[projectKey] = project.environments?.items?.map(

this.cachedEnvironments[projectKey] = project.environments?.items.map(

Copilot · 2025-12-18T16:07:29Z

src/api/LDApiWrapper.ts

-
-    async getFeatureFlagsForProject(projectKey: string) {
+    
+    private async getEnvironments(projectKey: string) {


Missing return type annotation for the async getEnvironments method. This private method should explicitly declare that it returns Promise<void> for better type safety and code clarity.

Suggested change

private async getEnvironments(projectKey: string) {

private async getEnvironments(projectKey: string): Promise<void> {

Copilot · 2025-12-18T16:07:29Z

src/resources/features/LDFeatureImporter.ts

-                     + ' Please use API version 20220603 when creating the API access token.'
+                    `Feature '${feature.key}' is missing environments. ` +
+                    'This may indicate that the feature flags were not fetched with environment data. ' +
+                    'Please use API version 20240415 when creating the API access token.' 


Trailing whitespace after the period on line 111. This should be removed to maintain code cleanliness and consistency.

Suggested change

'Please use API version 20240415 when creating the API access token.'

'Please use API version 20240415 when creating the API access token.'

Copilot · 2025-12-18T16:07:29Z

src/configs.test.ts

+            expect(() => validateKey('.', 'testKey')).not.toThrow()
+        })
+
+        test('should accept keys with all valid character types', () => {


Misleading test name and behavior. The test is named "should accept keys with all valid character types" but the first assertion expects the key 'aA1-_.' to throw an error when allowCapitalLetters is false (default). This test should either be moved to the "Invalid Keys" section or renamed to clarify it's testing the rejection of uppercase letters when not allowed.

Suggested change

test('should accept keys with all valid character types', () => {

test('should enforce capitalization rules for keys with all valid character types', () => {

Copilot · 2025-12-18T16:07:30Z

src/api/LDApiWrapper.ts

+                .map((key) => `env=${encodeURIComponent(key)}`)
+                .join('&')
+            url += `&${envParams}`
+        } 


Trailing whitespace after the closing brace on line 95. This should be removed to maintain code cleanliness.

Suggested change

}

}

chore: update to latest launchdarkly api

f94c0aa

Copilot AI review requested due to automatic review settings December 17, 2025 14:11

suthar26 requested a review from a team as a code owner December 17, 2025 14:11

Copilot started reviewing on behalf of suthar26 December 17, 2025 14:11 View session

github-advanced-security bot found potential problems Dec 17, 2025

View reviewed changes

luxscious reviewed Dec 17, 2025

View reviewed changes

Copilot AI reviewed Dec 17, 2025

View reviewed changes

suthar26 added 2 commits December 17, 2025 09:28

minor fixes

542d367

add initial value in constructor for cached Environments

9deff4c

Copilot AI review requested due to automatic review settings December 17, 2025 18:10

Copilot started reviewing on behalf of suthar26 December 17, 2025 18:10 View session

Copilot AI reviewed Dec 17, 2025

View reviewed changes

src/api/LDApiWrapper.ts Outdated Show resolved Hide resolved

src/api/LDApiWrapper.ts Outdated Show resolved Hide resolved

src/api/LDApiWrapper.ts Show resolved Hide resolved

add tests for environmnets and cache environments per project key

f00e521

suthar26 requested a review from luxscious December 17, 2025 18:37

luxscious approved these changes Dec 17, 2025

View reviewed changes

feat: allow source keys to be capitalized

e9c825a

Copilot AI review requested due to automatic review settings December 18, 2025 16:03

Copilot started reviewing on behalf of suthar26 December 18, 2025 16:03 View session

Copilot AI reviewed Dec 18, 2025

View reviewed changes

lint and typos

9d517ed

suthar26 merged commit a271c31 into main Dec 18, 2025
5 checks passed

suthar26 deleted the parthsuthar/cor-2977-ld-importer-migrate-to-new-ld-api-version branch December 18, 2025 16:22

	this.cachedEnvironments = environments.items.map((env: { key: string }) => env.key) ?? []
	this.cachedEnvironments = environments.items?.map((env: { key: string }) => env.key) ?? []

	* only the source Project Key can contain capital letters
	* Only the source Project Key can contain capital letters

	this.cachedEnvironments[projectKey] = project.environments?.items?.map(
	this.cachedEnvironments[projectKey] = project.environments?.items.map(


		async getFeatureFlagsForProject(projectKey: string) {

		private async getEnvironments(projectKey: string) {

	'Please use API version 20240415 when creating the API access token.'
	'Please use API version 20240415 when creating the API access token.'

	test('should accept keys with all valid character types', () => {
	test('should enforce capitalization rules for keys with all valid character types', () => {

chore: update to latest launchdarkly api #180

chore: update to latest launchdarkly api #180

Uh oh!

Conversation

suthar26 commented Dec 17, 2025

Uh oh!

Check warning

Uh oh!

Check warning

Uh oh!

luxscious Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

suthar26 Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants