Prebid core & PBS adapter: Feature tags and optional compilation of native support #8219

dgirardi · 2022-03-25T17:18:02Z

Type of change

Feature
Does this change affect user-facing APIs or examples documented on http://prebid.org?

Description of change

This adds feature flags that can remove portions of the codebase at build time (see #7867).

The first (and only) flag defined here is "NATIVE", which is the easiest (and smallest) to manage; only core and PBS are included - with the expectation that adapters will over time mark their feature-specific code as is done here.

This is the effect on the bundle size:

demetrio@pbws:~/src/Prebid.js$ gulp build-bundle-prod --modules=prebidServerBidAdapter > /dev/null 2>&1 && ls -l build/dist/prebid.js
-rw-rw-r-- 1 demetrio demetrio 176791 Jan 27 11:21 build/dist/prebid.js
demetrio@pbws:~/src/Prebid.js$ gulp build-bundle-prod --modules=prebidServerBidAdapter --disable=native > /dev/null 2>&1 && ls -l build/dist/prebid.js
-rw-rw-r-- 1 demetrio demetrio 168356 Jan 27 11:21 build/dist/prebid.js

A readable comparison of the output: https://gist.github.com/dgirardi/c506a2aa243125cc2a8bdcfa27e10d7a/revisions

Other information

Testing: the strategy is, for now, to add an additional test run with all features disabled. Once we have more flags defined I intend to revisit this - it will probably be too expensive to run the whole test suite on all feature combinations, but I am optimistic that we can find a good heuristic to identify "relevant" tests and be exhaustive only on those (most tests do not interact with the code being removed).

Compilation: I have decided to use our Babel plugin to resolve feature flags (as opposed to webpack's DefinePlugin or other options like terser arguments). The reason is that it works better for npm consumers: no change is required to keep the build working, and there's no risk of our globals (i.e. FEATURES) clashing with their namespace.

Documentation PR: TBD

…js' / import events from 'events.js' return different objects, which is a problem for stubbing)

…tion mode

patmmccann · 2022-03-25T17:25:04Z

@pm-harshad-mane something to consider for the pubmatic adapter?

snapwich

this is awesome. the PR is a bit out-of-date now and as you stated i think there's still some things to figure out regarding testing but overall i really like this approach of using dead-code elimination as well as using the babel plugin.

really nice

mmoschovas

This looks good. One thing I am noticing while going through this (not to do with this PR but wanted to make mention of it) is that the Object.assign within PBS bid adapter is getting excessively long i.e. 500+ lines of code. We should really think about breaking this up a bit into some smaller functions to reduce complexity and make this more readable.

dgirardi · 2022-06-17T13:05:30Z

@mmoschovas regarding the complexity, your input is welcome in #8562 - but overall I agree :)

patmmccann · 2022-06-17T13:39:24Z

@dgirardi this is released! Very exciting. Lmk when docs avail for review

bretg · 2022-06-22T15:09:41Z

Anyone up for documenting this (awesome) feature so new bid adapters utilize it? Belongs in https://docs.prebid.org/dev-docs/bidder-adaptor.html#supporting-native

dgirardi · 2022-06-22T15:25:06Z

@bretg I'll write some docs.

…ative support (prebid#8219) * Upgrade webpack to 5; gulp build works * Fix karma, except events * Uniform access to events, import * or require (import * from 'events.js' / import events from 'events.js' return different objects, which is a problem for stubbing) * Fix (?) adapters that use `this` inappropriately * Update webpack-bundle-analyzer * Fix warnings * Enable tree shaking * Set webpack mode 'none' (or else tests fail (!)) * Update coreJS version in babelrc - prebid#7943 * Use babel to translate to commonjs only for unit tests; enable production mode * Define feature flags at compile time - starting with just "NATIVE" * Add build-bundle-verbose * Run tests with all features disabled * Fix build-bundle-verbose * Tag native#nativeAdapters * Merge master * Add fsevents as optional dep * Adjust syntax for node 12

shahinrahbariasl · 2022-07-06T16:30:38Z

Hey @dgirardi , these are awesome changes!

One thing I noticed recently is that --watch flag for gulp test no longer works, probably because of it being hardcoded here, so gulp test always exits regardless of the flag. If I change watch: false to true in the above line, I can then use the --watch flag again and debug tests in chrome.

dgirardi · 2022-07-06T16:51:02Z

@shahinrahbariasl how are you running gulp for development? I personally found all options too infuriating to use when I first dove in, so I'm not sure what people use in the wild. I work with gulp serve-and-test --file <spec_file> (watch mode is always on for it).

shahinrahbariasl · 2022-07-06T18:13:52Z

I usually do gulp test --file <path-to-test-file> --watch. The I can go to http://localhost:9876/ and use debugger in tests. I can try the above too.

…ative support (prebid#8219) * Upgrade webpack to 5; gulp build works * Fix karma, except events * Uniform access to events, import * or require (import * from 'events.js' / import events from 'events.js' return different objects, which is a problem for stubbing) * Fix (?) adapters that use `this` inappropriately * Update webpack-bundle-analyzer * Fix warnings * Enable tree shaking * Set webpack mode 'none' (or else tests fail (!)) * Update coreJS version in babelrc - prebid#7943 * Use babel to translate to commonjs only for unit tests; enable production mode * Define feature flags at compile time - starting with just "NATIVE" * Add build-bundle-verbose * Run tests with all features disabled * Fix build-bundle-verbose * Tag native#nativeAdapters * Merge master * Add fsevents as optional dep * Adjust syntax for node 12

muuki88 · 2022-08-01T18:42:26Z

We use an webpack build with prebid as a NPM dependency. This change breaks our js bundle at runtime with

secureCreatives.js:25 Uncaught ReferenceError: FEATURES is not defined
    at ./node_modules/prebid.js/src/secureCreatives.js (secureCreatives.js:25:1)
    at __webpack_require__ (bootstrap:19:1)
    at ./node_modules/prebid.js/src/prebid.js (polyfill.js:18:2)
    at __webpack_require__ (bootstrap:19:1)
    at make namespace object:7:1
    at moli.mjs:41251:3
    at moli.mjs:41253:12

As the FEATURE variable comes out of thin air :P

wissamabyad · 2022-11-14T19:00:30Z

We're running into the same issue, and can't upgrade beyond version 7.1, and the error is still not handled in 7.25.

secureCreatives.js?4527:24 Uncaught (in promise) ReferenceError: FEATURES is not defined
    at eval (secureCreatives.js?4527:24:1)
    at ../../node_modules/prebid.js/src/secureCreatives.js (prebid.js:413:1)
    at __webpack_require__ (main.js:1349:42)
    at eval (prebid.js:12:78)
    at ../../node_modules/prebid.js/src/prebid.js (prebid.js:389:1)
    at __webpack_require__ (main.js:1349:42)
    at eval (library.ts:5:67)
    at ../../lib/advertising/Prebid/library.ts (prebid.js:23:1)
    at Function.__webpack_require__ (main.js:1349:42)

dgirardi · 2022-11-14T19:03:06Z

@wissamabyad, are you passing prebid sources through our babel configuration as in the README?

dgirardi added 25 commits January 12, 2022 10:38

Upgrade webpack to 5; gulp build works

d1dc13d

Fix karma, except events

fbfac81

Uniform access to events, import * or require (import * from 'events.…

1943cc7

…js' / import events from 'events.js' return different objects, which is a problem for stubbing)

Fix (?) adapters that use this inappropriately

5caa247

Update webpack-bundle-analyzer

086c753

Fix warnings

688cc68

Enable tree shaking

8efd09a

Set webpack mode 'none' (or else tests fail (!))

b89d5b3

Merge branch 'master' into upgrade-webpack

e6672b9

Update coreJS version in babelrc - prebid#7943

5d26111

Use babel to translate to commonjs only for unit tests; enable produc…

19c6286

…tion mode

Define feature flags at compile time - starting with just "NATIVE"

9f27fe8

Add build-bundle-verbose

913b547

Run tests with all features disabled

c3d65cd

Fix build-bundle-verbose

cba2ec0

Tag native#nativeAdapters

34ff7ac

Merge branch 'master' into upgrade-webpack

841311a

Merge master

062e6bb

Merge branch 'master' into upgrade-webpack

57dbb74

Add fsevents as optional dep

22a7b0c

Merge branch 'master' into upgrade-webpack

9f42bea

Merge branch 'master' into upgrade-webpack

a9e2088

Merge branch 'upgrade-webpack' into feature-tags

d270b6f

Merge branch 'master' into feature-tags

504cb10

Merge branch 'master' into feature-tags

1c4dc4e

dgirardi added the feature label Mar 25, 2022

dgirardi mentioned this pull request Mar 25, 2022

Prebid core & PBS adapter: POC - feature tags and optional compilation of native support #7978

Closed

2 tasks

ChrisHuie requested a review from osazos March 25, 2022 17:21

ChrisHuie assigned osazos Mar 25, 2022

ChrisHuie requested a review from robertrmartinez April 6, 2022 16:45

ChrisHuie assigned robertrmartinez Apr 6, 2022

ChrisHuie self-requested a review April 6, 2022 16:46

ChrisHuie self-assigned this Apr 6, 2022

snapwich self-assigned this Apr 27, 2022

snapwich approved these changes May 16, 2022

View reviewed changes

patmmccann requested a review from pm-harshad-mane June 16, 2022 15:27

patmmccann assigned pm-harshad-mane Jun 16, 2022

dgirardi added 2 commits June 16, 2022 10:23

Merge branch 'master' into feature-tags

80813f2

Adjust syntax for node 12

d557978

mmoschovas approved these changes Jun 17, 2022

View reviewed changes

patmmccann merged commit 5b4987d into prebid:master Jun 17, 2022

jsnellbaker mentioned this pull request Jun 22, 2022

Appnexus Bid Adapter: support native feature flags #8597

Merged

1 task

dgirardi mentioned this pull request Jun 22, 2022

PBJS: document the NATIVE feature flag for bid adapters prebid/prebid.github.io#3862

Merged

2 tasks

muuki88 mentioned this pull request Aug 1, 2022

Build system: adjust babel configuration to reduce bundle size #8732

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prebid core & PBS adapter: Feature tags and optional compilation of native support #8219

Prebid core & PBS adapter: Feature tags and optional compilation of native support #8219

dgirardi commented Mar 25, 2022 •

edited

Loading

patmmccann commented Mar 25, 2022

snapwich left a comment

mmoschovas left a comment

dgirardi commented Jun 17, 2022

patmmccann commented Jun 17, 2022

bretg commented Jun 22, 2022

dgirardi commented Jun 22, 2022

shahinrahbariasl commented Jul 6, 2022

dgirardi commented Jul 6, 2022

shahinrahbariasl commented Jul 6, 2022 •

edited

Loading

muuki88 commented Aug 1, 2022

wissamabyad commented Nov 14, 2022

dgirardi commented Nov 14, 2022

Prebid core & PBS adapter: Feature tags and optional compilation of native support #8219

Prebid core & PBS adapter: Feature tags and optional compilation of native support #8219

Conversation

dgirardi commented Mar 25, 2022 • edited Loading

Type of change

Description of change

Other information

patmmccann commented Mar 25, 2022

snapwich left a comment

Choose a reason for hiding this comment

mmoschovas left a comment

Choose a reason for hiding this comment

dgirardi commented Jun 17, 2022

patmmccann commented Jun 17, 2022

bretg commented Jun 22, 2022

dgirardi commented Jun 22, 2022

shahinrahbariasl commented Jul 6, 2022

dgirardi commented Jul 6, 2022

shahinrahbariasl commented Jul 6, 2022 • edited Loading

muuki88 commented Aug 1, 2022

wissamabyad commented Nov 14, 2022

dgirardi commented Nov 14, 2022

dgirardi commented Mar 25, 2022 •

edited

Loading

shahinrahbariasl commented Jul 6, 2022 •

edited

Loading