@speedkit/cli 4.43.0-beta.1 → 4.44.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/CHANGELOG.md +9 -2
  2. package/README.md +12 -2
  3. package/dist/commands/onboarding.d.ts +3 -0
  4. package/dist/commands/onboarding.js +7 -1
  5. package/dist/services/onboarding/error/inject-installation-error.d.ts +6 -0
  6. package/dist/services/onboarding/error/inject-installation-error.js +11 -0
  7. package/dist/services/onboarding/error/inject-target-error.d.ts +6 -0
  8. package/dist/services/onboarding/error/inject-target-error.js +11 -0
  9. package/dist/services/onboarding/error/missing-customer-path-error.d.ts +1 -1
  10. package/dist/services/onboarding/error/missing-customer-path-error.js +2 -1
  11. package/dist/services/onboarding/fetch-events/customer-domain-document-response.d.ts +4 -14
  12. package/dist/services/onboarding/fetch-events/customer-domain-document-response.js +6 -45
  13. package/dist/services/onboarding/fetch-events/document-rewrite.d.ts +19 -0
  14. package/dist/services/onboarding/fetch-events/document-rewrite.js +47 -0
  15. package/dist/services/onboarding/fetch-events/speed-kit-install-html.d.ts +5 -1
  16. package/dist/services/onboarding/fetch-events/speed-kit-install-html.js +7 -2
  17. package/dist/services/onboarding/html-rewrites.d.ts +3 -3
  18. package/dist/services/onboarding/html-rewrites.js +3 -3
  19. package/dist/services/onboarding/index.d.ts +1 -1
  20. package/dist/services/onboarding/index.js +1 -1
  21. package/dist/services/onboarding/inject/content-security-policy.d.ts +14 -0
  22. package/dist/services/onboarding/inject/content-security-policy.js +54 -0
  23. package/dist/services/onboarding/inject/deployed-installation.d.ts +15 -0
  24. package/dist/services/onboarding/inject/deployed-installation.js +32 -0
  25. package/dist/services/onboarding/inject/foreign-install-request.d.ts +27 -0
  26. package/dist/services/onboarding/inject/foreign-install-request.js +50 -0
  27. package/dist/services/onboarding/inject/inject-document-rewrite.d.ts +23 -0
  28. package/dist/services/onboarding/inject/inject-document-rewrite.js +52 -0
  29. package/dist/services/onboarding/inject/inject-service.d.ts +32 -0
  30. package/dist/services/onboarding/inject/inject-service.js +72 -0
  31. package/dist/services/onboarding/inject/injected-installation.d.ts +29 -0
  32. package/dist/services/onboarding/inject/injected-installation.js +37 -0
  33. package/dist/services/onboarding/onboarding-service-build-context.d.ts +15 -1
  34. package/dist/services/onboarding/onboarding-service-build-context.js +31 -2
  35. package/dist/services/onboarding/onboarding-service-factory.d.ts +23 -5
  36. package/dist/services/onboarding/onboarding-service-factory.js +86 -6
  37. package/dist/services/onboarding/spec/inject/content-security-policy.spec.d.ts +1 -0
  38. package/dist/services/onboarding/spec/inject/content-security-policy.spec.js +47 -0
  39. package/dist/services/onboarding/spec/inject/deployed-installation.spec.d.ts +1 -0
  40. package/dist/services/onboarding/spec/inject/deployed-installation.spec.js +49 -0
  41. package/dist/services/onboarding/spec/inject/foreign-install-request.spec.d.ts +1 -0
  42. package/dist/services/onboarding/spec/inject/foreign-install-request.spec.js +47 -0
  43. package/dist/services/onboarding/spec/inject/inject-document-rewrite.spec.d.ts +1 -0
  44. package/dist/services/onboarding/spec/inject/inject-document-rewrite.spec.js +66 -0
  45. package/dist/services/onboarding/spec/inject/injected-installation.spec.d.ts +1 -0
  46. package/dist/services/onboarding/spec/inject/injected-installation.spec.js +24 -0
  47. package/dist/services/onboarding/spec/onboarding-service-build-context.spec.d.ts +1 -0
  48. package/dist/services/onboarding/spec/onboarding-service-build-context.spec.js +22 -0
  49. package/dist/services/onboarding/spec/onboarding-service-factory.spec.js +53 -2
  50. package/dist/services/onboarding/templates/install-speed-kit-html-template.js +3 -0
  51. package/oclif.manifest.json +26 -3
  52. package/package.json +1 -1
@@ -0,0 +1,49 @@
1
+ import { expect } from "chai";
2
+ import { describe, it } from "mocha";
3
+ import { InjectInstallationError } from "../../error/inject-installation-error.js";
4
+ import { parseInstallResource, readDeployedInstallation, } from "../../inject/deployed-installation.js";
5
+ const ORIGIN = "https://www.example.com";
6
+ const INSTALL = "https://example.app.baqend.com/v1/speedkit/install.js";
7
+ function answer(status, body = "") {
8
+ return async () => new Response(status === 204 ? null : body, { status });
9
+ }
10
+ describe("parseInstallResource", () => {
11
+ it("reads the service worker path without its query", () => {
12
+ expect(parseInstallResource(`var speedKit={appName:"example",sw:"/apps/speed-kit/sw.js?r=abc&v=2.22.5",split:0};`, ORIGIN)).to.deep.equal({ swPath: "/apps/speed-kit/sw.js", scope: "/" });
13
+ });
14
+ it("reads the scope that the installation names", () => {
15
+ expect(parseInstallResource(`{sw:"/de/sw.js",scope:"/de/"}`, ORIGIN)).to.deep.equal({ swPath: "/de/sw.js", scope: "/de/" });
16
+ });
17
+ it("finds nothing in a resource without a service worker", () => {
18
+ expect(parseInstallResource("/* empty */", ORIGIN)).to.equal(undefined);
19
+ });
20
+ });
21
+ describe("readDeployedInstallation", () => {
22
+ it("fetches the install resource as a page of the origin", async () => {
23
+ const requests = [];
24
+ const fetchResource = (async (url, init) => {
25
+ requests.push({
26
+ url,
27
+ origin: init.headers.origin,
28
+ });
29
+ return new Response(`{sw:"/wrapper-sw.js?r=abc"}`);
30
+ });
31
+ const installation = await readDeployedInstallation(`${INSTALL}?r=abc`, ORIGIN, fetchResource);
32
+ expect(installation).to.deep.equal({
33
+ swPath: "/wrapper-sw.js",
34
+ scope: "/",
35
+ });
36
+ expect(requests).to.deep.equal([
37
+ { url: `${INSTALL}?r=abc`, origin: ORIGIN },
38
+ ]);
39
+ });
40
+ it("fails when the origin has no live installation", async () => {
41
+ const error = await readDeployedInstallation(INSTALL, ORIGIN, answer(204)).catch((error_) => error_);
42
+ expect(error).to.be.instanceOf(InjectInstallationError);
43
+ expect(error.message).to.contain("204");
44
+ });
45
+ it("fails when the install resource names no service worker", async () => {
46
+ const error = await readDeployedInstallation(INSTALL, ORIGIN, answer(200, "/* empty */")).catch((error_) => error_);
47
+ expect(error).to.be.instanceOf(InjectInstallationError);
48
+ });
49
+ });
@@ -0,0 +1,47 @@
1
+ import { expect } from "chai";
2
+ import { describe, it } from "mocha";
3
+ import { AbortResponse } from "../../browser/abort-response.js";
4
+ import { ForeignInstallRequest } from "../../inject/foreign-install-request.js";
5
+ const APP = "example.app.baqend.com";
6
+ function handler(testingId) {
7
+ const warnings = [];
8
+ const cli = {
9
+ writeWarning: (message) => warnings.push(message),
10
+ };
11
+ return { warnings, handler: new ForeignInstallRequest(APP, cli, testingId) };
12
+ }
13
+ function request(url) {
14
+ return { request: { url } };
15
+ }
16
+ describe("ForeignInstallRequest", () => {
17
+ it("has a pattern that the dispatcher matches against an install resource", () => {
18
+ const [{ urlPattern }] = handler().handler.patterns;
19
+ const expression = new RegExp(urlPattern);
20
+ expect(expression.test("https://other.app.baqend.com/v1/speedkit/install.js")).to.equal(true);
21
+ expect(expression.test("https://www.example.com/app.js")).to.equal(false);
22
+ });
23
+ it("lets the install resource of the injected app through", async () => {
24
+ const { handler: foreign, warnings } = handler();
25
+ const response = await foreign.handle(request(`https://${APP}/v1/speedkit/install.js?d=production`));
26
+ expect(response).to.equal(null);
27
+ expect(warnings).to.deep.equal([]);
28
+ });
29
+ it("blocks the install resource of another app, and says so once", async () => {
30
+ const { handler: foreign, warnings } = handler();
31
+ const url = "https://other.app.baqend.com/v1/speedkit/install.js";
32
+ const response = await foreign.handle(request(url));
33
+ await foreign.handle(request(url));
34
+ expect(response).to.be.instanceOf(AbortResponse);
35
+ expect(response.errorReason).to.equal("BlockedByClient");
36
+ expect(warnings).to.have.length(1);
37
+ expect(warnings[0]).to.contain(url);
38
+ });
39
+ it("blocks the live installation of the app while a testing installation is injected", async () => {
40
+ const { handler: foreign } = handler("abc-123");
41
+ expect(await foreign.handle(request(`https://${APP}/v1/speedkit/install.js`))).to.be.instanceOf(AbortResponse);
42
+ });
43
+ it("lets the testing installation through, also when the worker added the id again", async () => {
44
+ const { handler: foreign } = handler("abc-123");
45
+ expect(await foreign.handle(request(`https://${APP}/v1/speedkit/install.js?r=abc-123&r=abc-123`))).to.equal(null);
46
+ });
47
+ });
@@ -0,0 +1,66 @@
1
+ import { expect } from "chai";
2
+ import { describe, it } from "mocha";
3
+ import { InjectDocumentRewrite } from "../../inject/inject-document-rewrite.js";
4
+ import { InjectedInstallation } from "../../inject/injected-installation.js";
5
+ const APP = "https://example.app.baqend.com";
6
+ const INSTALL = `${APP}/v1/speedkit/install.js`;
7
+ function rewrite(removeContentSecurityPolicy = false, testingId) {
8
+ const warnings = [];
9
+ const cli = {
10
+ writeWarning: (message) => warnings.push(message),
11
+ };
12
+ const installation = new InjectedInstallation({ installPath: INSTALL, installParams: 'crossorigin="anonymous"' }, testingId);
13
+ return {
14
+ warnings,
15
+ rewrite: new InjectDocumentRewrite(installation, APP, removeContentSecurityPolicy, cli),
16
+ };
17
+ }
18
+ describe("InjectDocumentRewrite", () => {
19
+ it("injects the install script into a document without Speed Kit", () => {
20
+ const html = rewrite().rewrite.html("<html><head></head></html>");
21
+ expect(html).to.contain(`src="${INSTALL}" crossorigin="anonymous"`);
22
+ });
23
+ it("replaces the live install script with the testing installation", () => {
24
+ const html = rewrite(false, "abc-123").rewrite.html(`<html><head><script src="${INSTALL}" async></script></head></html>`);
25
+ expect(html.match(/install\.js/g)).to.have.length(1);
26
+ expect(html).to.contain(`src="${INSTALL}?r=abc-123"`);
27
+ });
28
+ it("reuses the nonce of the origin for the install script", () => {
29
+ const html = rewrite().rewrite.html(`<html><head><script nonce="n0nce">1</script></head></html>`);
30
+ expect(html).to.contain(`<script nonce="n0nce" src="${INSTALL}"`);
31
+ });
32
+ it("amends the policy header and prints the change once", () => {
33
+ const { rewrite: documentRewrite, warnings } = rewrite();
34
+ const headers = [
35
+ { name: "Content-Security-Policy", value: "script-src 'self'" },
36
+ {
37
+ name: "Content-Security-Policy-Report-Only",
38
+ value: "script-src 'self'",
39
+ },
40
+ ];
41
+ const first = documentRewrite.headers(headers);
42
+ documentRewrite.headers(headers);
43
+ expect(first).to.deep.equal([
44
+ { name: "Content-Security-Policy", value: `script-src 'self' ${APP}` },
45
+ {
46
+ name: "Content-Security-Policy-Report-Only",
47
+ value: "script-src 'self'",
48
+ },
49
+ ]);
50
+ expect(warnings).to.have.length(1);
51
+ expect(warnings[0]).to.contain("script-src");
52
+ });
53
+ it("removes every policy with -s", () => {
54
+ const { rewrite: documentRewrite, warnings } = rewrite(true);
55
+ const headers = documentRewrite.headers([
56
+ { name: "content-security-policy", value: "script-src 'self'" },
57
+ { name: "content-type", value: "text/html" },
58
+ ]);
59
+ const html = documentRewrite.html(`<html><head><meta http-equiv="Content-Security-Policy" content="script-src 'self'"></head></html>`);
60
+ expect(headers).to.deep.equal([
61
+ { name: "content-type", value: "text/html" },
62
+ ]);
63
+ expect(html).not.to.contain("Content-Security-Policy");
64
+ expect(warnings).to.deep.equal([]);
65
+ });
66
+ });
@@ -0,0 +1,24 @@
1
+ import { expect } from "chai";
2
+ import { describe, it } from "mocha";
3
+ import { InjectedInstallation } from "../../inject/injected-installation.js";
4
+ const RESOURCE = {
5
+ installPath: "https://example.app.baqend.com/v1/speedkit/install.js",
6
+ installParams: 'async="" crossorigin="anonymous"',
7
+ };
8
+ describe("InjectedInstallation", () => {
9
+ it("injects the latest deployed installation without a testing id", () => {
10
+ const installation = new InjectedInstallation(RESOURCE);
11
+ expect(installation.installPath).to.equal(RESOURCE.installPath);
12
+ expect(installation.installParams).to.equal(RESOURCE.installParams);
13
+ expect(installation.installPage("/")).to.equal("/speed-kit-install.html?url=%2F&enableSpeedKit=1");
14
+ });
15
+ it("names the testing installation in the install resource and on the install page", () => {
16
+ const installation = new InjectedInstallation(RESOURCE, "abc-123");
17
+ expect(installation.installPath).to.equal(`${RESOURCE.installPath}?r=abc-123`);
18
+ expect(installation.installPage("/de/")).to.equal("/de/speed-kit-install.html?url=%2Fde%2F&enableSpeedKit=1&debugSpeedKit=abc-123");
19
+ });
20
+ it("appends to an install path that has a query", () => {
21
+ const installation = new InjectedInstallation({ ...RESOURCE, installPath: "/sk/install.js?v=2" }, "abc-123");
22
+ expect(installation.installPath).to.equal("/sk/install.js?v=2&r=abc-123");
23
+ });
24
+ });
@@ -0,0 +1,22 @@
1
+ import { expect } from "chai";
2
+ import { describe, it } from "mocha";
3
+ import { withInjectDefault } from "../onboarding-service-build-context.js";
4
+ describe("withInjectDefault", () => {
5
+ it("gives --inject at the end the latest installation", () => {
6
+ expect(withInjectDefault(["customers/shop", "--inject"])).to.deep.equal([
7
+ "customers/shop",
8
+ "--inject=latest",
9
+ ]);
10
+ });
11
+ it("gives --inject before another flag the latest installation", () => {
12
+ expect(withInjectDefault(["customers/shop", "--inject", "--headless"])).to.deep.equal(["customers/shop", "--inject=latest", "--headless"]);
13
+ });
14
+ it("keeps the id that follows --inject", () => {
15
+ const argv = ["customers/shop", "--inject", "abc-123", "-p"];
16
+ expect(withInjectDefault(argv)).to.deep.equal(argv);
17
+ });
18
+ it("keeps --inject=<id>", () => {
19
+ const argv = ["customers/shop", "--inject=abc-123"];
20
+ expect(withInjectDefault(argv)).to.deep.equal(argv);
21
+ });
22
+ });
@@ -5,6 +5,8 @@ import { tmpdir } from "node:os";
5
5
  import { join } from "node:path";
6
6
  import { BrowseService } from "../browse/browse-service.js";
7
7
  import { BrowseDomainError } from "../error/browse-domain-error.js";
8
+ import { InjectTargetError } from "../error/inject-target-error.js";
9
+ import { InjectService } from "../inject/inject-service.js";
8
10
  import { MissingCustomerPathError } from "../error/missing-customer-path-error.js";
9
11
  import { BrowserContext } from "../onboarding-model.js";
10
12
  import { OnboardingServiceBuildContext, } from "../onboarding-service-build-context.js";
@@ -40,12 +42,18 @@ function buildContext(values = {}) {
40
42
  debugPort: 9290,
41
43
  browserFetch: false,
42
44
  browse: false,
45
+ inject: false,
43
46
  ...values,
44
47
  });
45
48
  }
46
49
  /** Records what browse mode would launch, instead of resolving extensions and Chrome. */
47
50
  class RecordingFactory extends OnboardingServiceFactory {
48
51
  launched;
52
+ installationRead;
53
+ async readDeployedInstallation(installPath, origin) {
54
+ this.installationRead = { installPath, origin };
55
+ return { swPath: "/deployed-sw.js", scope: "/" };
56
+ }
49
57
  async prepareBrowser(domain, customerChromeFlags) {
50
58
  this.launched = { domain, customerChromeFlags };
51
59
  return {
@@ -60,7 +68,7 @@ class RecordingFactory extends OnboardingServiceFactory {
60
68
  }
61
69
  describe("OnboardingServiceFactory", () => {
62
70
  describe("CUSTOMERPATH", () => {
63
- it("is required without --browse", async () => {
71
+ it("is required without --browse and without --inject", async () => {
64
72
  const factory = new OnboardingServiceFactory(buildContext());
65
73
  const error = await factory.getService().catch((error_) => error_);
66
74
  expect(error).to.be.instanceOf(MissingCustomerPathError);
@@ -81,7 +89,7 @@ describe("OnboardingServiceFactory", () => {
81
89
  expect(factory.launched).to.equal(undefined);
82
90
  });
83
91
  });
84
- describe("browse mode with a CUSTOMERPATH", () => {
92
+ describe("a mode that reads only config_customer.json", () => {
85
93
  let customerPath;
86
94
  before(() => {
87
95
  customerPath = mkdtempSync(join(tmpdir(), "sk-browse-"));
@@ -114,6 +122,49 @@ describe("OnboardingServiceFactory", () => {
114
122
  await factory.getService();
115
123
  expect(factory.launched?.domain).to.equal("https://shop.example.com/");
116
124
  });
125
+ it("builds the inject service under --inject, without any other config file", async () => {
126
+ const factory = new RecordingFactory(buildContext({ inject: true, testing: "abc-123", customerPath }));
127
+ const service = await factory.getService();
128
+ expect(service).to.be.instanceOf(InjectService);
129
+ expect(factory.launched).to.deep.equal({
130
+ domain: "https://www.example.com/",
131
+ customerChromeFlags: ["--lang=fr"],
132
+ });
133
+ expect(factory.installationRead).to.deep.equal({
134
+ installPath: "https://example-shop.app.baqend.com/v1/speedkit/install.js?d=production&r=abc-123",
135
+ origin: "https://www.example.com",
136
+ });
137
+ });
138
+ });
139
+ describe("inject mode without a CUSTOMERPATH", () => {
140
+ it("takes the app and the domain from the flags", async () => {
141
+ const factory = new RecordingFactory(buildContext({
142
+ inject: true,
143
+ app: "example-shop",
144
+ domain: "www.example.com",
145
+ }));
146
+ const service = await factory.getService();
147
+ expect(service).to.be.instanceOf(InjectService);
148
+ expect(factory.launched).to.deep.equal({
149
+ domain: "https://www.example.com/",
150
+ customerChromeFlags: undefined,
151
+ });
152
+ expect(factory.installationRead).to.deep.equal({
153
+ installPath: "https://example-shop.app.baqend.com/v1/speedkit/install.js",
154
+ origin: "https://www.example.com",
155
+ });
156
+ });
157
+ for (const [missing, values] of [
158
+ ["app", { domain: "www.example.com" }],
159
+ ["domain", { app: "example-shop" }],
160
+ ]) {
161
+ it(`fails without ${missing === "app" ? "an app" : "a domain"}`, async () => {
162
+ const factory = new RecordingFactory(buildContext({ inject: true, ...values }));
163
+ const error = await factory.getService().catch((error_) => error_);
164
+ expect(error).to.be.instanceOf(InjectTargetError);
165
+ expect(factory.launched).to.equal(undefined);
166
+ });
167
+ }
117
168
  });
118
169
  describe("buildBrowserContext", () => {
119
170
  const inputs = {
@@ -192,6 +192,9 @@ aside.loader:not(.stop)::after {
192
192
  step1.classList.add('error')
193
193
  showError(new Error('unable to load script: {{{installPath}}}' ))
194
194
  })
195
+ {{#if crossOrigin}}
196
+ installScript.crossOrigin = 'anonymous';
197
+ {{/if}}
195
198
  installScript.setAttribute('src','{{{installPath}}}')
196
199
  document.querySelector('head').appendChild(installScript)
197
200
 
@@ -647,7 +647,7 @@
647
647
  "aliases": [],
648
648
  "args": {
649
649
  "customerPath": {
650
- "description": "The customer config path (optional with --browse)",
650
+ "description": "The customer config path (optional with --browse and --inject)",
651
651
  "name": "customerPath",
652
652
  "required": false
653
653
  }
@@ -657,7 +657,9 @@
657
657
  "$ sk onboarding <customerPath> -c <configName> -d <domain>",
658
658
  "$ sk onboarding customers/decathlon.de -c production -d www.decathlon.de",
659
659
  "$ sk onboarding --browse -d www.decathlon.de --headless --debugPort 9290",
660
- "$ sk onboarding customers/decathlon.de --browse -p"
660
+ "$ sk onboarding customers/decathlon.de --browse -p",
661
+ "$ sk onboarding customers/decathlon.de --inject",
662
+ "$ sk onboarding customers/decathlon.de --inject <installationId>"
661
663
  ],
662
664
  "flags": {
663
665
  "configName": {
@@ -737,6 +739,27 @@
737
739
  "allowNo": false,
738
740
  "type": "boolean"
739
741
  },
742
+ "inject": {
743
+ "description": "Inject a deployed Speed Kit installation into the site, for a customer that has not installed Speed Kit. Without a value it uses the latest deployed installation. With an id it uses that testing installation. Needs no local config: without a CUSTOMERPATH, pass --app and -d.",
744
+ "exclusive": [
745
+ "browse"
746
+ ],
747
+ "name": "inject",
748
+ "hasDynamicHelp": false,
749
+ "helpValue": "[<installationId>]",
750
+ "multiple": false,
751
+ "type": "option"
752
+ },
753
+ "app": {
754
+ "dependsOn": [
755
+ "inject"
756
+ ],
757
+ "description": "The app of the installation that --inject uses. Wins over the app of the customer config.",
758
+ "name": "app",
759
+ "hasDynamicHelp": false,
760
+ "multiple": false,
761
+ "type": "option"
762
+ },
740
763
  "browserFetch": {
741
764
  "description": "Fetch every origin document with a second headless Chrome instead of a direct request. Only needed when bot protection refuses the CLI outright — a refusal is otherwise detected and rerouted on its own.",
742
765
  "name": "browserFetch",
@@ -1765,5 +1788,5 @@
1765
1788
  ]
1766
1789
  }
1767
1790
  },
1768
- "version": "4.43.0-beta.1"
1791
+ "version": "4.44.0-beta.1"
1769
1792
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@speedkit/cli",
3
3
  "description": "Speed Kit CLI",
4
- "version": "4.43.0-beta.1",
4
+ "version": "4.44.0-beta.1",
5
5
  "author": {
6
6
  "name": "Baqend.com",
7
7
  "email": "info@baqend.com"