From 535d52a3608e8fdeb52cbfee4737b9689cd50b09 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 10 Feb 2021 15:37:43 -0700 Subject: [PATCH 01/10] feat: add test for catching errors in Emitter --- test/emitter.test.ts | 22 +++++++++++++++++++++- test/serviceWorker.test.ts | 9 +++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 test/serviceWorker.test.ts diff --git a/test/emitter.test.ts b/test/emitter.test.ts index 8ff5106a45b1..001b13e0d18a 100644 --- a/test/emitter.test.ts +++ b/test/emitter.test.ts @@ -1,9 +1,10 @@ // Note: we need to import logger from the root // because this is the logger used in logError in ../src/common/util import { logger } from "../node_modules/@coder/logger" + import { Emitter } from "../src/common/emitter" -describe("Emitter", () => { +describe("emitter", () => { let spy: jest.SpyInstance beforeEach(() => { @@ -59,6 +60,25 @@ describe("Emitter", () => { emitter.dispose() }) + it("should log an error if something goes wrong", async () => { + const HELLO_WORLD = "HELLO_WORLD" + const mockCallback = jest.fn(() => "Mock function called") + const message = "You don't have access to that folder." + + const emitter = new Emitter<{ event: string; callback: () => void }>() + + const onHelloWorld = ({ event, callback }: { event: string; callback: () => void }): void => { + if (event === HELLO_WORLD) { + callback() + throw new Error(message) + } + } + + emitter.event(onHelloWorld) + + await emitter.emit({ event: HELLO_WORLD, callback: mockCallback }) + }) + it("should log an error if something goes wrong", async () => { const HELLO_WORLD = "HELLO_WORLD" const mockCallback = jest.fn(() => "Mock function called") diff --git a/test/serviceWorker.test.ts b/test/serviceWorker.test.ts new file mode 100644 index 000000000000..32e6effd580a --- /dev/null +++ b/test/serviceWorker.test.ts @@ -0,0 +1,9 @@ +describe("serviceWorker", () => { + it("should add the proper eventListeners", () => { + // make sure install, active and fetch were added as event listeners + }) + + it("should call the proper callbacks", () => { + // somehow test Line 8 with the events waitUntil.. + }) +}) \ No newline at end of file From 2690b46d03e132030a77de45f8da3188f500eb64 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Feb 2021 14:35:15 -0700 Subject: [PATCH 02/10] chore(testing): add service-worker-mock --- test/package.json | 2 ++ test/yarn.lock | 86 ++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 87 insertions(+), 1 deletion(-) diff --git a/test/package.json b/test/package.json index 4a408464c72f..9640d1956943 100644 --- a/test/package.json +++ b/test/package.json @@ -4,11 +4,13 @@ "@types/jest": "^26.0.20", "@types/jsdom": "^16.2.6", "@types/node-fetch": "^2.5.8", + "@types/service-worker-mock": "^2.0.1", "@types/supertest": "^2.0.10", "jest": "^26.6.3", "jsdom": "^16.4.0", "node-fetch": "^2.6.1", "playwright": "^1.8.0", + "service-worker-mock": "^2.0.5", "supertest": "^6.1.1", "ts-jest": "^26.4.4" } diff --git a/test/yarn.lock b/test/yarn.lock index 4f6ae7ab3b2c..559e3c07dc5b 100644 --- a/test/yarn.lock +++ b/test/yarn.lock @@ -588,6 +588,11 @@ resolved "https://registry.yarnpkg.com/@types/prettier/-/prettier-2.1.6.tgz#f4b1efa784e8db479cdb8b14403e2144b1e9ff03" integrity sha512-6gOkRe7OIioWAXfnO/2lFiv+SJichKVSys1mSsgyrYHSEjk8Ctv4tSR/Odvnu+HWlH2C8j53dahU03XmQdd5fA== +"@types/service-worker-mock@^2.0.1": + version "2.0.1" + resolved "https://registry.yarnpkg.com/@types/service-worker-mock/-/service-worker-mock-2.0.1.tgz#4857b2024318c395294a02eda5050ac083f41e56" + integrity sha512-LqaP0QmgppRF7YEaqx4amoazHNXaX5bIFDAu62LnWIc5ku0HbgqlPKroQstAu8WsdmWIqEfI9VGlP8Skkq+m5A== + "@types/stack-utils@^2.0.0": version "2.0.0" resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-2.0.0.tgz#7036640b4e21cc2f259ae826ce843d277dad8cff" @@ -1232,6 +1237,13 @@ diff-sequences@^26.6.2: resolved "https://registry.yarnpkg.com/diff-sequences/-/diff-sequences-26.6.2.tgz#48ba99157de1923412eed41db6b6d4aa9ca7c0b1" integrity sha512-Mv/TDa3nZ9sbc5soK+OoA74BsS3mL37yixCvUAQkiuA4Wz6YtwP/K47n2rv2ovzHZvoiQeA5FTQOschKkEwB0Q== +dom-urls@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/dom-urls/-/dom-urls-1.1.0.tgz#001ddf81628cd1e706125c7176f53ccec55d918e" + integrity sha1-AB3fgWKM0ecGElxxdvU8zsVdkY4= + dependencies: + urijs "^1.16.1" + domexception@^2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/domexception/-/domexception-2.0.1.tgz#fb44aefba793e1574b0af6aed2801d057529f304" @@ -2486,6 +2498,38 @@ locate-path@^5.0.0: dependencies: p-locate "^4.1.0" +lodash._basefor@^3.0.0: + version "3.0.3" + resolved "https://registry.yarnpkg.com/lodash._basefor/-/lodash._basefor-3.0.3.tgz#7550b4e9218ef09fad24343b612021c79b4c20c2" + integrity sha1-dVC06SGO8J+tJDQ7YSAhx5tMIMI= + +lodash.isarguments@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/lodash.isarguments/-/lodash.isarguments-3.1.0.tgz#2f573d85c6a24289ff00663b491c1d338ff3458a" + integrity sha1-L1c9hcaiQon/AGY7SRwdM4/zRYo= + +lodash.isarray@^3.0.0: + version "3.0.4" + resolved "https://registry.yarnpkg.com/lodash.isarray/-/lodash.isarray-3.0.4.tgz#79e4eb88c36a8122af86f844aa9bcd851b5fbb55" + integrity sha1-eeTriMNqgSKvhvhEqpvNhRtfu1U= + +lodash.isplainobject@^3.0.2: + version "3.2.0" + resolved "https://registry.yarnpkg.com/lodash.isplainobject/-/lodash.isplainobject-3.2.0.tgz#9a8238ae16b200432960cd7346512d0123fbf4c5" + integrity sha1-moI4rhayAEMpYM1zRlEtASP79MU= + dependencies: + lodash._basefor "^3.0.0" + lodash.isarguments "^3.0.0" + lodash.keysin "^3.0.0" + +lodash.keysin@^3.0.0: + version "3.0.8" + resolved "https://registry.yarnpkg.com/lodash.keysin/-/lodash.keysin-3.0.8.tgz#22c4493ebbedb1427962a54b445b2c8a767fb47f" + integrity sha1-IsRJPrvtsUJ5YqVLRFssinZ/tH8= + dependencies: + lodash.isarguments "^3.0.0" + lodash.isarray "^3.0.0" + lodash.memoize@4.x: version "4.1.2" resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe" @@ -3016,6 +3060,13 @@ readable-stream@^3.6.0: string_decoder "^1.1.1" util-deprecate "^1.0.1" +realistic-structured-clone@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/realistic-structured-clone/-/realistic-structured-clone-1.0.1.tgz#1abe82af0b80cd7b109fdaf5d29308032852d45d" + integrity sha1-Gr6CrwuAzXsQn9r10pMIAyhS1F0= + dependencies: + lodash.isplainobject "^3.0.2" + regex-not@^1.0.0, regex-not@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/regex-not/-/regex-not-1.0.2.tgz#1f4ece27e00b0b65e0247a6810e6a85d83a5752c" @@ -3199,6 +3250,16 @@ semver@^6.0.0, semver@^6.3.0: resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d" integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw== +service-worker-mock@^2.0.5: + version "2.0.5" + resolved "https://registry.yarnpkg.com/service-worker-mock/-/service-worker-mock-2.0.5.tgz#89d47ec1571130114d4deed66d69bdcfee4a4545" + integrity sha512-yk6NCFnRWGfbOlP+IS4hEbJnGU8dVgtodAAKLxhkTPsOmaES44XVSWTNozK6KwI+p/0PDRrFsb2RjTMhvXiNkA== + dependencies: + dom-urls "^1.1.0" + shelving-mock-indexeddb "^1.1.0" + url-search-params "^0.10.0" + w3c-hr-time "^1.0.1" + set-blocking@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/set-blocking/-/set-blocking-2.0.0.tgz#045f9782d011ae9a6803ddd382b24392b3d890f7" @@ -3243,6 +3304,19 @@ shellwords@^0.1.1: resolved "https://registry.yarnpkg.com/shellwords/-/shellwords-0.1.1.tgz#d6b9181c1a48d397324c84871efbcfc73fc0654b" integrity sha512-vFwSUfQvqybiICwZY5+DAWIPLKsWO31Q91JSKl3UYv+K5c2QRPzn0qzec6QPu1Qc9eHYItiP3NdJqNVqetYAww== +shelving-mock-event@^1.0.12: + version "1.0.12" + resolved "https://registry.yarnpkg.com/shelving-mock-event/-/shelving-mock-event-1.0.12.tgz#401dc90b3b49cbf2a817ecf2dd5a83eff4de2e14" + integrity sha512-2F+IZ010rwV3sA/Kd2hnC1vGNycsxeBJmjkXR8+4IOlv5e+Wvj+xH+A8Cv8/Z0lUyCut/HcxSpeDccYTVtnuaQ== + +shelving-mock-indexeddb@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/shelving-mock-indexeddb/-/shelving-mock-indexeddb-1.1.0.tgz#e065a8d7987d182d058e2b55f0f79a52d48a38f1" + integrity sha512-akHJAmGL/dplJ4FZNxPxVbOxMw8Ey6wAnB9+3+GCUNqPUcJaskS55GijxZtarTfAYB4XQyu+FLtjcq2Oa3e2Lg== + dependencies: + realistic-structured-clone "^1.0.1" + shelving-mock-event "^1.0.12" + signal-exit@^3.0.0, signal-exit@^3.0.2: version "3.0.3" resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.3.tgz#a1410c2edd8f077b08b4e253c8eacfcaf057461c" @@ -3674,11 +3748,21 @@ uri-js@^4.2.2: dependencies: punycode "^2.1.0" +urijs@^1.16.1: + version "1.19.6" + resolved "https://registry.yarnpkg.com/urijs/-/urijs-1.19.6.tgz#51f8cb17ca16faefb20b9a31ac60f84aa2b7c870" + integrity sha512-eSXsXZ2jLvGWeLYlQA3Gh36BcjF+0amo92+wHPyN1mdR8Nxf75fuEuYTd9c0a+m/vhCjRK0ESlE9YNLW+E1VEw== + urix@^0.1.0: version "0.1.0" resolved "https://registry.yarnpkg.com/urix/-/urix-0.1.0.tgz#da937f7a62e21fec1fd18d49b35c2935067a6c72" integrity sha1-2pN/emLiH+wf0Y1Js1wpNQZ6bHI= +url-search-params@^0.10.0: + version "0.10.2" + resolved "https://registry.yarnpkg.com/url-search-params/-/url-search-params-0.10.2.tgz#e9da69646e48c6140c6732e1f07fb669525f5a4e" + integrity sha512-d6GYsr992Bo9rzTZFc9BUw3UFAAg3prE9JGVBgW2TLTbI3rSvg4VDa0BFXHMzKkWbAuhrmaFWpucpRJl+3W7Jg== + use@^3.1.0: version "3.1.1" resolved "https://registry.yarnpkg.com/use/-/use-3.1.1.tgz#d50c8cac79a19fbc20f2911f56eb973f4e10070f" @@ -3725,7 +3809,7 @@ verror@1.10.0: core-util-is "1.0.2" extsprintf "^1.2.0" -w3c-hr-time@^1.0.2: +w3c-hr-time@^1.0.1, w3c-hr-time@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz#0a89cdf5cc15822df9c360543676963e0cc308cd" integrity sha512-z8P5DvDNjKDoFIHK7q8r8lackT6l+jo/Ye3HOle7l9nICP9lf1Ci25fy9vHd0JOWewkIFzXIEig3TdKT7JQ5fQ== From 4175c271184f43ca67891c41686236028a4b30f4 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Feb 2021 14:35:30 -0700 Subject: [PATCH 03/10] feat: add logs to serviceWorker --- src/browser/serviceWorker.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/browser/serviceWorker.ts b/src/browser/serviceWorker.ts index 1bee59bfb3c6..25765a1a4a68 100644 --- a/src/browser/serviceWorker.ts +++ b/src/browser/serviceWorker.ts @@ -1,11 +1,12 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ self.addEventListener("install", () => { - console.log("[Service Worker] install") + console.log("[Service Worker] installed") }) self.addEventListener("activate", (event: any) => { event.waitUntil((self as any).clients.claim()) + console.log("[Service Worker] activated") }) self.addEventListener("fetch", () => { From 4f2eb14268596c057bdaff85e0bef3a720ec25b6 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Feb 2021 14:35:41 -0700 Subject: [PATCH 04/10] feat(testing): add serviceWorker tests --- test/serviceWorker.test.ts | 45 +++++++++++++++++++++++++++++++++----- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/test/serviceWorker.test.ts b/test/serviceWorker.test.ts index 32e6effd580a..7b76f2c456e5 100644 --- a/test/serviceWorker.test.ts +++ b/test/serviceWorker.test.ts @@ -1,9 +1,44 @@ +import makeServiceWorkerEnv = require("service-worker-mock") +const makeFetchMock = require("service-worker-mock/fetch") + describe("serviceWorker", () => { - it("should add the proper eventListeners", () => { - // make sure install, active and fetch were added as event listeners + let spy: jest.SpyInstance + beforeEach(() => { + Object.assign( + global, + makeServiceWorkerEnv(), + makeFetchMock(), + // If you're using sinon ur similar you'd probably use below instead of makeFetchMock + // fetch: sinon.stub().returns(Promise.resolve()) + ) + jest.resetModules() + + spy = jest.spyOn(console, "log") + }) + + afterEach(() => { + jest.restoreAllMocks() + spy.mockRestore() + }) + + it("should add listeners", () => { + require("../src/browser/serviceWorker.ts") + const _self = (self as unknown) as WorkerGlobalScope + expect(_self.listeners.get("install")).toBeDefined() + expect(_self.listeners.get("activate")).toBeDefined() + expect(_self.listeners.get("fetch")).toBeDefined() + }) + + it("should call the proper callbacks for 'install'", async () => { + require("../src/browser/serviceWorker.ts") + await self.trigger("install") + expect(spy).toHaveBeenCalledWith("[Service Worker] installed") }) + it("should call the proper callbacks for 'activate'", async () => { + require("../src/browser/serviceWorker.ts") + await self.trigger("activate") - it("should call the proper callbacks", () => { - // somehow test Line 8 with the events waitUntil.. + // Activate serviceWorker + expect(spy).toHaveBeenCalledWith("[Service Worker] activated") }) -}) \ No newline at end of file +}) From a064e396b2416be98485ad742efce55d412b06fa Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Feb 2021 16:12:10 -0700 Subject: [PATCH 05/10] fix: add patches for service-worker-mock --- test/patches/service-worker-mock-fetch.patch | 15 +++++++++++++++ test/patches/service-worker-mock-response.patch | 9 +++++++++ 2 files changed, 24 insertions(+) create mode 100644 test/patches/service-worker-mock-fetch.patch create mode 100644 test/patches/service-worker-mock-response.patch diff --git a/test/patches/service-worker-mock-fetch.patch b/test/patches/service-worker-mock-fetch.patch new file mode 100644 index 000000000000..f3008c317c53 --- /dev/null +++ b/test/patches/service-worker-mock-fetch.patch @@ -0,0 +1,15 @@ +--- node_modules/service-worker-mock/fetch.js 2021-02-18 13:47:55.000000000 -0700 ++++ patches/service-worker-mock-fixed.js 2021-02-18 15:49:47.000000000 -0700 +@@ -1,8 +1,11 @@ + module.exports = async (request) => { ++ const Response = require('./models/Response'); + const response = new Response('Response from service-worker-mock/fetch.js', { + status: 200, + statusText: 'ok.' + }); +- response.url = request.url; ++ if (request && request.url) { ++ response.url = request.url; ++ } + return response; + }; diff --git a/test/patches/service-worker-mock-response.patch b/test/patches/service-worker-mock-response.patch new file mode 100644 index 000000000000..9e074f5062ea --- /dev/null +++ b/test/patches/service-worker-mock-response.patch @@ -0,0 +1,9 @@ +--- node_modules/service-worker-mock/models/Response.js 2021-02-18 13:47:55.000000000 -0700 ++++ patches/service-worker-mock-response.js 2021-02-18 15:57:12.000000000 -0700 +@@ -1,5 +1,6 @@ + // stubs https://developer.mozilla.org/en-US/docs/Web/API/Response + const Body = require('./Body'); ++const Blob = require('./Blob') + const Headers = require('./Headers'); + + const isSupportedBodyType = (body) => From 3b8d3a2d18cca179ef203ec23e3a3b2577a2aa4f Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Feb 2021 16:12:17 -0700 Subject: [PATCH 06/10] feat: add patch script to /test --- test/package.json | 3 +++ test/scripts/patch.sh | 22 ++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100755 test/scripts/patch.sh diff --git a/test/package.json b/test/package.json index 9640d1956943..1738e80d84ef 100644 --- a/test/package.json +++ b/test/package.json @@ -1,5 +1,8 @@ { "#": "We must put jest in a sub-directory otherwise VS Code somehow picks up the types and generates conflicts with mocha.", + "scripts": { + "postinstall": "./scripts/patch.sh" + }, "devDependencies": { "@types/jest": "^26.0.20", "@types/jsdom": "^16.2.6", diff --git a/test/scripts/patch.sh b/test/scripts/patch.sh new file mode 100755 index 000000000000..3a016d6f1caa --- /dev/null +++ b/test/scripts/patch.sh @@ -0,0 +1,22 @@ +#!/usr/bin/env bash +set -euo pipefail + +apply_service_worker_mock_patches() { + # The `service-worker-mock` package is no longer maintained + # so we have to apply patches ourselves + + # This patch fixes an undefined error in fetch.js and adds a missing import + patch --forward node_modules/service-worker-mock/fetch.js < patches/service-worker-mock-fetch.patch + + # This patch adds a missing import + patch --forward node_modules/service-worker-mock/models/Response.js < patches/service-worker-mock-response.patch +} + +main() { + echo -e "🔨 Applying patches..." + apply_service_worker_mock_patches + + echo -e "✅ Patches applied successfully." +} + +main "$@" From d419b65365a027b4b5266590f852de1240d10e44 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Feb 2021 16:50:41 -0700 Subject: [PATCH 07/10] feat: add skipLibCheck to lint.sh --- ci/dev/lint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/dev/lint.sh b/ci/dev/lint.sh index c4875ff1d710..9ba576e002c8 100755 --- a/ci/dev/lint.sh +++ b/ci/dev/lint.sh @@ -6,7 +6,7 @@ main() { eslint --max-warnings=0 --fix $(git ls-files "*.ts" "*.tsx" "*.js" | grep -v "lib/vscode") stylelint $(git ls-files "*.css" | grep -v "lib/vscode") - tsc --noEmit + tsc --noEmit --skipLibCheck shellcheck -e SC2046,SC2164,SC2154,SC1091,SC1090,SC2002 $(git ls-files "*.sh" | grep -v "lib/vscode") if command -v helm && helm kubeval --help > /dev/null; then helm kubeval ci/helm-chart From 040c0d6f8d6d96fcb4c5cedff1326d75ec81af2f Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Feb 2021 16:50:49 -0700 Subject: [PATCH 08/10] fix: add patch for service-worker-types --- test/patches/service-worker-types.patch | 14 ++++++++++++++ test/scripts/patch.sh | 4 ++++ 2 files changed, 18 insertions(+) create mode 100644 test/patches/service-worker-types.patch diff --git a/test/patches/service-worker-types.patch b/test/patches/service-worker-types.patch new file mode 100644 index 000000000000..1687082261ab --- /dev/null +++ b/test/patches/service-worker-types.patch @@ -0,0 +1,14 @@ +--- node_modules/@types/service-worker-mock/index.d.ts 2021-02-18 13:51:50.000000000 -0700 ++++ patches/service-workertypes.d.ts 2021-02-18 16:30:01.000000000 -0700 +@@ -3,6 +3,11 @@ + // Definitions by: Remco Haszing + // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + // TypeScript Version: 2.8 ++// https://gist.github.com/shqld/32df51a4a4ed429f2c76e4e2cfdf6f96#gistcomment-2793376 ++// excludes default libs such as 'dom' conflicting with 'webworker' ++/// ++/// ++/// + + export = makeServiceWorkerEnv; + declare function makeServiceWorkerEnv(): WorkerGlobalScope; diff --git a/test/scripts/patch.sh b/test/scripts/patch.sh index 3a016d6f1caa..48f099ace4ff 100755 --- a/test/scripts/patch.sh +++ b/test/scripts/patch.sh @@ -10,6 +10,10 @@ apply_service_worker_mock_patches() { # This patch adds a missing import patch --forward node_modules/service-worker-mock/models/Response.js < patches/service-worker-mock-response.patch + + # This patch fixes the types declaration file + # See discussion: + patch --forward node_modules/@types/service-worker-mock/index.d.ts < patches/service-worker-types.patch } main() { From ce9811f0bd2308d1c7619e2c727f5633eb42f479 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 24 Feb 2021 10:10:05 -0700 Subject: [PATCH 09/10] fix: inconsistency with patch --- test/patches/service-worker-mock-response.patch | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/patches/service-worker-mock-response.patch b/test/patches/service-worker-mock-response.patch index 9e074f5062ea..16ed6fd8a0d2 100644 --- a/test/patches/service-worker-mock-response.patch +++ b/test/patches/service-worker-mock-response.patch @@ -3,7 +3,7 @@ @@ -1,5 +1,6 @@ // stubs https://developer.mozilla.org/en-US/docs/Web/API/Response const Body = require('./Body'); -+const Blob = require('./Blob') ++const Blob = require('./Blob'); const Headers = require('./Headers'); - + const isSupportedBodyType = (body) => From f1f0f497ea4aad6e412af93863aeeeadd6378e83 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 24 Feb 2021 10:50:08 -0700 Subject: [PATCH 10/10] refactor: add custom mock for serviceWorker test --- test/package.json | 5 -- test/patches/service-worker-mock-fetch.patch | 15 ---- .../service-worker-mock-response.patch | 9 -- test/patches/service-worker-types.patch | 14 --- test/scripts/patch.sh | 26 ------ test/serviceWorker.test.ts | 86 +++++++++++++++---- test/yarn.lock | 86 +------------------ 7 files changed, 68 insertions(+), 173 deletions(-) delete mode 100644 test/patches/service-worker-mock-fetch.patch delete mode 100644 test/patches/service-worker-mock-response.patch delete mode 100644 test/patches/service-worker-types.patch delete mode 100755 test/scripts/patch.sh diff --git a/test/package.json b/test/package.json index 1738e80d84ef..4a408464c72f 100644 --- a/test/package.json +++ b/test/package.json @@ -1,19 +1,14 @@ { "#": "We must put jest in a sub-directory otherwise VS Code somehow picks up the types and generates conflicts with mocha.", - "scripts": { - "postinstall": "./scripts/patch.sh" - }, "devDependencies": { "@types/jest": "^26.0.20", "@types/jsdom": "^16.2.6", "@types/node-fetch": "^2.5.8", - "@types/service-worker-mock": "^2.0.1", "@types/supertest": "^2.0.10", "jest": "^26.6.3", "jsdom": "^16.4.0", "node-fetch": "^2.6.1", "playwright": "^1.8.0", - "service-worker-mock": "^2.0.5", "supertest": "^6.1.1", "ts-jest": "^26.4.4" } diff --git a/test/patches/service-worker-mock-fetch.patch b/test/patches/service-worker-mock-fetch.patch deleted file mode 100644 index f3008c317c53..000000000000 --- a/test/patches/service-worker-mock-fetch.patch +++ /dev/null @@ -1,15 +0,0 @@ ---- node_modules/service-worker-mock/fetch.js 2021-02-18 13:47:55.000000000 -0700 -+++ patches/service-worker-mock-fixed.js 2021-02-18 15:49:47.000000000 -0700 -@@ -1,8 +1,11 @@ - module.exports = async (request) => { -+ const Response = require('./models/Response'); - const response = new Response('Response from service-worker-mock/fetch.js', { - status: 200, - statusText: 'ok.' - }); -- response.url = request.url; -+ if (request && request.url) { -+ response.url = request.url; -+ } - return response; - }; diff --git a/test/patches/service-worker-mock-response.patch b/test/patches/service-worker-mock-response.patch deleted file mode 100644 index 16ed6fd8a0d2..000000000000 --- a/test/patches/service-worker-mock-response.patch +++ /dev/null @@ -1,9 +0,0 @@ ---- node_modules/service-worker-mock/models/Response.js 2021-02-18 13:47:55.000000000 -0700 -+++ patches/service-worker-mock-response.js 2021-02-18 15:57:12.000000000 -0700 -@@ -1,5 +1,6 @@ - // stubs https://developer.mozilla.org/en-US/docs/Web/API/Response - const Body = require('./Body'); -+const Blob = require('./Blob'); - const Headers = require('./Headers'); - - const isSupportedBodyType = (body) => diff --git a/test/patches/service-worker-types.patch b/test/patches/service-worker-types.patch deleted file mode 100644 index 1687082261ab..000000000000 --- a/test/patches/service-worker-types.patch +++ /dev/null @@ -1,14 +0,0 @@ ---- node_modules/@types/service-worker-mock/index.d.ts 2021-02-18 13:51:50.000000000 -0700 -+++ patches/service-workertypes.d.ts 2021-02-18 16:30:01.000000000 -0700 -@@ -3,6 +3,11 @@ - // Definitions by: Remco Haszing - // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - // TypeScript Version: 2.8 -+// https://gist.github.com/shqld/32df51a4a4ed429f2c76e4e2cfdf6f96#gistcomment-2793376 -+// excludes default libs such as 'dom' conflicting with 'webworker' -+/// -+/// -+/// - - export = makeServiceWorkerEnv; - declare function makeServiceWorkerEnv(): WorkerGlobalScope; diff --git a/test/scripts/patch.sh b/test/scripts/patch.sh deleted file mode 100755 index 48f099ace4ff..000000000000 --- a/test/scripts/patch.sh +++ /dev/null @@ -1,26 +0,0 @@ -#!/usr/bin/env bash -set -euo pipefail - -apply_service_worker_mock_patches() { - # The `service-worker-mock` package is no longer maintained - # so we have to apply patches ourselves - - # This patch fixes an undefined error in fetch.js and adds a missing import - patch --forward node_modules/service-worker-mock/fetch.js < patches/service-worker-mock-fetch.patch - - # This patch adds a missing import - patch --forward node_modules/service-worker-mock/models/Response.js < patches/service-worker-mock-response.patch - - # This patch fixes the types declaration file - # See discussion: - patch --forward node_modules/@types/service-worker-mock/index.d.ts < patches/service-worker-types.patch -} - -main() { - echo -e "🔨 Applying patches..." - apply_service_worker_mock_patches - - echo -e "✅ Patches applied successfully." -} - -main "$@" diff --git a/test/serviceWorker.test.ts b/test/serviceWorker.test.ts index 7b76f2c456e5..7933d1f42daf 100644 --- a/test/serviceWorker.test.ts +++ b/test/serviceWorker.test.ts @@ -1,44 +1,92 @@ -import makeServiceWorkerEnv = require("service-worker-mock") -const makeFetchMock = require("service-worker-mock/fetch") +interface MockEvent { + claim: jest.Mock + waitUntil?: jest.Mock +} + +interface Listener { + event: string + cb: (event?: MockEvent) => void +} describe("serviceWorker", () => { + let listeners: Listener[] = [] let spy: jest.SpyInstance - beforeEach(() => { - Object.assign( - global, - makeServiceWorkerEnv(), - makeFetchMock(), - // If you're using sinon ur similar you'd probably use below instead of makeFetchMock - // fetch: sinon.stub().returns(Promise.resolve()) - ) - jest.resetModules() + let claimSpy: jest.Mock + let waitUntilSpy: jest.Mock + + function emit(event: string) { + listeners + .filter((listener) => listener.event === event) + .forEach((listener) => { + switch (event) { + case "activate": + listener.cb({ + claim: jest.fn(), + waitUntil: jest.fn(() => waitUntilSpy()), + }) + break + default: + listener.cb() + } + }) + } + beforeEach(() => { + claimSpy = jest.fn() spy = jest.spyOn(console, "log") + waitUntilSpy = jest.fn() + + Object.assign(global, { + self: global, + addEventListener: (event: string, cb: () => void) => { + listeners.push({ event, cb }) + }, + clients: { + claim: claimSpy.mockResolvedValue("claimed"), + }, + }) }) afterEach(() => { jest.restoreAllMocks() - spy.mockRestore() + jest.resetModules() + spy.mockClear() + claimSpy.mockClear() + + // Clear all the listeners + listeners = [] }) - it("should add listeners", () => { + it("should add 3 listeners: install, activate and fetch", () => { require("../src/browser/serviceWorker.ts") - const _self = (self as unknown) as WorkerGlobalScope - expect(_self.listeners.get("install")).toBeDefined() - expect(_self.listeners.get("activate")).toBeDefined() - expect(_self.listeners.get("fetch")).toBeDefined() + const listenerEventNames = listeners.map((listener) => listener.event) + + expect(listeners).toHaveLength(3) + expect(listenerEventNames).toContain("install") + expect(listenerEventNames).toContain("activate") + expect(listenerEventNames).toContain("fetch") }) it("should call the proper callbacks for 'install'", async () => { require("../src/browser/serviceWorker.ts") - await self.trigger("install") + emit("install") expect(spy).toHaveBeenCalledWith("[Service Worker] installed") + expect(spy).toHaveBeenCalledTimes(1) + }) + + it("should do nothing when 'fetch' is called", async () => { + require("../src/browser/serviceWorker.ts") + emit("fetch") + expect(spy).not.toHaveBeenCalled() }) + it("should call the proper callbacks for 'activate'", async () => { require("../src/browser/serviceWorker.ts") - await self.trigger("activate") + emit("activate") // Activate serviceWorker expect(spy).toHaveBeenCalledWith("[Service Worker] activated") + expect(waitUntilSpy).toHaveBeenCalled() + expect(claimSpy).toHaveBeenCalled() }) }) diff --git a/test/yarn.lock b/test/yarn.lock index 559e3c07dc5b..4f6ae7ab3b2c 100644 --- a/test/yarn.lock +++ b/test/yarn.lock @@ -588,11 +588,6 @@ resolved "https://registry.yarnpkg.com/@types/prettier/-/prettier-2.1.6.tgz#f4b1efa784e8db479cdb8b14403e2144b1e9ff03" integrity sha512-6gOkRe7OIioWAXfnO/2lFiv+SJichKVSys1mSsgyrYHSEjk8Ctv4tSR/Odvnu+HWlH2C8j53dahU03XmQdd5fA== -"@types/service-worker-mock@^2.0.1": - version "2.0.1" - resolved "https://registry.yarnpkg.com/@types/service-worker-mock/-/service-worker-mock-2.0.1.tgz#4857b2024318c395294a02eda5050ac083f41e56" - integrity sha512-LqaP0QmgppRF7YEaqx4amoazHNXaX5bIFDAu62LnWIc5ku0HbgqlPKroQstAu8WsdmWIqEfI9VGlP8Skkq+m5A== - "@types/stack-utils@^2.0.0": version "2.0.0" resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-2.0.0.tgz#7036640b4e21cc2f259ae826ce843d277dad8cff" @@ -1237,13 +1232,6 @@ diff-sequences@^26.6.2: resolved "https://registry.yarnpkg.com/diff-sequences/-/diff-sequences-26.6.2.tgz#48ba99157de1923412eed41db6b6d4aa9ca7c0b1" integrity sha512-Mv/TDa3nZ9sbc5soK+OoA74BsS3mL37yixCvUAQkiuA4Wz6YtwP/K47n2rv2ovzHZvoiQeA5FTQOschKkEwB0Q== -dom-urls@^1.1.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/dom-urls/-/dom-urls-1.1.0.tgz#001ddf81628cd1e706125c7176f53ccec55d918e" - integrity sha1-AB3fgWKM0ecGElxxdvU8zsVdkY4= - dependencies: - urijs "^1.16.1" - domexception@^2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/domexception/-/domexception-2.0.1.tgz#fb44aefba793e1574b0af6aed2801d057529f304" @@ -2498,38 +2486,6 @@ locate-path@^5.0.0: dependencies: p-locate "^4.1.0" -lodash._basefor@^3.0.0: - version "3.0.3" - resolved "https://registry.yarnpkg.com/lodash._basefor/-/lodash._basefor-3.0.3.tgz#7550b4e9218ef09fad24343b612021c79b4c20c2" - integrity sha1-dVC06SGO8J+tJDQ7YSAhx5tMIMI= - -lodash.isarguments@^3.0.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/lodash.isarguments/-/lodash.isarguments-3.1.0.tgz#2f573d85c6a24289ff00663b491c1d338ff3458a" - integrity sha1-L1c9hcaiQon/AGY7SRwdM4/zRYo= - -lodash.isarray@^3.0.0: - version "3.0.4" - resolved "https://registry.yarnpkg.com/lodash.isarray/-/lodash.isarray-3.0.4.tgz#79e4eb88c36a8122af86f844aa9bcd851b5fbb55" - integrity sha1-eeTriMNqgSKvhvhEqpvNhRtfu1U= - -lodash.isplainobject@^3.0.2: - version "3.2.0" - resolved "https://registry.yarnpkg.com/lodash.isplainobject/-/lodash.isplainobject-3.2.0.tgz#9a8238ae16b200432960cd7346512d0123fbf4c5" - integrity sha1-moI4rhayAEMpYM1zRlEtASP79MU= - dependencies: - lodash._basefor "^3.0.0" - lodash.isarguments "^3.0.0" - lodash.keysin "^3.0.0" - -lodash.keysin@^3.0.0: - version "3.0.8" - resolved "https://registry.yarnpkg.com/lodash.keysin/-/lodash.keysin-3.0.8.tgz#22c4493ebbedb1427962a54b445b2c8a767fb47f" - integrity sha1-IsRJPrvtsUJ5YqVLRFssinZ/tH8= - dependencies: - lodash.isarguments "^3.0.0" - lodash.isarray "^3.0.0" - lodash.memoize@4.x: version "4.1.2" resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe" @@ -3060,13 +3016,6 @@ readable-stream@^3.6.0: string_decoder "^1.1.1" util-deprecate "^1.0.1" -realistic-structured-clone@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/realistic-structured-clone/-/realistic-structured-clone-1.0.1.tgz#1abe82af0b80cd7b109fdaf5d29308032852d45d" - integrity sha1-Gr6CrwuAzXsQn9r10pMIAyhS1F0= - dependencies: - lodash.isplainobject "^3.0.2" - regex-not@^1.0.0, regex-not@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/regex-not/-/regex-not-1.0.2.tgz#1f4ece27e00b0b65e0247a6810e6a85d83a5752c" @@ -3250,16 +3199,6 @@ semver@^6.0.0, semver@^6.3.0: resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d" integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw== -service-worker-mock@^2.0.5: - version "2.0.5" - resolved "https://registry.yarnpkg.com/service-worker-mock/-/service-worker-mock-2.0.5.tgz#89d47ec1571130114d4deed66d69bdcfee4a4545" - integrity sha512-yk6NCFnRWGfbOlP+IS4hEbJnGU8dVgtodAAKLxhkTPsOmaES44XVSWTNozK6KwI+p/0PDRrFsb2RjTMhvXiNkA== - dependencies: - dom-urls "^1.1.0" - shelving-mock-indexeddb "^1.1.0" - url-search-params "^0.10.0" - w3c-hr-time "^1.0.1" - set-blocking@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/set-blocking/-/set-blocking-2.0.0.tgz#045f9782d011ae9a6803ddd382b24392b3d890f7" @@ -3304,19 +3243,6 @@ shellwords@^0.1.1: resolved "https://registry.yarnpkg.com/shellwords/-/shellwords-0.1.1.tgz#d6b9181c1a48d397324c84871efbcfc73fc0654b" integrity sha512-vFwSUfQvqybiICwZY5+DAWIPLKsWO31Q91JSKl3UYv+K5c2QRPzn0qzec6QPu1Qc9eHYItiP3NdJqNVqetYAww== -shelving-mock-event@^1.0.12: - version "1.0.12" - resolved "https://registry.yarnpkg.com/shelving-mock-event/-/shelving-mock-event-1.0.12.tgz#401dc90b3b49cbf2a817ecf2dd5a83eff4de2e14" - integrity sha512-2F+IZ010rwV3sA/Kd2hnC1vGNycsxeBJmjkXR8+4IOlv5e+Wvj+xH+A8Cv8/Z0lUyCut/HcxSpeDccYTVtnuaQ== - -shelving-mock-indexeddb@^1.1.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/shelving-mock-indexeddb/-/shelving-mock-indexeddb-1.1.0.tgz#e065a8d7987d182d058e2b55f0f79a52d48a38f1" - integrity sha512-akHJAmGL/dplJ4FZNxPxVbOxMw8Ey6wAnB9+3+GCUNqPUcJaskS55GijxZtarTfAYB4XQyu+FLtjcq2Oa3e2Lg== - dependencies: - realistic-structured-clone "^1.0.1" - shelving-mock-event "^1.0.12" - signal-exit@^3.0.0, signal-exit@^3.0.2: version "3.0.3" resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.3.tgz#a1410c2edd8f077b08b4e253c8eacfcaf057461c" @@ -3748,21 +3674,11 @@ uri-js@^4.2.2: dependencies: punycode "^2.1.0" -urijs@^1.16.1: - version "1.19.6" - resolved "https://registry.yarnpkg.com/urijs/-/urijs-1.19.6.tgz#51f8cb17ca16faefb20b9a31ac60f84aa2b7c870" - integrity sha512-eSXsXZ2jLvGWeLYlQA3Gh36BcjF+0amo92+wHPyN1mdR8Nxf75fuEuYTd9c0a+m/vhCjRK0ESlE9YNLW+E1VEw== - urix@^0.1.0: version "0.1.0" resolved "https://registry.yarnpkg.com/urix/-/urix-0.1.0.tgz#da937f7a62e21fec1fd18d49b35c2935067a6c72" integrity sha1-2pN/emLiH+wf0Y1Js1wpNQZ6bHI= -url-search-params@^0.10.0: - version "0.10.2" - resolved "https://registry.yarnpkg.com/url-search-params/-/url-search-params-0.10.2.tgz#e9da69646e48c6140c6732e1f07fb669525f5a4e" - integrity sha512-d6GYsr992Bo9rzTZFc9BUw3UFAAg3prE9JGVBgW2TLTbI3rSvg4VDa0BFXHMzKkWbAuhrmaFWpucpRJl+3W7Jg== - use@^3.1.0: version "3.1.1" resolved "https://registry.yarnpkg.com/use/-/use-3.1.1.tgz#d50c8cac79a19fbc20f2911f56eb973f4e10070f" @@ -3809,7 +3725,7 @@ verror@1.10.0: core-util-is "1.0.2" extsprintf "^1.2.0" -w3c-hr-time@^1.0.1, w3c-hr-time@^1.0.2: +w3c-hr-time@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz#0a89cdf5cc15822df9c360543676963e0cc308cd" integrity sha512-z8P5DvDNjKDoFIHK7q8r8lackT6l+jo/Ye3HOle7l9nICP9lf1Ci25fy9vHd0JOWewkIFzXIEig3TdKT7JQ5fQ==