@speedkit/cli 4.25.2 → 4.27.0

package/dist/helpers/build-query-helper.d.ts

@@ -1,32 +0,0 @@
-/**
- * Returns the whitelisted filter as a sql query string.
- *
- * @param parsedConfig - The speed kit config parsed as an object.
- */
-export declare function getWhitelistedFilter(parsedConfig: any): string;
-/**
- * Returns the blacklisted filter as a SQL query string.
- *
- * @param parsedConfig - The speed kit config parsed as an object.
- */
-export declare function getBlacklistedFilter(parsedConfig: any): string;
-/**
- * Returns the parameter filter as a SQL query string.
- *
- * @param params - The stripped parameters that are named within the speed kit config.
- * @param skConfigVersion - The Speed Kit config ruleset version.
- */
-export declare function getParameterFilter(parameters: (string | RegExp)[], skConfigVersion?: number): string;
-/**
- * Returns the parameter replace (regexp_replace) as a SQL query string.
- *
- * @param params - The stripped parameters that are named within the speed kit config.
- * @param skConfigVersion - The Speed Kit config ruleset version.
- */
-export declare function getParameterReplaceFilter(parameters: (string | RegExp)[], skConfigVersion?: number): string;
-/**
- * Returns the stripped parameters that are named within the speed kit config.
- *
- * @param parsedConfig - The speed kit config parsed as an object.
- */
-export declare function getStrippedParameters(parsedConfig: any): (string | RegExp)[];

package/dist/helpers/build-query-helper.js

@@ -1,223 +0,0 @@
-/**
- * Returns the string between a left bound and a right bound.
- *
- * @param input - The input string to get the inner string from.
- * @param leftBound - The left bound of the string to be cut.
- * @param rightBound - The right bound of the string to be cut.
- */
-function getStringBetween(input, leftBound, rightBound) {
-    return input.slice(input.indexOf(leftBound) + 1, input.lastIndexOf(rightBound));
-}
-/**
- * Returns the comparison filter (like, regexp_like) as a SQL query string.
- *
- * @param property - The property to be compared
- * @param sqlField -The SQL field to compare with.
- * @param shouldEqual - True if the property should equal the sql value, false otherwise.
- * @param type - Whether type of property is a pathname or url.
- */
-function getFilterForProperty(property, sqlField, shouldEqual, type) {
-    if (typeof property === "string") {
-        if (type === "pathname") {
-            return `url_extract_path(${sqlField}) ${shouldEqual ? "" : "not "}like '${property}%'`;
-        }
-        return `${sqlField} ${shouldEqual ? "" : "not "}like 'https://${property}%'`;
-    }
-    const ignoreCase = isRegExpIgnoringCase(property);
-    const sqlRegExp = getStringBetween(String(property), "/", "/");
-    if (type === "pathname") {
-        return `${shouldEqual ? "" : "not "}regexp_like(url_extract_path(${sqlField}), '${ignoreCase ? "(?i)" : ""}${sqlRegExp}')`;
-    }
-    return `${shouldEqual ? "" : "not "}regexp_like(${sqlField}, '${ignoreCase ? "(?i)" : ""}${sqlRegExp}')`;
-}
-/**
- * Returns all properties of a speed kit rule with the given keys.
- *
- * @param speedKitRuleValues - The speed kit rule value to get the properties from (e.g. the whitelist).
- * @param key - The key to get the properties with (e.g. 'pathname').
- */
-function getRuleProperty(speedKitRuleValues, key) {
-    const properties = [];
-    if (!speedKitRuleValues) {
-        return properties;
-    }
-    for (const ruleValue of speedKitRuleValues) {
-        for (const ruleKey of Object.keys(ruleValue).filter((ruleKey) => key === ruleKey))
-            properties.push(...ruleValue[ruleKey]);
-    }
-    return properties;
-}
-/**
- * Returns the whitelisted filter as a sql query string.
- *
- * @param parsedConfig - The speed kit config parsed as an object.
- */
-export function getWhitelistedFilter(parsedConfig) {
-    const { whitelist, enabledSites } = parsedConfig;
-    // TODO: use origins instead here
-    const whitelistedFilter = `(\n    ${(whitelist[0].host || whitelist[0].url)
-        .map((hostname) => getFilterForProperty(hostname, "url", true, "url"))
-        .join("\n    or ")}\n  )`;
-    const enabledFilter = getRuleProperty(enabledSites, "pathname")
-        .map((pathname) => getFilterForProperty(pathname, "url", true, "pathname"))
-        .join("\nor ");
-    if (!enabledFilter) {
-        return `${whitelistedFilter}`;
-    }
-    return `(${whitelistedFilter}) and (${enabledFilter})`;
-}
-/**
- * Returns the blacklisted filter as a SQL query string.
- *
- * @param parsedConfig - The speed kit config parsed as an object.
- */
-export function getBlacklistedFilter(parsedConfig) {
-    const { blacklist, disabledSites } = parsedConfig;
-    const blacklistedPathnamesFilter = getRuleProperty(blacklist, "pathname")
-        .map((pathname) => getFilterForProperty(pathname, "url", false, "pathname"))
-        .join("\n  and ");
-    const blacklistedUrlsFilter = getRuleProperty(blacklist, "url")
-        .map((url) => getFilterForProperty(url, "url", false, "url"))
-        .join("\n  and ");
-    const disabledFilter = getRuleProperty(disabledSites, "pathname")
-        .map((pathname) => getFilterForProperty(pathname, "url", false, "pathname"))
-        .join("\n  and ");
-    let blacklistedFilter = "";
-    if (blacklistedPathnamesFilter) {
-        blacklistedFilter += blacklistedPathnamesFilter;
-    }
-    if (blacklistedUrlsFilter) {
-        blacklistedFilter += `\n and ${blacklistedUrlsFilter}`;
-    }
-    if (disabledFilter) {
-        blacklistedFilter += `\n and ${disabledFilter}`;
-    }
-    return blacklistedFilter;
-}
-/**
- * Returns the parameter filter as a SQL query string.
- *
- * @param params - The stripped parameters that are named within the speed kit config.
- * @param skConfigVersion - The Speed Kit config ruleset version.
- */
-export function getParameterFilter(parameters, skConfigVersion = 1) {
-    return parameters
-        .map((parameter) => {
-        // Prefix comparison for strings
-        if (typeof parameter === "string") {
-            return skConfigVersion === 1
-                ? `not regexp_like(key, '^${parameter}')`
-                : `key <> '${parameter}'`;
-        }
-        // Regexp like for complex regular expressions
-        const ignoreCase = isRegExpIgnoringCase(parameter);
-        return `not regexp_like(key, '${ignoreCase ? "(?i)" : ""}${getStringBetween(String(parameter), "/", "/")}')`;
-    })
-        .join("\nand ");
-}
-/**
- * Returns the parameter replace (regexp_replace) as a SQL query string.
- *
- * @param params - The stripped parameters that are named within the speed kit config.
- * @param skConfigVersion - The Speed Kit config ruleset version.
- */
-export function getParameterReplaceFilter(parameters, skConfigVersion = 1) {
-    const prefixParameters = [];
-    const suffixParameters = [];
-    const fullMatchParameters = [];
-    const prefixIgnoreCaseParameters = [];
-    const suffixIgnoreCaseParameters = [];
-    const fullMatchIgnoreCaseParameters = [];
-    for (const parameter of parameters) {
-        // String params or regex params with start marker but no end marker
-        if (typeof parameter === "string") {
-            if (skConfigVersion === 1) {
-                prefixParameters.push(parameter);
-                continue;
-            }
-            else {
-                fullMatchParameters.push(parameter);
-                continue;
-            }
-        }
-        const ignoreCase = isRegExpIgnoringCase(parameter);
-        // Regex params with start marker but no end marker
-        if (/\/\^[^$]+$/.test(String(parameter))) {
-            (ignoreCase ? prefixIgnoreCaseParameters : prefixParameters).push(getStringBetween(String(parameter), "^", "/"));
-            continue;
-        }
-        // Regex params with end marker but no start marker
-        if (/\/[^$^]+\$/.test(String(parameter))) {
-            (ignoreCase ? suffixIgnoreCaseParameters : suffixParameters).push(getStringBetween(String(parameter), "/", "$"));
-            continue;
-        }
-        // Regex params with start marker and end marker
-        if (/\/\^[^$]+\$\//.test(String(parameter))) {
-            (ignoreCase ? fullMatchIgnoreCaseParameters : fullMatchParameters).push(getStringBetween(String(parameter), "^", "$"));
-            continue;
-        }
-        // Regex params with no start marker and no end marker are being considered full matches
-        (ignoreCase ? fullMatchIgnoreCaseParameters : fullMatchParameters).push(getStringBetween(String(parameter), "/", "/"));
-    }
-    let regExpQuery = "regexp_replace(url, '#.*' )";
-    const regExps = [
-        getParameterPrefixRegExp(prefixParameters, false),
-        getParameterPrefixRegExp(prefixIgnoreCaseParameters, true),
-        getParameterSuffixRegExp(suffixParameters, false),
-        getParameterSuffixRegExp(suffixIgnoreCaseParameters, true),
-        getParameterFullMatchRegExp(fullMatchParameters, false),
-        getParameterFullMatchRegExp(fullMatchIgnoreCaseParameters, true),
-    ];
-    // Nest all regexes inside each other:
-    for (const regExp of regExps) {
-        if (regExp) {
-            regExpQuery = `regexp_replace(${regExpQuery}, '${regExp}', '')`;
-        }
-    }
-    return regExpQuery;
-}
-function isRegExpIgnoringCase(regExp) {
-    return /\/i$/.test(String(regExp));
-}
-function getParameterPrefixRegExp(parameters, ignoreCase) {
-    return parameters.length > 0
-        ? `${ignoreCase ? "(?i)" : ""}[?&](${parameters.join("|")})[^&]*`
-        : null;
-}
-function getParameterSuffixRegExp(parameters, ignoreCase) {
-    return parameters.length > 0
-        ? `${ignoreCase ? "(?i)" : ""}[?&][^&]*(${parameters.join("|")})(=[^&]*)?(?=&|$)`
-        : null;
-}
-function getParameterFullMatchRegExp(parameters, ignoreCase) {
-    return parameters.length > 0
-        ? `${ignoreCase ? "(?i)" : ""}[?&](${parameters.join("|")})(=[^&]*)?(?=&|$)`
-        : null;
-}
-/**
- * Returns the stripped parameters that are named within the speed kit config.
- *
- * @param parsedConfig - The speed kit config parsed as an object.
- */
-export function getStrippedParameters(parsedConfig) {
-    const parameterArray = parsedConfig.stripQueryParams;
-    if (!parameterArray) {
-        return [];
-    }
-    const isSimpleArray = parameterArray.every((parameter) => typeof parameter === "string" || parameter instanceof RegExp);
-    if (isSimpleArray) {
-        return parameterArray;
-    }
-    const parameters = [];
-    for (const entry of parameterArray) {
-        if (!entry.params) {
-            continue;
-        }
-        if (!Array.isArray(entry.params)) {
-            parameters.push(entry.params);
-            continue;
-        }
-        parameters.push(...entry.params);
-    }
-    return parameters;
-}

package/dist/helpers/get-parsed-config.d.ts

@@ -1,15 +0,0 @@
-import { ConfigFile } from "./customer-config.js";
-interface SpeedKitConfig {
-    ruleSetConfig?: {
-        version?: string;
-    };
-    [key: string]: any;
-}
-/**
- * @deprecated
- * @param config
- */
-export declare function parseSpeedKitConfig(config: string): SpeedKitConfig;
-export declare function getParsedConfig(configFile: ConfigFile): Promise<SpeedKitConfig>;
-export declare function getSpeedKitConfigVersion(config: SpeedKitConfig): number;
-export {};

package/dist/helpers/get-parsed-config.js

@@ -1,62 +0,0 @@
-/* eslint-disable */
-import * as vm from "node:vm";
-/**
- * @deprecated
- * @param config
- */
-export function parseSpeedKitConfig(config) {
-    // Replace all properties that use function calls or that are related to other objects like window
-    const window = {};
-    window.top = window;
-    const storage = {
-        length: 0,
-        clear: () => { },
-        getItem: () => { },
-        key: () => null,
-        removeItem: () => { },
-        setItem: () => { },
-    };
-    const node = {
-        querySelector: () => node,
-        querySelectorAll: () => [],
-        classList: { contains: () => false },
-    };
-    const context = {
-        window,
-        APP: "",
-        document: Object.assign(Object.create(node), {
-            cookie: "",
-            documentElement: Object.create(node),
-            head: Object.create(node),
-            body: Object.create(node),
-        }),
-        speedKit: window.speedKit,
-        navigator: { userAgent: "test-agent" },
-        location: new URL("https://www.example.com"),
-        localStorage: storage,
-        sessionStorage: storage,
-    };
-    vm.runInNewContext(config, context);
-    return window.speedKit;
-}
-export async function getParsedConfig(configFile) {
-    const configString = configFile ? await configFile.readContent() : undefined;
-    if (!configString) {
-        throw new Error("Speed Kit config could not be found in directory");
-    }
-    let parsedConfig;
-    try {
-        parsedConfig = parseSpeedKitConfig(configString);
-    }
-    catch (error) {
-        throw new Error(`Speed Kit config string could not be parsed.\n${error.stack}`);
-    }
-    if (!parsedConfig) {
-        throw new Error("Speed Kit config was not correctly exposed on the global speedKit variable.");
-    }
-    return parsedConfig;
-}
-export function getSpeedKitConfigVersion(config) {
-    return Number(config.ruleSetConfig?.version) || 1;
-}
-/* eslint-enable */

package/dist/services/onboarding/dashboard/parameter-query-builder.d.ts

@@ -1,8 +0,0 @@
-import { CustomerConfig, ConfigFileInterface } from "../../integration-api/index.js";
-export declare class ParameterQueryBuilder {
-    private customerConfig;
-    private speedKitConfigFile;
-    constructor(customerConfig: CustomerConfig, speedKitConfigFile: ConfigFileInterface);
-    buildParameterQuery(app: string, parameterFilter: string, whitelistedFilter: string, blacklistedFilter: string, parameterReplaceFilter: string): string;
-    getQuery(): string;
-}

package/dist/services/onboarding/dashboard/parameter-query-builder.js

@@ -1,63 +0,0 @@
-import { getBlacklistedFilter, getParameterFilter, getParameterReplaceFilter, getStrippedParameters, getWhitelistedFilter, } from "../../../helpers/build-query-helper.js";
-import { parseSpeedKitConfig } from "../../../helpers/get-parsed-config.js";
-export class ParameterQueryBuilder {
-    customerConfig;
-    speedKitConfigFile;
-    constructor(customerConfig, speedKitConfigFile) {
-        this.customerConfig = customerConfig;
-        this.speedKitConfigFile = speedKitConfigFile;
-    }
-    buildParameterQuery(app, parameterFilter, whitelistedFilter, blacklistedFilter, parameterReplaceFilter) {
-        const nowMinusOneMonth = new Date(new Date().setMonth(new Date().getMonth() - 1, new Date().getDate()));
-        const monthString = `${nowMinusOneMonth.getMonth() + 1 < 10 ? "0" : ""}${nowMinusOneMonth.getMonth() + 1}`;
-        const dateString = `${nowMinusOneMonth.getDate() < 10 ? "0" : ""}${nowMinusOneMonth.getDate()}`;
-        const date = `${nowMinusOneMonth.getFullYear()}-${monthString}-${dateString}`;
-        return `
-with urlWithParams as (
- select
-  url,
-  createdat,
-  split(url, '?')[1] as urlWithoutParams,
-  filter (
-      transform(
-        split(split(url, '?')[2], '&'),
-        (pair) -> split(pair, '=')[1]
-      ),
-      (key) -> ${parameterFilter}
-  ) as paramKeys
-from live.rum.pi
-where app = '${app}'
-  and date >= '${date}'
-  and cardinality(split(url, '?')) > 1
-  and (${whitelistedFilter})
-  and ${blacklistedFilter}
-), prepared as (
-select count(*) as PIs,
-  count(distinct url) as urls,
-  count(distinct ${parameterReplaceFilter}) as cachedUrls,
-  count(distinct urlWithoutParams) as uniqueWithoutParam,
-  paramKeys,
-  element_at(array_distinct(max_by(url, MD5(to_utf8(to_iso8601(createdat))), 500)), 1) as example1,
-  element_at(array_distinct(max_by(url, MD5(to_utf8(to_iso8601(createdat))), 500)), 2) as example2,
-  element_at(array_distinct(max_by(url, MD5(to_utf8(to_iso8601(createdat))), 500)), 3) as example3
-from urlWithParams
-group by paramKeys
-)
-
-select paramKeys, cachedUrls - uniqueWithoutParam as potentialGain, cachedUrls, PIs, example1, example2, example3
-from prepared
-where cardinality(paramKeys) > 0
-order by case when potentialGain > cachedUrls and potentialGain > PIs then potentialGain
-              when cachedUrls > PIs then cachedUrls
-              else PIs end desc`;
-    }
-    getQuery() {
-        const parsedConfig = parseSpeedKitConfig(this.speedKitConfigFile.getContent());
-        const parameters = getStrippedParameters(parsedConfig);
-        const parameterFilter = getParameterFilter(parameters);
-        const whitelistedFilter = getWhitelistedFilter(parsedConfig);
-        const blacklistedFilter = getBlacklistedFilter(parsedConfig);
-        const parameterReplaceFilter = getParameterReplaceFilter(parameters);
-        return this.buildParameterQuery(this.customerConfig.app, parameterFilter, whitelistedFilter, blacklistedFilter, parameterReplaceFilter);
-    }
-}