homebridge-cync-app 0.1.7 → 0.1.9

package/src/cync/cync-client.ts

@@ -28,15 +28,48 @@ export class CyncClient {
 	private readonly log: CyncLogger;
 	private readonly configClient: ConfigClient;
 	private readonly tcpClient: TcpClient;
-
+	private readonly unsupportedPropertiesProductIds = new Set<string>();
 	private readonly tokenStore: CyncTokenStore;
 	private tokenData: CyncTokenData | null = null;
+	private isDevicePropertyNotExistsError(err: unknown): boolean {
+		if (!err) {
+			return false;
+		}
+
+		type ErrorWithShape = {
+			status?: number;
+			error?: {
+				code?: number;
+				msg?: string;
+			};
+			message?: string;
+		};
+
+		const e = err as ErrorWithShape;
 
+		// Observed cloud response:
+		// HTTP 404 Not Found { error: { msg: 'device property not exists', code: 4041009 } }
+		if (e.status === 404 && e.error?.code === 4041009) {
+			return true;
+		}
+
+		// Fallback (if shape changes or gets wrapped)
+		if (e.message && e.message.includes('device property not exists')) {
+			return true;
+		}
+
+		return false;
+	}
+
+	private formatMeshLabel(mesh: { name?: string | null; id: string | number }): string {
+		const rawName = typeof mesh.name === 'string' ? mesh.name.trim() : '';
+		return rawName.length > 0 ? rawName : `No Name (id=${String(mesh.id)})`;
+	}
 	// Populated after successful login.
 	private session: CyncLoginSession | null = null;
 	private cloudConfig: CyncCloudConfig | null = null;
 
-	// ### 🧩 LAN Topology Cache: mirrors HA's home_devices / home_controllers / switchID_to_homeID
+	// LAN Topology Cache: mirrors HA's home_devices / home_controllers / switchID_to_homeID
 	private homeDevices: Record<string, string[]> = {};
 	private homeControllers: Record<string, number[]> = {};
 	private switchIdToHomeId: Record<number, string> = {};
@@ -52,12 +85,99 @@ export class CyncClient {
 	// Optional LAN update hook for the platform
 	private lanUpdateHandler: ((update: unknown) => void) | null = null;
 
-	// ### 🧩 LAN Update Bridge: allow platform to handle device updates
+	// Password Login Helper: background username/password login for new tokens
+	private async loginWithPasswordForToken(): Promise<CyncTokenData | null> {
+		const { username, password } = this.loginConfig;
+
+		if (!username || !password) {
+			this.log.error(
+				'CyncClient: cannot perform password login; username or password is missing from config.',
+			);
+			return null;
+		}
+
+		try {
+			this.log.warn(
+				'CyncClient: performing background username/password login (no OTP) to obtain a fresh token…',
+			);
+
+			const session = await this.configClient.loginWithPassword(
+				username.trim(),
+				password,
+			);
+
+			const raw = session.raw as Record<string, unknown>;
+			const authorize =
+				typeof raw.authorize === 'string' ? raw.authorize : undefined;
+
+			const s = session as unknown as SessionWithPossibleTokens;
+			const access = s.accessToken ?? s.jwt;
+
+			if (!access) {
+				this.log.error(
+					'CyncClient: password login session did not return an access token.',
+				);
+				return null;
+			}
+
+			const refresh = s.refreshToken ?? s.refreshJwt;
+			const expiresAt = s.expiresAt;
+
+			let lanLoginCode: string | undefined;
+			if (authorize) {
+				const userIdNum = Number.parseInt(session.userId, 10);
+				if (Number.isFinite(userIdNum) && userIdNum >= 0) {
+					const lanBlob = this.buildLanLoginCode(authorize, userIdNum);
+					lanLoginCode = Buffer.from(lanBlob).toString('base64');
+				} else {
+					this.log.warn(
+						'CyncClient: password login returned non-numeric userId=%s; LAN login code not generated.',
+						session.userId,
+					);
+				}
+			} else {
+				this.log.warn(
+					'CyncClient: password login response missing "authorize"; LAN login may be disabled.',
+				);
+			}
+
+			const next: CyncTokenData = {
+				userId: String(session.userId),
+				accessToken: access,
+				refreshToken: refresh,
+				expiresAt,
+				authorize,
+				lanLoginCode,
+			};
+
+			await this.tokenStore.save(next);
+			this.tokenData = next;
+			this.applyAccessToken(next);
+
+			this.log.info(
+				'CyncClient: obtained new token via password login; userId=%s expiresAt=%s',
+				next.userId,
+				next.expiresAt
+					? new Date(next.expiresAt).toISOString()
+					: 'unknown',
+			);
+
+			return next;
+		} catch (err) {
+			this.log.error(
+				'CyncClient: password-based background login failed: %o',
+				err,
+			);
+			return null;
+		}
+	}
+
+	// LAN Update Bridge: allow platform to handle device updates
 	public onLanDeviceUpdate(handler: (update: unknown) => void): void {
 		this.lanUpdateHandler = handler;
 	}
 
-	// ### 🧩 LAN Auth Blob Getter: Returns the LAN login code if available
+	// LAN Auth Blob Getter: Returns the LAN login code if available
 	public getLanLoginCode(): Uint8Array {
 		if (!this.tokenData?.lanLoginCode) {
 			this.log.debug('CyncClient: getLanLoginCode() → no LAN blob in token store.');
@@ -97,7 +217,7 @@ export class CyncClient {
 		);
 	}
 
-	// ### 🧩 LAN Login Code Builder
+	// LAN Login Code Builder
 	private buildLanLoginCode(authorize: string, userId: number): Uint8Array {
 		const authorizeBytes = Buffer.from(authorize, 'ascii');
 
@@ -321,12 +441,22 @@ export class CyncClient {
 	 *   // user reads email, gets code…
 	 *   await client.submitTwoFactor(username, password, code); // completes login
 	 */
-	// ### 🧩 Refresh Error Detector: identifies "Access-Token Expired" responses
+	// Refresh Error Detector: identifies "Access-Token Expired" responses
 	private isAccessTokenExpiredError(err: unknown): boolean {
-		if (!err || typeof err !== 'object') {
+		if (!err) {
 			return false;
 		}
 
+		// Most common case: ConfigClient throws a plain Error('Access-Token Expired')
+		if (err instanceof Error) {
+			if (
+				err.message === 'Access-Token Expired' ||
+				err.message.includes('Access-Token Expired')
+			) {
+				return true;
+			}
+		}
+
 		type ErrorWithShape = {
 			status?: number;
 			message?: string;
@@ -338,57 +468,82 @@ export class CyncClient {
 
 		const e = err as ErrorWithShape;
 
-		// Shape we see in logs:
+		// Shape we see in raw HTTP JSON:
 		// { error: { msg: 'Access-Token Expired', code: 4031021 } }
-		if (e.error && (e.error.msg === 'Access-Token Expired' || e.error.code === 4031021)) {
+		if (
+			e.error &&
+			(e.error.msg === 'Access-Token Expired' || e.error.code === 4031021)
+		) {
 			return true;
 		}
 
-		// Fallback: generic 403 with message string
-		if (e.status === 403 && e.message && e.message.includes('Access-Token Expired')) {
+		// Fallback: generic 403 plus message text
+		if (
+			e.status === 403 &&
+			e.message &&
+			e.message.includes('Access-Token Expired')
+		) {
 			return true;
 		}
 
 		return false;
 	}
 
-	// ### 🧩 Token Refresh Helper: exchanges refreshToken for a new accessToken
-	private async refreshAccessToken(stored: CyncTokenData): Promise<CyncTokenData | null> {
-		if (!stored.refreshToken) {
+	// Token Refresh Helper: exchanges refreshToken for a new accessToken, or falls back to password login
+	private async refreshAccessToken(
+		stored: CyncTokenData,
+	): Promise<CyncTokenData | null> {
+		// First, try refresh_token if we have one
+		if (stored.refreshToken) {
+			try {
+				const resp = await this.configClient.refreshAccessToken(
+					stored.refreshToken,
+				);
+
+				const next: CyncTokenData = {
+					...stored,
+					accessToken: resp.accessToken,
+					refreshToken: resp.refreshToken ?? stored.refreshToken,
+					expiresAt: resp.expiresAt ?? stored.expiresAt,
+				};
+
+				await this.tokenStore.save(next);
+				this.tokenData = next;
+				this.applyAccessToken(next);
+
+				this.log.info(
+					'CyncClient: refreshed access token for userId=%s; expiresAt=%s',
+					next.userId,
+					next.expiresAt
+						? new Date(next.expiresAt).toISOString()
+						: 'unknown',
+				);
+
+				return next;
+			} catch (err) {
+				this.log.error('CyncClient: token refresh failed: %o', err);
+				// fall through to password-based login below
+			}
+		} else {
 			this.log.warn(
-				'CyncClient: refreshAccessToken() called but no refreshToken is stored; cannot refresh.',
+				'CyncClient: refreshAccessToken() called but no refreshToken is stored; will attempt password-based login.',
 			);
-			return null;
 		}
 
-		try {
-			const resp = await this.configClient.refreshAccessToken(stored.refreshToken);
-
-			const next: CyncTokenData = {
-				...stored,
-				accessToken: resp.accessToken,
-				refreshToken: resp.refreshToken ?? stored.refreshToken,
-				expiresAt: resp.expiresAt ?? stored.expiresAt,
-			};
-
-			await this.tokenStore.save(next);
-			this.tokenData = next;
-			this.applyAccessToken(next);
-
-			this.log.info(
-				'CyncClient: refreshed access token for userId=%s; expiresAt=%s',
-				next.userId,
-				next.expiresAt ? new Date(next.expiresAt).toISOString() : 'unknown',
+		// If we get here, either we had no refreshToken or refresh failed.
+		// Attempt a background username/password login to obtain a fresh token.
+		const viaPassword = await this.loginWithPasswordForToken();
+		if (!viaPassword) {
+			this.log.error(
+				'CyncClient: password-based background login failed; cannot refresh Cync token automatically.',
 			);
-
-			return next;
-		} catch (err) {
-			this.log.error('CyncClient: token refresh failed: %o', err);
 			return null;
 		}
+
+		return viaPassword;
 	}
 
-	// ### 🧩 Cloud Config Wrapper: auto-refreshes access token
+	// Cloud Config Wrapper: auto-refreshes access token
 	private async getCloudConfigWithRefresh(): Promise<CyncCloudConfig> {
 		try {
 			return await this.configClient.getCloudConfig();
@@ -408,18 +563,33 @@ export class CyncClient {
 		}
 	}
 
-	// ### 🧩 Device Properties Wrapper: auto-refresh on Access-Token Expired for mesh calls
+	// Device Properties Wrapper: auto-refresh on Access-Token Expired for mesh calls
 	private async getDevicePropertiesWithRefresh(
 		productId: string | number,
 		meshId: string | number,
 	): Promise<Record<string, unknown>> {
-		// Normalise to strings for ConfigClient
 		const productIdStr = String(productId);
 		const meshIdStr = String(meshId);
 
+		// If we've already learned this product_id never supports the endpoint, skip.
+		if (this.unsupportedPropertiesProductIds.has(productIdStr)) {
+			return {};
+		}
+
 		try {
 			return await this.configClient.getDeviceProperties(productIdStr, meshIdStr);
 		} catch (err) {
+			// Expected case for some product lines: endpoint not implemented.
+			if (this.isDevicePropertyNotExistsError(err)) {
+				this.unsupportedPropertiesProductIds.add(productIdStr);
+				this.log.debug(
+					'CyncClient: properties unsupported for product_id=%s (mesh id=%s); caching and skipping.',
+					productIdStr,
+					meshIdStr,
+				);
+				return {};
+			}
+
 			if (this.isAccessTokenExpiredError(err) && this.tokenData) {
 				this.log.warn(
 					'CyncClient: access token expired when calling getDeviceProperties(); refreshing and retrying once.',
@@ -504,7 +674,7 @@ export class CyncClient {
 
 		// Debug: inspect per-mesh properties so we can find the real devices.
 		for (const mesh of cfg.meshes) {
-			const meshName = mesh.name ?? mesh.id;
+			const meshName = this.formatMeshLabel({ name: mesh.name, id: mesh.id });
 			const homeId = String(mesh.id);
 
 			this.log.debug(
@@ -517,7 +687,15 @@ export class CyncClient {
 			// Per-home maps, mirroring HA's CyncUserData.get_cync_config()
 			const homeDevices: string[] = [];
 			const homeControllers: number[] = [];
-
+			const productIdStr = String(mesh.product_id);
+			if (this.unsupportedPropertiesProductIds.has(productIdStr)) {
+				this.log.debug(
+					'CyncClient: skipping properties probe for mesh %s (product_id=%s) — previously marked unsupported.',
+					meshName,
+					productIdStr,
+				);
+				continue;
+			}
 			try {
 				const props = await this.getDevicePropertiesWithRefresh(
 					mesh.product_id,
@@ -541,7 +719,7 @@ export class CyncClient {
 						bulbsArray[0] ? Object.keys(bulbsArray[0] as Record<string, unknown>) : [],
 					);
 
-					// ### 🧩 Bulb Capability Debug: log each bulb so we can classify plugs vs lights
+					// Bulb Capability Debug: log each bulb so we can classify plugs vs lights
 					bulbsArray.forEach((bulb, index) => {
 						const record = bulb as Record<string, unknown>;
 
@@ -669,6 +847,15 @@ export class CyncClient {
 					);
 				}
 			} catch (err) {
+				if (this.isDevicePropertyNotExistsError(err)) {
+					this.log.debug(
+						'CyncClient: getDeviceProperties not supported for mesh %s (%s).',
+						meshName,
+						String(mesh.id),
+					);
+					continue;
+				}
+
 				this.log.warn(
 					'CyncClient: getDeviceProperties failed for mesh %s (%s): %s',
 					meshName,