[2/n][dagster-fivetran] Update DagsterFivetranTranslator and related classes for rework

[maximearmstrong]

Summary & Motivation

Builds out a very barebones translator class for the new version of the Fivetran integration.

The implementation for this translator will be inspired by the DagsterFivetranTranslator introduced in #25557, but a new implementation is required to leverage the workspace context and state-backed definitions, which is incompatible with the current translator and way of building assets.

Edit after Ben's comment here:

Move things around under translator.py. This PR leverages the DagsterFivetranTranslator introduced in introduced in #25557. FivetranWorkspaceData will implement the method to_fivetran_connector_table_props_data in a subsequent PR, that will map raw connector and destination data fetched using the Fivetran API into FivetranConnectorTableProps objects, that are compatible with the translator. This process will match what we currently do.

How I Tested These Changes

Tests will be added in subsequent PRs.

[maximearmstrong]

• [11/n][dagster-fivetran] Implement materialization method in FivetranWorkspace #25961 : 3 dependent PRs (#26009 , #26025 , #26181 )
• [dagster-fivetran] Use Fivetran translator instance in load specs fn and state-backed defs #26133
• [10/n][dagster-fivetran] Implement fivetran_assets and build_fivetran_assets_definitions #25944
• [dagster-fivetran] Implement resync_and_poll method in FivetranClient #26062
• [dagster-fivetran] Implement sync_and_poll method in FivetranClient #26061
• [dagster-fivetran] Implement base poll method in FivetranClient #26060
• [dagster-fivetran] Implement base resync method in FivetranClient #26059
• [9/n][dagster-fivetran] Implement base sync methods in FivetranClient #25911
• [8/n][dagster-fivetran] Implement FivetranConnector and FivetranDestination #25889
• [7/n][dagster-fivetran] Implement load_fivetran_asset_specs #25808
• [6/n][dagster-fivetran] Implement FivetranWorkspaceDefsLoader #25807
• [5/n][dagster-fivetran] Implement FivetranWorkspaceData to FivetranConnectorTableProps method #25797
• [4/n][dagster-fivetran] Implement fetch_fivetran_workspace_data #25788
• [3/n][dagster-fivetran] Implement FivetranClient for rework #25756
• [2/n][dagster-fivetran] Update DagsterFivetranTranslator and related classes for rework #25751 👈 (View in Graphite)
• [1/n][dagster-fivetran] Scaffold FivetranWorkspace for rework #25750
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

[maximearmstrong]

Until the previous functions and resource are deprecated and removed, users would import the reworked integration with the following:

from dagster_fivetran.v2 import DagsterFivetranTranslator, FivetranWorkspace

The new version of the integration won't actually be v2, so perhaps another import path would be better?

This is mainly to avoid name collisions between both previous and new translators. We could also name this translator differently if we really want users to import with from dagster_fivetran import FivetranWorkspace, but Dagster[IntegrationName]Translator is the naming convention for new integrations.

[dpeng817]

I think we should just call it something different than *.v2. Maybe experimental for a release -> 1.0 the integration, then we switch the old stuff to be under .legacy and make the new stuff exist under the top level package. @PedramNavid and @C00ldudeNoonan would probably have thoughts.

[maximearmstrong]

That makes sense - I updated the folder name for experimental in the previous PR in this stack.

[dpeng817]

to your queue for some design questions

[dpeng817]

I'm assuming this might be inherited from existing patterns, but I do find this kinda awkward. Creates a weird footgun where you can implement get_connector_spec in a way that does not utilize get_connector_asset_key, right?

I wonder if we should just have get_connector_spec and then force people to use get_connector_spec(...).asset_key.

To make this more efficient, we could cache the get_connector_spec result per datum.

[maximearmstrong]

I'm assuming this might be inherited from existing patterns, but I do find this kinda awkward.

Yes exactly. A similar discussion came up here.

I'm in favor of this change - I agree that this pattern is error prone.

It was kinda easier for a user to override the get_asset_key function, to add a prefix for instance. We could recommend doing something like the following instead, which looks a bit awkward but is less error prone.

class CustomDagsterTranslator(DagsterTranslator):
    def get_asset_spec(self, props) -> AssetSpec:
        asset_spec = super().get_asset_spec(props)
        return asset_spec._replace(asset_key=asset_spec.asset_key.with_prefix("my_prefix"))

@benpankow Any thoughts? I can update the other translators if we all agree on this.

[dpeng817]

I think we have better fxns for updating params on asset specs now too: replace_attributes top level fxn. But yea I think this pattern is good. Having an example people can copy paste, even if it looks slightly awkward, is much preferable to introducing a footgun.

[dpeng817]

Have we made the other integrations where this fxn exists public yet @maximearmstrong ? / would like to understand the status / experimentality there.

[benpankow]

I'm on board with this change - I think our initial push for get_asset_key was to avoid doing extra work to construct an entire asset spec when we would discard most of it & just retrieve the key, but Chris made a good point that any asset whose key we're generating we'll also be generating a spec for, either before or after. As long as we can cache the spec generation, we don't end up doing extra work in that case.

[maximearmstrong]

That's fair - we can remove the get_asset_key method in favor of the replace_attributes fnx for customization.

Have we made the other integrations where this fxn exists public yet

The get_asset_spec method is used in the translator of each BI integrations, and these translators are not marked as experimental. I think that method is pretty stable at this point.

[maximearmstrong]

The get_asset_key method is also not marked as experimental for the BI integrations, so that implies a deprecation cycle, but the risk seems pretty low here.

[dpeng817]

Yea if we're going to do it, we should probably do so soon. Want to post a public discussion about it to make sure we get buy in from @schrockn @benpankow ; do we have anyone customizing BI translators to our knowledge yet?

[maximearmstrong]

To my knowledge, no one is customizing the Tableau and Power BI translators yet. @benpankow Do you know if anyone is customizing the Sigma and Looker ones?

I can post the public discussion with code snippets to get consensus on this.

For this PR, I will remove the get_asset_key method - we can easily add it depending on the outcome of the discussion.

[dpeng817]

yep that sounds good to me!

[dpeng817]

shouldn't we also have get_destination_asset_key?

[maximearmstrong]

We will leverage the previous translator instead. See updated PR description.

[dpeng817]

shouldn't we also have get_destination_spec?

[benpankow]

I'm not sure this matches the way that we model Fivetran assets, at least in the current form - each connector can sync one or many tables, each of which we represent as an asset. Destinations may not make sense to model as an asset at all, since they just represent a storage destination but not a specific e.g. table

[maximearmstrong]

Re-reading the code after reading you comment, that makes a lot of sense. I will adjust the code.

[maximearmstrong]

I moved things around so that we leverage the translator as it was implemented, while saving the state with the raw API data. See updated PR description for the details.

[graphite-app]

Both FivetranContentType.CONNECTOR and FivetranContentType.DESTINATION need to be handled in the get_asset_key and get_asset_spec methods. Consider adding elif branches for FivetranContentType.DESTINATION that call corresponding get_destination_asset_key and get_destination_spec methods. These methods should be added as NotImplemented stubs, similar to the existing connector methods. The check.assert_never should only be hit for invalid enum values that aren't part of FivetranContentType.

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

re-requesting

[benpankow]

Do we still want/need this class, FivetranContentType etc if it's not getting fed into the translator?

In particular I think having the content type isn't necessary, since we aren't exposing this data to the user directly

[maximearmstrong]

I think it's worth keeping FivetranContentType for a few reasons:

• The content data for Fivetran is a JSON object returned by the API for both connectors and destinations. Using FivetranContentType, it's easier to keep track of the type of the FivetranContentData.
  • This pattern is used for Power BI and Tableau, where the content data is also a JSON object returned by an API.
• The implementation of fetch_fivetran_workspace_data leverages the FivetranContentType enum to create the FivetranWorkspaceData.
  • We use FivetranContentType when creating FivetranContentData objects and the FivetranWorkspaceData object, to differentiate connectors and destinations. See usage in subsequent PR, in [4/n][dagster-fivetran] Implement fetch_fivetran_workspace_data #25788 and [5/n][dagster-fivetran] Implement FivetranWorkspaceData to FivetranConnectorTableProps method #25797

Overall, I'm in favor of keeping this to keep our design pattern for XWorkspaceData and fetch_x_workspace_data as consistent as possible across integrations.

[dpeng817]

I think we want to delete this now right?

[maximearmstrong]

Yes, done in 6eb1099