extension-runtime.test.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. import test from 'node:test';
  2. import assert from 'node:assert/strict';
  3. import { JSDOM } from 'jsdom';
  4. import { createBackgroundRuntime } from '../extension/background-runtime.js';
  5. import { installContentRuntime } from '../extension/content-runtime.js';
  6. import { DEFAULT_CONFIG, publicConfig } from '../extension/config.js';
  7. const extensionId = 'runtime-test';
  8. const settings = { ...DEFAULT_CONFIG, enabled: true, accountId: 'work', token: 'test-local-secret', selectors: {} };
  9. const trusted = { id: extensionId, url: `chrome-extension://${extensionId}/options.html` };
  10. const tab = { id: 17, url: 'https://teams.cloud.microsoft/', active: true };
  11. const pageSender = { id: extensionId, frameId: 0, url: tab.url, tab };
  12. const event = () => {
  13. const listeners = new Set();
  14. return { listeners, addListener: listener => listeners.add(listener), removeListener: listener => listeners.delete(listener) };
  15. };
  16. function backgroundFixture({ failInjection = false, saved = settings } = {}) {
  17. const local = { config: structuredClone(saved) }, requests = [], injections = [], messages = [];
  18. let attached = false, configError = '';
  19. const chrome = {
  20. storage: { local: { setAccessLevel: async () => {}, get: async key => ({ [key]: structuredClone(local[key]) }), set: async values => Object.assign(local, structuredClone(values)) } },
  21. runtime: { id: extensionId, getURL: path => `chrome-extension://${extensionId}/${path}`, getManifest: () => ({ version: '0.1.1' }), onMessage: event(), onInstalled: event() },
  22. tabs: { query: async () => [tab, { id: 19, url: 'https://example.com/' }], get: async () => tab, sendMessage: async (id, message, options) => {
  23. messages.push({ id, message, options });
  24. if (!attached) throw new Error('Receiving end does not exist');
  25. if (message.type === 'CONFIG_CHANGED' && configError) return { ok: false, error: configError };
  26. return message.type === 'PROBE' ? { ok: true, ready: true, runtimeError: '' } : { ok: true };
  27. } },
  28. scripting: { executeScript: async options => { injections.push(options); if (failInjection) throw new Error('Access denied'); attached = true; } }
  29. };
  30. const background = createBackgroundRuntime({ chrome, sleep: async () => {}, fetch: async (url, options) => { requests.push({ url, ...options, body: JSON.parse(options.body) }); return { ok: true }; } });
  31. return { background, chrome, local, requests, injections, messages, failConfig: value => { configError = value; } };
  32. }
  33. function contentFixture({ send, collect } = {}) {
  34. const dom = new JSDOM('<html><body><main>Loading</main></body></html>', { url: tab.url });
  35. const messages = [], listeners = event(), scope = {}, timers = new Map();
  36. let timerId = 0, intervals = 0, observers = 0;
  37. dom.window.setTimeout = fn => { timers.set(++timerId, fn); return timerId; };
  38. dom.window.clearTimeout = id => timers.delete(id);
  39. dom.window.setInterval = () => { intervals++; return ++timerId; };
  40. dom.window.clearInterval = () => {};
  41. dom.window.MutationObserver = class { constructor() { observers++; } observe() {} disconnect() {} };
  42. const chrome = { runtime: { id: extensionId, onMessage: listeners, sendMessage: async message => {
  43. messages.push(message);
  44. if (send) return send(message);
  45. return message.type === 'GET_CONFIG' ? { ok: true, config: publicConfig(settings) } : { ok: true };
  46. } } };
  47. const dependencies = { chrome, window: dom.window, document: dom.window.document, scope, ...(collect ? { collect } : {}) };
  48. const runtime = installContentRuntime(dependencies);
  49. const message = input => new Promise(resolve => {
  50. const listener = [...listeners.listeners][0];
  51. assert.equal(listener(input, { id: extensionId }, resolve), true);
  52. });
  53. return { runtime, dependencies, messages, message, listeners, timers, counts: () => ({ intervals, observers }), close: () => { scope.__teamsLocalCollectorRuntime?.dispose(); dom.window.close(); } };
  54. }
  55. test('saving enabled config probes an existing Teams tab, injects once in its top frame, then applies config and reports readiness', async () => {
  56. const fixture = backgroundFixture();
  57. const result = await fixture.background.dispatch({ type: 'SAVE_CONFIG', config: settings }, trusted);
  58. assert.deepEqual(result.connection, { teamsTabCount: 1, readyTabCount: 1, error: '' });
  59. assert.deepEqual(fixture.injections, [{ target: { tabId: tab.id, frameIds: [0] }, files: ['content.js'] }]);
  60. assert.deepEqual(fixture.messages.map(item => item.message.type), ['PROBE', 'PROBE', 'CONFIG_CHANGED']);
  61. assert.ok(fixture.messages.every(item => item.options.frameId === 0));
  62. const state = await fixture.background.dispatch({ type: 'GET_STATE' }, trusted);
  63. assert.equal(state.readyTabCount, 1); assert.equal(fixture.injections.length, 1);
  64. assert.equal(fixture.requests.at(-1).url, 'http://127.0.0.1:4318/api/extension/status');
  65. assert.equal(fixture.requests.at(-1).headers.Authorization, 'Bearer test-local-secret');
  66. assert.doesNotMatch(JSON.stringify(fixture.requests.at(-1).body), /test-local-secret|records|Loading/);
  67. });
  68. test('startup and installation repair already-open tabs and register a working async runtime message listener', async () => {
  69. const fixture = backgroundFixture();
  70. fixture.background.start(); fixture.background.start();
  71. await new Promise(resolve => setImmediate(resolve));
  72. assert.equal(fixture.injections.length, 1);
  73. assert.equal(fixture.chrome.runtime.onMessage.listeners.size, 1);
  74. assert.equal(fixture.chrome.runtime.onInstalled.listeners.size, 1);
  75. [...fixture.chrome.runtime.onInstalled.listeners][0]();
  76. const response = await new Promise(resolve => {
  77. assert.equal([...fixture.chrome.runtime.onMessage.listeners][0]({ type: 'GET_STATE' }, trusted, resolve), true);
  78. });
  79. assert.equal(response.ok, true); assert.equal(response.readyTabCount, 1); assert.equal(fixture.injections.length, 1);
  80. });
  81. test('injection and page configuration failures remain visible after saving without discarding enabled settings', async () => {
  82. const fixture = backgroundFixture({ failInjection: true });
  83. const result = await fixture.background.dispatch({ type: 'SAVE_CONFIG', config: settings }, trusted);
  84. assert.equal(result.ok, true); assert.equal(result.connection.readyTabCount, 0);
  85. assert.match(result.connection.error, /网站访问权限/);
  86. assert.equal(fixture.local.config.enabled, true); assert.match(fixture.local.status.connectionError, /网站访问权限/);
  87. assert.match(fixture.requests.at(-1).body.error, /网站访问权限/);
  88. const second = backgroundFixture(); second.failConfig('页面未能读取配置');
  89. const failed = await second.background.dispatch({ type: 'SAVE_CONFIG', config: settings }, trusted);
  90. assert.match(failed.connection.error, /页面未能读取配置/);
  91. second.failConfig('');
  92. const repaired = await second.background.dispatch({ type: 'RECONNECT' }, trusted);
  93. assert.equal(repaired.connection.error, ''); assert.equal(repaired.readyTabCount, 1);
  94. });
  95. test('CAPTURE validation errors are recorded and diagnostic reporting always uses saved credentials', async () => {
  96. const fixture = backgroundFixture();
  97. await assert.rejects(fixture.background.dispatch({ type: 'CAPTURE', accountId: 'wrong', records: [], page: { url: tab.url } }, pageSender), /账号/);
  98. assert.match(fixture.local.status.lastError, /账号/);
  99. assert.match(fixture.requests.at(-1).body.error, /账号/);
  100. await assert.rejects(fixture.background.dispatch({ type: 'SAVE_CONFIG', config: { ...settings, port: 0, token: 'unsaved-secret' } }, trusted), /端口/);
  101. assert.deepEqual(fixture.local.config, settings);
  102. assert.ok(fixture.requests.every(request => request.headers.Authorization === 'Bearer test-local-secret'));
  103. await assert.rejects(fixture.background.ensureContentScript({ id: 22, url: 'https://example.com/' }), /Teams/);
  104. assert.equal(fixture.injections.length, 0);
  105. const repaired = await fixture.background.dispatch({ type: 'SAVE_CONFIG', config: settings }, trusted);
  106. assert.equal(repaired.connection.error, ''); assert.equal(fixture.local.status.lastError, '');
  107. assert.equal(fixture.requests.at(-1).body.error, '');
  108. });
  109. test('page runtime errors returned by PROBE are visible even when its earlier diagnostic message failed', async () => {
  110. const fixture = backgroundFixture();
  111. fixture.chrome.tabs.sendMessage = async () => ({ ok: true, ready: true, runtimeError: '页面解析失败' });
  112. const response = await fixture.background.dispatch({ type: 'GET_STATE' }, trusted);
  113. assert.equal(response.readyTabCount, 1); assert.equal(response.status.runtimeError, '页面解析失败');
  114. assert.equal(fixture.requests.at(-1).body.error, '页面解析失败');
  115. fixture.chrome.tabs.sendMessage = async () => ({ ok: true, ready: true, runtimeError: '' });
  116. const recovered = await fixture.background.dispatch({ type: 'GET_STATE' }, trusted);
  117. assert.equal(recovered.status.runtimeError, ''); assert.equal(fixture.requests.at(-1).body.error, '');
  118. });
  119. test('duplicate content initialization reuses one observer, heartbeat timer and listener; empty pages still send CAPTURE', async () => {
  120. const fixture = contentFixture();
  121. try {
  122. const duplicate = installContentRuntime(fixture.dependencies);
  123. assert.equal(duplicate, fixture.runtime);
  124. await fixture.runtime.ready;
  125. assert.deepEqual(fixture.counts(), { intervals: 1, observers: 1 });
  126. assert.equal(fixture.listeners.listeners.size, 1);
  127. await fixture.runtime.scan();
  128. const captures = fixture.messages.filter(message => message.type === 'CAPTURE');
  129. assert.equal(captures.length, 1); assert.deepEqual(captures[0].records, []);
  130. assert.equal(captures[0].page.signedIn, null);
  131. assert.equal((await fixture.message({ type: 'PROBE' })).ready, true);
  132. assert.doesNotMatch(JSON.stringify(fixture.messages), /test-local-secret/);
  133. } finally { fixture.close(); }
  134. });
  135. test('PROBE waits for async content initialization and does not falsely report a missing script', async () => {
  136. let release;
  137. const configReady = new Promise(resolve => { release = resolve; });
  138. const fixture = contentFixture({ send: async message => message.type === 'GET_CONFIG' ? configReady : { ok: true } });
  139. try {
  140. let responded = false;
  141. const result = fixture.message({ type: 'PROBE' }).then(reply => { responded = true; return reply; });
  142. await Promise.resolve(); assert.equal(responded, false);
  143. release({ ok: true, config: publicConfig(settings) });
  144. assert.equal((await result).ready, true);
  145. assert.deepEqual(fixture.counts(), { intervals: 1, observers: 1 });
  146. } finally { fixture.close(); }
  147. });
  148. test('initialization errors are reported and reinjection can replace a failed instance', async () => {
  149. let fail = true;
  150. const fixture = contentFixture({ send: async message => message.type === 'GET_CONFIG' ? (fail ? { ok: false, error: '配置格式无效' } : { ok: true, config: publicConfig(settings) }) : { ok: true } });
  151. try {
  152. await assert.rejects(fixture.runtime.ready, /配置格式无效/);
  153. assert.equal((await fixture.message({ type: 'PROBE' })).ok, false);
  154. assert.ok(fixture.messages.some(message => message.type === 'REPORT_STATUS' && message.runtimeError === '配置格式无效'));
  155. fail = false;
  156. const repaired = installContentRuntime(fixture.dependencies);
  157. await repaired.ready;
  158. assert.notEqual(repaired, fixture.runtime); assert.equal(fixture.listeners.listeners.size, 1);
  159. assert.equal((await fixture.message({ type: 'PROBE' })).ready, true);
  160. } finally { fixture.close(); }
  161. });
  162. test('rejected capture stays in the content queue, reports failure, and clears the error only after successful retry', async () => {
  163. let fail = true;
  164. const fixture = contentFixture({ send: async message => {
  165. if (message.type === 'GET_CONFIG') return { ok: true, config: publicConfig(settings) };
  166. if (message.type === 'CAPTURE' && fail) return { ok: false, error: '来源页面不匹配' };
  167. return { ok: true };
  168. } });
  169. try {
  170. await fixture.runtime.ready;
  171. fixture.dependencies.document.body.innerHTML = '<article data-message-id="m1"><div data-tid="message-body">Message</div></article>';
  172. await fixture.runtime.scan();
  173. const errorStatus = fixture.messages.filter(message => message.type === 'REPORT_STATUS').at(-1);
  174. assert.equal(errorStatus.runtimeError, '来源页面不匹配'); assert.equal(errorStatus.pending, 1);
  175. fail = false; await fixture.runtime.scan();
  176. const successStatus = fixture.messages.filter(message => message.type === 'REPORT_STATUS').at(-1);
  177. assert.equal(successStatus.runtimeError, ''); assert.equal(successStatus.pending, 0);
  178. assert.equal(fixture.messages.filter(message => message.type === 'CAPTURE').length, 2);
  179. } finally { fixture.close(); }
  180. });