mapbox / mapbox/node-or-tools

Build Debug Bindings for NPM

Open
#24 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C++
Stars
155
Forks
47
PR merge metrics
No merged PRs in 30d

Description

In https://github.com/mapbox/node-or-tools/pull/23 we switched to statically linking against upstream `libortools.a` and more importantly strip out debug symbols [here](https://github.com/mapbox/node-or-tools/blob/v1.0.3/scripts/install-deps.sh#L32-L34). What we should do is build debug binaries for npm which link against `libortools.a` with debug symbols _not_ stripped out.

Tasks:
- Create Travis builds for debug binaries which do not strip out debug symbols
- Publish debug binaries passing `--debug` to `node-pre-gyp`
- Make a new release https://github.com/mapbox/node-or-tools#releases
- Check s3 to see if debug binaries are there

cc @karenzshea

Contributor guide

Open the contributing guide

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 with scripts/install-deps.sh, especially the linked lines that strip debug symbols, and inspect the existing Travis build configuration. Trace how node-pre-gyp packages the current binaries, then determine how a --debug build would be published and released. Done means debug binaries are built without stripped symbols, published, included in a new release, and visible in S3.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, node.js
Domain
build-system, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.