bulltrackers-module 1.0.739 → 1.0.740

package/functions/computation-system-v2/core-api.js

@@ -0,0 +1,88 @@
+/**
+ * @fileoverview Core System API
+ * Contains the business logic and orchestrator management.
+ * Separated from index.js to prevent circular dependencies with handlers.
+ */
+
+const { Orchestrator } = require('./framework');
+const config = require('./config/bulltrackers.config');
+const { ManifestBuilder } = require('./framework/core/Manifest');
+const { Computation } = require('./framework/core/Computation');
+
+// Add computations to config
+config.computations = [
+    require('./computations/UserPortfolioSummary'),
+    require('./computations/PopularInvestorProfileMetrics'),
+    require('./computations/PopularInvestorRiskAssessment'),
+    require('./computations/PopularInvestorRiskMetrics'),
+    // Add more computations here as they're migrated
+];
+
+// Singleton orchestrator instance
+let orchestrator = null;
+
+async function getOrchestrator(customConfig = null, logger = null) {
+    if (!orchestrator || customConfig) {
+        const cfg = customConfig || config;
+        orchestrator = new Orchestrator(cfg, logger);
+    }
+    return orchestrator;
+}
+
+async function analyze(options) {
+    const { date, config: customConfig = null, logger = null } = options;
+    const orch = await getOrchestrator(customConfig, logger);
+    return orch.analyze({ date });
+}
+
+async function execute(options) {
+    const { date, pass = null, computation = null, dryRun = false, entities = null, config: customConfig = null, logger = null } = options;
+    const orch = await getOrchestrator(customConfig, logger);
+    return orch.execute({ date, pass, computation, dryRun, entities });
+}
+
+async function runComputation(options) {
+    const { date, computation, entityIds = null, dryRun = false, force = false, useWorkerPool, config: customConfig = null, logger = null } = options;
+    const orch = await getOrchestrator(customConfig, logger);
+
+    if (!orch.manifest) await orch.initialize();
+
+    const normalizedName = computation.toLowerCase().replace(/[^a-z0-9]/g, '');
+    const entry = orch.manifest.find(c => c.name === normalizedName);
+
+    if (!entry) throw new Error(`Computation not found: ${computation}`);
+
+    return orch.runSingle(entry, date, { entityIds, dryRun, force, useWorkerPool });
+}
+
+async function getManifest(options = {}) {
+    const { config: customConfig = null, logger = null } = options;
+    const orch = await getOrchestrator(customConfig, logger);
+    if (!orch.manifest) await orch.initialize();
+    return orch.manifest;
+}
+
+async function warmCache(options = {}) {
+    const { config: customConfig = null, logger = null } = options;
+    const orch = await getOrchestrator(customConfig, logger);
+    const allTables = Object.keys(orch.config.tables);
+    return orch.schemaRegistry.warmCache(allTables);
+}
+
+function reset() {
+    orchestrator = null;
+}
+
+module.exports = {
+    analyze,
+    execute,
+    runComputation,
+    getManifest,
+    warmCache,
+    reset,
+    getOrchestrator,
+    config,
+    ManifestBuilder,
+    Computation,
+    ...require('./framework')
+};

package/functions/computation-system-v2/docs/admin.md

@@ -1,9 +1,35 @@
+Here is the updated `admin.md` file. I have replaced the hardcoded placeholder URL with a dynamic variable (`$FUNCTION_URL`) and corrected the token generation command to remove the invalid `--audiences` flag.
+
+This version is copy-paste ready for your terminal.
+
+### `computation-system-v2/docs/admin.md`
+
+```markdown
 # Admin Test Endpoint
 
 ## Deploy
 
 ```bash
 node deploy.mjs ComputeAdminTest
+
+```
+
+## Setup (Run Before Testing)
+
+First, retrieve your function's actual URL and generate an authentication token.
+
+```bash
+# 1. Get the Function URL dynamically
+# (Adjust region if not in europe-west1)
+FUNCTION_URL=$(gcloud functions describe compute-admin-test \
+    --region=europe-west1 \
+    --format="value(serviceConfig.uri)")
+
+# 2. Generate an Identity Token (Standard User account)
+TOKEN=$(gcloud auth print-identity-token)
+
+echo "Targeting: $FUNCTION_URL"
+
 ```
 
 ## Usage Examples
@@ -11,81 +37,81 @@ node deploy.mjs ComputeAdminTest
 ### 1. Check System Status
 
 ```bash
-TOKEN=$(gcloud auth print-identity-token --audiences="https://europe-west1-stocks-12345.cloudfunctions.net/compute-admin-test")
-
-curl -X POST \
-    "https://europe-west1-stocks-12345.cloudfunctions.net/compute-admin-test" \
+curl -X POST "$FUNCTION_URL" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"action": "status"}'
+
 ```
 
 ### 2. Analyze What Would Run
 
 ```bash
-curl -X POST \
-    "https://europe-west1-stocks-12345.cloudfunctions.net/compute-admin-test" \
+curl -X POST "$FUNCTION_URL" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"action": "analyze", "date": "2026-01-25"}'
+
 ```
 
 ### 3. Run Full Computation
 
 ```bash
-curl -X POST \
-    "https://europe-west1-stocks-12345.cloudfunctions.net/compute-admin-test" \
+curl -X POST "$FUNCTION_URL" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"action": "run", "computation": "UserPortfolioSummary", "date": "2026-01-25", "force": true}'
+
 ```
 
 ### 4. Run Limited Test
 
 ```bash
-curl -X POST \
-    "https://europe-west1-stocks-12345.cloudfunctions.net/compute-admin-test" \
+curl -X POST "$FUNCTION_URL" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"action": "run_limited", "computation": "UserPortfolioSummary", "date": "2026-01-25", "limit": 5}'
+
 ```
 
 ### 5. Test Specific Entities
 
 ```bash
-curl -X POST \
-    "https://europe-west1-stocks-12345.cloudfunctions.net/compute-admin-test" \
+curl -X POST "$FUNCTION_URL" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"action": "run", "computation": "UserPortfolioSummary", "date": "2026-01-25", "entityIds": ["user-123", "user-456"], "force": true}'
+
 ```
 
 ### 6. Test Worker Directly
 
 ```bash
-curl -X POST \
-    "https://europe-west1-stocks-12345.cloudfunctions.net/compute-admin-test" \
+curl -X POST "$FUNCTION_URL" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"action": "test_worker", "computation": "UserPortfolioSummary", "date": "2026-01-25", "entityIds": ["user-123"]}'
+
 ```
 
 ### 7. Test with Worker Pool Override
 
 ```bash
-curl -X POST \
-    "https://europe-west1-stocks-12345.cloudfunctions.net/compute-admin-test" \
+curl -X POST "$FUNCTION_URL" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"action": "run", "computation": "UserPortfolioSummary", "date": "2026-01-25", "useWorkerPool": true, "force": true}'
+
 ```
 
 ## Available Actions
 
 | Action | Description |
-|--------|-------------|
+| --- | --- |
 | `status` | List all computations and system status |
 | `analyze` | Check what would run for a given date |
 | `run` | Execute a full computation |
 | `run_limited` | Execute on N random entities (safer for testing) |
-| `test_worker` | Direct test of worker function logic |
+| `test_worker` | Direct test of worker function logic |
+
+```

package/functions/computation-system-v2/handlers/adminTest.js

@@ -17,8 +17,7 @@
  *     -d '{"action": "run", "computation": "UserPortfolioSummary", "date": "2026-01-25"}'
  */
 
-const system = require('../index');
-
+const system = require('../core-api');
 /**
  * Admin test handler.
  */

package/functions/computation-system-v2/index.js

@@ -1,184 +1,12 @@
 /**
  * @fileoverview Computation System v2 Entry Point
- * * Usage:
- * const { execute, analyze, runComputation } = require('./computation-system-v2');
- * * // Analyze what can run
- * const report = await analyze({ date: '2026-01-24' });
- * * // Execute computations (Monolith/Scheduler mode)
- * const result = await execute({ date: '2026-01-24' });
- * * // Run single computation (Worker mode)
- * const task = await runComputation({ 
- * date: '2026-01-24', 
- * computation: 'UserPortfolioSummary' 
- * });
+ * Exports both the Core API and the Cloud Function Handlers.
  */
 
-const { Orchestrator } = require('./framework');
-const config = require('./config/bulltrackers.config');
-const { ManifestBuilder } = require('./framework/core/Manifest');
-const { Computation } = require('./framework/core/Computation');
-
-// Add computations to config
-// These are loaded from computation-system-v2/computations folder
-config.computations = [
-    require('./computations/UserPortfolioSummary'),
-    require('./computations/PopularInvestorProfileMetrics'),
-    require('./computations/PopularInvestorRiskAssessment'),
-    require('./computations/PopularInvestorRiskMetrics'),
-    // Add more computations here as they're migrated
-];
-
-// Singleton orchestrator instance
-let orchestrator = null;
-
-/**
- * Get or create the orchestrator instance.
- * @param {Object} [customConfig] - Override default config
- * @param {Object} [logger] - Custom logger
- * @returns {Promise<Orchestrator>}
- */
-async function getOrchestrator(customConfig = null, logger = null) {
-    if (!orchestrator || customConfig) {
-        const cfg = customConfig || config;
-        orchestrator = new Orchestrator(cfg, logger);
-        // Note: Orchestrator initializes lazily on first execute/analyze call, 
-        // but we can force it here if needed.
-    }
-    return orchestrator;
-}
-
-/**
- * Analyze what can run for a given date.
- * @param {Object} options
- * @param {string} options.date - Target date (YYYY-MM-DD)
- * @param {Object} [options.config] - Override config
- * @param {Object} [options.logger] - Custom logger
- * @returns {Promise<Object>} Analysis report
- */
-async function analyze(options) {
-    const { date, config: customConfig = null, logger = null } = options;
-    const orch = await getOrchestrator(customConfig, logger);
-    return orch.analyze({ date });
-}
-
-/**
- * Execute computations for a given date.
- * (Used by Scheduler or Monolithic runs)
- */
-async function execute(options) {
-    const { 
-        date, 
-        pass = null, 
-        computation = null, 
-        dryRun = false,
-        entities = null,
-        config: customConfig = null, 
-        logger = null 
-    } = options;
-    
-    const orch = await getOrchestrator(customConfig, logger);
-    return orch.execute({ date, pass, computation, dryRun, entities });
-}
-
-/**
- * WORKER ENTRY POINT: Run a single computation.
- * (Used by Cloud Functions / Dispatcher)
- * 
- * @param {Object} options
- * @param {string} options.date - Target date (YYYY-MM-DD)
- * @param {string} options.computation - Computation name
- * @param {string[]} [options.entityIds] - Specific entities to run (null = all)
- * @param {boolean} [options.dryRun] - If true, don't persist results
- * @param {boolean} [options.force] - If true, bypass up-to-date checks
- * @param {boolean} [options.useWorkerPool] - Override worker pool setting (undefined = use config)
- * @param {Object} [options.config] - Override config
- * @param {Object} [options.logger] - Custom logger
- */
-async function runComputation(options) {
-    const {
-        date,
-        computation,
-        entityIds = null,
-        dryRun = false,
-        force = false,
-        useWorkerPool,  // Runtime override for worker pool
-        config: customConfig = null,
-        logger = null
-    } = options;
-
-    const orch = await getOrchestrator(customConfig, logger);
-
-    // 1. Ensure manifest is built
-    if (!orch.manifest) await orch.initialize();
-
-    // 2. Find the specific entry
-    // We normalize to handle case-insensitivity
-    const normalizedName = computation.toLowerCase().replace(/[^a-z0-9]/g, '');
-    const entry = orch.manifest.find(c => c.name === normalizedName);
-
-    if (!entry) {
-        throw new Error(`Computation not found: ${computation}`);
-    }
-
-    // 3. Delegate to Orchestrator's runSingle
-    // This handles dependencies, data fetching, middleware, etc.
-    return orch.runSingle(entry, date, { 
-        entityIds, 
-        dryRun,
-        force,
-        useWorkerPool  // Pass override to Orchestrator
-    });
-}
-
-/**
- * Get the manifest (list of all computations with metadata).
- */
-async function getManifest(options = {}) {
-    const { config: customConfig = null, logger = null } = options;
-    const orch = await getOrchestrator(customConfig, logger);
-    if (!orch.manifest) await orch.initialize();
-    return orch.manifest;
-}
-
-/**
- * Warm the schema cache for all tables.
- */
-async function warmCache(options = {}) {
-    const { config: customConfig = null, logger = null } = options;
-    const orch = await getOrchestrator(customConfig, logger);
-    const allTables = Object.keys(orch.config.tables);
-    return orch.schemaRegistry.warmCache(allTables);
-}
-
-/**
- * Reset the singleton (useful for testing).
- */
-function reset() {
-    orchestrator = null;
-}
-
-// Import handlers for Cloud Functions
+const coreApi = require('./core-api');
 const handlers = require('./handlers');
 
 module.exports = {
-    // Main API
-    analyze,
-    execute,
-    ManifestBuilder,
-    Computation,
-
-    runComputation, // <--- New Method
-    getManifest,
-    warmCache,
-    reset,
-    
-    // For advanced usage
-    getOrchestrator,
-    config,
-    
-    // Cloud Function handlers
-    ...handlers,
-    
-    // Re-export framework components
-    ...require('./framework')
+    ...coreApi,
+    ...handlers
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bulltrackers-module",
-  "version": "1.0.739",
+  "version": "1.0.740",
   "description": "Helper Functions for Bulltrackers.",
   "main": "index.js",
   "files": [