Add an example to search for multi-byte pattern in an array #39479
Conversation
And manipulate the array directly.
github-actions
bot
added
Content:WebExt
|
Preview URLs (comment last updated: 2025-05-29 12:22:08) |
|
After giving this some thought, I'm not sure this page is the right place for this example. I understand the desire to have a concrete example of working with multi-byte sequences, but our in-page code samples tend to be relatively short and easy to parse. I think mdn/webextensions-examples may be a better home for this. While we don't currently have a "cookbook" section, I feel like this might be a good candidate for that type of content. Tagging @rebloor for a second opinion. |
| Array.prototype.indexOfMulti = function (searchElements, fromIndex) { | ||
| let i = this.indexOf(searchElements[0], fromIndex); | ||
| if (searchElements.length === 1 || i === -1) { | ||
| // Not found or no other elements to check | ||
| return i; | ||
| } | ||
|
|
||
| const initial = i; | ||
| for (let j = 1; j < searchElements.length && i < this.length; j++) { | ||
| if (this[++i] !== searchElements[j]) { | ||
| return this.indexOfMulti(searchElements, initial + 1); | ||
| } | ||
| } | ||
|
|
||
| return i === initial + searchElements.length - 1 ? initial : -1; | ||
| }; |
There was a problem hiding this comment.
Modifying built-in prototypes is generally considered an anti-pattern. There's no clear benefit to this approach over using a standalone function.
| Object.defineProperty(Array.prototype, "indexOfMulti", { | ||
| value: function (searchElements, fromIndex) { | ||
| let i = this.indexOf(searchElements[0], fromIndex); | ||
| if (searchElements.length === 1 || i === -1) { | ||
| // Not found or no other elements to check | ||
| return i; | ||
| } | ||
|
|
||
| if (i + searchElements.length > this.length) { | ||
| return -1; | ||
| } | ||
|
|
||
| const initial = i; | ||
| for (let j = 1, l = searchElements.length; j < l; j++) { | ||
| if (this[++i] !== searchElements[j]) { | ||
| return this.indexOfMulti(searchElements, initial + 1); | ||
| } | ||
| } | ||
| return initial; | ||
| }, | ||
| }); |
There was a problem hiding this comment.
Modifying built-in prototypes like this is generally considered an anti-pattern. It would be better to refactor this so indexOfMulti is a standalone function.
| Object.defineProperty(Array.prototype, "indexOfMulti", { | |
| value: function (searchElements, fromIndex) { | |
| let i = this.indexOf(searchElements[0], fromIndex); | |
| if (searchElements.length === 1 || i === -1) { | |
| // Not found or no other elements to check | |
| return i; | |
| } | |
| if (i + searchElements.length > this.length) { | |
| return -1; | |
| } | |
| const initial = i; | |
| for (let j = 1, l = searchElements.length; j < l; j++) { | |
| if (this[++i] !== searchElements[j]) { | |
| return this.indexOfMulti(searchElements, initial + 1); | |
| } | |
| } | |
| return initial; | |
| }, | |
| }); | |
| function indexOfMulti(arr, searchElements, fromIndex) { | |
| let i = arr.indexOf(searchElements[0], fromIndex); | |
| if (searchElements.length === 1 || i === -1) { | |
| // Not found or no other elements to check | |
| return i; | |
| } | |
| if (i + searchElements.length > arr.length) { | |
| return -1; | |
| } | |
| const initial = i; | |
| for (let j = 1, l = searchElements.length; j < l; j++) { | |
| if (arr[++i] !== searchElements[j]) { | |
| return indexOfMulti(arr, searchElements, initial + 1); | |
| } | |
| } | |
| return initial; | |
| } |
There was a problem hiding this comment.
If you'd like to improve this example, I'd suggest revising this function to use the KMP algorithm as this will reduce time spent on partial matches. That change isn't required for this PR, but if you don't want to make that change we should create a tracking issue to improve this in the future.
| filter.ondata = (event) => { | ||
| const buffer = new Uint8Array(event.data); | ||
| for (let i = 0, l = buffer.length; i < l; i++) { | ||
| data.push(buffer[i]); | ||
| } | ||
| }; | ||
|
|
||
| filter.onstop = (event) => { | ||
| for ( | ||
| let i = data.indexOfMulti(bytes), m = elements.length, n = bytes.length; | ||
| i >= 0; | ||
| i = data.indexOfMulti(bytes, i + m + n) | ||
| ) { | ||
| // Insert "WebExtension " at the given index | ||
| data.splice(i, 0, ...elements); | ||
| } | ||
|
|
||
| filter.write(new Uint8Array(data)); | ||
| filter.close(); | ||
| }; |
There was a problem hiding this comment.
Another suggestion that's out of scope for this PR: progressively apply the transform in ondata callbacks rather than buffering the entire file in memory and serially applying the transform at the end. This would improve scenarios where content can progressively render while streaming, such as with HTML responses.
| // JavaScript program to search the pattern in given array | ||
| // using KMP Algorithm | ||
|
|
||
| function constructLps(pat, lps) { |
There was a problem hiding this comment.
| @@ -315,6 +315,143 @@ browser.webRequest.onBeforeRequest.addListener( | |||
| ); | |||
| ``` | |||
|
|
|||
| This example demonstrates, how to search for multi-byte pattern in an array: | |||
There was a problem hiding this comment.
This example is very large now. Should it be on https://github.com/mdn/webextensions-examples?
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
files/en-us/mozilla/add-ons/webextensions/api/webrequest/streamfilter/ondata/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
And manipulate the array directly.
Description
Motivation
There was no example for manipulating the array directly without converting the whole array to a string first.
Additional details
Related issues and pull requests