Skip to content
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.

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

Twilio migration to low code. #40248

Closed
wants to merge 48 commits into from
Closed

Conversation

cmm-airbyte
Copy link
Contributor

@cmm-airbyte cmm-airbyte commented Jun 24, 2024

What & how

Migrating Twilio connector to low code.

Review guide

  1. manifest.yaml

User Impact

This must be transparent for users.

Can this PR be safely reverted and rolled back?

  • YES πŸ’š
  • NO ❌

Copy link

vercel bot commented Jun 24, 2024

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
airbyte-docs βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Jul 21, 2024 10:35pm

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


cristina.mariscal seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@cmm-airbyte cmm-airbyte changed the title Twilio accounts migration to low code WIP Twilio Accounts and Addresses streams migration to low code. Jun 26, 2024
@cmm-airbyte cmm-airbyte force-pushed the cmm-airbyte/twilioLCAccounts branch from c848546 to 560e9a4 Compare June 27, 2024 00:02
@girarda girarda requested a review from artem1205 July 10, 2024 00:12
Copy link

coderabbitai bot commented Jul 10, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)
  • coderabbit-ai-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@maxi297 maxi297 left a comment

Choose a reason for hiding this comment

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

Testing Manually

I have only tested the streams mentioned below although there are many more. I was using our sandbox account. Can we investigate the ones marked as to be investigated?

accounts

[Accepted change] Pagination has been removed from the account streams which makes request go from https://api.twilio.com/2010-04-01/Accounts.json?PageSize=1000 to https://api.twilio.com/2010-04-01/Accounts.json?

addresses

OK

available_phone_number_countries

OK

available_phone_numbers_local

[to be investigated] Getting Not found. The requested resource was not found on the server when the connector queries https://api.twilio.com/2010-04-01/Accounts/****/AvailablePhoneNumbers/BE/Local.json?PageSize=1000

available_phone_numbers_mobile

[to be investigated] Getting Not found. The requested resource was not found on the server when the connector queries https://api.twilio.com/2010-04-01/Accounts/****/AvailablePhoneNumbers/AR/Mobile.json?PageSize=1000

available_phone_numbers_toll-Free

[to be investigated] This stream was added in the manifest version but does not exist in the current version

incoming_phone_numbers

OK

keys

OK

flows

OK

step

[to be investigated] The latest version produces two records while the manifest one does not have any record. While reading through the logs of the manifest version output, I can see The requested resource /Flows/FW7ad717a690629a6da33bd3c8b9cf7d97/Executions/FN9715cbc94b32ed1090874270ad72efb7/Steps was not found

alerts

[to be investigated] There is a mismatch between the records. I get 4 from the latest version and 6 from the CDK one. Trying to match the first one of the latest version, I can't match 100% with any of the manifest one.

applications

OK

dependent_phone_numbers

[to be investigated] I get The requested resource /2010-04-01/Accounts/AC4cac489c46197c9ebc91c840120a4dee/Addresses/AD0164001bc0f84d9bc29e17378fe47c20/DependentPhoneNumbers.json was not found with the manifest version

}
}
}
```
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could you please add steps how to migrate to new version for the users? for example refresh source schema + clear data for affected streams. You can find an example in migration guide for other connectors(tiktok, slack)

breakingChanges:
1.0.0:
message: This release changes the state format of existing connections.
upgradeDeadline: "2024-12-01"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please add scopedImpact here

- $ref: "#/definitions/streams/Users"
- $ref: "#/definitions/streams/User Conversations"

spec:
Copy link
Collaborator

Choose a reason for hiding this comment

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

we have spec in manifest and in spec.json, should we delete one of them?

definitions:
base_requester:
type: HttpRequester
url_base: https://
Copy link
Collaborator

Choose a reason for hiding this comment

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

should we add https://api.twilio.com/2010-04-01 here to url_base, instead of defining it in requester.path for each stream?

type: MinMaxDatetime
datetime: "{{ now_utc().strftime('%Y-%m-%dT%H:%M:%SZ') }}"
datetime_format: "%Y-%m-%dT%H:%M:%SZ"
cursor_granularity: P1D
Copy link
Collaborator

Choose a reason for hiding this comment

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

should cursor_granularity be 1s in this case because we have datetime format with seconds precision? doesn't P1D lead to missing records?

- type: AddedFieldDefinition
path:
- date_created
value: '{% set formatted_datetime = format_datetime(record["date_created"], "%Y-%m-%dT%H:%M:%SZ", "%a, %d %b %Y %H:%M:%S %z") %}{{ formatted_datetime }}'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just a question, what was the reason to change the format of date related fields?

fields:
- type: AddedFieldDefinition
path:
- duration
Copy link
Collaborator

Choose a reason for hiding this comment

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

You can add schema_normalization: Default to record selector and it will autotransform fields like this into type from the schema, so you don't need to transform them here.

@natikgadzhi
Copy link
Contributor

@girarda if you'd like, community devs team would love to help out with any remaining low-code migrations, including Twilio. I think @pabloescoder will have capacity soon.

@pabloescoder
Copy link
Collaborator

@natikgadzhi @girarda Sure! I would certainly love to pick up any low code migrations including Twilio. Please let me know if there are any I could take up.

@natikgadzhi
Copy link
Contributor

@pabloescoder wait for @girarda's blessing before getting started

@pabloescoder
Copy link
Collaborator

@natikgadzhi Haha I'll wait πŸ˜„

@girarda
Copy link
Contributor

girarda commented Jul 31, 2024

Hello @pabloescoder, sorry for the delays. thank you for offering! your help would be much welcomed here!

@pabloescoder
Copy link
Collaborator

No problem! Apologies for the late reply. I'll look into it right away! @girarda

@natikgadzhi
Copy link
Contributor

@pabloescoder I've put this on our project board and set the priority. Still important to get to!

@pabloescoder
Copy link
Collaborator

@pabloescoder I've put this on our project board and set the priority. Still important to get to!

Sorry! This slipped out of my radar, will pick it up soon

@natikgadzhi
Copy link
Contributor

@pabloescoder taking after the quickbooks tasks?

@pabloescoder
Copy link
Collaborator

@natikgadzhi Yes! Let's wrap up with quickbooks by this weekend or early next week, then I'll start with this. It's been delayed for a long time.

@girarda girarda closed this Jan 28, 2025
@natikgadzhi
Copy link
Contributor

@pabloescoder this is still valid to work on, but you probably can use this as reference and start from scratch. Also, we should go to manifest-only and just make a schema-close-to-compatible version from scratch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/twilio
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants