temporalio / temporalio/samples-typescript

[Feature Request] Add sample for using `Buffer` polyfills

Open
#280 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
465
Forks
148
Avg merge
1d 10h
Merged PRs (30d)
11

Description

Describe the solution you'd like

Add a sample that demonstrate how to add support for using the Buffer class from sandboxed code, by loading an appropriate polyfill through a custom Webpack configuration.

Context

Some users have expressed their need for using the Buffer class in code that runs inside the Workflow sandbox. After discussion, however, our team has determined that it's preferable not to provide out-of-the-box support for that module, since that goes against some of our mid-term and long-term objectives, notably regarding the possibly of supporting other JavaScript runtimes (eg. Deno, browser, etc). Users may easily work around missing APIs by loading appropriate polyfills from their Webpack bundler.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing TypeScript samples and the custom Webpack configuration used for sandboxed Workflow code. Add a sample showing how to load a Buffer polyfill through that configuration and use Buffer from sandboxed code; done means the sample clearly demonstrates the workaround.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, webpack
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.