@snap/camera-kit 0.15.0 → 0.16.2

package/lib/metrics/operational/operationalMetricsReporter.js

@@ -1,144 +0,0 @@
-import { __awaiter } from "tslib";
-import { Injectable } from "../../dependency-injection/Injectable";
-import { HandlerChainBuilder } from "../../handlers/HandlerChainBuilder";
-import { createBatchingHandler } from "../../handlers/batchingHandler";
-import { SetOperationalMetricsRequest } from "../../generated-proto/pb_schema/camera_kit/v3/service";
-import { createMappingHandler } from "../../handlers/mappingHandler";
-import { pageVisibilityFactory } from "../../common/pageVisibility";
-import { metricsHandlerFactory } from "../metricsHandler";
-import { configurationToken } from "../../configuration";
-// CameraKit's prod metrics endpoint.
-// See: https://github.sc-corp.net/Snapchat/pb_schema/blob/c390b9c/proto/camera_kit/v3/service.proto#L126
-const DIMENSION_DELIMITER = ".";
-// These values are (currently) arbitrarily selected.
-// TODO: Once we have gathered a sufficient quantity of metrics data, we should tune these numbers to ensure we're
-// operating with the right cost vs. alarming SLA vs. IDB storage size tradeoffs.
-const METRIC_BATCH_MAX_SIZE = 100;
-const METRIC_BATCH_MAX_AGE_MS = 5000;
-/**
- * Use this class to report operational metrics – these are metrics that describe aspects of the SDK's performance,
- * which may be used to assess and investigate operational issues.
- */
-/** @internal */
-export class OperationalMetricsReporter {
-    constructor(metricsHandler) {
-        this.metricsHandler = metricsHandler;
-    }
-    /**
-     * Record a count.
-     *
-     * @param name
-     * @param count
-     * @param dimensions An optional Map containing dimensions which describe the metric.
-     * For example: `new Map([['status', '200']])`
-     * @returns Promise which resolves when the metric has been handled.
-     */
-    count(name, count, dimensions) {
-        return this.record(name, { $case: "count", count }, dimensions);
-    }
-    /**
-     * Record a duration in milliseconds.
-     *
-     * @param name
-     * @param latencyMillis
-     * @param dimensions An optional Map containing dimensions which describe the metric.
-     * For example: `new Map([['status', '200']])`
-     * @returns Promise which resolves when the metric has been handled.
-     */
-    timer(name, latencyMillis, dimensions) {
-        return this.record(name, { $case: "latencyMillis", latencyMillis }, dimensions);
-    }
-    /**
-     * Record a histogram.
-     *
-     * @param name
-     * @param histogram
-     * @param dimensions An optional Map containing dimensions which describe the metric.
-     * For example: `new Map([['status', '200']])`
-     * @returns Promise which resolves when the metric has been handled.
-     */
-    histogram(name, histogram, dimensions) {
-        return this.record(name, { $case: "histogram", histogram }, dimensions);
-    }
-    /**
-     * TODO: This entire class in no longer necessary, since the new Timer/Count/Histogram classes offer a cleaner API
-     * for recording metrics. Once we migrate all operational metrics to use those new APIs, this class can be removed
-     * and call sites will just call the metrics handler directly.
-     *
-     * @param metric Any concrete Metric (e.g. Count, Timer, Histogram)
-     * @returns
-     */
-    report(metric) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield Promise.all(metric.toOperationalMetric().map((metric) => this.metricsHandler(metric)));
-        });
-    }
-    record(name, metric, dimensions) {
-        // The naming convention (metricName.dimensionName.dimensionValue.dimensionName.dimensionValue...) is mentioned
-        // the Graphene docs here https://wiki.sc-corp.net/display/METRICS/Graphene
-        // TODO: find explicit documentation of the API, if it exists.
-        const serializedDimensions = dimensions
-            ? `.${Array.from(dimensions.entries())
-                .map((d) => d.join(DIMENSION_DELIMITER))
-                .join(DIMENSION_DELIMITER)}`
-            : "";
-        return this.metricsHandler({
-            name: `${name}${serializedDimensions}`,
-            timestamp: new Date(),
-            metric,
-        });
-    }
-}
-/**
- * @internal
- */
-export const operationalMetricReporterFactory = Injectable("operationalMetricsReporter", [metricsHandlerFactory.token, pageVisibilityFactory.token, configurationToken], (metricsHandler, pageVisibility, configuration) => {
-    const handler = new HandlerChainBuilder(metricsHandler)
-        .map(createMappingHandler((metrics) => {
-        const request = { metrics };
-        return new Request(
-        // eslint-disable-next-line max-len
-        `https://${configuration.apiHostname}/com.snap.camerakit.v3.Metrics/metrics/operational_metrics`, {
-            method: "POST",
-            body: JSON.stringify(SetOperationalMetricsRequest.toJSON(request)),
-            credentials: "include",
-            // When this is true it makes fetch behave like `Navigator.sendBeacon` – that is, the
-            // request will still be made even if the page terminates.
-            // https://developer.mozilla.org/en-US/docs/Web/API/fetch
-            keepalive: pageVisibility.isDuringVisibilityTransition("hidden"),
-        });
-    }, pageVisibility))
-        .map(createBatchingHandler({
-        // The batching logic here is very simple – it could be improved by e.g.
-        // computing statistics to reduce overall data sent, etc. Right now this is
-        // premature optimization, but could become a good idea in the future.
-        batchReduce: (previousBundle, metric) => {
-            var _a, _b;
-            let metrics = [...((_a = previousBundle === null || previousBundle === void 0 ? void 0 : previousBundle.metrics) !== null && _a !== void 0 ? _a : [])];
-            // For "count" metrics, it's straightforward to merge them into
-            // a single metric with the same name.
-            const existingCountIndex = ((_b = metric.metric) === null || _b === void 0 ? void 0 : _b.$case) === "count"
-                ? metrics.findIndex((m) => { var _a; return metric.name === m.name && ((_a = m.metric) === null || _a === void 0 ? void 0 : _a.$case) === "count"; })
-                : -1;
-            if (existingCountIndex >= 0) {
-                // Safety: Given the condition above, we can be sure that both the existing and new metrics
-                // are of the "count" type.
-                const existingValue = metrics[existingCountIndex].metric;
-                const newValue = metric.metric;
-                metrics.splice(existingCountIndex, 1, Object.assign(Object.assign({}, metric), { metric: {
-                        $case: "count",
-                        count: existingValue.count + newValue.count,
-                    } }));
-            }
-            else {
-                metrics.push(metric);
-            }
-            return { metrics };
-        },
-        isBatchComplete: (bundle) => bundle.metrics.length >= METRIC_BATCH_MAX_SIZE,
-        maxBatchAge: METRIC_BATCH_MAX_AGE_MS,
-        pageVisibility,
-    })).handler;
-    return new OperationalMetricsReporter(handler);
-});
-//# sourceMappingURL=operationalMetricsReporter.js.map

package/lib/metrics/operational/operationalMetricsReporter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"operationalMetricsReporter.js","sourceRoot":"","sources":["../../../src/metrics/operational/operationalMetricsReporter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAEnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAKvE,OAAO,EAAE,4BAA4B,EAAE,MAAM,uDAAuD,CAAC;AACrG,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAkB,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAA0B,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAMjF,qCAAqC;AACrC,yGAAyG;AAEzG,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAEhC,qDAAqD;AACrD,kHAAkH;AAClH,iFAAiF;AACjF,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAClC,MAAM,uBAAuB,GAAG,IAAI,CAAC;AAErC;;;GAGG;AACH,gBAAgB;AAChB,MAAM,OAAO,0BAA0B;IACnC,YAA6B,cAA8B;QAA9B,mBAAc,GAAd,cAAc,CAAgB;IAAG,CAAC;IAE/D;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAY,EAAE,KAAa,EAAE,UAAgC;QAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAY,EAAE,aAAqB,EAAE,UAAgC;QACvE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,EAAE,UAAU,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAY,EAAE,SAAiB,EAAE,UAAgC;QACvE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACG,MAAM,CAAC,MAAc;;YACvB,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACjG,CAAC;KAAA;IAEO,MAAM,CACV,IAAY,EACZ,MAA6C,EAC7C,UAAyC;QAEzC,+GAA+G;QAC/G,2EAA2E;QAC3E,8DAA8D;QAC9D,MAAM,oBAAoB,GAAG,UAAU;YACnC,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;iBAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;iBACvC,IAAI,CAAC,mBAAmB,CAAC,EAAE;YAClC,CAAC,CAAC,EAAE,CAAC;QAET,OAAO,IAAI,CAAC,cAAc,CAAC;YACvB,IAAI,EAAE,GAAG,IAAI,GAAG,oBAAoB,EAAE;YACtC,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,MAAM;SACT,CAAC,CAAC;IACP,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,UAAU,CACtD,4BAA4B,EAC5B,CAAC,qBAAqB,CAAC,KAAK,EAAE,qBAAqB,CAAC,KAAK,EAAE,kBAAkB,CAAU,EACvF,CAAC,cAA4B,EAAE,cAA8B,EAAE,aAAqC,EAAE,EAAE;IACpG,MAAM,OAAO,GAAG,IAAI,mBAAmB,CAAC,cAAc,CAAC;SAClD,GAAG,CACA,oBAAoB,CAAC,CAAC,OAAiC,EAAE,EAAE;QACvD,MAAM,OAAO,GAAiC,EAAE,OAAO,EAAE,CAAC;QAC1D,OAAO,IAAI,OAAO;QACd,mCAAmC;QACnC,WAAW,aAAa,CAAC,WAAW,4DAA4D,EAChG;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAClE,WAAW,EAAE,SAAS;YAEtB,qFAAqF;YACrF,0DAA0D;YAC1D,yDAAyD;YACzD,SAAS,EAAE,cAAc,CAAC,4BAA4B,CAAC,QAAQ,CAAC;SACnE,CACJ,CAAC;IACN,CAAC,EAAE,cAAc,CAAC,CACrB;SACA,GAAG,CACA,qBAAqB,CAAC;QAClB,wEAAwE;QACxE,2EAA2E;QAC3E,sEAAsE;QACtE,WAAW,EAAE,CAAC,cAAoD,EAAE,MAAyB,EAAE,EAAE;;YAC7F,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,OAAO,mCAAI,EAAE,CAAC,CAAC,CAAC;YAEnD,+DAA+D;YAC/D,sCAAsC;YACtC,MAAM,kBAAkB,GACpB,CAAA,MAAA,MAAM,CAAC,MAAM,0CAAE,KAAK,MAAK,OAAO;gBAC5B,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,WAAC,OAAA,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,CAAA,MAAA,CAAC,CAAC,MAAM,0CAAE,KAAK,MAAK,OAAO,CAAA,EAAA,CAAC;gBACjF,CAAC,CAAC,CAAC,CAAC,CAAC;YACb,IAAI,kBAAkB,IAAI,CAAC,EAAE;gBACzB,2FAA2F;gBAC3F,2BAA2B;gBAC3B,MAAM,aAAa,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAA0B,CAAC;gBAC7E,MAAM,QAAQ,GAAG,MAAM,CAAC,MAA0B,CAAC;gBACnD,OAAO,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,kCAC7B,MAAM,KACT,MAAM,EAAE;wBACJ,KAAK,EAAE,OAAO;wBACd,KAAK,EAAE,aAAa,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK;qBAC9C,IACH,CAAC;aACN;iBAAM;gBACH,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACxB;YAED,OAAO,EAAE,OAAO,EAAE,CAAC;QACvB,CAAC;QACD,eAAe,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,qBAAqB;QAC3E,WAAW,EAAE,uBAAuB;QACpC,cAAc;KACjB,CAAC,CACL,CAAC,OAAO,CAAC;IAEd,OAAO,IAAI,0BAA0B,CAAC,OAAO,CAAC,CAAC;AACnD,CAAC,CACJ,CAAC","sourcesContent":["import { Injectable } from \"../../dependency-injection/Injectable\";\nimport { FetchHandler } from \"../../handlers/defaultFetchHandler\";\nimport { HandlerChainBuilder } from \"../../handlers/HandlerChainBuilder\";\nimport { createBatchingHandler } from \"../../handlers/batchingHandler\";\nimport {\n    OperationalMetric,\n    OperationalMetricsBundle,\n} from \"../../generated-proto/pb_schema/camera_kit/v3/operational_metrics\";\nimport { SetOperationalMetricsRequest } from \"../../generated-proto/pb_schema/camera_kit/v3/service\";\nimport { createMappingHandler } from \"../../handlers/mappingHandler\";\nimport { PageVisibility, pageVisibilityFactory } from \"../../common/pageVisibility\";\nimport { metricsHandlerFactory } from \"../metricsHandler\";\nimport { CameraKitConfiguration, configurationToken } from \"../../configuration\";\nimport { Metric } from \"./Metric\";\n\ntype MetricsHandler = (metric: OperationalMetric) => Promise<void>;\ntype CountMetricValue = Extract<OperationalMetric[\"metric\"], { $case: \"count\" }>;\n\n// CameraKit's prod metrics endpoint.\n// See: https://github.sc-corp.net/Snapchat/pb_schema/blob/c390b9c/proto/camera_kit/v3/service.proto#L126\n\nconst DIMENSION_DELIMITER = \".\";\n\n// These values are (currently) arbitrarily selected.\n// TODO: Once we have gathered a sufficient quantity of metrics data, we should tune these numbers to ensure we're\n// operating with the right cost vs. alarming SLA vs. IDB storage size tradeoffs.\nconst METRIC_BATCH_MAX_SIZE = 100;\nconst METRIC_BATCH_MAX_AGE_MS = 5000;\n\n/**\n * Use this class to report operational metrics – these are metrics that describe aspects of the SDK's performance,\n * which may be used to assess and investigate operational issues.\n */\n/** @internal */\nexport class OperationalMetricsReporter {\n    constructor(private readonly metricsHandler: MetricsHandler) {}\n\n    /**\n     * Record a count.\n     *\n     * @param name\n     * @param count\n     * @param dimensions An optional Map containing dimensions which describe the metric.\n     * For example: `new Map([['status', '200']])`\n     * @returns Promise which resolves when the metric has been handled.\n     */\n    count(name: string, count: number, dimensions?: Map<string, string>): Promise<void> {\n        return this.record(name, { $case: \"count\", count }, dimensions);\n    }\n\n    /**\n     * Record a duration in milliseconds.\n     *\n     * @param name\n     * @param latencyMillis\n     * @param dimensions An optional Map containing dimensions which describe the metric.\n     * For example: `new Map([['status', '200']])`\n     * @returns Promise which resolves when the metric has been handled.\n     */\n    timer(name: string, latencyMillis: number, dimensions?: Map<string, string>): Promise<void> {\n        return this.record(name, { $case: \"latencyMillis\", latencyMillis }, dimensions);\n    }\n\n    /**\n     * Record a histogram.\n     *\n     * @param name\n     * @param histogram\n     * @param dimensions An optional Map containing dimensions which describe the metric.\n     * For example: `new Map([['status', '200']])`\n     * @returns Promise which resolves when the metric has been handled.\n     */\n    histogram(name: string, histogram: number, dimensions?: Map<string, string>): Promise<void> {\n        return this.record(name, { $case: \"histogram\", histogram }, dimensions);\n    }\n\n    /**\n     * TODO: This entire class in no longer necessary, since the new Timer/Count/Histogram classes offer a cleaner API\n     * for recording metrics. Once we migrate all operational metrics to use those new APIs, this class can be removed\n     * and call sites will just call the metrics handler directly.\n     *\n     * @param metric Any concrete Metric (e.g. Count, Timer, Histogram)\n     * @returns\n     */\n    async report(metric: Metric): Promise<void> {\n        await Promise.all(metric.toOperationalMetric().map((metric) => this.metricsHandler(metric)));\n    }\n\n    private record(\n        name: string,\n        metric: Required<OperationalMetric>[\"metric\"],\n        dimensions?: Map<string, string | number>\n    ): Promise<void> {\n        // The naming convention (metricName.dimensionName.dimensionValue.dimensionName.dimensionValue...) is mentioned\n        // the Graphene docs here https://wiki.sc-corp.net/display/METRICS/Graphene\n        // TODO: find explicit documentation of the API, if it exists.\n        const serializedDimensions = dimensions\n            ? `.${Array.from(dimensions.entries())\n                  .map((d) => d.join(DIMENSION_DELIMITER))\n                  .join(DIMENSION_DELIMITER)}`\n            : \"\";\n\n        return this.metricsHandler({\n            name: `${name}${serializedDimensions}`,\n            timestamp: new Date(),\n            metric,\n        });\n    }\n}\n\n/**\n * @internal\n */\nexport const operationalMetricReporterFactory = Injectable(\n    \"operationalMetricsReporter\",\n    [metricsHandlerFactory.token, pageVisibilityFactory.token, configurationToken] as const,\n    (metricsHandler: FetchHandler, pageVisibility: PageVisibility, configuration: CameraKitConfiguration) => {\n        const handler = new HandlerChainBuilder(metricsHandler)\n            .map(\n                createMappingHandler((metrics: OperationalMetricsBundle) => {\n                    const request: SetOperationalMetricsRequest = { metrics };\n                    return new Request(\n                        // eslint-disable-next-line max-len\n                        `https://${configuration.apiHostname}/com.snap.camerakit.v3.Metrics/metrics/operational_metrics`,\n                        {\n                            method: \"POST\",\n                            body: JSON.stringify(SetOperationalMetricsRequest.toJSON(request)),\n                            credentials: \"include\",\n\n                            // When this is true it makes fetch behave like `Navigator.sendBeacon` – that is, the\n                            // request will still be made even if the page terminates.\n                            // https://developer.mozilla.org/en-US/docs/Web/API/fetch\n                            keepalive: pageVisibility.isDuringVisibilityTransition(\"hidden\"),\n                        }\n                    );\n                }, pageVisibility)\n            )\n            .map(\n                createBatchingHandler({\n                    // The batching logic here is very simple – it could be improved by e.g.\n                    // computing statistics to reduce overall data sent, etc. Right now this is\n                    // premature optimization, but could become a good idea in the future.\n                    batchReduce: (previousBundle: OperationalMetricsBundle | undefined, metric: OperationalMetric) => {\n                        let metrics = [...(previousBundle?.metrics ?? [])];\n\n                        // For \"count\" metrics, it's straightforward to merge them into\n                        // a single metric with the same name.\n                        const existingCountIndex =\n                            metric.metric?.$case === \"count\"\n                                ? metrics.findIndex((m) => metric.name === m.name && m.metric?.$case === \"count\")\n                                : -1;\n                        if (existingCountIndex >= 0) {\n                            // Safety: Given the condition above, we can be sure that both the existing and new metrics\n                            // are of the \"count\" type.\n                            const existingValue = metrics[existingCountIndex].metric as CountMetricValue;\n                            const newValue = metric.metric as CountMetricValue;\n                            metrics.splice(existingCountIndex, 1, {\n                                ...metric,\n                                metric: {\n                                    $case: \"count\",\n                                    count: existingValue.count + newValue.count,\n                                },\n                            });\n                        } else {\n                            metrics.push(metric);\n                        }\n\n                        return { metrics };\n                    },\n                    isBatchComplete: (bundle) => bundle.metrics.length >= METRIC_BATCH_MAX_SIZE,\n                    maxBatchAge: METRIC_BATCH_MAX_AGE_MS,\n                    pageVisibility,\n                })\n            ).handler;\n\n        return new OperationalMetricsReporter(handler);\n    }\n);\n"]}

package/lib/session/index.d.ts

@@ -1 +0,0 @@
-export { Keyboard } from "./LensKeyboard";

package/lib/session/index.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.js.map

package/lib/session/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/session/index.ts"],"names":[],"mappings":"","sourcesContent":["export { Keyboard } from \"./LensKeyboard\";\n"]}

package/lib/transforms/index.d.ts

@@ -1 +0,0 @@
-export * from "./Transform2D";

package/lib/transforms/index.js

@@ -1,2 +0,0 @@
-export * from "./Transform2D";
-//# sourceMappingURL=index.js.map

package/lib/transforms/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/transforms/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC","sourcesContent":["export * from \"./Transform2D\";\n"]}