mirror of
https://github.com/Llewellynvdm/nativefier.git
synced 2024-12-23 02:28:55 +00:00
App: revert addition of extra flag --internal-login-pages
See discussion at https://github.com/nativefier/nativefier/pull/1124#issuecomment-794751514 : > @TheCleric I was about to merge this, then reconsidered one little thing (yes I wrote "little", I'm not reconsidering this whole thing 😅). > > I'm re-considering having the extra flag. I'm not so sure this will harm a lot of use cases. I'd like to 1. merge this PR, 2. immediately follow up with a small commit removing the flag & adjusting api.md, 3. release with the change well-documented / asking for feedback if this is problematic to anyone. (I'm not asking you any extra work, and like leaving an in-tree commit trace of considering the flag). If people complain with a valid reason, we'll restore the flag with a quick revert, else we're happy with one less flag and a reasonably-handled breaking change. > > Thoughts / objections? Answered by: > That seems reasonable to me. > > [discussion on an extra structured way to pass flags]
This commit is contained in:
parent
6f7e80bafd
commit
74a7d3375d
@ -225,14 +225,7 @@ export function createMainWindow(
|
|||||||
};
|
};
|
||||||
|
|
||||||
const onWillNavigate = (event: Event, urlToGo: string): void => {
|
const onWillNavigate = (event: Event, urlToGo: string): void => {
|
||||||
if (
|
if (!linkIsInternal(options.targetUrl, urlToGo, options.internalUrls)) {
|
||||||
!linkIsInternal(
|
|
||||||
options.targetUrl,
|
|
||||||
urlToGo,
|
|
||||||
options.internalLoginPages,
|
|
||||||
options.internalUrls,
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
event.preventDefault();
|
event.preventDefault();
|
||||||
if (options.blockExternalUrls) {
|
if (options.blockExternalUrls) {
|
||||||
onBlockedExternalUrl(urlToGo);
|
onBlockedExternalUrl(urlToGo);
|
||||||
@ -301,7 +294,6 @@ export function createMainWindow(
|
|||||||
urlToGo,
|
urlToGo,
|
||||||
disposition,
|
disposition,
|
||||||
options.targetUrl,
|
options.targetUrl,
|
||||||
options.internalLoginPages,
|
|
||||||
options.internalUrls,
|
options.internalUrls,
|
||||||
preventDefault,
|
preventDefault,
|
||||||
shell.openExternal.bind(this),
|
shell.openExternal.bind(this),
|
||||||
|
@ -21,7 +21,6 @@ test('internal urls should not be handled', () => {
|
|||||||
internalUrl,
|
internalUrl,
|
||||||
undefined,
|
undefined,
|
||||||
originalUrl,
|
originalUrl,
|
||||||
true,
|
|
||||||
undefined,
|
undefined,
|
||||||
preventDefault,
|
preventDefault,
|
||||||
openExternal,
|
openExternal,
|
||||||
@ -50,7 +49,6 @@ test('external urls should be opened externally', () => {
|
|||||||
externalUrl,
|
externalUrl,
|
||||||
undefined,
|
undefined,
|
||||||
originalUrl,
|
originalUrl,
|
||||||
true,
|
|
||||||
undefined,
|
undefined,
|
||||||
preventDefault,
|
preventDefault,
|
||||||
openExternal,
|
openExternal,
|
||||||
@ -80,7 +78,6 @@ test('external urls should be ignored if blockExternal is true', () => {
|
|||||||
externalUrl,
|
externalUrl,
|
||||||
undefined,
|
undefined,
|
||||||
originalUrl,
|
originalUrl,
|
||||||
true,
|
|
||||||
undefined,
|
undefined,
|
||||||
preventDefault,
|
preventDefault,
|
||||||
openExternal,
|
openExternal,
|
||||||
@ -109,7 +106,6 @@ test('tab disposition should be ignored if tabs are not enabled', () => {
|
|||||||
internalUrl,
|
internalUrl,
|
||||||
foregroundDisposition,
|
foregroundDisposition,
|
||||||
originalUrl,
|
originalUrl,
|
||||||
true,
|
|
||||||
undefined,
|
undefined,
|
||||||
preventDefault,
|
preventDefault,
|
||||||
openExternal,
|
openExternal,
|
||||||
@ -138,7 +134,6 @@ test('tab disposition should be ignored if url is external', () => {
|
|||||||
externalUrl,
|
externalUrl,
|
||||||
foregroundDisposition,
|
foregroundDisposition,
|
||||||
originalUrl,
|
originalUrl,
|
||||||
true,
|
|
||||||
undefined,
|
undefined,
|
||||||
preventDefault,
|
preventDefault,
|
||||||
openExternal,
|
openExternal,
|
||||||
@ -167,7 +162,6 @@ test('foreground tabs with internal urls should be opened in the foreground', ()
|
|||||||
internalUrl,
|
internalUrl,
|
||||||
foregroundDisposition,
|
foregroundDisposition,
|
||||||
originalUrl,
|
originalUrl,
|
||||||
true,
|
|
||||||
undefined,
|
undefined,
|
||||||
preventDefault,
|
preventDefault,
|
||||||
openExternal,
|
openExternal,
|
||||||
@ -197,7 +191,6 @@ test('background tabs with internal urls should be opened in background tabs', (
|
|||||||
internalUrl,
|
internalUrl,
|
||||||
backgroundDisposition,
|
backgroundDisposition,
|
||||||
originalUrl,
|
originalUrl,
|
||||||
true,
|
|
||||||
undefined,
|
undefined,
|
||||||
preventDefault,
|
preventDefault,
|
||||||
openExternal,
|
openExternal,
|
||||||
@ -227,7 +220,6 @@ test('about:blank urls should be handled', () => {
|
|||||||
'about:blank',
|
'about:blank',
|
||||||
undefined,
|
undefined,
|
||||||
originalUrl,
|
originalUrl,
|
||||||
true,
|
|
||||||
undefined,
|
undefined,
|
||||||
preventDefault,
|
preventDefault,
|
||||||
openExternal,
|
openExternal,
|
||||||
|
@ -4,7 +4,6 @@ export function onNewWindowHelper(
|
|||||||
urlToGo: string,
|
urlToGo: string,
|
||||||
disposition: string,
|
disposition: string,
|
||||||
targetUrl: string,
|
targetUrl: string,
|
||||||
internalLoginPages: boolean,
|
|
||||||
internalUrls: string | RegExp,
|
internalUrls: string | RegExp,
|
||||||
preventDefault,
|
preventDefault,
|
||||||
openExternal,
|
openExternal,
|
||||||
@ -14,7 +13,7 @@ export function onNewWindowHelper(
|
|||||||
blockExternal: boolean,
|
blockExternal: boolean,
|
||||||
onBlockedExternalUrl: (url: string) => void,
|
onBlockedExternalUrl: (url: string) => void,
|
||||||
): void {
|
): void {
|
||||||
if (!linkIsInternal(targetUrl, urlToGo, internalLoginPages, internalUrls)) {
|
if (!linkIsInternal(targetUrl, urlToGo, internalUrls)) {
|
||||||
preventDefault();
|
preventDefault();
|
||||||
if (blockExternal) {
|
if (blockExternal) {
|
||||||
onBlockedExternalUrl(urlToGo);
|
onBlockedExternalUrl(urlToGo);
|
||||||
|
@ -10,61 +10,46 @@ const externalUrl = 'https://www.wikipedia.org/wiki/Electron';
|
|||||||
const wildcardRegex = /.*/;
|
const wildcardRegex = /.*/;
|
||||||
|
|
||||||
test('the original url should be internal', () => {
|
test('the original url should be internal', () => {
|
||||||
expect(linkIsInternal(internalUrl, internalUrl, false, undefined)).toEqual(
|
expect(linkIsInternal(internalUrl, internalUrl, undefined)).toEqual(true);
|
||||||
true,
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test('sub-paths of the original url should be internal', () => {
|
test('sub-paths of the original url should be internal', () => {
|
||||||
expect(
|
expect(
|
||||||
linkIsInternal(
|
linkIsInternal(internalUrl, internalUrl + internalUrlSubPath, undefined),
|
||||||
internalUrl,
|
|
||||||
internalUrl + internalUrlSubPath,
|
|
||||||
false,
|
|
||||||
undefined,
|
|
||||||
),
|
|
||||||
).toEqual(true);
|
).toEqual(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("'about:blank' should be internal", () => {
|
test("'about:blank' should be internal", () => {
|
||||||
expect(linkIsInternal(internalUrl, 'about:blank', false, undefined)).toEqual(
|
expect(linkIsInternal(internalUrl, 'about:blank', undefined)).toEqual(true);
|
||||||
true,
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test('urls from different sites should not be internal', () => {
|
test('urls from different sites should not be internal', () => {
|
||||||
expect(linkIsInternal(internalUrl, externalUrl, false, undefined)).toEqual(
|
expect(linkIsInternal(internalUrl, externalUrl, undefined)).toEqual(false);
|
||||||
false,
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test('all urls should be internal with wildcard regex', () => {
|
test('all urls should be internal with wildcard regex', () => {
|
||||||
expect(
|
expect(linkIsInternal(internalUrl, externalUrl, wildcardRegex)).toEqual(true);
|
||||||
linkIsInternal(internalUrl, externalUrl, false, wildcardRegex),
|
|
||||||
).toEqual(true);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test('a "www." of a domain should be considered internal', () => {
|
test('a "www." of a domain should be considered internal', () => {
|
||||||
expect(linkIsInternal(internalUrl, internalUrlWww, false, undefined)).toEqual(
|
expect(linkIsInternal(internalUrl, internalUrlWww, undefined)).toEqual(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('urls on the same "base domain" should be considered internal', () => {
|
||||||
|
expect(linkIsInternal(internalUrl, sameBaseDomainUrl, undefined)).toEqual(
|
||||||
true,
|
true,
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('urls on the same "base domain" should be considered internal', () => {
|
|
||||||
expect(
|
|
||||||
linkIsInternal(internalUrl, sameBaseDomainUrl, false, undefined),
|
|
||||||
).toEqual(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('urls on the same "base domain" should be considered internal, even with a www', () => {
|
test('urls on the same "base domain" should be considered internal, even with a www', () => {
|
||||||
expect(
|
expect(linkIsInternal(internalUrlWww, sameBaseDomainUrl, undefined)).toEqual(
|
||||||
linkIsInternal(internalUrlWww, sameBaseDomainUrl, false, undefined),
|
true,
|
||||||
).toEqual(true);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('urls on the same "base domain" should be considered internal, long SLD', () => {
|
test('urls on the same "base domain" should be considered internal, long SLD', () => {
|
||||||
expect(
|
expect(
|
||||||
linkIsInternal(internalUrlCoUk, sameBaseDomainUrlCoUk, false, undefined),
|
linkIsInternal(internalUrlCoUk, sameBaseDomainUrlCoUk, undefined),
|
||||||
).toEqual(true);
|
).toEqual(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -98,20 +83,9 @@ const testLoginPages = [
|
|||||||
];
|
];
|
||||||
|
|
||||||
test.each(testLoginPages)(
|
test.each(testLoginPages)(
|
||||||
'%s login page should be internal if internalLoginPages is enabled',
|
'%s login page should be internal',
|
||||||
(loginUrl: string) => {
|
(loginUrl: string) => {
|
||||||
expect(linkIsInternal(internalUrl, loginUrl, true, undefined)).toEqual(
|
expect(linkIsInternal(internalUrl, loginUrl, undefined)).toEqual(true);
|
||||||
true,
|
|
||||||
);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
test.each(testLoginPages)(
|
|
||||||
'%s login page should not be internal if internalLoginPages is disabled',
|
|
||||||
(loginUrl: string) => {
|
|
||||||
expect(linkIsInternal(internalUrl, loginUrl, false, undefined)).toEqual(
|
|
||||||
false,
|
|
||||||
);
|
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
|
@ -36,14 +36,13 @@ function isInternalLoginPage(url: string): boolean {
|
|||||||
export function linkIsInternal(
|
export function linkIsInternal(
|
||||||
currentUrl: string,
|
currentUrl: string,
|
||||||
newUrl: string,
|
newUrl: string,
|
||||||
internalLoginPages: boolean,
|
|
||||||
internalUrlRegex: string | RegExp,
|
internalUrlRegex: string | RegExp,
|
||||||
): boolean {
|
): boolean {
|
||||||
if (newUrl === 'about:blank') {
|
if (newUrl === 'about:blank') {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (internalLoginPages && isInternalLoginPage(newUrl)) {
|
if (isInternalLoginPage(newUrl)) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
25
docs/api.md
25
docs/api.md
@ -43,7 +43,6 @@
|
|||||||
- [[ignore-gpu-blacklist]](#ignore-gpu-blacklist)
|
- [[ignore-gpu-blacklist]](#ignore-gpu-blacklist)
|
||||||
- [[enable-es3-apis]](#enable-es3-apis)
|
- [[enable-es3-apis]](#enable-es3-apis)
|
||||||
- [[insecure]](#insecure)
|
- [[insecure]](#insecure)
|
||||||
- [[internal-login-pages]](#internal-login-pages)
|
|
||||||
- [[internal-urls]](#internal-urls)
|
- [[internal-urls]](#internal-urls)
|
||||||
- [[block-external-urls]](#block-external-urls)
|
- [[block-external-urls]](#block-external-urls)
|
||||||
- [[proxy-rules]](#proxy-rules)
|
- [[proxy-rules]](#proxy-rules)
|
||||||
@ -395,30 +394,6 @@ Passes the enable-es3-apis flag to the Chrome engine, to force the activation of
|
|||||||
|
|
||||||
Forces the packaged app to ignore web security errors, such as [Mixed Content](https://developer.mozilla.org/en-US/docs/Security/Mixed_content) errors when receiving HTTP content on a HTTPS site.
|
Forces the packaged app to ignore web security errors, such as [Mixed Content](https://developer.mozilla.org/en-US/docs/Security/Mixed_content) errors when receiving HTTP content on a HTTPS site.
|
||||||
|
|
||||||
#### [internal-login-pages]
|
|
||||||
|
|
||||||
```
|
|
||||||
--internal-login-pages <boolean>
|
|
||||||
```
|
|
||||||
|
|
||||||
Whether to consider known login providers to be internal, so as to avoid login urls being opened in a browser without being able to login to the application. Default: true
|
|
||||||
|
|
||||||
Known login providers:
|
|
||||||
- Amazon
|
|
||||||
- Facebook
|
|
||||||
- GitHub
|
|
||||||
- Google
|
|
||||||
- LinkedIn
|
|
||||||
- Microsoft
|
|
||||||
- Okta
|
|
||||||
- Twitter
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
nativefier https://google.com --internal-login-pages false
|
|
||||||
```
|
|
||||||
|
|
||||||
#### [internal-urls]
|
#### [internal-urls]
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -44,7 +44,6 @@ function pickElectronAppArgs(options: AppOptions): any {
|
|||||||
ignoreCertificate: options.nativefier.ignoreCertificate,
|
ignoreCertificate: options.nativefier.ignoreCertificate,
|
||||||
ignoreGpuBlacklist: options.nativefier.ignoreGpuBlacklist,
|
ignoreGpuBlacklist: options.nativefier.ignoreGpuBlacklist,
|
||||||
insecure: options.nativefier.insecure,
|
insecure: options.nativefier.insecure,
|
||||||
internalLoginPages: options.nativefier.internalLoginPages,
|
|
||||||
internalUrls: options.nativefier.internalUrls,
|
internalUrls: options.nativefier.internalUrls,
|
||||||
blockExternalUrls: options.nativefier.blockExternalUrls,
|
blockExternalUrls: options.nativefier.blockExternalUrls,
|
||||||
maxHeight: options.nativefier.maxHeight,
|
maxHeight: options.nativefier.maxHeight,
|
||||||
|
11
src/cli.ts
11
src/cli.ts
@ -9,11 +9,7 @@ import * as log from 'loglevel';
|
|||||||
import { isArgFormatInvalid } from './helpers/helpers';
|
import { isArgFormatInvalid } from './helpers/helpers';
|
||||||
import { supportedArchs, supportedPlatforms } from './infer/inferOs';
|
import { supportedArchs, supportedPlatforms } from './infer/inferOs';
|
||||||
import { buildNativefierApp } from './main';
|
import { buildNativefierApp } from './main';
|
||||||
import {
|
import { parseBooleanOrString, parseJson } from './utils/parseUtils';
|
||||||
parseBoolean,
|
|
||||||
parseBooleanOrString,
|
|
||||||
parseJson,
|
|
||||||
} from './utils/parseUtils';
|
|
||||||
|
|
||||||
// package.json is `require`d to let tsc strip the `src` folder by determining
|
// package.json is `require`d to let tsc strip the `src` folder by determining
|
||||||
// baseUrl=src. A static import would prevent that and cause an ugly extra "src" folder
|
// baseUrl=src. A static import would prevent that and cause an ugly extra "src" folder
|
||||||
@ -212,11 +208,6 @@ if (require.main === module) {
|
|||||||
'default zoom factor to use when the app is opened; defaults to 1.0',
|
'default zoom factor to use when the app is opened; defaults to 1.0',
|
||||||
parseFloat,
|
parseFloat,
|
||||||
)
|
)
|
||||||
.option(
|
|
||||||
'--internal-login-pages',
|
|
||||||
"Force known login pages (Amazon, Facebook, GitHub, Google, LinkedIn, Microsoft, Okta, Twitter) to be internal urls so they don't have to be individually specified. Default: true",
|
|
||||||
(value) => parseBoolean(value, true),
|
|
||||||
)
|
|
||||||
.option(
|
.option(
|
||||||
'--internal-urls <value>',
|
'--internal-urls <value>',
|
||||||
'regex of URLs to consider "internal"; all other URLs will be opened in an external browser. Default: URLs on same second-level domain as app',
|
'regex of URLs to consider "internal"; all other URLs will be opened in an external browser. Default: URLs on same second-level domain as app',
|
||||||
|
@ -36,13 +36,6 @@ function checkApp(appRoot: string, inputOptions: any): void {
|
|||||||
const iconPath = path.join(appPath, iconFile);
|
const iconPath = path.join(appPath, iconFile);
|
||||||
expect(fs.existsSync(iconPath)).toBe(true);
|
expect(fs.existsSync(iconPath)).toBe(true);
|
||||||
expect(fs.statSync(iconPath).size).toBeGreaterThan(1000);
|
expect(fs.statSync(iconPath).size).toBeGreaterThan(1000);
|
||||||
|
|
||||||
// Internal Login Pages enabled by default
|
|
||||||
expect(nativefierConfig.internalLoginPages).toBe(
|
|
||||||
inputOptions.internalLoginPages === undefined
|
|
||||||
? true
|
|
||||||
: inputOptions.internalLoginPages,
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
describe('Nativefier', () => {
|
describe('Nativefier', () => {
|
||||||
@ -62,17 +55,4 @@ describe('Nativefier', () => {
|
|||||||
checkApp(appPath, options);
|
checkApp(appPath, options);
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test('can disable internalLoginPages', async () => {
|
|
||||||
const tempDirectory = getTempDir('integtest');
|
|
||||||
const options = {
|
|
||||||
targetUrl: 'https://google.com/',
|
|
||||||
out: tempDirectory,
|
|
||||||
overwrite: true,
|
|
||||||
platform: 'linux',
|
|
||||||
internalLoginPages: false,
|
|
||||||
};
|
|
||||||
const appPath = await buildNativefierApp(options);
|
|
||||||
checkApp(appPath, options);
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
@ -34,7 +34,6 @@ export interface AppOptions {
|
|||||||
ignoreGpuBlacklist: boolean;
|
ignoreGpuBlacklist: boolean;
|
||||||
inject: string[];
|
inject: string[];
|
||||||
insecure: boolean;
|
insecure: boolean;
|
||||||
internalLoginPages: boolean;
|
|
||||||
internalUrls: string;
|
internalUrls: string;
|
||||||
blockExternalUrls: boolean;
|
blockExternalUrls: boolean;
|
||||||
maximize: boolean;
|
maximize: boolean;
|
||||||
|
@ -74,11 +74,6 @@ export async function getOptions(rawOptions: any): Promise<AppOptions> {
|
|||||||
ignoreGpuBlacklist: rawOptions.ignoreGpuBlacklist || false,
|
ignoreGpuBlacklist: rawOptions.ignoreGpuBlacklist || false,
|
||||||
inject: rawOptions.inject || [],
|
inject: rawOptions.inject || [],
|
||||||
insecure: rawOptions.insecure || false,
|
insecure: rawOptions.insecure || false,
|
||||||
internalLoginPages:
|
|
||||||
rawOptions.internalLoginPages === undefined ||
|
|
||||||
typeof rawOptions.internalLoginPages !== 'boolean'
|
|
||||||
? true
|
|
||||||
: rawOptions.internalLoginPages,
|
|
||||||
internalUrls: rawOptions.internalUrls || null,
|
internalUrls: rawOptions.internalUrls || null,
|
||||||
blockExternalUrls: rawOptions.blockExternalUrls || false,
|
blockExternalUrls: rawOptions.blockExternalUrls || false,
|
||||||
maximize: rawOptions.maximize || false,
|
maximize: rawOptions.maximize || false,
|
||||||
|
Loading…
Reference in New Issue
Block a user