fix: Move ready queue processing after identity request #933
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| import { isEmpty, isFunction } from './utils'; | ||
|
|
||
| export const processReadyQueue = (readyQueue): Function[] => { | ||
| if (!isEmpty(readyQueue)) { | ||
| readyQueue.forEach(readyQueueItem => { | ||
| if (isFunction(readyQueueItem)) { | ||
| // debugger; | ||
alexs-mparticle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| readyQueueItem(); | ||
| } else if (Array.isArray(readyQueueItem)) { | ||
| // debugger; | ||
alexs-mparticle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| processPreloadedItem(readyQueueItem); | ||
| } | ||
| }); | ||
| } | ||
| return []; | ||
| }; | ||
|
|
||
| const processPreloadedItem = (readyQueueItem): void => { | ||
| const args = readyQueueItem; | ||
| const method = args.splice(0, 1)[0]; | ||
|
|
||
| // if the first argument is a method on the base mParticle object, run it | ||
| if (typeof window !== 'undefined' && window.mParticle && window.mParticle[args[0]]) { | ||
| window.mParticle[method].apply(this, args); | ||
| // otherwise, the method is on either eCommerce or Identity objects, ie. "eCommerce.setCurrencyCode", "Identity.login" | ||
| } else { | ||
| const methodArray = method.split('.'); | ||
| try { | ||
| let computedMPFunction = window.mParticle; | ||
| for (const currentMethod of methodArray) { | ||
| computedMPFunction = computedMPFunction[currentMethod]; | ||
| } | ||
| ((computedMPFunction as unknown) as Function).apply(this, args); | ||
| } catch (e) { | ||
| throw new Error('Unable to compute proper mParticle function ' + e); | ||
| } | ||
| } | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| import { processReadyQueue } from '../../src/pre-init-utils'; | ||
|
|
||
| describe('pre-init-utils', () => { | ||
| describe('#processReadyQueue', () => { | ||
| it('should return an empty array if readyQueue is empty', () => { | ||
| const result = processReadyQueue([]); | ||
| expect(result).toEqual([]); | ||
| }); | ||
|
|
||
| it('should process functions passed as arguments', () => { | ||
| const functionSpy = jest.fn(); | ||
| const readyQueue: Function[] = [functionSpy, functionSpy, functionSpy]; | ||
| const result = processReadyQueue(readyQueue); | ||
| expect(functionSpy).toHaveBeenCalledTimes(3); | ||
| expect(result).toEqual([]); | ||
| }); | ||
|
|
||
| it('should process functions passed as arrays', () => { | ||
| const functionSpy = jest.fn(); | ||
| (window.mParticle as any) = { | ||
| fakeFunction: functionSpy, | ||
| }; | ||
| const readyQueue = [['fakeFunction']]; | ||
| processReadyQueue(readyQueue); | ||
| expect(functionSpy).toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('should process functions passed as arrays with arguments', () => { | ||
| const functionSpy = jest.fn(); | ||
| (window.mParticle as any) = { | ||
| fakeFunction: functionSpy, | ||
| args: () => {}, | ||
|
There was a problem hiding this comment. Is this There was a problem hiding this comment. I'm open to discussing this further. Adding There was a problem hiding this comment. let's hop on a zoom about this to walk through There was a problem hiding this comment. hm. when i comment out line 32, it passes for me. see screenshot below: |
||
| }; | ||
| const readyQueue = [['fakeFunction', 'args']]; | ||
| processReadyQueue(readyQueue); | ||
| expect(functionSpy).toHaveBeenCalledWith('args'); | ||
| }); | ||
|
|
||
| it('should process arrays passed as arguments with multiple methods', () => { | ||
| const functionSpy = jest.fn(); | ||
| (window.mParticle as any) = { | ||
| fakeFunction: { | ||
| anotherFakeFunction: functionSpy, | ||
| }, | ||
| }; | ||
| const readyQueue = [['fakeFunction.anotherFakeFunction', 'foo']]; | ||
| processReadyQueue(readyQueue); | ||
| expect(functionSpy).toHaveBeenCalledWith('foo'); | ||
| }); | ||
rmi22186 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| it('should throw an error if it cannot compute the proper mParticle function', () => { | ||
| const readyQueue = [['Identity.login']]; | ||
| expect(() => processReadyQueue(readyQueue)).toThrowError("Unable to compute proper mParticle function TypeError: Cannot read properties of undefined (reading 'login')"); | ||
| }); | ||
| }); | ||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Your PR description appropriately states when this is the case, rather than "for some reason", so I'd turn that into a comment.
"Will also continue to clear out the ready queue as part of the initial init flow if an identify request is unnecessary, such as if there is an existing session".