@shopware-ag/meteor-admin-sdk
Version:
The Meteor SDK for the Shopware Administration.
209 lines • 11.2 kB
JavaScript
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
(function (factory) {
if (typeof module === "object" && typeof module.exports === "object") {
var v = factory(require, exports);
if (v !== undefined) module.exports = v;
}
else if (typeof define === "function" && define.amd) {
define(["require", "exports", "./index"], factory);
}
})(function (require, exports) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const index_1 = require("./index");
const mockSend = jest.fn();
jest.mock('../channel', () => ({
createSender: () => (...args) => mockSend(...args),
}));
describe('telemetry', () => {
beforeEach(() => {
mockSend.mockReset();
mockSend.mockResolvedValue(undefined);
});
describe('dispatch', () => {
it('is a function', () => {
expect(typeof index_1.dispatch).toBe('function');
});
});
describe('trackPageView', () => {
it('dispatches page_viewed with the correct property names', () => __awaiter(void 0, void 0, void 0, function* () {
yield (0, index_1.trackPageView)({
sw_route_from_href: '/dashboard',
sw_route_from_name: 'sw.dashboard.index',
sw_route_to_href: '/products',
sw_route_to_name: 'sw.product.index',
});
expect(mockSend).toHaveBeenCalledWith({
event: 'page_viewed',
data: {
sw_route_from_href: '/dashboard',
sw_route_from_name: 'sw.dashboard.index',
sw_route_to_href: '/products',
sw_route_to_name: 'sw.product.index',
},
});
}));
it('includes sw_route_to_query when provided', () => __awaiter(void 0, void 0, void 0, function* () {
yield (0, index_1.trackPageView)({
sw_route_from_href: '/dashboard',
sw_route_from_name: null,
sw_route_to_href: '/products',
sw_route_to_name: null,
sw_route_to_query: 'limit=25',
});
expect(mockSend).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({ sw_route_to_query: 'limit=25' }),
}));
}));
});
describe('trackLinkVisited', () => {
it('dispatches link_visited with href and internal type', () => __awaiter(void 0, void 0, void 0, function* () {
yield (0, index_1.trackLinkVisited)({ sw_link_href: '/products', sw_link_type: 'internal' });
expect(mockSend).toHaveBeenCalledWith({
event: 'link_visited',
data: { sw_link_href: '/products', sw_link_type: 'internal' },
});
}));
it('dispatches link_visited with external type', () => __awaiter(void 0, void 0, void 0, function* () {
yield (0, index_1.trackLinkVisited)({ sw_link_href: 'https://example.com', sw_link_type: 'external' });
expect(mockSend).toHaveBeenCalledWith({
event: 'link_visited',
data: { sw_link_href: 'https://example.com', sw_link_type: 'external' },
});
}));
});
describe('getSourceExtensionName', () => {
beforeEach(() => {
window._swsdk = Object.assign(Object.assign({}, window._swsdk), { adminExtensions: {
'my-plugin': {
baseUrl: 'http://my-plugin.localhost',
permissions: {},
},
'another-extension': {
baseUrl: 'http://another.localhost',
permissions: {},
},
} });
});
afterEach(() => {
window._swsdk = Object.assign(Object.assign({}, window._swsdk), { adminExtensions: {} });
});
it('returns the technical name for a registered extension origin', () => {
const name = (0, index_1.getSourceExtensionName)('http://my-plugin.localhost/some/path');
expect(name).toBe('my-plugin');
});
it('returns the correct name when multiple extensions are registered', () => {
const name = (0, index_1.getSourceExtensionName)('http://another.localhost');
expect(name).toBe('another-extension');
});
it('returns undefined for an unknown origin', () => {
const name = (0, index_1.getSourceExtensionName)('http://unknown.localhost');
expect(name).toBeUndefined();
});
it('returns undefined for empty string', () => {
const name = (0, index_1.getSourceExtensionName)('');
expect(name).toBeUndefined();
});
it('returns undefined for undefined', () => {
const name = (0, index_1.getSourceExtensionName)(undefined);
expect(name).toBeUndefined();
});
it('returns undefined when origin matches the admin window and no sourceWindow is given', () => {
const name = (0, index_1.getSourceExtensionName)(window.location.origin);
expect(name).toBeUndefined();
});
it('resolves a same-origin extension when sourceWindow href matches a baseUrl prefix', () => {
window._swsdk.adminExtensions['same-origin-plugin'] = {
baseUrl: `${window.location.origin}/bundles/same-origin-plugin/`,
permissions: {},
};
const fakeWindow = {
location: { href: `${window.location.origin}/bundles/same-origin-plugin/index.html` },
};
const name = (0, index_1.getSourceExtensionName)(window.location.origin, fakeWindow);
expect(name).toBe('same-origin-plugin');
});
it('returns undefined for same-origin when sourceWindow href does not match any baseUrl', () => {
const fakeWindow = {
location: { href: `${window.location.origin}/some/other/path` },
};
const name = (0, index_1.getSourceExtensionName)(window.location.origin, fakeWindow);
expect(name).toBeUndefined();
});
it('does not match an extension whose baseUrl is a string prefix of another extension baseUrl', () => {
window._swsdk.adminExtensions['plugin'] = {
baseUrl: `${window.location.origin}/bundles/plugin/`,
permissions: {},
};
window._swsdk.adminExtensions['plugin-extra'] = {
baseUrl: `${window.location.origin}/bundles/plugin-extra/`,
permissions: {},
};
const fakeWindow = {
location: { href: `${window.location.origin}/bundles/plugin-extra/index.html` },
};
const name = (0, index_1.getSourceExtensionName)(window.location.origin, fakeWindow);
expect(name).toBe('plugin-extra');
});
it('resolves when baseUrl is the exact href of the sender window (file URL pattern)', () => {
window._swsdk.adminExtensions['exact-url-plugin'] = {
baseUrl: `${window.location.origin}/admin/exact-url-plugin/index.html`,
permissions: {},
};
// The SDK appends ?location-id=... to iframe URLs; we must still resolve correctly.
const fakeWindow = {
location: { href: `${window.location.origin}/admin/exact-url-plugin/index.html?location-id=my-location` },
};
const name = (0, index_1.getSourceExtensionName)(window.location.origin, fakeWindow);
expect(name).toBe('exact-url-plugin');
});
it('resolves a same-origin extension whose baseUrl has no trailing slash', () => {
window._swsdk.adminExtensions['no-slash-plugin'] = {
baseUrl: `${window.location.origin}/bundles/no-slash-plugin`,
permissions: {},
};
const fakeWindow = {
location: { href: `${window.location.origin}/bundles/no-slash-plugin/index.html` },
};
const name = (0, index_1.getSourceExtensionName)(window.location.origin, fakeWindow);
expect(name).toBe('no-slash-plugin');
});
it('returns the most specific match when baseUrls are nested', () => {
window._swsdk.adminExtensions['parent-plugin'] = {
baseUrl: `${window.location.origin}/bundles/parent/`,
permissions: {},
};
window._swsdk.adminExtensions['child-plugin'] = {
baseUrl: `${window.location.origin}/bundles/parent/child/`,
permissions: {},
};
const fakeWindow = {
location: { href: `${window.location.origin}/bundles/parent/child/index.html` },
};
const name = (0, index_1.getSourceExtensionName)(window.location.origin, fakeWindow);
expect(name).toBe('child-plugin');
});
it('does not match an extension on the same host but a different port', () => {
window._swsdk.adminExtensions['port-plugin'] = {
baseUrl: 'http://my-plugin.localhost:8080',
permissions: {},
};
const name = (0, index_1.getSourceExtensionName)('http://my-plugin.localhost:9090');
expect(name).toBeUndefined();
});
it('does not match an extension on the same host but a different scheme', () => {
const name = (0, index_1.getSourceExtensionName)('https://my-plugin.localhost');
expect(name).toBeUndefined();
});
});
});
});
//# sourceMappingURL=index.spec.js.map