Google Workspace Admin - add eventName filter to sources #17535
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
WalkthroughA new Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GoogleWorkspaceSource
participant GoogleWorkspaceAPI
User->>GoogleWorkspaceSource: Configure source with eventName filter
GoogleWorkspaceSource->>GoogleWorkspaceAPI: Fetch admin activity events
GoogleWorkspaceAPI-->>GoogleWorkspaceSource: Return list of events
loop For each event
GoogleWorkspaceSource->>GoogleWorkspaceSource: isCorrectEventType(event)
alt Event matches eventName or filter not set
GoogleWorkspaceSource->>User: Process event
else Event does not match
GoogleWorkspaceSource->>GoogleWorkspaceSource: Skip event
end
end
Assessment against linked issues
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
components/google_workspace/sources/common/common.tsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
components/google_workspace/sources/new-admin-activity-by-app-name/new-admin-activity-by-app-name.ts (1)
7-9: Fix misleading description stringThe
descriptionstill references “selected user”, which is inaccurate for this source (it filters by application name). This can confuse users browsing the component catalog.- description: "Emit new admin activities by selected user", + description: "Emit new admin activities by application name",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (6)
components/google_workspace/package.json(2 hunks)components/google_workspace/sources/common/common.ts(4 hunks)components/google_workspace/sources/new-admin-activity-by-app-name/new-admin-activity-by-app-name.ts(1 hunks)components/google_workspace/sources/new-admin-activity-by-user-and-app-name/new-admin-activity-by-user-and-app-name.ts(1 hunks)components/google_workspace/sources/new-admin-activity-by-user/new-admin-activity-by-user.ts(1 hunks)components/google_workspace/sources/new-admin-activity/new-admin-activity.ts(1 hunks)
🧰 Additional context used
🧠 Learnings (7)
📓 Common learnings
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#15376
File: components/monday/sources/name-updated/name-updated.mjs:6-6
Timestamp: 2025-01-23T03:55:15.166Z
Learning: Source names in Monday.com components don't need to start with "New" if they emit events for updated items (e.g., "Name Updated", "Column Value Updated") rather than new items. This follows the component guidelines exception where the "New" prefix is only required when emits are limited to new items.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#14265
File: components/the_magic_drip/sources/common.mjs:35-43
Timestamp: 2024-10-10T19:18:27.998Z
Learning: In `components/the_magic_drip/sources/common.mjs`, when processing items in `getAndProcessData`, `savedIds` is intentionally updated with IDs of both emitted and non-emitted items to avoid emitting retroactive events upon first deployment and ensure only new events are emitted as they occur.
components/google_workspace/sources/new-admin-activity/new-admin-activity.ts (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
components/google_workspace/sources/new-admin-activity-by-user-and-app-name/new-admin-activity-by-user-and-app-name.ts (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
components/google_workspace/package.json (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
components/google_workspace/sources/new-admin-activity-by-app-name/new-admin-activity-by-app-name.ts (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
components/google_workspace/sources/new-admin-activity-by-user/new-admin-activity-by-user.ts (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
components/google_workspace/sources/common/common.ts (4)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#15376
File: components/monday/sources/name-updated/name-updated.mjs:6-6
Timestamp: 2025-01-23T03:55:15.166Z
Learning: Source names in Monday.com components don't need to start with "New" if they emit events for updated items (e.g., "Name Updated", "Column Value Updated") rather than new items. This follows the component guidelines exception where the "New" prefix is only required when emits are limited to new items.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-10-08T15:33:38.240Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-07-24T02:06:47.016Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#14265
File: components/the_magic_drip/sources/common.mjs:35-43
Timestamp: 2024-10-10T19:18:27.998Z
Learning: In `components/the_magic_drip/sources/common.mjs`, when processing items in `getAndProcessData`, `savedIds` is intentionally updated with IDs of both emitted and non-emitted items to avoid emitting retroactive events upon first deployment and ensure only new events are emitted as they occur.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Lint Code Base
- GitHub Check: Verify TypeScript components
- GitHub Check: pnpm publish
- GitHub Check: Publish TypeScript components
🔇 Additional comments (12)
components/google_workspace/package.json (2)
3-3: LGTM: Package version increment is appropriate.The version bump from 0.0.7 to 0.0.8 correctly reflects the addition of new functionality (eventName filter).
20-20: LGTM: Platform dependency update aligns with new functionality.The platform dependency update from ^1.2.0 to ^3.1.0 supports the new eventName filtering capabilities.
components/google_workspace/sources/common/common.ts (3)
7-8: LGTM: Import path adjustments are consistent.The relative path updates from
../to../../align with the directory restructuring mentioned in the PR.
22-27: LGTM: EventName prop implementation follows Pipedream patterns.The eventName prop uses propDefinition correctly to reference the googleWorkspace app's eventName property.
159-161: Event filtering integration is correctly placed.The filtering logic is properly positioned to skip events that don't match the specified eventName before emission.
components/google_workspace/sources/new-admin-activity-by-user-and-app-name/new-admin-activity-by-user-and-app-name.ts (2)
2-2: LGTM: Import path updated correctly.The import path change from
"../common"to"../common/common"aligns with the directory restructuring.
9-9: LGTM: Version increment reflects new functionality.The version bump from 0.0.4 to 0.0.5 correctly indicates the addition of eventName filtering capability.
components/google_workspace/sources/new-admin-activity/new-admin-activity.ts (2)
2-2: LGTM: Import path updated correctly.The import path change from
"../common"to"../common/common"aligns with the directory restructuring.
9-9: LGTM: Version increment reflects new functionality.The version bump from 0.0.4 to 0.0.5 correctly indicates the addition of eventName filtering capability.
components/google_workspace/sources/new-admin-activity-by-user/new-admin-activity-by-user.ts (2)
2-2: LGTM: Import path updated correctly.The import path change from
"../common"to"../common/common"aligns with the directory restructuring.
9-9: LGTM: Version increment reflects new functionality.The version bump from 0.0.4 to 0.0.5 correctly indicates the addition of eventName filtering capability.
components/google_workspace/sources/new-admin-activity-by-app-name/new-admin-activity-by-app-name.ts (1)
2-2: Import path update looks correctThe switch to
../common/commonaligns with the new file layout and matches the updates in sibling sources. No issues spotted.
luancazarine
left a comment
luancazarine
left a comment
There was a problem hiding this comment.
Hi @michelle0927, LGTM! Ready for QA!
Resolves #16966
Summary by CodeRabbit
New Features
Chores