Zum Inhalt springen

Upgrading

Upgrade von 0.18 auf 0.21

0.21.0 ist veröffentlicht. Dies sind die ### Breaking-Einträge des zugehörigen Changelog-Abschnitts, einzeln aufgeführt mit den jeweils erforderlichen Änderungen. 0.19 und 0.20 enthalten keine Breaking Changes, daher ist dies ein einziger Schritt von 0.18 – lesen Sie diesen Leitfaden vor dem Wechsel auf 0.21, nicht danach.

In beiden Fällen handelt es sich um Kompilierungsfehler statt um stillschweigende Verhaltensänderungen: Der Build weist auf jede Zeile hin, die bearbeitet werden muss, und der grep-Befehl unter jedem Abschnitt findet sie noch vor dem Build.


31. context.client.data kompiliert in einem Collection-Callback nicht mehr

Abschnitt betitelt „31. context.client.data kompiliert in einem Collection-Callback nicht mehr“

RebaseCallContext["client"] ist jetzt RebaseCallbackClient: RebaseClient ohne data. Serverseitig ist dieser Client das rebase-Singleton, welches seit 0.18 kein data mehr besitzt. Daher kompilierte context.client.data.collection(…) zwar, warf dann aber bei jedem Aufruf Cannot read properties of undefined (reading 'collection'). Nun ist es stattdessen ein Kompilierungsfehler.

Was zu ändern ist: Führen Sie Abfragen über context.data aus, dem Accessor, den Abfragen eines Callbacks von vornherein nutzen sollten. Er wird mit den Rechten dessen ausgeführt, was den Callback ausgelöst hat, und zwar innerhalb der Transaktion des Schreibvorgangs selbst. Der Callbacks-Leitfaden beschreibt, worauf die einzelnen Accessoren des Kontexts zugreifen können.

afterSave: async ({ context }) => {
await context.client.data.audit_logs.create({ action: "approved" });
await context.data.audit_logs.create({ action: "approved" });
}
grep -rn "client\.data\b" config

context.client.dataAsAdmin ist weiterhin vorhanden für Callbacks, die sehen müssen, was ein Administrator sehen darf. admin.browserCallbacks ändert sich ebenfalls: Die alte Schreibweise funktionierte dort, da der Client des Panels data bereitstellt, kompiliert nun aber gleichermaßen nicht mehr. useRebaseContext().client in einer React-Komponente behält sein data.

32. selectedEntities wurde entfernt: Eine Auswahl besteht aus Zeilen oder einer Query

Abschnitt betitelt „32. selectedEntities wurde entfernt: Eine Auswahl besteht aus Zeilen oder einer Query“

Eine Collection-Ansicht kann nun jede Zeile auswählen, die ihrem Filter entspricht, nicht nur die bereits geladenen Zeilen. Daher gibt SelectionController kein Entity[] mehr zurück. selectionController.selection ist eine EntitySelection-Union: { type: "entities", entities } für manuell angehakte Zeilen oder { type: "query", query, excluded, count? } für jede Zeile, die einer Query entspricht, von denen die meisten noch gar nicht gelesen wurden.

Was zu ändern ist: Eine benutzerdefinierte Aktion, die die Auswahl ausliest, wandelt diese mit resolveSelection aus @rebasepro/cms in Zeilen um. Dies gibt die angehakten Zeilen sofort zurück und liest eine Query-Auswahl seitenweise ein – mit einem optionalen Fortschritts-Callback. Wenn die Query mehr als 20.000 Zeilen umfasst, wird ein Fehler geworfen, anstatt nur ein Präfix zurückzugeben.

const handlePublish = async () => {
for (const entity of selectionController.selectedEntities) {
const selected = await resolveSelection({
selection: selectionController.selection,
accessor: data.collection(path)
});
for (const entity of selected) {
await data.collection(entity.path).update(entity.id, { status: "published" });
}
};
grep -rn "selectedEntities" config frontend

Damit einher gehen drei kleinere Anpassungen:

  • selectionController.selectedEntities.length → selectionController.selectedCount. Dies ist undefined, niemals 0, wenn jede Zeile ausgewählt ist, die einer Query entspricht, und die Collection nicht gezählt werden kann – bilden Sie diesen Fall ab, setzen Sie keinen Standardwert.
  • setSelectedEntities(prev => …) → setSelection(prev => …), was eine EntitySelection entgegennimmt und zurückgibt. setSelectedEntities(rows) mit einem Array funktioniert weiterhin.
  • Die Überprüfung, ob überhaupt etwas ausgewählt ist, erfolgt über selectionController.hasSelection.

isEntitySelected und toggleEntitySelection bleiben unverändert und sollten weiterhin für Checkboxen pro Zeile verwendet werden. Das Beispiel für Collection-Aktionen zeigt das gesamte Pattern.