add gusto connector example #442

fivetran-surabhisingh · 2025-10-31T18:25:30Z

Jira ticket

Closes <ADD TICKET LINK HERE, EACH PR MUST BE LINKED TO A JIRA TICKET>

Description of Change

<MENTION A SHORT DESCRIPTION OF YOUR CHANGES HERE>

Testing

<MENTION ABOUT YOUR TESTING DETAILS HERE, ATTACH SCREENSHOTS IF NEEDED (WITHOUT PII)>

Checklist

Some tips and links to help validate your PR:

Tested the connector with fivetran debug command.
Added/Updated example specific README.md file, refer here for template.
Followed Python Coding Standards, refer here

github-actions · 2025-10-31T18:26:02Z

🧹 Python Code Quality Check

⚠️ Flake8 has detected issues, please fix the issues before merging:

📎 Download full report from workflow artifacts.

📌 Only Python files changed in this PR were checked.

🔍 See how this check works

This comment is auto-updated with every commit.

Copilot

Pull Request Overview

This PR adds a new Gusto connector to fetch HR and payroll data from the Gusto API. However, the implementation uses an incorrect API pattern that is incompatible with the Fivetran Connector SDK.

Key Changes

Adds a new Gusto connector implementation at connectors/gusto/connector.py
Attempts to use decorator-based pattern with @connector decorator
Fetches employee data from Gusto API

Copilot · 2025-10-31T18:45:55Z

connectors/gusto/connector.py

+import requests
+from fivetran_connector_sdk import connector, config, state, records, log, schema


BLOCKER: Incorrect SDK imports. The Fivetran Connector SDK does not export connector, config, state, records, or schema modules in this way. The correct imports should be: from fivetran_connector_sdk import Connector, from fivetran_connector_sdk import Logging as log, and from fivetran_connector_sdk import Operations as op. See template_example_connector/connector.py for the correct pattern.

Copilot · 2025-10-31T18:45:55Z

connectors/gusto/connector.py

+Fetches HR and payroll data from Gusto API.
+"""
+
+import requests


Missing comment explaining the import. Every import must have an inline comment. Note that requests is provided by the SDK runtime and should not be included in requirements.txt. Add comment like: # For making HTTP API requests to Gusto (provided by SDK runtime)

Copilot · 2025-10-31T18:45:55Z

connectors/gusto/connector.py

+CONFIG = config.Config(
+    base_url=config.StringField(default="https://api.gusto.com"),
+    access_token=config.SecretField(description="OAuth2 access token")
+)
+
+SCHEMA = schema.Schema(
+    name="gusto_employees",
+    columns={
+        "id": schema.StringColumn(),
+        "first_name": schema.StringColumn(),
+        "last_name": schema.StringColumn(),
+        "email": schema.StringColumn(),
+        "status": schema.StringColumn(),
+    }
+)
+
+@connector(
+    name="GustoConnector",
+    version="0.1.0",
+    config=CONFIG,
+    schema=SCHEMA,
+)
+def run_connector(ctx: state.Context):


BLOCKER: The entire structure is incompatible with Fivetran Connector SDK. The SDK does not use decorators, Config classes, or Schema classes. Instead, it requires: (1) A schema(configuration: dict) function that returns a list of table dictionaries, (2) An update(configuration: dict, state: dict) function for data fetching, (3) A Connector object initialized with these functions: connector = Connector(update=update, schema=schema). Configuration should be provided via configuration.json file. See template_example_connector/connector.py for the correct implementation pattern.

Copilot · 2025-10-31T18:45:56Z

connectors/gusto/connector.py

+    response = requests.get(f"{ctx.config.base_url}/v1/employees", headers=headers)
+    response.raise_for_status()
+
+    for emp in response.json():
+        records.write("gusto_employees", emp)


BLOCKER: Incorrect operations usage. The SDK does not have a records.write() function. Instead, use op.upsert(table='gusto_employees', data=emp) after importing from fivetran_connector_sdk import Operations as op. Each upsert call must be preceded by a comment explaining its purpose.

Copilot · 2025-10-31T18:45:56Z

connectors/gusto/connector.py

+)
+def run_connector(ctx: state.Context):
+    headers = {"Authorization": f"Bearer {ctx.config.access_token}"}
+    response = requests.get(f"{ctx.config.base_url}/v1/employees", headers=headers)


Missing retry logic for API request. Network calls must implement retry logic with exponential backoff for transient failures (network errors, rate limits, 5xx errors). Limit to 3-5 retry attempts and log each retry. Example: for attempt in range(__MAX_RETRIES): try: response = requests.get(...); break except (requests.Timeout, requests.ConnectionError) as e: if attempt == __MAX_RETRIES - 1: raise; sleep_time = min(60, 2 ** attempt); time.sleep(sleep_time)

Copilot · 2025-10-31T18:45:56Z

connectors/gusto/connector.py

+    response = requests.get(f"{ctx.config.base_url}/v1/employees", headers=headers)
+    response.raise_for_status()
+
+    for emp in response.json():


Potential memory issue: response.json() loads the entire response into memory. For large employee datasets, this could cause memory overflow. If the Gusto API supports pagination, implement it to process data in chunks. If pagination is not available and datasets are guaranteed to be small, add a comment explaining why full materialization is acceptable.

Copilot · 2025-10-31T18:45:56Z

connectors/gusto/connector.py

+    for emp in response.json():
+        records.write("gusto_employees", emp)
+
+    return ctx.update_state({"last_sync": "now"})


BLOCKER: Incorrect state management. The SDK does not use ctx.update_state(). Instead, state should be updated via op.checkpoint(state) where state is a dictionary. The update function should not return anything. State checkpointing must occur after successful data operations with the required comment: # Save the progress by checkpointing the state...

Copilot · 2025-10-31T18:45:57Z

connectors/gusto/connector.py

+"""
+Gusto connector for Fivetran Connector SDK.
+Fetches HR and payroll data from Gusto API.
+"""


Module docstring should include a link to technical reference documentation. Expected format: Line 1 should be a one-line description, followed by reference links. Example from template: \"\"\"ADD ONE LINE DESCRIPTION OF YOUR CONNECTOR HERE.\\nSee the Technical Reference documentation (https://fivetran.com/docs/connectors/connector-sdk/technical-reference#update)\\nand the Best Practices documentation (https://fivetran.com/docs/connectors/connector-sdk/best-practices) for details\"\"\"

Copilot · 2025-10-31T18:45:57Z

connectors/gusto/connector.py

+"""
+Gusto connector for Fivetran Connector SDK.
+Fetches HR and payroll data from Gusto API.
+"""
+
+import requests
+from fivetran_connector_sdk import connector, config, state, records, log, schema
+
+CONFIG = config.Config(


Missing required structure. The connector is missing: (1) import json for configuration file reading, (2) schema(configuration: dict) function with required docstring, (3) update(configuration: dict, state: dict) function with required docstring, (4) Connector initialization: connector = Connector(update=update, schema=schema), (5) Main block for local debugging with if __name__ == '__main__': connector.debug(). See template_example_connector/connector.py lines 7-166 for the complete required structure.

Copilot · 2025-10-31T18:45:57Z

connectors/gusto/connector.py

+"""
+
+import requests
+from fivetran_connector_sdk import connector, config, state, records, log, schema


Import of 'log' is not used.

Suggested change

from fivetran_connector_sdk import connector, config, state, records, log, schema

from fivetran_connector_sdk import connector, config, state, records, schema

add gusto connector example

5c10a23

fivetran-surabhisingh self-assigned this Oct 31, 2025

fivetran-surabhisingh requested a review from a team as a code owner October 31, 2025 18:25

fivetran-surabhisingh added the hackathon For all the PRs related to the internal Fivetran 2025 Connector SDK Hackathon. label Oct 31, 2025

github-actions bot added the size/S PR size: small label Oct 31, 2025

fivetran-sahilkhirwal requested review from Copilot, fivetran-anushkaparashar and fivetran-sahilkhirwal October 31, 2025 18:43

Copilot AI reviewed Oct 31, 2025

View reviewed changes

		import requests
		from fivetran_connector_sdk import connector, config, state, records, log, schema

add gusto connector example #442

Are you sure you want to change the base?

add gusto connector example #442

Uh oh!

Conversation

fivetran-surabhisingh commented Oct 31, 2025

Jira ticket

Description of Change

Testing

Checklist

Uh oh!

github-actions bot commented Oct 31, 2025

🧹 Python Code Quality Check

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant