DX: Preload user namespace #19927
Merged
DX: Preload user namespace #19927
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ilmotta
requested review from
shivekkhurana,
seanstrom,
vkjr,
Parveshdhull,
OmarBasem and
ulisesmac
Jenkins BuildsClick to see older builds (20)
|
seanstrom
approved these changes
May 7, 2024
ilmotta
force-pushed
the
ilmotta/preload-user-namespace
branch
from
5cb40df
to
31c986f
Compare
ilmotta
force-pushed
the
ilmotta/preload-user-namespace
branch
from
a3d49c8
to
6d17457
Compare
Yes, so many times! I can accommodate your suggestion @clauxx. @seanstrom does that sound okay for you? |
I'm happy to have both too 🙌 |
Parveshdhull
approved these changes
May 8, 2024
ilmotta
force-pushed
the
ilmotta/preload-user-namespace
branch
from
5ec8e17
to
ff5db2a
Compare
85% of end-end tests have passedFailed tests (6)Click to expandClass TestWalletMultipleDevice:
Class TestGroupChatMultipleDeviceMergedNewUI:
Class TestWalletOneDevice:
Class TestDeepLinksOneDevice:
Expected to fail tests (2)Click to expandClass TestCommunityOneDeviceMerged:
Class TestGroupChatMultipleDeviceMergedNewUI:
Passed tests (44)Click to expandClass TestCommunityMultipleDeviceMergedTwo:
Class TestOneToOneChatMultipleSharedDevicesNewUiTwo:
Class TestActivityMultipleDevicePRTwo:
Class TestActivityMultipleDevicePR:
Class TestCommunityOneDeviceMerged:
Class TestActivityCenterContactRequestMultipleDevicePR:
Class TestCommunityMultipleDeviceMerged:
Class TestWalletOneDevice:
Class TestGroupChatMultipleDeviceMergedNewUI:
Class TestOneToOneChatMultipleSharedDevicesNewUi:
|
shivekkhurana
approved these changes
May 10, 2024
|
Finally <3
|
ilmotta
force-pushed
the
ilmotta/preload-user-namespace
branch
from
ff5db2a
to
c9544a9
Compare
ilmotta
added a commit
that referenced
this pull request
May 10, 2024
Reverts the preloading mechanism from PR #19927, which introduced a problem I couldn't find any satisfactory solution. The namespaces user and dev.user were being preloaded by shadow-cljs, but the problem is that preloading will fail if those namespaces don't exist in your file system. I couldn't find any solution to conditionally preload namespaces via shadow-cljs and ClojureScript unfortunately doesn't support conditional requires like Clojure. At least we got to keep the code to not lint them and the whole idea to start to commit dev-only code inside src/dev/.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR preloads the
usernamespace (src/user.cljsandsrc/dev/user.cljs) for themobiletarget and for dev-only purposes. The files are git-ignored.Just a reminder that you'll be responsible for making sure your
usernamespace is correct. If it's broken in any way (e.g. calling non-existent code) the app will crash at initialization (dev-only environment obviously).Why?
When the app initializes, it loads namespaces that were required at least once. If you create a
usernamespace, it won't be automatically required for you. And if you, like some Clojure devs, like to use theusernamespace as your safe heaven for experimentation and dev-only utilities, you'll need to remember to evaluate the namespace at least once.This is tedious and many times I forgot to do so and the app crashed because the compiler didn't know where the symbols were coming from.
How do I use it?
Simply create a file
src/user.cljsorsrc/dev/user.cljsand write whatever you want there! Personally, I often use it to persist experiments during development, for example, functions to manipulate the app-db, functions I can call from Emacs directly, debugging functions (e.g. #19906 (comment)), and so on.Some Clojure teams like to commit the
usernamespace and share it with other team members. This can work, but to me it misses the point that I want a namespace that's already loaded and which is my own playground where I don't care about code quality.Areas that may be impacted
None.
Steps to test
Behavior-wise, nothing to test. As a dev, you can verify it works for you by creating a file like the following, and you can require any namespace inside
src/. Once you load the app, the vars insideuserordev.userns should be readily available for you to be used anywhere in the repo without having to require theusernamespace innsforms.Remember to delete code using the
usernamespace before opening a PR ;)status: ready