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

Put the wasm dir back in wasm/wasm. #2071

Merged
merged 2 commits into from
Jul 11, 2024
Merged

Conversation

SpicyLemon
Copy link
Contributor

@SpicyLemon SpicyLemon commented Jul 11, 2024

Description

Put the wasm directory back to data/wasm/wasm. That is what it is in v1.18 (and before).

Yesterday, I worked on adding a step to the upgrade that would move the directory, but that comes with complications that would be better to not rush. Specifically, during the app initialization, the wasm module creates some stuff in there (if it doesn't already exist). And it looks like there's some new stuff in there. So we'd have to do some sort of merger of the old and new, and do it in a way that, upon a failure, doesn't really screw things up for people.

We can try to move it again later, when we've got more time to evaluate the sticking points and get some decent testing on it first.


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

Summary by CodeRabbit

  • Bug Fixes

    • Resolved issue with the incorrect location of the wasm directory.
  • Documentation

    • Updated the Swagger API documentation.
  • Chores

    • Upgraded dependencies, including github.com/hashicorp/go-getter.

@SpicyLemon SpicyLemon requested a review from a team as a code owner July 11, 2024 17:33
Copy link
Contributor

coderabbitai bot commented Jul 11, 2024

Walkthrough

The recent update to the provenance project includes a bug fix for the relocation of the wasm directory, enhancements to the Swagger API documentation, and dependency updates such as bumping the version of github.com/hashicorp/go-getter. Additionally, the wasmDir variable in app/app.go now points to a more specific path by adding a "wasm" subdirectory.

Changes

File/Path Change Summary
CHANGELOG.md Documented bug fix, Swagger API documentation updates, and dependency bumps.
app/app.go Updated wasmDir declaration to include the "wasm" subdirectory.

Poem

In a rabbit's code, paths realign,
Swift and sure, byte trails combine.
Wasm finds its proper place,
Swagger's docs keep up the pace.
Dependencies rise like morning sun,
Provenance, your journey's just begun! 🌟✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@SpicyLemon SpicyLemon enabled auto-merge (squash) July 11, 2024 17:35
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fae7a8b and 897b5c4.

Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • app/app.go (1 hunks)
Additional comments not posted (2)
app/app.go (1)

623-623: LGTM! But verify the new path usage in the codebase.

The code changes are approved.

However, ensure that all references to the old path are updated to the new path containing the additional "wasm" directory.

Verification successful

Verification Successful: No further updates needed.

The new path filepath.Join(homePath, "data", "wasm") is correctly updated and referenced only in app/app.go. No other references to the old path or similar directories were found that require updating.

  • app/app.go: The only file referencing the updated path.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all references to the old wasmDir path are updated to the new path.

# Test: Search for the old path usage. Expect: No occurrences of the old path.
rg --type go 'filepath.Join\(homePath, "data"\)'

Length of output: 50


Script:

#!/bin/bash
# Description: Verify all references to the new wasmDir path.

# Test: Search for the new path usage. Expect: Occurrences of the new path.
rg --type go 'filepath.Join\(homePath, "data", "wasm"\)'

Length of output: 121


Script:

#!/bin/bash
# Description: Verify any other potential references to directories similar to the old path.

# Test: Search for any references to "data" directory that might need updating.
rg --type go 'filepath.Join\(homePath, "data"\)'

Length of output: 50


Script:

#!/bin/bash
# Description: Verify any references to "wasm" directories to ensure all relevant paths are updated.

# Test: Search for any references to "wasm" directories.
rg --type go 'wasm'

Length of output: 43779

CHANGELOG.md (1)

50-53: LGTM!

The entry clearly describes the bug fix related to relocating the wasm directory.

@SpicyLemon SpicyLemon merged commit 1f0ffae into main Jul 11, 2024
31 checks passed
@SpicyLemon SpicyLemon deleted the dwedul/put-wasm-dir-back branch July 11, 2024 18:57
SpicyLemon added a commit that referenced this pull request Jul 11, 2024
* Put the wasm dir back in wasm/wasm.

* Add changelog entry.
SpicyLemon added a commit that referenced this pull request Jul 11, 2024
* Put the wasm dir back in wasm/wasm.

* Add changelog entry.

Co-authored-by: Ira Miller <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants