pdm/stream_deck_notion_timer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

v1.0.38: eliminate setSettings from onKeyDown to fix flash

Browse Source 
setSettings always resets the button visual state — no workaround
exists. Removed activeEntryId from per-button settings entirely.
Running state now tracked via runningActionId in global settings
(alongside runningEntryId). onWillAppear restores state from
memRunningActionId. onKeyDown only calls setState — clean, instant.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
pdmarf
2026-04-24 09:20:41 +01:00
parent 35a0bbb867
commit 4171b2f6e9
6 changed files with 84 additions and 160 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
com.pdma.notion-timer.sdPlugin/bin/plugin.js
View File

@@ -6438,7 +6438,7 @@ async function stopTimer(token, entryId) {
} }
// src/plugin.ts // src/plugin.ts
var CURRENT_VERSION = "1.0.37"; var CURRENT_VERSION = "1.0.38";
var GITEA_BASE = "https://gitea.pdmarf.co.uk/pdm/stream_deck_notion_timer/raw/branch/stable-rebuild"; var GITEA_BASE = "https://gitea.pdmarf.co.uk/pdm/stream_deck_notion_timer/raw/branch/stable-rebuild";
var SIGNING_PUBLIC_KEY = `-----BEGIN PUBLIC KEY----- var SIGNING_PUBLIC_KEY = `-----BEGIN PUBLIC KEY-----
MCowBQYDK2VwAyEAN7ko8TUpuPzPAJuKAZCRjV0c4ZSlou5d9pUAF6o12b4= MCowBQYDK2VwAyEAN7ko8TUpuPzPAJuKAZCRjV0c4ZSlou5d9pUAF6o12b4=
@@ -6528,17 +6528,18 @@ async function getGlobal() {
return { ...stored, ...HARDCODED }; return { ...stored, ...HARDCODED };
} }
var memRunningEntryId = void 0; var memRunningEntryId = void 0;
async function getRunningEntryId() { var memRunningActionId = void 0;
if (memRunningEntryId === void 0) { async function loadRunningState() {
if (memRunningEntryId !== void 0) return;
const stored = await plugin_default.settings.getGlobalSettings(); const stored = await plugin_default.settings.getGlobalSettings();
memRunningEntryId = stored.runningEntryId ?? null; memRunningEntryId = stored.runningEntryId ?? null;
} memRunningActionId = stored.runningActionId ?? null;
return memRunningEntryId;
} }
async function setRunningEntry(entryId) { async function setRunningEntry(entryId, actionId) {
memRunningEntryId = entryId; memRunningEntryId = entryId;
memRunningActionId = actionId;
const stored = await plugin_default.settings.getGlobalSettings(); const stored = await plugin_default.settings.getGlobalSettings();
await plugin_default.settings.setGlobalSettings({ ...stored, runningEntryId: entryId }); await plugin_default.settings.setGlobalSettings({ ...stored, runningEntryId: entryId, runningActionId: actionId });
} }
async function sendProjectsToPI(tokenOverride) { async function sendProjectsToPI(tokenOverride) {
try { try {
@@ -6568,42 +6569,34 @@ function buttonTitle(projectName) {
return projectName.replace(/^[\p{Extended_Pictographic}\uFE0F\s]+/u, "").trim(); return projectName.replace(/^[\p{Extended_Pictographic}\uFE0F\s]+/u, "").trim();
} }
var TimerToggle = class extends SingletonAction { var TimerToggle = class extends SingletonAction {
settingsCache = /* @__PURE__ */ new Map(); projectCache = /* @__PURE__ */ new Map();
async onWillAppear(ev) { async onWillAppear(ev) {
const { activeEntryId, projectName } = ev.payload.settings; this.projectCache.set(ev.action.id, ev.payload.settings);
const title = buttonTitle(projectName || ""); const title = buttonTitle(ev.payload.settings.projectName || "");
const running = await getRunningEntryId(); await loadRunningState();
const isRunning = !!activeEntryId && activeEntryId === running; const isRunning = memRunningActionId === ev.action.id;
if (activeEntryId && !isRunning) {
const cleared = { ...ev.payload.settings, activeEntryId: null };
await ev.action.setSettings(cleared);
this.settingsCache.set(ev.action.id, cleared);
await Promise.all([ev.action.setState(0), ev.action.setTitle(title)]);
} else {
this.settingsCache.set(ev.action.id, ev.payload.settings);
if (isRunning) { if (isRunning) {
await Promise.all([ev.action.setState(1), ev.action.setTitle(`\u23F1 ${title}`)]); await Promise.all([ev.action.setState(1), ev.action.setTitle(`\u23F1 ${title}`)]);
} else { } else {
await Promise.all([ev.action.setState(0), ev.action.setTitle(title)]); await Promise.all([ev.action.setState(0), ev.action.setTitle(title)]);
} }
} }
}
async onPropertyInspectorDidAppear(_ev) { async onPropertyInspectorDidAppear(_ev) {
await sendProjectsToPI(); await sendProjectsToPI();
} }
async onKeyDown(ev) { async onKeyDown(ev) {
this.settingsCache.set(ev.action.id, ev.payload.settings); const { projectId, projectName } = ev.payload.settings;
const { projectId, projectName, activeEntryId } = ev.payload.settings;
const title = buttonTitle(projectName || ""); const title = buttonTitle(projectName || "");
const isRunning = memRunningActionId === ev.action.id;
if (projectId) { if (projectId) {
if (activeEntryId) { if (isRunning) {
await Promise.all([ev.action.setState(0), ev.action.setTitle(title)]); await Promise.all([ev.action.setState(0), ev.action.setTitle(title)]);
} else { } else {
for (const other of this.actions) { for (const other of this.actions) {
if (other.id === ev.action.id) continue; if (other.id === ev.action.id) continue;
const otherSettings = this.settingsCache.get(other.id); if (memRunningActionId === other.id) {
if (otherSettings?.activeEntryId) { const s = this.projectCache.get(other.id);
await Promise.all([other.setState(0), other.setTitle(buttonTitle(otherSettings.projectName || ""))]); await Promise.all([other.setState(0), other.setTitle(buttonTitle(s?.projectName || ""))]);
} }
} }
await Promise.all([ev.action.setState(1), ev.action.setTitle(`\u23F1 ${title}`)]); await Promise.all([ev.action.setState(1), ev.action.setTitle(`\u23F1 ${title}`)]);
@@ -6611,7 +6604,6 @@ var TimerToggle = class extends SingletonAction {
} }
const global = await getGlobal(); const global = await getGlobal();
if (!isConfigured(global)) { if (!isConfigured(global)) {
await Promise.all([ev.action.setState(activeEntryId ? 1 : 0), ev.action.setTitle(activeEntryId ? `\u23F1 ${title}` : title)]);
await ev.action.showAlert(); await ev.action.showAlert();
return; return;
} }
@@ -6620,40 +6612,21 @@ var TimerToggle = class extends SingletonAction {
return; return;
} }
try { try {
if (activeEntryId) { if (isRunning) {
await stopTimer(global.notionToken, activeEntryId); await stopTimer(global.notionToken, memRunningEntryId);
const stopped = { ...ev.payload.settings, activeEntryId: null }; await setRunningEntry(null, null);
this.settingsCache.set(ev.action.id, stopped);
await Promise.all([ev.action.setSettings(stopped), ev.action.setState(0), ev.action.setTitle(title)]);
await setRunningEntry(null);
} else { } else {
const prevEntryId = await getRunningEntryId(); if (memRunningEntryId) {
if (prevEntryId) { await stopTimer(global.notionToken, memRunningEntryId);
await stopTimer(global.notionToken, prevEntryId);
for (const other of this.actions) {
if (other.id === ev.action.id) continue;
const otherSettings = this.settingsCache.get(other.id);
if (otherSettings?.activeEntryId === prevEntryId) {
const stopped = { ...otherSettings, activeEntryId: null };
this.settingsCache.set(other.id, stopped);
await Promise.all([other.setSettings(stopped), other.setState(0), other.setTitle(buttonTitle(otherSettings.projectName || ""))]);
} }
} const entryId = await startTimer(global.notionToken, global.timingDbId, projectId, projectName, global.userId);
} await setRunningEntry(entryId, ev.action.id);
const entryId = await startTimer(
global.notionToken,
global.timingDbId,
projectId,
projectName,
global.userId
);
const started = { ...ev.payload.settings, activeEntryId: entryId };
this.settingsCache.set(ev.action.id, started);
await Promise.all([ev.action.setSettings(started), ev.action.setState(1), ev.action.setTitle(`\u23F1 ${title}`)]);
await setRunningEntry(entryId);
} }
} catch (err) { } catch (err) {
await Promise.all([ev.action.setState(activeEntryId ? 1 : 0), ev.action.setTitle(activeEntryId ? `\u23F1 ${title}` : title)]); await Promise.all([
ev.action.setState(isRunning ? 1 : 0),
ev.action.setTitle(isRunning ? `\u23F1 ${title}` : title)
]);
plugin_default.logger.error("Timer toggle failed:", err); plugin_default.logger.error("Timer toggle failed:", err);
await ev.action.showAlert(); await ev.action.showAlert();
} }

3
com.pdma.notion-timer.sdPlugin/bin/plugin.js.sig
View File

@@ -1 +1,2 @@
<EFBFBD>¹È©Ô<EFBFBD>u1ÀïÖB!ª£½I- bhݵ ä± Gr7L†]x~cá…»d³X Þ¹×y¯9<>B/£ž/ Κ¤<06>C¤•Sί¤
Φ®Έ}•~P }ηΜ<>Z;·ΆxΤη{,¦NYPπu4#ΑΚ„jα§ΎWCκΈ©σΔ «Έ<0E>d

2
com.pdma.notion-timer.sdPlugin/manifest.json
View File

@@ -2,7 +2,7 @@
"Author": "Pete Marfleet", "Author": "Pete Marfleet",
"Description": "Toggle Notion time tracking for a project with a single button press.", "Description": "Toggle Notion time tracking for a project with a single button press.",
"Name": "Notion Timer", "Name": "Notion Timer",
"Version": "1.0.37", "Version": "1.0.38",
"SDKVersion": 2, "SDKVersion": 2,
"Software": { "MinimumVersion": "5.0" }, "Software": { "MinimumVersion": "5.0" },
"OS": [{ "Platform": "mac", "MinimumVersion": "10.11" }], "OS": [{ "Platform": "mac", "MinimumVersion": "10.11" }],

BIN
notion-timer.streamDeckPlugin
View File

Binary file not shown.

124
src/plugin.ts
View File

@@ -1,4 +1,4 @@
const CURRENT_VERSION = "1.0.37"; const CURRENT_VERSION = "1.0.38";
const GITEA_BASE = "https://gitea.pdmarf.co.uk/pdm/stream_deck_notion_timer/raw/branch/stable-rebuild"; const GITEA_BASE = "https://gitea.pdmarf.co.uk/pdm/stream_deck_notion_timer/raw/branch/stable-rebuild";
const SIGNING_PUBLIC_KEY = `-----BEGIN PUBLIC KEY----- const SIGNING_PUBLIC_KEY = `-----BEGIN PUBLIC KEY-----
MCowBQYDK2VwAyEAN7ko8TUpuPzPAJuKAZCRjV0c4ZSlou5d9pUAF6o12b4= MCowBQYDK2VwAyEAN7ko8TUpuPzPAJuKAZCRjV0c4ZSlou5d9pUAF6o12b4=
@@ -52,7 +52,6 @@ async function checkForUpdates(sendStatus?: (msg: string) => void): Promise<void
const path = await import("path"); const path = await import("path");
const pluginRoot = path.join(path.dirname(__filename), ".."); const pluginRoot = path.join(path.dirname(__filename), "..");
// Update UI and image assets
const ASSETS = [ const ASSETS = [
"ui/property-inspector.html", "ui/property-inspector.html",
"ui/global-property-inspector.html", "ui/global-property-inspector.html",
@@ -67,7 +66,6 @@ async function checkForUpdates(sendStatus?: (msg: string) => void): Promise<void
} }
} }
// Remove legacy SVG icons that persist on disk after Stream Deck merge-installs
const LEGACY = ["imgs/idle.svg", "imgs/running.svg"]; const LEGACY = ["imgs/idle.svg", "imgs/running.svg"];
for (const f of LEGACY) { for (const f of LEGACY) {
try { fs.unlinkSync(path.join(pluginRoot, f)); } catch { /* already gone */ } try { fs.unlinkSync(path.join(pluginRoot, f)); } catch { /* already gone */ }
@@ -98,12 +96,12 @@ interface GlobalSettings {
projectsDbId: string; projectsDbId: string;
userId: string; userId: string;
runningEntryId?: string | null; runningEntryId?: string | null;
runningActionId?: string | null;
} }
interface TimerSettings { interface TimerSettings {
projectId: string; projectId: string;
projectName: string; projectName: string;
activeEntryId: string | null;
} }
const HARDCODED = { const HARDCODED = {
@@ -116,21 +114,22 @@ async function getGlobal(): Promise<GlobalSettings> {
return { ...stored, ...HARDCODED }; return { ...stored, ...HARDCODED };
} }
// In-memory cache so onWillAppear can check running state without an async round-trip // In-memory running state — avoids async round-trips on every button press
let memRunningEntryId: string | null | undefined = undefined; // undefined = not yet loaded let memRunningEntryId: string | null | undefined = undefined;
let memRunningActionId: string | null | undefined = undefined;
async function getRunningEntryId(): Promise<string | null> { async function loadRunningState(): Promise<void> {
if (memRunningEntryId === undefined) { if (memRunningEntryId !== undefined) return;
const stored = await streamDeck.settings.getGlobalSettings<GlobalSettings>(); const stored = await streamDeck.settings.getGlobalSettings<GlobalSettings>();
memRunningEntryId = stored.runningEntryId ?? null; memRunningEntryId = stored.runningEntryId ?? null;
} memRunningActionId = stored.runningActionId ?? null;
return memRunningEntryId;
} }
async function setRunningEntry(entryId: string | null): Promise<void> { async function setRunningEntry(entryId: string | null, actionId: string | null): Promise<void> {
memRunningEntryId = entryId; memRunningEntryId = entryId;
memRunningActionId = actionId;
const stored = await streamDeck.settings.getGlobalSettings<GlobalSettings>(); const stored = await streamDeck.settings.getGlobalSettings<GlobalSettings>();
await streamDeck.settings.setGlobalSettings({ ...stored, runningEntryId: entryId }); await streamDeck.settings.setGlobalSettings({ ...stored, runningEntryId: entryId, runningActionId: actionId });
} }
async function sendProjectsToPI(tokenOverride?: string): Promise<void> { async function sendProjectsToPI(tokenOverride?: string): Promise<void> {
@@ -159,59 +158,45 @@ function isConfigured(g: GlobalSettings): boolean {
return !!(g.notionToken && g.userId); return !!(g.notionToken && g.userId);
} }
// Strip leading emoji characters so the button title shows just the project name
function buttonTitle(projectName: string): string { function buttonTitle(projectName: string): string {
return projectName.replace(/^[\p{Extended_Pictographic}\uFE0F\s]+/u, "").trim(); return projectName.replace(/^[\p{Extended_Pictographic}\uFE0F\s]+/u, "").trim();
} }
@action({ UUID: "com.pdma.notion-timer.toggle" }) @action({ UUID: "com.pdma.notion-timer.toggle" })
class TimerToggle extends SingletonAction<TimerSettings> { class TimerToggle extends SingletonAction<TimerSettings> {
private settingsCache = new Map<string, TimerSettings>(); private projectCache = new Map<string, TimerSettings>();
async onWillAppear(ev: WillAppearEvent<TimerSettings>): Promise<void> { async onWillAppear(ev: WillAppearEvent<TimerSettings>): Promise<void> {
const { activeEntryId, projectName } = ev.payload.settings; this.projectCache.set(ev.action.id, ev.payload.settings);
const title = buttonTitle(projectName || ""); const title = buttonTitle(ev.payload.settings.projectName || "");
await loadRunningState();
// Use in-memory cache to determine correct state before rendering — no flash const isRunning = memRunningActionId === ev.action.id;
const running = await getRunningEntryId();
const isRunning = !!activeEntryId && activeEntryId === running;
if (activeEntryId && !isRunning) {
// Self-heal: this button thinks it's running but it's not — clear it
const cleared = { ...ev.payload.settings, activeEntryId: null };
await ev.action.setSettings(cleared);
this.settingsCache.set(ev.action.id, cleared);
await Promise.all([ev.action.setState(0), ev.action.setTitle(title)]);
} else {
this.settingsCache.set(ev.action.id, ev.payload.settings);
if (isRunning) { if (isRunning) {
await Promise.all([ev.action.setState(1), ev.action.setTitle(`⏱ ${title}`)]); await Promise.all([ev.action.setState(1), ev.action.setTitle(`⏱ ${title}`)]);
} else { } else {
await Promise.all([ev.action.setState(0), ev.action.setTitle(title)]); await Promise.all([ev.action.setState(0), ev.action.setTitle(title)]);
} }
} }
}
async onPropertyInspectorDidAppear(_ev: PropertyInspectorDidAppearEvent<TimerSettings>): Promise<void> { async onPropertyInspectorDidAppear(_ev: PropertyInspectorDidAppearEvent<TimerSettings>): Promise<void> {
await sendProjectsToPI(); await sendProjectsToPI();
} }
async onKeyDown(ev: KeyDownEvent<TimerSettings>): Promise<void> { async onKeyDown(ev: KeyDownEvent<TimerSettings>): Promise<void> {
this.settingsCache.set(ev.action.id, ev.payload.settings); const { projectId, projectName } = ev.payload.settings;
const { projectId, projectName, activeEntryId } = ev.payload.settings;
const title = buttonTitle(projectName || ""); const title = buttonTitle(projectName || "");
const isRunning = memRunningActionId === ev.action.id;
// Instant visual feedback before any async work // Instant visual feedback — no setSettings, no flash
if (projectId) { if (projectId) {
if (activeEntryId) { if (isRunning) {
await Promise.all([ev.action.setState(0), ev.action.setTitle(title)]); await Promise.all([ev.action.setState(0), ev.action.setTitle(title)]);
} else { } else {
// Turn off any other running button immediately using the cache — no async needed
for (const other of this.actions) { for (const other of this.actions) {
if (other.id === ev.action.id) continue; if (other.id === ev.action.id) continue;
const otherSettings = this.settingsCache.get(other.id); if (memRunningActionId === other.id) {
if (otherSettings?.activeEntryId) { const s = this.projectCache.get(other.id);
await Promise.all([other.setState(0), other.setTitle(buttonTitle(otherSettings.projectName || ""))]); await Promise.all([other.setState(0), other.setTitle(buttonTitle(s?.projectName || ""))]);
} }
} }
await Promise.all([ev.action.setState(1), ev.action.setTitle(`⏱ ${title}`)]); await Promise.all([ev.action.setState(1), ev.action.setTitle(`⏱ ${title}`)]);
@@ -219,59 +204,26 @@ class TimerToggle extends SingletonAction<TimerSettings> {
} }
const global = await getGlobal(); const global = await getGlobal();
if (!isConfigured(global)) { await ev.action.showAlert(); return; }
if (!isConfigured(global)) { if (!projectId) { await ev.action.showAlert(); return; }
await Promise.all([ev.action.setState(activeEntryId ? 1 : 0), ev.action.setTitle(activeEntryId ? `⏱ ${title}` : title)]);
await ev.action.showAlert();
return;
}
if (!projectId) {
await ev.action.showAlert();
return;
}
try { try {
if (activeEntryId) { if (isRunning) {
await stopTimer(global.notionToken, activeEntryId); await stopTimer(global.notionToken, memRunningEntryId!);
const stopped = { ...ev.payload.settings, activeEntryId: null }; await setRunningEntry(null, null);
this.settingsCache.set(ev.action.id, stopped);
// setSettings and setState together so the state reset doesn't flash
await Promise.all([ev.action.setSettings(stopped), ev.action.setState(0), ev.action.setTitle(title)]);
await setRunningEntry(null);
} else { } else {
const prevEntryId = await getRunningEntryId(); if (memRunningEntryId) {
await stopTimer(global.notionToken, memRunningEntryId);
// Stop previous timer and update its settings
if (prevEntryId) {
await stopTimer(global.notionToken, prevEntryId);
for (const other of this.actions) {
if (other.id === ev.action.id) continue;
const otherSettings = this.settingsCache.get(other.id);
if (otherSettings?.activeEntryId === prevEntryId) {
const stopped = { ...otherSettings, activeEntryId: null };
this.settingsCache.set(other.id, stopped);
await Promise.all([other.setSettings(stopped), other.setState(0), other.setTitle(buttonTitle(otherSettings.projectName || ""))]);
} }
} const entryId = await startTimer(global.notionToken, global.timingDbId, projectId, projectName, global.userId);
} await setRunningEntry(entryId, ev.action.id);
const entryId = await startTimer(
global.notionToken,
global.timingDbId,
projectId,
projectName,
global.userId,
);
const started = { ...ev.payload.settings, activeEntryId: entryId };
this.settingsCache.set(ev.action.id, started);
// setSettings and setState together so the state reset doesn't flash
await Promise.all([ev.action.setSettings(started), ev.action.setState(1), ev.action.setTitle(`⏱ ${title}`)]);
await setRunningEntry(entryId);
} }
} catch (err) { } catch (err) {
// Revert optimistic visual on error // Revert visual on error
await Promise.all([ev.action.setState(activeEntryId ? 1 : 0), ev.action.setTitle(activeEntryId ? `⏱ ${title}` : title)]); await Promise.all([
ev.action.setState(isRunning ? 1 : 0),
ev.action.setTitle(isRunning ? `⏱ ${title}` : title),
]);
streamDeck.logger.error("Timer toggle failed:", err); streamDeck.logger.error("Timer toggle failed:", err);
await ev.action.showAlert(); await ev.action.showAlert();
} }
@@ -281,7 +233,6 @@ class TimerToggle extends SingletonAction<TimerSettings> {
const timerAction = new TimerToggle(); const timerAction = new TimerToggle();
streamDeck.actions.registerAction(timerAction); streamDeck.actions.registerAction(timerAction);
// v2 requires using streamDeck.ui.onSendToPlugin — the SingletonAction method does not fire
streamDeck.ui.onSendToPlugin<{ event: string; settings?: TimerSettings; token?: string }>(async (ev) => { streamDeck.ui.onSendToPlugin<{ event: string; settings?: TimerSettings; token?: string }>(async (ev) => {
if (ev.payload.event === "saveSettings" && ev.payload.settings) { if (ev.payload.event === "saveSettings" && ev.payload.settings) {
await ev.action.setSettings(ev.payload.settings); await ev.action.setSettings(ev.payload.settings);
@@ -300,5 +251,4 @@ streamDeck.ui.onSendToPlugin<{ event: string; settings?: TimerSettings; token?:
streamDeck.connect(); streamDeck.connect();
// Check for updates 10 seconds after startup to avoid disrupting initial connection
setTimeout(() => checkForUpdates(), 10_000); setTimeout(() => checkForUpdates(), 10_000);

2
version.json
View File

@@ -1 +1 @@
{ "version": "1.0.37" } { "version": "1.0.38" }