Skip to content

Plumb through bypassScopeCheck #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tarunramsinghani merged 2 commits into from
Feb 21, 2025
Merged

Plumb through bypassScopeCheck #494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be7c0cd
Switch back to official Gallery APIs
winstliu May 28, 2024
fa5f7e4
Plumb through bypassScopeCheck
Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions app/exec/extension/_lib/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,11 @@ export interface PublishSettings {
* If true, command will not wait for extension to be validated.
*/
noWaitValidation?: boolean;

/**
* If true, publish will not halt in the event of requiring new scopes.
*/
bypassScopeCheck?: boolean;
}

/*** Types related to localized resources ***/
Expand Down
95 changes: 6 additions & 89 deletions app/exec/extension/_lib/publish.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,16 +231,13 @@ export class PublisherManager extends GalleryBase {
}

export class SharingManager extends GalleryBase {
private id: Promise<string>;
private publisher: Promise<string>;

public shareWith(accounts: string[]): Promise<any> {
return this.getExtInfo().then(extInfo => {
return Promise.all(
accounts.map(account => {
trace.info("Sharing extension with %s.", account);
return SharingManager.shareExtension(this.galleryClient, extInfo.publisher, extInfo.id, account).catch(errHandler.httpErr);
// return this.galleryClient.shareExtension(extInfo.publisher, extInfo.id, account).catch(errHandler.httpErr);
return this.galleryClient.shareExtension(extInfo.publisher, extInfo.id, account).catch(errHandler.httpErr);
}),
);
});
Expand All @@ -267,48 +264,6 @@ export class SharingManager extends GalleryBase {
return ext.sharedWith.map(acct => acct.name);
});
}

/******** TEMPORARY UNTIL REST CLIENT UPDATED ********/
public static async shareExtension(
client: IGalleryApi,
publisherName: string,
extensionName: string,
accountName: string
): Promise<void> {

return new Promise<void>(async (resolve, reject) => {
let routeValues: any = {
publisherName: publisherName,
extensionName: extensionName,
accountName: accountName
};

try {
let verData = await client.vsoClient.getVersioningData(
"6.1-preview.1",
"gallery",
"a1e66d8f-f5de-4d16-8309-91a4e015ee46",
routeValues);

let url: string = verData.requestUrl;
let options = client.createRequestOptions('application/json',
verData.apiVersion);

const res = await client.rest.create<void>(url, null, options);

let ret = client.formatResponse(res.result,
null,
false);

resolve(ret);

}
catch (err) {
reject(err);
}
});
}
/******** /TEMPORARY UNTIL REST CLIENT UPDATED ********/
}

export class PackagePublisher extends GalleryBase {
Expand Down Expand Up @@ -338,9 +293,7 @@ export class PackagePublisher extends GalleryBase {
* @return Q.Promise that is resolved when publish is complete
*/
public publish(): Promise<GalleryInterfaces.PublishedExtension> {
const extPackage: GalleryInterfaces.ExtensionPackage = {
extensionManifest: fs.readFileSync(this.settings.vsixPath, "base64"),
};
const extPackage = fs.createReadStream(this.settings.vsixPath)
trace.debug("Publishing %s", this.settings.vsixPath);

// Check if the app is already published. If so, call the update endpoint. Otherwise, create.
Expand Down Expand Up @@ -402,18 +355,16 @@ export class PackagePublisher extends GalleryBase {
}

private createOrUpdateExtension(
extPackage: GalleryInterfaces.ExtensionPackage,
extPackage: fs.ReadStream,
): Promise<GalleryInterfaces.PublishedExtension> {
return this.checkVsixPublished().then(extInfo => {
let publishPromise;
let publishPromise: Promise<GalleryInterfaces.PublishedExtension>;
if (extInfo && extInfo.published) {
trace.info("It is, %s the extension", colors.cyan("update").toString());
publishPromise = this
.updateExtension(extPackage as any, extInfo.publisher, extInfo.id, false)
.catch(errHandler.httpErr);
publishPromise = this.galleryClient.updateExtension(null, extPackage, extInfo.publisher, extInfo.id, this.settings.bypassScopeCheck).catch(errHandler.httpErr);
} else {
trace.info("It isn't, %s a new extension.", colors.cyan("create").toString());
publishPromise = this.updateExtension(extPackage as any, extInfo.publisher, extInfo.id, true).catch(errHandler.httpErr);
publishPromise = this.galleryClient.createExtension(null, extPackage).catch(errHandler.httpErr);
Comment thread
nathanhammond marked this conversation as resolved.
}
return publishPromise.then(() => {
return this.galleryClient.getExtension(
Expand All @@ -427,40 +378,6 @@ export class PackagePublisher extends GalleryBase {
});
}

/******** TEMPORARY UNTIL REST CLIENT UPDATED ********/
private async updateExtension(
content: any,
publisherName: string,
extensionName: string,
create: boolean,
): Promise<GalleryInterfaces.PublishedExtension> {

let routeValues: any = {
publisherName: publisherName,
extensionName: extensionName
};

const queryValues: any = {
bypassScopeCheck: undefined
};

const verData = await this.galleryClient.vsoClient.getVersioningData(
"6.1-preview.2",
"gallery",
"e11ea35a-16fe-4b80-ab11-c4cab88a0966",
routeValues,
queryValues
);

const url = verData.requestUrl;
const options = this.galleryClient.createRequestOptions("application/json", verData.apiVersion);
options.additionalHeaders = { "Content-Type": "application/json" };

const response = await (create ? this.galleryClient.rest.create(url, content, options) : this.galleryClient.rest.replace(url, content, options));
return this.galleryClient.formatResponse(response.result, GalleryInterfaces.TypeInfo.PublishedExtension, false);
}
/******** /TEMPORARY UNTIL REST CLIENT UPDATED ********/

public waitForValidation(
interval: number,
maxInterval: number,
Expand Down
6 changes: 5 additions & 1 deletion app/exec/extension/default.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export class ManifestJsonArgument extends args.JsonArgument<any> {}
export interface ExtensionArguments extends CoreArguments {
accounts: args.ArrayArgument;
branch: args.StringArgument;
bypassScopeCheck: args.BooleanArgument;
bypassValidation: args.BooleanArgument;
description: args.StringArgument;
displayName: args.StringArgument;
Expand Down Expand Up @@ -148,6 +149,7 @@ export class ExtensionBase<T> extends TfCommand<ExtensionArguments, T> {
"Path to an existing VSIX (to publish or query for).",
args.ReadableFilePathsArgument,
);
this.registerCommandArgument("bypassScopeCheck", "Bypass scope check", null, args.BooleanArgument, "false");
this.registerCommandArgument("bypassValidation", "Bypass local validation", null, args.BooleanArgument, "false");
this.registerCommandArgument(
"locRoot",
Expand Down Expand Up @@ -300,8 +302,9 @@ export class ExtensionBase<T> extends TfCommand<ExtensionArguments, T> {
this.commandArgs.extensionId.val(true),
this.commandArgs.shareWith.val(),
this.commandArgs.noWaitValidation.val(),
this.commandArgs.bypassScopeCheck.val(),
]).then<PublishSettings>(values => {
const [marketUrl, vsix, publisher, extensionId, shareWith, noWaitValidation] = values;
const [marketUrl, vsix, publisher, extensionId, shareWith, noWaitValidation, bypassScopeCheck] = values;
let vsixPath: string = _.isArray<string>(vsix) ? vsix[0] : null;
return {
galleryUrl: marketUrl,
Expand All @@ -310,6 +313,7 @@ export class ExtensionBase<T> extends TfCommand<ExtensionArguments, T> {
extensionId: extensionId,
shareWith: shareWith,
noWaitValidation: noWaitValidation,
bypassScopeCheck: bypassScopeCheck,
};
});
}
Expand Down
2 changes: 2 additions & 0 deletions app/exec/extension/publish.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export interface ExtensionCreateArguments {
override?: any;
publisher?: string;
extensionid?: string;
bypassscopecheck?: boolean;
bypassvalidation?: boolean;
}

Expand All @@ -45,6 +46,7 @@ export class ExtensionPublish extends extBase.ExtensionBase<ExtensionPublishResu
"json5",
"override",
"overridesFile",
"bypassScopeCheck",
"bypassValidation",
"publisher",
"extensionId",
Expand Down
1 change: 1 addition & 0 deletions app/exec/extension/resources/create.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ export class GenerateExtensionResources extends extBase.ExtensionBase<GenResourc
"override",
"overridesFile",
"revVersion",
"bypassScopeCheck",
"bypassValidation",
"publisher",
"extensionId",
Expand Down
11 changes: 3 additions & 8 deletions app/exec/extension/share.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,9 @@ export class ExtensionShare extends extBase.ExtensionBase<string[]> {
});
}
return extInfoPromise.then(extInfo => {
return this.commandArgs.shareWith.val().then(shareWith => {
let sharePromises: Promise<void>[] = [];
shareWith.forEach(account => {
sharePromises.push(SharingManager.shareExtension(galleryApi, extInfo.publisher, extInfo.id, account));
});
return Promise.all(sharePromises).then(() => {
return shareWith;
});
return this.commandArgs.shareWith.val().then(accounts => {
const sharingMgr = new SharingManager({}, galleryApi, extInfo);
return sharingMgr.shareWith(accounts).then(() => accounts);
});
});
});
Expand Down