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

refactor: remove legacy demo resources #2066

Merged
merged 5 commits into from
Oct 27, 2023
Merged

refactor: remove legacy demo resources #2066

merged 5 commits into from
Oct 27, 2023

Conversation

bossenti
Copy link
Contributor

Purpose

This PR removes some legacy resources that have been used for demo purposes but are rather outdated.

Remarks

PR introduces (a) breaking change(s): yes (see below)

PR introduces (a) deprecation(s): no

Breaking Change

This PR removes two data sources from StreamPipes:

  • watertank-simulator
  • vehicle-simulator

@github-actions github-actions bot added dependencies Pull requests that update a dependency file java Pull requests that update Java code pipeline elements Relates to pipeline elements backend Everything that is related to the StreamPipes backend installer Affects the StreamPipes installer documentation Everything related to documentation gh-actions Pull requests that update GitHub Actions code labels Oct 20, 2023
@bossenti
Copy link
Contributor Author

follow-up task: #2067

@bossenti bossenti added this to the 0.93.0 milestone Oct 20, 2023
@dominikriemer
Copy link
Member

@bossenti if I'm not mistaken the PR not only removes the demo sources, but also the streampipes-sources module. This includes methods to define data streams programmatically. I think this is a useful feature for use cases where streams should be created directly instead of defining adapters.
Adapters are useful for configurable and reusable connectors, but there might be cases where a fixed data stream should be defined using the SDK.
Do we really want to delete this?

@bossenti
Copy link
Contributor Author

@dominikriemer Good point!

I deleted streampipes-sources because it only contains two classes:

  • AbstractAdapterIncludedStream
  • AbstractAlreadyExistingStream

Both only have been used by the two demo sources removed within this PR so I considered them to be legacy 😅 So are they still required to create a data stream? If my understanding is correct, a StreamPipes Function uses the the client to generate a new data stream, for example.

@bossenti bossenti added the breaking change Indicates that a PR or issue yields to a breaking change label Oct 22, 2023
@dominikriemer
Copy link
Member

Yes, I think they are not directly needed by the function but users can use these convenience classes to create data streams in the SDK. These are the classes we currently mention in the data stream tutorial (https://streampipes.apache.org/docs/extend-tutorial-data-sources/).
I'd suggest to keep these classes and just remove the demo resources.

@bossenti
Copy link
Contributor Author

Okay, then let's keep them.
Should we leave them in streampipes-sources or move them elsewhere?

@dominikriemer
Copy link
Member

@bossenti can it be moved to streampipes-extensions-management? Since they are helper classes similar to the PullAdapter.

@bossenti bossenti merged commit f8be8f6 into dev Oct 27, 2023
18 checks passed
@bossenti bossenti deleted the remove-dead-resources branch October 27, 2023 05:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Everything that is related to the StreamPipes backend breaking change Indicates that a PR or issue yields to a breaking change dependencies Pull requests that update a dependency file documentation Everything related to documentation gh-actions Pull requests that update GitHub Actions code installer Affects the StreamPipes installer java Pull requests that update Java code pipeline elements Relates to pipeline elements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants