@fairfox/polly 0.7.0 → 0.7.2

package/dist/tools/verify/src/cli.js

@@ -687,6 +687,17 @@ class TLAGenerator {
     return isFirst;
   }
   addStateType(config, _analysis) {
+    this.defineValueTypes();
+    this.line("\\* Application state type definition");
+    this.line("State == [");
+    this.indent++;
+    const stateFields = this.collectStateFields(config, _analysis);
+    this.writeStateFields(stateFields);
+    this.indent--;
+    this.line("]");
+    this.line("");
+  }
+  defineValueTypes() {
     this.line("\\* Generic value type for sequences and maps");
     this.line("\\* Bounded to allow model checking");
     this.line('Value == {"v1", "v2", "v3"}');
@@ -695,9 +706,8 @@ class TLAGenerator {
     this.line("\\* Bounded to allow model checking");
     this.line('Keys == {"k1", "k2", "k3"}');
     this.line("");
-    this.line("\\* Application state type definition");
-    this.line("State == [");
-    this.indent++;
+  }
+  collectStateFields(config, _analysis) {
     const stateFields = [];
     for (const [fieldPath, fieldConfig] of Object.entries(config.state)) {
       if (typeof fieldConfig !== "object" || fieldConfig === null)
@@ -707,24 +717,26 @@ class TLAGenerator {
       stateFields.push(`${fieldName}: ${tlaType}`);
     }
     for (const fieldAnalysis of _analysis.fields) {
-      if (!fieldAnalysis.path || typeof fieldAnalysis.path !== "string") {
+      if (!fieldAnalysis.path || typeof fieldAnalysis.path !== "string")
         continue;
-      }
       const fieldName = this.sanitizeFieldName(fieldAnalysis.path);
-      if (stateFields.some((f) => f.startsWith(`${fieldName}:`))) {
+      if (stateFields.some((f) => f.startsWith(`${fieldName}:`)))
         continue;
-      }
       const tlaType = this.inferTLATypeFromAnalysis(fieldAnalysis);
       stateFields.push(`${fieldName}: ${tlaType}`);
     }
-    for (let i = 0;i < stateFields.length; i++) {
-      const field = stateFields[i];
-      const suffix = i < stateFields.length - 1 ? "," : "";
+    return stateFields;
+  }
+  writeStateFields(fields) {
+    if (fields.length === 0) {
+      this.line("dummy: BOOLEAN  \\* Placeholder for empty state");
+      return;
+    }
+    for (let i = 0;i < fields.length; i++) {
+      const field = fields[i];
+      const suffix = i < fields.length - 1 ? "," : "";
       this.line(`${field}${suffix}`);
     }
-    this.indent--;
-    this.line("]");
-    this.line("");
   }
   addMessageTypes(_config, analysis) {
     if (analysis.messageTypes.length === 0) {
@@ -765,6 +777,20 @@ class TLAGenerator {
     this.line("\\* Initial application state");
     this.line("InitialState == [");
     this.indent++;
+    const fields = this.collectInitialStateFields(config, _analysis);
+    this.writeInitialStateFields(fields);
+    this.indent--;
+    this.line("]");
+    this.line("");
+    this.line("\\* Initial state (extends MessageRouter)");
+    this.line("UserInit ==");
+    this.indent++;
+    this.line("/\\ Init  \\* MessageRouter's init");
+    this.line("/\\ contextStates = [c \\in Contexts |-> InitialState]");
+    this.indent--;
+    this.line("");
+  }
+  collectInitialStateFields(config, _analysis) {
     const fields = [];
     for (const [fieldPath, fieldConfig] of Object.entries(config.state)) {
       if (typeof fieldConfig !== "object" || fieldConfig === null)
@@ -774,31 +800,26 @@ class TLAGenerator {
       fields.push(`${fieldName} |-> ${initialValue}`);
     }
     for (const fieldAnalysis of _analysis.fields) {
-      if (!fieldAnalysis.path || typeof fieldAnalysis.path !== "string") {
+      if (!fieldAnalysis.path || typeof fieldAnalysis.path !== "string")
         continue;
-      }
       const fieldName = this.sanitizeFieldName(fieldAnalysis.path);
-      if (fields.some((f) => f.startsWith(`${fieldName} |->`))) {
+      if (fields.some((f) => f.startsWith(`${fieldName} |->`)))
         continue;
-      }
       const initialValue = this.getInitialValueFromAnalysis(fieldAnalysis);
       fields.push(`${fieldName} |-> ${initialValue}`);
     }
+    return fields;
+  }
+  writeInitialStateFields(fields) {
+    if (fields.length === 0) {
+      this.line("dummy |-> FALSE  \\* Placeholder for empty state");
+      return;
+    }
     for (let i = 0;i < fields.length; i++) {
       const field = fields[i];
       const suffix = i < fields.length - 1 ? "," : "";
       this.line(`${field}${suffix}`);
     }
-    this.indent--;
-    this.line("]");
-    this.line("");
-    this.line("\\* Initial state (extends MessageRouter)");
-    this.line("UserInit ==");
-    this.indent++;
-    this.line("/\\ Init  \\* MessageRouter's init");
-    this.line("/\\ contextStates = [c \\in Contexts |-> InitialState]");
-    this.indent--;
-    this.line("");
   }
   addActions(config, analysis) {
     this.line("\\* =============================================================================");
@@ -3715,11 +3736,24 @@ class TypeExtractor {
     const stateType = stateFilePath ? this.extractStateType(stateFilePath) : this.findStateType();
     const messageTypes = this.findMessageTypes();
     const fields = stateType ? this.analyzeFields(stateType) : [];
+    const handlerAnalysis = this.extractHandlerAnalysis();
+    const validMessageTypes = this.filterAndLogMessageTypes(messageTypes, handlerAnalysis.messageTypes);
+    const validHandlers = this.filterAndLogHandlers(handlerAnalysis.handlers);
+    return {
+      stateType,
+      messageTypes: validMessageTypes,
+      fields,
+      handlers: validHandlers
+    };
+  }
+  extractHandlerAnalysis() {
     const configFilePath = this.project.getCompilerOptions()["configFilePath"];
     const tsConfigPath = typeof configFilePath === "string" ? configFilePath : "tsconfig.json";
     const handlerExtractor = new HandlerExtractor(tsConfigPath);
-    const handlerAnalysis = handlerExtractor.extractHandlers();
-    const allMessageTypes = Array.from(new Set([...messageTypes, ...handlerAnalysis.messageTypes]));
+    return handlerExtractor.extractHandlers();
+  }
+  filterAndLogMessageTypes(messageTypes, handlerMessageTypes) {
+    const allMessageTypes = Array.from(new Set([...messageTypes, ...handlerMessageTypes]));
     const validMessageTypes = [];
     const invalidMessageTypes = [];
     for (const msgType of allMessageTypes) {
@@ -3729,18 +3763,32 @@ class TypeExtractor {
         invalidMessageTypes.push(msgType);
       }
     }
-    if (invalidMessageTypes.length > 0 && process.env["POLLY_DEBUG"]) {
-      console.log(`[WARN] Filtered out ${invalidMessageTypes.length} invalid message type(s):`);
-      for (const invalid of invalidMessageTypes) {
-        console.log(`[WARN]   - "${invalid}" (not a valid TLA+ identifier)`);
+    this.logInvalidMessageTypes(invalidMessageTypes);
+    return validMessageTypes;
+  }
+  logInvalidMessageTypes(invalidMessageTypes) {
+    if (invalidMessageTypes.length === 0 || !process.env["POLLY_DEBUG"])
+      return;
+    console.log(`[WARN] Filtered out ${invalidMessageTypes.length} invalid message type(s):`);
+    for (const invalid of invalidMessageTypes) {
+      console.log(`[WARN]   - "${invalid}" (not a valid TLA+ identifier)`);
+    }
+  }
+  filterAndLogHandlers(handlers) {
+    const validHandlers = handlers.filter((h) => this.isValidTLAIdentifier(h.messageType));
+    this.logInvalidHandlers(handlers, validHandlers);
+    return validHandlers;
+  }
+  logInvalidHandlers(allHandlers, validHandlers) {
+    const filteredHandlerCount = allHandlers.length - validHandlers.length;
+    if (filteredHandlerCount === 0 || !process.env["POLLY_DEBUG"])
+      return;
+    console.log(`[WARN] Filtered out ${filteredHandlerCount} handler(s) with invalid message types:`);
+    for (const handler of allHandlers) {
+      if (!this.isValidTLAIdentifier(handler.messageType)) {
+        console.log(`[WARN]   - Handler for "${handler.messageType}" at ${handler.location.file}:${handler.location.line}`);
       }
     }
-    return {
-      stateType,
-      messageTypes: validMessageTypes,
-      fields,
-      handlers: handlerAnalysis.handlers
-    };
   }
   isValidTLAIdentifier(s) {
     if (!s || s.length === 0) {
@@ -4499,4 +4547,4 @@ main().catch((error) => {
   process.exit(1);
 });
 
-//# debugId=0953A65126AAFD2664756E2164756E21
+//# debugId=6EFAE591D90C88BD64756E2164756E21