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

Rename webnative to odd #506

Merged
merged 13 commits into from
Apr 11, 2023
Merged

Rename webnative to odd #506

merged 13 commits into from
Apr 11, 2023

Conversation

bgins
Copy link
Member

@bgins bgins commented Apr 3, 2023

Summary

This PR renames Webnative to ODD with the following changes:

  • Rename package from webnative to @oddjs/odd
  • Update GitHub repo references to https://github.com/oddsdk/ts-odd
  • Update webnative-walletauth to odd-walletauth at https://github.com/oddsdk/odd-walletauth
  • Update webnative-app-template to odd-app-template at https://github.com/oddsdk/odd-app-template
  • Update website reference to https://odd.dev
  • Update guide links to point to https://docs.odd.dev
  • Update API docs URL to https://api.odd.dev
  • Rename Webnative to ODD in README, comments, and error messages
  • Update README references to globalThis.__webnative.programs to globalThis.__odd.programs
  • Expose ESM as oddjs instead of webnative
  • Update nix flake name from webnative to oddjs
  • Rename integration test CAR files
  • Rename typedoc name from Webnative SDK to ODD SDK
  • Rename iframe and classified post message to odd
  • Set sharedRepo to false
  • Update docs app_url to odd.fission.app

Note that the docs are still published to webnative.fission.app and we will point https://api.odd.dev to that for the moment. The docs have been updated to publish to odd.fission.app.

What's missing?

WNFS has not been renamed yet. Can we and should we reframe this to use the term ODD Volumes?

There are a couple of places where there are breaking changes in the interaction with the lobby and the names of IndexedDB keys. These have been addressed based on PR feedback below:

https://github.com/fission-codes/webnative/blob/27842451b01510a46524b35d997627c3fdc844c9/src/index.ts#L865-L867

Left this as is because it is for backwards compatibility.

https://github.com/fission-codes/webnative/blob/27842451b01510a46524b35d997627c3fdc844c9/src/components/capabilities/implementation/fission-lobby.ts#L97

Set sharedRepo to false.

https://github.com/fission-codes/webnative/blob/27842451b01510a46524b35d997627c3fdc844c9/src/components/capabilities/implementation/fission-lobby.ts#L157

https://github.com/fission-codes/webnative/blob/27842451b01510a46524b35d997627c3fdc844c9/src/components/capabilities/implementation/fission-lobby.ts#L204-L207

These last two have been renamed from webnative to odd.

Test plan (required)

The usual test suites should run as before because this is mostly about renaming.

Closing issues

Closes #505
Closes #507

After Merge

  • Does this change invalidate any docs or tutorials? Yesss, so much. We will.
  • Does this change require a release to be made? It will. 👍

@bgins bgins marked this pull request as ready for review April 3, 2023 23:42
@bgins bgins self-assigned this Apr 3, 2023
@icidasset
Copy link
Contributor

(this could be changed! Maybe https://api.odd.dev/?)

Yes please 👍

couple of places where there are breaking changes

  1. This only applies to versions of Webnative before v0.35
    It's an upgrade step from < 0.35 to >= 0.35, you can leave this in or remove it entirely.
  2. This one can be removed, so set it to sharedRepo = false
  3. This id doesn't matter I think, feel free to rename.
  4. This one doesn't matter either, only didExchange is of importance, feel free to rename.

README.md Outdated
case webnative.ProgramError.InsecureContext:
// Webnative requires HTTPS
case odd.ProgramError.InsecureContext:
// ODD requires HTTPS
Copy link
Contributor

Choose a reason for hiding this comment

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

When 'ODD' is used on its own (eg. not ODD Program), should we say ODD.js or ODD SDK instead?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, good point. I think the distinction here is ODD SDK when used as a noun, and ODD when used as an adjective. I'll update the noun spots. 👌

Copy link
Member

Choose a reason for hiding this comment

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

nice, I've been using ODD SDK for those cases in the new odd.dev site too 👍🏼

@avivash
Copy link
Member

avivash commented Apr 4, 2023

Just flagging that we'll want to change the workflow urls too once those domains are ready https://github.com/fission-codes/webnative/blob/rename-webnative-to-odd/.github/workflows/docs.yaml#L33

@bgins
Copy link
Member Author

bgins commented Apr 4, 2023

Just flagging that we'll want to change the workflow urls too once those domains are ready https://github.com/fission-codes/webnative/blob/rename-webnative-to-odd/.github/workflows/docs.yaml#L33

Yep, good call. I'm not entirely sure how we have this set up to publish.

@walkah could we look into updating this workflow URL to odd.fission.app? Not a high priority because it will be hidden behind https://api.odd.dev.

Copy link
Contributor

@icidasset icidasset left a comment

Choose a reason for hiding this comment

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

Copy link
Member

@avivash avivash left a comment

Choose a reason for hiding this comment

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

Looks great! I'm going to start integrating this branch with a few of the webnative->odd branches i have going in the different template repos 👍🏼

@bgins
Copy link
Member Author

bgins commented Apr 10, 2023

Just flagging that we'll want to change the workflow urls too once those domains are ready https://github.com/fission-codes/webnative/blob/rename-webnative-to-odd/.github/workflows/docs.yaml#L33

Updated this to odd.fission.app.

@bgins bgins merged commit 1791b3e into main Apr 11, 2023
@bgins bgins deleted the rename-webnative-to-odd branch April 11, 2023 16:08
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.

Rename Webnative to ODD Ensure the global we use in the CDN package is oddjs
3 participants