Translate EarlGrey headers to Javascript calls #178

DanielMSchmidt · 2017-06-28T19:19:24Z

Plan

As migrating functionality from EarlGrey to detox is manual and therefore time consuming and error-prone process @rotemmiz came up with the idea of generating Javascript calls from EarlGrey itself.
The idea is to have EarlGrey as input, parse its header files to define the possible functions and result in a JS EarlGrey client that you may call that will then execute the equivalent Objective-C functions through the bridge.

This way we might be able to focus on real functionality and enable new contributors to not have to worry about the detox internals from the beginning.

Current State

GreyActions.h is transformed to detox/src/ios/EarlGrey/GreyActions.js

Update 1: @loganfsmyth hinted me in the right direction with the comments, so I got that one working. Still need to figure out how to add a space behind them, but if I can't find a babel option there still is good ol' str.replace(/\*\//g, '*/\n') ;)

loganfsmyth · 2017-06-28T20:16:29Z

You may want to consider passing your code through something like https://github.com/prettier/prettier to make the formatting nicer. Babel's toolchain by default does basic formatting, but making it super nicely readable isn't really one of our goals since most people don't read our output at all, and formatting the output nicely take longer.

DanielMSchmidt · 2017-06-28T20:18:31Z

Great idea, that might make it much nicer 👍

DanielMSchmidt · 2017-06-28T20:22:59Z

@loganfsmyth I tried the on the output, but It seems to ignore the comments completely.

I will file an issue (prettier/prettier#2340) and maybe do a PR for that.
Maybe that use-case is a nice enhancement for them.

DanielMSchmidt · 2017-07-01T10:04:38Z

I found a good first throw for the type checking and I will try to mimic the current behavior in terms of the return statement.

DanielMSchmidt · 2017-07-01T10:51:01Z

For testing I would execute the transformation on a bunch of files and import the js file to then test their functionality, I think this is the easiest way

rotemmiz

Ho my, this is super neat!

rotemmiz · 2017-07-02T19:16:16Z

demo.js

+@return A GREYAction that performs a long press on an element.
+*/static actionForLongPressAtPointduration(point, duration) {
+    if (typeof point === "object") throw new Error("point should be a object, but got " + point);
+    if (typeof duration === "number") throw new Error("duration should be a number, but got " + duration);


Maybe print typeof params instead of value

Great Idea, why don't we have both "duration should be a number, but got '42'(string)". Will add it to the todos

rotemmiz · 2017-07-02T19:40:45Z

Re "exclude functions with unsupported argument types", we currently don't support passing Booleans in the objC invocation implementation.

DanielMSchmidt · 2017-07-02T19:44:03Z

@rotemmiz Is there a reason that we don't support it? I thought about these out flagged functions.

rotemmiz · 2017-07-02T19:47:03Z

It's a bug in the implementation, and it will be hard to fix since the code there is a bit messy. We need to refactor/rewrite it some day.

It does work on the Java implementation though ;)

LeoNatan · 2017-07-05T12:40:13Z

@rotemmiz If you want, let's have a look at refactoring after I finish a milestone in the profiler / Instruments.

rotemmiz · 2017-08-02T20:58:52Z

generation/package.json

+    "test": "jest"
+  },
+  "author": "DanielMSchmidt <danielmschmidt92@gmail.com>",
+  "license": "ISC",


awitherow

Asides from some clarity in documentation and code structure this is really awesome. These opinions are just my own as well, take them or leave them 🙇 🙏

awitherow · 2017-08-03T07:10:20Z

generation/earl-grey.js

+  );
+}
+
+function capitalizeFirstLetter(string) {


it might be a good time to move capitalizeFirstLetter and methodNameToSnakeCase and sanitizeArgument either to another file that specifically is for helper methods, or at least organise them together so that the main functions in this file (createMethod, createClass, ...) are logically sorted for future reading of this file.

Good idea, the are all based around making the input more sane... Will do so 👍

awitherow · 2017-08-03T07:10:56Z

generation/earl-grey.js

+  isOneOf,
+} = require('./type-checks');
+
+function createClass(json) {


Would love to see some comment code on what these json structures look like, or at least references to them somewhere. It helps when visualising things moving through the functions 👍

Will add comments like this 👍

awitherow · 2017-08-03T07:14:08Z

generation/earl-grey.js

+function capitalizeFirstLetter(string) {
+  return string.charAt(0).toUpperCase() + string.slice(1);
+}
+function methodNameToSnakeCase(name) {


isThisSnakeCase?

YesItIs 😂

awitherow · 2017-08-03T07:43:13Z

generation/type-checks.js

+    t.identifier(name)
+  );
+
+const isNumber = generateTypeCheck("number");


I am really stoked about this and would love to see this typecheck generator be a separate package I could use 👍 <3

I can extract that out, what would you search for if you would like to find it?

DanielMSchmidt · 2017-08-06T13:04:15Z

@awitherow Extracted the guard clause generation into the babel-generate-guard-clauses.

@rotemmiz The build seems to be failing on master and the error looks the same as here, can this be merged?

awitherow · 2017-08-09T09:13:43Z

Nice @DanielMSchmidt the guard class generators are looking nice 👍

DanielMSchmidt · 2017-08-10T07:01:45Z

🎉 🎊 🎉 🎊🎉

DanielMSchmidt mentioned this pull request Jun 28, 2017

Feature Request: Comments in babel-types babel/babel#5897

Open

DanielMSchmidt mentioned this pull request Jun 28, 2017

Enhancement: Comments prettier/prettier#2340

Closed

rotemmiz reviewed Jul 2, 2017

View reviewed changes

DanielMSchmidt force-pushed the code-generation branch from d4d7444 to 39b2598 Compare July 11, 2017 06:47

This was referenced Jul 13, 2017

Possible Earl Grey actions we would want to expose? #159

Closed

Add point to point panning API #154

Closed

DanielMSchmidt force-pushed the code-generation branch 2 times, most recently from 0e46849 to 9fadf88 Compare August 2, 2017 20:21

rotemmiz reviewed Aug 2, 2017

View reviewed changes

DanielMSchmidt changed the title ~~WIP: Translate EarlGrey headers to Javascript calls~~ Translate EarlGrey headers to Javascript calls Aug 2, 2017

awitherow approved these changes Aug 3, 2017

View reviewed changes

DanielMSchmidt force-pushed the code-generation branch from c362a85 to 3dbc01e Compare August 5, 2017 18:46

DanielMSchmidt force-pushed the code-generation branch from 9913fee to e5e96c1 Compare August 9, 2017 05:50

DanielMSchmidt added 7 commits August 9, 2017 07:50

initial script setup for creating a class with same name as input

940402d

setup methods to have correctly named arguments

ad072dc

take static methods into account

7c16794

include comments in output js

9016146

enable js type checks for objective-c types

ac4a9b1

refactor generation into own module for better testability

a0eb0bb

add export statement to output

b06771d

DanielMSchmidt added 22 commits August 9, 2017 07:50

add direct call and generated code

de0eb64

add actual type to type check

56efb82

add more fine grained validations for complex types

9129e49

refactor too simple function away

06ea2d8

refactor type checks to own file

73cfa1f

add generation to ci pipeline

5166011

map alike argument types

ad20cda

use snake case for methods and add colons for selector

4130a1d

add auxilliary comment

e7c6ed2

add readme

01ed3ec

rename to appropriate name

1af9d3a

replace manual with generated code

0632779

fix ci build

5308b41

add comment about json structure

69c558c

move helpers into own file

a80f20a

log status in long running tests

b55e5ba

moved guard clause code into seperate package

abe2cf3

move greyactions in existing folder

14dfa70

refactor enum types to be declared the same as currently

f1308bb

move earl-grey into subdirectory

7e2d225

add global functions

1882bda

add sanitizer calls

5bcd23f

DanielMSchmidt force-pushed the code-generation branch from e5e96c1 to 5bcd23f Compare August 9, 2017 05:53

exclude generated code from coverage

175f481

rotemmiz merged commit e607fb3 into wix:master Aug 10, 2017

DanielMSchmidt deleted the code-generation branch August 10, 2017 07:01

isnifer mentioned this pull request Aug 27, 2017

Call supported EarlGrey and Espresso matcher APIs in runtime #251

Closed

wix locked and limited conversation to collaborators Jul 23, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Translate EarlGrey headers to Javascript calls #178

Translate EarlGrey headers to Javascript calls #178

DanielMSchmidt commented Jun 28, 2017 •

edited

Loading

loganfsmyth commented Jun 28, 2017

DanielMSchmidt commented Jun 28, 2017

DanielMSchmidt commented Jun 28, 2017 •

edited

Loading

DanielMSchmidt commented Jul 1, 2017

DanielMSchmidt commented Jul 1, 2017

rotemmiz left a comment

rotemmiz Jul 2, 2017

DanielMSchmidt Jul 2, 2017

rotemmiz commented Jul 2, 2017

DanielMSchmidt commented Jul 2, 2017

rotemmiz commented Jul 2, 2017

LeoNatan commented Jul 5, 2017

rotemmiz Aug 2, 2017

DanielMSchmidt Aug 2, 2017

awitherow left a comment

awitherow Aug 3, 2017

DanielMSchmidt Aug 3, 2017

awitherow Aug 3, 2017

DanielMSchmidt Aug 3, 2017

awitherow Aug 3, 2017

DanielMSchmidt Aug 3, 2017

awitherow Aug 3, 2017

DanielMSchmidt Aug 3, 2017

DanielMSchmidt commented Aug 6, 2017

awitherow commented Aug 9, 2017

DanielMSchmidt commented Aug 10, 2017

Translate EarlGrey headers to Javascript calls #178

Translate EarlGrey headers to Javascript calls #178

Conversation

DanielMSchmidt commented Jun 28, 2017 • edited Loading

Plan

Current State

loganfsmyth commented Jun 28, 2017

DanielMSchmidt commented Jun 28, 2017

DanielMSchmidt commented Jun 28, 2017 • edited Loading

DanielMSchmidt commented Jul 1, 2017

DanielMSchmidt commented Jul 1, 2017

rotemmiz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rotemmiz commented Jul 2, 2017

DanielMSchmidt commented Jul 2, 2017

rotemmiz commented Jul 2, 2017

LeoNatan commented Jul 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

awitherow 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

DanielMSchmidt commented Aug 6, 2017

awitherow commented Aug 9, 2017

DanielMSchmidt commented Aug 10, 2017

DanielMSchmidt commented Jun 28, 2017 •

edited

Loading

DanielMSchmidt commented Jun 28, 2017 •

edited

Loading