src/vs/workbench/contrib/update/common/updateUtils.ts
227 LOC · 208 covered · 19 uncovered · 63 ranges · 46 concepts · 42 introducers · 36 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
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 related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
1
>
/*---------------------------------------------------------------------------------------------
updateUtils.ts ×13
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 { localize } from '../../../../nls.js';
7
>
import { Downloading } from '../../../../platform/update/common/update.js';
8
>
9
>
/**
10
>
* Returns the progress percentage based on the current and maximum progress values.
11
>
*/
12
>
export function computeProgressPercent(current: number | undefined, max: number | undefined): number | undefined {
15
>
}
17
>
return Math.max(Math.min(Math.round((current / max) * 100), 100), 0);
18
>
}
20
>
/**
21
>
* Computes an estimate of remaining download time in seconds.
22
>
*/
23
>
export function computeDownloadTimeRemaining(state: Downloading): number | undefined {
25
>
if (downloadedBytes === undefined || totalBytes === undefined || startTime === undefined) {
27
>
}
29
>
const elapsedMs = Date.now() - startTime;
30
>
if (downloadedBytes <= 0 || totalBytes <= 0 || elapsedMs <= 0) {
32
>
}
34
>
const remainingBytes = totalBytes - downloadedBytes;
35
>
if (remainingBytes <= 0) {
37
>
}
39
>
const bytesPerMs = downloadedBytes / elapsedMs;
40
>
if (bytesPerMs <= 0) {
41
return undefined;
42
}
44
>
const remainingMs = remainingBytes / bytesPerMs;
45
>
return Math.ceil(remainingMs / 1000);
46
>
}
48
>
/**
49
>
* Computes the current download speed in bytes per second.
50
>
*/
51
>
export function computeDownloadSpeed(state: Downloading): number | undefined {
53
>
if (downloadedBytes === undefined || startTime === undefined) {
55
>
}
57
>
const elapsedMs = Date.now() - startTime;
60
>
}
62
>
return (downloadedBytes / elapsedMs) * 1000;
63
>
}
65
>
/**
66
>
* Computes the version to use for fetching update info.
67
>
* - If the minor version differs: returns `{major}.{minor}` (e.g., 1.108.2 -> 1.109.5 => 1.109)
68
>
* - If the same minor: returns the target version as-is (e.g., 1.109.2 -> 1.109.5 => 1.109.5)
69
>
*/
70
>
export function computeUpdateInfoVersion(currentVersion: string, targetVersion: string): string | undefined {
72
>
const target = tryParseVersion(targetVersion);
73
>
if (!current || !target) {
75
>
}
79
>
}
81
>
return `${target.major}.${target.minor}.${target.patch}`;
82
>
}
84
>
/**
85
>
* Computes the URL to fetch update info from.
86
>
* Follows the release notes URL pattern but with `_update` suffix.
87
>
*/
88
>
export function getUpdateInfoUrl(version: string): string {
90
>
return `https://code.visualstudio.com/raw/v${versionLabel}_update.md`;
91
>
}
93
>
/**
94
>
* Formats the time remaining as a human-readable string.
95
>
*/
96
>
export function formatTimeRemaining(seconds: number): string {
98
>
if (hours >= 1) {
100
>
if (formattedHours === '1') {
101
>
return localize('update.timeRemainingHour', "{0} hour", formattedHours);
102
>
} else {
103
>
return localize('update.timeRemainingHours', "{0} hours", formattedHours);
104
>
}
105
>
}
107
>
const minutes = Math.floor(seconds / 60);
108
>
if (minutes >= 1) {
110
>
}
112
>
return localize('update.timeRemainingSeconds', "{0}s", seconds);
113
>
}
115
>
/**
116
>
* Formats a byte count as a human-readable string.
117
>
*/
118
>
export function formatBytes(bytes: number): string {
121
>
}
123
>
const kb = bytes / 1024;
124
>
if (kb < 1024) {
126
>
}
128
>
const mb = kb / 1024;
129
>
if (mb < 1024) {
131
>
}
133
>
const gb = mb / 1024;
134
>
return localize('update.gigabytes', "{0} GB", formatDecimal(gb));
135
>
}
137
>
/**
138
>
* Tries to parse a date string and returns the timestamp or undefined if parsing fails.
139
>
*/
140
>
export function tryParseDate(date: string | undefined): number | undefined {
143
>
}
145
>
try {
146
>
const parsed = Date.parse(date);
148
>
} catch {
149
return undefined;
150
}
153
>
/**
154
>
* Formats a timestamp as a localized date string.
155
>
*/
156
>
export function formatDate(timestamp: number): string {
158
>
year: 'numeric',
159
>
month: 'short',
160
>
day: 'numeric'
161
>
});
162
>
}
164
>
/**
165
>
* Formats a number to 1 decimal place, omitting ".0" for whole numbers.
166
>
*/
167
>
export function formatDecimal(value: number): string {
169
>
return rounded % 1 === 0 ? rounded.toString() : rounded.toFixed(1);
170
>
}
172
>
export interface IVersion {
173
>
major: number;
174
>
minor: number;
175
>
patch: number;
176
>
}
177
>
178
>
/**
179
>
* Parses a version string in the format "major.minor.patch" and returns an object with the components.
180
>
*/
181
>
export function tryParseVersion(version: string | undefined): IVersion | undefined {
184
>
}
186
>
const match = /^(\d{1,10})\.(\d{1,10})\.(\d{1,10})/.exec(version);
187
>
if (!match) {
189
>
}
191
>
try {
192
>
return {
193
>
major: parseInt(match[1]),
194
>
minor: parseInt(match[2]),
195
>
patch: parseInt(match[3])
196
>
};
197
>
} catch {
198
return undefined;
199
}
202
>
/**
203
>
* Processes an error message and returns a user-friendly version of it, or undefined if the error should be ignored.
204
>
*/
205
>
export function preprocessError(error?: string): string | undefined {
206
if (!error) {
207
return undefined;
208
}
209
210
if (/The request timed out|The network connection was lost/i.test(error)) {
211
return undefined;
212
}
213
214
return error.replace(
215
/See https:\/\/github\.com\/Squirrel\/Squirrel\.Mac\/issues\/182 for more information/,
216
'This might mean the application was put on quarantine by macOS. See [this link](https://github.com/microsoft/vscode/issues/7426#issuecomment-425093469) for more information'
217
);
218
}
220
>
/**
221
>
* Determines whether there is a major or minor version change between two versions.
222
>
*/
223
>
export function isMajorMinorVersionChange(previousVersion?: string, newVersion?: string): boolean {
225
>
const current = tryParseVersion(newVersion);
226
>
return !!previous && !!current && (previous.major !== current.major || previous.minor !== current.minor);
227
>
}