@speedkit/cli 2.35.0 → 2.37.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.37.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.36.0...v2.37.0) (2024-07-03)
+
+
+### Features
+
+* **prewarm:** show minimal output on quietMode ([aa847d8](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/aa847d8c5ccaacbbcf94c1128973fb5af23f9e33))
+
+# [2.36.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.35.0...v2.36.0) (2024-06-27)
+
+
+### Features
+
+* **pop-prewarming:** update shielding configuration ([7aa22b6](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/7aa22b6f7a754fc8cb5fdc01454c4c4167e65035))
+
 # [2.35.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.34.0...v2.35.0) (2024-06-21)
 
 

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @speedkit/cli
 $ sk COMMAND
 running command...
 $ sk (--version)
-@speedkit/cli/2.35.0 linux-x64 node-v20.14.0
+@speedkit/cli/2.37.0 linux-x64 node-v20.15.0
 $ sk --help [COMMAND]
 USAGE
   $ sk COMMAND
@@ -287,7 +287,7 @@ Generate a pop config for the given app
 
 ```
 USAGE
-  $ sk generate-pop-config APP [-c <value>] [-d] [-p <value>] [-t <value>] [-r]
+  $ sk generate-pop-config APP [-c <value>] [-d] [-p <value>] [-t <value>] [-r] [-s]
 
 ARGUMENTS
   APP  The customers appName
@@ -298,6 +298,7 @@ FLAGS
                                deployment will be skipped or forced.
   -p, --pop-limit=<value>      [default: 5] The maximal pop count which should prewarmed.
   -r, --use-rum                Compute the pop statistics based on RUM. Otherwise the real Speed Kit traffic is used.
+  -s, --force-shield           Force a shield based prewarming config.
   -t, --traffic-share=<value>  [default: 5] The minimum traffic share in percent a pop must have to be actually
                                prewarmed.
 

package/dist/commands/generate-pop-config.d.ts

@@ -11,6 +11,7 @@ export default class GeneratePopConfig extends Command {
         "pop-limit": import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
         "traffic-share": import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
         "use-rum": import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        "force-shield": import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     createPopPrewarmingCode(popConfig: string): Promise<string>;
     deployPrewarmingConfig(app: string, config: string, deploy: boolean | undefined): Promise<void>;

package/dist/commands/generate-pop-config.js

@@ -40,6 +40,11 @@ const SHIELDS = [
         pop: "HKG",
         shield: "Hongkong Shield",
     },
+    {
+        condition: ({ pop }) => ["NRT", "ITM", "TYO", "HND"].includes(pop),
+        pop: "NRT",
+        shield: "Tokyo Shield",
+    },
     {
         condition: ({ region }) => region === "Asia-South",
         pop: "DEL",
@@ -109,6 +114,11 @@ class GeneratePopConfig extends core_1.Command {
             default: false,
             description: "Compute the pop statistics based on RUM. Otherwise the real Speed Kit traffic is used.",
         }),
+        "force-shield": core_1.Flags.boolean({
+            char: "s",
+            default: false,
+            description: "Force a shield based prewarming config.",
+        }),
     };
     async createPopPrewarmingCode(popConfig) {
         const revalidationTemplate = await (0, file_helper_1.readLocalFile)(__dirname, "../templates/speedKit.Revalidated.js");
@@ -136,13 +146,13 @@ class GeneratePopConfig extends core_1.Command {
         }
     }
     async run() {
-        const { args: { app }, flags: { coverage, deploy, "pop-limit": popLimit, "traffic-share": minimalShare, "use-rum": useRum, }, } = await this.parse(GeneratePopConfig);
+        const { args: { app }, flags: { coverage, deploy, "pop-limit": popLimit, "traffic-share": minimalShare, "use-rum": useRum, "force-shield": forceShield, }, } = await this.parse(GeneratePopConfig);
         // @todo refactor businessCode from this command to src/pop-config/pop-config-service
         const popConfigService = await new pop_config_1.PopConfigFactory().getService();
         const result = await popConfigService.getUsedPopsPerOrigin(app, useRum);
         const originStats = this.generateOriginStats(result).filter((stats) => stats.hits > 1000);
-        this.printStats(originStats, coverage / 100, minimalShare / 100, popLimit);
-        const popConfig = this.generatePopConfig(originStats, coverage / 100, minimalShare / 100, popLimit);
+        this.printStats(originStats, coverage / 100, minimalShare / 100, popLimit, forceShield);
+        const popConfig = this.generatePopConfig(originStats, coverage / 100, minimalShare / 100, popLimit, forceShield);
         await this.deployPrewarmingConfig(app, popConfig, deploy);
     }
     byHitsDesc(a, b) {
@@ -202,10 +212,10 @@ class GeneratePopConfig extends core_1.Command {
         }))
             .sort(this.byHitsDesc);
     }
-    generatePopConfig(originStats, coverage, minimalShare, popLimit) {
+    generatePopConfig(originStats, coverage, minimalShare, popLimit, forceShield) {
         const originConfigs = { DEFAULT: [] };
         for (const originStat of originStats) {
-            originConfigs[originStat.origin] = this.generatePrewarmingConfig(originStat, coverage, minimalShare, popLimit).pops.map((pop) => "POP." + pop);
+            originConfigs[originStat.origin] = this.generatePrewarmingConfig(originStat, coverage, minimalShare, popLimit, forceShield).pops.map((pop) => "POP." + pop);
         }
         const serializedConfig = JSON.stringify(originConfigs, null, "  ")
             .replaceAll(/"(POP.*?)"/g, "$1")
@@ -262,10 +272,10 @@ const ORIGIN_POPS = ${serializedConfig}`;
         }
         return { edgeCoverage, pops, requiresShielding: true, shieldCoverage };
     }
-    generatePrewarmingConfig(originStat, coverage, minimalShare, popLimit) {
+    generatePrewarmingConfig(originStat, coverage, minimalShare, popLimit, forceShield) {
         // Use shields if we need to prewar more than 5 pops to achieve the coverage
         const useShieldPrewarming = originStat.pops[popLimit - 1]?.coverage < coverage;
-        if (useShieldPrewarming) {
+        if (useShieldPrewarming || forceShield) {
             return this.generatePopListByShields(originStat, coverage, minimalShare, popLimit);
         }
         return this.generatePopListByPops(originStat, coverage, minimalShare);
@@ -279,7 +289,7 @@ const ORIGIN_POPS = ${serializedConfig}`;
         }
         return { pop: s.pop, shield: s.shield };
     }
-    printStats(originStats, coverage, minimalShare, popLimit) {
+    printStats(originStats, coverage, minimalShare, popLimit, forceShield) {
         let shieldingRequired = false;
         for (const originStat of originStats) {
             this.log(`${originStat.origin} ${originStat.hits}`);
@@ -303,7 +313,7 @@ const ORIGIN_POPS = ${serializedConfig}`;
                 if (popStats.coverage >= coverage || popStats.share < minimalShare)
                     break;
             }
-            const config = this.generatePrewarmingConfig(originStat, coverage, minimalShare, popLimit);
+            const config = this.generatePrewarmingConfig(originStat, coverage, minimalShare, popLimit, forceShield);
             this.log("  --------------------");
             if (config.requiresShielding)
                 this.log("  Final shield coverage: " +

package/dist/services/cli/cli-service-model.d.ts

@@ -12,6 +12,7 @@ export declare enum CliActionStatus {
 }
 export interface CliServiceInterface {
     style: chalk.Chalk;
+    readonly quiet: boolean;
     code(code: string, buffered?: boolean): void;
     codeStyle(code: string): string;
     comment(message: string, buffered?: boolean): void;

package/dist/services/cli/cli-service.d.ts

@@ -3,7 +3,7 @@ import { table } from "@oclif/core/lib/cli-ux/styled/table";
 import { Options } from "cli-progress";
 import { CliActionStatus, CliServiceInterface } from "./cli-service-model";
 export declare class CliService implements CliServiceInterface {
-    private readonly quiet;
+    readonly quiet: boolean;
     style: chalk.Chalk;
     private buffer;
     private progressBar?;

package/dist/services/prewarm/pre-warm-service.d.ts

@@ -6,6 +6,7 @@ export declare class PreWarmService {
     private cli;
     private urls;
     private variations;
+    private requestsSend;
     constructor(assetClient: AssetApiClient, cli: CliServiceInterface, urls: string[], variations: string[]);
     handleRequestCallback(assetClient: AssetApiClient, entry: AssetItemInterface): Promise<void>;
     run(): Promise<void>;
@@ -18,4 +19,5 @@ export declare class PreWarmService {
     private stopProgressBar;
     private updateProgressBar;
     private updateRateLimit;
+    private showMinimalStatusUpdate;
 }

package/dist/services/prewarm/pre-warm-service.js

@@ -10,6 +10,7 @@ class PreWarmService {
     cli;
     urls;
     variations;
+    requestsSend = 0;
     constructor(assetClient, cli, urls, variations) {
         this.assetClient = assetClient;
         this.cli = cli;
@@ -56,6 +57,8 @@ class PreWarmService {
             return;
         }
         this.cli.write("Retry rateLimited requests.");
+        // reset for minimal output
+        this.requestsSend = 0;
         const urlsToRetry = assetList
             .getByStatus(_1.ItemStatus.RETRY)
             .map((entry) => entry.url);
@@ -80,6 +83,7 @@ class PreWarmService {
         offset += batch.length;
         this.updateProgressBar(offset, assetList);
         await this.updateRateLimit(batch);
+        this.showMinimalStatusUpdate(batch, assetList);
         // fetch next batch
         await this.fetchBatch(assetList, offset);
     }
@@ -150,5 +154,17 @@ class PreWarmService {
             this.assetClient.reduceMaxRequestsPerSecond();
         }
     }
+    showMinimalStatusUpdate(batch, assetList) {
+        if (!this.cli.quiet) {
+            return;
+        }
+        this.requestsSend += batch.length;
+        const assetLength = assetList.getLength();
+        const errors = assetList.getErrorCount();
+        const success = assetList.getSuccessCount();
+        const retry = assetList.getRetryCount();
+        const currentRate = this.assetClient.getRateLimit();
+        this.cli.write(this.cli.style.gray(`${this.requestsSend}/${assetLength} | rate: ${currentRate} | success: ${success} | retry: ${retry} | errors: ${errors}`));
+    }
 }
 exports.PreWarmService = PreWarmService;

package/oclif.manifest.json

@@ -378,6 +378,13 @@
           "name": "use-rum",
           "allowNo": false,
           "type": "boolean"
+        },
+        "force-shield": {
+          "char": "s",
+          "description": "Force a shield based prewarming config.",
+          "name": "force-shield",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -681,5 +688,5 @@
       ]
     }
   },
-  "version": "2.35.0"
+  "version": "2.37.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "2.35.0",
+  "version": "2.37.0",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"