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

chore: remove near-sdk-sim from repo #817

Merged
merged 3 commits into from
May 19, 2022
Merged

chore: remove near-sdk-sim from repo #817

merged 3 commits into from
May 19, 2022

Conversation

austinabell
Copy link
Contributor

@austinabell austinabell commented May 17, 2022

Since there is no way for us to upgrade near-sdk-sim to be compatible with new protocol version, it is necessary we not just soft deprecate and if people need these sim tests, they can stay on 4.0.0-pre.9 until they can switch

Closes #662
closes #802
closes #759

@willemneal
Copy link
Contributor

Good riddance! No more rocksdb artifacts blowing up my hard drive.

Copy link
Member

@ChaoticTempest ChaoticTempest left a comment

Choose a reason for hiding this comment

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

Feels like people can benefit from us publishing one final patch release to near-sdk-sim to say it's deprecated and workspaces should be used in favor. WDYT?

@austinabell
Copy link
Contributor Author

Feels like people can benefit from us publishing one final patch release to near-sdk-sim to say it's deprecated and workspaces should be used in favor. WDYT?

That's why I released 4.0.0-pre.9, it's unlikely people would update into any temporary version we release in the ~week between now and stable release.

Obviously not ideal, but it wasn't foreseen that we would have to hard deprecate sim tests for 4.0 given we can't update the VM logic. We can add a commit on top of the released commit as a patch version, but I'm not sure that's better since it will be the last functional version of the SDK for near-sdk-sim and dealing with deprecation warnings might not be ideal either.

@itegulov
Copy link
Contributor

Can we just delete all the code but leave a top-level #[deprecated] annotation that leads the user to workspaces-rs and migration doc and release it as a 4.0 version for the very last time?

@austinabell
Copy link
Contributor Author

Can we just delete all the code but leave a top-level #[deprecated] annotation that leads the user to workspaces-rs and migration doc and release it as a 4.0 version for the very last time?

The reason this is not done is because the code will be broken using 4.0 of the SDK and will be cryptic why it doesn't work. We can always release a 4.0 with this deprecation based on this old commit, but since it's not functional anymore we should remove it from the repo.

Let's find some time to chat about the best path for this as it's a bit nuanced.

Options being:

  • Add deprecation to sim tests on 4.0 release (even though broken on sim tests)
  • Add compiler error on the 4.0 release with links to workspaces (and migration doc if stable link)
  • Do not release near-sdk-sim and just communicate this deprecation to community

Any of these can be done if this PR comes in, though

Copy link
Contributor

@itegulov itegulov left a comment

Choose a reason for hiding this comment

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

Yeah fair enough

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants