-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement safe plugin uninstallation (#11084)
Modifies the plugin system to handle uninstallation and the presence of multiple versions - Most references to plugins should include version number this is enforced by typing in most cases - Uninstalling a plugin on the frontend will not delete the deployed files, and the plugin will remain active on the frontend until the application is restarted
- Loading branch information
1 parent
bf905e8
commit bfa1b44
Showing
32 changed files
with
752 additions
and
215 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -58,4 +58,5 @@ | |
"editor.rulers": [ | ||
180 | ||
], | ||
"typescript.preferences.quoteStyle": "single", | ||
} |
This file contains 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
This file contains 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
41 changes: 41 additions & 0 deletions
41
packages/plugin-ext-vscode/src/common/plugin-vscode-uri.ts
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
// ***************************************************************************** | ||
// Copyright (C) 2022 Ericsson and others. | ||
// | ||
// This program and the accompanying materials are made available under the | ||
// terms of the Eclipse Public License v. 2.0 which is available at | ||
// http://www.eclipse.org/legal/epl-2.0. | ||
// | ||
// This Source Code may also be made available under the following Secondary | ||
// Licenses when the conditions for such availability set forth in the Eclipse | ||
// Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
// with the GNU Classpath Exception which is available at | ||
// https://www.gnu.org/software/classpath/license.html. | ||
// | ||
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
// ***************************************************************************** | ||
|
||
import URI from '@theia/core/lib/common/uri'; | ||
|
||
/** | ||
* Static methods for identifying a plugin as the target of the VSCode deployment system. | ||
* In practice, this means that it will be resolved and deployed by the Open-VSX system. | ||
*/ | ||
export namespace VSCodeExtensionUri { | ||
export const VSCODE_PREFIX = 'vscode:extension/'; | ||
/** | ||
* Should be used to prefix a plugin's ID to ensure that it is identified as a VSX Extension. | ||
* @returns `vscode:extension/${id}` | ||
*/ | ||
export function toVsxExtensionUriString(id: string): string { | ||
return `${VSCODE_PREFIX}${id}`; | ||
} | ||
export function toUri(id: string): URI { | ||
return new URI(toVsxExtensionUriString(id)); | ||
} | ||
export function toId(uri: URI): string | undefined { | ||
if (uri.scheme === 'vscode' && uri.path.dir.toString() === 'extension') { | ||
return uri.path.base; | ||
} | ||
return undefined; | ||
} | ||
} |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
// ***************************************************************************** | ||
// Copyright (C) 2022 Ericsson and others. | ||
// | ||
// This program and the accompanying materials are made available under the | ||
// terms of the Eclipse Public License v. 2.0 which is available at | ||
// http://www.eclipse.org/legal/epl-2.0. | ||
// | ||
// This Source Code may also be made available under the following Secondary | ||
// Licenses when the conditions for such availability set forth in the Eclipse | ||
// Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
// with the GNU Classpath Exception which is available at | ||
// https://www.gnu.org/software/classpath/license.html. | ||
// | ||
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
// ***************************************************************************** | ||
|
||
export namespace PluginIdentifiers { | ||
export interface Components { | ||
publisher?: string; | ||
name: string; | ||
version: string; | ||
} | ||
|
||
export interface IdAndVersion { | ||
id: UnversionedId; | ||
version: string; | ||
} | ||
|
||
export type VersionedId = `${string}.${string}@${string}`; | ||
export type UnversionedId = `${string}.${string}`; | ||
/** Unpublished plugins (not from Open VSX or VSCode plugin store) may not have a `publisher` field. */ | ||
export const UNPUBLISHED = '<unpublished>'; | ||
|
||
/** | ||
* @returns a string in the format `<publisher>.<name>` | ||
*/ | ||
export function componentsToUnversionedId({ publisher = UNPUBLISHED, name }: Components): UnversionedId { | ||
return `${publisher.toLowerCase()}.${name.toLowerCase()}`; | ||
} | ||
/** | ||
* @returns a string in the format `<publisher>.<name>@<version>`. | ||
*/ | ||
export function componentsToVersionedId({ publisher = UNPUBLISHED, name, version }: Components): VersionedId { | ||
return `${publisher.toLowerCase()}.${name.toLowerCase()}@${version}`; | ||
} | ||
export function componentsToVersionWithId(components: Components): IdAndVersion { | ||
return { id: componentsToUnversionedId(components), version: components.version }; | ||
} | ||
/** | ||
* @returns a string in the format `<id>@<version>`. | ||
*/ | ||
export function idAndVersionToVersionedId({ id, version }: IdAndVersion): VersionedId { | ||
return `${id}@${version}`; | ||
} | ||
/** | ||
* @returns a string in the format `<publisher>.<name>`. | ||
*/ | ||
export function unversionedFromVersioned(id: VersionedId): UnversionedId { | ||
const endOfId = id.indexOf('@'); | ||
return id.slice(0, endOfId) as UnversionedId; | ||
} | ||
/** | ||
* @returns `undefined` if it looks like the string passed in does not have the format returned by {@link PluginIdentifiers.toVersionedId}. | ||
*/ | ||
export function identifiersFromVersionedId(probablyId: string): Components | undefined { | ||
const endOfPublisher = probablyId.indexOf('.'); | ||
const endOfName = probablyId.indexOf('@', endOfPublisher); | ||
if (endOfPublisher === -1 || endOfName === -1) { | ||
return undefined; | ||
} | ||
return { publisher: probablyId.slice(0, endOfPublisher), name: probablyId.slice(endOfPublisher + 1, endOfName), version: probablyId.slice(endOfName + 1) }; | ||
} | ||
/** | ||
* @returns `undefined` if it looks like the string passed in does not have the format returned by {@link PluginIdentifiers.toVersionedId}. | ||
*/ | ||
export function idAndVersionFromVersionedId(probablyId: string): IdAndVersion | undefined { | ||
const endOfPublisher = probablyId.indexOf('.'); | ||
const endOfName = probablyId.indexOf('@', endOfPublisher); | ||
if (endOfPublisher === -1 || endOfName === -1) { | ||
return undefined; | ||
} | ||
return { id: probablyId.slice(0, endOfName) as UnversionedId, version: probablyId.slice(endOfName + 1) }; | ||
} | ||
} |
Oops, something went wrong.