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

💥 Drop deprecated base64 #5664

Merged
merged 4 commits into from
Feb 5, 2025
Merged

💥 Drop deprecated base64 #5664

merged 4 commits into from
Feb 5, 2025

Conversation

dubzzz
Copy link
Owner

@dubzzz dubzzz commented Feb 5, 2025

Description

The arbitrary base64 has been marked for deprecation since version 3.22.0.

It is now being fully dropped.

If you still want to rely on something behaving this way we recommend you to use the following constructs:

function base64(): fc.Arbitrary<string> {
  return fc.constantFrom(...'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+/');
}
Or even more accurate
function base64Mapper(v: number) {
  if (v < 26) return String.fromCharCode(v + 65); // A-Z
  if (v < 52) return String.fromCharCode(v + 97 - 26); // a-z
  if (v < 62) return String.fromCharCode(v + 48 - 52); // 0-9
  return v === 62 ? '+' : '/'; // 43, 47
}

function base64Unmapper(s: unknown) {
  if (typeof s !== 'string' || s.length !== 1) {
    throw new Error('Invalid entry');
  }
  const v = s.charCodeAt(0);
  if (v >= 65 && v <= 90) return v - 65; // A-Z
  if (v >= 97 && v <= 122) return v - 97 + 26; // a-z
  if (v >= 48 && v <= 57) return v - 48 + 52; // 0-9
  return v === 43 ? 62 : v === 47 ? 63 : -1; // +/
}

function base64() {
  return integer({ min: 0, max: 63 }).map(base64Mapper, base64Unmapper);
}

ChecklistDon't delete this checklist and make sure you do the following before opening the PR

  • The name of my PR follows gitmoji specification
  • My PR references one of several related issues (if any)
    • New features or breaking changes must come with an associated Issue or Discussion
    • My PR does not add any new dependency without an associated Issue or Discussion
  • My PR includes bumps details, please run yarn bump and flag the impacts properly
  • My PR adds relevant tests and they would have failed without my PR (when applicable)

Advanced

  • Category: 💥 Breaking change
  • Impacts: Dropped arbitraries

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
etrepum Bob Ippolito
**Description**

<!-- Please provide a short description and potentially linked issues
justifying the need for this PR -->

The arbitrary `base64` has been marked for deprecation since version
3.22.0.

It is now being fully dropped.

If you still want to rely on something behaving this way we recommend
you to use the following constructs:

```ts
function base64(): fc.Arbitrary<string> {
  return fc.constantFrom(...'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+/');
}
```

<details>
<summary>Or even more accurate</summary>

```ts
function base64Mapper(v: number) {
  if (v < 26) return String.fromCharCode(v + 65); // A-Z
  if (v < 52) return String.fromCharCode(v + 97 - 26); // a-z
  if (v < 62) return String.fromCharCode(v + 48 - 52); // 0-9
  return v === 62 ? '+' : '/'; // 43, 47
}

function base64Unmapper(s: unknown) {
  if (typeof s !== 'string' || s.length !== 1) {
    throw new Error('Invalid entry');
  }
  const v = s.charCodeAt(0);
  if (v >= 65 && v <= 90) return v - 65; // A-Z
  if (v >= 97 && v <= 122) return v - 97 + 26; // a-z
  if (v >= 48 && v <= 57) return v - 48 + 52; // 0-9
  return v === 43 ? 62 : v === 47 ? 63 : -1; // +/
}

function base64() {
  return integer({ min: 0, max: 63 }).map(base64Mapper, base64Unmapper);
}
```
</details>

<!-- * Your PR is fixing a bug or regression? Check for existing issues
related to this bug and link them -->
<!-- * Your PR is adding a new feature? Make sure there is a related
issue or discussion attached to it -->

<!-- You can provide any additional context to help into understanding
what's this PR is attempting to solve: reproduction of a bug, code
snippets... -->

**Checklist** — _Don't delete this checklist and make sure you do the
following before opening the PR_

- [x] The name of my PR follows [gitmoji](https://gitmoji.dev/)
specification
- [x] My PR references one of several related issues (if any)
- [x] New features or breaking changes must come with an associated
Issue or Discussion
- [x] My PR does not add any new dependency without an associated Issue
or Discussion
- [x] My PR includes bumps details, please run `yarn bump` and flag the
impacts properly
- [x] My PR adds relevant tests and they would have failed without my PR
(when applicable)

<!-- More about contributing at
https://github.com/dubzzz/fast-check/blob/main/CONTRIBUTING.md -->

**Advanced**

<!-- How to fill the advanced section is detailed below! -->

- [x] Category: 💥 Breaking change
- [x] Impacts: Dropped arbitraries

<!-- [Category] Please use one of the categories below, it will help us
into better understanding the urgency of the PR -->
<!-- * ✨ Introduce new features -->
<!-- * 📝 Add or update documentation -->
<!-- * ✅ Add or update tests -->
<!-- * 🐛 Fix a bug -->
<!-- * 🏷️ Add or update types -->
<!-- * ⚡️ Improve performance -->
<!-- * _Other(s):_ ... -->

<!-- [Impacts] Please provide a comma separated list of the potential
impacts that might be introduced by this change -->
<!-- * Generated values: Can your change impact any of the existing
generators in terms of generated values, if so which ones? when? -->
<!-- * Shrink values: Can your change impact any of the existing
generators in terms of shrink values, if so which ones? when? -->
<!-- * Performance: Can it require some typings changes on user side?
Please give more details -->
<!-- * Typings: Is there a potential performance impact? In which cases?
-->
doc

Verified

This commit was signed with the committer’s verified signature.
etrepum Bob Ippolito
Copy link

changeset-bot bot commented Feb 5, 2025

⚠️ No Changeset found

Latest commit: 10bf58f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

doc
Copy link

pkg-pr-new bot commented Feb 5, 2025

Open in Stackblitz@fast-check/examples

@fast-check/ava

npm i https://pkg.pr.new/@fast-check/ava@5664

@fast-check/expect-type

npm i https://pkg.pr.new/@fast-check/expect-type@5664

fast-check

npm i https://pkg.pr.new/fast-check@5664

@fast-check/jest

npm i https://pkg.pr.new/@fast-check/jest@5664

@fast-check/packaged

npm i https://pkg.pr.new/@fast-check/packaged@5664

@fast-check/poisoning

npm i https://pkg.pr.new/@fast-check/poisoning@5664

@fast-check/vitest

npm i https://pkg.pr.new/@fast-check/vitest@5664

@fast-check/worker

npm i https://pkg.pr.new/@fast-check/worker@5664

commit: 10bf58f

Copy link
Contributor

github-actions bot commented Feb 5, 2025

👋 A preview of the new documentation is available at: http://67a3ebbef0302c28694c700c--dubzzz-fast-check.netlify.app

@dubzzz dubzzz enabled auto-merge (squash) February 5, 2025 22:54
Copy link
Contributor

github-actions bot commented Feb 5, 2025

👋 A preview of the new documentation is available at: http://67a3ecfabc52372d2bb2d14d--dubzzz-fast-check.netlify.app

Copy link

codecov bot commented Feb 5, 2025

Codecov Report

Attention: Patch coverage is 90.00000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 94.77%. Comparing base (525d49b) to head (10bf58f).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
packages/fast-check/src/arbitrary/base64String.ts 90.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5664      +/-   ##
==========================================
- Coverage   94.79%   94.77%   -0.02%     
==========================================
  Files         228      227       -1     
  Lines        9985     9989       +4     
  Branches     2802     2803       +1     
==========================================
+ Hits         9465     9467       +2     
- Misses        520      522       +2     
Flag Coverage Δ
unit-tests 94.77% <90.00%> (-0.02%) ⬇️
unit-tests-18.x-Linux 94.77% <90.00%> (-0.02%) ⬇️
unit-tests-20.x-Linux 94.77% <90.00%> (-0.02%) ⬇️
unit-tests-22.x-Linux 94.77% <90.00%> (-0.02%) ⬇️
unit-tests-latest-Linux 94.77% <90.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dubzzz dubzzz merged commit 386d5dd into main Feb 5, 2025
54 of 56 checks passed
@dubzzz dubzzz deleted the pr-5285 branch February 5, 2025 23:01
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.

None yet

1 participant