@cocreate/usage 1.2.1 → 1.4.0

package/.github/workflows/automated.yml

@@ -1,8 +1,10 @@
 name: Automated Workflow
+
 on:
   push:
     branches:
       - master
+
 jobs:
   about:
     runs-on: ubuntu-latest
@@ -18,52 +20,37 @@ jobs:
         with:
           direction: overwrite-github
           githubToken: "${{ secrets.GITHUB }}"
+
   release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/checkout@v4
         with:
-          node-version: 14
-      - name: Semantic Release
-        uses: cycjimmy/semantic-release-action@v3
-        id: semantic
+          fetch-depth: 0 # Required so semantic-release can trace git tags/history
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          extra_plugins: |
-            @semantic-release/changelog
+          node-version: 22
+
+      - name: Install Semantic Release & Plugins
+        # Installs semantic-release and its plugins on the runner
+        run: |
+          npm install -g semantic-release \
+            @semantic-release/changelog \
+            @semantic-release/npm \
+            @semantic-release/github \
             @semantic-release/git
-            @semantic-release/github
+
+      - name: Run Semantic Release (Native)
+        id: semantic
+        # This will automatically pick up your export default config file in the repository root
+        run: npx semantic-release
         env:
-          GITHUB_TOKEN: "${{ secrets.GITHUB }}"
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
           NPM_TOKEN: "${{ secrets.NPM_TOKEN }}"
+
     outputs:
       new_release_published: "${{ steps.semantic.outputs.new_release_published }}"
-      new_release_version: "${{ steps.semantic.outputs.new_release_version }}"
-  upload:
-    runs-on: ubuntu-latest
-    needs: release
-    if: needs.release.outputs.new_release_published == 'true'
-    env:
-      VERSION: "${{ needs.release.outputs.new_release_version }}"
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - name: Set npm registry auth
-        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc
-      - name: Install dependencies
-        run: yarn install
-      
-      - name: Set Environment Variables
-        run: |
-          echo "organization_id=${{ secrets.COCREATE_ORGANIZATION_ID }}" >> $GITHUB_ENV
-          echo "key=${{ secrets.COCREATE_KEY }}" >> $GITHUB_ENV
-          echo "host=${{ secrets.COCREATE_HOST }}" >> $GITHUB_ENV
-      - name: CoCreate Upload
-        run: coc upload
-
+      new_release_version: "${{ steps.semantic.outputs.new_release_version }}"

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+# [1.4.0](https://github.com/CoCreate-app/CoCreate-usage/compare/v1.3.0...v1.4.0) (2026-07-18)
+
+
+### Features
+
+* enhance event listener handling and improve logging for organization deletion ([cca2e40](https://github.com/CoCreate-app/CoCreate-usage/commit/cca2e408ba2c6599aab2b56430b1d74b923fbb57))
+* refactor usage tracking with new bandwidth management and event listeners ([76f8ddb](https://github.com/CoCreate-app/CoCreate-usage/commit/76f8ddb539ad6a3384ed5d1557b1e36b9d64222a))
+
+# [1.3.0](https://github.com/CoCreate-app/CoCreate-usage/compare/v1.2.2...v1.3.0) (2026-07-17)
+
+
+### Features
+
+* update automated workflow and release configuration for improved semantic release handling ([47aa8c2](https://github.com/CoCreate-app/CoCreate-usage/commit/47aa8c2941f8393a0ca55cbf6f66ae4df1172dea))
+
+## [1.2.2](https://github.com/CoCreate-app/CoCreate-usage/compare/v1.2.1...v1.2.2) (2026-07-14)
+
+
+### Bug Fixes
+
+* remove unnecessary console logs in init function for cleaner output ([af5f039](https://github.com/CoCreate-app/CoCreate-usage/commit/af5f03958fa5e84008411e99186bcdea438e7087))
+* removed post install ([933f2b6](https://github.com/CoCreate-app/CoCreate-usage/commit/933f2b6b9a7a551afb7e2723bfd02de9a72f2019))
+* semantic version handling. Reorganize .gitignore for improved clarity and structure ([9d67031](https://github.com/CoCreate-app/CoCreate-usage/commit/9d67031f6144a5b767ff0a2b6d487b14cbbd33aa))
+* update module export to ES6 syntax in release.config.js ([8908cb7](https://github.com/CoCreate-app/CoCreate-usage/commit/8908cb7ea61ceb65d1151909e8706c0a54046903))
+* update organization ID reference and host variable in sendUsageUpdate function ([4f4cc11](https://github.com/CoCreate-app/CoCreate-usage/commit/4f4cc11f9d0757b27c71f180ce83895fb2c436cd))
+* update package.json to use ESM and restructure entry points ([c96c5db](https://github.com/CoCreate-app/CoCreate-usage/commit/c96c5db22a621d2af2a151d2173ffaa265c03f6e))
+
 ## [1.2.1](https://github.com/CoCreate-app/CoCreate-usage/compare/v1.2.0...v1.2.1) (2025-05-01)
 
 

package/package.json

@@ -1,18 +1,10 @@
 {
   "name": "@cocreate/usage",
-  "version": "1.2.1",
+  "version": "1.4.0",
   "description": "CoCreate-usage",
   "keywords": [
     "cocreate-usage",
-    "cocreate",
-    "low-code-framework",
-    "no-code-framework",
-    "cocreatejs",
-    "cocreatejs-component",
-    "cocreate-framework",
-    "no-code",
     "low-code",
-    "collaborative-framework",
     "realtime",
     "realtime-framework",
     "collaboration",
@@ -20,6 +12,7 @@
     "html5-framework",
     "javascript-framework"
   ],
+  "type": "module",
   "main": "./src/index.js",
   "publishConfig": {
     "access": "public"
@@ -36,7 +29,6 @@
   "homepage": "https://cocreate.app/docs/CoCreate-usage",
   "scripts": {
     "demo": "PORT=5000 node demo/server.js",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "postinstall": "node -e \"const { execSync } = require('child_process'); try { execSync('coc --version', { stdio: 'ignore' }); } catch (error) { try { execSync('npm install -g @cocreate/cli', { stdio: 'inherit' }); console.log('Installed \"@cocreate/cli\" globally.'); } catch (error) { console.error('Failed to install \"@cocreate/cli\" globally:', error); } }\""
+    "test": "echo \"Error: no test specified\" && exit 1"
   }
 }

package/release.config.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   dryRun: false,
   branches: ["master"],
   plugins: [
@@ -10,12 +10,20 @@ module.exports = {
         changelogFile: "CHANGELOG.md",
       },
     ],
-    "@semantic-release/npm",
-    "@semantic-release/github",
+    "@semantic-release/npm", 
     [
-      "@semantic-release/git",
+      "@semantic-release/github", 
       {
+        successComment: false,
+        failTitle: false,
+      },
+    ],
+    [
+      "@semantic-release/git", 
+      {
+        // Only stage and commit the changelog and package.json
         assets: ["CHANGELOG.md", "package.json"],
+        message: "chore(release): ${nextRelease.version} [skip ci]",
       },
     ],
   ],

package/src/index.js

@@ -1,208 +1,288 @@
+/********************************************************************************
+ * Copyright (C) 2023 CoCreate and Contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ ********************************************************************************/
+
+import crud from '@cocreate/crud-server';
+
 class CoCreateUsage {
-    constructor(crud) {
-        this.wsManager = crud.wsManager;
-        this.crud = crud;
-        this.init();
-        this.organizations = new Map()
-    }
+    constructor(platformOrgId) {
+        this.platformOrgId = platformOrgId; // Master platform organization ID
 
-    init() {
-        if (this.wsManager) {
-            this.wsManager.on('setBandwidth', (data) => this.setBandwidth(data));
-        }
+        // Constants
+        this.FLUSH_THRESHOLD_BYTES = 10 * 1024 * 1024; // 10 Megabytes
+        this.TENANT_INTERVAL_MS = 60 * 1000;            // 1 Minute
+
+        // Double-buffer map tracking separate platform and tenant blocks per organization
+        this.bandwidthMap = new Map();
+
+        // Initialize the Event Listeners
+        this.initEventListeners();
     }
 
+    /**
+     * Connects directly to process event signals.
+     */
+    initEventListeners() {
+        // Unified Application-Wide System Interceptor
+        // Expects an input object: { organization_id, data, type: 'ingress' | 'egress' }
+        process.on('usage', (payload) => {
+            if (!payload || typeof payload !== 'object') return;
+            
+            const { organization_id, data, type } = payload;
+            if (organization_id) {
+                this.trackUsage(organization_id, data, type || 'ingress');
+            }
+        });
+
+        // Dynamic Eviction Loop: Caught via native process messaging.
+        // Triggers clean flushes and timer de-allocations during standard disconnects or orchestrator shutdowns.
+        process.on('orgDeleted', async (organization_id) => {
+            if (this.bandwidthMap.has(organization_id)) {
+                console.log(`[USAGE] Event Received: Flushing pending data pipelines for Org: ${organization_id}`);
+                try {
+                    await this.flushAndClearSingle(organization_id);
+                    console.log(`[USAGE] Flushing Completed: Memory registry successfully cleared for Org: ${organization_id}`);
+                } catch (err) {
+                    console.error(`[USAGE ERROR] Failed to cleanly flush data during orgDeleted event for ${organization_id}:`, err);
+                }
+            }
+        });
+    }
 
-    async setBandwidth({ type, data, organization_id }) {
+    /**
+     * High-performance, robust byte-calculation routine.
+     * Accurately parses binary files (images, video chunks), text responses, and data objects.
+     */
+    calculatePayloadBytes(data) {
+        if (data === null || data === undefined) return 0;
+        
         try {
-            let dataTransfered = this.getBytes(data)
-
-            if (!dataTransfered || !organization_id)
-                return
-            // TODO: set duration 
-            let org = this.organizations.get(organization_id)
-            if (!org) {
-                let self = this
-
-                org = {}
-                org.debounce = setTimeout(() => {
-                    self.send(org, organization_id, data.host); // Call the callback to display the count
-                    self.organizations.delete(organization_id)
-                }, 60000);
-
-                org.dataTransferedIn = 0;
-                org.dataTransferedInCount = 0;
-                org.dataTransferedOut = 0;
-                org.dataTransferedOutCount = 0;
-
-                this.organizations.set(organization_id, org)
+            // Case 1: Raw media streams, files, or binary chunks (Buffers / TypedArrays)
+            if (Buffer.isBuffer(data)) {
+                return data.length;
             }
-
-            if (type === 'in') {
-                org.dataTransferedIn = dataTransfered;
-                org.dataTransferedInCount++
-            } else if (type === 'out') {
-                org.dataTransferedOut = dataTransfered;
-                org.dataTransferedOutCount++
-            } else {
-                console.log('else')
+            if (data instanceof Uint8Array || data.buffer instanceof ArrayBuffer) {
+                return data.byteLength || data.length || 0;
             }
-
+            
+            // Case 2: Plain Text / Base64 Encoded Strings
+            if (typeof data === 'string') {
+                return Buffer.byteLength(data, 'utf8');
+            }
+            
+            // Case 3: Native JavaScript Objects & Arrays (Database schemas, API JSON packets)
+            if (typeof data === 'object') {
+                return Buffer.byteLength(JSON.stringify(data), 'utf8');
+            }
+            
+            // Case 4: Fallback for primitive datatypes (numbers, booleans, etc.)
+            return Buffer.byteLength(String(data), 'utf8');
         } catch (error) {
-            console.log('Usage error', error)
+            console.error('[USAGE ERROR] Failed to safely calculate payload byte scale:', error);
+            return 0;
         }
     }
 
-
-    async send(org, organization_id, host) {
-        delete org.debounce
-
-        org.dataTransferedOut += 250
-        org.dataTransferedOutCount++
-
-        const platformOrganization = this.crud.config.organization_id
-        let organization = await this.crud.send({
-            method: 'object.read',
-            host: this.crud.config.host,
-            array: 'organizations',
-            object: { _id: organization_id },
-            organization_id: platformOrganization
-        })
-
-        org.dataTransferedIn += this.getBytes(platformOrganization)
-        org.dataTransferedInCount++
-
-        if (organization && organization.object && organization.object[0]) {
-            organization = organization.object[0]
-        } else return
-
-        //TODO: if (organization.transactionInterval) // set in global map to use with timeout 1 sec intervals to 3600 sec
-        if (this.wsManager.organizations.has(organization_id)) {
-            if (organization.balance <= 0) {
-                this.wsManager.organizations.get(organization_id).status = false
-                this.wsManager.organizations.get(organization_id).organizationBalance = false
-                this.wsManager.organizations.get(organization_id).error = 'Your balance has fallen bellow 0'
-
-            } else {
-                this.wsManager.organizations.get(organization_id).status = true
-                this.wsManager.organizations.get(organization_id).organizationBalance = true
-                this.wsManager.organizations.get(organization_id).error = ''
-            }
+    /**
+     * Main entry point to track incoming traffic.
+     */
+    trackUsage(organization_id, data, direction = 'ingress') {
+        const now = Date.now();
+        const incomingBytes = this.calculatePayloadBytes(data);
+
+        // If this is a brand new organization session, initialize our distinct tracking layers
+        if (!this.bandwidthMap.has(organization_id)) {
+            const tenantTimer = setInterval(() => {
+                this.flushTenantWindow(organization_id);
+            }, this.TENANT_INTERVAL_MS);
+
+            this.bandwidthMap.set(organization_id, {
+                // Buffer A: Tenant 1-minute accumulator (system_usage)
+                tenant: {
+                    ingressBytes: 0,
+                    egressBytes: 0,
+                    totalBytes: 0,
+                    count: 0,
+                    sampleStart: now,
+                    sampleEnd: now
+                },
+                // Buffer B: Platform master accumulator (system_bandwidth)
+                platform: {
+                    ingressBytes: 0,
+                    egressBytes: 0,
+                    totalBytes: 0,
+                    count: 0,
+                    sampleStart: now,
+                    sampleEnd: now
+                },
+                tenantTimer
+            });
         }
 
-        let timeStamp = new Date(new Date().toISOString());
-        let isExpired = false
-        if (organization.lastDeposit) {
-            let lastDeposit = new Date(organization.lastDeposit)
-            isExpired = lastDeposit <= timeStamp.setFullYear(timeStamp.getFullYear() - 1)
-        }
+        const stats = this.bandwidthMap.get(organization_id);
 
-        let isResetDataTransfer = false
-        if (organization.modified && organization.modified.on) {
-            let previousTimeStamp = new Date(organization.modified.on)
-            if (previousTimeStamp.getMonth() !== timeStamp.getMonth()) {
-                isResetDataTransfer = true
-                this.crud.send({
-                    method: 'object.create',
-                    host: this.crud.config.host,
-                    array: 'transactions',
-                    object: {
-                        organization_id,
-                        type: "withdrawal", // deposit, credit, withdrawal, debit
-                        dataTransfered: organization.dataTransfered,
-                        previousTimeStamp
-                    },
-                    organization_id: platformOrganization,
-                    timeStamp
-                });
-                organization.dataTransfered = 0
-            }
+        // 1. Accumulate Tenant Buffer (Flushes on interval)
+        if (direction === 'ingress') {
+            stats.tenant.ingressBytes += incomingBytes;
+        } else if (direction === 'egress') {
+            stats.tenant.egressBytes += incomingBytes;
         }
-
-        let dataTransfered = org.dataTransferedIn + org.dataTransferedOut
-        dataTransfered = dataTransfered / 1073741824;
-        dataTransfered = dataTransfered.toFixed(32);
-        dataTransfered = parseFloat(dataTransfered);
-
-        let rate = this.getRate(organization.dataTransfered)
-        let amount = dataTransfered * rate
-        amount = -amount
-        amount = amount.toFixed(32)
-        amount = parseFloat(amount)
-
-        let balanceUpdate = {
-            method: 'object.update',
-            host: this.crud.config.host,
-            array: 'organizations',
-            object: { _id: organization_id },
-            organization_id: platformOrganization,
-            timeStamp
+        stats.tenant.totalBytes += incomingBytes;
+        stats.tenant.count += 1;
+        stats.tenant.sampleEnd = now;
+
+        // 2. Accumulate Platform Buffer (Flushes on event triggers / 10MB only)
+        if (direction === 'ingress') {
+            stats.platform.ingressBytes += incomingBytes;
+        } else if (direction === 'egress') {
+            stats.platform.egressBytes += incomingBytes;
         }
+        stats.platform.totalBytes += incomingBytes;
+        stats.platform.count += 1;
+        stats.platform.sampleEnd = now;
 
-        if (isExpired)
-            balanceUpdate.object['balance'] = 0
-        else
-            balanceUpdate.object.$inc = { balance: amount }
-
-        if (isResetDataTransfer)
-            balanceUpdate.object['dataTransfered'] = 0
-        else if (!balanceUpdate.object.$inc)
-            balanceUpdate.object.$inc = { dataTransfered }
-        else
-            balanceUpdate.object.$inc.dataTransfered = dataTransfered
-
-        // console.log('balanceUpdate: ', balanceUpdate)
-
-        this.crud.send(balanceUpdate)
-
-        let transaction = {
-            method: 'object.create',
-            host,
-            array: 'transactions',
-            object: {
-                organization_id,
-                type: "withdrawal", // deposit, credit, withdrawal, debit
-                amount,
-                rate,
-                dataTransfered,
-                ...org
-            },
-            organization_id,
-            timeStamp
+        // 3. Platform Trigger: Flush to the master platform ledger if we hit 10MB
+        if (stats.platform.totalBytes >= this.FLUSH_THRESHOLD_BYTES) {
+            this.flushPlatformWindow(organization_id);
         }
+    }
 
-        this.crud.send(transaction);
-
+    /**
+     * PIPELINE A: Handles the 1-minute interval flush to the client tenant's database
+     */
+    async flushTenantWindow(organization_id) {
+        const stats = this.bandwidthMap.get(organization_id);
+        if (!stats || stats.tenant.totalBytes === 0) return;
+
+        const tenantData = stats.tenant;
+
+        // Save exactly one document representing this complete 1-minute segment to their partition
+        await this.saveToTenantBilling(organization_id, tenantData);
+
+        // Reset ONLY the tenant accumulator to begin a fresh 1-minute block
+        const now = Date.now();
+        stats.tenant = {
+            ingressBytes: 0,
+            egressBytes: 0,
+            totalBytes: 0,
+            count: 0,
+            sampleStart: now,
+            sampleEnd: now
+        };
     }
 
-    getBytes(data) {
-        if (typeof data === 'number')
-            return data;
-        else if (data instanceof Buffer)
-            return data.byteLength || 0;
-        else if (data instanceof String || typeof data === 'string')
-            return Buffer.byteLength(data, 'utf8') || 0;
-        else if (typeof data === 'object')
-            return Buffer.byteLength(JSON.stringify(data), 'utf8') || 0;
-        else return 0
+    /**
+     * PIPELINE B: Handles targeted platform flushes (when 10MB limit is reached)
+     */
+    async flushPlatformWindow(organization_id) {
+        const stats = this.bandwidthMap.get(organization_id);
+        if (!stats || stats.platform.totalBytes === 0) return;
+
+        const platformData = stats.platform;
+
+        // Save platform ledger record
+        await this.saveToLedgerDatabase(organization_id, platformData);
+
+        // Reset ONLY the platform long-term memory accumulator
+        const now = Date.now();
+        stats.platform = {
+            ingressBytes: 0,
+            egressBytes: 0,
+            totalBytes: 0,
+            count: 0,
+            sampleStart: now,
+            sampleEnd: now
+        };
     }
 
-    getRate(totalUsage = 0) {
-        const tiers = [
-            { limit: 1, rate: 10 },
-            { limit: 10, rate: 5 },
-            { limit: 100, rate: 2.5 },
-            { limit: 1000, rate: 1.125 },
-            { limit: 10000, rate: 0.562 },
-            { limit: 100000, rate: 0.281 },
-            { limit: 1000000, rate: 0.145 }
-        ];
+    /**
+     * Target eviction: Clears timers and flushes all outstanding tenant & platform balances
+     */
+    async flushAndClearSingle(organization_id) {
+        const stats = this.bandwidthMap.get(organization_id);
+        if (!stats) return;
+
+        // De-allocate the 1-minute background loop instantly
+        if (stats.tenantTimer) {
+            clearInterval(stats.tenantTimer);
+        }
+
+        // Flush any partial unsaved records remaining in either pipeline
+        await Promise.all([
+            this.flushTenantWindow(organization_id),
+            this.flushPlatformWindow(organization_id)
+        ]);
 
-        const matchingTier = tiers.find(tier => totalUsage < tier.limit);
+        // Evict from active tracker
+        this.bandwidthMap.delete(organization_id);
+    }
 
-        return matchingTier ? matchingTier.rate : 0.12;
+    /**
+     * CRUD Adapter: Platform Bandwidth Collection (Private time-series log)
+     * Writes into the platform's sandbox segment, cataloging target clients in "organization".
+     */
+    async saveToLedgerDatabase(organization_id, stats) {
+        try {
+            await crud.send({
+                method: 'object.create',
+                array: 'system_bandwidth',
+                object: {
+                    organization_id: this.platformOrgId, // Platform workspace sandbox route
+                    organization: organization_id,       // The actual client tenant who generated the bandwidth
+                    ingressBytes: stats.ingressBytes,
+                    egressBytes: stats.egressBytes,
+                    totalBytes: stats.totalBytes,
+                    totalRequests: stats.count,
+                    sampleStart: new Date(stats.sampleStart),
+                    sampleEnd: new Date(stats.sampleEnd),
+                    durationMs: stats.sampleEnd - stats.sampleStart,
+                    processed: false                     // Ready for asynchronous billing calculations
+                },
+                organization_id: this.platformOrgId      // Outermost routing targeting the Platform's DB partition
+            });
+        } catch (error) {
+            console.error(`[DB ERROR] Failed to write to system_bandwidth for ${organization_id}:`, error);
+        }
     }
 
+    /**
+     * CRUD Adapter: Tenant Usage Collection (Their 1-Minute Dashboard Stream)
+     * Writes directly to the tenant's partition under the safe, system namespace "system_usage"
+     */
+    async saveToTenantBilling(organization_id, stats) {
+        try {
+            await crud.send({
+                method: 'object.create',
+                array: 'system_usage',
+                object: {
+                    organization_id,                     // Tenant's sandbox segment route
+                    ingressBytes: stats.ingressBytes,
+                    egressBytes: stats.egressBytes,
+                    totalBytes: stats.totalBytes,
+                    totalRequests: stats.count,
+                    sampleStart: new Date(stats.sampleStart),
+                    sampleEnd: new Date(stats.sampleEnd),
+                    durationMs: stats.sampleEnd - stats.sampleStart
+                },
+                organization_id: organization_id         // Outermost routing targeting the Client's DB partition
+            });
+        } catch (error) {
+            console.error(`[DB ERROR] Failed to write to system_usage for ${organization_id}:`, error);
+        }
+    }
 }
 
-module.exports = CoCreateUsage;
+export default CoCreateUsage;