Merge pull request #207 from csfloat/feature/alarms-optional

Makes Alarms Permission Optional

Author: Step7750

manifest.json

@@ -43,7 +43,8 @@
         "service_worker": "src/background.js",
         "type": "module"
     },
-    "permissions": ["storage", "scripting", "alarms"],
+    "permissions": ["storage", "scripting"],
+    "optional_permissions": ["alarms"],
     "host_permissions": [
         "*://*.steamcommunity.com/market/listings/730/*",
         "*://*.steamcommunity.com/id/*/inventory*",

src/background.ts

@@ -1,7 +1,7 @@
 import {Handle} from './lib/bridge/server';
 import {InternalResponseBundle} from './lib/bridge/types';
 import MessageSender = chrome.runtime.MessageSender;
-import {PING_CSFLOAT_TRADE_STATUS_ALARM_NAME, pingTradeStatus} from './lib/alarms/csfloat_trade_pings';
+import {alarmListener, registerTradeAlarmIfPossible} from './lib/alarms/setup';
 
 function unifiedHandler(request: any, sender: MessageSender, sendResponse: (response?: any) => void) {
     Handle(request, sender)
@@ -41,21 +41,13 @@ chrome.runtime.onMessageExternal.addListener((request, sender, sendResponse) =>
     return true;
 });
 
-chrome.alarms.onAlarm.addListener(async (alarm) => {
-    if (alarm.name === PING_CSFLOAT_TRADE_STATUS_ALARM_NAME) {
-        await pingTradeStatus();
-    }
-});
+if (chrome.alarms) {
+    // Install at the root level to make sure events wake up the service worker
+    chrome.alarms.onAlarm.addListener(alarmListener);
+}
 
 async function checkAlarmState() {
-    const alarm = await chrome.alarms.get(PING_CSFLOAT_TRADE_STATUS_ALARM_NAME);
-
-    if (!alarm) {
-        await chrome.alarms.create(PING_CSFLOAT_TRADE_STATUS_ALARM_NAME, {
-            periodInMinutes: 5,
-            delayInMinutes: 1,
-        });
-    }
+    await registerTradeAlarmIfPossible();
 }
 
 checkAlarmState();

src/lib/alarms/setup.ts

@@ -0,0 +1,32 @@
+import {PING_CSFLOAT_TRADE_STATUS_ALARM_NAME, pingTradeStatus} from './csfloat_trade_pings';
+import {HasPermissions} from '../bridge/handlers/has_permissions';
+
+export async function alarmListener(alarm: chrome.alarms.Alarm) {
+    if (alarm.name === PING_CSFLOAT_TRADE_STATUS_ALARM_NAME) {
+        await pingTradeStatus();
+    }
+}
+
+async function registerAlarmListenerIfPossible() {
+    if (chrome.alarms) {
+        chrome.alarms.onAlarm.addListener(alarmListener);
+    }
+}
+
+export async function registerTradeAlarmIfPossible() {
+    const hasPermissions = await HasPermissions.handleRequest({permissions: ['alarms'], origins: []}, {});
+    if (!hasPermissions.granted) {
+        return;
+    }
+
+    await registerAlarmListenerIfPossible();
+
+    const alarm = await chrome.alarms.get(PING_CSFLOAT_TRADE_STATUS_ALARM_NAME);
+
+    if (!alarm) {
+        await chrome.alarms.create(PING_CSFLOAT_TRADE_STATUS_ALARM_NAME, {
+            periodInMinutes: 5,
+            delayInMinutes: 1,
+        });
+    }
+}

src/lib/bridge/handlers/ping_setup_extension.ts

@@ -1,6 +1,7 @@
 import {SimpleHandler} from './main';
 import {RequestType} from './types';
 import {environment} from '../../../environment';
+import {registerTradeAlarmIfPossible} from '../../alarms/setup';
 
 export interface PingSetupExtensionRequest {}
 
@@ -9,6 +10,8 @@ export interface PingSetupExtensionResponse {}
 export const PingSetupExtension = new SimpleHandler<PingSetupExtensionRequest, PingSetupExtensionResponse>(
     RequestType.PING_SETUP_EXTENSION,
     async (req) => {
+        await registerTradeAlarmIfPossible();
+
         const resp = await fetch(`${environment.csfloat_base_api_url}/v1/me/extension/setup`, {
             credentials: 'include',
             method: 'POST',

src/lib/components/trade_offer/auto_fill.ts

@@ -61,7 +61,7 @@ export class AutoFill extends FloatElement {
 
         try {
             const hasPermissions = await ClientSend(HasPermissions, {
-                permissions: [],
+                permissions: ['alarms'],
                 origins: ['*://*.steampowered.com/*'],
             });
             this.hasPermissions = hasPermissions.granted;

src/lib/components/trade_offers/better_tracking.ts

@@ -56,7 +56,7 @@ export class BetterTrackingWidget extends FloatElement {
         try {
             // Used for api.steampowered.com requests, all tokens stay on the users' device
             const hasPermissions = await ClientSend(HasPermissions, {
-                permissions: [],
+                permissions: ['alarms'],
                 origins: ['*://*.steampowered.com/*'],
             });
 
@@ -90,7 +90,7 @@ export class BetterTrackingWidget extends FloatElement {
                               />
                           </div>
                           <span class="item-name">Setup Offer Tracking on CSFloat</span>
-                          <div class="sale-info">Verify trades faster while preserving your privacy.</div>
+                          <div class="sale-info">Verify trades while preserving your privacy.</div>
                       </div>
                       <csfloat-steam-button id="csfloat-enable-enhanced" .text="${'Enable'}"></csfloat-steam-button>
                   </div>

src/lib/page_scripts/trade_offers.ts

@@ -24,7 +24,7 @@ if (!inPageContext()) {
             chrome.runtime.sendMessage(
                 {
                     message: 'requestPermissions',
-                    permissions: [],
+                    permissions: ['alarms'],
                     origins: ['*://*.steampowered.com/*'],
                 },
                 (granted) => {