@speedkit/cli 4.36.1 → 4.36.2
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.
- package/CHANGELOG.md +7 -0
- package/dist/base/sk-command.d.ts +41 -0
- package/dist/base/sk-command.js +56 -0
- package/dist/commands/auto-prewarm.d.ts +6 -4
- package/dist/commands/auto-prewarm.js +13 -66
- package/dist/commands/autocomplete/fish.d.ts +2 -2
- package/dist/commands/autocomplete/fish.js +3 -2
- package/dist/commands/browser/clean.d.ts +2 -2
- package/dist/commands/browser/clean.js +6 -6
- package/dist/commands/browser/list.d.ts +2 -2
- package/dist/commands/browser/list.js +6 -7
- package/dist/commands/browser/update.d.ts +2 -2
- package/dist/commands/browser/update.js +9 -11
- package/dist/commands/bulk-deploy.d.ts +4 -2
- package/dist/commands/bulk-deploy.js +7 -37
- package/dist/commands/config/edit.d.ts +2 -2
- package/dist/commands/config/edit.js +2 -2
- package/dist/commands/config/setup.d.ts +5 -2
- package/dist/commands/config/setup.js +9 -19
- package/dist/commands/deploy.d.ts +12 -3
- package/dist/commands/deploy.js +14 -20
- package/dist/commands/diff-url-parameters.d.ts +3 -2
- package/dist/commands/diff-url-parameters.js +19 -16
- package/dist/commands/extension/add.d.ts +2 -2
- package/dist/commands/extension/add.js +6 -6
- package/dist/commands/extension/devtools.d.ts +2 -2
- package/dist/commands/extension/devtools.js +6 -7
- package/dist/commands/extension/list.d.ts +2 -2
- package/dist/commands/extension/list.js +5 -6
- package/dist/commands/extension/remove.d.ts +2 -2
- package/dist/commands/extension/remove.js +6 -6
- package/dist/commands/extension/update.d.ts +2 -2
- package/dist/commands/extension/update.js +5 -6
- package/dist/commands/find-pops.d.ts +2 -2
- package/dist/commands/find-pops.js +10 -11
- package/dist/commands/generate-customer-config.d.ts +5 -2
- package/dist/commands/generate-customer-config.js +9 -27
- package/dist/commands/generate-pop-config.d.ts +2 -2
- package/dist/commands/generate-pop-config.js +19 -15
- package/dist/commands/login.d.ts +2 -2
- package/dist/commands/login.js +6 -9
- package/dist/commands/onboarding.d.ts +18 -3
- package/dist/commands/onboarding.js +13 -11
- package/dist/commands/origin-request.d.ts +4 -2
- package/dist/commands/origin-request.js +10 -42
- package/dist/commands/prewarm.d.ts +4 -2
- package/dist/commands/prewarm.js +12 -56
- package/dist/commands/pull.d.ts +4 -2
- package/dist/commands/pull.js +9 -14
- package/dist/commands/query/parameter.d.ts +4 -2
- package/dist/commands/query/parameter.js +12 -19
- package/dist/commands/query/prewarm.d.ts +4 -2
- package/dist/commands/query/prewarm.js +16 -23
- package/dist/commands/revalidate.d.ts +4 -2
- package/dist/commands/revalidate.js +13 -56
- package/dist/commands/wpt-launcher.d.ts +2 -2
- package/dist/commands/wpt-launcher.js +16 -17
- package/dist/hooks/init/first-run.js +9 -10
- package/dist/models/context.d.ts +24 -0
- package/dist/models/context.js +31 -0
- package/dist/services/athena/athena-flags.d.ts +18 -0
- package/dist/services/athena/athena-flags.js +29 -0
- package/dist/services/athena/athena-service-build-context.d.ts +25 -0
- package/dist/services/athena/athena-service-build-context.js +4 -0
- package/dist/services/athena/athena-service-factory.d.ts +3 -16
- package/dist/services/athena/athena-service-factory.js +11 -27
- package/dist/services/athena/baqend-athena-service.d.ts +3 -14
- package/dist/services/athena/baqend-athena-service.js +8 -16
- package/dist/services/athena/index.d.ts +1 -0
- package/dist/services/athena/index.js +1 -0
- package/dist/services/athena/spec/baqend-athena-service.spec.js +2 -2
- package/dist/services/browser-fetch/browser-origin-fetch.d.ts +2 -2
- package/dist/services/browser-fetch/browser-origin-fetch.js +1 -1
- package/dist/services/browser-fetch/browser-origin-fetcher.d.ts +3 -3
- package/dist/services/browser-fetch/browser-origin-fetcher.js +5 -5
- package/dist/services/browser-fetch/spec/browser-origin-fetch.spec.js +10 -10
- package/dist/services/cli/cli-environment-factory.d.ts +25 -0
- package/dist/services/cli/cli-environment-factory.js +30 -0
- package/dist/services/cli/cli-environment.d.ts +73 -0
- package/dist/services/cli/cli-environment.js +216 -0
- package/dist/services/cli/cli-service-build-context.d.ts +10 -0
- package/dist/services/cli/cli-service-build-context.js +4 -0
- package/dist/services/cli/cli-service-factory.d.ts +7 -7
- package/dist/services/cli/cli-service-factory.js +7 -7
- package/dist/services/cli/cli-service-model.d.ts +0 -4
- package/dist/services/cli/cli-service-model.js +0 -6
- package/dist/services/cli/cli-service.d.ts +16 -2
- package/dist/services/cli/cli-service.js +17 -18
- package/dist/services/cli/cli-settings.d.ts +37 -0
- package/dist/services/cli/cli-settings.js +23 -0
- package/dist/services/cli/command-build-context.d.ts +23 -0
- package/dist/services/cli/index.d.ts +5 -1
- package/dist/services/cli/index.js +5 -1
- package/dist/services/cli/spec/cli-environment-detection.spec.js +52 -0
- package/dist/services/cli/spec/cli-environment.spec.js +125 -0
- package/dist/services/cli/spec/cli-service.spec.js +9 -19
- package/dist/services/config-api/client.d.ts +3 -3
- package/dist/services/config-api/client.js +4 -4
- package/dist/services/config-api/config-api-factory.js +3 -3
- package/dist/services/config-api/entity-manager-provider.d.ts +11 -0
- package/dist/services/config-api/{entity-manager-factory.js → entity-manager-provider.js} +7 -1
- package/dist/services/customer-config/customer-config-service-build-context.d.ts +33 -0
- package/dist/services/customer-config/customer-config-service-build-context.js +36 -0
- package/dist/services/customer-config/customer-config-service-factory.d.ts +3 -4
- package/dist/services/customer-config/customer-config-service-factory.js +5 -8
- package/dist/services/customer-config/customer-config-service.d.ts +2 -2
- package/dist/services/customer-config/index.d.ts +1 -1
- package/dist/services/customer-config/index.js +1 -1
- package/dist/services/customer-config/site-analyzer/index.d.ts +1 -0
- package/dist/services/customer-config/site-analyzer/index.js +1 -0
- package/dist/services/customer-config/site-analyzer/site-analyzer-service-build-context.d.ts +6 -0
- package/dist/services/customer-config/site-analyzer/site-analyzer-service-build-context.js +4 -0
- package/dist/services/customer-config/site-analyzer/site-analyzer-service-factory.d.ts +3 -3
- package/dist/services/customer-config/site-analyzer/site-analyzer-service-factory.js +4 -5
- package/dist/services/deploy/bulk/bulk-deploy-model.d.ts +0 -25
- package/dist/services/deploy/bulk/bulk-deploy-model.js +1 -27
- package/dist/services/deploy/bulk/bulk-deploy-service-build-context.d.ts +51 -0
- package/dist/services/deploy/bulk/bulk-deploy-service-build-context.js +50 -0
- package/dist/services/deploy/bulk/bulk-deploy-service-factory.d.ts +2 -4
- package/dist/services/deploy/bulk/bulk-deploy-service-factory.js +2 -5
- package/dist/services/deploy/bulk/bulk-deploy-service.d.ts +3 -2
- package/dist/services/deploy/bulk/config-deploy-factory.d.ts +3 -3
- package/dist/services/deploy/bulk/config-deploy-factory.js +16 -8
- package/dist/services/deploy/bulk/index.d.ts +1 -0
- package/dist/services/deploy/bulk/index.js +1 -0
- package/dist/services/deploy/checks/activation/customer-approval-check.d.ts +3 -1
- package/dist/services/deploy/checks/activation/customer-approval-check.js +4 -2
- package/dist/services/deploy/checks/pre-deploy/device-detection-changed-check.d.ts +3 -1
- package/dist/services/deploy/checks/pre-deploy/device-detection-changed-check.js +4 -2
- package/dist/services/deploy/checks/pre-deploy/split-change-check.d.ts +3 -1
- package/dist/services/deploy/checks/pre-deploy/split-change-check.js +4 -2
- package/dist/services/deploy/deploy-service-build-context.d.ts +63 -0
- package/dist/services/deploy/deploy-service-build-context.js +64 -0
- package/dist/services/deploy/deploy-service-factory.d.ts +5 -8
- package/dist/services/deploy/deploy-service-factory.js +28 -19
- package/dist/services/deploy/mr/base-config-reader.d.ts +6 -4
- package/dist/services/deploy/mr/base-config-reader.js +6 -8
- package/dist/services/deploy/mr/index.d.ts +1 -0
- package/dist/services/deploy/mr/index.js +1 -0
- package/dist/services/deploy/mr/merge-request-deploy-model.d.ts +0 -35
- package/dist/services/deploy/mr/merge-request-deploy-model.js +0 -34
- package/dist/services/deploy/mr/merge-request-deploy-service-build-context.d.ts +32 -0
- package/dist/services/deploy/mr/merge-request-deploy-service-build-context.js +20 -0
- package/dist/services/deploy/mr/merge-request-deploy-service-factory.d.ts +2 -4
- package/dist/services/deploy/mr/merge-request-deploy-service-factory.js +31 -10
- package/dist/services/deploy/mr/merge-request-deploy-service.d.ts +3 -2
- package/dist/services/deploy/spec/bulk/bulk-deploy-service.spec.js +14 -3
- package/dist/services/deploy/spec/checks/activation/customer-approval-check.spec.js +7 -5
- package/dist/services/deploy/spec/checks/pre-deploy/split-change-check.spec.js +2 -1
- package/dist/services/diff/diff-service-build-context.d.ts +14 -0
- package/dist/services/diff/diff-service-build-context.js +4 -0
- package/dist/services/diff/diff-service-factory.d.ts +4 -5
- package/dist/services/diff/diff-service-factory.js +4 -7
- package/dist/services/diff/index.d.ts +1 -1
- package/dist/services/diff/index.js +1 -1
- package/dist/services/document-handler-runtime/{context/document-handler-runtime-context.d.ts → document-handler-runtime-model.d.ts} +0 -5
- package/dist/services/document-handler-runtime/document-handler-runtime-service-build-context.d.ts +11 -0
- package/dist/services/document-handler-runtime/document-handler-runtime-service-build-context.js +4 -0
- package/dist/services/document-handler-runtime/document-handler-server.js +2 -2
- package/dist/services/document-handler-runtime/factory/document-handler-runtime-service-factory.d.ts +3 -6
- package/dist/services/document-handler-runtime/factory/document-handler-runtime-service-factory.js +14 -14
- package/dist/services/document-handler-runtime/server/request.js +1 -1
- package/dist/services/document-handler-runtime/templates/database-mock.d.ts +1 -1
- package/dist/services/document-handler-runtime/templates/database-mock.js +1 -1
- package/dist/services/integration-api/customer-config-flags.d.ts +16 -0
- package/dist/services/integration-api/customer-config-flags.js +30 -0
- package/dist/services/integration-api/handler/install-resource-handler.d.ts +8 -0
- package/dist/services/integration-api/handler/install-resource-handler.js +10 -1
- package/dist/services/integration-api/index.d.ts +1 -0
- package/dist/services/integration-api/index.js +1 -0
- package/dist/services/integration-api/integration-api-factory.d.ts +4 -6
- package/dist/services/integration-api/integration-api-factory.js +11 -11
- package/dist/services/integration-api/integration-api-model.d.ts +0 -9
- package/dist/services/integration-api/integration-api-model.js +0 -16
- package/dist/services/integration-api/integration-api-service-build-context.d.ts +19 -0
- package/dist/services/integration-api/integration-api-service-build-context.js +4 -0
- package/dist/services/integration-api/spec/config-plugin.spec.js +1 -1
- package/dist/services/integration-api/spec/integration-api-service.spec.js +7 -3
- package/dist/services/integration-api/spec/speed-kit-config-file.spec.js +9 -2
- package/dist/services/integration-api/struct/config-plugin.d.ts +1 -1
- package/dist/services/integration-api/struct/config-plugin.js +12 -7
- package/dist/services/integration-api/struct/speed-kit-config-file.d.ts +18 -2
- package/dist/services/integration-api/struct/speed-kit-config-file.js +22 -12
- package/dist/services/integration-api/struct/speed-kit-config.d.ts +1 -1
- package/dist/services/onboarding/browser/config/browser-config.d.ts +3 -3
- package/dist/services/onboarding/browser/config/browser-config.js +5 -5
- package/dist/services/onboarding/browser/executable/executable-validator.d.ts +3 -3
- package/dist/services/onboarding/browser/executable/executable-validator.js +17 -15
- package/dist/services/onboarding/browser/extension/extension-downloader.d.ts +3 -3
- package/dist/services/onboarding/browser/extension/extension-downloader.js +6 -6
- package/dist/services/onboarding/browser/extension/extension-validator.d.ts +3 -3
- package/dist/services/onboarding/browser/extension/extension-validator.js +4 -4
- package/dist/services/onboarding/file-events/file-watcher.js +1 -0
- package/dist/services/onboarding/index.d.ts +1 -1
- package/dist/services/onboarding/index.js +1 -1
- package/dist/services/onboarding/onboarding-model.d.ts +8 -24
- package/dist/services/onboarding/onboarding-model.js +19 -87
- package/dist/services/onboarding/onboarding-service-build-context.d.ts +57 -0
- package/dist/services/onboarding/onboarding-service-build-context.js +67 -0
- package/dist/services/onboarding/onboarding-service-factory.d.ts +2 -5
- package/dist/services/onboarding/onboarding-service-factory.js +47 -34
- package/dist/services/onboarding/spec/onboarding-model.spec.js +11 -6
- package/dist/services/origin-request/index.d.ts +1 -1
- package/dist/services/origin-request/index.js +1 -1
- package/dist/services/origin-request/origin-request-service-build-context.d.ts +52 -0
- package/dist/services/origin-request/origin-request-service-build-context.js +54 -0
- package/dist/services/origin-request/origin-request-service-factory.d.ts +2 -5
- package/dist/services/origin-request/origin-request-service-factory.js +12 -12
- package/dist/services/origin-request/origin-request-service.d.ts +2 -2
- package/dist/services/pop-config/index.d.ts +1 -0
- package/dist/services/pop-config/index.js +1 -0
- package/dist/services/pop-config/pop-config-factory.d.ts +4 -1
- package/dist/services/pop-config/pop-config-factory.js +10 -3
- package/dist/services/pop-config/pop-config-service-build-context.d.ts +10 -0
- package/dist/services/pop-config/pop-config-service-build-context.js +4 -0
- package/dist/services/prewarm/auto-pre-warm-factory.d.ts +3 -31
- package/dist/services/prewarm/auto-pre-warm-factory.js +6 -11
- package/dist/services/prewarm/auto-pre-warm-service-build-context.d.ts +84 -0
- package/dist/services/prewarm/auto-pre-warm-service-build-context.js +68 -0
- package/dist/services/prewarm/index.d.ts +2 -0
- package/dist/services/prewarm/index.js +2 -0
- package/dist/services/prewarm/pre-warm-factory.d.ts +4 -5
- package/dist/services/prewarm/pre-warm-factory.js +6 -8
- package/dist/services/prewarm/pre-warm-model.d.ts +0 -10
- package/dist/services/prewarm/pre-warm-model.js +0 -18
- package/dist/services/prewarm/pre-warm-service-build-context.d.ts +47 -0
- package/dist/services/prewarm/pre-warm-service-build-context.js +64 -0
- package/dist/services/pull/index.d.ts +1 -0
- package/dist/services/pull/index.js +1 -0
- package/dist/services/pull/pull-service-build-context.d.ts +28 -0
- package/dist/services/pull/pull-service-build-context.js +17 -0
- package/dist/services/pull/pull-service-factory.d.ts +3 -5
- package/dist/services/pull/pull-service-factory.js +13 -14
- package/dist/services/pull/pull-service-model.d.ts +0 -5
- package/dist/services/pull/pull-service-model.js +0 -9
- package/dist/services/query-builder/query-builder-factory.d.ts +9 -7
- package/dist/services/query-builder/query-builder-factory.js +26 -15
- package/dist/{models/cli-parameters.d.ts → services/query-builder/query-builder-flags.d.ts} +1 -120
- package/dist/services/query-builder/query-builder-flags.js +150 -0
- package/dist/services/query-builder/query-builder-model.d.ts +1 -14
- package/dist/services/query-builder/query-builder-service-build-context.d.ts +113 -0
- package/dist/services/query-builder/query-builder-service-build-context.js +68 -0
- package/dist/services/query-builder/query-builder-service.d.ts +3 -3
- package/dist/services/query-builder/spec/query-builder-flags.spec.d.ts +1 -0
- package/dist/{models/spec/cli-parameters.spec.js → services/query-builder/spec/query-builder-flags.spec.js} +1 -1
- package/dist/services/revalidate/index.d.ts +1 -0
- package/dist/services/revalidate/index.js +1 -0
- package/dist/services/revalidate/revalidate-factory.d.ts +3 -5
- package/dist/services/revalidate/revalidate-factory.js +2 -6
- package/dist/services/revalidate/revalidate-model.d.ts +0 -9
- package/dist/services/revalidate/revalidate-model.js +0 -8
- package/dist/services/revalidate/revalidate-service-build-context.d.ts +38 -0
- package/dist/services/revalidate/revalidate-service-build-context.js +59 -0
- package/dist/services/setup/browser/browser-setup-service.d.ts +3 -4
- package/dist/services/setup/browser/browser-setup-service.js +16 -18
- package/dist/services/setup/difftool/difftool-setup-service.d.ts +3 -4
- package/dist/services/setup/difftool/difftool-setup-service.js +5 -7
- package/dist/services/setup/extension/extension-setup-service.d.ts +3 -4
- package/dist/services/setup/extension/extension-setup-service.js +8 -10
- package/dist/services/setup/index.d.ts +1 -1
- package/dist/services/setup/index.js +1 -1
- package/dist/services/setup/setup-service-build-context.d.ts +27 -0
- package/dist/services/setup/setup-service-build-context.js +26 -0
- package/dist/services/setup/setup-service-factory.d.ts +2 -6
- package/dist/services/setup/setup-service-factory.js +10 -18
- package/dist/services/setup/setup-service.d.ts +4 -5
- package/dist/services/setup/setup-service.js +6 -7
- package/oclif.manifest.json +1 -1
- package/package.json +4 -2
- package/dist/models/cli-parameters.js +0 -297
- package/dist/services/cli/cli-config.d.ts +0 -59
- package/dist/services/cli/cli-config.js +0 -180
- package/dist/services/cli/environment.d.ts +0 -15
- package/dist/services/cli/environment.js +0 -40
- package/dist/services/cli/spec/cli-config.spec.js +0 -117
- package/dist/services/cli/spec/environment.spec.js +0 -28
- package/dist/services/config-api/entity-manager-factory.d.ts +0 -5
- package/dist/services/customer-config/customer-config-service-context.d.ts +0 -13
- package/dist/services/customer-config/customer-config-service-context.js +0 -21
- package/dist/services/deploy/context/deploy-context.d.ts +0 -32
- package/dist/services/deploy/context/deploy-context.js +0 -72
- package/dist/services/diff/diff-model.d.ts +0 -9
- package/dist/services/diff/diff-model.js +0 -12
- package/dist/services/origin-request/origin-request-context.d.ts +0 -13
- package/dist/services/origin-request/origin-request-context.js +0 -23
- package/dist/services/query-builder/query-command.d.ts +0 -28
- package/dist/services/query-builder/query-command.js +0 -37
- package/dist/services/setup/setup-context.d.ts +0 -14
- package/dist/services/setup/setup-context.js +0 -15
- /package/dist/{models/spec/cli-parameters.spec.d.ts → services/cli/command-build-context.js} +0 -0
- /package/dist/services/cli/spec/{cli-config.spec.d.ts → cli-environment-detection.spec.d.ts} +0 -0
- /package/dist/services/cli/spec/{environment.spec.d.ts → cli-environment.spec.d.ts} +0 -0
- /package/dist/services/document-handler-runtime/{context/document-handler-runtime-context.js → document-handler-runtime-model.js} +0 -0
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { Interfaces } from "@oclif/core";
|
|
2
|
+
import { CliEnvironment, CommandContextValues } from "../cli/index.js";
|
|
3
|
+
declare const args: {};
|
|
4
|
+
declare const flags: {
|
|
5
|
+
force: Interfaces.BooleanFlag<boolean>;
|
|
6
|
+
postInstall: Interfaces.BooleanFlag<boolean>;
|
|
7
|
+
};
|
|
8
|
+
/** How the first-run wizard runs, as the wizard reads it. */
|
|
9
|
+
export interface SetupOptions {
|
|
10
|
+
/** true when invoked from the npm postinstall hook */
|
|
11
|
+
readonly postInstall?: boolean;
|
|
12
|
+
/** re-run even if setup was already completed */
|
|
13
|
+
readonly force?: boolean;
|
|
14
|
+
}
|
|
15
|
+
export interface SetupServiceBuildContextValues extends CommandContextValues, SetupOptions {
|
|
16
|
+
}
|
|
17
|
+
declare const SetupServiceBuildContext_base: new (values: SetupServiceBuildContextValues) => Readonly<SetupServiceBuildContextValues>;
|
|
18
|
+
/** What the setup wizard and the extension commands are built from. */
|
|
19
|
+
export declare class SetupServiceBuildContext extends SetupServiceBuildContext_base {
|
|
20
|
+
static readonly args: {};
|
|
21
|
+
static readonly flags: {
|
|
22
|
+
force: Interfaces.BooleanFlag<boolean>;
|
|
23
|
+
postInstall: Interfaces.BooleanFlag<boolean>;
|
|
24
|
+
};
|
|
25
|
+
static create(_parsedArgs: Interfaces.InferredArgs<typeof args>, parsedFlags: Interfaces.InferredFlags<typeof flags>, environment: CliEnvironment): SetupServiceBuildContext;
|
|
26
|
+
}
|
|
27
|
+
export {};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { Flags } from "@oclif/core";
|
|
2
|
+
import { Context } from "../../models/context.js";
|
|
3
|
+
const args = {};
|
|
4
|
+
const flags = {
|
|
5
|
+
force: Flags.boolean({
|
|
6
|
+
char: "f",
|
|
7
|
+
description: "Re-run even if setup was already completed",
|
|
8
|
+
}),
|
|
9
|
+
postInstall: Flags.boolean({
|
|
10
|
+
hidden: true,
|
|
11
|
+
description: "Internal flag used by the npm postinstall hook",
|
|
12
|
+
}),
|
|
13
|
+
};
|
|
14
|
+
/** What the setup wizard and the extension commands are built from. */
|
|
15
|
+
export class SetupServiceBuildContext extends Context() {
|
|
16
|
+
static args = args;
|
|
17
|
+
static flags = flags;
|
|
18
|
+
static create(_parsedArgs, parsedFlags, environment) {
|
|
19
|
+
return new SetupServiceBuildContext({
|
|
20
|
+
environment,
|
|
21
|
+
postInstall: parsedFlags.postInstall,
|
|
22
|
+
force: parsedFlags.force,
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
SetupServiceBuildContext;
|
|
@@ -1,12 +1,8 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { CliServiceInterface } from "../cli/index.js";
|
|
3
|
-
import { SetupContext } from "./setup-context.js";
|
|
1
|
+
import { SetupServiceBuildContext } from "./setup-service-build-context.js";
|
|
4
2
|
import { SetupService } from "./setup-service.js";
|
|
5
3
|
export declare class SetupServiceFactory {
|
|
6
|
-
private readonly oclifConfig;
|
|
7
4
|
private readonly context;
|
|
8
|
-
private readonly cli?;
|
|
9
5
|
private service?;
|
|
10
|
-
constructor(
|
|
6
|
+
constructor(context: SetupServiceBuildContext);
|
|
11
7
|
getService(): SetupService;
|
|
12
8
|
}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { CliConfig, CliServiceFactory, } from "../cli/index.js";
|
|
2
1
|
import { normalizePlatform } from "./os/tool-registry.js";
|
|
3
2
|
import { BrowserDetector } from "./browser/browser-detector.js";
|
|
4
3
|
import { BrowserManager } from "./browser/browser-manager.js";
|
|
@@ -7,36 +6,29 @@ import { DiffToolDetector } from "./difftool/difftool-detector.js";
|
|
|
7
6
|
import { DiffToolSetupService } from "./difftool/difftool-setup-service.js";
|
|
8
7
|
import { ExtensionInstaller, resolveChromeMajorVersion, } from "./extension/extension-installer.js";
|
|
9
8
|
import { ExtensionSetupService } from "./extension/extension-setup-service.js";
|
|
10
|
-
import { SetupContext } from "./setup-context.js";
|
|
11
9
|
import { SetupService } from "./setup-service.js";
|
|
12
10
|
export class SetupServiceFactory {
|
|
13
|
-
oclifConfig;
|
|
14
11
|
context;
|
|
15
|
-
cli;
|
|
16
12
|
service;
|
|
17
|
-
constructor(
|
|
18
|
-
this.oclifConfig = oclifConfig;
|
|
13
|
+
constructor(context) {
|
|
19
14
|
this.context = context;
|
|
20
|
-
this.cli = cli;
|
|
21
15
|
}
|
|
22
16
|
getService() {
|
|
23
17
|
if (this.service instanceof SetupService) {
|
|
24
18
|
return this.service;
|
|
25
19
|
}
|
|
26
|
-
const cli = this.cli
|
|
27
|
-
const
|
|
28
|
-
const
|
|
29
|
-
const
|
|
30
|
-
const home = this.oclifConfig.home;
|
|
31
|
-
const cacheDir = userConfig.tempFolder;
|
|
20
|
+
const cli = this.context.environment.cli;
|
|
21
|
+
const platform = normalizePlatform(this.context.environment.oclif.platform);
|
|
22
|
+
const home = this.context.environment.oclif.home;
|
|
23
|
+
const cacheDir = this.context.environment.cacheDir;
|
|
32
24
|
const browserDetector = new BrowserDetector(platform, home, cacheDir);
|
|
33
25
|
const browserManager = new BrowserManager(cacheDir, cli);
|
|
34
|
-
const browserSetup = new BrowserSetupService(cli,
|
|
26
|
+
const browserSetup = new BrowserSetupService(cli, this.context.environment, browserDetector, browserManager);
|
|
35
27
|
const diffDetector = new DiffToolDetector(platform, home);
|
|
36
|
-
const diffSetup = new DiffToolSetupService(cli,
|
|
37
|
-
const extensionInstaller = new ExtensionInstaller(cacheDir, resolveChromeMajorVersion(
|
|
38
|
-
const extensionSetup = new ExtensionSetupService(cli,
|
|
39
|
-
this.service = new SetupService(cli,
|
|
28
|
+
const diffSetup = new DiffToolSetupService(cli, this.context.environment, diffDetector);
|
|
29
|
+
const extensionInstaller = new ExtensionInstaller(cacheDir, resolveChromeMajorVersion(this.context.environment.settings.browserBuildId));
|
|
30
|
+
const extensionSetup = new ExtensionSetupService(cli, this.context.environment, extensionInstaller);
|
|
31
|
+
this.service = new SetupService(cli, this.context.environment, browserSetup, diffSetup, extensionSetup, this.context);
|
|
40
32
|
return this.service;
|
|
41
33
|
}
|
|
42
34
|
}
|
|
@@ -1,17 +1,16 @@
|
|
|
1
1
|
import { BrowserSetupService } from "./browser/browser-setup-service.js";
|
|
2
2
|
import { DiffToolSetupService } from "./difftool/difftool-setup-service.js";
|
|
3
3
|
import { ExtensionSetupService } from "./extension/extension-setup-service.js";
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
4
|
+
import { SetupOptions } from "./setup-service-build-context.js";
|
|
5
|
+
import { CliEnvironment, CliServiceInterface } from "../cli/index.js";
|
|
6
6
|
export declare class SetupService {
|
|
7
7
|
private readonly cli;
|
|
8
|
-
private readonly
|
|
9
|
-
private readonly userConfig;
|
|
8
|
+
private readonly environment;
|
|
10
9
|
private readonly browserSetup;
|
|
11
10
|
private readonly diffSetup;
|
|
12
11
|
private readonly extensionSetup;
|
|
13
12
|
private readonly context;
|
|
14
|
-
constructor(cli: CliServiceInterface,
|
|
13
|
+
constructor(cli: CliServiceInterface, environment: CliEnvironment, browserSetup: BrowserSetupService, diffSetup: DiffToolSetupService, extensionSetup: ExtensionSetupService, context: SetupOptions);
|
|
15
14
|
/**
|
|
16
15
|
* Runs the full first-run wizard (browser + diff tool + extensions) and marks
|
|
17
16
|
* it done.
|
|
@@ -1,15 +1,13 @@
|
|
|
1
1
|
export class SetupService {
|
|
2
2
|
cli;
|
|
3
|
-
|
|
4
|
-
userConfig;
|
|
3
|
+
environment;
|
|
5
4
|
browserSetup;
|
|
6
5
|
diffSetup;
|
|
7
6
|
extensionSetup;
|
|
8
7
|
context;
|
|
9
|
-
constructor(cli,
|
|
8
|
+
constructor(cli, environment, browserSetup, diffSetup, extensionSetup, context) {
|
|
10
9
|
this.cli = cli;
|
|
11
|
-
this.
|
|
12
|
-
this.userConfig = userConfig;
|
|
10
|
+
this.environment = environment;
|
|
13
11
|
this.browserSetup = browserSetup;
|
|
14
12
|
this.diffSetup = diffSetup;
|
|
15
13
|
this.extensionSetup = extensionSetup;
|
|
@@ -29,13 +27,14 @@ export class SetupService {
|
|
|
29
27
|
await this.diffSetup.run();
|
|
30
28
|
this.cli.spacer();
|
|
31
29
|
await this.extensionSetup.run();
|
|
32
|
-
this.
|
|
30
|
+
this.environment.save({ firstRunCompleted: true });
|
|
33
31
|
this.cli.spacer();
|
|
34
32
|
this.cli.writeSuccess("Setup complete. Re-run any time with `sk config setup`.");
|
|
35
33
|
}
|
|
36
34
|
/** True when the first-run wizard has already been completed once. */
|
|
37
35
|
isFirstRunCompleted() {
|
|
38
|
-
return Boolean(this.
|
|
36
|
+
return (Boolean(this.environment.settings.firstRunCompleted) &&
|
|
37
|
+
!this.context.force);
|
|
39
38
|
}
|
|
40
39
|
/** Update-reminder check for the browser, used by the init hook. */
|
|
41
40
|
async remindBrowserUpdate() {
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@speedkit/cli",
|
|
3
3
|
"description": "Speed Kit CLI",
|
|
4
|
-
"version": "4.36.
|
|
4
|
+
"version": "4.36.2",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Baqend.com",
|
|
7
7
|
"email": "info@baqend.com"
|
|
@@ -26,6 +26,7 @@
|
|
|
26
26
|
"postbuild": "oclif manifest && oclif readme",
|
|
27
27
|
"prepack": "npm run build",
|
|
28
28
|
"test": "mocha",
|
|
29
|
+
"lint": "eslint src",
|
|
29
30
|
"coverage": "nyc mocha",
|
|
30
31
|
"coverage:report": "nyc --reporter cobertura mocha",
|
|
31
32
|
"test:golden": "UPDATE_GOLDEN=1 mocha --grep \"golden queries\"",
|
|
@@ -45,7 +46,8 @@
|
|
|
45
46
|
"ts"
|
|
46
47
|
],
|
|
47
48
|
"spec": [
|
|
48
|
-
"src/**/*.spec.ts"
|
|
49
|
+
"src/**/*.spec.ts",
|
|
50
|
+
"eslint-rules/**/*.spec.ts"
|
|
49
51
|
]
|
|
50
52
|
},
|
|
51
53
|
"bin": {
|
|
@@ -1,297 +0,0 @@
|
|
|
1
|
-
import { Args, Flags } from "@oclif/core";
|
|
2
|
-
// Imported from the modules rather than from the query-builder barrels: this
|
|
3
|
-
// file is loaded by every command, and the rules barrel pulls in the automata
|
|
4
|
-
// library.
|
|
5
|
-
import { parseMatchPattern } from "../services/query-builder/rules/match-pattern.js";
|
|
6
|
-
import { DEVICE_VARIATIONS } from "../services/query-builder/queries/device.js";
|
|
7
|
-
import { DEFAULT_ATHENA_CATALOG } from "../services/athena/athena-service-model.js";
|
|
8
|
-
export var CLIParameters;
|
|
9
|
-
(function (CLIParameters) {
|
|
10
|
-
CLIParameters["AppName"] = "app";
|
|
11
|
-
CLIParameters["Artifacts"] = "artifacts";
|
|
12
|
-
CLIParameters["ConfigName"] = "configName";
|
|
13
|
-
CLIParameters["ContentTypes"] = "contentTypes";
|
|
14
|
-
CLIParameters["Catalog"] = "catalog";
|
|
15
|
-
CLIParameters["Cookies"] = "cookies";
|
|
16
|
-
CLIParameters["Count"] = "count";
|
|
17
|
-
CLIParameters["CustomerPath"] = "customerPath";
|
|
18
|
-
CLIParameters["CustomersDirectory"] = "customersDirectory";
|
|
19
|
-
CLIParameters["Days"] = "days";
|
|
20
|
-
CLIParameters["Delay"] = "delay";
|
|
21
|
-
CLIParameters["Device"] = "device";
|
|
22
|
-
CLIParameters["Domain"] = "domain";
|
|
23
|
-
CLIParameters["DryRun"] = "dryRun";
|
|
24
|
-
CLIParameters["Execute"] = "execute";
|
|
25
|
-
CLIParameters["BySet"] = "bySet";
|
|
26
|
-
CLIParameters["ExcludeNoindex"] = "excludeNoindex";
|
|
27
|
-
CLIParameters["ExcludeNotFound"] = "excludeNotFound";
|
|
28
|
-
CLIParameters["ExcludeSuspicious"] = "excludeSuspicious";
|
|
29
|
-
CLIParameters["Explain"] = "explain";
|
|
30
|
-
CLIParameters["Group"] = "group";
|
|
31
|
-
CLIParameters["HardNavigationsOnly"] = "hardNavigationsOnly";
|
|
32
|
-
CLIParameters["HideDiff"] = "hideDiff";
|
|
33
|
-
CLIParameters["Ips"] = "ips";
|
|
34
|
-
CLIParameters["KeepParameterSorting"] = "keepParameterSorting";
|
|
35
|
-
CLIParameters["Limit"] = "limit";
|
|
36
|
-
CLIParameters["Match"] = "match";
|
|
37
|
-
CLIParameters["MinHits"] = "minHits";
|
|
38
|
-
CLIParameters["MinImpressions"] = "minImpressions";
|
|
39
|
-
CLIParameters["Quiet"] = "quiet";
|
|
40
|
-
CLIParameters["Mobile"] = "mobile";
|
|
41
|
-
CLIParameters["PageUrl"] = "pageUrl";
|
|
42
|
-
CLIParameters["Path"] = "path";
|
|
43
|
-
CLIParameters["SlackToken"] = "slackToken";
|
|
44
|
-
CLIParameters["TestId"] = "testId";
|
|
45
|
-
CLIParameters["Urls"] = "urls";
|
|
46
|
-
CLIParameters["Variation"] = "variation";
|
|
47
|
-
CLIParameters["VariationPath"] = "variationPath";
|
|
48
|
-
CLIParameters["Verbose"] = "verbose";
|
|
49
|
-
CLIParameters["Workgroup"] = "workgroup";
|
|
50
|
-
CLIParameters["useTestConfig"] = "useTestConfig";
|
|
51
|
-
})(CLIParameters || (CLIParameters = {}));
|
|
52
|
-
/* eslint-disable @typescript-eslint/no-duplicate-enum-values */
|
|
53
|
-
export var CLIParametersChar;
|
|
54
|
-
(function (CLIParametersChar) {
|
|
55
|
-
CLIParametersChar["AppName"] = "a";
|
|
56
|
-
CLIParametersChar["Artifacts"] = "a";
|
|
57
|
-
CLIParametersChar["ConfigName"] = "c";
|
|
58
|
-
CLIParametersChar["ContentTypes"] = "c";
|
|
59
|
-
CLIParametersChar["Cookies"] = "c";
|
|
60
|
-
CLIParametersChar["CustomerPath"] = "p";
|
|
61
|
-
CLIParametersChar["CustomersDirectory"] = "d";
|
|
62
|
-
CLIParametersChar["Days"] = "d";
|
|
63
|
-
CLIParametersChar["Delay"] = "d";
|
|
64
|
-
CLIParametersChar["Domain"] = "d";
|
|
65
|
-
CLIParametersChar["DryRun"] = "d";
|
|
66
|
-
CLIParametersChar["Execute"] = "e";
|
|
67
|
-
CLIParametersChar["Group"] = "g";
|
|
68
|
-
CLIParametersChar["HideDiff"] = "h";
|
|
69
|
-
CLIParametersChar["Ips"] = "i";
|
|
70
|
-
CLIParametersChar["KeepParameterSorting"] = "k";
|
|
71
|
-
CLIParametersChar["Mobile"] = "m";
|
|
72
|
-
CLIParametersChar["SlackToken"] = "t";
|
|
73
|
-
CLIParametersChar["Path"] = "p";
|
|
74
|
-
CLIParametersChar["Variation"] = "v";
|
|
75
|
-
CLIParametersChar["VariationPath"] = "p";
|
|
76
|
-
CLIParametersChar["Quiet"] = "q";
|
|
77
|
-
CLIParametersChar["useTestConfig"] = "t";
|
|
78
|
-
})(CLIParametersChar || (CLIParametersChar = {}));
|
|
79
|
-
/* eslint-enable @typescript-eslint/no-duplicate-enum-values */
|
|
80
|
-
export var CLIParametersExample;
|
|
81
|
-
(function (CLIParametersExample) {
|
|
82
|
-
CLIParametersExample["AppName"] = "decathlon";
|
|
83
|
-
CLIParametersExample["Artifacts"] = "dynamic,SpeedKit";
|
|
84
|
-
CLIParametersExample["ConfigName"] = "production";
|
|
85
|
-
CLIParametersExample["ContentTypes"] = "image,style";
|
|
86
|
-
CLIParametersExample["Cookies"] = "consentCookies";
|
|
87
|
-
CLIParametersExample["CustomerPath"] = "customers/decathlon.de";
|
|
88
|
-
CLIParametersExample["CustomersDirectory"] = "customers";
|
|
89
|
-
CLIParametersExample["Delay"] = "1200";
|
|
90
|
-
CLIParametersExample["Devices"] = "desktop,mobile";
|
|
91
|
-
CLIParametersExample["Domain"] = "www.decathlon.de";
|
|
92
|
-
CLIParametersExample["Group"] = "B";
|
|
93
|
-
CLIParametersExample["Ips"] = "151.101.120.194";
|
|
94
|
-
CLIParametersExample["Match"] = "^/p/";
|
|
95
|
-
CLIParametersExample["Mobile"] = "Y";
|
|
96
|
-
CLIParametersExample["PageUrl"] = "https://www.decathlon.de/";
|
|
97
|
-
CLIParametersExample["Path"] = "C:\\Users\\testUser\\file.csv";
|
|
98
|
-
CLIParametersExample["SlackToken"] = "someSlackToken";
|
|
99
|
-
CLIParametersExample["TestId"] = "listing-50vs50";
|
|
100
|
-
CLIParametersExample["Urls"] = "url1,url2,url3";
|
|
101
|
-
CLIParametersExample["Variation"] = "MOBILE";
|
|
102
|
-
CLIParametersExample["Variations"] = "MOBILE,DESKTOP";
|
|
103
|
-
CLIParametersExample["VariationPath"] = "C:\\Users\\testUser\\variations.csv";
|
|
104
|
-
})(CLIParametersExample || (CLIParametersExample = {}));
|
|
105
|
-
export const CLI_CONFIG_NAME = {
|
|
106
|
-
[CLIParameters.ConfigName]: Flags.string({
|
|
107
|
-
char: CLIParametersChar.ConfigName,
|
|
108
|
-
default: "production",
|
|
109
|
-
description: "The costumer config name",
|
|
110
|
-
required: false,
|
|
111
|
-
}),
|
|
112
|
-
};
|
|
113
|
-
// to enable testMode for deploy and onboarding command
|
|
114
|
-
// it will set the field app to the configured testApp
|
|
115
|
-
// and name to the original configured app
|
|
116
|
-
export const CLI_CONFIG_IS_TEST = {
|
|
117
|
-
[CLIParameters.useTestConfig]: Flags.boolean({
|
|
118
|
-
char: CLIParametersChar.useTestConfig,
|
|
119
|
-
description: "Override app with configured testApp",
|
|
120
|
-
}),
|
|
121
|
-
};
|
|
122
|
-
/** Shared wording, so every query command describes the window the same way. */
|
|
123
|
-
export const CLI_QUERY_DAYS_DESCRIPTION = "Number of days the query looks back";
|
|
124
|
-
/**
|
|
125
|
-
* How far back a query looks. Its own object because `generate-pop-config`
|
|
126
|
-
* takes it without the `-d` shorthand, which `--deploy` holds there.
|
|
127
|
-
*/
|
|
128
|
-
export const CLI_QUERY_DAYS = {
|
|
129
|
-
[CLIParameters.Days]: Flags.integer({
|
|
130
|
-
char: CLIParametersChar.Days,
|
|
131
|
-
description: CLI_QUERY_DAYS_DESCRIPTION,
|
|
132
|
-
min: 1,
|
|
133
|
-
required: false,
|
|
134
|
-
}),
|
|
135
|
-
};
|
|
136
|
-
/**
|
|
137
|
-
* What a query command does with the query it built. Both commands take them,
|
|
138
|
-
* so a query can be piped or run without a detour through the clipboard.
|
|
139
|
-
*/
|
|
140
|
-
export const CLI_QUERY_OUTPUT = {
|
|
141
|
-
[CLIParameters.Execute]: Flags.boolean({
|
|
142
|
-
char: CLIParametersChar.Execute,
|
|
143
|
-
default: false,
|
|
144
|
-
description: "Execute the query directly and write the result to a <app>-<date>-<query>.csv file",
|
|
145
|
-
}),
|
|
146
|
-
[CLIParameters.Quiet]: Flags.boolean({
|
|
147
|
-
char: CLIParametersChar.Quiet,
|
|
148
|
-
default: false,
|
|
149
|
-
description: "Output only the raw query without clipboard copy or styling",
|
|
150
|
-
}),
|
|
151
|
-
};
|
|
152
|
-
/**
|
|
153
|
-
* Which page impressions a query leaves out, and whether to account for every
|
|
154
|
-
* rule it does not carry over literally. Bots are always excluded.
|
|
155
|
-
*/
|
|
156
|
-
export const CLI_QUERY_FILTERS = {
|
|
157
|
-
[CLIParameters.ExcludeNoindex]: Flags.boolean({
|
|
158
|
-
default: false,
|
|
159
|
-
description: "Exclude page impressions of pages marked noindex",
|
|
160
|
-
}),
|
|
161
|
-
[CLIParameters.ExcludeSuspicious]: Flags.boolean({
|
|
162
|
-
default: false,
|
|
163
|
-
description: "Exclude page impressions Speed Kit classified as suspicious",
|
|
164
|
-
}),
|
|
165
|
-
[CLIParameters.Explain]: Flags.boolean({
|
|
166
|
-
default: false,
|
|
167
|
-
description: "Account for every rule the query leaves out, reduces or approximates",
|
|
168
|
-
}),
|
|
169
|
-
[CLIParameters.HardNavigationsOnly]: Flags.boolean({
|
|
170
|
-
default: false,
|
|
171
|
-
description: "Exclude soft (SPA) navigations",
|
|
172
|
-
}),
|
|
173
|
-
};
|
|
174
|
-
/**
|
|
175
|
-
* Which variation the pre-warm list carries per url, instead of leaving the
|
|
176
|
-
* pre-warmer to request every url in every variation.
|
|
177
|
-
*
|
|
178
|
-
* The two flags answer the same question from two different sources — the
|
|
179
|
-
* traffic, or the operator — so combining them would cross-produce the list
|
|
180
|
-
* again, which is what they are there to stop. A command that also reads a
|
|
181
|
-
* variations file from disk excludes that one on its own side.
|
|
182
|
-
*/
|
|
183
|
-
export const CLI_QUERY_VARIATIONS = {
|
|
184
|
-
[CLIParameters.Device]: Flags.string({
|
|
185
|
-
delimiter: ",",
|
|
186
|
-
description: "Split the list by device class, so every url is warmed in the variations it was actually requested in. A class not named is left out",
|
|
187
|
-
exclusive: [CLIParameters.Variation],
|
|
188
|
-
multiple: true,
|
|
189
|
-
options: [...DEVICE_VARIATIONS],
|
|
190
|
-
required: false,
|
|
191
|
-
}),
|
|
192
|
-
[CLIParameters.Variation]: Flags.string({
|
|
193
|
-
char: CLIParametersChar.Variation,
|
|
194
|
-
delimiter: ",",
|
|
195
|
-
description: "Pair every url of the list with each of these variations. For the custom variations no traffic can reveal, e.g. 'desktop-pdp-a,mobile-pdp-a'",
|
|
196
|
-
exclusive: [CLIParameters.Device],
|
|
197
|
-
multiple: true,
|
|
198
|
-
required: false,
|
|
199
|
-
}),
|
|
200
|
-
};
|
|
201
|
-
/**
|
|
202
|
-
* What the pre-warm query keeps of a long tail that is mostly seen once.
|
|
203
|
-
*
|
|
204
|
-
* Every flag here shapes the list itself, so a command that builds that list
|
|
205
|
-
* takes all of them — `sk auto-prewarm` included, or a count could describe a
|
|
206
|
-
* list the pre-warmer would never produce.
|
|
207
|
-
*/
|
|
208
|
-
export const CLI_QUERY_PREWARM_LIST = {
|
|
209
|
-
...CLI_QUERY_VARIATIONS,
|
|
210
|
-
[CLIParameters.ExcludeNotFound]: Flags.boolean({
|
|
211
|
-
default: false,
|
|
212
|
-
description: "Leave out urls the origin answers with a 404 more often than not",
|
|
213
|
-
}),
|
|
214
|
-
[CLIParameters.Limit]: Flags.integer({
|
|
215
|
-
description: "Keep only the most requested urls",
|
|
216
|
-
min: 1,
|
|
217
|
-
required: false,
|
|
218
|
-
}),
|
|
219
|
-
[CLIParameters.Match]: Flags.string({
|
|
220
|
-
description: "Keep only urls whose path matches this regular expression, e.g. '^/p/'. The path is matched with its query string, the way a version 1 pathname rule matches it, so '[?&]size=' works too. Repeat the flag to keep the urls matching any of several patterns, and start a pattern with (?i) to match case-insensitively",
|
|
221
|
-
multiple: true,
|
|
222
|
-
parse: async (input) => {
|
|
223
|
-
try {
|
|
224
|
-
parseMatchPattern(input);
|
|
225
|
-
}
|
|
226
|
-
catch (error) {
|
|
227
|
-
throw new Error(`--match ${input} is not a regular expression: ${error.message}`, { cause: error });
|
|
228
|
-
}
|
|
229
|
-
return input;
|
|
230
|
-
},
|
|
231
|
-
required: false,
|
|
232
|
-
}),
|
|
233
|
-
[CLIParameters.MinHits]: Flags.integer({
|
|
234
|
-
description: "Keep only urls requested at least this often in the window",
|
|
235
|
-
min: 1,
|
|
236
|
-
required: false,
|
|
237
|
-
}),
|
|
238
|
-
};
|
|
239
|
-
/**
|
|
240
|
-
* The pre-warm query flags in full: the list-shaping ones plus `--count`, which
|
|
241
|
-
* reports the list's size instead of returning it. Only a command that can
|
|
242
|
-
* answer with a count takes this one — `sk auto-prewarm` warms the list, so it
|
|
243
|
-
* takes {@link CLI_QUERY_PREWARM_LIST} instead.
|
|
244
|
-
*/
|
|
245
|
-
export const CLI_QUERY_PREWARM = {
|
|
246
|
-
...CLI_QUERY_PREWARM_LIST,
|
|
247
|
-
[CLIParameters.Count]: Flags.boolean({
|
|
248
|
-
default: false,
|
|
249
|
-
description: "Run the query and report how large the list is instead of what is in it: urls, the impressions they stand for, and a row per variation where the list carries variations. Every other flag still applies, so this counts the list the same command would produce",
|
|
250
|
-
exclusive: [CLIParameters.Execute],
|
|
251
|
-
}),
|
|
252
|
-
};
|
|
253
|
-
/**
|
|
254
|
-
* Where a query that is executed actually runs.
|
|
255
|
-
*
|
|
256
|
-
* The catalog is the account's, not the query's: our own logins reach the rum
|
|
257
|
-
* tables under `live`, while a role scoped to one account reaches the same
|
|
258
|
-
* tables under `AwsDataCatalog`. `SK_ATHENA_CATALOG` lets a CI job say so once.
|
|
259
|
-
*
|
|
260
|
-
* Athena resolves the account's default workgroup when none is named, which is
|
|
261
|
-
* only right where the credentials are allowed to use it — a role scoped to one
|
|
262
|
-
* workgroup is refused on any other, and the result location is a workgroup
|
|
263
|
-
* setting too. `SK_ATHENA_WORKGROUP` lets a CI job set it once for every
|
|
264
|
-
* command in the job.
|
|
265
|
-
*/
|
|
266
|
-
export const CLI_ATHENA = {
|
|
267
|
-
[CLIParameters.Catalog]: Flags.string({
|
|
268
|
-
default: DEFAULT_ATHENA_CATALOG,
|
|
269
|
-
description: "Athena data catalog holding the rum tables. Names the catalog both in the query and in the context it runs in, so the two always agree",
|
|
270
|
-
env: "SK_ATHENA_CATALOG",
|
|
271
|
-
required: false,
|
|
272
|
-
}),
|
|
273
|
-
[CLIParameters.Workgroup]: Flags.string({
|
|
274
|
-
description: "Athena workgroup to run the query in, e.g. 'prewarming'. Defaults to the account's default workgroup",
|
|
275
|
-
env: "SK_ATHENA_WORKGROUP",
|
|
276
|
-
required: false,
|
|
277
|
-
}),
|
|
278
|
-
};
|
|
279
|
-
/** How the parameter query presents what it found. */
|
|
280
|
-
export const CLI_QUERY_PARAMETER = {
|
|
281
|
-
[CLIParameters.BySet]: Flags.boolean({
|
|
282
|
-
default: false,
|
|
283
|
-
description: "Rank whole sets of parameters instead of single parameters, to see which ones travel together",
|
|
284
|
-
}),
|
|
285
|
-
[CLIParameters.MinImpressions]: Flags.integer({
|
|
286
|
-
description: "Leave out parameters seen on fewer page impressions than this",
|
|
287
|
-
min: 1,
|
|
288
|
-
required: false,
|
|
289
|
-
}),
|
|
290
|
-
};
|
|
291
|
-
export const CLI_CUSTOMER_CONFIG = {
|
|
292
|
-
[CLIParameters.CustomerPath]: Args.directory({
|
|
293
|
-
name: CLIParameters.CustomerPath,
|
|
294
|
-
required: true,
|
|
295
|
-
description: "The customer config path",
|
|
296
|
-
}),
|
|
297
|
-
};
|
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
import { Config } from "@oclif/core";
|
|
2
|
-
/** A Chrome extension installed via the setup wizard and tracked for updates. */
|
|
3
|
-
export interface ManagedExtension {
|
|
4
|
-
/** Chrome Web Store extension id */
|
|
5
|
-
id: string;
|
|
6
|
-
name: string;
|
|
7
|
-
version: string;
|
|
8
|
-
/** absolute path to the unpacked extension directory */
|
|
9
|
-
path: string;
|
|
10
|
-
}
|
|
11
|
-
export interface UserCliConfig {
|
|
12
|
-
chromeExtensionPaths: string;
|
|
13
|
-
/** system-specific flags, appended to the onboarding browser's launch args */
|
|
14
|
-
chromeFlags: string[];
|
|
15
|
-
chromePath: string;
|
|
16
|
-
chromeUserProfilePath: string;
|
|
17
|
-
diffExec: string;
|
|
18
|
-
diffExecTemplate: string;
|
|
19
|
-
diffTool: string;
|
|
20
|
-
ideaDirectory: string;
|
|
21
|
-
slackToken: string;
|
|
22
|
-
testApp: string;
|
|
23
|
-
browserChannel: string;
|
|
24
|
-
browserBuildId: string;
|
|
25
|
-
browserAutoUpdate: boolean;
|
|
26
|
-
updateReminderDays: number;
|
|
27
|
-
lastBrowserUpdateCheck: string;
|
|
28
|
-
managedChromeExtensions: ManagedExtension[];
|
|
29
|
-
lastExtensionUpdateCheck: string;
|
|
30
|
-
firstRunCompleted: boolean;
|
|
31
|
-
tempFolder: string;
|
|
32
|
-
runtimeConfig: Config;
|
|
33
|
-
nodeModulesPath: string;
|
|
34
|
-
}
|
|
35
|
-
export declare class CliConfig {
|
|
36
|
-
private config;
|
|
37
|
-
private userCliConfig;
|
|
38
|
-
constructor(config: Config);
|
|
39
|
-
load(customerPath?: string): UserCliConfig;
|
|
40
|
-
private createEmptyConfigFile;
|
|
41
|
-
private createEmptyUserConfig;
|
|
42
|
-
/**
|
|
43
|
-
* Persists the given settings into the user config.json, merging with what
|
|
44
|
-
* is already there. Runtime-only keys are stripped so they never leak into
|
|
45
|
-
* the file. Also reflects the change in the in-memory config so the running
|
|
46
|
-
* command sees it immediately.
|
|
47
|
-
*/
|
|
48
|
-
save(partial: Partial<UserCliConfig>): void;
|
|
49
|
-
private getConfigFilePath;
|
|
50
|
-
private loadConfigFromConfigFile;
|
|
51
|
-
private loadConfigFromEnvironment;
|
|
52
|
-
private resolveExtensionConfigPaths;
|
|
53
|
-
private readCliConfigFromFile;
|
|
54
|
-
/**
|
|
55
|
-
* Reads and parses config.json without any side effects. Returns null when
|
|
56
|
-
* the file is missing or cannot be parsed.
|
|
57
|
-
*/
|
|
58
|
-
private readRawConfigFile;
|
|
59
|
-
}
|