@flowcore/cli 1.1.2 → 1.3.0

package/CHANGELOG.md

@@ -7,6 +7,25 @@
 
 
 
+## [1.3.0](https://github.com/flowcore-io/flowcore-cli/compare/v1.2.0...v1.3.0) (2024-01-09)
+
+
+### Features
+
+* added timeout for destination as flag ([f731aac](https://github.com/flowcore-io/flowcore-cli/commit/f731aac025262179af1fd56e2ab2477a674635f9))
+
+
+### Bug Fixes
+
+* added description to start that includes week ([58687a7](https://github.com/flowcore-io/flowcore-cli/commit/58687a7bbb66aaa5d6da26af88e555cbb1e72467))
+
+## [1.2.0](https://github.com/flowcore-io/flowcore-cli/compare/v1.1.2...v1.2.0) (2024-01-09)
+
+
+### Features
+
+* added multiple events, added weeks functionality to start time ([9a2f8cc](https://github.com/flowcore-io/flowcore-cli/commit/9a2f8cc5e4c5dd885f5cab6c3fbd886caf6b482d))
+
 ## [1.1.2](https://github.com/flowcore-io/flowcore-cli/compare/v1.1.1...v1.1.2) (2024-01-09)
 
 

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @flowcore/cli
 $ flowcore COMMAND
 running command...
 $ flowcore (--version)
-@flowcore/cli/1.1.2 linux-x64 node-v20.10.0
+@flowcore/cli/1.3.0 linux-x64 node-v20.10.0
 $ flowcore --help [COMMAND]
 USAGE
   $ flowcore COMMAND
@@ -103,7 +103,7 @@ EXAMPLES
   $ flowcore config set -l https://auth.flowcore.io/realms/flowcore/.well-known/openid-configuration -c my-client-id -p
 ```
 
-_See code: [src/commands/config/set.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.1.2/src/commands/config/set.ts)_
+_See code: [src/commands/config/set.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.3.0/src/commands/config/set.ts)_
 
 ## `flowcore config show`
 
@@ -123,7 +123,7 @@ EXAMPLES
   $ flowcore config show
 ```
 
-_See code: [src/commands/config/show.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.1.2/src/commands/config/show.ts)_
+_See code: [src/commands/config/show.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.3.0/src/commands/config/show.ts)_
 
 ## `flowcore help [COMMANDS]`
 
@@ -166,7 +166,7 @@ EXAMPLES
   $ flowcore login --port 8080
 ```
 
-_See code: [src/commands/login.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.1.2/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.3.0/src/commands/login.ts)_
 
 ## `flowcore plugins`
 
@@ -449,7 +449,7 @@ Stream events from a datacore running on the Flowcore Platform
 
 ```
 USAGE
-  $ flowcore stream STREAM [--profile <value>] [-d <value>] [-j] [-l] [-o http|log] [-s <value>]
+  $ flowcore stream STREAM [--profile <value>] [-d <value>] [-j] [-l] [-o http|log] [-s <value>] [-t <value>]
 
 ARGUMENTS
   STREAM  stream url to connect to
@@ -460,17 +460,24 @@ FLAGS
   -l, --[no-]live            Change to live mode when reaching last time bucket
   -o, --output=<option>      [default: http] Output format
                              <options: http|log>
-  -s, --start=<value>        Start time bucket to stream from, example: (1y, 1m, 1d, 1h)
+  -s, --start=<value>        Start time bucket to stream from, example: (1y, 1m, 1w, 1d, 1h)
+  -t, --timeout=<value>      [default: 5000] Timeout in milliseconds to wait for a response from the destination
       --profile=<value>      Specify the configuration profile to use
 
 DESCRIPTION
   Stream events from a datacore running on the Flowcore Platform
 
 EXAMPLES
-  $ flowcore stream https://staging.flowcore.io/flowcore/flowcore-platform/organization.0/event.organization.subscription.updated-requested.0.stream
+  $ flowcore stream https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream
+
+  $ flowcore stream https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream -s 1y
+
+  $ flowcore stream https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream -o log -s 3m --json > some.json
+
+  $ flowcore stream https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream -o log -s 3m
 ```
 
-_See code: [src/commands/stream.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.1.2/src/commands/stream.ts)_
+_See code: [src/commands/stream.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.3.0/src/commands/stream.ts)_
 
 ## `flowcore version`
 
@@ -507,5 +514,5 @@ DESCRIPTION
   Check what user you are logged in as
 ```
 
-_See code: [src/commands/whoami.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.1.2/src/commands/whoami.ts)_
+_See code: [src/commands/whoami.ts](https://github.com/flowcore-io/flowcore-cli/blob/v1.3.0/src/commands/whoami.ts)_
 <!-- commandsstop -->

package/dist/commands/stream.d.ts

@@ -11,6 +11,7 @@ export default class Stream extends BaseCommand<typeof Stream> {
         live: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         output: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         start: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        timeout: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
     };
     run(): Promise<void>;
     private processEvents;

package/dist/commands/stream.js

@@ -19,14 +19,18 @@ export default class Stream extends BaseCommand {
     };
     static description = 'Stream events from a datacore running on the Flowcore Platform';
     static examples = [
-        '<%= config.bin %> <%= command.id %> https://staging.flowcore.io/flowcore/flowcore-platform/organization.0/event.organization.subscription.updated-requested.0.stream',
+        '<%= config.bin %> <%= command.id %> https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream',
+        '<%= config.bin %> <%= command.id %> https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream -s 1y',
+        '<%= config.bin %> <%= command.id %> https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream -o log -s 3m --json > some.json',
+        '<%= config.bin %> <%= command.id %> https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream -o log -s 3m',
     ];
     static flags = {
         destination: Flags.string({ char: 'd', default: "http://localhost:3000/transform", description: 'Destination to send events to' }),
         json: Flags.boolean({ char: 'j', description: 'Output json only' }),
         live: Flags.boolean({ allowNo: true, char: 'l', default: true, description: 'Change to live mode when reaching last time bucket' }),
         output: Flags.string({ char: 'o', default: 'http', description: 'Output format', options: ['http', 'log'] }),
-        start: Flags.string({ char: 's', description: 'Start time bucket to stream from, example: (1y, 1m, 1d, 1h)' }),
+        start: Flags.string({ char: 's', description: 'Start time bucket to stream from, example: (1y, 1m, 1w, 1d, 1h)' }),
+        timeout: Flags.integer({ char: 't', default: 5000, description: 'Timeout in milliseconds to wait for a response from the destination' }),
     };
     async run() {
         const config = this.cliConfiguration.getConfig();
@@ -53,7 +57,7 @@ export default class Stream extends BaseCommand {
         const org = parts[1];
         const dataCore = parts[2];
         const aggregator = parts[3];
-        const eventType = parts[4].replace(/\.stream$/i, "");
+        const eventTypes = parts[4].replace(/\.stream$/i, "").replace("[", "").replace("]", "").split(",");
         const fetchDataCoreResponse = await graphqlClient.client.request(FETCH_DATA_CORE_GQL_QUERY, {
             dataCore,
             organization: org,
@@ -63,7 +67,7 @@ export default class Stream extends BaseCommand {
             aggregator,
             dataCoreId,
         });
-        let firstTimeBucket = eventRangeRequest.datacore.flowtypes.find(ft => ft.aggregator === aggregator)?.events.find(e => e.name === eventType)?.catalog.range.firstTimeBucket;
+        let firstTimeBucket = eventRangeRequest.datacore.flowtypes.find(ft => ft.aggregator === aggregator)?.events.find(e => eventTypes.includes(e.name))?.catalog.range.firstTimeBucket;
         if (!firstTimeBucket && !flags.start) {
             firstTimeBucket = createTimebucket(dayjs());
             !this.flags.json && this.warn(`First time bucket not found, setting to current time (${ux.colorize("yellowBright", firstTimeBucket)})`);
@@ -76,15 +80,15 @@ export default class Stream extends BaseCommand {
             firstTimeBucket = this.setTimeBucket(dayjs(), "1d");
             !this.flags.json && this.log(ux.colorize("green", `Setting first time bucket to ${ux.colorize("yellow", "1d")} ago (${ux.colorize("yellowBright", firstTimeBucket)})`));
         }
-        let lastTimeBucket = eventRangeRequest.datacore.flowtypes.find(ft => ft.aggregator === aggregator)?.events.find(e => e.name === eventType)?.catalog.range.lastTimeBucket;
+        let lastTimeBucket = eventRangeRequest.datacore.flowtypes.find(ft => ft.aggregator === aggregator)?.events.find(e => eventTypes.includes(e.name))?.catalog.range.lastTimeBucket;
         if (!lastTimeBucket) {
             lastTimeBucket = createTimebucket(dayjs());
             !this.flags.json && this.warn(`Last time bucket not found, setting to current time (${ux.colorize("yellowBright", lastTimeBucket)})`);
         }
         const observer = new Subject();
-        !this.flags.json && this.log(ux.colorize("blackBright", `Starting to stream events for ${dataCoreId} - ${aggregator} - ${eventType}, press ${ux.colorize("whiteBright", "ctrl+c")} to stop`));
+        !this.flags.json && this.log(ux.colorize("blackBright", `Starting to stream events for ${dataCoreId} - ${aggregator} - ${eventTypes}, press ${ux.colorize("whiteBright", "ctrl+c")} to stop`));
         // eslint-disable-next-line no-void
-        void this.streamEvents(dataCoreId, aggregator, eventType, firstTimeBucket, lastTimeBucket, graphqlClient, observer, flags.live);
+        void this.streamEvents(dataCoreId, aggregator, eventTypes, firstTimeBucket, lastTimeBucket, graphqlClient, observer, flags.live);
         await this.processEvents(observer, flags.destination, flags.output);
     }
     async processEvents(observer, destination, output) {
@@ -120,13 +124,14 @@ export default class Stream extends BaseCommand {
                 !this.flags.json && this.log(`Sending event to ${destination}: ${event.eventId}`);
                 try {
                     // eslint-disable-next-line no-await-in-loop
-                    const result = await fetch(destination, {
-                        body: JSON.stringify(event),
-                        headers: {
-                            "Content-Type": "application/json",
-                        },
-                        method: "POST",
-                    });
+                    const result = await Promise.race([fetch(destination, {
+                            body: JSON.stringify(event),
+                            headers: {
+                                "Content-Type": "application/json",
+                            },
+                            method: "POST",
+                        }),
+                        new Promise((resolve, reject) => { setTimeout(() => reject(new Error("Timeout waiting for response")), this.flags.timeout); }),]);
                     if (!result.ok) {
                         !this.flags.json && this.warn(`Error sending event to ${destination}: ${result.statusText}`);
                     }
@@ -150,7 +155,7 @@ export default class Stream extends BaseCommand {
         }
     }
     setTimeBucket(date, start) {
-        const parts = start.match(/(\d+)([dhmy])/i);
+        const parts = start.match(/(\d+)([dhmwy])/i);
         if (!parts) {
             ux.error(`Invalid start time bucket, generated from ${start}`);
         }
@@ -161,6 +166,9 @@ export default class Stream extends BaseCommand {
             case "m": {
                 return createTimebucket(date.subtract(Number.parseInt(parts[1], 10), "month"));
             }
+            case "w": {
+                return createTimebucket(date.subtract(Number.parseInt(parts[1], 10), "week"));
+            }
             case "d": {
                 return createTimebucket(date.subtract(Number.parseInt(parts[1], 10), "day"));
             }
@@ -172,7 +180,7 @@ export default class Stream extends BaseCommand {
             }
         }
     }
-    async streamEvents(dataCoreId, aggregator, eventType, firstTimeBucket, lastTimeBucket, graphqlClient, observer, live) {
+    async streamEvents(dataCoreId, aggregator, eventTypes, firstTimeBucket, lastTimeBucket, graphqlClient, observer, live) {
         let startTimeBucket = dayjs(firstTimeBucket, TIME_BUCKET_HOUR_PATTERN);
         const currentTime = dayjs.utc();
         let liveMode = false;
@@ -197,7 +205,7 @@ export default class Stream extends BaseCommand {
                         afterEventId: lastEventId || undefined,
                         aggregator,
                         dataCoreId,
-                        eventType,
+                        eventTypes,
                         timeBucket,
                     });
                     cursor = response.datacore.fetchEvents.cursor;

package/dist/utils/queries/fetch-events.gql.d.ts

@@ -21,7 +21,7 @@ export type FetchEventsQueryInput = {
     beforeEventId?: string;
     cursor?: string;
     dataCoreId: string;
-    eventType: string;
+    eventTypes: string[];
     pageSize?: number;
     timeBucket: string;
 };

package/dist/utils/queries/fetch-events.gql.js

@@ -1,10 +1,10 @@
 import { gql } from "graphql-request";
 export const FETCH_EVENTS_GQL_QUERY = gql `
-  query FLOWCORE_CLI_FETCH_EVENTS($dataCoreId: ID!, $aggregator: String!, $eventType: String!, $timeBucket: String!, $cursor: String, $afterEventId: String, $beforeEventId: String, $pageSize: Int) {
+  query FLOWCORE_CLI_FETCH_EVENTS($dataCoreId: ID!, $aggregator: String!, $eventTypes: [String!]!, $timeBucket: String!, $cursor: String, $afterEventId: String, $beforeEventId: String, $pageSize: Int) {
     datacore(search: {id: $dataCoreId}) {
       fetchEvents(input: {
         aggregator: $aggregator,
-        eventTypes: [$eventType],
+        eventTypes: $eventTypes,
         timeBucket: $timeBucket
         cursor: $cursor
         afterEventId: $afterEventId

package/oclif.manifest.json

@@ -52,7 +52,10 @@
       },
       "description": "Stream events from a datacore running on the Flowcore Platform",
       "examples": [
-        "<%= config.bin %> <%= command.id %> https://staging.flowcore.io/flowcore/flowcore-platform/organization.0/event.organization.subscription.updated-requested.0.stream"
+        "<%= config.bin %> <%= command.id %> https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream",
+        "<%= config.bin %> <%= command.id %> https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream -s 1y",
+        "<%= config.bin %> <%= command.id %> https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream -o log -s 3m --json > some.json",
+        "<%= config.bin %> <%= command.id %> https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream -o log -s 3m"
       ],
       "flags": {
         "profile": {
@@ -100,11 +103,20 @@
         },
         "start": {
           "char": "s",
-          "description": "Start time bucket to stream from, example: (1y, 1m, 1d, 1h)",
+          "description": "Start time bucket to stream from, example: (1y, 1m, 1w, 1d, 1h)",
           "name": "start",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "timeout": {
+          "char": "t",
+          "description": "Timeout in milliseconds to wait for a response from the destination",
+          "name": "timeout",
+          "default": 5000,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -256,5 +268,5 @@
       ]
     }
   },
-  "version": "1.1.2"
+  "version": "1.3.0"
 }

package/package.json

@@ -86,7 +86,7 @@
     "prestart": "npm run build",
     "update-schema": "rover graph introspect https://graph.api.staging.flowcore.io/graphql -o schema.gql"
   },
-  "version": "1.1.2",
+  "version": "1.3.0",
   "bugs": "https://github.com/flowcore-io/flowcore-cli/issues",
   "keywords": [
     "flowcore",