Remove leading slash from message names

This commit is contained in:
hensm
2021-04-24 04:16:20 +01:00
committed by Matt Hensman
parent e349ce5db7
commit d48efe4840
23 changed files with 207 additions and 192 deletions

View File

@@ -52,7 +52,7 @@ export default new class ShimManager {
: this.createShimFromContent(port));
shim.contentPort.postMessage({
subject: "shim:/initialized"
subject: "shim:initialized"
, data: await bridge.getInfo()
});
@@ -139,18 +139,18 @@ export default new class ShimManager {
}
private async handleContentMessage (shim: Shim, message: Message) {
const [ destination ] = message.subject.split(":/");
const [ destination ] = message.subject.split(":");
if (destination === "bridge") {
shim.bridgePort.postMessage(message);
}
switch (message.subject) {
case "main:/shimReady": {
case "main:shimReady": {
shim.requestedAppId = message.data.appId;
for (const receiver of StatusManager.getReceivers()) {
shim.contentPort.postMessage({
subject: "shim:/serviceUp"
subject: "shim:serviceUp"
, data: { id: receiver.id }
});
}
@@ -234,7 +234,7 @@ export default new class ShimManager {
* TODO: If we're closing a selector, make sure it's the
* same one that caused the session creation.
*/
case "main:/sessionCreated": {
case "main:sessionCreated": {
const selector = await ReceiverSelectorManager.getSelector();
const shouldClose = await options.get(
"receiverSelectorWaitForConnection");
@@ -252,7 +252,7 @@ export default new class ShimManager {
StatusManager.addEventListener("serviceUp", ev => {
for (const shim of this.activeShims) {
shim.contentPort.postMessage({
subject: "shim:/serviceUp"
subject: "shim:serviceUp"
, data: { id: ev.detail.id }
});
}
@@ -261,7 +261,7 @@ export default new class ShimManager {
StatusManager.addEventListener("serviceDown", ev => {
for (const shim of this.activeShims) {
shim.contentPort.postMessage({
subject: "shim:/serviceDown"
subject: "shim:serviceDown"
, data: { id: ev.detail.id }
});
}

View File

@@ -50,7 +50,7 @@ export default new class StatusManager
}
this.bridgePort.postMessage({
subject: "bridge:/stopReceiverApp"
subject: "bridge:stopReceiverApp"
, data: { receiver }
});
}
@@ -61,7 +61,7 @@ export default new class StatusManager
bridgePort.onDisconnect.addListener(this.onBridgePortDisconnect);
bridgePort.postMessage({
subject: "bridge:/initialize"
subject: "bridge:initialize"
, data: {
shouldWatchStatus: true
}
@@ -76,7 +76,7 @@ export default new class StatusManager
*/
private onBridgePortMessage (message: Message) {
switch (message.subject) {
case "main:/serviceUp": {
case "main:serviceUp": {
const { data: receiver } = message;
this.receivers.set(receiver.id, receiver);
@@ -87,7 +87,7 @@ export default new class StatusManager
break;
}
case "main:/serviceDown": {
case "main:serviceDown": {
const { data: { id }} = message;
if (this.receivers.has(id)) {
@@ -101,7 +101,7 @@ export default new class StatusManager
break;
}
case "main:/receiverStatus": {
case "main:receiverStatus": {
const { data: { id, status }} = message;
const receiver = this.receivers.get(id);

View File

@@ -57,7 +57,7 @@ export default class NativeReceiverSelector extends ReceiverSelector {
"receiverSelectorCloseIfFocusLost");
this.bridgePort.postMessage({
subject: "bridge:/receiverSelector/open"
subject: "bridge:receiverSelector/open"
, data: JSON.stringify({
receivers
, defaultMediaType
@@ -93,7 +93,7 @@ export default class NativeReceiverSelector extends ReceiverSelector {
public close (): void {
if (this.bridgePort) {
this.bridgePort.postMessage({
subject: "bridge:/receiverSelector/close"
subject: "bridge:receiverSelector/close"
});
}
@@ -102,7 +102,7 @@ export default class NativeReceiverSelector extends ReceiverSelector {
private async onBridgePortMessage (message: Message) {
switch (message.subject) {
case "main:/receiverSelector/selected": {
case "main:receiverSelector/selected": {
this.wasReceiverSelected = true;
this.dispatchEvent(new CustomEvent("selected", {
detail: message.data
@@ -114,12 +114,12 @@ export default class NativeReceiverSelector extends ReceiverSelector {
break;
}
case "main:/receiverSelector/error": {
case "main:receiverSelector/error": {
logger.error("Native receiver selector error", message.data);
this.dispatchEvent(new CustomEvent("error"));
break;
}
case "main:/receiverSelector/close": {
case "main:receiverSelector/close": {
if (!this.wasReceiverSelected) {
this.dispatchEvent(new CustomEvent("cancelled"));
}
@@ -134,7 +134,7 @@ export default class NativeReceiverSelector extends ReceiverSelector {
break;
}
case "main:/receiverSelector/stop": {
case "main:receiverSelector/stop": {
this.dispatchEvent(new CustomEvent("stop", {
detail: message.data
}));

View File

@@ -118,7 +118,7 @@ export default class PopupReceiverSelector extends ReceiverSelector {
public update (receivers: Receiver[]) {
this.receivers = receivers;
this.messagePort?.postMessage({
subject: "popup:/update"
subject: "popup:update"
, data: {
receivers: this.receivers
}
@@ -162,12 +162,12 @@ export default class PopupReceiverSelector extends ReceiverSelector {
}
this.messagePort.postMessage({
subject: "popup:/init"
subject: "popup:init"
, data: { appId: this.appId }
});
this.messagePort.postMessage({
subject: "popup:/update"
subject: "popup:update"
, data: {
receivers: this.receivers
, defaultMediaType: this.defaultMediaType
@@ -183,7 +183,7 @@ export default class PopupReceiverSelector extends ReceiverSelector {
*/
private onPopupMessage (message: Message) {
switch (message.subject) {
case "receiverSelector:/selected": {
case "receiverSelector:selected": {
this.wasReceiverSelected = true;
this.dispatchEvent(new CustomEvent("selected", {
detail: message.data
@@ -192,7 +192,7 @@ export default class PopupReceiverSelector extends ReceiverSelector {
break;
}
case "receiverSelector:/stop": {
case "receiverSelector:stop": {
this.dispatchEvent(new CustomEvent("stop", {
detail: message.data
}));

View File

@@ -65,7 +65,7 @@ const getInfo = () => new Promise<BridgeInfo>(async (resolve, reject) => {
applicationVersion = await nativeMessaging.sendNativeMessage(
applicationName
, { subject: "bridge:/getInfo"
, { subject: "bridge:getInfo"
, data: version });
} catch (err) {
logger.error("Bridge connection failed.");

View File

@@ -39,7 +39,7 @@ export default async function loadSender (opts: LoadSenderOptions) {
}
shim.contentPort.postMessage({
subject: "shim:/launchApp"
subject: "shim:launchApp"
, data: { receiver: opts.selection.receiver }
});

View File

@@ -3,10 +3,12 @@
import logger from "./logger";
import options from "./options";
import { Message } from "../messaging";
type DisconnectListener = (port: browser.runtime.Port) => void;
type MessageListener = (message: any) => void;
type MessageListener = (message: Message) => void;
function connectNative (application: string) {
/**
@@ -165,7 +167,7 @@ function connectNative (application: string) {
async function sendNativeMessage (
application: string
, message: any) {
, message: Message) {
try {
return await browser.runtime.sendNativeMessage(application, message);

View File

@@ -13,102 +13,114 @@ import Volume from "./shim/cast/classes/Volume";
import { MediaInfo } from "./shim/cast/media";
/**
* Messages are JSON objects with a `subject` string key and a
* generic `data` key.
*
* Message subjects may include an optional destination and response
* name formatted like this:
* ^(destination:)?messageName(\/responseName)?$
*
* Message formats are specified with subject as a key and data as the
* value in the message table.
*/
type MessagesBase = {
"popup:/init": { appId?: string }
, "popup:/update": {
"popup:init": { appId?: string }
, "popup:update": {
receivers: Receiver[]
, defaultMediaType?: ReceiverSelectorMediaType
, availableMediaTypes?: ReceiverSelectorMediaType
}
, "popup:/close": {}
, "popup:close": {}
, "receiverSelector:/selected": ReceiverSelection
, "receiverSelector:/stop": ReceiverSelection
, "receiverSelector:selected": ReceiverSelection
, "receiverSelector:stop": ReceiverSelection
, "main:/shimReady": { appId: string }
, "main:shimReady": { appId: string }
, "main:selectReceiver": {}
, "shim:selectReceiver/selected": ReceiverSelectionCast
, "shim:selectReceiver/stopped": ReceiverSelectionStop
, "shim:selectReceiver/cancelled": {}
, "main:/sessionCreated": {}
, "main:sessionCreated": {}
, "shim:/serviceUp": { id: Receiver["id"] }
, "shim:/serviceDown": { id: Receiver["id"] }
, "shim:serviceUp": { id: Receiver["id"] }
, "shim:serviceDown": { id: Receiver["id"] }
, "shim:/initialized": BridgeInfo
, "shim:/launchApp": { receiver: Receiver }
, "shim:initialized": BridgeInfo
, "shim:launchApp": { receiver: Receiver }
// Session messages
, "shim:/session/stopped": {}
, "shim:/session/connected": {
, "shim:session/stopped": {}
, "shim:session/connected": {
sessionId: string
, namespaces: Array<{ name: string }>
, displayName: string
, statusText: string
}
, "shim:/session/updateStatus": { volume: Volume }
, "shim:/session/impl_addMessageListener": {
, "shim:session/updateStatus": { volume: Volume }
, "shim:session/impl_addMessageListener": {
namespace: string
, data: string
}
, "shim:/session/impl_sendMessage": {
, "shim:session/impl_sendMessage": {
messageId: string
, error: boolean
}
, "shim:/session/impl_setReceiverMuted": {
, "shim:session/impl_setReceiverMuted": {
volumeId: string
, error: boolean
}
, "shim:/session/impl_setReceiverVolumeLevel": {
, "shim:session/impl_setReceiverVolumeLevel": {
volumeId: string
, error: boolean
}
, "shim:/session/impl_stop": {
, "shim:session/impl_stop": {
stopId: string
, error: boolean
}
// Bridge session messages
, "bridge:/session/initialize": {
, "bridge:session/initialize": {
address: string
, port: number
, appId: string
, sessionId: string
, _id: string
}
, "bridge:/session/impl_leave": {
, "bridge:session/impl_leave": {
id: string
, _id: string
}
, "bridge:/session/impl_sendMessage": {
, "bridge:session/impl_sendMessage": {
namespace: string
, message: any
, messageId: string
, _id: string
}
, "bridge:/session/impl_setReceiverMuted": {
, "bridge:session/impl_setReceiverMuted": {
muted: boolean
, volumeId: string
, _id: string
}
, "bridge:/session/impl_setReceiverVolumeLevel": {
, "bridge:session/impl_setReceiverVolumeLevel": {
newLevel: number
, volumeId: string
, _id: string
}
, "bridge:/session/impl_stop": {
, "bridge:session/impl_stop": {
stopId: string;
_id: string;
}
, "bridge:/session/impl_addMessageListener": {
, "bridge:session/impl_addMessageListener": {
namespace: string;
_id: string;
}
// Media messages
, "shim:/media/update": {
, "shim:media/update": {
currentTime: number
, _lastCurrentTime: number
, customData: any
@@ -120,53 +132,54 @@ type MessagesBase = {
, media: MediaInfo
, mediaSessionId: number
}
, "shim:/media/sendMediaMessageResponse": {
, "shim:media/sendMediaMessageResponse": {
messageId: string
, error: boolean
}
// Bridge media messages
, "bridge:/media/initialize": {
, "bridge:media/initialize": {
sessionId: string
, mediaSessionId: number
, _internalSessionId: string
, _id: string
}
, "bridge:/media/sendMediaMessage": {
, "bridge:media/sendMediaMessage": {
message: any
, messageId: string
, _id: string
}
// Bridge messages
, "main:/receiverSelector/selected": ReceiverSelectionCast
, "main:/receiverSelector/error": string
, "main:/receiverSelector/close": {}
, "main:/receiverSelector/stop": ReceiverSelectionStop
, "main:receiverSelector/selected": ReceiverSelectionCast
, "main:receiverSelector/error": string
, "main:receiverSelector/close": {}
, "main:receiverSelector/stop": ReceiverSelectionStop
, "bridge:/initialize": { shouldWatchStatus: boolean }
, "bridge:getInfo": string
, "bridge:initialize": { shouldWatchStatus: boolean }
, "bridge:/receiverSelector/open": any
, "bridge:/receiverSelector/close": {}
, "bridge:receiverSelector/open": any
, "bridge:receiverSelector/close": {}
, "bridge:/stopReceiverApp": { receiver: Receiver }
, "bridge:stopReceiverApp": { receiver: Receiver }
, "bridge:/mediaServer/start": {
, "bridge:mediaServer/start": {
filePath: string
, port: number
}
, "mediaCast:/mediaServer/started": {
, "mediaCast:mediaServer/started": {
mediaPath: string
, subtitlePaths: string[]
, localAddress: string
}
, "mediaCast:/mediaServer/stopped": {}
, "mediaCast:/mediaServer/error": {}
, "mediaCast:mediaServer/stopped": {}
, "mediaCast:mediaServer/error": {}
, "main:/serviceUp": Receiver
, "main:/serviceDown": { id: string }
, "main:serviceUp": Receiver
, "main:serviceDown": { id: string }
, "main:/receiverStatus": {
, "main:receiverStatus": {
id: string
, status: ReceiverStatus
}

View File

@@ -15,7 +15,7 @@ function startMediaServer (filePath: string, port: number)
return new Promise((resolve, reject) => {
backgroundPort.postMessage({
subject: "bridge:/mediaServer/start"
subject: "bridge:mediaServer/start"
, data: {
filePath: decodeURI(filePath)
, port
@@ -25,16 +25,16 @@ function startMediaServer (filePath: string, port: number)
backgroundPort.addEventListener("message", function onMessage (ev) {
const message = ev.data as Message;
if (message.subject.startsWith("mediaCast:/mediaServer/")) {
if (message.subject.startsWith("mediaCast:mediaServer/")) {
backgroundPort.removeEventListener("message", onMessage);
}
switch (message.subject) {
case "mediaCast:/mediaServer/started": {
case "mediaCast:mediaServer/started": {
resolve(message.data);
break;
}
case "mediaCast:/mediaServer/error": {
case "mediaCast:mediaServer/error": {
reject();
break;
}
@@ -376,7 +376,7 @@ export async function init (opts: InitOptions) {
window.addEventListener("beforeunload", async () => {
backgroundPort.postMessage({
subject: "bridge:/mediaServer/stop"
subject: "bridge:mediaServer/stop"
});
if (await options.get("mediaStopOnUnload")) {

View File

@@ -55,7 +55,7 @@ export default class Session {
}
switch (message.subject) {
case "shim:/session/stopped": {
case "shim:session/stopped": {
// Disconnect from extension messages
this.#listener.disconnect();
@@ -68,7 +68,7 @@ export default class Session {
break;
}
case "shim:/session/connected": {
case "shim:session/connected": {
this.status = SessionStatus.CONNECTED;
this.sessionId = message.data.sessionId;
this.transportId = message.data.sessionId;
@@ -83,7 +83,7 @@ export default class Session {
break;
}
case "shim:/session/updateStatus": {
case "shim:session/updateStatus": {
const volume: Volume = message.data.volume;
if (volume) {
@@ -110,7 +110,7 @@ export default class Session {
}
case "shim:/session/impl_addMessageListener": {
case "shim:session/impl_addMessageListener": {
const { namespace, data } = message.data;
const messageListeners = this.#messageListeners.get(namespace);
@@ -123,7 +123,7 @@ export default class Session {
break;
}
case "shim:/session/impl_sendMessage": {
case "shim:session/impl_sendMessage": {
const { messageId, error } = message.data;
const [ successCallback, errorCallback ] =
this.#sendMessageCallbacks.get(messageId) ?? [];
@@ -139,7 +139,7 @@ export default class Session {
break;
}
case "shim:/session/impl_setReceiverMuted": {
case "shim:session/impl_setReceiverMuted": {
const { volumeId, error } = message.data;
const [ successCallback, errorCallback ] =
this.#setReceiverMutedCallbacks.get(volumeId) ?? [];
@@ -155,7 +155,7 @@ export default class Session {
break;
}
case "shim:/session/impl_setReceiverVolumeLevel": {
case "shim:session/impl_setReceiverVolumeLevel": {
const { volumeId, error } = message.data;
const [ successCallback, errorCallback ] =
this.#setReceiverVolumeLevelCallbacks
@@ -172,7 +172,7 @@ export default class Session {
break;
}
case "shim:/session/impl_stop": {
case "shim:session/impl_stop": {
const { stopId, error } = message.data;
const [ successCallback, errorCallback ]
= this.#stopCallbacks.get(stopId) ?? [];
@@ -227,7 +227,7 @@ export default class Session {
if (receiver) {
sendMessageResponse({
subject: "bridge:/session/initialize"
subject: "bridge:session/initialize"
, data: {
address: (receiver as any)._address
, port: (receiver as any)._port
@@ -255,7 +255,7 @@ export default class Session {
this.#messageListeners.get(namespace)?.add(listener);
sendMessageResponse({
subject: "bridge:/session/impl_addMessageListener"
subject: "bridge:session/impl_addMessageListener"
, data: {
namespace
, _id: this.#id
@@ -274,7 +274,7 @@ export default class Session {
const id = uuid();
sendMessageResponse({
subject: "bridge:/session/impl_leave"
subject: "bridge:session/impl_leave"
, data: {
id
, _id: this.#id
@@ -380,7 +380,7 @@ export default class Session {
const messageId = uuid();
sendMessageResponse({
subject: "bridge:/session/impl_sendMessage"
subject: "bridge:session/impl_sendMessage"
, data: {
namespace
, message
@@ -403,7 +403,7 @@ export default class Session {
const volumeId = uuid();
sendMessageResponse({
subject: "bridge:/session/impl_setReceiverMuted"
subject: "bridge:session/impl_setReceiverMuted"
, data: {
muted
, volumeId
@@ -425,7 +425,7 @@ export default class Session {
const volumeId = uuid();
sendMessageResponse({
subject: "bridge:/session/impl_setReceiverVolumeLevel"
subject: "bridge:session/impl_setReceiverVolumeLevel"
, data: {
newLevel
, volumeId
@@ -446,7 +446,7 @@ export default class Session {
const stopId = uuid();
sendMessageResponse({
subject: "bridge:/session/impl_stop"
subject: "bridge:session/impl_stop"
, data: {
stopId
, _id: this.#id

View File

@@ -102,7 +102,7 @@ export function initialize (
apiConfig = newApiConfig;
sendMessageResponse({
subject: "main:/shimReady"
subject: "main:shimReady"
, data: { appId: apiConfig.sessionRequest.appId }
});
@@ -227,7 +227,7 @@ export function _requestSession (
, selectedReceiver // receiver
, (session: Session) => {
sendMessageResponse({
subject: "main:/sessionCreated"
subject: "main:sessionCreated"
});
sessionRequestInProgress = false;
@@ -277,7 +277,7 @@ export function unescape (escaped: string): string {
onMessage(async message => {
switch (message.subject) {
case "shim:/initialized": {
case "shim:initialized": {
isAvailable = true;
break;
}
@@ -286,7 +286,7 @@ onMessage(async message => {
* Cast destination found (serviceUp). Set the API availability
* property and call the page event function (__onGCastApiAvailable).
*/
case "shim:/serviceUp": {
case "shim:serviceUp": {
const receiver = message.data;
if (receiverList.find(r => r.id === receiver.id)) {
@@ -307,7 +307,7 @@ onMessage(async message => {
* Cast destination lost (serviceDown). Remove from the receiver list
* and update availability state.
*/
case "shim:/serviceDown": {
case "shim:serviceDown": {
const receiverIndex = receiverList.findIndex(
receiver => receiver.id === message.data.id);
@@ -352,7 +352,7 @@ onMessage(async message => {
, selectedReceiver // receiver
, (session: Session) => {
sendMessageResponse({
subject: "main:/sessionCreated"
subject: "main:sessionCreated"
});
sessionRequestInProgress = false;
@@ -412,7 +412,7 @@ onMessage(async message => {
break;
}
case "shim:/launchApp": {
case "shim:launchApp": {
const receiver: Receiver = message.data.receiver;
_requestSession(receiver
, session => {

View File

@@ -50,7 +50,7 @@ export default class Media {
}
switch (message.subject) {
case "shim:/media/update": {
case "shim:media/update": {
const status = message.data;
this.currentTime = status.currentTime;
@@ -81,7 +81,7 @@ export default class Media {
break;
}
case "shim:/media/sendMediaMessageResponse": {
case "shim:media/sendMediaMessageResponse": {
const { messageId, error } = message.data;
const [ successCallback, errorCallback ]
= this.#sendMediaMessageCallbacks
@@ -125,7 +125,7 @@ export default class Media {
, _internalSessionId: string) {
sendMessageResponse({
subject: "bridge:/media/initialize"
subject: "bridge:media/initialize"
, data: {
sessionId
, mediaSessionId
@@ -344,7 +344,7 @@ export default class Media {
]);
sendMessageResponse({
subject: "bridge:/media/sendMediaMessage"
subject: "bridge:media/sendMediaMessage"
, data: {
message
, messageId

View File

@@ -89,7 +89,7 @@ export function ensureInit (): Promise<MessagePort> {
function handleIncomingMessageToShim (message: Message) {
switch (message.subject) {
case "shim:/initialized": {
case "shim:initialized": {
initializedBridgeInfo = message.data;
if (initializedBridgeInfo.isVersionCompatible) {

View File

@@ -67,7 +67,7 @@ if (document.currentScript) {
onMessage(message => {
switch (message.subject) {
case "shim:/initialized": {
case "shim:initialized": {
bridgeInfo = message.data;
if (!isFramework) {

View File

@@ -73,7 +73,7 @@ class PopupApp extends Component<{}, PopupAppState> {
this.port.onMessage.addListener((message: Message) => {
switch (message.subject) {
case "popup:/init": {
case "popup:init": {
this.setState({
requestedAppId: message.data?.appId
});
@@ -81,7 +81,7 @@ class PopupApp extends Component<{}, PopupAppState> {
break;
}
case "popup:/update": {
case "popup:update": {
const { receivers
, availableMediaTypes
, defaultMediaType } = message.data;
@@ -100,7 +100,7 @@ class PopupApp extends Component<{}, PopupAppState> {
break;
}
case "popup:/close": {
case "popup:close": {
window.close();
break;
}
@@ -217,7 +217,7 @@ class PopupApp extends Component<{}, PopupAppState> {
});
this.port?.postMessage({
subject: "receiverSelector:/selected"
subject: "receiverSelector:selected"
, data: {
receiver
, mediaType: this.state.mediaType
@@ -228,7 +228,7 @@ class PopupApp extends Component<{}, PopupAppState> {
private onStop (receiver: Receiver) {
this.port?.postMessage({
subject: "receiverSelector:/stop"
subject: "receiverSelector:stop"
, data: { receiver }
});
}