Skip to content

fix (Models): Escape non-standard table names #6903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions web-common/src/features/connectors/olap/createModel.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
import { fileArtifacts } from "@rilldata/web-common/features/entity-management/file-artifacts";
import { getName } from "@rilldata/web-common/features/entity-management/name-utils";
import {
getName,
isNonStandardIdentifier,
} from "@rilldata/web-common/features/entity-management/name-utils";
import { ResourceKind } from "@rilldata/web-common/features/entity-management/resource-selectors";
import { eventBus } from "@rilldata/web-common/lib/event-bus/event-bus";
import { QueryClient } from "@tanstack/svelte-query";
import { get } from "svelte/store";
import { hasSpaces } from "../../../lib/string-utils";
import {
getRuntimeServiceAnalyzeConnectorsQueryKey,
getRuntimeServiceGetInstanceQueryKey,
Expand Down Expand Up @@ -77,7 +79,9 @@ export async function createModelFromTable(
const topComments =
"-- Model SQL\n-- Reference documentation: https://docs.rilldata.com/reference/project-files/models";
const connectorLine = `-- @connector: ${connector}`;
const selectStatement = hasSpaces(sufficientlyQualifiedTableName)
const selectStatement = isNonStandardIdentifier(
sufficientlyQualifiedTableName,
)
? `select * from "${sufficientlyQualifiedTableName}"`
: `select * from ${sufficientlyQualifiedTableName}`;
const devLimit = "{{ if dev }} limit 100000 {{ end}}";
Expand Down
20 changes: 11 additions & 9 deletions web-common/src/features/dashboards/url-state/filters/converters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ import {
type V1Expression,
V1Operation,
} from "@rilldata/web-common/runtime-client";
import grammar from "./expression.cjs";
import nearley from "nearley";
import { isNonStandardIdentifier } from "../../../entity-management/name-utils";
import grammar from "./expression.cjs";

const compiledGrammar = nearley.Grammar.fromCompiled(grammar);
export function convertFilterParamToExpression(filter: string) {
Expand All @@ -13,7 +14,6 @@ export function convertFilterParamToExpression(filter: string) {
return parser.results[0] as V1Expression;
}

const NonStandardName = /^[a-zA-Z][a-zA-Z0-9_]*$/;
export function convertExpressionToFilterParam(
expr: V1Expression,
depth = 0,
Expand Down Expand Up @@ -108,13 +108,15 @@ function convertBinaryExpressionToFilterParam(
}

function escapeColumnName(columnName: string) {
// if name doesnt have any special chars do not surround it by quotes.
// this makes the url more readable
if (NonStandardName.test(columnName)) return columnName;
const escapedColumnName = columnName
.replace(/\\/g, "\\\\")
.replace(/"/g, '\\"');
return `"${escapedColumnName}"`;
if (isNonStandardIdentifier(columnName)) {
const escapedColumnName = columnName
.replace(/\\/g, "\\\\")
.replace(/"/g, '\\"');
return `"${escapedColumnName}"`;
}

// If name doesn't have any special characters, do not surround it by quotes.
return columnName;
}

function escapeValue(value: unknown) {
Expand Down
12 changes: 12 additions & 0 deletions web-common/src/features/entity-management/name-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,15 @@ export function isDuplicateName(
export function sanitizeEntityName(entityName: string): string {
return entityName.replace(INVALID_CHARS, "_");
}

/**
* Determines if a name doesn't follow standard identifier rules and would
* require escaping/quoting in SQL or other database contexts.
*
* @param name The string to check
* @returns true if the name doesn't follow standard identifier rules (must start with a letter and contain only letters, numbers, and underscores)
*/
export function isNonStandardIdentifier(name: string): boolean {
const standardIdentifierPattern = /^[a-zA-Z][a-zA-Z0-9_]*$/;
return !standardIdentifierPattern.test(name);
}
3 changes: 0 additions & 3 deletions web-common/src/lib/string-utils.ts

This file was deleted.

Loading