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 1 commit
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.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.",
props: {
sdk,
},
type: "source",
methods: {},
async run() {},
};
14 changes: 14 additions & 0 deletions components/sdk/sources/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.",
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 version does not match package version

The component version is "0.0.1", while the @pipedream/sdk package version is "0.1.0". Please update the component version to align with the package version.

🔗 Analysis chain

Version inconsistency with package version

The component version is set to "0.0.1" while the @pipedream/sdk package has been updated to "0.1.0". Consider aligning these versions for consistency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check SDK package version
cat components/sdk/package.json | jq '.version'

Length of output: 55

props: {
sdk,
},
type: "source",
methods: {},
async run() {},
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 incomplete - Add required source methods

As a source component, this should implement standard source methods:

  1. The empty methods object should include standard source lifecycle methods
  2. The run() method needs implementation for event handling

Consider adding:

  • deploy() for source initialization
  • dedupe() for event deduplication
  • Event processing logic in run()

Would you like me to provide a skeleton implementation of these required methods?

};
14 changes: 14 additions & 0 deletions components/sdk/sources/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.",
props: {
sdk,
},
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

Add standard source component properties

The component is missing common source properties that might be useful for event handling and deduplication.

   props: {
     sdk,
+    app: {
+      type: "app",
+      app: "sdk",
+    },
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: 60,
+      },
+    },
+    db: "$.service.db",
   },

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

type: "source",
methods: {},
async run() {},
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 component is missing critical functionality for event handling and processing.

Essential methods needed:

  1. Event processing in the run method
  2. Deduplication logic
  3. Error handling
  4. Proper SDK event emission handling

Would you like me to provide a complete implementation example or create an issue to track this task?

};
14 changes: 14 additions & 0 deletions components/sdk/sources/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.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";
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

SDK import missing required methods

The sdk.app.mjs no longer exports authKeys. Please update the import and usage accordingly.

🔗 Analysis chain

Verify SDK import and available methods

Let's ensure the SDK import path is correct and verify the available methods after the removal of authKeys.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify SDK import path and exported members

# Check if sdk.app.mjs exists and show its exports
fd -e mjs -e js "sdk.app" -x cat {} \; | grep -A 5 "export"

# Find all SDK imports across the codebase for consistency
rg "import.*sdk.*from.*sdk\.app"

Length of output: 20439


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.",
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 number inconsistency with package

The component version is set to "0.0.1" while the package @pipedream/sdk is being updated to "0.1.0". Consider aligning these versions for consistency.

-  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 React.js Pipedream SDK",
version: "0.0.1",
key: "sdk-reactjs-event-received",
description: "Emit new event via the React.js Pipedream SDK.",
name: "New Event Received from the React.js Pipedream SDK",
version: "0.1.0",
key: "sdk-reactjs-event-received",
description: "Emit new event via the React.js Pipedream SDK.",

props: {
sdk,
},
type: "source",
methods: {},
async run() {},
};
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

Add essential source component methods

The component structure needs implementation details and common source methods:

  • Event validation
  • Error handling
  • Rate limiting
  • Cleanup
   type: "source",
-  methods: {},
+  methods: {
+    // Validate incoming events
+    validateEvent(event) {
+      if (!event?.type) {
+        throw new Error("Event type is required");
+      }
+    },
+    // Handle errors
+    handleError(error) {
+      console.error("Error processing event:", error);
+      throw error;
+    },
+  },
-  async run() {},
+  async run(event) {
+    try {
+      this.validateEvent(event);
+      // Process and emit the event
+      this.$emit(event, {
+        summary: `New ${event.type} event received`,
+        ts: Date.now(),
+      });
+    } catch (error) {
+      this.handleError(error);
+    }
+  },
📝 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
type: "source",
methods: {},
async run() {},
};
type: "source",
methods: {
// Validate incoming events
validateEvent(event) {
if (!event?.type) {
throw new Error("Event type is required");
}
},
// Handle errors
handleError(error) {
console.error("Error processing event:", error);
throw error;
},
},
async run(event) {
try {
this.validateEvent(event);
// Process and emit the event
this.$emit(event, {
summary: `New ${event.type} event received`,
ts: Date.now(),
});
} catch (error) {
this.handleError(error);
}
},
};

14 changes: 14 additions & 0 deletions components/sdk/sources/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