request.ts ×15

Frontier kind: Code frontier

unlabeled · c_3f674879f4d3

2417 tests · 7420 LOC · 37 files · introduces 0 tests · 283 LOC · 2 files

Introduces — evidence that enters the hierarchy at this concept

Code
18 ranges283 lines · 2 files
Tests
0 tests

Contains — complete concept membership

All code (extent)
986 ranges7420 lines · 37 files · Browse complete extent
All tests (intent)
2417 testsBrowse complete intent

Neighbourhood graph

The orange circle is the focus. Violet and green circles are every ancestor and descendant, broader and narrower, at any distance; blue squares and pink diamonds are the introduced files and exact introduced tests of every visible concept, not only the focus's. Arrows point from broader to narrower concepts and bridge only concepts omitted from this view. Undirected links show source or test introduction. Concept and file size follows LOC; exact test nodes use test-count units.

Introduced files, introduced tests, and structurally relevant concept specialization

In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the native relationship evidence on this page.

Graph controls are ready.

Interactive rendering requires JavaScript and WebGL. Use the native relationship evidence on this page while the interactive map is unavailable.

Native relationship evidence

Every exact file and test below is linked only from the concept that introduces it.

Introduced tests

Every collected test enters the hierarchy at exactly one concept.

No tests are introduced at this concept. Its intent tests are introduced by other concepts.

Introduced code

Every collected source range enters the hierarchy at exactly one concept.

2 files ranked by introduced lines: 283 introduced LOC across 18 ranges. Expand a file to inspect source; the > gutter marks introduced lines.

src/vs/platform/request/common/request.ts 277 introduced LOC · 15 ranges

Open complete file

1 > /*--------------------------------------------------------------------------------------------- request.ts
2 > * Copyright (c) Microsoft Corporation. All rights reserved.
3 > * Licensed under the MIT License. See License.txt in the project root for license information.
4 > *--------------------------------------------------------------------------------------------*/
5 >
6 > import { streamToBuffer } from '../../../base/common/buffer.js';
7 > import { CancellationToken } from '../../../base/common/cancellation.js';
8 > import { getErrorMessage } from '../../../base/common/errors.js';
9 > import { Emitter, Event } from '../../../base/common/event.js';
10 > import { Disposable } from '../../../base/common/lifecycle.js';
11 > import { IHeaders, IRequestContext, IRequestOptions } from '../../../base/parts/request/common/request.js';
12 > import { localize } from '../../../nls.js';
13 > import { ConfigurationScope, Extensions, IConfigurationNode, IConfigurationRegistry } from '../../configuration/common/configurationRegistry.js';
14 > import { createDecorator } from '../../instantiation/common/instantiation.js';
15 > import { ILogService } from '../../log/common/log.js';
16 > import { Registry } from '../../registry/common/platform.js';
17 >
18 > export const IRequestService = createDecorator<IRequestService>('requestService');
19 >
20 > /**
21 > * Use as the {@link IRequestOptions.callSite} value to prevent
22 > * request telemetry from being emitted. This is needed for
23 > * callers such as the telemetry sender to avoid cyclical calls.
24 > */
25 > export const NO_FETCH_TELEMETRY = 'NO_FETCH_TELEMETRY';
26 >
27 > export interface IRequestCompleteEvent {
28 > readonly callSite: string;
29 > readonly latency: number;
30 > readonly statusCode: number | undefined;
31 > }
32 >
33 > export interface AuthInfo {
34 > isProxy: boolean;
35 > scheme: string;
36 > host: string;
37 > port: number;
38 > realm: string;
39 > attempt: number;
40 > }
41 >
42 > export interface Credentials {
43 > username: string;
44 > password: string;
45 > }
46 >
47 > export interface IRequestService {
48 > readonly _serviceBrand: undefined;
49 >
50 > /**
51 > * Fires when a request completes (successfully or with an error response).
52 > */
53 > readonly onDidCompleteRequest: Event<IRequestCompleteEvent>;
54 >
55 > request(options: IRequestOptions, token: CancellationToken): Promise<IRequestContext>;
56 >
57 > resolveProxy(url: string): Promise<string | undefined>;
58 > lookupAuthorization(authInfo: AuthInfo): Promise<Credentials | undefined>;
59 > lookupKerberosAuthorization(url: string): Promise<string | undefined>;
60 > loadCertificates(): Promise<string[]>;
61 > }
62 >
63 > class LoggableHeaders {
64 >
65 > private headers: IHeaders | undefined;
66 >
67 > constructor(private readonly original: IHeaders) { }
68 >
69 > toJSON(): any {
70 if (!this.headers) {
71 const headers = Object.create(null);
81 return this.headers;
82 }
83 > request.ts
84 > }
85 >
86 > export abstract class AbstractRequestService extends Disposable implements IRequestService {
87 >
88 > declare readonly _serviceBrand: undefined;
89 >
90 > private counter = 0;
91 >
92 > private readonly _onDidCompleteRequest = this._register(new Emitter<IRequestCompleteEvent>());
93 > readonly onDidCompleteRequest = this._onDidCompleteRequest.event;
94 >
95 > constructor(protected readonly logService: ILogService) {
96 super();
97 }
98 > request.ts
99 > protected async logAndRequest(options: IRequestOptions, request: () => Promise<IRequestContext>): Promise<IRequestContext> {
100 const prefix = `#${++this.counter}: ${options.url}`;
101 this.logService.trace(`${prefix} - begin`, options.type, new LoggableHeaders(options.headers ?? {}));
115 }
116 }
117 > request.ts
118 > abstract request(options: IRequestOptions, token: CancellationToken): Promise<IRequestContext>;
119 > abstract resolveProxy(url: string): Promise<string | undefined>;
120 > abstract lookupAuthorization(authInfo: AuthInfo): Promise<Credentials | undefined>;
121 > abstract lookupKerberosAuthorization(url: string): Promise<string | undefined>;
122 > abstract loadCertificates(): Promise<string[]>;
123 > }
124 >
125 > export function isSuccess(context: IRequestContext): boolean {
126 return (context.res.statusCode && context.res.statusCode >= 200 && context.res.statusCode < 300) || context.res.statusCode === 1223;
127 }
128 > request.ts
129 > export function isClientError(context: IRequestContext): boolean {
130 return !!context.res.statusCode && context.res.statusCode >= 400 && context.res.statusCode < 500;
131 }
132 > request.ts
133 > export function isServerError(context: IRequestContext): boolean {
134 return !!context.res.statusCode && context.res.statusCode >= 500 && context.res.statusCode < 600;
135 }
136 > request.ts
137 > /**
138 > * Reads a header value from an {@link IHeaders} map, tolerating array-shaped
139 > * values and case-insensitive lookups.
140 > */
141 > export function readHeader(headers: IHeaders | undefined, name: string): string | undefined {
142 if (!headers) {
143 return undefined;
149 return value;
150 }
151 > request.ts
152 > /**
153 > * Parses the `Retry-After` header as a number of seconds. Returns `undefined`
154 > * if absent or not a finite positive number. The HTTP-date form is not parsed.
155 > */
156 > export function retryAfterFromHeaders(headers: IHeaders | undefined): number | undefined {
157 const value = readHeader(headers, 'retry-after');
158 if (!value) {
162 return Number.isFinite(parsed) && parsed > 0 ? parsed : undefined;
163 }
164 > request.ts
165 > export function hasNoContent(context: IRequestContext): boolean {
166 return context.res.statusCode === 204;
167 }
168 > request.ts
169 export async function asText(context: IRequestContext): Promise<string | null> {
170 if (hasNoContent(context)) {
174 return buffer.toString();
175 }
176 > request.ts
177 export async function asTextOrError(context: IRequestContext): Promise<string | null> {
178 if (!isSuccess(context)) {
181 return asText(context);
182 }
183 > request.ts
184 export async function asJson<T = {}>(context: IRequestContext): Promise<T | null> {
185 if (!isSuccess(context)) {
198 }
199 }
200 > request.ts
201 > export function updateProxyConfigurationsScope(useHostProxy: boolean, useHostProxyDefault: boolean): void {
202 registerProxyConfigurations(useHostProxy, useHostProxyDefault);
203 }
204 > request.ts
205 > export const USER_LOCAL_AND_REMOTE_SETTINGS = [
206 > 'http.proxy',
207 > 'http.proxyStrictSSL',
208 > 'http.proxyKerberosServicePrincipal',
209 > 'http.noProxy',
210 > 'http.proxyAuthorization',
211 > 'http.proxySupport',
212 > 'http.systemCertificates',
213 > 'http.systemCertificatesNode',
214 > 'http.experimental.systemCertificatesV2',
215 > 'http.fetchAdditionalSupport',
216 > 'http.experimental.networkInterfaceCheckInterval',
217 > ];
218 >
219 > export const systemCertificatesNodeDefault = false;
220 >
221 > let proxyConfiguration: IConfigurationNode[] = [];
222 > let previousUseHostProxy: boolean | undefined = undefined;
223 > let previousUseHostProxyDefault: boolean | undefined = undefined;
224 > function registerProxyConfigurations(useHostProxy = true, useHostProxyDefault = true): void {
225 > if (previousUseHostProxy === useHostProxy && previousUseHostProxyDefault === useHostProxyDefault) {
226 return;
227 }
228 > request.ts
229 > previousUseHostProxy = useHostProxy;
230 > previousUseHostProxyDefault = useHostProxyDefault;
231 >
232 > const configurationRegistry = Registry.as<IConfigurationRegistry>(Extensions.Configuration);
233 > const oldProxyConfiguration = proxyConfiguration;
234 > proxyConfiguration = [
235 > {
236 > id: 'http',
237 > order: 15,
238 > title: localize('httpConfigurationTitle', "HTTP"),
239 > type: 'object',
240 > scope: ConfigurationScope.MACHINE,
241 > properties: {
242 > 'http.useLocalProxyConfiguration': {
243 > type: 'boolean',
244 > default: useHostProxyDefault,
245 > markdownDescription: localize('useLocalProxy', "Controls whether in the remote extension host the local proxy configuration should be used. This setting only applies as a remote setting during [remote development](https://aka.ms/vscode-remote)."),
246 > restricted: true
247 > },
248 > }
249 > },
250 > {
251 > id: 'http',
252 > order: 15,
253 > title: localize('httpConfigurationTitle', "HTTP"),
254 > type: 'object',
255 > scope: ConfigurationScope.APPLICATION,
256 > properties: {
257 > 'http.electronFetch': {
258 > type: 'boolean',
259 > default: false,
260 > description: localize('electronFetch', "Controls whether use of Electron's fetch implementation instead of Node.js' should be enabled. All local extensions will get Electron's fetch implementation for the global fetch API."),
261 > restricted: true
262 > },
263 > }
264 > },
265 > {
266 > id: 'http',
267 > order: 15,
268 > title: localize('httpConfigurationTitle', "HTTP"),
269 > type: 'object',
270 > scope: useHostProxy ? ConfigurationScope.APPLICATION : ConfigurationScope.MACHINE,
271 > properties: {
272 > 'http.proxy': {
273 > type: 'string',
274 > pattern: '^(https?|socks|socks4a?|socks5h?)://([^:]*(:[^@]*)?@)?([^:]+|\\[[:0-9a-fA-F]+\\])(:\\d+)?/?$|^$',
275 > markdownDescription: localize('proxy', "The proxy setting to use. If not set, will be inherited from the `http_proxy` and `https_proxy` environment variables. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`'),
276 > restricted: true
277 > },
278 > 'http.proxyStrictSSL': {
279 > type: 'boolean',
280 > default: true,
281 > markdownDescription: localize('strictSSL', "Controls whether the proxy server certificate should be verified against the list of supplied CAs. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`'),
282 > restricted: true
283 > },
284 > 'http.proxyKerberosServicePrincipal': {
285 > type: 'string',
286 > markdownDescription: localize('proxyKerberosServicePrincipal', "Overrides the principal service name for Kerberos authentication with the HTTP proxy. A default based on the proxy hostname is used when this is not set. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`'),
287 > restricted: true
288 > },
289 > 'http.noProxy': {
290 > type: 'array',
291 > items: { type: 'string' },
292 > markdownDescription: localize('noProxy', "Specifies domain names for which proxy settings should be ignored for HTTP/HTTPS requests. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`'),
293 > restricted: true
294 > },
295 > 'http.proxyAuthorization': {
296 > type: ['null', 'string'],
297 > default: null,
298 > markdownDescription: localize('proxyAuthorization', "The value to send as the `Proxy-Authorization` header for every network request. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`'),
299 > restricted: true
300 > },
301 > 'http.proxySupport': {
302 > type: 'string',
303 > enum: ['off', 'on', 'fallback', 'override'],
304 > enumDescriptions: [
305 > localize('proxySupportOff', "Disable proxy support for extensions."),
306 > localize('proxySupportOn', "Enable proxy support for extensions."),
307 > localize('proxySupportFallback', "Enable proxy support for extensions, fall back to request options, when no proxy found."),
308 > localize('proxySupportOverride', "Enable proxy support for extensions, override request options."),
309 > ],
310 > default: 'override',
311 > markdownDescription: localize('proxySupport', "Use the proxy support for extensions. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`'),
312 > restricted: true
313 > },
314 > 'http.systemCertificates': {
315 > type: 'boolean',
316 > default: true,
317 > markdownDescription: localize('systemCertificates', "Controls whether CA certificates should be loaded from the OS. On Windows and macOS, a reload of the window is required after turning this off. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`'),
318 > restricted: true
319 > },
320 > 'http.systemCertificatesNode': {
321 > type: 'boolean',
322 > tags: ['experimental'],
323 > default: systemCertificatesNodeDefault,
324 > markdownDescription: localize('systemCertificatesNode', "Controls whether system certificates should be loaded using Node.js built-in support. Reload the window after changing this setting. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`'),
325 > restricted: true,
326 > experiment: {
327 > mode: 'auto'
328 > }
329 > },
330 > 'http.experimental.systemCertificatesV2': {
331 > type: 'boolean',
332 > tags: ['experimental'],
333 > default: false,
334 > markdownDescription: localize('systemCertificatesV2', "Controls whether experimental loading of CA certificates from the OS should be enabled. This uses a more general approach than the default implementation. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`'),
335 > restricted: true
336 > },
337 > 'http.fetchAdditionalSupport': {
338 > type: 'boolean',
339 > default: true,
340 > markdownDescription: localize('fetchAdditionalSupport', "Controls whether Node.js' fetch implementation should be extended with additional support. Currently proxy support ({1}) and system certificates ({2}) are added when the corresponding settings are enabled. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`', '`#http.proxySupport#`', '`#http.systemCertificates#`'),
341 > restricted: true
342 > },
343 > 'http.webSocketAdditionalSupport': {
344 > type: 'boolean',
345 > default: true,
346 > markdownDescription: localize('webSocketAdditionalSupport', "Controls whether the built-in WebSocket implementation should be extended with additional support. Currently proxy support ({1}) and system certificates ({2}) are added when the corresponding settings are enabled. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`', '`#http.proxySupport#`', '`#http.systemCertificates#`'),
347 > restricted: true
348 > },
349 > 'http.experimental.networkInterfaceCheckInterval': {
350 > type: 'number',
351 > default: 300,
352 > minimum: -1,
353 > tags: ['experimental'],
354 > markdownDescription: localize('networkInterfaceCheckInterval', "Controls the interval in seconds for checking network interface changes to invalidate the proxy cache. Set to -1 to disable. When during [remote development](https://aka.ms/vscode-remote) the {0} setting is disabled this setting can be configured in the local and the remote settings separately.", '`#http.useLocalProxyConfiguration#`'),
355 > restricted: true,
356 > experiment: {
357 > mode: 'auto'
358 > }
359 > }
360 > }
361 > }
362 > ];
363 > configurationRegistry.updateConfigurations({ add: proxyConfiguration, remove: oldProxyConfiguration });
364 > }
365 >
366 > registerProxyConfigurations();
src/vs/platform/configuration/common/configurationRegistry.ts 6 introduced LOC · 3 ranges

Open complete file

756
757 if (property.experiment) {
758 > if (!property.tags?.some(tag => tag.toLowerCase() === 'onexp')) { configurationRegistry.ts
759 > property.tags = property.tags ?? [];
760 > property.tags.push('onExP');
761 > }
762 } else if (property.tags?.some(tag => tag.toLowerCase() === 'onexp')) {
763 console.error(`Invalid tag 'onExP' found for property '${key}'. Please use 'experiment' property instead.`);