Skip to content

SDK triggers components skeleton #14637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 12, 2024
Merged

SDK triggers components skeleton #14637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc3681b
SDK triggers scaffolding
dannyroosevelt Nov 12, 2024
6b33e8a
Moving source files into corresponding folders
dannyroosevelt Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions components/sdk/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@pipedream/sdk",
"version": "0.0.1",
"version": "0.1.0",
"description": "Pipedream SDK Components",
"main": "sdk.app.mjs",
"keywords": [
Expand All @@ -12,4 +12,4 @@
"publishConfig": {
"access": "public"
}
}
}
8 changes: 1 addition & 7 deletions components/sdk/sdk.app.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,4 @@ export default {
type: "app",
app: "sdk",
propDefinitions: {},
methods: {
// this.$auth contains connected account data
authKeys() {
console.log(Object.keys(this.$auth));
},
},
};
};
14 changes: 14 additions & 0 deletions components/sdk/sources/nextjs-event-received/nextjs-event-received.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import sdk from "../../sdk.app.mjs";

export default {
name: "New Event Received from the Next.js Pipedream SDK",
version: "0.0.1",
key: "sdk-nextjs-event-received",
description: "Emit new event via the Next.js Pipedream SDK.",
Comment on lines +3 to +7
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Component metadata needs version alignment

The component version (0.0.1) should align with the SDK version (0.1.0) mentioned in the PR summary for consistency.

  name: "New Event Received from the Next.js Pipedream SDK",
- version: "0.0.1",
+ version: "0.1.0",
  key: "sdk-nextjs-event-received",
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
export default {
name: "New Event Received from the Next.js Pipedream SDK",
version: "0.0.1",
key: "sdk-nextjs-event-received",
description: "Emit new event via the Next.js Pipedream SDK.",
export default {
name: "New Event Received from the Next.js Pipedream SDK",
version: "0.1.0",
key: "sdk-nextjs-event-received",
description: "Emit new event via the Next.js Pipedream SDK.",

props: {
sdk,
},
type: "source",
methods: {},
async run() {},
Comment on lines +11 to +13
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Empty methods object and run implementation

The component has an empty methods object and run function, which makes it non-functional in its current state.

The source component needs at least:

  1. Basic event handling in the run method
  2. Helper methods for processing Next.js specific requests
  3. Error handling

Here's a suggested implementation:

  type: "source",
- methods: {},
- async run() {},
+ methods: {
+   generateMeta(event) {
+     return {
+       id: event.id || uuid(),
+       summary: "New Next.js Event",
+       ts: Date.now(),
+     };
+   },
+ },
+ async run(event) {
+   const { body, headers } = event;
+   
+   if (!body) {
+     throw new Error("No event body received");
+   }
+   
+   const meta = this.generateMeta(body);
+   this.$emit(body, meta);
+   
+   return {
+     status: 200,
+     body: {
+       success: true,
+     },
+   };
+ },

Committable suggestion skipped: line range outside the PR's diff.

};
14 changes: 14 additions & 0 deletions components/sdk/sources/nodejs-event-received/nodejs-event-received.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import sdk from "../../sdk.app.mjs";

export default {
name: "New Event Received from the Node.js Pipedream SDK",
version: "0.0.1",
key: "sdk-nodejs-event-received",
description: "Emit new event via the Node.js Pipedream SDK.",
Comment on lines +4 to +7
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Version number should match SDK version

The component version (0.0.1) is inconsistent with the SDK version (0.1.0) mentioned in the changes. Consider aligning these versions for better version tracking.

-  version: "0.0.1",
+  version: "0.1.0",

Enhance the component description

The current description is quite brief. Consider adding more details about:

  • What triggers the event
  • What data is emitted
  • Common use cases

Committable suggestion skipped: line range outside the PR's diff.

props: {
sdk,
},
type: "source",
methods: {},
async run() {},
Comment on lines +11 to +13
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

⚠️ Potential issue

Implement the run() method

The run() method is currently empty. It should:

  1. Handle incoming events
  2. Include proper error handling
  3. Implement retry logic for failed operations
  4. Add logging for debugging purposes

Would you like me to help create a basic implementation with these features?

Add input validation

Consider adding validation methods to verify incoming events before processing:

methods: {
  validateEvent(event) {
    // Add validation logic
  },
},

};
14 changes: 14 additions & 0 deletions components/sdk/sources/nuxtjs-event-received/nuxtjs-event-received.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import sdk from "../../sdk.app.mjs";

export default {
name: "New Event Received from the Nuxt.js Pipedream SDK",
version: "0.0.1",
key: "sdk-nuxtjs-event-received",
description: "Emit new event via the Nuxt.js Pipedream SDK.",
Comment on lines +4 to +7
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Version inconsistency detected

The component version (0.0.1) doesn't match the SDK package version (0.1.0) mentioned in the summary. This might cause confusion about compatibility.

-  version: "0.0.1",
+  version: "0.1.0",
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
name: "New Event Received from the Nuxt.js Pipedream SDK",
version: "0.0.1",
key: "sdk-nuxtjs-event-received",
description: "Emit new event via the Nuxt.js Pipedream SDK.",
name: "New Event Received from the Nuxt.js Pipedream SDK",
version: "0.1.0",
key: "sdk-nuxtjs-event-received",
description: "Emit new event via the Nuxt.js Pipedream SDK.",

props: {
sdk,
},
type: "source",
methods: {},
async run() {},
Comment on lines +12 to +13
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Implement required source component methods

The empty methods object and run implementation need to be completed. At minimum, implement:

  1. Event handling logic in run
  2. Error handling
  3. Input validation
  4. Event emission

Here's a suggested implementation structure:

methods: {
  validateEvent(event) {
    // Add validation logic
  },
  async processEvent(event) {
    // Add processing logic
  }
},
async run({ event }) {
  try {
    this.validateEvent(event);
    await this.processEvent(event);
    
    // Emit the processed event
    this.$emit(event, {
      summary: `New event received from Nuxt.js SDK`,
      ts: Date.now(),
    });
  } catch (error) {
    console.error("Error processing Nuxt.js event:", error);
    throw error;
  }
}

Would you like me to create a GitHub issue to track the implementation of these methods?

};
Comment on lines +1 to +14
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Component 'sdk-nuxtjs-event-received' Not Registered in SDK's Component Registry

The component is not referenced in any SDK registry or main export files.

🔗 Analysis chain

Verify component registration

Let's verify if this component is properly registered in the SDK's component registry.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the component is registered in the SDK's main exports or component registry

# Look for component registration files
echo "Searching for component registration files..."
fd -e json -e js -e mjs -t f "registry|index|main" --full-path components/sdk

# Check if this component is referenced in any of these files
rg -l "sdk-nuxtjs-event-received" components/sdk

Length of output: 300

14 changes: 14 additions & 0 deletions components/sdk/sources/python-event-received/python-event-received.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import sdk from "../../sdk.app.mjs";

export default {
name: "New Event Received from the Python Pipedream SDK",
version: "0.0.1",
key: "sdk-python-event-received",
description: "Emit new event via the Python Pipedream SDK.",
props: {
sdk,
},
type: "source",
methods: {},
async run() {},
};
14 changes: 14 additions & 0 deletions components/sdk/sources/reactjs-event-received/reactjs-event-received.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import sdk from "../../sdk.app.mjs";

export default {
name: "New Event Received from the React.js Pipedream SDK",
version: "0.0.1",
key: "sdk-reactjs-event-received",
description: "Emit new event via the React.js Pipedream SDK.",
props: {
sdk,
},
type: "source",
methods: {},
async run() {},
};
Comment on lines +12 to +14
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Implementation required: Add core source component functionality

The component is currently a skeleton without implementation. A source component typically needs:

  1. Event emission handling
  2. Error handling and validation
  3. Lifecycle methods (e.g., deploy, dedupe)

Would you like me to help create a basic implementation with these essential features? I can also create a GitHub issue to track this implementation task.

Additionally, consider adding these method stubs:

   type: "source",
-  methods: {},
+  methods: {
+    // Emit events received from React.js applications
+    async emitEvent(event) {
+      // TODO: Implement event emission logic
+    },
+    // Validate incoming events
+    validateEvent(event) {
+      // TODO: Implement event validation
+    },
+  },
-  async run() {},
+  async run(event) {
+    // TODO: Implement main event processing logic
+    // 1. Validate incoming event
+    // 2. Process event data
+    // 3. Emit event to workflow
+  },

Committable suggestion skipped: line range outside the PR's diff.

14 changes: 14 additions & 0 deletions components/sdk/sources/vue-event-received/vue-event-received.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import sdk from "../../sdk.app.mjs";

export default {
name: "New Event Received from the Vue Pipedream SDK",
version: "0.0.1",
key: "sdk-vue-event-received",
description: "Emit new event via the Vue Pipedream SDK.",
props: {
sdk,
},
type: "source",
methods: {},
async run() {},
};
Loading