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.

Sign up for GitHub

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

Jump to bottom

build: Allow compilation on Windows #14718

Merged
merged 2 commits into from
Dec 8, 2023
Merged

build: Allow compilation on Windows #14718

merged 2 commits into from
Dec 8, 2023

Conversation

dbussink
Copy link
Contributor

@dbussink dbussink commented Dec 7, 2023

Vitess is not always just used standalone, but also sometimes for components. For example the parser, schemadiff, the MySQL connection parser etc. are components used separately.

Even though these parts have no OS specific bits (like process management etc. for tablet management and MySQL), we can't compile this on Windows due to dependencies on things like syslog in places.

These changes allow for building Vitess on Windows. This does not in any way indicate actual support for Windows for Vitess or even plans to ever do that in the future, it's solely here to make it easier to use Vitess parts as a library.

Related Issue(s)

Part of #14717

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

@dbussink dbussink added Type: Internal Cleanup Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: General Changes throughout the code base labels Dec 7, 2023
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 7, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Dec 7, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Dec 7, 2023
@dbussink dbussink added go and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request go labels Dec 7, 2023
mattlord
mattlord approved these changes Dec 7, 2023
View reviewed changes
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Makes sense to me. I only had minor comments and nits.

go/streamlog/streamlog_windows.go Outdated Show resolved Hide resolved
go/test/endtoend/cluster/vttablet_process_windows.go Outdated Show resolved Hide resolved
go/test/endtoend/filelock/filelock_unix.go Show resolved Hide resolved
go/vt/servenv/pprof_unix.go Outdated Show resolved Hide resolved
go/syscallutil/kill_unix.go Show resolved Hide resolved
go/syscallutil/kill_windows.go Show resolved Hide resolved
go/test/endtoend/cluster/vttablet_process_unix.go Show resolved Hide resolved
go/test/endtoend/cluster/vttablet_process_windows.go Show resolved Hide resolved
go/vt/servenv/pprof_windows.go Show resolved Hide resolved
@dbussink
build: Allow compilation on Windows
49d702c 
Vitess is not always just used standalone, but also sometimes for
components. For example the parser, schemadiff, the MySQL connection parser etc. are
components used separately.

Even though these parts have no OS specific bits (like process
management etc. for tablet management and MySQL), we can't compile this
on Windows due to dependencies on things like syslog in places.

These changes allow for building Vitess on Windows. This does not in any
way indicate actual support for Windows for Vitess or even plans to ever
do that in the future, it's solely here to make it easier to use Vitess
parts as a library.

Signed-off-by: Dirkjan Bussink <[email protected]>
@dbussink
Address feedback
45ee093 
Signed-off-by: Dirkjan Bussink <[email protected]>
@dbussink dbussink force-pushed the dbussink/compile-on-windows branch from 245136f to 45ee093 Compare December 8, 2023 13:37
vmg
vmg approved these changes Dec 8, 2023
View reviewed changes
Copy link
Collaborator

@vmg vmg left a comment

Choose a reason for hiding this comment

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

The hope here is that this is a temporary stopgap until we can re-architect Vitess and extract the parts that would be meaningful as a library -- then those parts would be the only ones that would support compilation under Windows.

@vmg vmg merged commit 08b2c8b into vitessio:main Dec 8, 2023
116 checks passed
@vmg vmg deleted the dbussink/compile-on-windows branch December 8, 2023 16:04
ejortegau pushed a commit to slackhq/vitess that referenced this pull request Dec 13, 2023
@dbussink @ejortegau
build: Allow compilation on Windows (vitessio#14718)
5c2f6b3 
Signed-off-by: Dirkjan Bussink <[email protected]>
@mattlord mattlord mentioned this pull request Jan 5, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattlord mattlord mattlord approved these changes

@vmg vmg vmg approved these changes

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps is a code owner

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach is a code owner

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100 GuptaManan100 is a code owner

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

@systay systay Awaiting requested review from systay systay is a code owner

@frouioui frouioui Awaiting requested review from frouioui frouioui is a code owner

@ajm188 ajm188 Awaiting requested review from ajm188 ajm188 is a code owner

Assignees
No one assigned
Labels
Component: General Changes throughout the code base Type: Enhancement Logical improvement (somewhere between a bug and feature) Type: Internal Cleanup
Projects
None yet
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@dbussink @vmg @mattlord