better type assertions

Author: lerouxb

packages/compass-smoke-tests/src/build-info.ts

@@ -12,11 +12,10 @@ const SUPPORTED_CHANNELS = ['dev', 'beta', 'stable'] as const;
 
 export type Channel = typeof SUPPORTED_CHANNELS[number];
 
-function assertObjectHasKeys(
-  obj: unknown,
-  name: string,
-  keys: readonly string[]
-) {
+function assertObjectHasKeys<
+  Keys extends readonly string[],
+  Obj extends Record<Keys[number], unknown>
+>(obj: unknown, name: string, keys: Keys): asserts obj is Obj {
   assert(
     typeof obj === 'object' && obj !== null,
     'Expected buildInfo to be an object'
@@ -39,10 +38,10 @@ export function assertCommonBuildInfo(
 ): asserts buildInfo is CommonBuildInfo {
   assertObjectHasKeys(buildInfo, 'buildInfo', commonKeys);
   assert(
-    SUPPORTED_CHANNELS.includes((buildInfo as { channel: Channel }).channel),
-    `Expected ${
-      (buildInfo as { channel: Channel }).channel
-    } to be in ${SUPPORTED_CHANNELS.join(',')}`
+    SUPPORTED_CHANNELS.includes(buildInfo.channel as Channel),
+    `Expected ${JSON.stringify(
+      buildInfo.channel
+    )} to be in ${SUPPORTED_CHANNELS.join(',')}`
   );
 }