Fdc3 for web impl commonjs #1452

robmoffat · 2024-11-28T16:54:34Z

This is to complete #1297 and address #1351, adds rollup to the fdc3 package so that common-js is still supported.

Since I know CJS is used in node, I ran the following:

var fdc3CJS= require('@kite9/fdc3-commonjs')

console.log("Got FDC3", fdc3CJS)

From within the fdc3-for-web/demo process and got back:

Got FDC3 {
  AgentError: {
    AgentNotFound: 'AgentNotFound',
    AccessDenied: 'AccessDenied',
    ErrorOnConnect: 'ErrorOnConnect',
    InvalidFailover: 'InvalidFailover'
  },
  OpenError: {
    AppNotFound: 'AppNotFound',
    ErrorOnLaunch: 'ErrorOnLaunch',
...
  Convert: [class Convert],
  addContextListener: [Function: addContextListener],
  addEventListener: [Function: addEventListener],
  addIntentListener: [Function: addIntentListener],
  broadcast: [Function: broadcast],
  compareVersionNumbers: [Function: compareVersionNumbers],
  createPrivateChannel: [Function: createPrivateChannel],
  fdc3Ready: [Function: fdc3Ready],
  findInstances: [Function: findInstances],
  findIntent: [Function: findIntent],
  findIntentsByContext: [Function: findIntentsByContext],
  getAgent: [Function: getAgent],
  getAppMetadata: [Function: getAppMetadata],
  getCurrentChannel: [Function: getCurrentChannel],
  getInfo: [Function: getInfo],
  getOrCreateChannel: [Function: getOrCreateChannel],
  getSystemChannels: [Function: getSystemChannels],
  getUserChannels: [Function: getUserChannels],
  isStandardContextType: [Function: isStandardContextType],
  isStandardIntent: [Function: isStandardIntent],
  joinChannel: [Function: joinChannel],
  joinUserChannel: [Function: joinUserChannel],
  leaveCurrentChannel: [Function: leaveCurrentChannel],
  open: [Function: open],
  raiseIntent: [Function: raiseIntent],
  raiseIntentForContext: [Function: raiseIntentForContext],
  versionIsAtLeast: [Function: versionIsAtLeast]
}

Which looks ok to me? Obviously, I can't call getAgent, so not sure how further to test this.

Nb, this is very much simplified from the original rollup.config.js (preserved in the packages/fdc3/old dir) but I think a lot of the assumptions of that are not necessarily relevant anymore, perhaps?

netlify · 2024-11-28T16:54:50Z

✅ Deploy Preview for fdc3 ready!

Name	Link
🔨 Latest commit	`74f383b`
🔍 Latest deploy log	https://app.netlify.com/sites/fdc3/deploys/6748a04dde422900086315e9
😎 Deploy Preview	https://deploy-preview-1452--fdc3.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2024-11-28T16:57:44Z

Coverage Report

Commit: d9529a9
Base: fdc3-for-web-impl@c459f07

Type	Base	This PR
Total Statements Coverage	?	95.92% (?)
Total Branches Coverage	?	81.72% (?)
Total Functions Coverage	?	97.36% (?)
Total Lines Coverage	?	95.99% (?)

Details (changed files)

File	Statements	Branches	Functions	Lines
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts	95.33%	84.26%	100%	95.1%

Details (all files)

File	Statements	Branches	Functions	Lines
packages/fdc3-agent-proxy/src/BasicDesktopAgent.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/index.ts	100%	100%	71.42%	100%
packages/fdc3-agent-proxy/src/apps/DefaultAppSupport.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/channels/DefaultChannel.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts	94.64%	75%	93.33%	94.33%
packages/fdc3-agent-proxy/src/channels/DefaultPrivateChannel.ts	97.05%	75%	100%	97.05%
packages/fdc3-agent-proxy/src/handshake/DefaultHandshakeSupport.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/intents/DefaultIntentResolution.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/listeners/AbstractListener.ts	94.44%	83.33%	100%	94.44%
packages/fdc3-agent-proxy/src/listeners/DefaultContextListener.ts	100%	92.3%	100%	100%
packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts	100%	80%	100%	100%
packages/fdc3-agent-proxy/src/listeners/EventListener.ts	90%	50%	80%	90%
packages/fdc3-agent-proxy/src/listeners/HeartbeatListener.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/listeners/PrivateChannelEventListener.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/messaging/AbstractMessaging.ts	92.3%	78.94%	93.75%	92.15%
packages/fdc3-get-agent/src/Fdc3Version.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/index.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/messaging/AbstractWebMessaging.ts	100%	66.66%	100%	100%
packages/fdc3-get-agent/src/messaging/MessagePortMessaging.ts	95%	75%	100%	95%
packages/fdc3-get-agent/src/messaging/message-port.ts	96.29%	92.85%	100%	96.29%
packages/fdc3-get-agent/src/strategies/ElectronEventLoader.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts	98.27%	70%	100%	98.24%
packages/fdc3-get-agent/src/strategies/TimeoutLoader.ts	100%	85.71%	100%	100%
packages/fdc3-get-agent/src/strategies/getAgent.ts	92.68%	76.92%	91.66%	92.1%
packages/fdc3-get-agent/src/ui/AbstractUIComponent.ts	100%	83.33%	100%	100%
packages/fdc3-get-agent/src/ui/DefaultDesktopAgentChannelSelector.ts	100%	66.66%	100%	100%
packages/fdc3-get-agent/src/ui/DefaultDesktopAgentIntentResolver.ts	100%	75%	100%	100%
packages/fdc3-get-agent/src/ui/NullChannelSelector.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/ui/NullIntentResolver.ts	100%	100%	66.66%	100%
packages/fdc3-standard/src/index.ts	100%	100%	0%	100%
packages/fdc3-standard/src/api/Errors.ts	100%	100%	100%	100%
packages/fdc3-standard/src/api/GetAgent.ts	100%	100%	100%	100%
packages/fdc3-standard/src/api/Methods.ts	94.04%	84.05%	96.29%	95%
packages/fdc3-standard/src/api/RecommendedChannels.ts	100%	100%	100%	100%
packages/fdc3-standard/src/context/ContextType.ts	100%	100%	100%	100%
packages/fdc3-standard/src/intents/Intents.ts	100%	100%	100%	100%
packages/fdc3-standard/src/internal/contextConfiguration.ts	100%	100%	100%	100%
packages/fdc3-standard/src/internal/intentConfiguration.ts	100%	100%	100%	100%
packages/fdc3-standard/src/internal/typeHelpers.ts	100%	100%	100%	100%
toolbox/fdc3-for-web/fdc3-web-impl/src/BasicFDC3Server.ts	100%	100%	100%	100%
toolbox/fdc3-for-web/fdc3-web-impl/src/ServerContext.ts	100%	100%	100%	100%
toolbox/fdc3-for-web/fdc3-web-impl/src/directory/BasicDirectory.ts	96.77%	84.21%	100%	96.42%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts	95.33%	84.26%	100%	95.1%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/HeartbeatHandler.ts	82.35%	64.86%	92.85%	84%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts	90.81%	72.6%	98.18%	90.24%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/OpenHandler.ts	96.77%	79.48%	100%	96.77%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/support.ts	100%	100%	100%	100%

github-actions · 2024-11-28T16:57:49Z

github-actions · 2024-11-28T17:05:31Z

kriswest · 2024-11-28T17:06:21Z

The old config built two sets of files into the module, which consumers could switch between by setting a NODE_ENV variable, which this config won't produce. I'm no export on these config, but it also looks like you are only producing common.js files, and in their development form (all comments etc. retained as terser is not used to dtrip them out).

github-actions · 2024-11-28T17:06:51Z

robmoffat · 2024-11-28T17:14:14Z

HI @kriswest,

Yes that's right. The main difference between the two versions being that the production one was minified using terser.

Based on @thorsent's feedback about this, it seems like the use case for CJS is automated tests on very legacy versions of node. Given that, it seemed best that we provide the un-minified version by default so at least people can figure out where their tests are going wrong.

kriswest · 2024-11-28T17:19:54Z

One of the participating teams fed back that they were still using CommonJS in builds.

The advantage of having both types in the module is that, based on whether you are doing a dev or prod build, it includes the relevant version. If you then bundle and treeshake your own app you app code only then includes the version you use, so prod builds are leaner, while dev builds are unminimized, including comments, maps etc.. I have no idea if an app can do that minification itself if we don't.

At least thats my (limited) understanding. @julianna-ciq probably understands it better?

robmoffat · 2024-11-28T17:34:13Z

Do we actually know who is using CJS? It might be simpler to just ask that one person! I have a feeling this is super-niche and not worth spending a lot of time on, but at the same time it'd be nice not to give that one person a headache.

kriswest · 2024-11-28T17:37:47Z

@Roaders commented in a meeting - however, we don't know every app and team thats consuming the FDC3 npm module. Its gets around 8k downloads a week from NPM...

robmoffat · 2024-11-29T09:21:03Z

The reason it's so different is that basically I had to start over and read the rollup docs on how to do this - the original script (preserved) didn't work out-of-the-box.

As I looked into it, it seemed like a lot of the original rollup config probably wasn't relevant to what we were doing anymore. For example, it referenced react, but we don't have any react in the fdc3 module.

So it's tricky. We could spend effort trying to preserve the NODE_ENV stuff if that's what you want? But (going by @thorsent's notes) it seems like an odd thing to have in there just to reduce the size of a download for the node environment, especially given the node environment is going to be pulling in the entire dependency into it's node_modules: effectively having a minified version is just going to increase the size of the download!

kriswest · 2024-11-29T10:51:34Z

The react reference is only a minor part of that config (a couple of lines), the majority is related to preparing the variations on the module. I'm not convinced its producing both CommonJs and ES6 versions now. Also, the goal is not to reduce the module size downloaded by NPM, but rather the output bundle size of a project consuming the module. The module is going to increase in size with 2.2 and the loss of a minified version to pull in may exacerbate that increase in size for downstream projects.

I think we need to understand the impact of changes to the module, before releasing a version with those changes.

kriswest · 2024-11-29T11:05:23Z

The react part of the config is probably inherited from tsdx's rollup config, as that is what was originally used to build the module (and also where the dev/prod build setup comes from).

robmoffat · 2024-12-10T11:14:45Z

@kriswest did this get raised in the SWG meeting last week at all?

kriswest · 2024-12-10T13:14:44Z

I mentioned it, few opinions were offered and no conclusion drawn unfortunately

robmoffat · 2024-12-10T13:52:36Z

Shall I close this then?

github-actions · 2024-12-16T13:33:14Z

packages/fdc3/rollup.config.mjs

kriswest · 2024-12-16T15:09:07Z

Shall I close this then?

Sorry to clarify my previous response: I mentioned the idea to publish two modules, ES6 and CommonJS, allowing for a simple resolution for anyone's build that gets broken by switching to ES6 only and there were no objections. I think @novavi liked the idea of being able to track usage and retire the CommonJs module when its not in use.

Hence, I think we should proceed as we've discussed offline @robmoffat, and it looks like you are on your way there already.

github-actions · 2024-12-16T15:24:47Z

robmoffat · 2024-12-16T15:26:17Z

yeah think this is done as discussed. WDYT?

kriswest

Needs a changelog adding (for the siwtch to searpate ES6 and commonJS modules).

Also, these packages will (I assume!) publish with the readme file from each package. fdc3-commonjs is lacking a Readme file currently as is fdc3, see https://www.npmjs.com/package/@kite9/fdc3 for what that looks like.

In the past the NPM package has inherited the repositoy's README file, which is not ideal. This is good oppurtunity to develop something more relevant, including content for both App and Desktop Agent developers as very basic getting started content. Each readme should also include an early reference to the other package and an explanation of which to use.

README.md

github-actions · 2024-12-16T15:45:41Z

Co-authored-by: Kris West <kris.west@interop.io>

github-actions · 2024-12-17T08:42:12Z

github-actions · 2024-12-17T08:57:14Z

github-actions · 2024-12-17T08:59:12Z

kriswest

LGTM

packages/fdc3-commonjs/README.md

packages/fdc3/README.md

Co-authored-by: Kris West <kris.west@interop.io>

github-actions · 2024-12-18T15:20:11Z

github-actions · 2024-12-18T15:20:17Z

github-actions · 2024-12-18T15:20:29Z

github-actions · 2024-12-18T15:20:53Z

Added legacy CJS support fdc3 package

74f383b

robmoffat requested a review from a team as a code owner November 28, 2024 16:54

kriswest changed the base branch from main to fdc3-for-web-impl November 28, 2024 16:59

robmoffat requested review from thorsent, Lecss and kriswest November 28, 2024 16:59

robmoffat added 2 commits November 28, 2024 17:02

removed command line args, added to script

0098d48

removed comments

b00d208

This was linked to issues Nov 28, 2024

FDC3 monorepo #1297

Open

CommonJs vs ES6 #1351

Open

robmoffat assigned Roaders Dec 3, 2024

kriswest mentioned this pull request Dec 5, 2024

Standard WG Meeting - December 5th, 2024 #1458

Open

11 tasks

robmoffat added 2 commits December 16, 2024 13:28

Merge branch 'fdc3-for-web-impl' into fdc3-for-web-impl-commonjs

fb83447

build complete

2785128

kriswest reviewed Dec 16, 2024

View reviewed changes

packages/fdc3/rollup.config.mjs Outdated Show resolved Hide resolved

Added commonjs as a separate module

edcb439

Updated package lock

e0de6a7

kriswest requested changes Dec 16, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

66c0091

Co-authored-by: Kris West <kris.west@interop.io>

robmoffat added 2 commits December 17, 2024 08:53

Added module readmes

dd72cfa

added changelog

96025eb

kriswest approved these changes Dec 18, 2024

View reviewed changes

kriswest reviewed Dec 18, 2024

View reviewed changes

packages/fdc3-commonjs/README.md Show resolved Hide resolved

kriswest reviewed Dec 18, 2024

View reviewed changes

packages/fdc3-commonjs/README.md Outdated Show resolved Hide resolved

kriswest reviewed Dec 18, 2024

View reviewed changes

packages/fdc3/README.md Outdated Show resolved Hide resolved

kriswest reviewed Dec 18, 2024

View reviewed changes

packages/fdc3/README.md Outdated Show resolved Hide resolved

robmoffat and others added 4 commits December 18, 2024 15:16

Update packages/fdc3/README.md

4b21e9f

Co-authored-by: Kris West <kris.west@interop.io>

Update packages/fdc3/README.md

6221b61

Co-authored-by: Kris West <kris.west@interop.io>

Update packages/fdc3-commonjs/README.md

1d22686

Co-authored-by: Kris West <kris.west@interop.io>

Update packages/fdc3-commonjs/README.md

d9529a9

Co-authored-by: Kris West <kris.west@interop.io>

kriswest mentioned this pull request Dec 18, 2024

FDC3 for Web Browsers Discussion group 19th December 2024 #1478

Open

7 tasks

robmoffat merged commit 2f5429a into fdc3-for-web-impl Dec 18, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fdc3 for web impl commonjs #1452

Fdc3 for web impl commonjs #1452

robmoffat commented Nov 28, 2024 •

edited

Loading

netlify bot commented Nov 28, 2024 •

edited

Loading

github-actions bot commented Nov 28, 2024 •

edited

Loading

github-actions bot commented Nov 28, 2024

github-actions bot commented Nov 28, 2024

kriswest commented Nov 28, 2024

github-actions bot commented Nov 28, 2024

robmoffat commented Nov 28, 2024 •

edited

Loading

kriswest commented Nov 28, 2024

robmoffat commented Nov 28, 2024

kriswest commented Nov 28, 2024

robmoffat commented Nov 29, 2024 •

edited

Loading

kriswest commented Nov 29, 2024

kriswest commented Nov 29, 2024

robmoffat commented Dec 10, 2024

kriswest commented Dec 10, 2024

robmoffat commented Dec 10, 2024

github-actions bot commented Dec 16, 2024

kriswest commented Dec 16, 2024

github-actions bot commented Dec 16, 2024

robmoffat commented Dec 16, 2024

kriswest left a comment

github-actions bot commented Dec 16, 2024

github-actions bot commented Dec 17, 2024

github-actions bot commented Dec 17, 2024

github-actions bot commented Dec 17, 2024

kriswest left a comment

github-actions bot commented Dec 18, 2024

github-actions bot commented Dec 18, 2024

github-actions bot commented Dec 18, 2024

github-actions bot commented Dec 18, 2024

Fdc3 for web impl commonjs #1452

Fdc3 for web impl commonjs #1452

Conversation

robmoffat commented Nov 28, 2024 • edited Loading

netlify bot commented Nov 28, 2024 • edited Loading

✅ Deploy Preview for fdc3 ready!

github-actions bot commented Nov 28, 2024 • edited Loading

Coverage Report

github-actions bot commented Nov 28, 2024

github-actions bot commented Nov 28, 2024

kriswest commented Nov 28, 2024

github-actions bot commented Nov 28, 2024

robmoffat commented Nov 28, 2024 • edited Loading

kriswest commented Nov 28, 2024

robmoffat commented Nov 28, 2024

kriswest commented Nov 28, 2024

robmoffat commented Nov 29, 2024 • edited Loading

kriswest commented Nov 29, 2024

kriswest commented Nov 29, 2024

robmoffat commented Dec 10, 2024

kriswest commented Dec 10, 2024

robmoffat commented Dec 10, 2024

github-actions bot commented Dec 16, 2024

kriswest commented Dec 16, 2024

github-actions bot commented Dec 16, 2024

robmoffat commented Dec 16, 2024

kriswest left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 16, 2024

github-actions bot commented Dec 17, 2024

github-actions bot commented Dec 17, 2024

github-actions bot commented Dec 17, 2024

kriswest left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 18, 2024

github-actions bot commented Dec 18, 2024

github-actions bot commented Dec 18, 2024

github-actions bot commented Dec 18, 2024

robmoffat commented Nov 28, 2024 •

edited

Loading

netlify bot commented Nov 28, 2024 •

edited

Loading

github-actions bot commented Nov 28, 2024 •

edited

Loading

robmoffat commented Nov 28, 2024 •

edited

Loading

robmoffat commented Nov 29, 2024 •

edited

Loading