Update lavamoat browserify docs by leotm · Pull Request #476 · LavaMoat/LavaMoat

leotm · 2023-03-27T10:21:11Z

Follow-up to #475 spotted from going thru js example

Fix examples link
Fix resolve/lib/sync.js throws error it can't find lavamoat-browserify from node_modules
- Install lavamoat-browserify with Yarn before running lavamoat
Fix yarn start server broken MM logo (screen) if user forgets to run yarn lavamoat first
- Error: LavaMoat - required package not in allowlist: package "metamask-logo" requested "metamask-logo>gl-mat4" as "gl-mat4/perspective"
- i.e. Run yarn lavamoat to fully update policy.json we provide
Update remaining examples documentation and files (browserify and serve left alone)

nb: same RN v8 warnings (excluding Promises)

[V8] RN 0.66.5 + SES 0.18.1: 31 warnings docs#14

and in cli example console.error only on localhost:5000 (favicon.ico 404 only on refresh)

nb: js example

~~Should we mention in docs to expect these errors or are these unexpected to look at fixing?~~
No console.error's running zero extensions

- Fix examples link - Fix resolve/lib/sync.js throws error it can't find lavamoat-browserify from node_modules - Install lavamoat-browserify with Yarn before running lavamoat - Fix yarn start server broken MM logo if user forgets to run yarn lavamoat first - Error: LavaMoat - required package not in allowlist: package "metamask-logo" requested "metamask-logo>gl-mat4" as "gl-mat4/perspective" - i.e. Run yarn lavamoat to fully update policy.json we provide - Update remaining examples documentation, files and deps

leotm · 2023-03-27T11:41:59Z

+{
+  "resources": {
+  }
+}


updated here like

LavaMoat/packages/browserify/examples/01-simple-js/lavamoat/browserify/policy-override.json

Lines 1 to 4 in ba3b50d

{

"resources": {

}

}

we could omit our policy configs and rely on running yarn lavamoat in instructions to autogen

missing newline at EOF

added to both examples in 4bd9640
but i noticed yarn lavamoat always removes missing EOF newlines in policy.json

if we intend to be consistent can revert this commit
or follow-up with lavamoat cli to add missing newlines in both policy configs
(atm policy-override.json isn't formatted if it exists)

legobeat · 2023-03-27T13:17:57Z

  },
  "dependencies": {
-    "metamask-logo": "^2.2.1"
+    "lavamoat-browserify": "^16.0.0",


this would be a devDependency i think?

oops yes ^ updated in b5432db including docs

legobeat · 2023-03-27T13:18:06Z

  },
  "dependencies": {
-    "metamask-logo": "^2.2.1"
+    "lavamoat-browserify": "^16.0.0",


this would be a devDependency i think?

updated in b5432db including docs

Did you experience problems running these examples? I test my code against example 01 constantly, never experiencing any problems..

just making sure @weizman you're adding lavamoat-browserify too right in this example 🤔
i checked yarn global add lavamoat-browserify@15.5.0 (since 16 was wrongly introduced) but it has no binaries

@leotm lavamoat-browserify is not supposed to have any binaries AFAIK - what are you missing specifically?

ok ^ was just wondering how we're testing the example without lavamoat-browserify as a dependency

e.g. possibly locally

but yep it's not pos globally (since no binaries)

so deffo want it as a dependency (devDep as you pointed out)

so think PR now looks good to merge if you're happy

weizman · 2023-03-27T13:48:42Z

I'm confused about the general motivation here. Did you experience problems running these examples?
I test my code against example 01 constantly, never experiencing any problems..

weizman · 2023-03-27T13:51:43Z

I think I might understand the confusion here.. I'm pretty sure you see errors because of the extensions you have installed while testing this page.
The examples scuttle global object properties, which the extensions you have installed rely on when they try to inject code into the page.
When running these examples, you must do so with zero extensions enabled to see it functioning correctly.
Mind giving it a try to make sure I make sense?

leotm · 2023-03-27T15:15:41Z

I think I might understand the confusion here.. I'm pretty sure you see errors because of the extensions you have installed while testing this page. The examples scuttle global object properties, which the extensions you have installed rely on when they try to inject code into the page. When running these examples, you must do so with zero extensions enabled to see it functioning correctly. Mind giving it a try to make sure I make sense?

perfect thanks exactly right its my extensions ^ can confirm no console.errors incognito
(thought uBlock Origin disabled was enough)

leotm · 2023-03-27T15:31:27Z

I'm confused about the general motivation here. Did you experience problems running these examples? I test my code against example 01 constantly, never experiencing any problems..

yep exactly was wondering where the examples link supposed to go to and why couldn't run the js example or cli one

then was curious why yarn start renders our logo fine in browser w/o running yarn lavamoat in js example
but doesn't in cli example

and why we commit yarn lavamoat autogen'ed files in js example but not fully in cli example

so thought this PR might address those problems i ran into

Co-authored-by: weizman <weizmangal@gmail.com>

And update documentation

And prettify js example

legobeat

one small suggestion, lgtm otherwise!

Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>

- fix: Node.js 18 compatibility (#551) - deps: update lavamoat-core@^12.4.0->^14.1.1 - deps: @lavamoat/lavapack@^3.3.0->^5.1.2 - doc: update examples and docs (#476) - change: Add back policyDebug option (#440)

- fix: Node.js 18 compatibility (LavaMoat#551) - deps: update lavamoat-core@^12.4.0->^14.1.1 - deps: @lavamoat/lavapack@^3.3.0->^5.1.2 - doc: update examples and docs (LavaMoat#476) - change: Add back policyDebug option (LavaMoat#440)

leotm force-pushed the update-lavamoat-browserify-docs branch from 9d28481 to 86599cf Compare March 27, 2023 11:29

leotm commented Mar 27, 2023

View reviewed changes

Comment thread packages/browserify/examples/00-simple-cli/yarn.lock

leotm force-pushed the update-lavamoat-browserify-docs branch from 86599cf to 25a8dba Compare March 27, 2023 11:39

leotm commented Mar 27, 2023

View reviewed changes

Comment thread packages/browserify/examples/00-simple-cli/policy.json

leotm commented Mar 27, 2023

View reviewed changes

leotm mentioned this pull request Mar 27, 2023

Add scuttler prop instead of fixed Snow integration #475

Merged

3 tasks

leotm marked this pull request as ready for review March 27, 2023 12:34

leotm requested a review from a team March 27, 2023 12:34

legobeat reviewed Mar 27, 2023

View reviewed changes

Comment thread packages/browserify/examples/README.md

leotm and others added 3 commits March 27, 2023 16:35

Fix packages/browserify/examples broken link

33b7a75

Co-authored-by: weizman <weizmangal@gmail.com>

Update lavamoat-browserify to devDependencies

b5432db

And update documentation

Add policy override missing newlines at EOF

4bd9640

And prettify js example

weizman approved these changes Mar 27, 2023

View reviewed changes

leotm requested a review from legobeat March 27, 2023 16:29

legobeat reviewed Mar 30, 2023

View reviewed changes

Comment thread packages/browserify/examples/README.md Outdated

legobeat approved these changes Mar 30, 2023

View reviewed changes

Update packages/browserify/examples/README.md

7d7f75e

Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>

leotm merged commit e1cac44 into main Mar 30, 2023

leotm deleted the update-lavamoat-browserify-docs branch March 30, 2023 14:26

legobeat mentioned this pull request Jun 2, 2023

browserify/version - 15.6.0 #602

Merged

Conversation

leotm commented Mar 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

leotm Mar 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

legobeat Mar 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

leotm Mar 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

legobeat Mar 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

weizman commented Mar 27, 2023

Uh oh!

weizman commented Mar 27, 2023

Uh oh!

leotm commented Mar 27, 2023

Uh oh!

leotm commented Mar 27, 2023

Uh oh!

Uh oh!

legobeat left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

leotm commented Mar 27, 2023 •

edited

Loading

leotm Mar 27, 2023 •

edited

Loading

legobeat Mar 27, 2023 •

edited

Loading

leotm Mar 27, 2023 •

edited

Loading

legobeat Mar 27, 2023 •

edited

Loading