build: support tsx components and storybook #1564

filipesilva · 2021-08-19T17:52:08Z

No description provided.

Add component story

filipesilva · 2021-08-23T10:48:38Z

src/cljs/athens/devcards/right_sidebar.cljs

    [athens.views.right-sidebar :as right-sidebar]
    [devcards.core :refer [defcard-rg]]
    [re-frame.core :refer [dispatch]]))


 (defcard-rg Toggle
-  [button {:primary true :on-click-fn #(dispatch [:right-sidebar/toggle])} "Toggle"])
+  [:> Button {:isPrimary true :on-click-fn #(dispatch [:right-sidebar/toggle])} "Toggle"])


Reagent will convert props in dash-chase into camelCase. So we can still keep using idiomatic property names in cljs.

Instead of using :> everywhere, we can also declare these components with reagent/adapt-react-class somewhere. Not sure if it's worth the effort though.

I prefer dash-case.

I prefer :>.

Reagent will convert it into camelCase automatically.

src/js/components/Button/button.css

src/cljs/athens/views/buttons.cljs

filipesilva · 2021-08-24T08:46:07Z

.storybook/preview.js

+  },
+}
+
+const cssVars = `


Discussed with Stuart how this is duplication of code in athens.style, and how we could put it in a JS file and use it as the source of truth for both setups. Left it as is for now to reduce scope of the PR.

Would we want athens.style to be CSS/JS in the future? Might be better for OSS devs and theme developers.

Not sure about the whole of athens.style, but at least part of it yes.

Yeah just the part that is all the CSS properties.

The style generation for Storybook has been implemented in my current branch here, shanberg@dca0688, but is not yet used in the app.

filipesilva · 2021-08-24T08:47:10Z

Note for reviewers: most of the file changes in this PR are changing the require and usage of Button.

neotyk

1 question about build workflow.

neotyk · 2021-08-30T11:05:47Z

.github/workflows/build.yml

@@ -238,6 +244,9 @@ jobs:
           mkdir -p ~/private_keys/
           echo '${{ secrets.api_key }}' > ~/private_keys/AuthKey_${{ secrets.api_key_id }}.p8

+       - name: Compile components


What is the reason we compile components 3x?
Can't we cache the result of 1st complication and reuse in other 2 places?

Roughly the same reason we compile the app in those 3 places too: the are being used as a build step prior to the app build step, so whenever the app gets built the components should be built as well.

It should be possible to cache the results of the compilation, especially since the component compilation is simpler than the app compilation. But caching brings its own set of problems, like determining the cache invalidation policy (yarn.lock+all ts files for now, maybe different later), and I can't imagine it will bring any benefit since compiling the components is faster than restoring cache+storing cache for now.

So I don't really see a reason to use cache at the moment.

Do these components get served anywhere? Before, we could see devcards at contributor github pages at like username.github.io/athens/cards.html. This is a great way to see contributor/PR components without building locally.

Our hypothetical athensresearch.github.io/athens/storybook.html, could also host the official components/design system.

They aren't served anywhere now, no. I think they can be built with yarn build-storybook in this fashion. Afterwards they would need to be deployed.

For contributors to show them they'd also have to somehow deploy them to github pages though. How was that done before?

Another note: athensresearch.github.io is essentially a singleton for the master branch deployment, we can't deploy there until rtc is merged into master.

For contributors to show them they'd also have to somehow deploy them to github pages though. How was that done before?

https://handbook.athensresearch.org/community/get-involved/setup#deploying-athens-and-devcards

Another note: athensresearch.github.io is essentially a singleton for the master branch deployment, we can't deploy there until rtc is merged into master.

That's a good point. Right now, Github pages are only updated when main is deployed via a tagged release.

In the past, I setup Actions so that contributors would update their GitHub pages whenever they pushed to any branch, not just when they pushed to their main. The problem here was that if they pushed to another branch, it would update. I even dynamically included their Git hash and linked to the GitHub commit in their GitHub pages Athens build. Actually, none of this worked out that well, and the easiest ended up being that I just added their fork as a remote and built it locally every time I was reviewing their PR. This should probably still be the workflow going forward for PR reviews.

I think we want a way to preview these changes via temporary deployment but not too sure how to do it now without involving some third party service.

Probably could deploy to GH pages under a branch name path. Then clean up that on merge? GH actions has a rich enough API to do that. Probably needs an ADR of it's own.

The problem with GH pages is it would only be able to serve one branch at a time. I feel like a service like Vercel could have a deploy for an arbitrary number of git hashes. This is too much overhead for most contributors, but I could seem it being more valuable when we have several people iterating on frontend code consistently.

For now, I think it's fine for all engineers to have remotes for one another. Building locally is another step of reproducibilty which can actually be helpful. Finally, modifying and hot-reloading code is something that a service deploy wouldn't allow for. Interacting with the code and application is gold for understanding it!

WRT #1564 (comment), talked to Alex on standup and he prefer the faster build than the caching for now.

tangjeff0

Please take a look at questions.

Should we just get rid of devcards now?

Great work!

tangjeff0 · 2021-08-30T21:20:04Z

doc/adr/000x-js-components.md

+# X. JS Components
+
+Date: 2021-08-23
+
+## Status
+
+Proposed.
+
+
+## Context
+
+Inspired by [David Nolen's ClojureScript in the Age of TypeScript](https://vouch.io/developing-mobile-digital-key-applications-with-clojurescript/) talk and post, we started thinking about how viable it would be to use JS (instead of CLJS) components.
+
+This change would provide design with a better and more familiar development environment for components and reduce their dependency on engineering to ship work.
+The separation also has several second order benefits related to organization and communication. 
+
+Costs for this change are centered around the degree of separation between application and components, where cljs is the primary language on the former and js on the latter, and maintaining extra tooling.
+
+
+## Decision
+
+TBD
+
+
+## Consequences
+
+Negative consequences:
+* JS/CLJS context switching when working in the app and on components at the same time
+* Higher surface area for JS interop problems
+* More complex build step
+* More tooling to maintain
+* Harder for for CLJS engineers to develop and maintain components
+
+
+Positive consequences:
+* Better development and testing environment for components
+* Clearer defined deliverable scope and context for components
+* Component documentation
+* Smaller and simpler application codebase 
+* Looser coupling between engineering and design
+* Design can deliver work on separate cadence, units, and timeline, from engineering
+* Easier to enforce discipline on components as pure functions
+* CLJS proficiency is not necessary for design work
+* Easier for contributors to contribute to components
+* Reduced bus factor in design


Creating another pointer to our Hypotheses G Docs. ADRs capture the design of an architectural decision, some of the trade-offs, and some of the motivations, but could still be made more explicit in terms of the design of decision-making from an organizational point of view.

Perhaps we should link to the doc here? Fine if only privately accessible for now.

tangjeff0 · 2021-08-30T21:29:20Z

.storybook/preview.js

+  },
+}
+
+const cssVars = `


Would we want athens.style to be CSS/JS in the future? Might be better for OSS devs and theme developers.

package.json

project.clj

tangjeff0 · 2021-08-30T21:39:57Z

.github/workflows/build.yml

@@ -238,6 +244,9 @@ jobs:
           mkdir -p ~/private_keys/
           echo '${{ secrets.api_key }}' > ~/private_keys/AuthKey_${{ secrets.api_key_id }}.p8

+       - name: Compile components


Do these components get served anywhere? Before, we could see devcards at contributor github pages at like username.github.io/athens/cards.html. This is a great way to see contributor/PR components without building locally.

Our hypothetical athensresearch.github.io/athens/storybook.html, could also host the official components/design system.

tangjeff0 · 2021-08-31T15:15:58Z

.gitignore

@@ -31,3 +31,6 @@

 # electron build
 dist
+
+# design system ts output
+/src/js/components/**/*.js


For some reason, I my git is recognizing unstaged changes in /src/js/components/Button/Button.js and /src/js/components/Button/Button.stories.js. The diff is just different slightly differenent transpiled TS=>JS.

What's your version of git? Recursive glob support was only added in 1.8.2.

2.25.1. Can look into it and add my repro steps.

Seems fine now. But storybook-static/ code is being created. Do we want all these files?

filipesilva · 2021-09-02T15:19:56Z

@tangjeff0 removed devcards, which removed a LOT of other stuff via carve.

tangjeff0

We should add a project-level JS linter now that we are adding javascript, but in a separate PR. I'm noticing some inconsistencies regarding semi-colons and whitespace in the new JS files.

src/cljs/athens/devcards.cljs

src/cljs/athens/devcards/style_guide.cljs

src/cljs/athens/devcards/styling_with_stylefy.cljs

src/js/components/Button/Button.tsx

src/cljsjs/create_react_class.cljs

src/cljs/athens/views/buttons.cljs

src/cljs/athens/views/filters.cljs

tangjeff0 · 2021-09-03T13:54:06Z

.gitignore

@@ -31,3 +31,6 @@

 # electron build
 dist
+
+# design system ts output
+/src/js/components/**/*.js


Seems fine now. But storybook-static/ code is being created. Do we want all these files?

filipesilva · 2021-09-08T16:06:47Z

@tangjeff0 we could add JS/TS linting, but that sounds like a non-blocking improvement. Do you agree, or do you think we need it from the get-go?

juniusfree · 2021-09-09T05:25:39Z

src/cljs/athens/electron/db_modal.cljs

    [athens.views.modal :refer [modal-style]]
    [athens.views.textinput :as textinput]
-    [cljsjs.react]
-    [cljsjs.react.dom]


The removal of cljsjs.react.dom resulted in error. This is when adding a new db.

Fix in #1641, thanks for the catch!

Fix athensresearch#1564 (comment)

build: support tsx components and storybook

59c6629

filipesilva requested review from neotyk and shanberg August 19, 2021 17:52

shanberg and others added 8 commits August 21, 2021 09:58

improvement(storybook): props and style for button test case

6689ad5

improvement(storybook): improve file structure

c5ec43e

feat: build proper tsx button component

107d3dd

rfct: use new button component

c9e2ff5

Merge pull request #1 from shanberg/add-component-story

1e83f82

Add component story

rfct: remove compiled files

a514a01

build: don't compile stories to js

1396e81

rfct: style

ce3d3bd

filipesilva commented Aug 23, 2021

View reviewed changes

filipesilva added 2 commits August 23, 2021 11:50

rfct: use dash-case for button props

17e6570

Reagent will convert it into camelCase automatically.

docs: add js components ADR

f87e920

filipesilva requested a review from tangjeff0 August 23, 2021 15:37

filipesilva marked this pull request as ready for review August 23, 2021 15:37

filipesilva commented Aug 24, 2021

View reviewed changes

src/js/components/Button/button.css Outdated Show resolved Hide resolved

filipesilva commented Aug 24, 2021

View reviewed changes

src/cljs/athens/views/buttons.cljs Outdated Show resolved Hide resolved

filipesilva commented Aug 24, 2021

View reviewed changes

neotyk requested changes Aug 30, 2021

View reviewed changes

tangjeff0 requested changes Aug 31, 2021

View reviewed changes

filipesilva added 5 commits August 31, 2021 13:39

rfct: remove unused files

b4eb289

rfct: simplify yarn clean cmd

432ba63

rfct: rename storybook scripts for consistency

6b84ae2

fix: remove unused src path

7886600

build: only watch component dir for components

a23223e

tangjeff0 reviewed Aug 31, 2021

View reviewed changes

filipesilva added 2 commits September 2, 2021 10:59

docs: update js components ADR

79397e2

Merge branch 'feature/rtc-v1' into storybook

3cfe181

rfct: remove devcards

492f591

filipesilva force-pushed the storybook branch from 21cf117 to 492f591 Compare September 2, 2021 15:19

tangjeff0 requested changes Sep 3, 2021

View reviewed changes

rfct: remove main devcards file

2a50714

neotyk approved these changes Sep 8, 2021

View reviewed changes

filipesilva added 2 commits September 8, 2021 16:53

build: ignore storybook build folder

fdce6c0

docs: add deferred work items to JS components ADR

8c668d2

tangjeff0 merged commit 925f7a4 into athensresearch:feature/rtc-v1 Sep 8, 2021

juniusfree reviewed Sep 9, 2021

View reviewed changes

filipesilva added a commit to filipesilva/athens that referenced this pull request Sep 9, 2021

fix: import react-dom instead of using missing global

70027b9

Fix athensresearch#1564 (comment)

filipesilva mentioned this pull request Sep 9, 2021

fix: import react-dom instead of using missing global #1641

Merged

build: support tsx components and storybook #1564

build: support tsx components and storybook #1564

Conversation

filipesilva commented Aug 19, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shanberg Sep 4, 2021 • edited Loading

Choose a reason for hiding this comment

filipesilva commented Aug 24, 2021

neotyk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tangjeff0 Sep 3, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tangjeff0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

filipesilva commented Sep 2, 2021

tangjeff0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

filipesilva commented Sep 8, 2021

juniusfree Sep 9, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shanberg Sep 4, 2021 •

edited

Loading

tangjeff0 Sep 3, 2021 •

edited

Loading

juniusfree Sep 9, 2021 •

edited

Loading