diff --git a/.changeset/strong-cats-report.md b/.changeset/strong-cats-report.md new file mode 100644 index 0000000..e5c6ac9 --- /dev/null +++ b/.changeset/strong-cats-report.md @@ -0,0 +1,8 @@ +--- +"@oneschema/importer": patch +"@oneschema/react": patch +"@oneschema/vue": patch +"@oneschema/angular": patch +--- + +Include the core importer version in initialization messages for server-side SDK telemetry. diff --git a/packages/importer/package.json b/packages/importer/package.json index b359ade..7d8c42e 100644 --- a/packages/importer/package.json +++ b/packages/importer/package.json @@ -47,7 +47,8 @@ "build": "yarn run clean && rollup -c && node ../../scripts/dual-types.mjs dist/index.d.ts", "build-test": "parcel build test/index.html", "test": "parcel serve test/index.html -p 4242 --open", - "test:ci": "true", + "test:ci": "node --test test/importer.test.cjs", + "test:unit": "yarn build && node --test test/importer.test.cjs", "fix": "eslint './src/**/**.{ts,js}' --fix", "check": "eslint './src/**/**.{ts,js}' && tsc --noEmit", "clean": "npx --yes rimraf dist" diff --git a/packages/importer/src/importer.ts b/packages/importer/src/importer.ts index ffe5479..32f1434 100644 --- a/packages/importer/src/importer.ts +++ b/packages/importer/src/importer.ts @@ -60,6 +60,7 @@ export class OneSchemaImporterClass extends EventEmitter { #client = "Importer" #version = version + #coreVersion = version #resumeTokenKey = "" /** @internal */ @@ -430,6 +431,7 @@ export class OneSchemaImporterClass extends EventEmitter { JSON.stringify({ version: this.#version, client: this.#client, + coreVersion: this.#coreVersion, "@from": `${this.#client}#${this.#version}`, "@to": IMPORTER_EMBED_MARKER, ...message, diff --git a/packages/importer/test/importer.test.cjs b/packages/importer/test/importer.test.cjs new file mode 100644 index 0000000..263f931 --- /dev/null +++ b/packages/importer/test/importer.test.cjs @@ -0,0 +1,62 @@ +const assert = require("node:assert/strict") +const { test } = require("node:test") + +const { version } = require("../package.json") +const { OneSchemaImporterClass } = require("../dist/main.js") + +function createImporter() { + global.window = { + addEventListener() {}, + removeEventListener() {}, + } + + const messages = [] + const iframe = { + contentWindow: { + postMessage(payload, targetOrigin) { + messages.push({ payload, targetOrigin }) + }, + }, + dataset: {}, + style: {}, + setAttribute() {}, + } + const importer = new OneSchemaImporterClass({ + baseUrl: "https://embed.test", + clientId: "client-id", + manageDOM: false, + templateKey: "template-key", + userJwt: "user-jwt", + }) + + importer.setIframe(iframe) + + return { iframe, importer, messages } +} + +function postInitMessage(importer, iframe, messages) { + importer.launch() + iframe.onload() + importer.close(true) + return messages[0].payload +} + +test("posts the core package version on init messages", () => { + const { iframe, importer, messages } = createImporter() + + const payload = postInitMessage(importer, iframe, messages) + + assert.equal(payload.messageType, "init") + assert.equal(payload.coreVersion, version) +}) + +test("keeps the core version separate from the wrapper identity", () => { + const { iframe, importer, messages } = createImporter() + importer.setClient("React", "0.7.4") + + const payload = postInitMessage(importer, iframe, messages) + + assert.equal(payload.version, "0.7.4") + assert.equal(payload.coreVersion, version) + assert.equal(payload["@from"], "React#0.7.4") +})