WebExtensionsのtabs.sendMessageが動かない

Question

###前提・実現したいこと
WebExtensionsでyoutubeの動画を新しいウインドウで開くアドオンを作っています。
なぜか最初にインストールした時だけbrowser.tabs.sendMessageがエラーを出します。ブラウザーを再起動すると直ります。これはバグなんでしょうかそれとも僕の書き方が悪いんでしょうか。

###発生している問題・エラーメッセージ

Error: Error: Could not establish connection. Receiving end does not exist.  YouTube-background.js:2:3
	onError moz-extension://31a62720-6f34-4d04-9287-0b9c07dc7cf3/YouTube-background.js:2:3
	(非同期: promise callback)
	newWindow/< moz-extension://31a62720-6f34-4d04-9287-0b9c07dc7cf3/YouTube-background.js:10:5
	(非同期: promise callback)
	newWindow moz-extension://31a62720-6f34-4d04-9287-0b9c07dc7cf3/YouTube-background.js:8:3
	onGot/</< moz-extension://31a62720-6f34-4d04-9287-0b9c07dc7cf3/YouTube-background.js:39:9
	(非同期: promise callback)
	onGot/< moz-extension://31a62720-6f34-4d04-9287-0b9c07dc7cf3/YouTube-background.js:38:7
	(非同期: promise callback)
	onGot moz-extension://31a62720-6f34-4d04-9287-0b9c07dc7cf3/YouTube-background.js:25:5
	(非同期: promise callback)
	getInfoForTab moz-extension://31a62720-6f34-4d04-9287-0b9c07dc7cf3/YouTube-background.js:48:5
	(非同期: promise callback)
	<匿名関数> moz-extension://31a62720-6f34-4d04-9287-0b9c07dc7cf3/YouTube-background.js:54:3

###該当のソースコード
manifest.json

{
    "manifest_version": 2,
    "name": "YouTube Popup Panel",
    "version": "1.2",
    "applications": {
        "gecko": {
            "id": "[e-mail]"
        }
    },
    "description": "__MSG_extensionDescription__",
    "default_locale": "en",
    "background": {
        "scripts": ["YouTube-background.js"]
    },
    "page_action": {
        "default_icon": "icons/page-32.png",
        "default_title": "Popup"
    },
    "icons": {
        "48": "icons/page-48.png",
        "64": "icon/page-64.png"
    },
    "permissions": [
        "storage",
        "tabs"
    ],
    "options_ui": {
        "page": "options/options.html"
    }
}

background

function onError(error) {
  console.error(`Error: ${error}`);
}

function newWindow(YouTubeURL) {
  const videoID = YouTubeURL.slice(32);
  const querying = browser.tabs.query({currentWindow: true, active: true});
  querying.then((tabs) => {
    console.log(tabs[0].id);
    browser.tabs.sendMessage(tabs[0].id, {URL: videoID}).catch(onError);
  });
  /* browser.windows.onCreated.addListener(() => {
  });
  browser.windows.onCreated.removeListener(newWindow); */
}

function onGot(tabInfo) {
  const YouTubewatchURL = 'https://www.youtube.com/watch';
  if (tabInfo.url.match(YouTubewatchURL)) {
    let width = 960;
    let height = 540;
    const gettingWidth = browser.storage.local.get('width');
    const gettingHeight = browser.storage.local.get('height');
    const popupURL = browser.extension.getURL('popup/popup.html');
    Promise.all([gettingWidth, gettingHeight]).then(results => {
      if (results[0] && results[0].width) {
        width = parseInt(results[0].width, 10);
      }
      if (results[1] && results[1].height) {
        height = parseInt(results[1].height, 10);
      }
      const creating = browser.windows.create({
        url: popupURL,
        type: 'panel',
        width: width,
        height: height,
      });
      creating.then(() => {
        newWindow(tabInfo.url);
      });
    });
  }
}

function getInfoForTab(tabs) {
  if (tabs.length > 0) {
    const gettingInfo = browser.tabs.get(tabs[0].id);
    gettingInfo.then(onGot);
  }
}

browser.pageAction.onClicked.addListener(() => {
  const querying = browser.tabs.query({currentWindow: true, active: true});
  querying.then(getInfoForTab);
});

function updateActiveTab(tabs) {
  function onGot(tabInfo) {
    const YouTubewatchURL = 'https://www.youtube.com/watch';
    if (tabInfo.url.match(YouTubewatchURL)) {
      browser.pageAction.show(tabs);
    }
  }
  const gettingInfo = browser.tabs.get(tabs);
  gettingInfo.then(onGot);
}
// listen to tab URL changes
browser.tabs.onUpdated.addListener((tabId, changeInfo) => {
  if (changeInfo.status === 'complete') {
    console.log(tabId);
    updateActiveTab(tabId);
  }
});
// listen to tab switching
browser.tabs.onActivated.addListener((activeInfo) => {
  updateActiveTab(activeInfo.tabId);
});

新しいウインドウのhtmlが読み込んでるjs

browser.runtime.onMessage.addListener(getURL);

###試したこと
エラーを調べてみたけれどわからなかった。

###補足情報(言語/FW/ツール等のバージョンなど)
firefox developer edition 54.0a2
firefox 64bit 52.0

Comments

[turbgraphics200]

manifest.jsonも期先してください

[turbgraphics200]

onGot()はどのタイミングで呼ばれるのでしょうか

[nekojiro]

tabs.onUpdated.addListenerとonActivated.addListenerのどちらかが作動したらです。コードを全部乗せたほうがいいですか？

[turbgraphics200]

できれば全部載せてください。

[turbgraphics200]

ううむ、私の環境では再現しませんね。(Win10, FF52 DE54.0a2)

[nekojiro]

firefox52で新しいプロファイルを作ってインストールしてみたらブラウザーコンソールで同じエラーが出ました。一応アドオンのURL書いておきますね。https://addons.mozilla.org/ja/firefox/addon/youtube-popup-panel/

[turbgraphics200]

ううむ、URLからインストールしてみましたが、やはり私の環境では再現しませんでした。

Answer 1

そのエラーは、 sendMessage を送る先で browser.runtime.onMessage.addListener が設定されていないときにおきます。

例えば、

browser.pageAction.onClicked.addListener(async _ => {
	const tabs = await browser.tabs.query({currentWindow: true, active: true})
	const tabid = tabs[0].id
	browser.tabs.sendMessage(tabid , {data: 100})
		.then(e => console.log(e)).catch(e => console.error(e))
	// Error: Could not establish connection. Receiving end does not exist.
})

これだけで 送り先のタブで何も設定していないとエラーが発生します

Error: Could not establish connection. Receiving end does not exist.

送り先で設定されていると

browser.pageAction.onClicked.addListener(async _ => {
	const tabs = await browser.tabs.query({currentWindow: true, active: true})
	const tabid = tabs[0].id
	await browser.tabs.executeScript(tabid, {
		code: `
			browser.runtime.onMessage.addListener(async request => {
				console.log(request)
				return {response: "ok"}
			})
		`
	})
	browser.tabs.sendMessage(tabid, {data: 100})
		.then(e => console.log(e)).catch(e => console.error(e))
	// Object { response: "ok" }
})

このように browser.runtime.onMessage.addListener での返り値を受け取れます。

今回の場合、 tabid は拡張機能の popup.html のものになるかと思いますので、 JavaScript を埋め込む必要はなく、 popup.html でこんな風に browser.runtime.onMessage.addListener を設定すればいいです。

<!doctype html>
<meta charset="utf-8"/>

<script src="popup.js"></script>

[popup.js]

browser.runtime.onMessage.addListener(async request => {
	console.log(request)
	return {response: "ok"}
})

ただ、今のコードだと sendMessage のタイミングではまだ開いてページのロードが完了していないようで、 about:blank となっていました。

browser.runtime.onMessage.addListener が正しく設定できているならロード済みになるのを待ってから sendMessage するだけで動くのではと思います。

あと、たしか拡張機能のページだと tabs でなく runtime で通信できたと思います。（Chrome では。Firefoxは試してないです）

---

コピペの影響でコードに統一性がなかったのでちょっと修正しました

Comments

[nekojiro]

asyncを付けても動きませんでした。

[nekojiro]

browser.tabs.onUpdated.addListener((tabId, changeInfo) => {
if (changeInfo.status === 'complete') {
const querying = browser.tabs.query({currentWindow: true, active: true});
querying.then((tabs) => {
browser.tabs.sendMessage(tabs[0].id, {URL: videoID}).catch(onError);
});
}
});
browser.tabs.onUpdated.removeListener;
ページのロードを待ったら動きました。ありがとうございます。