eslint rule update

Author: raju-opti

eslint-local-rules/require-platform-declaration.js

@@ -1,28 +1,97 @@
 /**
  * ESLint Rule: require-platform-declaration
  * 
- * Ensures that all non-test source files export __supportedPlatforms
+ * Ensures that all non-test source files export __supportedPlatforms with valid platform values
  * 
  * Valid:
- *   export const __supportedPlatforms = ['browser'] as const;
- *   export const __supportedPlatforms = ['__universal__'] as const;
- *   export const __supportedPlatforms: Platform[] = ['browser', 'node'];
+ *   export const __supportedPlatforms = ['browser'];
+ *   export const __supportedPlatforms = ['__universal__'];
+ *   export const __supportedPlatforms = ['browser', 'node'];
  * 
  * Invalid:
  *   // Missing __supportedPlatforms export
+ *   // Invalid platform values (must match Platform type definition in platform_support.ts)
+ *   // Not exported as const array
  */
 
+const fs = require('fs');
+const path = require('path');
+const ts = require('typescript');
+
+// Cache for valid platforms
+let validPlatformsCache = null;
+
+function getValidPlatforms(context) {
+  if (validPlatformsCache) {
+    return validPlatformsCache;
+  }
+
+  try {
+    const filename = context.getFilename();
+    const workspaceRoot = filename.split('/lib/')[0];
+    const platformSupportPath = path.join(workspaceRoot, 'lib', 'platform_support.ts');
+    
+    if (fs.existsSync(platformSupportPath)) {
+      const content = fs.readFileSync(platformSupportPath, 'utf8');
+      const sourceFile = ts.createSourceFile(
+        platformSupportPath,
+        content,
+        ts.ScriptTarget.Latest,
+        true
+      );
+      
+      const platforms = [];
+      
+      // Visit all nodes in the AST
+      function visit(node) {
+        // Look for: export type Platform = 'browser' | 'node' | ...
+        if (ts.isTypeAliasDeclaration(node) && 
+            node.name.text === 'Platform' &&
+            node.modifiers?.some(m => m.kind === ts.SyntaxKind.ExportKeyword)) {
+          
+          // Parse the union type
+          if (ts.isUnionTypeNode(node.type)) {
+            for (const type of node.type.types) {
+              if (ts.isLiteralTypeNode(type) && ts.isStringLiteral(type.literal)) {
+                platforms.push(type.literal.text);
+              }
+            }
+          }
+        }
+        
+        ts.forEachChild(node, visit);
+      }
+      
+      visit(sourceFile);
+      
+      if (platforms.length > 0) {
+        validPlatformsCache = platforms;
+        return validPlatformsCache;
+      }
+    }
+  } catch (error) {
+    // Fallback to hardcoded values if parsing fails
+    console.warn('Could not parse platform_support.ts, using fallback values:', error.message);
+  }
+  
+  // Fallback to default platforms
+  validPlatformsCache = ['browser', 'node', 'react_native', '__universal__'];
+  return validPlatformsCache;
+}
+
 module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'Require __supportedPlatforms export in all source files',
+      description: 'Require __supportedPlatforms export with valid platform values in all source files',
       category: 'Best Practices',
       recommended: true,
     },
     messages: {
-      missingPlatformDeclaration: 'File must export __supportedPlatforms to declare which platforms it supports. Example: export const __supportedPlatforms = [\'__universal__\'] as const;',
-      invalidPlatformDeclaration: '__supportedPlatforms must be exported as a const array. Example: export const __supportedPlatforms = [\'browser\', \'node\'] as const;',
+      missingPlatformDeclaration: 'File must export __supportedPlatforms to declare which platforms it supports. Example: export const __supportedPlatforms = [\'__universal__\'];',
+      invalidPlatformDeclaration: '__supportedPlatforms must be exported as a const array. Example: export const __supportedPlatforms = [\'browser\', \'node\'];',
+      invalidPlatformValue: '__supportedPlatforms contains invalid platform value "{{value}}". Valid platforms are: {{validPlatforms}}',
+      emptyPlatformArray: '__supportedPlatforms array cannot be empty. Specify at least one platform or use [\'__universal__\']',
     },
     schema: [],
   },
@@ -49,8 +118,8 @@ module.exports = {
       return {};
     }
 
+    const VALID_PLATFORMS = getValidPlatforms(context);
     let hasPlatformExport = false;
-    let isValidExport = false;
 
     return {
       ExportNamedDeclaration(node) {
@@ -73,7 +142,7 @@ module.exports = {
                 return;
               }
 
-              // Validate it's an array
+              // Validate it's an array expression
               let init = declarator.init;
 
               // Handle TSAsExpression: [...] as const
@@ -86,13 +155,43 @@ module.exports = {
                 init = init.expression;
               }
 
-              if (init && init.type === 'ArrayExpression') {
-                isValidExport = true;
-              } else {
+              if (!init || init.type !== 'ArrayExpression') {
                 context.report({
                   node: declarator,
                   messageId: 'invalidPlatformDeclaration',
                 });
+                return;
+              }
+              
+              // Check if array is empty
+              if (init.elements.length === 0) {
+                context.report({
+                  node: init,
+                  messageId: 'emptyPlatformArray',
+                });
+                return;
+              }
+              
+              // Validate each array element is a valid platform string
+              for (const element of init.elements) {
+                if (element && element.type === 'Literal' && typeof element.value === 'string') {
+                  if (!VALID_PLATFORMS.includes(element.value)) {
+                    context.report({
+                      node: element,
+                      messageId: 'invalidPlatformValue',
+                      data: { 
+                        value: element.value,
+                        validPlatforms: VALID_PLATFORMS.map(p => `'${p}'`).join(', ')
+                      }
+                    });
+                  }
+                } else {
+                  // Not a string literal
+                  context.report({
+                    node: element || init,
+                    messageId: 'invalidPlatformDeclaration',
+                  });
+                }
               }
             }
           }

lib/client_factory.ts

@@ -29,7 +29,7 @@ import { InMemoryLruCache } from "./utils/cache/in_memory_lru_cache";
 import { transformCache, CacheWithRemove } from "./utils/cache/cache";
 import { ConstantBackoff } from "./utils/repeater/repeater";
 
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __supportedPlatforms = ['__universal__'];
 
 export type OptimizelyFactoryConfig = Config & {
   requestHandler: RequestHandler;

lib/common_exports.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __supportedPlatforms = ['__universal__'];
 
 export { createStaticProjectConfigManager } from './project_config/config_manager_factory';
 

lib/core/audience_evaluator/index.ts

@@ -21,7 +21,7 @@ import { CONDITION_EVALUATOR_ERROR, UNKNOWN_CONDITION_TYPE } from 'error_message
 import { AUDIENCE_EVALUATION_RESULT, EVALUATING_AUDIENCE} from 'log_message';
 import { LoggerFacade } from '../../logging/logger';
 
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __supportedPlatforms = ['__universal__'];
 
 export class AudienceEvaluator {
   private logger?: LoggerFacade;

lib/core/audience_evaluator/odp_segment_condition_evaluator/index.ts

@@ -17,7 +17,7 @@ import { UNKNOWN_MATCH_TYPE } from 'error_message';
 import { LoggerFacade } from '../../../logging/logger';
 import { Condition, OptimizelyUserContext } from '../../../shared_types';
 
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __supportedPlatforms = ['__universal__'];
 
 const QUALIFIED_MATCH_TYPE = 'qualified';
 

lib/core/bucketer/bucket_value_generator.ts

@@ -17,7 +17,7 @@ import murmurhash from 'murmurhash';
 import { INVALID_BUCKETING_ID } from 'error_message';
 import { OptimizelyError } from '../../error/optimizly_error';
 
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __supportedPlatforms = ['__universal__'];
 
 const HASH_SEED = 1;
 const MAX_HASH_VALUE = Math.pow(2, 32);

lib/core/bucketer/index.ts

@@ -29,7 +29,7 @@ import { OptimizelyError } from '../../error/optimizly_error';
 import { generateBucketValue } from './bucket_value_generator';
 import { DecisionReason } from '../decision_service';
 
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __supportedPlatforms = ['__universal__'];
 
 export const USER_NOT_IN_ANY_EXPERIMENT = 'User %s is not in any experiment of group %s.';
 export const USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP = 'User %s is not in experiment %s of group %s.';

lib/core/condition_tree_evaluator/index.ts

@@ -14,7 +14,7 @@
  * limitations under the License.                                           *
  ***************************************************************************/
 
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __supportedPlatforms = ['__universal__'];
 
 const AND_CONDITION = 'and';
 const OR_CONDITION = 'or';

lib/core/decision/index.ts

@@ -21,7 +21,7 @@ import { DecisionObj } from '../decision_service';
  * @param   {DecisionObj} decisionObj       Object representing decision
  * @returns {string}                        Experiment key or empty string if experiment is null
  */
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __supportedPlatforms = ['__universal__'];
 
 
 export function getExperimentKey(decisionObj: DecisionObj): string {

lib/core/decision_service/cmab/cmab_client.ts

@@ -24,7 +24,7 @@ import { isSuccessStatusCode } from "../../../utils/http_request_handler/http_ut
 import { BackoffController } from "../../../utils/repeater/repeater";
 import { Producer } from "../../../utils/type";
 
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __supportedPlatforms = ['__universal__'];
 
 export interface CmabClient {
   fetchDecision(