root
/
playwright
mirror of https://github.com/microsoft/playwright.git
1
0
Fork 0
Code Issues Actions 3 Packages Projects Releases Wiki Activity

chore: deprecate method `context.setHTTPCredentials()` (#2763) 

This will start emitting deprecation warning once
`context.setHTTPCredentials` is called.
This commit is contained in:
Andrey Lushnikov 2020-06-29 16:37:01 -07:00 committed by GitHub
parent 38236b4f29
commit 0963c1979e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/chromium/crBrowser.ts
View File

@ -18,7 +18,7 @@
import { BrowserBase, BrowserOptions, BrowserContextOptions } from '../browser';
import { assertBrowserContextIsNotOwned, BrowserContext, BrowserContextBase, validateBrowserContextOptions, verifyGeolocation } from '../browserContext';
import { Events as CommonEvents } from '../events';
import { assert } from '../helper';
import { assert, deprecate } from '../helper';
import * as network from '../network';
import { Page, PageBinding, Worker } from '../page';
import { ConnectionTransport, SlowMoTransport } from '../transport';
@ -393,6 +393,7 @@ export class CRBrowserContext extends BrowserContextBase {
}
async setHTTPCredentials(httpCredentials: types.Credentials | null): Promise<void> {
deprecate(`context.setHTTPCredentials`, `warning: method |context.setHTTPCredentials()| is deprecated. Instead of changing credentials, create another browser context with new credentials.`);
this._options.httpCredentials = httpCredentials || undefined;
for (const page of this.pages())
await (page._delegate as CRPage).updateHttpCredentials();

3
src/firefox/ffBrowser.ts
View File

@ -18,7 +18,7 @@
import { BrowserBase, BrowserOptions, BrowserContextOptions } from '../browser';
import { assertBrowserContextIsNotOwned, BrowserContext, BrowserContextBase, validateBrowserContextOptions, verifyGeolocation } from '../browserContext';
import { Events } from '../events';
import { assert, helper, RegisteredListener } from '../helper';
import { assert, deprecate, helper, RegisteredListener } from '../helper';
import * as network from '../network';
import { Page, PageBinding } from '../page';
import { ConnectionTransport, SlowMoTransport } from '../transport';
@ -292,6 +292,7 @@ export class FFBrowserContext extends BrowserContextBase {
}
async setHTTPCredentials(httpCredentials: types.Credentials | null): Promise<void> {
deprecate(`context.setHTTPCredentials`, `warning: method |context.setHTTPCredentials()| is deprecated. Instead of changing credentials, create another browser context with new credentials.`);
this._options.httpCredentials = httpCredentials || undefined;
await this._browser._connection.send('Browser.setHTTPCredentials', { browserContextId: this._browserContextId || undefined, credentials: httpCredentials });
}

9
src/helper.ts
View File

@ -36,7 +36,16 @@ export type Listener = (...args: any[]) => void;
let isInDebugMode = !!getFromENV('PWDEBUG');
let isInRecordMode = false;
const deprecatedHits = new Set();
export function deprecate(methodName: string, message: string) {
if (deprecatedHits.has(methodName))
return;
deprecatedHits.add(methodName);
console.warn(message);
}
class Helper {
static evaluationString(fun: Function | string, ...args: any[]): string {
if (Helper.isString(fun)) {
assert(args.length === 0 || (args.length === 1 && args[0] === undefined), 'Cannot evaluate a string with arguments');

3
src/webkit/wkBrowser.ts
View File

@ -18,7 +18,7 @@
import { BrowserBase, BrowserOptions, BrowserContextOptions } from '../browser';
import { assertBrowserContextIsNotOwned, BrowserContext, BrowserContextBase, validateBrowserContextOptions, verifyGeolocation } from '../browserContext';
import { Events } from '../events';
import { helper, RegisteredListener, assert } from '../helper';
import { helper, deprecate, RegisteredListener, assert } from '../helper';
import * as network from '../network';
import { Page, PageBinding } from '../page';
import { ConnectionTransport, SlowMoTransport } from '../transport';
@ -305,6 +305,7 @@ export class WKBrowserContext extends BrowserContextBase {
}
async setHTTPCredentials(httpCredentials: types.Credentials | null): Promise<void> {
deprecate(`context.setHTTPCredentials`, `warning: method |context.setHTTPCredentials()| is deprecated. Instead of changing credentials, create another browser context with new credentials.`);
this._options.httpCredentials = httpCredentials || undefined;
for (const page of this.pages())
await (page._delegate as WKPage).updateHttpCredentials();