Proposal: A tool for generating a deno-optimized version of the driver

[bradenmacdonald]

This PR contains a script which I used to auto-generate a Deno version of neo4j-driver-lite. If you are interested in officially supporting Deno, this is one way to do so.

Background

• Deno is an increasingly popular alternative to Node.js that is built with Rust and natively supports TypeScript
• Because Deno supports web APIs, the "browser" version of the JavaScript driver does work with Deno (though I haven't tested it extensively). But it's preferable to have an optimized version that includes full TypeScript typings.
• I had previously mentioned my port of driver version 4.3 on the forum and was told there was some interest from you guys in supporting Deno. So here is one approach. If you'd like to support Deno, I think this is the easiest way, but there are of course other approaches. If you want to close this PR and pursue another path or don't want to support Deno for now, it's totally fine with me.

Prerequisites

While working on Deno, I found and fixed a bunch of other issues in the codebase. To make the review easier, I have separated them into smaller, simpler pull requests:

• Use isolatedModules for easier compatibility with Deno (and others) #827
• Fix some broken imports #828
• Fix some TypeScript errors found with TypeScript 4.5 / Deno #829

This PR includes all the commits from those PRs because they're required. Once they are merged, the diff of this PR will be much smaller (really just the one commit 73981b1).

Whether or not you are interested in merging this PR, I do hope you can merge those fix PRs, as it will make it much easier to create a Deno port in the future.

Approach

See this link for the new README that explains the approach:

This folder contains a script which can auto-generate a version of neo4j-driver-lite that is fully compatible with Deno, including complete type information.

The resulting driver does not use any dependencies outside of the Deno standard library.

The script will:

1. Copy neo4j-driver-lite and the Neo4j packages it uses into a subfolder here called lib.
2. Rewrite all imports to Deno-compatible versions
3. Replace the "node channel" with the "browser channel"
4. Test that the resulting driver can be imported by Deno and passes type checks

Demo

The resulting code that is auto-generated by this script can be seen at https://deno.land/x/[email protected] . It should work identically to neo4j-driver-lite.

Instructions for testing it out are in the README in this PR and also in the README at https://deno.land/x/[email protected]

Known issues

I didn't have time to figure out how to test this driver using the test suite. But the code is 99% the same as the neo4j-driver-lite code (which is tested), it's fully type-checked by TypeScript as part of the build process, and I've been using this in a large Neo4j project (via Vertex Framework) without issues.

Other Thoughts

Thanks for having a nicely structured codebase and keeping the dependencies to a minimum! It made this port relatively easy :)

[bigmontz]

Hi @bradenmacdonald,

thanks for you contribution. For your PR be able to be reviewed, you need to read and sign Neo4j's CLA (https://neo4j.com/developer/cla/).

[bradenmacdonald]

@bigmontz I did, but I did it just before submitting these PRs so maybe your records haven't been updated yet.

[bigmontz]

@bradenmacdonald, found it.

I will take a look at your previous PRs.

[bigmontz]

Hi @bradenmacdonald,

I've merged your others PRs. Could you please rebase this PR?

I will find a moment next week for setting up a Deno environment test the changes you did in this PR.

Many thanks.

[bradenmacdonald]

@bigmontz Sure thing. Rebased :)

[bigmontz]

Great contribution, @bradenmacdonald.

It's going to be merged to 5.0, since I'd like to setup the integration test suite before release it.

Many thanks, again.

[bradenmacdonald]

Makes sense, thanks! Cheers :)