Add binding gen js for remote and local #12

bthaile · 2023-09-05T17:44:07Z

Added FileReader to config for reading files locally, so it can be mocked out for testing.
Moved shared objects to common module
Added support for js docs
With flix version 1.1 there'll be a return type that can be added to js docs for scripts.

…ate file

bindings/js/gen.go

common/types.go

flixkit.go

bindings/js/gen.go

common/helpers.go

flixkit.go

bindings/js/templates/main.tmpl

cmd/main.go

chasefleming

Left some comments. Also, it does feel like the bindings stuff is going to need to be in its own internal package.

templates/js_main.tmpl

flixkit.go

javascript.go

…late name to be fcl specific

binding_generator.go

flixkit.go

javascript.go

javascript_test.go

… files for tests

javascript.go

templates/js_fcl_main.tmpl

…s generator

bjartek · 2023-10-16T20:00:06Z

types.go

+	return t.Data.Type == "transaction"
+}
+
+func (t *FlowInteractionTemplate) GetAndReplaceCadenceImports(networkName string) (string, error) {


https://github.com/onflow/flow-cli/blob/16b0c277df6c77d556e4c628dcdc50e373ba526e/flowkit/project/program.go#L74

this is for executing the flix. Good catch we should have this "import" syntax in a helper lib that all tools import.

Oh ok. Well then it might be ok. Since we kind of control how imports look like in a flix.

bindings/fcl-js.go

jribbink · 2023-10-17T16:13:53Z

How will we know these templates generated are compatible with the user's installed version of FCL? What if the interface of FCL changes in FCL 2.0, 3.0, etc? Or, what if later version flixkit-go leverages new FCL features in the future, but the user is using an older version of FCL?

bthaile · 2023-10-18T16:37:59Z

How will we know these templates generated are compatible with the user's installed version of FCL? What if the interface of FCL changes in FCL 2.0, 3.0, etc? Or, what if later version flixkit-go leverages new FCL features in the future, but the user is using an older version of FCL?

Good point and good catch. It'll get a little ugly to use semver to check the version against the fcl version used. It would create a javascript dep that I don't want to force on the consumer of the javascript.

I'll add some verbiage in the comment block of the generated javascript that indicates they need version 1.3.0 or greater.

JeffreyDoyle · 2023-10-18T22:58:51Z

@jribbink @bthaile

In FCL we try to "normalize" the interaction template before its used, and in doing so we check that the version of the interaction template is compatible with that version of FCL:

eg: https://github.com/onflow/fcl-js/blob/master/packages/fcl/src/normalizers/interaction-template/interaction-template.js#L1-L13

So we do have some safeguards today around versioning. That said, we may want to think up a more elegant solution that doesn't require us to release a new version of FCL when a new version of Interaction Template is released.

chasefleming

@bthaile It's a bit of a black box right now unless you know the tools well. Even for me with some context it takes a little to figure out what is happening. This is a new feature and should require docs added. Can you create a page explaining this, how to use it, and what a library needs to do in order to add their library? Then can you link that page off the repo under a new section?

bindings/fcl-js.go

chasefleming · 2023-10-20T22:11:54Z

types.go

+		for contractName, networks := range contracts {
+			network, ok := networks[networkName]
+			if !ok {
+				return "", fmt.Errorf("network %s not found for contract %s", networkName, contractName)


why the empty string returned if not found? won't that fail later?

A error is returned, I'd prefer to return a nil. Since I just moved the code, I didn't want to modify it.

chasefleming · 2023-10-20T22:12:23Z

types.go

+			pattern := fmt.Sprintf(`import\s*%s\s*from\s*%s`, contractName, dependencyAddress)
+			re, err := regexp.Compile(pattern)
+			if err != nil {
+				return "", fmt.Errorf("invalid regex pattern: %v", err)


same question

Same response, A error is returned, I'd prefer to return a nil. Since I just moved the code, I didn't want to modify it.

chasefleming · 2023-10-20T22:14:04Z

bindings/fcl-js.go

+	IsLocalTemplate bool
+}
+
+type FclJSGenerator struct {


should this be lowercased?

It's publicly assessable. I thought it needed to be uppercase so calls can get to ti.

It has to be uppercased for other packages to access it yes.

bindings/fcl-js.go

types.go

bindings/fcl-js.go

bthaile · 2023-10-21T21:01:55Z

@bthaile It's a bit of a black box right now unless you know the tools well. Even for me with some context it takes a little to figure out what is happening. This is a new feature and should require docs added. Can you create a page explaining this, how to use it, and what a library needs to do in order to add their library? Then can you link that page off the repo under a new section?

I added usage verbiage in readme, it ended up being really simple.

bthaile added 9 commits September 1, 2023 12:57

init check in for generating binding files based on flix

a2c8c05

add sub templates for js files, gen binding file in same dir as templ…

6f03fb0

…ate file

organization of files and ignores

389069b

ignore built file

7451e2a

ignore template files

4ab973f

ignore template files

016c059

add file reader to config for unit testing

5a50239

verify that remote templates can gen js files

50d5bcb

fix git ignore file

1b9b440

bthaile requested a review from chasefleming as a code owner September 5, 2023 17:44

bthaile added 4 commits September 5, 2023 13:06

ignore cmd dir and all .DS_Store files

37a9f3d

remove .DS_Store files

6c242b7

add testing gen js binding with remote flix

f9d4bf4

support array of simple types

d15e7ca

chasefleming requested changes Sep 6, 2023

View reviewed changes

bthaile added 3 commits September 6, 2023 17:15

first batch of changes based on feedback

d4848cf

collapse files and keep everything in flixkit package

2098974

clean up

530a385

chasefleming requested a review from bjartek September 8, 2023 16:34

chasefleming requested changes Sep 8, 2023

View reviewed changes

add js docs to provide types for typescript

b7a142c

chasefleming reviewed Sep 8, 2023

View reviewed changes

javascript.go Outdated Show resolved Hide resolved

bthaile added 2 commits September 8, 2023 18:24

do not rely on message to be there and that us-en exists, update temp…

870b6ff

…late name to be fcl specific

fix consistency for testing

805a993

bjartek requested changes Sep 11, 2023

View reviewed changes

bthaile added 5 commits September 14, 2023 12:54

simplify conversion to js types, fcl uses strings for all numbers

dac9742

add golden for unit tests

4a9cf9a

pass in generator method to generate code

bd1a7a9

use interface and set specific port for testing remote and use golden…

5aef7f0

… files for tests

fixed arguments key sorting issue, that was causing test failures

e7cd1bc

bthaile added 3 commits September 28, 2023 15:34

fix case typo in generator name

4932623

remove need to read from disk to get template

64e11a5

tidy

aa66b9f

bthaile mentioned this pull request Sep 29, 2023

Add support for JS code generation for flix onflow/flow-cli#1222

Merged

6 tasks

chasefleming requested changes Oct 3, 2023

View reviewed changes

javascript.go Outdated Show resolved Hide resolved

javascript.go Outdated Show resolved Hide resolved

javascript.go Outdated Show resolved Hide resolved

javascript.go Outdated Show resolved Hide resolved

javascript.go Outdated Show resolved Hide resolved

chasefleming reviewed Oct 3, 2023

View reviewed changes

templates/js_fcl_main.tmpl Outdated Show resolved Hide resolved

bthaile added 2 commits October 4, 2023 09:50

move js generator to bindings module and rename js generator to fcl j…

9d27901

…s generator

formatting

8c19379

bjartek reviewed Oct 16, 2023

View reviewed changes

bjartek requested changes Oct 17, 2023

View reviewed changes

bindings/fcl-js.go Outdated Show resolved Hide resolved

pass in template directory to be more flexible

0593679

bthaile added 2 commits October 18, 2023 11:39

add comment that fcl version 1.3.0 or greater is needed to use templates

5a9f441

add helper func to create fcl js code generator

8857770

bjartek approved these changes Oct 20, 2023

View reviewed changes

chasefleming requested changes Oct 20, 2023

View reviewed changes

bthaile added 3 commits October 20, 2023 21:16

removed todo: added named return values from method

9cd4a66

update readme to include bindings module

5ad7e6a

use filepath.Walk to get files from template dir

6619788

chasefleming approved these changes Oct 22, 2023

View reviewed changes

bthaile merged commit 06e2391 into main Oct 23, 2023

chasefleming deleted the add-binding-gen branch October 23, 2023 17:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add binding gen js for remote and local #12

Add binding gen js for remote and local #12

bthaile commented Sep 5, 2023 •

edited

Loading

chasefleming left a comment •

edited

Loading

bjartek Oct 16, 2023

bthaile Oct 16, 2023

bjartek Oct 17, 2023

jribbink commented Oct 17, 2023 •

edited

Loading

bthaile commented Oct 18, 2023

JeffreyDoyle commented Oct 18, 2023

chasefleming left a comment

chasefleming Oct 20, 2023

bthaile Oct 21, 2023

chasefleming Oct 20, 2023

bthaile Oct 21, 2023

chasefleming Oct 20, 2023

bthaile Oct 21, 2023

bjartek Oct 21, 2023

bthaile commented Oct 21, 2023

Add binding gen js for remote and local #12

Add binding gen js for remote and local #12

Conversation

bthaile commented Sep 5, 2023 • edited Loading

chasefleming left a comment • edited Loading

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

jribbink commented Oct 17, 2023 • edited Loading

bthaile commented Oct 18, 2023

JeffreyDoyle commented Oct 18, 2023

chasefleming 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

bthaile commented Oct 21, 2023

bthaile commented Sep 5, 2023 •

edited

Loading

chasefleming left a comment •

edited

Loading

jribbink commented Oct 17, 2023 •

edited

Loading