Switch to TypeScript - Githubissues

jvilk commented 11 years ago

We have a working TypeScript port of Doppio, but we need to backport a number of items to it.

Here's a comparison view to see all of the lines of code we need to backport: https://github.com/int3/doppio/compare/30c1e99ef1cba1cbbd338043d5881b9f709e1393...master

Here's a list (in order of when it was added to Doppio):

[x] Expose jvm.dump_state in the browser. https://github.com/int3/doppio/commit/30e1014b918fe71e159a1c73698d76bcbf8b38a6
[x] Backport run_bytecode https://github.com/int3/doppio/commit/d94c3c328971d73258a27b9de21fcaa3de0af64f https://github.com/int3/doppio/commit/34a5630e56cca8904352b494b40bb867a380cc52
[x] Backport Giles' render script.
[x] Remove Ruby renderer and dependencies. https://github.com/int3/doppio/commit/992154a4fd4bdd68c682817566c2973d76adb32c
[x] Remove the Perl dependency. https://github.com/int3/doppio/commit/ac30ed218d54567ea180a2361a2f26c6a27fd04a
[x] Backport Giles' new server script.
[x] Backport misc setup.sh changes.
[x] Backport debug log API. https://github.com/int3/doppio/commit/8aa8b583b8e3ffdad95fbeceda7587e05dd99cd0
[x] Backport Giles' core-viewer browser integration.
[x] Backport Giles' console history hack https://github.com/int3/doppio/commit/d33a34ef7110ce8f5972000a26d1c5109bbb8495
[x] BrowserFS conversion: Asynchronize frontend code.
[x] BrowserFS conversion: Asynchronize native methods.
[x] BrowserFS conversion: Switch completely to buffers. No more binary strings.
[x] BrowserFS conversion: Asynchronize testing.
[x] BrowserFS conversion: Change demo to use new paths.
[x] Fix feature detection. https://github.com/int3/doppio/commit/9598eecd0aeac70da3e99089b83ce074f5470b36
[x] Backport Bowerification
[x] Fix release build
[x] Get dev browser build to work
[x] Get release browser build to work
[x] Add missing comments into TypeScript source.
[x] Clean up Makefile.
[x] setup.sh Java 7 check
[x] Upload 0 files bug fix
[x] Array reflection fixes
[x] setup.sh fixes

jvilk commented 11 years ago

I'll probably have to update this once we've been Bowerified, but it's a start!

jvilk commented 11 years ago

Updated with more items.

perimosocordiae commented 11 years ago

Files that still need work:

[x] src/util (buffers)
[x] src/testing (everything async)
[x] src/natives (everything async)
[x] src/runtime (for multinewarray)
[x] src/opcodes (for multinewarray)

lavelle commented 11 years ago

Is it counterproductive for me to be writing a load of new stuff in CoffeeScript right now? I know the conversion process is pretty simple since TypeScript is a strict JS superset so you can just compile and change the extension, but generated CoffeeScript can be kinda ugly (especially loops and stuff) and it seems like if TypeScript is the future of this project I may as well start using it now, since I'll have to in the long run.

perimosocordiae commented 11 years ago

It's up to you. Your options are:

Keep working with Coffeescript, with the understanding that you might need to do some porting later.
Switch to TypeScript, with the understanding that it's not fully feature-complete yet (see above :smile:).

The porting process really isn't too bad, though it does involve manually un-crappifying the coffee-compiled output.

jvilk commented 11 years ago

@lavelle : If you keep plugging away in CoffeeScript. I'll convert your code for you. :thumbsup:

But if you want to be proactive about the switch, you'll probably want to wait until we fix the browser build process for TypeScript. Right now, it's broken.

lavelle commented 11 years ago

Okay, thanks. I'll stick with CoffeeScript for now and switch as soon as TypeScript is finished and becomes Doppio's official language.

jvilk commented 11 years ago

Adding the few things we've added to master to the checklist. I think it's time for a final push to get this dude building properly.

jvilk commented 11 years ago

Using RequireJS, I have a dev build of typed-doppio 'booting up' (preloading files) in the browser. It's not completely working (for some reason, running ls in the root directory never triggers the callback...), but it's progress!

Here's some build instructions:

tsc --module amd --outDir build/dev browser/frontend.ts
Do the other build junk (cat-ing the CSS file, generating mini-rt and listings.json, etc.)

It's pretty simple compared to our current shenanigans. And we no longer have to track dependencies (!) in the Makefile or index.mustache. :smile:

This also suggests that we will be able to use RequireJS's 'optimizer' to make a single module for all of Doppio, and that we can simply build release from the development output. For example (Make pseudo-code):

release: dev
  // Recursively run make so it'll see the new files.
  make _release
_release: build/release/*/*.js
  // Run RequireJS's optimizer.
  // Run Uglify on the module.
  // Remove staging directory.
build/release/*/*.js: build/dev/*/*.js
  // Run through Jez's ice-cream, dump into a staging directory.

There are still some issues, though:

I temporarily removed Ace from the demo page, as it clobbers require. There has to be some way to make it not do that.
As mentioned before, it doesn't completely work yet.
We need to track actual AMD dependencies (as opposed to type dependencies) separate from require calls using an annotation. See my recent changes for details. But maybe making these explicit is a 'good thing'?

...but we're close. :smile:

jvilk commented 11 years ago

Oh. I see. read_dir is broken... shakes fist at @perimosocordiae

I fixed a few things, but I'll need to do some debugging later as it's still returning nothing: https://github.com/int3/doppio/commit/acb9b3ba2c64e43e62847395b43ff979da7d757f

jvilk commented 11 years ago

The dev build is on-par with master Doppio (ignoring Ace editor issues). I'm trying to get a release build working using RequireJS's compiler. When I get this working, we'll have an easy automated method of generating a release build and the library using that compiler. But for now, it's choking on loading the JavaScript dependencies in the release configuration (e.g. underscore).

(Note that I still need to update the Makefile; that's the last thing I plan to do)

jvilk commented 11 years ago

OK. So, apparently the release build issues were caused by me not placing the amd-dependency annotations at the top of the source files. Once that was done, it... worked!

todo:

[x] Hook up Jez's ice-cream module to get a real release build working in the browser. (command: node ../../node_modules/.bin/ice-cream $file_produced_from_r.js --remove trace --remove vtrace --remove debug > $outputfile)
[x] Fix up Ace Editor issues.
[x] Update the dev Makefile target.
[x] Update the library Makefile target.
[x] Update the release Makefile target.
[x] Decouple the demo logic from the library on the demo page.

jvilk commented 11 years ago

Alright! Release/dev/library builds properly work (can someone sanity check me?). We just need to port over comments!

Here's the comments checklist:

[x] browser/frontend.ts
[x] browser/mockconsole.ts
[x] browser/untar.ts
[x] console/coverage.ts
[x] console/disassembler.ts
[x] console/repl.ts
[x] console/runner.ts
[x] console/test_runner.ts
[x] src/ClassData.ts
[x] src/ClassLoader.ts
[x] src/ConstantPool.ts
[x] src/attributes.ts
[x] src/disassembler.ts
[x] src/exceptions.ts
[x] src/gLong.ts
[x] src/java_object.ts
[x] src/jvm.ts
[x] src/logging.ts
[x] src/methods.ts
[x] src/natives.ts
[x] src/opcodes.ts
[x] src/option_parser.ts
[x] src/runtime.ts
[x] src/testing.ts
[x] src/util.ts

jvilk commented 11 years ago

I believe we are ready. There's nothing more to backport, release/release-cli/dev/dev-cli all build properly and pass tests in the same way as master, and I've verified that building from a cleanly cloned repo works.

jvilk commented 11 years ago

I just hit the switch! We're typed now. :smile:

plasma-umass / doppio

Switch to TypeScript #243