README.md

Graphistry for PowerBI

Bundle

1. Update pbiviz.json's displayName with the intended version number

2. Run:

./dc.sh build pbi
./bin/package.sh

Creates dist/

Develop

Generate certs for pbi

• Run initial steps at https://docs.microsoft.com/en-us/power-bi/developer/visuals/create-ssl-certificate

• Subsequent steps automated by ./gen_certs.sh (check for deltas against above link if old)

=> puts certs into node_modules/powerbi-visuals-tools/certs so docker volumes can mount them

Regenerate package lock

In host: npm i --package-lock-only (Windows may need npm i --package-lock-only --legacy-peer-deps)

(TODO: as docker cmd)

GraphistryJS

Switch dependency in package.json: file:/some-folder/graphistry-js/projects/client-api-react (or npm link)

Prettier transform

In host (else have to volume mount src/):

npm i
npm run prettier

And to apply:

npm run prettier:fix

Setting Up Development Environment

Create host certs for https://localhost:8080 needed for https://app.powerbi.com/ live testing:

./bootstrap_host.dev.sh

MS docs: Install a certificate

Create PowerBI dev account:

• https://powerbi.microsoft.com/en-us/ -> start free
• pbi online account -> settings -> developers -> enable developer mode
• in a report (ex: HR), add a Developer visuals
• it will show a greyed component with "Can't contact visual server"

Versions

Version numbers are automatically taken from the latest git tag, and sometimes with suffix -dev.

Use environment variables to override how it is used for base docker images and/or published package versions. Read scripts to see which are used and how.

Publish

• Update CHANGELOG.md with intended version number
• Merge your PR and ensure CI passes
• From main branch:

git tag X.Y.Z
git push --tags

This will create a new tag and release: https://github.com/graphistry/graphbi/releases

OS X

• The keygen stuff might do funny keychain stuff
  • keychain: search for 'localhost' and allow all
  • may not still work in chrome, but maybe in firefox
  • or a reboot
• If ./dc.dev.sh up fails with Error response from daemon: invalid mount config for type "bind": bind source path does not exist: /usr/local/lib/node_modules/powerbi-visuals-tools/certs
  • In docker -> preferences -> resources -> file sharing: /usr/local/lib/node_modules
  • ... or wherever npm list -g --silent | head -1 goes

Build, launch, and live-edit

./dc.dev.sh build  # docker compose -f docker-compose.dev.yml build
./dc.dev.sh up     # docker compose -f docker-compose.dev.yml up

or

NODE_ENV=development ./node_modules/.bin/pbiviz start

TLS-protected URL https://localhost:8080/assets/status should now work

• Go to report: https://app.powerbi.com/groups/me/reports/ce302f22-d702-4419-af92-ea4a8888722f/ReportSection2
• Edit (opens visual components panel)
• Add "Developer Visual" component (icon </>)

The component should now be connected