mirror of
https://github.com/denoland/deno.git
synced 2024-11-29 16:30:56 -05:00
930ce20870
This commit deprecates `window` global and adds deprecation
notice on each use of `window`.
We decided to proceed with removal of `window` global variable in Deno
2.0. There's a lot of code
in the wild that uses pattern like this:
```
if (typeof window !== "undefined) {
...
}
```
to check if the code is being run in browser. However, this check passes
fine in Deno and
most often libraries that do this check try to access some browser API
that is not available
in Deno, or use DOM APIs (which are also not available in Deno).
This situation has occurred multiple times already
and it's unfeasible to expect the whole ecosystem to migrate to new
check (and even if that
happened there's a ton of code that's already shipped and won't change).
The migration is straightfoward - replace all usages of `window` with
`globalThis` or `self`.
When Deno encounters use of `window` global it will now issue a warning,
steering users
towards required changes:
```
Warning
├ Use of deprecated "window" API.
│
├ This API will be removed in Deno 2.0. Make sure to upgrade to a stable API before then.
│
├ Suggestion: Use `globalThis` or `self` instead.
│
├ Suggestion: You can provide `window` in the current scope with: `const window = globalThis`.
│
└ Stack trace:
└─ at file:///Users/ib/dev/deno/foo.js:7:1
```
Ref https://github.com/denoland/deno/issues/13367.
131 lines
3.5 KiB
JavaScript
131 lines
3.5 KiB
JavaScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
|
|
import { core, internals, primordials } from "ext:core/mod.js";
|
|
const {
|
|
op_bootstrap_language,
|
|
op_bootstrap_numcpus,
|
|
op_bootstrap_user_agent,
|
|
} = core.ensureFastOps(true);
|
|
const {
|
|
ObjectDefineProperties,
|
|
ObjectPrototypeIsPrototypeOf,
|
|
SymbolFor,
|
|
} = primordials;
|
|
|
|
import * as util from "ext:runtime/06_util.js";
|
|
import * as location from "ext:deno_web/12_location.js";
|
|
import * as console from "ext:deno_console/01_console.js";
|
|
import * as webidl from "ext:deno_webidl/00_webidl.js";
|
|
import * as globalInterfaces from "ext:deno_web/04_global_interfaces.js";
|
|
import * as webStorage from "ext:deno_webstorage/01_webstorage.js";
|
|
import * as prompt from "ext:runtime/41_prompt.js";
|
|
import { loadWebGPU, webgpu } from "ext:deno_webgpu/00_init.js";
|
|
|
|
class Navigator {
|
|
constructor() {
|
|
webidl.illegalConstructor();
|
|
}
|
|
|
|
[SymbolFor("Deno.privateCustomInspect")](inspect, inspectOptions) {
|
|
return inspect(
|
|
console.createFilteredInspectProxy({
|
|
object: this,
|
|
evaluate: ObjectPrototypeIsPrototypeOf(NavigatorPrototype, this),
|
|
keys: [
|
|
"hardwareConcurrency",
|
|
"userAgent",
|
|
"language",
|
|
"languages",
|
|
],
|
|
}),
|
|
inspectOptions,
|
|
);
|
|
}
|
|
}
|
|
|
|
const navigator = webidl.createBranded(Navigator);
|
|
|
|
function memoizeLazy(f) {
|
|
let v_ = null;
|
|
return () => {
|
|
if (v_ === null) {
|
|
v_ = f();
|
|
}
|
|
return v_;
|
|
};
|
|
}
|
|
|
|
const numCpus = memoizeLazy(() => op_bootstrap_numcpus());
|
|
const userAgent = memoizeLazy(() => op_bootstrap_user_agent());
|
|
const language = memoizeLazy(() => op_bootstrap_language());
|
|
|
|
ObjectDefineProperties(Navigator.prototype, {
|
|
gpu: {
|
|
configurable: true,
|
|
enumerable: true,
|
|
get() {
|
|
webidl.assertBranded(this, NavigatorPrototype);
|
|
loadWebGPU();
|
|
return webgpu.gpu;
|
|
},
|
|
},
|
|
hardwareConcurrency: {
|
|
configurable: true,
|
|
enumerable: true,
|
|
get() {
|
|
webidl.assertBranded(this, NavigatorPrototype);
|
|
return numCpus();
|
|
},
|
|
},
|
|
userAgent: {
|
|
configurable: true,
|
|
enumerable: true,
|
|
get() {
|
|
webidl.assertBranded(this, NavigatorPrototype);
|
|
return userAgent();
|
|
},
|
|
},
|
|
language: {
|
|
configurable: true,
|
|
enumerable: true,
|
|
get() {
|
|
webidl.assertBranded(this, NavigatorPrototype);
|
|
return language();
|
|
},
|
|
},
|
|
languages: {
|
|
configurable: true,
|
|
enumerable: true,
|
|
get() {
|
|
webidl.assertBranded(this, NavigatorPrototype);
|
|
return [language()];
|
|
},
|
|
},
|
|
});
|
|
const NavigatorPrototype = Navigator.prototype;
|
|
|
|
const mainRuntimeGlobalProperties = {
|
|
Location: location.locationConstructorDescriptor,
|
|
location: location.locationDescriptor,
|
|
Window: globalInterfaces.windowConstructorDescriptor,
|
|
window: util.getterOnly(() => {
|
|
internals.warnOnDeprecatedApi(
|
|
"window",
|
|
new Error().stack,
|
|
"Use `globalThis` or `self` instead.",
|
|
"You can provide `window` in the current scope with: `const window = globalThis`.",
|
|
);
|
|
return globalThis;
|
|
}),
|
|
self: util.getterOnly(() => globalThis),
|
|
Navigator: util.nonEnumerable(Navigator),
|
|
navigator: util.getterOnly(() => navigator),
|
|
alert: util.writable(prompt.alert),
|
|
confirm: util.writable(prompt.confirm),
|
|
prompt: util.writable(prompt.prompt),
|
|
localStorage: util.getterOnly(webStorage.localStorage),
|
|
sessionStorage: util.getterOnly(webStorage.sessionStorage),
|
|
Storage: util.nonEnumerable(webStorage.Storage),
|
|
};
|
|
|
|
export { mainRuntimeGlobalProperties, memoizeLazy };
|