Stdlib soundness of option returning functions

未关闭
  • 哪里不对？
#9,233 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
ocaml
领域
backend-api-design

调研方向

Start by examining the standard library bindings for Array.shift, Array.pop, Array.get, and Map.get, then trace how option-returning functions are represented and compiled. The issue proposes several competing approaches, so first determine which behavior maintainers want; done means the selected approach makes these functions sound while addressing the interop edge cases raised.

由索引模型根据 Issue 内容生成。

描述

Array.shift, Array.pop, Array.get, Map.get, and likely others are unsound, see Playground.

Here is what a correct version of shift could be:

let shiftSafe = xs =>
  if xs->Array.isEmpty {
    None
  } else {
    let value = xs->Array.getUnsafe(0)
    let _ = xs->Array.shift
    Some(value)
  }

This is a common mistake when writing JS bindings and can be unexpected to users who expect ReScript to be a safe language.

I couldn't find a previous discussion, but I believe this needs a bit of consideration. The choices I see are:

  1. Implement safe ReScript version of Stdlib functions, rename the zero overhead to shiftUnsafe, getUnsafe, etc.
  2. Fix the compiler's handling of option-returning functions.
  3. Fix the representation of options.

Unfortunately, I think there will always be edge-cases that make (2) a losing battle. Even with correct code generation, people often use imprecise types for interop making compile-time information insufficient to prevent unexpected results. For example, users storing undefined containing data in a JSON type.

Similar to the previous reasoning, (3) is likely going to cause too many issues from users that are relying on a particular option implementation.

So I believe (1) is the correct choice for the standard library. However, this still makes the "obvious" implementation of JS bindings written by users prone to errors. One idea would be to generate a fixture by default unless disabled:

@send external shift: array<'a> => option<'a> = "shift"
@send @noInterop external shiftUnsafe: array<'a> => option<'a> = "shift"

// Stdlib_Array.bs.js
let shift = t => Primitive_option.some(t.shift())
主要语言
OCaml
星标
7.5k
派生
485
平均合并
17 小时 9 分钟
30 天内合并 PR
264

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

rescript-lang/rescript 的其他 Issue

查看 rescript-lang/rescript 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。