🐛🧑‍💻 - Replace deprecated ZSTDgetDecompressedSize with ZSTDgetFrameContentSize

[efraespada]

Is there an existing issue for this?

• I have searched the existing issues.

Which plugins are affected?

Zstandard macOS

Which platforms are affected?

macOS

Description

The plugin uses the deprecated zstd API ZSTD_getDecompressedSize() to obtain the decompressed size before calling ZSTD_decompress(). This function has been removed (or is being removed) in newer environments (e.g. macOS 26+), and the zstd documentation recommends using ZSTD_getFrameContentSize() instead.

Proposed solution

• Replace all usages of ZSTD_getDecompressedSize with ZSTD_getFrameContentSize in the platform implementations (iOS, macOS, Linux, Windows, Android, CLI) and in generated bindings where the API is called from Dart.
• Handle the return values correctly: ZSTD_getFrameContentSize can return ZSTD_CONTENTSIZE_UNKNOWN and ZSTD_CONTENTSIZE_ERROR in addition to the size; the existing fallback (e.g. compressedSize * 20 when size is not usable) should still apply.
• Do not add or vendor another copy of the zstd library; keep using the existing in-repo zstd sources and build setup. The current codebase already provides ZSTD_getFrameContentSize; only the call sites need to be updated.

Scope

• Update Dart/FFI call sites that use ZSTD_getDecompressedSize to use ZSTD_getFrameContentSize and treat unknown/error values appropriately.
• Optionally expose or use the ZSTD_CONTENTSIZE_* constants in bindings if needed for clearer logic.
• No change to the way zstd is integrated (no new copy of zstd in Classes or elsewhere).

References

• PR #102 (same goal; this issue tracks a minimal fix without vendoring another zstd copy).
• zstd API: ZSTD_getFrameContentSize() replaces ZSTD_getDecompressedSize() (see zstd.h in-repo).

Reproducing the issue

Run the macOS sample app.

Flutter Version

3.41.4

Relevant Log Output

Flutter dependencies

Expand Flutter dependencies snippet

Replace this line with the contents of your `flutter pub deps -- --style=compact`.

Additional context and comments

No response

[vypbot]

🐛 Bugfix Actions

1. The issue was assigned to @efraespada (creator).
2. The issue's title was updated from Replace deprecated ZSTD_getDecompressedSize with ZSTD_getFrameContentSize to 🐛🧑‍💻 - Replace deprecated ZSTDgetDecompressedSize with ZSTDgetFrameContentSize.
3. The issue was linked to vypdev and moved to the column Todo.
4. Priority set to P0 in vypdev.
5. The branch develop was used to create bugfix/103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize.
6. Moved issue to In Progress in vypdev.

Reminder

1. Take a coffee break while you work ☕.
2. Check out the branch:

git fetch -v && git checkout bugfix/103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize

3. Commit the needed changes with this prefix:

bugfix-103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize

4. Open a Pull Request from bugfix/103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize to develop. New PR

Debug log

[DEBUG] Setup done. Issue number: 103, isSingleAction: false, isIssue: true, isPullRequest: false, isPush: false
[DEBUG] ✅ No previous runs active. Continuing...
[INFO] Running IssueUseCase for issue #103.
[INFO] 📋 Executing IssueUseCase.
[INFO] 🔐 Executing CheckPermissionsUseCase.
[DEBUG] Ignoring permission checking. Issue state is not 'opened'.
[INFO] 👤 Executing AssignMemberToIssueUseCase.
[DEBUG] #103 needs 1 assignees.
[DEBUG] Assigned Issue creator @efraespada to #103.
[INFO] ✏️ Executing UpdateTitleUseCase.
[DEBUG] Issue title updated to: 🐛🧑‍💻 - Replace deprecated ZSTDgetDecompressedSize with ZSTDgetFrameContentSize
[INFO] 🏷️ Executing UpdateIssueTypeUseCase.
[DEBUG] Setting issue type for issue 103 to Bug
[DEBUG] Creating new issue type "Bug" for organization vypdev...
[DEBUG] Issue Type: Bug
[DEBUG] Issue Type Description: An issue indicating a defect, error, or malfunction that needs to be investigated and fixed.
[DEBUG] Issue Type Color: orange
[DEBUG] Fetched issue ID: I_kwDONFe3187y78MB
[DEBUG] Organization ID: MDEyOk9yZ2FuaXphdGlvbjYzNzA1NDAz
[DEBUG] Organization issue types: [{"id":"IT_kwDOA8wRO84AuWac","name":"Task"},{"id":"IT_kwDOA8wRO84AuWag","name":"Bug"},{"id":"IT_kwDOA8wRO84AuWak","name":"Feature"},{"id":"IT_kwDOA8wRO84Bw9l2","name":"Documentation"},{"id":"IT_kwDOA8wRO84Bw9mw","name":"Question"},{"id":"IT_kwDOA8wRO84Bw9oA","name":"Maintenance"},{"id":"IT_kwDOA8wRO84Bw90_","name":"Release"},{"id":"IT_kwDOA8wRO84Bxfgg","name":"Hotfix"},{"id":"IT_kwDOA8wRO84Bxfgh","name":"Help"}]
[DEBUG] Found existing issue type "Bug" with ID: IT_kwDOA8wRO84AuWag
[DEBUG] Successfully updated issue type to Bug
[INFO] 🔗 Executing LinkIssueProjectUseCase.
[DEBUG] Fetched issue ID: I_kwDONFe3187y78MB
[DEBUG] Linked I_kwDONFe3187y78MB with id PVTI_lADOA8wRO84Ajh7BzgncUk8 to project PVT_kwDOA8wRO84Ajh7B
[DEBUG] Content ID: PVTI_lADOA8wRO84Ajh7BzgncUk8
[DEBUG] Target field: {
  "id": "PVTSSF_lADOA8wRO84Ajh7Bzgb4L2E",
  "name": "Status",
  "options": [
    {
      "id": "f75ad846",
      "name": "Todo"
    },
    {
      "id": "47fc9ee4",
      "name": "In Progress"
    },
    {
      "id": "98236657",
      "name": "Done"
    }
  ]
}
[DEBUG] Target option: {
  "id": "f75ad846",
  "name": "Todo"
}
[DEBUG] Target field ID: PVTSSF_lADOA8wRO84Ajh7Bzgb4L2E
[DEBUG] Target option ID: f75ad846
[INFO] 📏 Executing CheckPriorityIssueSizeUseCase.
[DEBUG] Priority: priority: high
[DEBUG] Github Priority Label: P0
[DEBUG] Content ID: PVTI_lADOA8wRO84Ajh7BzgncUk8
[DEBUG] Target field: {
  "id": "PVTSSF_lADOA8wRO84Ajh7Bzgb4MPQ",
  "name": "Priority",
  "options": [
    {
      "id": "4af6496f",
      "name": "P0"
    },
    {
      "id": "f87877a5",
      "name": "P1"
    },
    {
      "id": "27f99ddc",
      "name": "P2"
    }
  ]
}
[DEBUG] Target option: {
  "id": "4af6496f",
  "name": "P0"
}
[DEBUG] Target field ID: PVTSSF_lADOA8wRO84Ajh7Bzgb4MPQ
[DEBUG] Target option ID: 4af6496f
[INFO] 🌿 Executing PrepareBranchesUseCase.
[DEBUG] Fetching tags and forcing fetch...
[DEBUG] Fetching all remote branches with verbose output...
[DEBUG] Successfully fetched all remote branches.
[DEBUG] Available branches:
[DEBUG] - bugfix/58-web-out-of-memory-when-trying-to-decompress-a-17mb-buffer
[DEBUG] - develop
[DEBUG] - master
[DEBUG] - release/1.3.29
[DEBUG] Branch type: bugfix
[DEBUG] Managing branches
[DEBUG] [
  "bugfix/58-web-out-of-memory-when-trying-to-decompress-a-17mb-buffer",
  "develop",
  "master",
  "release/1.3.29"
]
[DEBUG] Searching for branches related to issue #103...
[DEBUG] ============================================================================================
[DEBUG] Base branch: develop
[DEBUG] New branch: bugfix/103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize
[DEBUG] Creating linked branch bugfix/103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize from develop
[DEBUG] Repository information retrieved: {"target":{"oid":"f2470cea4c58efba4af775fde7747bc503bbd2c7"}}
[DEBUG] Linking branch "bugfix/103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize" (oid: f2470cea4c58efba4af775fde7747bc503bbd2c7) to issue #103
[DEBUG] Linked branch: {"id":"LB_kwDO8u_DAc4AxDNH","ref":{"name":"bugfix/103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize"}}
[INFO] 📜 Executing CommitPrefixBuilderUseCase.
[DEBUG] Commit prefix generated: bugfix-103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize
[INFO] 📥 Executing MoveIssueToInProgressUseCase.
[DEBUG] Content ID: PVTI_lADOA8wRO84Ajh7BzgncUk8
[DEBUG] Target field: {
  "id": "PVTSSF_lADOA8wRO84Ajh7Bzgb4L2E",
  "name": "Status",
  "options": [
    {
      "id": "f75ad846",
      "name": "Todo"
    },
    {
      "id": "47fc9ee4",
      "name": "In Progress"
    },
    {
      "id": "98236657",
      "name": "Done"
    }
  ]
}
[DEBUG] Target option: {
  "id": "47fc9ee4",
  "name": "In Progress"
}
[DEBUG] Target field ID: PVTSSF_lADOA8wRO84Ajh7Bzgb4L2E
[DEBUG] Target option ID: 47fc9ee4
[INFO] 🧹 Executing RemoveNotNeededBranchesUseCase.
[INFO] 🏷️ Executing DeployAddedUseCase.
[INFO] 🏷️ Executing DeployedAddedUseCase.
[INFO] Main run finished. Results: 11, total steps: 6.
[INFO] Publishing result: 11 result(s), 6 step(s), 0 error(s).
[INFO] 📄 Executing PublishResultUseCase.

🚀 Happy coding!

^{Made with ❤️ by vypdev/copilot}

[vypbot]

🐛 Bugfix News

Changes on branch bugfix/103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize:

---

• 9723661 by Efra Espada (@efraespada)

update decompress method to use ZSTD_getFrameContentSize for better handling of decompressed size

---

• 2b8cbe1 by Efra Espada (@efraespada)

docs: enhance README and example documentation for zstandard plugin

- Added comprehensive documentation sections in the main README and example README, including Getting Started, API references, and usage examples.
- Updated the Zstandard class and extension methods with detailed comments and usage examples for better clarity.
- Improved platform-specific README files to include installation instructions, usage examples, and troubleshooting tips for each platform implementation (Android, iOS, Linux, macOS, Windows, web).

---

• 1010c54 by Efra Espada (@efraespada)

chore: enhance CI workflows and documentation for coverage reporting

- Updated GitHub Actions workflows for all platforms to include coverage reporting using Codecov.
- Modified test commands to run with coverage options across Android, iOS, Linux, macOS, Windows, and CLI.
- Added performance characteristics and known limitations sections to platform-specific documentation.
- Enhanced README with new performance and best practices sections.

---

• d951b3b by Efra Espada (@efraespada)

chore: update zstandard plugin configuration and macOS integration

- Added dependency overrides in pubspec.yaml to use local zstandard_macos plugin during development.
- Updated project.pbxproj to correct the Embed Pods Frameworks build phase identifier and enhance script handling.
- Modified zstandard_macos.podspec to refine source file inclusion and improve header search paths for better compatibility.
- Adjusted zstandard_macos.c to streamline the inclusion of the zstd library.

---

• 3d1b10d by Efra Espada (@efraespada)

docs: update building and CI/CD documentation for zstandard plugin

- Clarified the process for updating the zstd source for iOS and macOS, including a new script for syncing.
- Enhanced the workflow section to prevent manual edits to the native zstd C library.
- Added details on regenerating FFI bindings and running the app after updates.
- Updated CI/CD documentation to include new scripts for syncing and regenerating bindings.
- Made minor adjustments to example project configurations for better integration.

---

• 87b3667 by Efra Espada (@efraespada)

docs: update building and CI/CD documentation for zstandard plugin

- Added a new all-in-one script for macOS builds that runs sync, bindings, builds, and tests sequentially.
- Clarified the canonical zstd source location and updated related scripts to reflect the new structure.
- Enhanced instructions for syncing zstd source into iOS and macOS plugin directories.
- Updated CMakeLists.txt files to utilize the new zstd source directory structure.
- Removed outdated files and references related to the previous zstandard_macos/src structure.

---

• 796d991 by Efra Espada (@efraespada)

chore: update documentation and scripts for zstd source management

- Added a new entry to .gitignore for the .zstd_upstream directory.
- Updated building.md to clarify the process for updating the canonical zstd source, including new script commands for easier updates.
- Modified build_macos.sh and sync_zstd_ios_macos.sh scripts to reflect the new update process for zstd source.
- Enhanced zstandard_cli_bindings_generated.dart to correct references to the canonical source location.
- Removed outdated CMakeLists.txt and adjusted Makefile and other build scripts for improved compatibility and clarity.

---

• 63d576a by Efra Espada (@efraespada)

chore: streamline zstd source management and update build scripts

- Updated documentation in building.md to clarify the process for verifying and using the canonical zstd source.
- Modified build scripts for Linux and macOS to directly reference the canonical zstd source, removing unnecessary sync steps.
- Enhanced zstandard_android bindings to correctly reference the new zstd source location.
- Removed outdated CMakeLists.txt and other related files to simplify the project structure and improve compatibility.

---

• 2cd385d by Efra Espada (@efraespada)

chore: sync zstd source for iOS and macOS plugins

- Updated documentation in building.md to clarify the syncing process of zstd into iOS and macOS plugin directories.
- Enhanced sync_zstd_ios_macos.sh script to ensure a clean copy of zstd is available for CocoaPods.
- Added pre_install hooks in example app Podfiles to automate the syncing process before CocoaPods runs.
- Modified podspec files to remove the synced zstd copy after compilation to prevent conflicts and ensure a fresh build environment.

---

• d6bfc4b by Efra Espada (@efraespada)

chore: refine zstd syncing process for iOS and macOS plugins

- Updated documentation to clarify the new script phases for syncing zstd sources in podspec files.
- Removed pre_install hooks from example app Podfiles, as syncing is now handled directly in the podspecs.
- Enhanced sync_zstd_ios_macos.sh to support platform-specific syncing and ensure a clean build environment.
- Adjusted podspec files to include script phases for syncing and removing zstd copies during the build process.

---

• 4b7a7f4 by Efra Espada (@efraespada)

chore: update podspec files for zstd syncing process in iOS and macOS

- Added prepare_command to podspec files to ensure the zstd syncing script is executed at pod install time.
- Clarified comments regarding the syncing process and the removal of synced zstd copies after compilation.
- Enhanced script phases to improve the build process and ensure the latest zstd sources are available during compilation.

---

• 15a17a9 by Efra Espada (@efraespada)

chore: refine zstd syncing process in podspec and example Podfile

- Updated documentation to clarify the execution order of script phases and the necessity of syncing before the first pod install.
- Enhanced the Podfile for the macOS example to ensure Xcode waits for the zstd sync before compiling sources.
- Adjusted the zstandard_macos podspec to set the correct execution position for the sync script, ensuring it runs before header copying.

---

• e18674d by Efra Espada (@efraespada)

chore: simplify zstd syncing in Podfile and podspec

- Removed unnecessary Xcode build phase adjustments from the macOS example Podfile to streamline the zstd syncing process.
- Updated the zstandard_macos podspec to include output file paths for the zstd header, ensuring proper integration during the build process.

---

• 573ad14 by Efra Espada (@efraespada)

chore: update zstd syncing process in podspecs and documentation

- Modified podspec files for iOS and macOS to change the execution position of the "Remove synced zstd" phase to :any, ensuring it runs last and does not delete sources prematurely.
- Updated documentation to reflect the new script phase execution order and clarify the necessity of syncing before the first pod install.
- Enhanced comments in the sync script to explain the updated execution flow for better clarity.

---

• b668a33 by Efra Espada (@efraespada)

chore: enhance zstandard_ios podspec for improved syncing and compatibility

- Added minimum CocoaPods version requirement to support new script phase features.
- Updated script phases to ensure zstd syncing occurs before header copying, improving build reliability.
- Enhanced comments for clarity on the syncing process and execution order.
- Adjusted build settings to ensure proper visibility of zstd C symbols for Dart FFI integration.

---

• 7a93108 by Efra Espada (@efraespada)

chore: update zstandard_ios podspec to include additional public header files

- Added zstd_errors.h to the public header files to ensure proper module build visibility.
- Enhanced comments to clarify the relationship between zstd.h and zstd_errors.h for better understanding during integration.

---

• 4d5db08 by Efra Espada (@efraespada)

chore: remove pre_install hook for zstd syncing in macOS Podfile

- Eliminated the pre_install block that synced zstd sources, as syncing is now managed directly in the podspecs.
- Streamlined the Podfile for better clarity and maintainability.

---

• 272202c by Efra Espada (@efraespada)

chore: remove iOS/macOS zstd symlinks documentation

- Deleted the documentation file outlining the use of symlinks for shared zstd sources in iOS and macOS, as the syncing process is now managed directly in the podspecs.
- This change helps streamline the documentation and reduces redundancy in the project's development resources.

---

• 5ead191 by Efra Espada (@efraespada)

chore: update documentation for zstd syncing in iOS and macOS

- Clarified the syncing process of the zstd C library from the repo root into the iOS and macOS plugin directories, emphasizing the use of podspecs for automation.
- Updated architecture descriptions to reflect the new structure and build process, ensuring accurate guidance for developers.
- Removed outdated references to manual syncing and pre_install hooks, streamlining the documentation for better clarity and maintainability.

---

⚠️ Attention

One or more commits didn't start with the prefix bugfix-103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize.

bugfix-103-replace-deprecated-zstdgetdecompressedsize-with-zstdgetframecontentsize: created hello-world app

---

^{Made with ❤️ by vypdev/copilot}

[vypbot]

ZSTD_getFrameContentSize binding uses int return type for 64-bit unsigned value

Severity: high

Location: zstandard_android_bindings_generated.dart:117

The Dart binding ZSTD_getFrameContentSize maps an UnsignedLongLong (64-bit unsigned) native return to a Dart int (signed). This risks incorrect interpretation of sentinel values used to signal unknown/error (ZSTD_CONTENTSIZE_UNKNOWN, ZSTD_CONTENTSIZE_ERROR) and potential overflow on platforms where a 64-bit unsigned value cannot be represented as a signed int.
Suggested fix:
Bind ZSTD_getFrameContentSize as a 64-bit unsigned (Uint64) in Dart or provide a wrapper that translates sentinel values to safe Dart representations, and ensure downstream code checks for ZSTD_CONTENTSIZE_UNKNOWN / ZSTD_CONTENTSIZE_ERROR correctly.

^{Written by vypdev/copilot for commit 5ead191bfcdcd8e7f053b2f9fe9987c5bdaa0193. This will update automatically on new commits.}