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

Source Hubspot: Web Analytics API #33042

Merged
merged 13 commits into from Dec 8, 2023

Conversation

roman-yermilov-gl
Copy link
Collaborator

@roman-yermilov-gl roman-yermilov-gl commented Dec 4, 2023

What

Implement Web Analytics streams: #32702

How

Implemented new Web Analytics streams:

  • ContactsWebAnalytics
  • CompaniesWebAnalytics
  • DealsWebAnalytics
  • TicketsWebAnalytics
  • EngagementsCallsWebAnalytics
  • EngagementsEmailsWebAnalytics
  • EngagementsMeetingsWebAnalytics
  • EngagementsNotesWebAnalytics
  • EngagementsTasksWebAnalytics
  • GoalsWebAnalytics
  • LineItemsWebAnalytics
  • ProductsWebAnalytics
  • Custom Objects Stream

Implement client side incremental sync
Make streams to share same schema for default properties
Make a toggle to turn on/off web analytics streams

Copy link

vercel bot commented Dec 4, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Dec 8, 2023 1:12pm

Copy link
Contributor

github-actions bot commented Dec 4, 2023

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@roman-yermilov-gl roman-yermilov-gl force-pushed the ryermilov/source-hubspot-web-analytics-api branch from 64c0886 to 1589260 Compare December 4, 2023 16:31
@roman-yermilov-gl roman-yermilov-gl force-pushed the ryermilov/source-hubspot-web-analytics-api branch from 5891e59 to a8240d9 Compare December 5, 2023 14:25
@roman-yermilov-gl roman-yermilov-gl force-pushed the ryermilov/source-hubspot-web-analytics-api branch from 9d853db to 0562a0a Compare December 6, 2023 16:02
@roman-yermilov-gl roman-yermilov-gl force-pushed the ryermilov/source-hubspot-web-analytics-api branch from 98a850d to f7f6d7e Compare December 8, 2023 12:32
@roman-yermilov-gl roman-yermilov-gl merged commit 98d57db into master Dec 8, 2023
23 of 24 checks passed
@roman-yermilov-gl roman-yermilov-gl deleted the ryermilov/source-hubspot-web-analytics-api branch December 8, 2023 14:04
@timroes
Copy link
Collaborator

timroes commented Dec 8, 2023

Hi, why was this merged, despite CI being red on it? The doc changes broke master. @roman-yermilov-gl could you please open another PR to fix the issues with the docs.

[18:10:23.024] Running build in Washington, D.C., USA (East) – iad1
[18:10:23.317] Cloning github.com/airbytehq/airbyte (Branch: master, Commit: 79d6e51)
[18:10:30.826] Cloning completed: 7.508s
[18:10:30.826] Running "git diff HEAD^ HEAD --quiet . ../docs"
[18:10:35.079] Restored build cache
[18:10:35.155] Running "vercel build"
[18:10:35.638] Vercel CLI 32.6.1
[18:10:36.270] Running "install" command: `yarn install `...
[18:10:36.605] yarn install v1.22.17
[18:10:36.677] [1/4] Resolving packages...
[18:10:37.121] success Already up-to-date.
[18:10:37.126] Done in 0.53s.
[18:10:37.337] yarn run v1.22.17
[18:10:37.363] $ docusaurus build
[18:10:38.432] Fetching connector registry...
[18:10:38.508] [INFO] [en] Creating an optimized production build...
[18:10:38.776] fetched 358 connectors form registry
[18:10:39.776] [info] [webpackbar] Compiling Client
[18:10:39.799] [info] [webpackbar] Compiling Server
[18:10:54.012] [success] [webpackbar] Client: Compiled with some errors in 14.24s
[18:10:54.016] 
[18:10:54.016] 
[18:10:54.016] SyntaxError: /vercel/path0/docs/integrations/sources/hubspot.md: Expected corresponding JSX closing tag for <HideInUI>. (289:0)
[18:10:54.017]   287 | <h3 {...{"id":"experimental-streams"}}>{`Experimental streams`}</h3>
[18:10:54.017]   288 | <p><a parentName="p" {...{"href":"https://developers.hubspot.com/docs/api/events/web-analytics"}}>{`Web Analytics`}</a>{` streams may be enabled as an experimental feature but please note that they are based on API which is currently in beta and may change at some point of time or be unstable.`}</p>
[18:10:54.017] > 289 | </FieldAnchor>
[18:10:54.017]       | ^
[18:10:54.017]   290 | <h3 {...{"id":"notes-on-the-engagements-stream"}}>{`Notes on the `}<inlineCode parentName="h3">{`engagements`}</inlineCode>{` stream`}</h3>
[18:10:54.017]   291 | <ol>
[18:10:54.018]   292 | <li parentName="ol">{`Objects in the `}<inlineCode parentName="li">{`engagements`}</inlineCode>{` stream can have one of the following types: `}<inlineCode parentName="li">{`note`}</inlineCode>{`, `}<inlineCode parentName="li">{`email`}</inlineCode>{`, `}<inlineCode parentName="li">{`task`}</inlineCode>{`, `}<inlineCode parentName="li">{`meeting`}</inlineCode>{`, `}<inlineCode parentName="li">{`call`}</inlineCode>{`. Depending on the type of engagement, different properties are set for that object in the `}<inlineCode parentName="li">{`engagements_metadata`}</inlineCode>{` table in the destination:`}</li>
[18:10:54.018] [ERROR] Client bundle compiled with errors therefore further build is impossible.
[18:10:54.091] error Command failed with exit code 1.
[18:10:54.091] info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
[18:10:54.109] Error: Command "yarn build" exited with 1

@erohmensing
Copy link
Contributor

^ Specifically I think the issue is that you can't use a FieldAnchor within a HideInUI component, as the field anchor only works within the UI

@timroes
Copy link
Collaborator

timroes commented Dec 8, 2023

I think it might be related to this (https://github.com/airbytehq/airbyte/blob/master/docs/integrations/sources/hubspot.md?plain=1#L194) being a self-closing tag, but then closed in line 200 again.

@roman-yermilov-gl
Copy link
Collaborator Author

@timroes CI was green, all tests were passed and I had one approve

@roman-yermilov-gl
Copy link
Collaborator Author

@timroes Let me fix this self-closing tag in additional PR

@roman-yermilov-gl
Copy link
Collaborator Author

@timroes @erohmensing
I have prepared PR with fix: #33257

rishabh-cldcvr pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Dec 14, 2023
Co-authored-by: roman-yermilov-gl <roman-yermilov-gl@users.noreply.github.com>
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/hubspot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Source Hubspot: extend connector by implementing Web Analytics streams
5 participants