ember-polling-push-updates 0.0.0

package/.woodpecker/release.yml

@@ -0,0 +1,13 @@
+steps:
+  install:
+    image: madnificent/ember:5.12.0
+    commands:
+      - npm ci
+  release:
+    image: plugins/npm
+    settings:
+      token:
+        from_secret: npm_access_token
+when:
+  - event: tag
+    ref: refs/tags/*

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2025
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,27 @@
+# ember-polling-push-updates
+
+[Short description of the addon.]
+
+## Compatibility
+
+- Ember.js v4.12 or above
+- Ember CLI v4.12 or above
+- Node.js v18 or above
+
+## Installation
+
+```
+ember install ember-polling-push-updates
+```
+
+## Usage
+
+[Longer description of how to use the addon in apps.]
+
+## Contributing
+
+See the [Contributing](CONTRIBUTING.md) guide for details.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).

package/addon/services/push-updates.js

@@ -0,0 +1,165 @@
+import { tracked } from '@glimmer/tracking';
+import Service from '@ember/service';
+
+export default class PushUpdatesService extends Service {
+  @tracked tabUri;
+  @tracked tabUriP;
+
+  handlers = {};
+
+  constructor() {
+    super(...arguments);
+
+    this.startQueryLoop();
+  }
+
+  addHandler( kind, functor ) {
+    this.handlers[kind] ||= [];
+    this.handlers[kind].push( functor );
+  }
+
+  removeHandler( kind, functor ) {
+    this.handlers[kind] =
+      (this.handlers[kind] || [])
+        .filter( (element) => element !== functor );
+  }
+
+  async ensureTabUri() {
+    if( ! this.tabUriP ) {
+      this.tabUriP = new Promise( async (acc, rej) => {
+        try {
+          const body = await fetch(`/polling/tabUri`);
+          const resp = await body.json();
+          const tabUri = resp.data.attributes.tabUri;
+          this.tabUri = tabUri;
+          acc(tabUri);
+        } catch (e) {
+          console.error(`Could not get tab URI  ${e}`);
+          rej();
+        }
+      });
+    }
+    return await this.tabUriP;
+  }
+
+  async startQueryLoop() {
+    let tabUri = await this.ensureTabUri(); // will be updated if we need to refresh the tab uri
+    while (true) {
+      try {
+        const body = (await (await fetch(`/polling/messages?tab=${encodeURIComponent(tabUri)}`)).json());
+        const messages = body.data;
+
+        if( body.data ) {
+          // call processors if they exist
+          messages
+            .forEach(
+              (message) =>
+                this
+                  .handlers[message.attributes.channel]
+                  ?.forEach(
+                    (handler) => { try {
+                      handler.call(message.attributes.content)
+                    } catch (e) {
+                      console.warn(`Handler did not respond to message`, { handler, message, e })
+                    } }));
+        } else {
+          // we are in the reror state and should fetch again
+          console.warn(`Lost tabId, asking for a new one ${tabUri}`);
+          // TODO: inform our registered consumers our tab has changed so they can setup their monitoring requests again
+          this.tabUriP = null;
+          tabUri = await this.ensureTabUri();
+        }
+      } catch (e) {
+        console.warn(`Failed to poll messages ${e}.`);
+      }
+      await timeout( 2000 );
+    }
+  }
+
+  // SUPPORT FOR SPECIFIC TYPES OF MONITOR
+  async monitorCache({ path, callback, initial=true }) {
+    const tabUri = await this.ensureTabUri();
+    const queryParams = new URLSearchParams({ tab: tabUri, path });
+    await fetch(`/cache-monitor/monitor?${queryParams}`,
+      {
+        method: 'POST',
+        headers: { 'accept': 'application/vnd.api+json' }
+      });
+    this.addHandler(
+      "http://services.semantic.works/cache-monitor",
+      callback);
+    if( initial )
+      await callback();
+  }
+
+  async unMonitorCache({ path, callback }) {
+    const tabUri = await this.ensureTabUri();
+    const queryParams = new URLSearchParams({ tab: tabUri, path });
+    await fetch(`/cache-monitor/monitor?${queryParams}`,
+      {
+        method: 'DELETE',
+        headers: { 'accept': 'application/vnd.api+json' }
+      });
+    this.removeHandler(
+      "http://services.semantic.works/cache-monitor",
+      callback
+    )
+  }
+
+  async monitorResource({ uri, callback }) {
+    const tabUri = await this.ensureTabUri();
+    const queryParams = new URLSearchParams({ subject: uri });
+    await fetch(`/resource-monitor/monitor?${queryParams}`,
+      {
+        method: "POST",
+        headers: {
+          'accept': "application/vnd.api+json",
+          "MU-TAB-ID": tabUri
+        }
+      });
+    this.addHandler(
+      "http://services.semantic.works/resource-monitor",
+      callback);
+  }
+
+  async unMonitorResource({ uri: uri, callback }) {
+    const tabUri = await this.ensureTabUri();
+    const queryParams = new URLSearchParams({ subject: uri });
+    await fetch(`/resource-monitor/monitor?${queryParams}`,
+      {
+        method: "DELETE",
+        headers: {
+          'accept': "application/vnd.api+json",
+          "MU-TAB-ID": tabUri
+        }
+      })
+    this.removeHandler("http://services.semantic.works/resource-monitor", callback);
+  }
+
+  modelReloadCallbacks = {};
+
+  async monitorModel(model) {
+    const availableModel = await model;
+    if( availableModel.uri ) {
+      const callback = () => availableModel.reload();
+      this.modelReloadCallbacks[model] ||= [];
+      this.modelReloadCallbacks[model].push( callback );
+      await this.monitorResource( { uri: availableModel.uri, callback });
+    } else {
+      throw `Could not monitor model because no URI was found ${availableModel}`;
+    }
+  }
+
+  async unMonitorModel(model) {
+    const availableModel = await model;
+    if ( availableModel.uri && this.modelReloadCallbacks[model] ) {
+      const [callback, restCallbacks] = this.modelReloadCallbacks[model];
+      this.modelReloadCallbacks[model] = restCallbacks;
+      await this.unMonitorResource({ uri: availableModel.uri, callback });
+    }
+  }
+}
+
+function timeout() {
+  return true;
+}

package/addon/utils/timeout.js

@@ -0,0 +1,5 @@
+export default function timeout(ms) {
+  return new Promise((acc) =>
+    setTimeout(() => acc(), ms)
+  );
+}

package/app/services/push-updates.js

@@ -0,0 +1 @@
+export { default } from 'ember-polling-push-updates/services/push-updates';

package/app/utils/timeout.js

@@ -0,0 +1 @@
+export { default } from 'ember-polling-push-updates/utils/timeout';

package/index.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+  name: require('./package').name,
+};

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "ember-polling-push-updates",
+  "version": "0.0.0",
+  "description": "The default blueprint for ember-cli addons.",
+  "keywords": [
+    "ember-addon"
+  ],
+  "repository": "",
+  "license": "MIT",
+  "author": "",
+  "directories": {
+    "doc": "doc",
+    "test": "tests"
+  },
+  "scripts": {
+    "build": "ember build --environment=production",
+    "lint": "concurrently \"npm:lint:*(!fix)\" --names \"lint:\"",
+    "lint:css": "stylelint \"**/*.css\"",
+    "lint:css:fix": "concurrently \"npm:lint:css -- --fix\"",
+    "lint:fix": "concurrently \"npm:lint:*:fix\" --names \"fix:\"",
+    "lint:hbs": "ember-template-lint .",
+    "lint:hbs:fix": "ember-template-lint . --fix",
+    "lint:js": "eslint . --cache",
+    "lint:js:fix": "eslint . --fix",
+    "start": "ember serve",
+    "test": "concurrently \"npm:lint\" \"npm:test:*\" --names \"lint,test:\"",
+    "test:ember": "ember test",
+    "test:ember-compatibility": "ember try:each"
+  },
+  "dependencies": {
+    "@babel/core": "^7.25.2",
+    "ember-cli-babel": "^8.2.0",
+    "ember-cli-htmlbars": "^6.3.0"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "^7.25.1",
+    "@babel/plugin-proposal-decorators": "^7.24.7",
+    "@ember/optional-features": "^2.1.0",
+    "@ember/test-helpers": "^3.3.1",
+    "@embroider/test-setup": "^4.0.0",
+    "@glimmer/component": "^1.1.2",
+    "@glimmer/tracking": "^1.1.2",
+    "broccoli-asset-rev": "^3.0.0",
+    "concurrently": "^8.2.2",
+    "ember-auto-import": "^2.8.1",
+    "ember-cli": "~5.12.0",
+    "ember-cli-clean-css": "^3.0.0",
+    "ember-cli-dependency-checker": "^3.3.2",
+    "ember-cli-inject-live-reload": "^2.1.0",
+    "ember-cli-sri": "^2.1.1",
+    "ember-cli-terser": "^4.0.2",
+    "ember-load-initializers": "^2.1.2",
+    "ember-page-title": "^8.2.3",
+    "ember-qunit": "^8.1.0",
+    "ember-resolver": "^12.0.1",
+    "ember-source": "~5.12.0",
+    "ember-source-channel-url": "^3.0.0",
+    "ember-template-lint": "^6.0.0",
+    "ember-try": "^3.0.0",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-ember": "^12.2.1",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-qunit": "^8.1.2",
+    "loader.js": "^4.7.0",
+    "prettier": "^3.3.3",
+    "qunit": "^2.22.0",
+    "qunit-dom": "^3.2.1",
+    "stylelint": "^15.11.0",
+    "stylelint-config-standard": "^34.0.0",
+    "stylelint-prettier": "^4.1.0",
+    "webpack": "^5.95.0"
+  },
+  "peerDependencies": {
+    "ember-source": ">= 4.0.0"
+  },
+  "engines": {
+    "node": ">= 18"
+  },
+  "ember": {
+    "edition": "octane"
+  },
+  "ember-addon": {
+    "configPath": "tests/dummy/config"
+  }
+}