feat!: Refactored topic structure for more granular flow and access

build/arena-account.js

@@ -61,15 +61,15 @@ export default class ARENAUserAccount {
      * @return {UserAccountData} object with user account data
      */
     static async userAuthState() {
-        return ARENAUserAccount._makeRequest('GET', `/user/user_state`);
+        return ARENAUserAccount._makeRequest('GET', `/user/v2/user_state`);
     }
 
     /**
      * Request scene names which the user has permission to from user database
      * @return {[string]} list of scene names
      */
     static async userScenes() {
-        return ARENAUserAccount._makeRequest('GET', '/user/my_scenes');
+        return ARENAUserAccount._makeRequest('GET', '/user/v2/my_scenes');
     }
 
     /**
@@ -80,15 +80,15 @@ export default class ARENAUserAccount {
     static async requestUserNewScene(sceneNamespace, isPublic = false) {
         const params = new FormData();
         // TODO: add public parameter
-        return ARENAUserAccount._makeRequest('POST', `/user/scenes/${sceneNamespace}`);
+        return ARENAUserAccount._makeRequest('POST', `/user/v2/scenes/${sceneNamespace}`);
     }
 
     /**
      * Request to delete scene permissions from user db
      * @param {string} sceneNamespace name of the scene without namespace
      */
     static async requestDeleteUserScene(sceneNamespace) {
-        return ARENAUserAccount._makeRequest('DELETE', `/user/scenes/${sceneNamespace}`);
+        return ARENAUserAccount._makeRequest('DELETE', `/user/v2/scenes/${sceneNamespace}`);
     }
 
     /**
@@ -105,7 +105,7 @@ export default class ARENAUserAccount {
         // pages /scenes and /build should have general permissions for the user's scene objects
         const result = await ARENAUserAccount._makeRequest(
             'POST',
-            `/user/mqtt_auth`,
+            `/user/v2/mqtt_auth`,
             params,
             'application/x-www-form-urlencoded'
         );

build/main.js

@@ -3,6 +3,7 @@
 /* eslint-disable import/extensions */
 import * as PersistObjects from './persist-objects.js';
 import ARENAUserAccount from './arena-account.js';
+import TOPICS from '../src/constants/topics.js';
 
 const Alert = Swal.mixin({
     toast: true,
@@ -853,7 +854,7 @@ window.addEventListener('onauth', async (e) => {
         // add scene if it does not exist
         if (newScene) await PersistObjects.addNewScene(namespaceinput.value, sceneinput.value, undefined);
 
-        await PersistObjects.addObject(obj, `${namespaceinput.value}/${sceneinput.value}`);
+        await PersistObjects.addObject(obj, namespaceinput.value, sceneinput.value);
         setTimeout(async () => {
             PersistObjects.populateObjectList(
                 `${namespaceinput.value}/${sceneinput.value}`,
@@ -1036,7 +1037,11 @@ Swal.fire({
  * @param {string} mqttToken
  */
 function updatePublishControlsByToken(namespace, scenename, mqttToken) {
-    const objectsTopic = `realm/s/${namespace}/${scenename}`;
+    const objectsTopic = TOPICS.PUBLISH.SCENE_OBJECTS.formatStr({
+        nameSpace: namespace,
+        sceneName: scenename,
+        objectId: '+',
+    });
     const editor = ARENAAUTH.isUserSceneEditor(mqttToken, objectsTopic);
     const delButton = document.getElementById('delobj');
     const deleteSceneButton = document.getElementById('deletescene');
@@ -1051,3 +1056,9 @@ function updatePublishControlsByToken(namespace, scenename, mqttToken) {
         item.disabled = !editor;
     });
 }
+
+// eslint-disable-next-line no-extend-native
+String.prototype.formatStr = function formatStr(...args) {
+    const params = arguments.length === 1 && typeof args[0] === 'object' ? args[0] : args;
+    return this.replace(/\{([^}]+)\}/g, (match, key) => (typeof params[key] !== 'undefined' ? params[key] : match));
+};

build/mqtt-client.js

@@ -23,8 +23,7 @@ export default class MqttClient {
             host: st.host !== undefined ? st.host : 'arena.andrew.cmu.edu',
             port: st.port !== undefined ? st.port : 8083,
             path: st.path !== undefined ? st.path : '/mqtt/',
-            clientid:
-                st.clientid !== undefined ? st.clientid : `build-client-${Math.round(Math.random() * 10000)}`,
+            clientid: st.clientid !== undefined ? st.clientid : `build-client-${Math.round(Math.random() * 10000)}`,
             subscribeTopics: st.subscribeTopics,
             onConnectCallback: st.onConnectCallback,
             onConnectCallbackContext: st.onConnectCallbackContext,

build/persist-objects.js

@@ -8,6 +8,7 @@
 
 /* global Alert, ARENAAUTH, ARENADefaults, Swal, THREE */
 /* eslint-disable import/extensions */
+import TOPICS from '../src/constants/topics.js';
 import MqttClient from './mqtt-client.js';
 import ARENAUserAccount from './arena-account.js';
 import { TTLCache } from './ttl-cache.js';
@@ -369,7 +370,10 @@ export function updateSubscribeTopic(scene) {
 
     if (persist.currentScene) persist.mc.unsubscribe(persist.currentScene);
     if (scene) {
-        const topic = `realm/s/${scene}/#`;
+        const topic = TOPICS.SUBSCRIBE.SCENE_PUBLIC.formatStr({
+            nameSpace: scene.split('/')[0],
+            sceneName: scene.split('/')[1],
+        });
         persist.mc.subscribe(topic);
         persist.currentScene = scene;
         populateProgramInstanceList();
@@ -556,7 +560,7 @@ export async function addNewScene(ns, sceneName, newObjs) {
 
     // add objects to the new scene
     newObjs.forEach((obj) => {
-        addObject(obj, `${ns}/${sceneName}`);
+        addObject(obj, ns, sceneName);
     });
     return exists;
 }
@@ -604,7 +608,11 @@ export function performActionArgObjList(action, scene, objList, json = true) {
             scene = `${obj.namespace}/${obj.sceneId}`;
             theNewScene = obj.sceneId;
         }
-        const topic = `realm/s/${scene}/${obj.object_id}`;
+        const topic = TOPICS.PUBLISH.SCENE_OBJECTS.formatStr({
+            nameSpace: theNewScene.split('/')[0],
+            sceneName: theNewScene.split('/')[1],
+            objectId: obj.object_id,
+        });
         console.info(`Publish [ ${topic}]: ${actionObj}`);
         try {
             persist.mc.publish(topic, actionObj);
@@ -634,7 +642,7 @@ export function clearSelected() {
     }
 }
 
-export async function addObject(obj, scene) {
+export async function addObject(obj, nameSpace, sceneName) {
     let found = false;
     if (!persist.mqttConnected) mqttReconnect();
 
@@ -674,7 +682,11 @@ export async function addObject(obj, scene) {
 
     const persistAlert = obj.persist === false ? '<br/><strong>Object not persisted.</strong>' : '';
     const objJson = JSON.stringify(obj);
-    const topic = `realm/s/${scene}/${obj.object_id}`;
+    const topic = TOPICS.PUBLISH.SCENE_OBJECTS.formatStr({
+        nameSpace,
+        sceneName,
+        objectId: obj.object_id,
+    });
     console.info(`Publish [ ${topic}]: ${objJson}`);
     try {
         persist.mc.publish(topic, objJson);

build/schemas/arena-program.json

@@ -62,7 +62,7 @@
                 },
                 "args": {
                     "type": "array",
-                    "description": "Command-line arguments (passed in argv). Supports variables: ${scene}, ${mqtth}, ${cameraid}, ${username}, ${runtimeid}, ${moduleid}, ${query-string-key}.",
+                    "description": "Command-line arguments (passed in argv). Supports variables: ${scene}, ${mqtth}, ${userid}, ${username}, ${runtimeid}, ${moduleid}, ${query-string-key}.",
                     "uniqueItems": false,
                     "items": {
                         "type": "string",
@@ -71,7 +71,7 @@
                 },
                 "env": {
                     "type": "array",
-                    "description": "Environment variables. Supports variables: ${scene}, ${namespace}, ${mqtth}, ${cameraid}, ${username}, ${runtimeid}, ${moduleid}, ${query-string-key}.",
+                    "description": "Environment variables. Supports variables: ${scene}, ${namespace}, ${mqtth}, ${userid}, ${username}, ${runtimeid}, ${moduleid}, ${query-string-key}.",
                     "uniqueItems": false,
                     "items": {
                         "type": "string",
@@ -136,7 +136,7 @@
                             "type": "pubsub",
                             "mode": "rw",
                             "params": {
-                                "topic": "realm/s/${scene}"
+                                "topic": "realm/s/${scene}/${namespace}"
                             }
                         }
                     ]

build/schemas/definitions-arena-object.json

@@ -24,7 +24,16 @@
         },
         "ttl": {
             "description": "When applied to an entity, the entity will remove itself from DOM after the specified number of seconds. Update is allowed, which will reset the timer to start from that moment.",
-            "type": "integer"
+            "type": "number"
+        },
+        "private": {
+            "description": "If true, interactions with this object should not be broadcasted to other clients, but rather sent on private topics",
+            "type": "boolean",
+            "default": false
+        },
+        "program_id": {
+            "description": "The program_id on private program topics that interactions to be directed to, if the private flag is set true. Ignored if private flag is false.",
+            "type": "string"
         }
     }
 }

build/schemas/event.json

@@ -9,27 +9,42 @@
             "properties": {
                 "data": {
                     "properties": {
-                        "source": {
-                            "title": "Source ID",
-                            "description": "The `object_id` of event origination. e.g camera or client program connection id.",
+                        "target": {
+                            "description": "The `object_id` of event destination.",
                             "type": "string"
                         },
-                        "position": {
+                        "targetPosition": {
                             "description": "The event destination position in 3D.",
                             "format": "grid",
-                            "$ref": "#/definitions/vector3",
-                            "title": "Position"
+                            "$ref": "#/definitions/vector3"
                         },
-                        "clickPos": {
+                        "originPosition": {
                             "description": "The event origination position in 3D.",
                             "format": "grid",
                             "$ref": "#/definitions/vector3",
-                            "title": "Click Position",
                             "default": {
                                 "x": 0,
                                 "y": 1.6,
                                 "z": 0
                             }
+                        },
+                        "source": {
+                            "title": "DEPRECATED (source)",
+                            "description": "DEPRECATED: data.source is deprecated for clientEvent, use data.target instead.",
+                            "type": "string",
+                            "deprecated": true
+                        },
+                        "position": {
+                            "title": "DEPRECATED (position)",
+                            "description": "DEPRECATED: data.position is deprecated for clientEvent, use data.targetPosition instead.",
+                            "type": "object",
+                            "deprecated": true
+                         },
+                        "clickPos": {
+                            "title": "DEPRECATED (clickPos)",
+                            "description": "DEPRECATED: data.clickPos is deprecated for clientEvent, use data.originPosition instead.",
+                            "type": "object",
+                            "deprecated": true
                         }
                     },
                     "title": "Event Data",

files/script.js

@@ -66,7 +66,7 @@ function getStorePath() {
 }
 
 window.addEventListener('onauth', async (e) => {
-    await ARENAAUTH.makeUserRequest('GET', '/user/storelogin');
+    await ARENAAUTH.makeUserRequest('GET', '/user/v2/storelogin');
     const authToken = ARENAAUTH.getCookie('auth');
     loadStoreFront(authToken);
 });

navbar-old.js

@@ -4,7 +4,7 @@ $(document).ready(() => {
     // add page header
     $('#header').load('/header-old.html', () => {
         // update auth state in nav bar
-        fetch('/user/user_state')
+        fetch('/user/v2/user_state')
             .then((response) => response.json())
             .then((data) => {
                 window.auth = data;
@@ -16,7 +16,7 @@ $(document).ready(() => {
                 dropdownMenu.append('<li><a href="/conf/versions.html">Version</a></li>');
                 if (window.auth.authenticated) {
                     authDrop.html(`${window.auth.username} <b class='caret'></b>`);
-                    dropdownMenu.append('<li><a href="/user/profile">Profile</a></li>');
+                    dropdownMenu.append('<li><a href="/user/v2/profile">Profile</a></li>');
                     dropdownMenu.append('<li><a id="show_perms" href="#">Permissions</a></li>');
                     $('#show_perms').on('click', () => {
                         const frame = document.getElementsByTagName('iframe');
@@ -27,10 +27,10 @@ $(document).ready(() => {
                             alert('No MQTT permissions');
                         }
                     });
-                    dropdownMenu.append('<li><a href="/user/logout">Logout</a></li>');
+                    dropdownMenu.append('<li><a href="/user/v2/logout">Logout</a></li>');
                 } else {
                     authDrop.html('Login <b class="caret"></b>');
-                    dropdownMenu.append('<li><a href="/user/login">Login</a></li>').on('click', (e) => {
+                    dropdownMenu.append('<li><a href="/user/v2/login">Login</a></li>').on('click', (e) => {
                         localStorage.setItem('request_uri', window.location.href);
                     });
                 }

navbar.js

@@ -4,7 +4,7 @@ $(document).ready(() => {
     // add page header
     $('#header').load('/header.html', () => {
         // update auth state in nav bar
-        fetch('/user/user_state')
+        fetch('/user/v2/user_state')
             .then((response) => response.json())
             .then((data) => {
                 window.auth = data;
@@ -20,7 +20,7 @@ $(document).ready(() => {
                 dropdownMenu.append('<li><a class="dropdown-item" href="/conf/versions.html">Version</a></li>');
                 if (window.auth.authenticated) {
                     authDrop.html(window.auth.username);
-                    dropdownMenu.append('<li><a class="dropdown-item" href="/user/profile">Profile</a></li>');
+                    dropdownMenu.append('<li><a class="dropdown-item" href="/user/v2/profile">Profile</a></li>');
                     dropdownMenu.append('<li><a class="dropdown-item" id="show_perms" href="#">Permissions</a></li>');
                     $('#show_perms').on('click', () => {
                         const frame = document.getElementsByTagName('iframe');
@@ -31,11 +31,11 @@ $(document).ready(() => {
                             window.alert('No MQTT permissions');
                         }
                     });
-                    dropdownMenu.append('<li><a class="dropdown-item" href="/user/logout">Logout</a></li>');
+                    dropdownMenu.append('<li><a class="dropdown-item" href="/user/v2/logout">Logout</a></li>');
                 } else {
                     authDrop.html('Login');
                     dropdownMenu
-                        .append('<li><a class="dropdown-item" href="/user/login">Login</a></li>')
+                        .append('<li><a class="dropdown-item" href="/user/v2/login">Login</a></li>')
                         .on('click', (e) => {
                             localStorage.setItem('request_uri', window.location.href);
                         });

scenes/scenes.js

@@ -122,7 +122,7 @@ window.addEventListener('onauth', async (e) => {
             window.userSceneId = _e.target.value;
             updateUriBuilderCheckboxes(true);
             updateUserSceneUrlBox(`${window.location.origin}/${_e.target.value}`);
-            scenePermsLink.href = `${window.location.origin}/user/profile/scenes/${_e.target.value}`;
+            scenePermsLink.href = `${window.location.origin}/user/v2/profile/scenes/${_e.target.value}`;
             deleteUserSceneBtn.value = _e.target.value;
             toggleUserSceneButtons(true);
         } else {
@@ -229,7 +229,7 @@ window.addEventListener('onauth', async (e) => {
     deleteUserSceneBtn.addEventListener('click', () => {
         if (confirm(`Are you sure you want to delete ${deleteUserSceneBtn.value}?`)) {
             const deletes = [
-                axios.delete(`/user/scenes/${deleteUserSceneBtn.value}`, {
+                axios.delete(`/user/v2/scenes/${deleteUserSceneBtn.value}`, {
                     withCredentials: true,
                 }),
                 axios.delete(`/persist/${deleteUserSceneBtn.value}`),
@@ -327,7 +327,7 @@ window.addEventListener('onauth', async (e) => {
     // my_scenes may include 'public' namespaces for staff
     // my_scenes may include other editor namespaces that have been granted
     axios
-        .get('/user/my_scenes', {
+        .get('/user/v2/my_scenes', {
             withCredentials: true,
         })
         .then((res) => {

screenshare/index.js

@@ -116,10 +116,10 @@ function onConnectionSuccess() {
     });
 
     conference.setDisplayName(
-        `${(+new Date()).toString(36)} ${window.params.screenSharePrefix}_${window.params.camName}`
+        `${(+new Date()).toString(36)} ${window.params.screenSharePrefix}_${window.params.idTag}`
     );
     conference.setLocalParticipantProperty('screenshareDispName', window.params.displayName);
-    conference.setLocalParticipantProperty('screenshareCamName', window.params.camName);
+    conference.setLocalParticipantProperty('screenshareidTag', window.params.idTag);
     conference.setLocalParticipantProperty('screenshareObjIds', window.params.objectIds);
 
     conference.join();