openobserve/tests/ui-testing/playwright-tests/Workflows/workflows-delivery.spec.js

/**
 * Workflows v1 — destination DELIVERY (DEL-01..02)
 *
 * Everything else in the suite proves the workflow was BUILT. These prove data
 * actually reached the destination.
 *
 * How it works — the "self-ingest sink". The destination POST is made server-side
 * (which is why NEG-06's 127.0.0.1:1 yields connection-refused), so pointing a
 * destination at OpenObserve's OWN ingest endpoint makes the app deliver into a
 * stream we control. Two facts make that assertable without polling:
 *
 *   1. batch_execution.rs applies `endpoint.headers` to every outbound request, so
 *      an Authorization header lets the workflow post into an authenticated endpoint.
 *   2. On a 2xx it calls send_output(body) — the destination node's OUTPUT *is* the
 *      sink's response. For an ingest sink that response is OpenObserve's own
 *      receipt, e.g. {"code":200,"status":[{"name":"...","successful":1,"failed":0}]}.
 *
 * So `successful: 1` is delivery confirmed by the receiving side, synchronously.
 *
 * Self-cleaning: `wf_auto_*` names and `wf_auto_sink_*` streams are both already
 * swept by cleanup.spec.js.
 */

const { test, expect, navigateToBase } = require('../utils/enhanced-baseFixtures.js');
const testLogger = require('../utils/test-logger.js');
const PageManager = require('../../pages/page-manager.js');

const uniq = () => `${Date.now().toString(36).slice(-5)}${Math.random().toString(36).slice(2, 5)}`;

const orgId = () => process.env.ORGNAME || 'default';
const sinkStream = (id) => `wf_auto_sink_${id}`;
const sinkUrl = (id) => `${process.env.ZO_BASE_URL}/api/${orgId()}/${sinkStream(id)}/_json`;
// Ingest requires auth; the destination forwards whatever headers it carries.
const basicAuth = () =>
  'Basic ' +
  Buffer.from(
    `${process.env.ZO_ROOT_USER_EMAIL}:${process.env.ZO_ROOT_USER_PASSWORD}`
  ).toString('base64');

test.describe.configure({ mode: 'parallel' });

test.describe(
  'Workflows destination delivery',
  { tag: ['@workflows', '@workflowsDelivery', '@enterprise', '@all'] },
  () => {
    let pm;

    test.beforeEach(async ({ page }, testInfo) => {
      testLogger.testStart(testInfo.title, testInfo.file);
      await navigateToBase(page);
      pm = new PageManager(page);
      await pm.workflowsPage.assertEnabled();
    });

    // DEL-01 — a reachable destination paints the SUCCESS badge. This is the missing
    // twin of NEG-06, which only ever asserted the error badge: without it, a change
    // that made every send fail would still satisfy the negative test.
    test('DEL-01: a live destination reports a successful send', async () => {
      const id = uniq();
      const name = `wf_auto_del_${id}`;
      await pm.workflowsPage.buildTriggerToDestinationAndSave({
        name,
        destName: `wf_auto_dest_${id}`,
        url: sinkUrl(id),
        headers: { Authorization: basicAuth() },
      });
      await pm.workflowsPage.goToList();
      await pm.workflowsPage.openEdit(name);
      await pm.workflowsPage.testRunFromEditor({ liveSend: true });
      await pm.workflowsPage.expectNodeTestPassed('destination');
      await pm.workflowsPage.expectNodeTestPassed('workflow_trigger');

      // A badge alone (✓ or rehearsal flask) is painted for a SUPPRESSED rehearsal too.
      // Only the destination's OUTPUT distinguishes a real send: for the self-ingest
      // sink that output is OpenObserve's own ingest receipt, where successful > 0 is
      // delivery confirmed by the receiving side. Assert it here or a change that made
      // every send silently suppress would still green this test.
      const receipt = await pm.workflowsPage.destinationIngestReceipt();
      testLogger.info('destination node output (ingest receipt)', { receipt });
      const status = (receipt.status || [])[0] || {};
      expect(status.name).toBe(sinkStream(id));
      expect(status.successful).toBeGreaterThan(0);
      expect(status.failed).toBe(0);
      testLogger.info('destination reported a successful send', { name });
    });

    // DEL-02 — the payload actually landed. The destination node's output is the
    // sink's response body, so for an ingest sink it is OpenObserve's own receipt.
    test('DEL-02: the delivered payload is ingested by the sink', async () => {
      const id = uniq();
      const name = `wf_auto_del_${id}`;
      await pm.workflowsPage.buildTriggerToDestinationAndSave({
        name,
        destName: `wf_auto_dest_${id}`,
        url: sinkUrl(id),
        headers: { Authorization: basicAuth() },
      });
      await pm.workflowsPage.goToList();
      await pm.workflowsPage.openEdit(name);
      await pm.workflowsPage.testRunFromEditor({ liveSend: true });
      await pm.workflowsPage.expectNodeTestPassed('destination');

      // The receiving side confirms it stored the record. Verified live:
      // {"code":200,"status":[{"name":"wf_auto_sink_...","successful":1,"failed":0}]}
      const receipt = await pm.workflowsPage.destinationIngestReceipt();
      testLogger.info('destination node output (ingest receipt)', { receipt });
      const status = (receipt.status || [])[0] || {};
      expect(status.name).toBe(sinkStream(id));
      expect(status.successful).toBeGreaterThan(0);
      expect(status.failed).toBe(0);
    });

    // SUP-01 — the DEFAULT path, and the safety-critical half of the decision. A Test
    // run that never touches the suppress switch must NOT dispatch, so a rehearsal can
    // never page on-call. The destination still passes (it received records) but its
    // output is the {"suppressed": true} preview, not a delivery receipt, and no sink
    // stream is created.
    test('SUP-01: a default test run suppresses the destination (no real send)', async () => {
      const id = uniq();
      const name = `wf_auto_del_${id}`;
      await pm.workflowsPage.buildTriggerToDestinationAndSave({
        name,
        destName: `wf_auto_dest_${id}`,
        url: sinkUrl(id),
        headers: { Authorization: basicAuth() },
      });
      await pm.workflowsPage.goToList();
      await pm.workflowsPage.openEdit(name);
      // No liveSend — suppression stays ON. Runs the drawer with the default (safe) state.
      await pm.workflowsPage.testRunFromEditor();
      await pm.workflowsPage.expectNodeTestRehearsal('destination');

      const preview = await pm.workflowsPage.destinationSuppressionPreview();
      testLogger.info('destination node output (suppression preview)', { preview });
      expect(preview.suppressed).toBe(true);
      expect(preview.record_count).toBeGreaterThan(0);
      expect(preview.destination_id).toBe(`wf_auto_dest_${id}`);
      // A real delivery receipt carries status[]; its absence proves no sink was created.
      expect(preview.status).toBeUndefined();
      testLogger.info('default test run suppressed the destination', { name });
    });
  }
);