feat: 🎸 add WindowManager service for simple open/close

This commit is contained in:
Randall Morey committed 2021-05-05 14:34:26 -04:00
1 parent f597901140
commit dea79d785b
3 files changed
+117 -22

No files matched your search

+58
View File
@@ -0,0 +1,58 @@
import Service from '@ember/service';
import { inject as service } from '@ember/service';
/**
* The window manager service enables browser windows to open and close
* without the need to retain window references at the callsite.
*/
export default class WindowManagerService extends Service {
// =services
@service('browser/window') window;
// =attributes
/**
* An array of windows under management.
* @private
* @type {[Window]}
*/
#managedWindows = [];
// =methods
/**
* Opens a new window of the specified URL via browser services.
* @param {string} url
* @see `window.open`
*/
open(url) {
const newWindow = this.window.open(url);
this.add(newWindow);
}
/**
* Closes all windows under management and purges their references.
* @see `window.close`
*/
closeAll() {
this.#managedWindows.forEach((window) => window.close());
this.purgeAll();
}
/**
* Adds a window to management.
* @param {Window} window
*/
add(window) {
this.#managedWindows.push(window);
}
/**
* Resets the managed windows array. As long as no array references are
* retained, this should result in the original array being GC'd.
*/
purgeAll() {
this.#managedWindows = [];
}
}
@@ -0,0 +1,54 @@
import { module, test } from 'qunit';
import { setupTest } from 'ember-qunit';
import { setupBrowserFakes } from 'ember-browser-services/test-support';
import Service from '@ember/service';
module('Unit | Service | window-manager', function (hooks) {
setupTest(hooks);
setupBrowserFakes(hooks, { window: true });
test('it opens window instances', function (assert) {
assert.expect(1);
const fakeURL = 'bloop://not-a-real-url';
// Register mock window service
this.owner.register(
'service:browser/window',
class extends Service {
open(url) {
assert.equal(url, fakeURL);
}
}
);
const service = this.owner.lookup('service:window-manager');
service.open(fakeURL);
});
test('it closes all open window instances and _does not_ close already-closed instances', function (assert) {
const instanceCount = 3;
const assertionsPerInstance = 1;
assert.expect(instanceCount * assertionsPerInstance);
// Register mock window service
this.owner.register(
'service:browser/window',
class extends Service {
open() {
return {
close() {
assert.ok(true, 'Window closed.');
},
};
}
}
);
const service = this.owner.lookup('service:window-manager');
for (let i = 0; i < instanceCount; i++) {
service.open();
}
// First, close all open instances.
service.closeAll();
// Try closeAll again, which should result in no additional assertions.
// See assert.expect above, which accounts for a single close call
// per instance.
service.closeAll();
});
});
+5 -22
View File
@@ -7578,7 +7578,7 @@ debug@~4.1.0:
dependencies:
ms "^2.1.1"
debuglog@*, debuglog@^1.0.1:
debuglog@^1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492"
integrity sha1-qiT/uaw9+aI1GDfPstJ5NgzXhJI=
@@ -12385,7 +12385,7 @@ import-lazy@^4.0.0:
resolved "https://registry.yarnpkg.com/import-lazy/-/import-lazy-4.0.0.tgz#e8eb627483a0a43da3c03f3e35548be5cb0cc153"
integrity sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==
imurmurhash@*, imurmurhash@^0.1.4:
imurmurhash@^0.1.4:
version "0.1.4"
resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea"
integrity sha1-khi5srkoojixPcT7a21XbyMUU+o=
@@ -14083,11 +14083,6 @@ lodash._baseflatten@^3.0.0:
lodash.isarguments "^3.0.0"
lodash.isarray "^3.0.0"
lodash._baseindexof@*:
version "3.1.0"
resolved "https://registry.yarnpkg.com/lodash._baseindexof/-/lodash._baseindexof-3.1.0.tgz#fe52b53a1c6761e42618d654e4a25789ed61822c"
integrity sha1-/lK1OhxnYeQmGNZU5KJXie1hgiw=
lodash._baseuniq@~4.6.0:
version "4.6.0"
resolved "https://registry.yarnpkg.com/lodash._baseuniq/-/lodash._baseuniq-4.6.0.tgz#0ebb44e456814af7905c6212fa2c9b2d51b841e8"
@@ -14096,16 +14091,11 @@ lodash._baseuniq@~4.6.0:
lodash._createset "~4.0.0"
lodash._root "~3.0.0"
lodash._bindcallback@*, lodash._bindcallback@^3.0.0:
lodash._bindcallback@^3.0.0:
version "3.0.1"
resolved "https://registry.yarnpkg.com/lodash._bindcallback/-/lodash._bindcallback-3.0.1.tgz#e531c27644cf8b57a99e17ed95b35c748789392e"
integrity sha1-5THCdkTPi1epnhftlbNcdIeJOS4=
lodash._cacheindexof@*:
version "3.0.2"
resolved "https://registry.yarnpkg.com/lodash._cacheindexof/-/lodash._cacheindexof-3.0.2.tgz#3dc69ac82498d2ee5e3ce56091bafd2adc7bde92"
integrity sha1-PcaayCSY0u5ePOVgkbr9Ktx73pI=
lodash._createassigner@^3.0.0:
version "3.1.1"
resolved "https://registry.yarnpkg.com/lodash._createassigner/-/lodash._createassigner-3.1.1.tgz#838a5bae2fdaca63ac22dee8e19fa4e6d6970b11"
@@ -14115,19 +14105,12 @@ lodash._createassigner@^3.0.0:
lodash._isiterateecall "^3.0.0"
lodash.restparam "^3.0.0"
lodash._createcache@*:
version "3.1.2"
resolved "https://registry.yarnpkg.com/lodash._createcache/-/lodash._createcache-3.1.2.tgz#56d6a064017625e79ebca6b8018e17440bdcf093"
integrity sha1-VtagZAF2JeeevKa4AY4XRAvc8JM=
dependencies:
lodash._getnative "^3.0.0"
lodash._createset@~4.0.0:
version "4.0.3"
resolved "https://registry.yarnpkg.com/lodash._createset/-/lodash._createset-4.0.3.tgz#0f4659fbb09d75194fa9e2b88a6644d363c9fe26"
integrity sha1-D0ZZ+7CddRlPqeK4imZE02PJ/iY=
lodash._getnative@*, lodash._getnative@^3.0.0:
lodash._getnative@^3.0.0:
version "3.9.1"
resolved "https://registry.yarnpkg.com/lodash._getnative/-/lodash._getnative-3.9.1.tgz#570bc7dede46d61cdcde687d65d3eecbaa3aaff5"
integrity sha1-VwvH3t5G1hzc3mh9ZdPuy6o6r/U=
@@ -14345,7 +14328,7 @@ lodash.pick@^4.4.0:
resolved "https://registry.yarnpkg.com/lodash.pick/-/lodash.pick-4.4.0.tgz#52f05610fff9ded422611441ed1fc123a03001b3"
integrity sha1-UvBWEP/53tQiYRRB7R/BI6AwAbM=
lodash.restparam@*, lodash.restparam@^3.0.0:
lodash.restparam@^3.0.0:
version "3.6.1"
resolved "https://registry.yarnpkg.com/lodash.restparam/-/lodash.restparam-3.6.1.tgz#936a4e309ef330a7645ed4145986c85ae5b20805"
integrity sha1-k2pOMJ7zMKdkXtQUWYbIWuWyCAU=