feat: Add hashSha256 method for SHA-256 hashing #1116

jaissica12 · 2025-11-17T16:14:09Z

Background

Added hashSha256 method and related helpers to provide SHA-256 hashing functionality for advertisers using the mParticle Web SDK without requiring the Rokt Kit dependency.
Code reference: attribute-service , hash-string, rokt-docs

What Has Changed

Added hashSha256 method
Added unit tests for hashing. Referred the same test cases from sdk-webto compare the hashed values

Screenshots/Video

{Include any screenshots or video demonstrating the new feature or fix, if applicable}

Checklist

I have performed a self-review of my own code.
I have made corresponding changes to the documentation.
I have added tests that prove my fix is effective or that my feature works.
I have tested this locally.

Additional Notes

{Any additional information or context relevant to this PR}

Reference Issue (For employees only. Ignore if you are an outside contributor)

Closes https://go/j/SDKE-452

samdozor · 2025-11-19T18:49:57Z

src/roktManager.ts

+     */
+    public async hashSha256(attribute: string | number | boolean | undefined | null): Promise<string> {
+        if (attribute === undefined || attribute === null) {
+            throw new Error('Value cannot be null or undefined');


i worry this will cause more harm than good in crashing the current loop/thread. our typical pattern would be to log an error or warning.

I would also make the argument that there's nothing wrong with passing a null or undefined into this particular method. The method is able to act on the value passed in - it should just respond with the attribute (which is either null or undefined).

Thanks for the feedback about logging pattern. Updated the code:

For null/undefined inputs: Returns the value as-is with a logger.warning

For hash failures: Returns undefined with a logger.error

I know this was updated already, but as an fyi - returning the null or undefined is fine because the wSDK will automatically sanitize these out when you pass a false-y value to it. I just tested

src/roktManager.ts

…date tests

rmi22186 · 2025-12-02T15:58:43Z

src/roktManager.ts

+            const hashedAttributes: IRoktPartnerAttributes = {};
+
+            for (const key in attributes) {
+                const attributeValue = attributes[key];
+
+                hashedAttributes[key] = attributeValue;
+
+                const hashedValue = await this.hashSha256(attributeValue);
+
+                if (hashedValue) {
+                    hashedAttributes[`${key}sha256`] = hashedValue;
+                }
+            }


This currently hashes the attributes sequentially, but the Rokt wSDK hashes in parallel, which is faster.

Suggested change

const hashedAttributes: IRoktPartnerAttributes = {};

for (const key in attributes) {

const attributeValue = attributes[key];

hashedAttributes[key] = attributeValue;

const hashedValue = await this.hashSha256(attributeValue);

if (hashedValue) {

hashedAttributes[`${key}sha256`] = hashedValue;

}

}

// Get own property keys only

const keys = Object.keys(attributes);

if (keys.length === 0) {

return {};

}

// Hash all attributes in parallel

const hashPromises = keys.map(async (key) => {

const attributeValue = attributes[key];

const hashedValue = await this.hashSha256(attributeValue);

return { key, attributeValue, hashedValue };

});

const results = await Promise.all(hashPromises);

// Build the result object

const hashedAttributes: IRoktPartnerAttributes = {};

for (const { key, attributeValue, hashedValue } of results) {

hashedAttributes[key] = attributeValue;

if (hashedValue) {

hashedAttributes[`${key}sha256`] = hashedValue;

}

}

Thanks for the feedback, updated!

rmi22186 · 2025-12-03T14:03:52Z

src/roktManager.ts

+
        } catch (error) {
-            return Promise.reject(error instanceof Error ? error : new Error('Unknown error occurred'));
+            return Promise.reject(error instanceof Error ? error : new Error('Failed to hash attributes'));


This will throw an error, similar to what you did with hashSha256 before. Can you instead log the error here?

rmi22186 · 2025-12-03T16:58:36Z

src/roktManager.ts

        } catch (error) {
            const errorMessage = error instanceof Error ? error.message : String(error);
-            this.logger.error(`Failed to hash "${attribute}" and returning undefined, selectPlacements will continue: ${errorMessage}`);
+            this.logger.error(`Failed to hash "${attribute}" and returning undefined: ${errorMessage}`);


@mattbodle - What are your thoughts on removing ${attribute} here? One positive is that it would reduce the total distinct logs, but we wouldn't be able to target specific attributes that the partner is using which would help us pinpoint the exact problem. What do you think?

@gtamanaha also^^

actually since this would likely be email based on the test below, I say we remove it since it'd be pii

Should just be Failed to hashSha256, returning undefined: ${errorMessage}

Updated error and warning message to exclude pii

I think having the attribute will be helpful and you can use wildcard to filter DD queries. Example

@gtamanaha - The issue here is that there is potential for this value being email (PII).

rmi22186 · 2025-12-03T17:05:21Z

src/roktManager.ts

        } catch (error) {
-            return Promise.reject(error instanceof Error ? error : new Error('Unknown error occurred'));
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            this.logger.error(`Failed to hash "${attributes}", selectPlacements will continue: ${errorMessage}`);


Should just be Failed to hashAttributes, returning undefined: ${errorMessage}

sonarqubecloud · 2025-12-03T17:23:06Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

jaissica12 added 2 commits November 17, 2025 11:11

feat: Add hashSha256 method for SHA-256 hashing and related test

eae3d27

move hashSha256 method after rokt kit methods for better organization

5708ef0

jaissica12 marked this pull request as ready for review November 17, 2025 16:28

jaissica12 requested a review from rmi22186 November 17, 2025 16:30

jaissica12 mentioned this pull request Nov 17, 2025

feat: add local SHA-256 hashing logic in hashAttributes #1112

Closed

4 tasks

samdozor requested changes Nov 19, 2025

View reviewed changes

jaissica12 added 2 commits November 19, 2025 17:42

add logger warning for null/undefined inputs in hashSha256

1098eee

return undefined instead of throwing when hashSha256 fails

a78419e

jaissica12 requested a review from samdozor November 20, 2025 17:08

rmi22186 reviewed Nov 21, 2025

View reviewed changes

src/roktManager.ts Show resolved Hide resolved

Update hashAttributes to use hashSha256 internally for hashing and up…

8c91a8b

…date tests

jaissica12 requested a review from rmi22186 November 24, 2025 20:35

rmi22186 requested changes Dec 2, 2025

View reviewed changes

parallelize hashAttributes to match Rokt wSDK

4dfbc71

jaissica12 requested a review from rmi22186 December 2, 2025 20:35

rmi22186 reviewed Dec 3, 2025

View reviewed changes

update logger error message for hashAttributes and hashSha256

ccc9f30

rmi22186 reviewed Dec 3, 2025

View reviewed changes

jaissica12 added 2 commits December 3, 2025 12:16

update logger warning and error message to exclude user attributes

fa03a20

remove and from hashSha256 error message and update related test

293e290

jaissica12 requested a review from rmi22186 December 3, 2025 17:22

rmi22186 approved these changes Dec 3, 2025

View reviewed changes

feat: Add hashSha256 method for SHA-256 hashing #1116

Are you sure you want to change the base?

feat: Add hashSha256 method for SHA-256 hashing #1116

Uh oh!

Conversation

jaissica12 commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Background

What Has Changed

Screenshots/Video

Checklist

Additional Notes

Reference Issue (For employees only. Ignore if you are an outside contributor)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jaissica12 Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gtamanaha Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Dec 3, 2025

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jaissica12 commented Nov 17, 2025 •

edited

Loading

jaissica12 Dec 3, 2025 •

edited

Loading

gtamanaha Dec 3, 2025 •

edited

Loading