Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add FormData under melange.dom #1153

Merged
merged 16 commits into from
Dec 8, 2024
Merged

Add FormData under melange.dom #1153

merged 16 commits into from
Dec 8, 2024

Conversation

davesnx
Copy link
Member

@davesnx davesnx commented Jul 16, 2024

Moved and adapted FormData from https://github.com/melange-community/melange-fetch/blob/master/src/Fetch.ml

Since reasonml/reason-react#846, React would benefit to have FormData as part of melange.dom rather than their own bindings

PS. Fixes a documentation typo in the first commit.

Comment on lines 7 to 10
let classify : entryValue -> [> `String of string | `File of file ] =
fun t ->
if Js.typeof t = "string" then `String (Obj.magic t)
else `File (Obj.magic t)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not really happy with the classify, but I haven't seen any other way to achieve support for File

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you show me examples of why classify is needed?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm reading it in reasonml/reason-react#846, but I wonder whether this is needed at all or if folks can classify it downstream, or even use Js.Types.classify.

Besides, if we were to keep this, I'd rather call it Blob than File, since File is a subclass of Blob.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally, the discussion for 0 runtime goes away if we remove this. If it's needed can be added in webapi

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a bit weird that entryValue is provided by this module but unnaccessible from this module, but it's simpler to keep it like this

@anmonteiro
Copy link
Member

anmonteiro commented Aug 10, 2024

How is this working in DOM? my understanding is that this code is being added to melange.belt:

(modules
:standard
\
node
node_buffer
node_child_process
node_fs
node_module
node_path
node_process
node_process
dom
dom_storage)

this code doesn't compile locally:

        melc jscomp/others/.dom.objs/melange/dom.{cmi,cmj,cmt} (exit 2)
File "jscomp/others/dom.ml", line 296, characters 18-30:
296 | module FormData = Dom_formData
                        ^^^^^^^^^^^^
Error (warning 49 [no-cmi-file]): no cmi file was found in path for module Dom_formData

Copy link
Member

@anmonteiro anmonteiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One issue with form data here is that it sort of breaks the assumption that melange.dom only has types, and no functions.

What do you think about adding the necessary types in this PR and then making a small library for form data using those types?

type t

external make : unit -> t = "FormData" [@@mel.new]
external append : string -> string -> unit = "append" [@@mel.send.pipe: t]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

append also takes a ?filename

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

append can't have a filename when it's a string. appendBlob or appendFile is used and have the ?filename there

external make : unit -> t = "FormData" [@@mel.new]
external append : string -> string -> unit = "append" [@@mel.send.pipe: t]
external delete : string -> unit = "delete" [@@mel.send.pipe: t]
external get : string -> entryValue option = "get" [@@mel.send.pipe: t]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this function doesn't return entryValue option, but rather null when not found. we should use [@@mel.return null_to_opt]

external delete : string -> unit = "delete" [@@mel.send.pipe: t]
external get : string -> entryValue option = "get" [@@mel.send.pipe: t]
external getAll : string -> entryValue array = "getAll" [@@mel.send.pipe: t]
external set : string -> string -> unit = "set" [@@mel.send.pipe: t]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

set also takes ?filename

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as append. Can't have a filename when it's a string. setObject or setFile or setBlob can be used and have ?filename

@davesnx
Copy link
Member Author

davesnx commented Nov 15, 2024

Do you prefer to keep bindings outside of melange.dom?

There's currently dom_storage (and this PR adds FormData and future prs add Blob and File). Moving those into another lib sounds good melange.web, maybe? Better inside this repo or outside?

@davesnx
Copy link
Member Author

davesnx commented Nov 15, 2024

As far as I know dom is just a dependency of melange.belt, and there's a library (name melange.dom).

@davesnx davesnx requested a review from anmonteiro November 18, 2024 22:16
Copy link
Member

@anmonteiro anmonteiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that FormData isn't really specific to JS environments that have a DOM, so this could rather be added to Js.FormData. what do you think?

@davesnx
Copy link
Member Author

davesnx commented Nov 25, 2024

That make sense, moved also https://github.com/melange-re/melange/pull/1218/files into js

@davesnx
Copy link
Member Author

davesnx commented Nov 26, 2024

Don't understand why opam macos fails while ubuntu is ok

@anmonteiro
Copy link
Member

@davesnx what do you think of the new API for set and append? I think we can get away with a single function for each and use @mel.unwrap for polymorphism.

@anmonteiro
Copy link
Member

@davesnx what do you think of the new API for set and append? I think we can get away with a single function for each and use @mel.unwrap for polymorphism.

in 32cf627 I changed it again to take the distinction between blobs / primitives into account (the functions only accept filename as a third argument if the 2nd arg is a Blob).

@anmonteiro anmonteiro merged commit 053bcff into main Dec 8, 2024
5 checks passed
@anmonteiro anmonteiro deleted the Add-dom-formdata branch December 8, 2024 06:21
anmonteiro added a commit to anmonteiro/opam-repository that referenced this pull request Feb 10, 2025
CHANGES:

- Make the `unprocessed` alert fatal by default
  ([melange-re/melange#1135](melange-re/melange#1135))
- support `-H` for hidden include dirs in OCaml 5.2
  ([melange-re/melange#1137](melange-re/melange#1137))
- support `[@mel.*]` attributes in uncurried externals
  ([melange-re/melange#1140](melange-re/melange#1140))
- add Worker types to `melange.dom`
  ([melange-re/melange#1147](melange-re/melange#1147))
- Add support for dynamic `import()`
  ([melange-re/melange#1164](melange-re/melange#1164))
- Fix code generation of custom `true` / `false` constructors
  ([melange-re/melange#1175](melange-re/melange#1175))
- Fix code generation of OCaml objects that refers to an init variable in scope
  ([melange-re/melange#1183](melange-re/melange#1183))
- Support `[@mel.as "string"]` in variant definitions
  ([melange-re/melange#884](melange-re/melange#884))
- BREAKING: remove `[@@deriving jsConverter]` for variant definitions
  ([melange-re/melange#884](melange-re/melange#884)). Use `[@mel.as
  "string here"]` instead.
- Support OCaml 5.3 ([melange-re/melange#1168](melange-re/melange#1168))
- Upgrade Stdlib to the OCaml 5.3 Stdlib
  ([melange-re/melange#1182](melange-re/melange#1182))
- Support `[@mel.tag "the_tag"]` in variant definitions
  ([melange-re/melange#1189](melange-re/melange#1189))
  - combined with `[@mel.as ..]` in variant definitions and inline record
    payloads, Melange can now express types for discriminated union object
    shapes.
- melange-ppx: don't silence warning 20 (`ignored-extra-argument`) for
  `%mel.raw` application
  ([melange-re/melange#1166](melange-re/melange#1166)).
  - This change reverts the behavior introduced in
    ([melange-re/melange#915](melange-re/melange#915)).
  - The new recommendation is to annotate `%mel.raw` functions or disable
    warning 20 at the project level.
- ppx,core: propagate internal FFI information via attributes instead of adding
  marshalled data in the native primitive name
  ([melange-re/melange#1222](melange-re/melange#1222))
- melange-ppx: allow `@mel.unwrap` polyvariants not to have a payload
  ([melange-re/melange#1239](melange-re/melange#1239))
- `melange.node`: fix `Buffer.fromString` and add
  `Buffer.fromStringWithEncoding`
  ([melange-re/melange#1246](melange-re/melange#1246))
- `melange.node`: bind to all supported Node.js `Buffer` encodings in
  `Node.Buffer` ([melange-re/melange#1246](melange-re/melange#1246))
- `melange.js`: Add `Js.FormData` with bindings to the
  [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) API
  ([melange-re/melange#1153](melange-re/melange#1153),
  [melange-re/melange#1270](melange-re/melange#1270),
  [melange-re/melange#1281](melange-re/melange#1281)
- `melange.js`: Add `Js.Blob` and `Js.File` with bindings to the
  [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) and
  [File](https://developer.mozilla.org/en-US/docs/Web/API/File) APIs
  ([melange-re/melange#1218](melange-re/melange#1218))
- `melange.js`: add `TypedArray` types at the toplevel in the `Js` module
  ([melange-re/melange#1248](melange-re/melange#1248))
- BREAKING: remove `--mel-g`
  ([melange-re/melange#1234](melange-re/melange#1234))
- runtime(`melange.js`): port `[@mel.send.pipe]` functions to `[@mel.send]`,
  taking advantage of the `@mel.send` + labeled argument improvement (see
  above) ([melange-re/melange#1260](melange-re/melange#1260),
  [melange-re/melange#1264](melange-re/melange#1264),
  [melange-re/melange#1265](melange-re/melange#1265),
  [melange-re/melange#1266](melange-re/melange#1266),
  [melange-re/melange#1280](melange-re/melange#1280),
  [melange-re/melange#1278](melange-re/melange#1278))
- core: fix a crash related to finding constructor names in pattern matching triggered by dune's earlier implementation of `(implicit_transitive_deps false)`
  ([melange-re/melange#1238](melange-re/melange#1238),
  [melange-re/melange#1262](melange-re/melange#1262))
- core: pre-compute the closure param map for functions inlined with
  `--mel-cross-module-opt`
  ([melange-re/melange#1219](melange-re/melange#1219))
- BREAKING: ppx: print the `deprecated` alert for `@@deriving abstract` at the
  declaration site rather than at (all) usages
  ([melange-re/melange#1269](melange-re/melange#1269))
- JS generation: prettify `for` loops
  ([melange-re/melange#1275](melange-re/melange#1275))
- JS generation: improve formatting for `throw` and `return` statements, JS
  objects ([melange-re/melange#1286](melange-re/melange#1286),
  [melange-re/melange#1289](melange-re/melange#1289))
- JS generation: improve formatting for empty return and continue statements
  ([melange-re/melange#1288](melange-re/melange#1288))
- JS generation: remove trailing spaces before commas in `export`
  ([melange-re/melange#1287](melange-re/melange#1287))
- JS generation: remove redundant switch cases branches
  ([melange-re/melange#1295](melange-re/melange#1295))
- JS generation: move space before comma inside `for` definition
  ([melange-re/melange#1296](melange-re/melange#1296))
- JS generation: add space before while loop condition
  ([melange-re/melange#1297](melange-re/melange#1297))
- JS generation: improve indentation of parenthesized blocks
  ([melange-re/melange#1293](melange-re/melange#1293))
- JS generation: add space after constructor comments
  ([melange-re/melange#1294](melange-re/melange#1294))
- JS generation: improve identation of `switch` cases
  ([melange-re/melange#1299](melange-re/melange#1299))
- JS generation: don't generate empty `default:` cases in `switch`
  ([melange-re/melange#1300](melange-re/melange#1300))
- JS generation: emit `module.exports` in CommonJS instead of `exports.x`
  ([melange-re/melange#1314](melange-re/melange#1314))
- JS generation: remove trailing newline after `switch`
  ([melange-re/melange#1313](melange-re/melange#1313))
- ffi: allow annotating `@mel.send` FFI with `@mel.this` to specify which
  parameter should represent the "self" argument.
  ([melange-re/melange#1303](melange-re/melange#1285),
  [melange-re/melange#1310](melange-re/melange#1310))
  - This improvement to the FFI allows expressing more FFI constructs via
    labeled and optionally labeled arguments, e.g. `external foo: value:string
    -> (t [@mel.this]) -> unit = "foo" [@@mel.send]` will now produce
    `t.foo(value)` instead of `value.foo(t)`.
  - It also allows removing usages of `[@mel.send.pipe: t]` in favor of
    `[@mel.send]` with `[@mel.this]`, including when used with `@mel.variadic`.
- ppx: deprecate `[@mel.send.pipe]`
  ([melange-re/melange#1321](melange-re/melange#1321))
- core: fix missed optimization on OCaml versions 5.2 and above, caused by
  [ocaml/ocaml#12236](ocaml/ocaml#12236) generating
  multiple function nodes for `fun a -> fun b -> ...` in the Lambda IR.
anmonteiro added a commit to anmonteiro/opam-repository that referenced this pull request Feb 10, 2025
CHANGES:

- Make the `unprocessed` alert fatal by default
  ([melange-re/melange#1135](melange-re/melange#1135))
- support `-H` for hidden include dirs in OCaml 5.2
  ([melange-re/melange#1137](melange-re/melange#1137))
- support `[@mel.*]` attributes in uncurried externals
  ([melange-re/melange#1140](melange-re/melange#1140))
- add Worker types to `melange.dom`
  ([melange-re/melange#1147](melange-re/melange#1147))
- Add support for dynamic `import()`
  ([melange-re/melange#1164](melange-re/melange#1164))
- Fix code generation of custom `true` / `false` constructors
  ([melange-re/melange#1175](melange-re/melange#1175))
- Fix code generation of OCaml objects that refers to an init variable in scope
  ([melange-re/melange#1183](melange-re/melange#1183))
- Support `[@mel.as "string"]` in variant definitions
  ([melange-re/melange#884](melange-re/melange#884))
- BREAKING: remove `[@@deriving jsConverter]` for variant definitions
  ([melange-re/melange#884](melange-re/melange#884)). Use `[@mel.as
  "string here"]` instead.
- Support OCaml 5.3 ([melange-re/melange#1168](melange-re/melange#1168))
- Upgrade Stdlib to the OCaml 5.3 Stdlib
  ([melange-re/melange#1182](melange-re/melange#1182))
- Support `[@mel.tag "the_tag"]` in variant definitions
  ([melange-re/melange#1189](melange-re/melange#1189))
  - combined with `[@mel.as ..]` in variant definitions and inline record
    payloads, Melange can now express types for discriminated union object
    shapes.
- melange-ppx: don't silence warning 20 (`ignored-extra-argument`) for
  `%mel.raw` application
  ([melange-re/melange#1166](melange-re/melange#1166)).
  - This change reverts the behavior introduced in
    ([melange-re/melange#915](melange-re/melange#915)).
  - The new recommendation is to annotate `%mel.raw` functions or disable
    warning 20 at the project level.
- ppx,core: propagate internal FFI information via attributes instead of adding
  marshalled data in the native primitive name
  ([melange-re/melange#1222](melange-re/melange#1222))
- melange-ppx: allow `@mel.unwrap` polyvariants not to have a payload
  ([melange-re/melange#1239](melange-re/melange#1239))
- `melange.node`: fix `Buffer.fromString` and add
  `Buffer.fromStringWithEncoding`
  ([melange-re/melange#1246](melange-re/melange#1246))
- `melange.node`: bind to all supported Node.js `Buffer` encodings in
  `Node.Buffer` ([melange-re/melange#1246](melange-re/melange#1246))
- `melange.js`: Add `Js.FormData` with bindings to the
  [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) API
  ([melange-re/melange#1153](melange-re/melange#1153),
  [melange-re/melange#1270](melange-re/melange#1270),
  [melange-re/melange#1281](melange-re/melange#1281)
- `melange.js`: Add `Js.Blob` and `Js.File` with bindings to the
  [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) and
  [File](https://developer.mozilla.org/en-US/docs/Web/API/File) APIs
  ([melange-re/melange#1218](melange-re/melange#1218))
- `melange.js`: add `TypedArray` types at the toplevel in the `Js` module
  ([melange-re/melange#1248](melange-re/melange#1248))
- BREAKING: remove `--mel-g`
  ([melange-re/melange#1234](melange-re/melange#1234))
- runtime(`melange.js`): port `[@mel.send.pipe]` functions to `[@mel.send]`,
  taking advantage of the `@mel.send` + labeled argument improvement (see
  above) ([melange-re/melange#1260](melange-re/melange#1260),
  [melange-re/melange#1264](melange-re/melange#1264),
  [melange-re/melange#1265](melange-re/melange#1265),
  [melange-re/melange#1266](melange-re/melange#1266),
  [melange-re/melange#1280](melange-re/melange#1280),
  [melange-re/melange#1278](melange-re/melange#1278))
- core: fix a crash related to finding constructor names in pattern matching triggered by dune's earlier implementation of `(implicit_transitive_deps false)`
  ([melange-re/melange#1238](melange-re/melange#1238),
  [melange-re/melange#1262](melange-re/melange#1262))
- core: pre-compute the closure param map for functions inlined with
  `--mel-cross-module-opt`
  ([melange-re/melange#1219](melange-re/melange#1219))
- BREAKING: ppx: print the `deprecated` alert for `@@deriving abstract` at the
  declaration site rather than at (all) usages
  ([melange-re/melange#1269](melange-re/melange#1269))
- JS generation: prettify `for` loops
  ([melange-re/melange#1275](melange-re/melange#1275))
- JS generation: improve formatting for `throw` and `return` statements, JS
  objects ([melange-re/melange#1286](melange-re/melange#1286),
  [melange-re/melange#1289](melange-re/melange#1289))
- JS generation: improve formatting for empty return and continue statements
  ([melange-re/melange#1288](melange-re/melange#1288))
- JS generation: remove trailing spaces before commas in `export`
  ([melange-re/melange#1287](melange-re/melange#1287))
- JS generation: remove redundant switch cases branches
  ([melange-re/melange#1295](melange-re/melange#1295))
- JS generation: move space before comma inside `for` definition
  ([melange-re/melange#1296](melange-re/melange#1296))
- JS generation: add space before while loop condition
  ([melange-re/melange#1297](melange-re/melange#1297))
- JS generation: improve indentation of parenthesized blocks
  ([melange-re/melange#1293](melange-re/melange#1293))
- JS generation: add space after constructor comments
  ([melange-re/melange#1294](melange-re/melange#1294))
- JS generation: improve identation of `switch` cases
  ([melange-re/melange#1299](melange-re/melange#1299))
- JS generation: don't generate empty `default:` cases in `switch`
  ([melange-re/melange#1300](melange-re/melange#1300))
- JS generation: emit `module.exports` in CommonJS instead of `exports.x`
  ([melange-re/melange#1314](melange-re/melange#1314))
- JS generation: remove trailing newline after `switch`
  ([melange-re/melange#1313](melange-re/melange#1313))
- ffi: allow annotating `@mel.send` FFI with `@mel.this` to specify which
  parameter should represent the "self" argument.
  ([melange-re/melange#1303](melange-re/melange#1285),
  [melange-re/melange#1310](melange-re/melange#1310))
  - This improvement to the FFI allows expressing more FFI constructs via
    labeled and optionally labeled arguments, e.g. `external foo: value:string
    -> (t [@mel.this]) -> unit = "foo" [@@mel.send]` will now produce
    `t.foo(value)` instead of `value.foo(t)`.
  - It also allows removing usages of `[@mel.send.pipe: t]` in favor of
    `[@mel.send]` with `[@mel.this]`, including when used with `@mel.variadic`.
- ppx: deprecate `[@mel.send.pipe]`
  ([melange-re/melange#1321](melange-re/melange#1321))
- core: fix missed optimization on OCaml versions 5.2 and above, caused by
  [ocaml/ocaml#12236](ocaml/ocaml#12236) generating
  multiple function nodes for `fun a -> fun b -> ...` in the Lambda IR.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants