Skip to content

Commit

Permalink
fix: Stopped calling usage pulse in air-gapped instance (#38749)
Browse files Browse the repository at this point in the history
## Description

This PR added fix for not triggering usage pulse for air gapped
instances


Fixes appsmithorg/cloud-services#1883


## Automation

/ok-to-test tags="@tag.Sanity"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/12867501950>
> Commit: 2300d20
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12867501950&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Sanity`
> Spec:
> <hr>Mon, 20 Jan 2025 12:38:11 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Bug Fixes**
- Enhanced user activity tracking by introducing airgapped environment
detection, preventing unnecessary tracking in restricted network
settings.
- **Tests**
- Added a new test suite to verify the behavior of the user activity
tracking method in airgapped conditions, ensuring correct functionality
based on the airgapped status.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
albinAppsmith authored Jan 20, 2025
1 parent 0b830a5 commit 2ca5993
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
6 changes: 6 additions & 0 deletions app/client/src/usagePulse/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import { PULSE_INTERVAL as PULSE_INTERVAL_CE } from "ce/constants/UsagePulse";
import { PULSE_INTERVAL as PULSE_INTERVAL_EE } from "ee/constants/UsagePulse";
import store from "store";
import type { PageListReduxState } from "reducers/entityReducers/pageListReducer";
import { isAirgapped } from "ee/utils/airgapHelpers";

class UsagePulse {
static userAnonymousId: string | undefined;
Expand All @@ -26,6 +27,7 @@ class UsagePulse {
static isTelemetryEnabled: boolean;
static isAnonymousUser: boolean;
static isFreePlan: boolean;
static isAirgapped = isAirgapped();

/*
* Function to check if the given URL is trakable or not.
Expand Down Expand Up @@ -143,6 +145,10 @@ class UsagePulse {
* registers listeners to wait for the user to go to a trackable url
*/
static async sendPulseAndScheduleNext() {
if (UsagePulse.isAirgapped) {
return;
}

UsagePulse.sendPulse();
UsagePulse.scheduleNextActivityListeners();
}
Expand Down
30 changes: 30 additions & 0 deletions app/client/src/usagePulse/usagePulse.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,34 @@ describe("Usage pulse", () => {
});
});
});

describe("sendPulseAndScheduleNext", () => {
let sendPulseSpy: jest.SpyInstance;
let scheduleNextActivityListenersSpy: jest.SpyInstance;

beforeEach(() => {
sendPulseSpy = jest
.spyOn(UsagePulse, "sendPulse")
.mockImplementation(() => {});
scheduleNextActivityListenersSpy = jest
.spyOn(UsagePulse, "scheduleNextActivityListeners")
.mockImplementation(() => {});
UsagePulse.isAirgapped = false;
});

it("should not send pulse or schedule next when airgapped", () => {
UsagePulse.isAirgapped = true;
UsagePulse.sendPulseAndScheduleNext();

expect(sendPulseSpy).not.toHaveBeenCalled();
expect(scheduleNextActivityListenersSpy).not.toHaveBeenCalled();
});

it("should send pulse and schedule next activity listeners when not airgapped", () => {
UsagePulse.sendPulseAndScheduleNext();

expect(sendPulseSpy).toHaveBeenCalledTimes(1);
expect(scheduleNextActivityListenersSpy).toHaveBeenCalledTimes(1);
});
});
});

0 comments on commit 2ca5993

Please sign in to comment.