Skip to content

Revert "[NOCI] Update bot checking logic" #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jjl014 wants to merge 1 commit into from
Closed

Revert "[NOCI] Update bot checking logic" #364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,5 @@
"rerank",
"atcs",
"testdata",
"Bytespider"
]
}
73 changes: 20 additions & 53 deletions spec/src/utils/humanity-check.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
/* eslint-disable
no-underscore-dangle,
no-restricted-properties,
import/no-unresolved
*/
/* eslint-disable import/no-unresolved */
const dotenv = require('dotenv');
const chai = require('chai');
const chaiAsPromised = require('chai-as-promised');
Expand All @@ -19,7 +15,7 @@ const bundled = process.env.BUNDLED === 'true';
describe('ConstructorIO - Utils - Humanity Check', () => {
// Don't run tests in bundle context, as these tests are for library internals
if (!bundled) {
describe('constructor', () => {
describe('isHuman', () => {
const storageKey = '_constructorio_is_human';
let cleanup;

Expand All @@ -39,89 +35,60 @@ describe('ConstructorIO - Utils - Humanity Check', () => {
it('Should not have isHuman flag set on initial instantiation', () => {
const humanity = new HumanityCheck();

expect(humanity.hasPerformedHumanEvent).to.equal(false);
expect(humanity.isHuman()).to.equal(false);
expect(store.session.get(storageKey)).to.equal(null);
});

it('Should have isHuman flag set if human-like actions are detected', () => {
const humanity = new HumanityCheck();

expect(humanity.hasPerformedHumanEvent).to.equal(false);
expect(humanity.isHuman()).to.equal(false);
helpers.triggerResize();
expect(humanity.hasPerformedHumanEvent).to.equal(true);
expect(humanity.isHuman()).to.equal(true);
expect(store.session.get(storageKey)).to.equal(true);
});
});

it('Should have isHuman flag set if session variable is set', () => {
const humanity = new HumanityCheck();

expect(humanity.isHuman()).to.equal(false);
store.session.set(storageKey, true);
expect(humanity.isHuman()).to.equal(true);
expect(store.session.get(storageKey)).to.equal(true);
});
});
describe('isBot', () => {
const storageKey = '_constructorio_is_human';
let cleanup;
let defaultAgent;

beforeEach(() => {
global.CLIENT_VERSION = 'cio-mocha';
cleanup = jsdom();

defaultAgent = window.navigator.userAgent;
cleanup = jsdom();
window.navigator.webdriver = true;
});

afterEach(() => {
delete global.CLIENT_VERSION;
delete window.navigator.webdriver;
window.navigator.__defineGetter__('userAgent', () => defaultAgent);
cleanup();

helpers.clearStorage();
});

it('Should return true if it detects a webdriver', () => {
window.navigator.webdriver = true;
const humanity = new HumanityCheck();

expect(humanity.isBot()).to.equal(true);
expect(store.session.get(storageKey)).to.equal(null);
});

it('Should return true if it detects a webdriver and the session variable is set via human-like action', () => {
window.navigator.webdriver = true;
const humanity = new HumanityCheck();

expect(humanity.isBot()).to.equal(true);
helpers.triggerResize();
expect(humanity.isBot()).to.equal(true);
expect(store.session.get(storageKey)).to.equal(true);
});

it('Should return true if it detects a bot user agent', () => {
window.navigator.__defineGetter__('userAgent', () => 'Mozilla/5.0 (Linux; Android 5.0) AppleWebKit/537.36 (KHTML, like Gecko) Mobile Safari/537.36 (compatible; Bytespider; spider-feedback@bytedance.com)');
it('Should have isBot flag set on initial instantiation', () => {
const humanity = new HumanityCheck();

expect(humanity.isBot()).to.equal(true);
expect(store.session.get(storageKey)).to.equal(null);
});

it('Should return true if it detects a bot user agent and the session variable is set via human-like action', () => {
window.navigator.__defineGetter__('userAgent', () => 'Mozilla/5.0 (Linux; Android 5.0) AppleWebKit/537.36 (KHTML, like Gecko) Mobile Safari/537.36 (compatible; Bytespider; spider-feedback@bytedance.com)');
const humanity = new HumanityCheck();

expect(humanity.isBot()).to.equal(true);
helpers.triggerResize();
expect(humanity.isBot()).to.equal(true);
expect(store.session.get(storageKey)).to.equal(true);
});

it('Should return true if it does not detect the user is a bot user nor webdriver and the session variable has not been set yet', () => {
const humanity = new HumanityCheck();

expect(humanity.isBot()).to.equal(true);
});

it('Should return false if it does not detect the user is a bot/webdriver and the session variable is set via human-like action', () => {
it('Should have isBot flag set to false if session variable is set', () => {
const humanity = new HumanityCheck();

expect(humanity.isBot()).to.equal(true);
helpers.triggerResize();
store.session.set(storageKey, true);
expect(humanity.isBot()).to.equal(false);
expect(store.session.get(storageKey)).to.equal(true);
});
});
}
Expand Down
121 changes: 23 additions & 98 deletions spec/src/utils/request-queue.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
this.timeout(3000);

const storageKey = '_constructorio_requests';
const humanityStorageKey = '_constructorio_is_human';
const waitInterval = 2000;
let requestQueueOptions = {};
const piiExamples = [
Expand Down Expand Up @@ -180,8 +179,7 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
helpers.clearStorage();
});

it('Should add url requests to the queue if the user is human', async () => {
store.session.set(humanityStorageKey, true);
it('Should add url requests to the queue', () => {
const requests = new RequestQueue(requestQueueOptions);

requests.queue('https://ac.cnstrc.com/behavior?action=session_start');
Expand All @@ -193,8 +191,7 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
expect(store.local.get(storageKey)).to.be.an('array').length(3);
});

it('Should add object requests to the queue - POST with body if the user is human', () => {
store.session.set(humanityStorageKey, true);
it('Should add object requests to the queue - POST with body', () => {
const requests = new RequestQueue(requestQueueOptions);

requests.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'session_start' });
Expand All @@ -221,7 +218,6 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
});

it('Should obfuscate requests if PII is detected', () => {
store.session.set(humanityStorageKey, true); // Enabled for the test to run
const requests = new RequestQueue(requestQueueOptions);
const allExamples = [];

Expand Down Expand Up @@ -256,7 +252,6 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
});

it('Should not obfuscate requests if no PII is detected', () => {
store.session.set(humanityStorageKey, true); // Enabled for the test to run
const requests = new RequestQueue(requestQueueOptions);

notPiiExamples.forEach((query) => {
Expand Down Expand Up @@ -348,13 +343,12 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
it('Should send all url tracking requests if queue is populated and user is human', (done) => {
const requests = new RequestQueue(requestQueueOptions);

helpers.triggerResize(); // Human-like action

requests.queue('https://ac.cnstrc.com/behavior?action=session_start');
requests.queue('https://ac.cnstrc.com/behavior?action=focus');
requests.queue('https://ac.cnstrc.com/behavior?action=magic_number_three');

expect(RequestQueue.get()).to.be.an('array').length(3);
helpers.triggerResize();
requests.send();

setTimeout(() => {
Expand All @@ -365,7 +359,6 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
});

it('Should send all object tracking requests if queue is populated and user is human - POST with body', (done) => {
store.session.set(humanityStorageKey, true);
const requests = new RequestQueue(requestQueueOptions);

requests.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'session_start' });
Expand All @@ -383,26 +376,14 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
}, waitInterval);
});

it('Should not send tracking requests if queue was populated and user is not human', (done) => {
it('Should not send tracking requests if queue is populated and user is not human', (done) => {
const requests = new RequestQueue(requestQueueOptions);

store.local.set(storageKey, [
{
url: 'https://ac.cnstrc.com/behavior?action=session_start',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=focus',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=magic_number_three',
method: 'GET',
},
]);
requests.queue('https://ac.cnstrc.com/behavior?action=session_start');
requests.queue('https://ac.cnstrc.com/behavior?action=focus');
requests.queue('https://ac.cnstrc.com/behavior?action=magic_number_three');

expect(RequestQueue.get()).to.be.an('array').length(3);

requests.send();

setTimeout(() => {
Expand All @@ -414,20 +395,9 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
it('Should not send tracking requests if queue is populated and user is human and page is unloading', (done) => {
const requests = new RequestQueue(requestQueueOptions);

store.local.set(storageKey, [
{
url: 'https://ac.cnstrc.com/behavior?action=session_start',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=focus',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=magic_number_three',
method: 'GET',
},
]);
requests.queue('https://ac.cnstrc.com/behavior?action=session_start');
requests.queue('https://ac.cnstrc.com/behavior?action=focus');
requests.queue('https://ac.cnstrc.com/behavior?action=magic_number_three');

expect(RequestQueue.get()).to.be.an('array').length(3);
helpers.triggerResize();
Expand All @@ -443,20 +413,9 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
it('Should not send tracking requests if queue is populated and user is human and page is unloading and send was called before unload', (done) => {
const requests = new RequestQueue(requestQueueOptions);

store.local.set(storageKey, [
{
url: 'https://ac.cnstrc.com/behavior?action=session_start',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=focus',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=magic_number_three',
method: 'GET',
},
]);
requests.queue('https://ac.cnstrc.com/behavior?action=session_start');
requests.queue('https://ac.cnstrc.com/behavior?action=focus');
requests.queue('https://ac.cnstrc.com/behavior?action=magic_number_three');

expect(RequestQueue.get()).to.be.an('array').length(3);
helpers.triggerResize();
Expand Down Expand Up @@ -769,28 +728,11 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
const sendSpy1 = sinon.spy(requests1, 'send');
const sendSpy2 = sinon.spy(requests2, 'send');

store.local.set(storageKey, [
{
url: 'https://ac.cnstrc.com/behavior?action=session_start',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=focus',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=magic_number_three',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=magic_number_four',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=magic_number_five',
method: 'GET',
},
]);
requests1.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'number_one' });
requests1.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'number_two' });
requests1.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'number_three' });
requests1.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'number_four' });
requests1.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'number_five' });

helpers.triggerResize();
requests1.send();
Expand All @@ -812,28 +754,11 @@ describe('ConstructorIO - Utils - Request Queue', function utilsRequestQueue() {
const sendSpy1 = sinon.spy(requests1, 'send');
const sendSpy2 = sinon.spy(requests2, 'send');

store.local.set(storageKey, [
{
url: 'https://ac.cnstrc.com/behavior?action=session_start',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=focus',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=magic_number_three',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=magic_number_four',
method: 'GET',
},
{
url: 'https://ac.cnstrc.com/behavior?action=magic_number_five',
method: 'GET',
},
]);
requests1.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'number_one' });
requests2.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'number_two' });
requests1.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'number_three' });
requests2.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'number_four' });
requests1.queue('https://ac.cnstrc.com/behavior', 'POST', { action: 'number_five' });

helpers.triggerResize();
requests1.send();
Expand Down
Loading
Loading