TanStack / TanStack/table

Custom sortingFn not being run when row key is undefined

Abierto
#5,653 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
TypeScript
Estrellas
28.4k
Forks
3.6k
Merge medio
1 d 14 h
PR fusionados (30 d)
10

Descripción

TanStack Table version

8.19.2

Framework/Library version

Vue 3.4.31

Describe the bug and the steps to reproduce it

I was debating whether to even post this issue or not, since it's such a narrow edge case and is mostly inconsequential. But here it is.

My custom sortingFn is was not being run when changing the sort direction of certain columns. I was adding things to the sort func to handle the order of nullish values, and it wasn't having any effect because the function wasn't even being run. Luckily this isn't super important, as the sortUndefined met my needs in this case, but I still think this is a bug.

I can't nail down the exact conditions that cause this, but I think this happens when:

  • there are only 2 rows
  • one of the rows object doesn't have the key that is being sorted by

See the reproducible example. Look at the console logs while clicking on the different columns. The first static column triggers the sorting func. The other two columns do not, unless you add a third row or define the key for the other row.

Reproducible example code for posterity
<template>
  <table>
    <thead>
      <tr v-for="headerGroup in table.getHeaderGroups()" :key="headerGroup.id">
        <th
          v-for="header in headerGroup.headers"
          :key="header.id"
          :colSpan="header.colSpan"
          @click="header.column.getToggleSortingHandler()?.($event)"
        >
          <FlexRender
            :render="header.column.columnDef.header"
            :props="header.getContext()"
          />
          <span v-if="header.column.getIsSorted() === 'desc'"> v</span>
          <span v-else-if="header.column.getIsSorted() === 'asc'"> ^</span>
          <span v-else> -</span>
        </th>
      </tr>
    </thead>

    <tbody>
      <tr v-for="row in table.getRowModel().rows" :key="row.id">
        <td v-for="cell in row.getVisibleCells()" :key="cell.id">
          <FlexRender
            :render="cell.column.columnDef.cell"
            :props="cell.getContext()"
          />
        </td>
      </tr>
    </tbody>
  </table>
</template>

<script lang="ts">
type Cell = Record<string, unknown>;

export type Cols<Rows extends Cell[] = Cell[]> = {
  key: Extract<keyof Rows[number], string>;
  name: string;
}[];
</script>

<script setup lang="ts" generic="Rows extends Cell[]">
import { computed } from "vue";
import {
  createColumnHelper,
  FlexRender,
  getCoreRowModel,
  getFacetedMinMaxValues,
  getFacetedRowModel,
  getFacetedUniqueValues,
  getFilteredRowModel,
  getPaginationRowModel,
  getSortedRowModel,
  useVueTable,
  type Row as TanstackRow,
} from "@tanstack/vue-table";
import type { SortingFn } from "@tanstack/vue-table";

type Props = {
  cols: Cols<Rows>;
  rows: Rows;
};

const props = defineProps<Props>();

type Row = Rows[number];

const columnHelper = createColumnHelper<Row>();

const sortingFunction: SortingFn<Row> = (
  a: TanstackRow<Row>,
  b: TanstackRow<Row>,
) => {
  console.log("sort");
  if (a < b) return -1;
  if (a > b) return 1;
  return 0;
};

const columns = computed(() =>
  props.cols.map((col) =>
    columnHelper.accessor((row: Row) => row[col.key], {
      id: col.key,
      header: col.name,
      enableSorting: true,
      sortingFn: sortingFunction,
    }),
  ),
);

const table = useVueTable({
  get data() {
    return props.rows;
  },
  get columns() {
    return columns.value;
  },
  getCoreRowModel: getCoreRowModel(),
  getFilteredRowModel: getFilteredRowModel(),
  getPaginationRowModel: getPaginationRowModel(),
  getSortedRowModel: getSortedRowModel(),
  getFacetedRowModel: getFacetedRowModel(),
  getFacetedUniqueValues: getFacetedUniqueValues(),
  getFacetedMinMaxValues: getFacetedMinMaxValues(),
  initialState: {
    pagination: {
      pageIndex: 0,
      pageSize: 999999,
    },
  },
});
</script>
<script setup lang="ts">
import AppTable from "./components/AppTable.vue";

const rows = [
  { static: "test", abc: 123 },
  { static: "test", def: 456 },
  // { static: "test", abc: 789 },
];

const cols = [
  { key: "static", name: "Static" },
  { key: "abc", name: "ABC" },
  { key: "def", name: "DEF" },
];
</script>

<template>
  <AppTable :rows="rows" :cols="cols" />
</template>
Your Minimal, Reproducible Example - (Sandbox Highly Recommended)

https://codesandbox.io/p/devbox/tanstack-table-sorting-bug-782h9d

Do you intend to try to help solve this bug with your own PR?

No, because I do not know how

Terms & Code of Conduct
  • I agree to follow this project's Code of Conduct
  • I understand that if my bug cannot be reliable reproduced in a debuggable environment, it will probably not be fixed and this issue may even be closed.

sortUndefined met my needs here, but I was also able to force the sortingFn to run by making sure every row being returned from get data() { return props.rows; } has every col key defined:

const _rows = computed(() => {
  /** row with all possible object keys at least defined */
  const blankRow = Object.fromEntries(props.cols.map((col) => [col.key, ""]));

  return props.rows.map((row) => ({
    /** start with blank row */
    ...cloneDeep(blankRow), // lodash cloneDeep
    /** add actual row data */
    ...row,
  }));
});

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con la reproducción enlazada de CodeSandbox y la ruta de ordenación de getSortedRowModel, comparando las columnas cuyas filas omiten la clave accedida con la columna estática. Se considera completado cuando se invoca la sortingFn personalizada al cambiar la dirección de ordenación para esas columnas, con cobertura para el caso de dos filas con undefined-key.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
frontend
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.