Hide type models for Ruby in non-canary mode

Author: koesie10

extensions/ql-vscode/src/model-editor/languages/models-as-data.ts

@@ -19,6 +19,10 @@ import type { AccessPathSuggestionRow } from "../suggestions";
 
 type GenerateMethodDefinition<T> = (method: T) => DataTuple[];
 type ReadModeledMethod = (row: DataTuple[]) => ModeledMethod;
+type IsHiddenContext = {
+  method: MethodDefinition;
+  isCanary: boolean;
+};
 
 export type ModelsAsDataLanguagePredicate<T> = {
   extensiblePredicate: string;
@@ -30,6 +34,14 @@ export type ModelsAsDataLanguagePredicate<T> = {
   supportedEndpointTypes?: EndpointType[];
   generateMethodDefinition: GenerateMethodDefinition<T>;
   readModeledMethod: ReadModeledMethod;
+
+  /**
+   * Controls whether this predicate is hidden for a certain method. This only applies to the UI.
+   * If not specified, the predicate is visible for all methods.
+   *
+   * @param method The method to check if the predicate is hidden for.
+   */
+  isHidden?: (context: IsHiddenContext) => boolean;
 };
 
 type ParseGenerationResults = (

extensions/ql-vscode/src/model-editor/languages/ruby/index.ts

@@ -169,6 +169,8 @@ export const ruby: ModelsAsDataLanguage = {
           methodParameters: "",
         };
       },
+      // Hide for all non-canary users
+      isHidden: ({ isCanary }) => !isCanary,
     },
   },
   modelGeneration: {

extensions/ql-vscode/src/model-editor/method-modeling/method-modeling-view-provider.ts

@@ -11,6 +11,7 @@ import type { ModelingStore } from "../modeling-store";
 import { AbstractWebviewViewProvider } from "../../common/vscode/abstract-webview-view-provider";
 import { assertNever } from "../../common/helpers-pure";
 import type { ModelConfigListener } from "../../config";
+import { isCanary } from "../../config";
 import type { DatabaseItem } from "../../databases/local-databases";
 import type { ModelingEvents } from "../modeling-events";
 import type { QueryLanguage } from "../../common/query-language";
@@ -46,6 +47,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
       t: "setMethodModelingPanelViewState",
       viewState: {
         language: this.language,
+        isCanary: isCanary(),
       },
     });
   }

extensions/ql-vscode/src/model-editor/model-editor-view.ts

@@ -40,6 +40,7 @@ import type { Method } from "./method";
 import type { ModeledMethod } from "./modeled-method";
 import type { ExtensionPack } from "./shared/extension-pack";
 import type { ModelConfigListener } from "../config";
+import { isCanary } from "../config";
 import { Mode } from "./shared/mode";
 import { loadModeledMethods, saveModeledMethods } from "./modeled-method-fs";
 import { pickExtensionPack } from "./extension-pack-picker";
@@ -450,6 +451,7 @@ export class ModelEditorView extends AbstractWebview<
         mode: this.modelingStore.getMode(this.databaseItem),
         showModeSwitchButton,
         sourceArchiveAvailable,
+        isCanary: isCanary(),
       },
     });
   }

extensions/ql-vscode/src/model-editor/shared/view-state.ts

@@ -11,8 +11,10 @@ export interface ModelEditorViewState {
   mode: Mode;
   showModeSwitchButton: boolean;
   sourceArchiveAvailable: boolean;
+  isCanary: boolean;
 }
 
 export interface MethodModelingPanelViewState {
   language: QueryLanguage | undefined;
+  isCanary: boolean;
 }

extensions/ql-vscode/src/stories/method-modeling/MethodModelingInputs.stories.tsx

@@ -34,6 +34,7 @@ const Template: StoryFn<typeof MethodModelingInputsComponent> = (args) => {
       language={QueryLanguage.Java}
       modeledMethod={m}
       onChange={onChange}
+      isCanary={true}
     />
   );
 };

extensions/ql-vscode/src/view/method-modeling/MethodModeling.tsx

@@ -50,6 +50,7 @@ const UnsavedTag = ({ modelingStatus }: { modelingStatus: ModelingStatus }) => (
 
 export type MethodModelingProps = {
   language: QueryLanguage;
+  isCanary: boolean;
   modelingStatus: ModelingStatus;
   method: Method;
   modeledMethods: ModeledMethod[];
@@ -60,6 +61,7 @@ export type MethodModelingProps = {
 
 export const MethodModeling = ({
   language,
+  isCanary,
   modelingStatus,
   modeledMethods,
   method,
@@ -80,6 +82,7 @@ export const MethodModeling = ({
       </DependencyContainer>
       <MultipleModeledMethodsPanel
         language={language}
+        isCanary={isCanary}
         method={method}
         modeledMethods={modeledMethods}
         isModelingInProgress={isModelingInProgress}

extensions/ql-vscode/src/view/method-modeling/MethodModelingInputs.tsx

@@ -24,6 +24,7 @@ const Name = styled.span`
 
 export type MethodModelingInputsProps = {
   language: QueryLanguage;
+  isCanary: boolean;
   method: Method;
   modeledMethod: ModeledMethod | undefined;
   modelPending: boolean;
@@ -33,6 +34,7 @@ export type MethodModelingInputsProps = {
 
 export const MethodModelingInputs = ({
   language,
+  isCanary,
   method,
   modeledMethod,
   modelPending,
@@ -55,7 +57,7 @@ export const MethodModelingInputs = ({
           {isModelingInProgress ? (
             <InProgressDropdown />
           ) : (
-            <ModelTypeDropdown {...inputProps} />
+            <ModelTypeDropdown isCanary={isCanary} {...inputProps} />
           )}
         </Input>
       </Container>

extensions/ql-vscode/src/view/method-modeling/MethodModelingView.tsx

@@ -116,6 +116,7 @@ export function MethodModelingView({
   return (
     <MethodModeling
       language={viewState?.language}
+      isCanary={viewState?.isCanary ?? false}
       modelingStatus={modelingStatus}
       method={method}
       modeledMethods={modeledMethods}

extensions/ql-vscode/src/view/method-modeling/MultipleModeledMethodsPanel.tsx

@@ -19,6 +19,7 @@ import type { ModelingStatus } from "../../model-editor/shared/modeling-status";
 
 export type MultipleModeledMethodsPanelProps = {
   language: QueryLanguage;
+  isCanary: boolean;
   method: Method;
   modeledMethods: ModeledMethod[];
   modelingStatus: ModelingStatus;
@@ -61,6 +62,7 @@ const ModificationActions = styled.div`
 
 export const MultipleModeledMethodsPanel = ({
   language,
+  isCanary,
   method,
   modeledMethods,
   modelingStatus,
@@ -157,6 +159,7 @@ export const MultipleModeledMethodsPanel = ({
       {modeledMethods.length > 0 ? (
         <MethodModelingInputs
           language={language}
+          isCanary={isCanary}
           method={method}
           modeledMethod={modeledMethods[selectedIndex]}
           modelPending={isModelPending(
@@ -170,6 +173,7 @@ export const MultipleModeledMethodsPanel = ({
       ) : (
         <MethodModelingInputs
           language={language}
+          isCanary={isCanary}
           method={method}
           modeledMethod={undefined}
           modelPending={isModelPending(