SDKS-3941: Migrate Protect from Legacy to new Ping SDK #274

ancheetah · 2025-05-07T22:51:41Z

JIRA Ticket

https://pingidentity.atlassian.net/browse/SDKS-3941

Description

Moves Ping Protect module from legacy SDK using functional pattern. Improves JS Doc annotations and unit tests.

No changeset.

changeset-bot · 2025-05-07T22:51:46Z

⚠️ No Changeset found

Latest commit: f3ecb6c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

nx-cloud · 2025-05-07T22:58:37Z

View your CI Pipeline Execution ↗ for commit f3ecb6c.

Command	Status	Duration	Result
`nx affected -t build typecheck lint test e2e-ci`	✅ Succeeded	1m 43s	View ↗
`nx-cloud record -- nx format:check`	✅ Succeeded	2s	View ↗

☁️ Nx Cloud last updated this comment at 2025-05-21 19:49:00 UTC

github-actions · 2025-05-07T23:01:03Z

Deployed f34d851 to https://ForgeRock.github.io/ping-javascript-sdk/pr-274/f34d851c0e15e3adfffb2d7e51203b615c130c46 branch gh-pages in ForgeRock/ping-javascript-sdk

codecov-commenter · 2025-05-07T23:01:14Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.26%. Comparing base (b9867d1) to head (f3ecb6c).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #274   +/-   ##
=======================================
  Coverage   50.26%   50.26%           
=======================================
  Files          29       29           
  Lines        1711     1711           
  Branches      196      195    -1     
=======================================
  Hits          860      860           
  Misses        851      851

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

cerebrl

Looks good to me. I'll let @ryanbas21 be the final arbiter as most of this has to do with the usual scaffolding/infrastructure implementation.

packages/protect/src/lib/protect.ts

packages/protect/package.json

packages/protect/src/lib/protect.ts

packages/protect/src/lib/protect.types.ts

packages/protect/src/lib/protect.ts

ancheetah · 2025-05-08T19:23:04Z

moved loading signals sdk out of protect api. added test for failed signals sdk load.

ryanbas21 · 2025-05-09T14:42:15Z

packages/protect/package.json

+    "url": "git+https://github.com/ForgeRock/ping-javascript-sdk.git",
+    "directory": "packages/protect"
+  },
+  "sideEffects": true,


I may have misled you. What I meant was something like this:

https://github.com/ForgeRock/forgerock-javascript-sdk/blob/develop/packages/ping-protect/package.json#L14

This is my reasoning/thought process so let me know if this tracks with you.

Tree shaking is the process of dead code removal. This is a static process, so bundlers are doing this based on the static code available during the uglification/minify process.

The signals SDK is not a module. It's just like an iiffe that is executed when the script loads. Additionally, it modifies the window with new functions that it uses. These modify the global scope (window) which are side effects.

So we need to tell bundlers that this file is effectful. It can't be removed. We rely on the effects produced by this in other code that.

So here we can use an array to say the files we are asking not be removed.

Another common input in sideEffect arrays would be CSS files (in a glob syntax) because CSS also changes the dom.

Another one would be a polyfill that extends the Array prototype.

Now - truth be told, I'm not sure the code style of factory functions is very tree shakeable to begin with because the bundler can't execute the factory to determine if some of the code is used or not later on. So it must include it.

But I could be wrong, or maybe things advanced and I'm not sure, so its worth including it anyways.

packages/protect/README.md

ryanbas21

Great work!

packages/protect/README.md

packages/protect/src/lib/protect.ts

ancheetah · 2025-05-13T17:52:48Z

@ryanbas21 @cerebrl please review again. Added support for marketplace nodes, updated readme with important note, and changed the module name from createProtect to protect. Also I updated the ProtectInitializeConfig type and it was a little strange to me. Should it just extend from the ProtectConfig type?

packages/protect/src/lib/protect.test.ts

packages/protect/src/lib/protect.ts

cerebrl · 2025-05-15T21:41:53Z

packages/protect/src/lib/protect.types.ts

+export interface ProtectInitializeConfig
+  extends Omit<ProtectConfig, 'envId' | 'waitForWindowLoad' | 'hubUrl' | 'externalIdentifiers'> {
+  _type: 'PingOneProtect';
+  _action: 'protect_initialize';
+  envId?: string;
+  customHost?: string;
+}


Ryan says, "It's fine"

cerebrl

This looks good. I think there's just one correction needed in the README.md file to reflect the name change in the exported function.

cerebrl · 2025-05-16T20:39:37Z

packages/protect/README.md

+The `start` method can be called at application startup, or when you receive the `PingOneProtectInitializeCallback` callback from the server. We recommend you call `start` as soon as you can to collect as much data as possible for higher accuracy.
+
+```js
+import { createProtect } from '@pingidentity/protect';


This import is now just protect, yeah?

ancheetah · 2025-05-17T21:52:58Z

updated readme with new naming for protect module and squashed commits

ryanbas21 · 2025-05-19T14:56:15Z

packages/protect/src/lib/protect.ts

+          return undefined;
+        }
+
+        const protectMetadataCb = cbs.find((metadataCallback) => {


is there any chance that there are no metadata callbacks and this produces undefined?

I don't remember, so maybe i should look into this. I maybe wrote it like this originally.

nevermind I see the check below

ancheetah marked this pull request as draft May 7, 2025 22:53

ancheetah force-pushed the SDKS-3941-ping-protect branch from 6af5770 to 579c6ba Compare May 7, 2025 22:57

ancheetah requested review from ryanbas21 and cerebrl May 7, 2025 23:01

ancheetah force-pushed the SDKS-3941-ping-protect branch from 579c6ba to 6e4b133 Compare May 8, 2025 14:43

ancheetah marked this pull request as ready for review May 8, 2025 14:44

ancheetah force-pushed the SDKS-3941-ping-protect branch from 6e4b133 to 24a1fed Compare May 8, 2025 14:52

cerebrl approved these changes May 8, 2025

View reviewed changes

ancheetah commented May 8, 2025

View reviewed changes

packages/protect/src/lib/protect.ts Outdated Show resolved Hide resolved

ryanbas21 requested changes May 8, 2025

View reviewed changes

packages/protect/package.json Show resolved Hide resolved

packages/protect/src/lib/protect.ts Outdated Show resolved Hide resolved

packages/protect/src/lib/protect.types.ts Outdated Show resolved Hide resolved

packages/protect/src/lib/protect.ts Outdated Show resolved Hide resolved

ancheetah force-pushed the SDKS-3941-ping-protect branch from 24a1fed to 8623e44 Compare May 8, 2025 19:19

ancheetah requested review from ryanbas21 and cerebrl May 8, 2025 19:23

ryanbas21 reviewed May 9, 2025

View reviewed changes

ancheetah marked this pull request as draft May 9, 2025 15:25

ancheetah marked this pull request as ready for review May 9, 2025 16:27

ryanbas21 approved these changes May 12, 2025

View reviewed changes

cerebrl requested changes May 13, 2025

View reviewed changes

packages/protect/README.md Show resolved Hide resolved

packages/protect/src/lib/protect.ts Outdated Show resolved Hide resolved

ancheetah requested review from cerebrl and ryanbas21 May 13, 2025 17:49

cerebrl requested changes May 14, 2025

View reviewed changes

ancheetah force-pushed the SDKS-3941-ping-protect branch from 927f19b to a522e9a Compare May 15, 2025 16:32

cerebrl reviewed May 15, 2025

View reviewed changes

cerebrl approved these changes May 16, 2025

View reviewed changes

ancheetah force-pushed the SDKS-3941-ping-protect branch from b9d2d27 to 86c863d Compare May 17, 2025 21:46

ryanbas21 reviewed May 19, 2025

View reviewed changes

ryanbas21 approved these changes May 19, 2025

View reviewed changes

feat(protect): add protect package

f3ecb6c

ancheetah force-pushed the SDKS-3941-ping-protect branch from 86c863d to f3ecb6c Compare May 21, 2025 19:46

ancheetah merged commit 39c94fc into main May 21, 2025
4 checks passed

ancheetah deleted the SDKS-3941-ping-protect branch May 21, 2025 19:50

SDKS-3941: Migrate Protect from Legacy to new Ping SDK #274

SDKS-3941: Migrate Protect from Legacy to new Ping SDK #274

Uh oh!

Conversation

ancheetah commented May 7, 2025

JIRA Ticket

Description

Uh oh!

changeset-bot bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

nx-cloud bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

cerebrl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ancheetah commented May 8, 2025

Uh oh!

ryanbas21 May 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ryanbas21 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ancheetah commented May 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cerebrl May 15, 2025

Choose a reason for hiding this comment

Uh oh!

cerebrl May 15, 2025

Choose a reason for hiding this comment

Uh oh!

cerebrl left a comment

Choose a reason for hiding this comment

Uh oh!

cerebrl May 16, 2025

Choose a reason for hiding this comment

Uh oh!

ancheetah commented May 17, 2025

Uh oh!

ryanbas21 May 19, 2025

Choose a reason for hiding this comment

Uh oh!

ryanbas21 May 19, 2025

Choose a reason for hiding this comment

Uh oh!

ryanbas21 May 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

changeset-bot bot commented May 7, 2025 •

edited

Loading

nx-cloud bot commented May 7, 2025 •

edited

Loading

github-actions bot commented May 7, 2025 •

edited

Loading

codecov-commenter commented May 7, 2025 •

edited

Loading