Eliminate query parameter from RegistryV2RequestOptions (#244)

microsoft · Jan 8, 2025 · d8d90e9 · d8d90e9
1 parent ac9703e
commit d8d90e9
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 14 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/vscode-docker-registries/CHANGELOG.md b/packages/vscode-docker-registries/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 0.2.0 - 7 January 2025
+### Fixed
+* Fixes an issue that would cause infinite looping on registries that used paging in tags listing. [#243](https://github.com/microsoft/vscode-docker-extensibility/issues/243)
+* The above required a breaking alteration to the `RegistryV2RequestOptions` interface.
+
 ## 0.1.13 - 17 December 2024
 ### Fixed
 * Fixed 404 when exploring and pulling GHCR images. [#238](https://github.com/microsoft/vscode-docker-extensibility/issues/238)

diff --git a/packages/vscode-docker-registries/package.json b/packages/vscode-docker-registries/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-docker-registries",
     "author": "Microsoft Corporation",
-    "version": "0.1.13",
+    "version": "0.2.0",
     "description": "Extensibility model for contributing registry providers to the Docker extension for Visual Studio Code",
     "license": "See LICENSE in the project root for license information.",
     "repository": {

diff --git a/packages/vscode-docker-registries/src/clients/GitHub/GitHubRegistryDataProvider.ts b/packages/vscode-docker-registries/src/clients/GitHub/GitHubRegistryDataProvider.ts
@@ -98,11 +98,7 @@ export class GitHubRegistryDataProvider extends RegistryV2DataProvider {
             const catalogResponse = await registryV2Request<{ repositories: string[] }>({
                 authenticationProvider: this.authenticationProvider,
                 method: 'GET',
-                requestUri: requestUrl,
-                query: {
-                    n: '100',
-                    last: nextSearchString
-                },
+                requestUri: requestUrl.with({ query: new URLSearchParams({ n: '100', last: nextSearchString }).toString() }),
                 scopes: ['registry:catalog:*'],
                 throwOnFailure: true,
             });

diff --git a/packages/vscode-docker-registries/src/clients/RegistryV2/RegistryV2DataProvider.ts b/packages/vscode-docker-registries/src/clients/RegistryV2/RegistryV2DataProvider.ts
@@ -37,7 +37,6 @@ export abstract class RegistryV2DataProvider extends CommonRegistryDataProvider
                 authenticationProvider: this.getAuthenticationProvider(registry),
                 method: 'GET',
                 requestUri: nextLink,
-                query: Object.fromEntries(new URLSearchParams(nextLink.query)),
                 scopes: ['registry:catalog:*'],
             });
 

diff --git a/packages/vscode-docker-registries/src/clients/RegistryV2/registryV2Request.ts b/packages/vscode-docker-registries/src/clients/RegistryV2/registryV2Request.ts
@@ -12,7 +12,6 @@ import { HttpErrorResponse } from '../../utils/errors';
 export interface RegistryV2RequestOptions {
     method: 'GET' | 'POST' | 'PUT' | 'DELETE';
     requestUri: vscode.Uri;
-    query?: Record<string, string>;
     scopes: string[];
     headers?: Record<string, string>;
     throwOnFailure?: boolean;
@@ -45,9 +44,6 @@ export async function registryV2Request<T>(options: RegistryV2RequestOptions): P
 }
 
 async function registryV2RequestInternal<T>(options: RegistryV2RequestOptions): Promise<RegistryV2Response<T>> {
-    const query = new URLSearchParams(options.query);
-    const uri = options.requestUri.with({ query: query.toString() });
-
     const auth = await options.authenticationProvider.getSession(options.scopes, options.sessionOptions);
 
     const request: RequestLike = {
@@ -59,13 +55,13 @@ async function registryV2RequestInternal<T>(options: RegistryV2RequestOptions):
         method: options.method,
     };
 
-    const response = await httpRequest(uri.toString(true), request, options.throwOnFailure);
+    const response = await httpRequest(options.requestUri.toString(true), request, options.throwOnFailure);
 
     return {
         status: response.status,
         statusText: response.statusText,
         succeeded: response.succeeded,
-        uri: uri,
+        uri: options.requestUri,
         headers: response.headers,
         body: response.succeeded && (parseInt(response.headers.get('content-length') ?? '0') || response.headers.get('transfer-encoding') === 'chunked') ? await response.json() as T : undefined,
     };