Alte SharePoint Framework-Solutions jetzt aktualisieren!

Microsoft hat mit dem SharePoint Framework SPFx vor eini­ger Zeit einen neuen und moder­nen Weg für die SharePoint-Entwicklung vor­ge­stellt. Seit der ers­ten Version set­zen wir bei Communardo auf die­ses Pferd - und wur­den nicht enttäuscht.

Einige unse­rer Lösungen sind aller­dings bereits "in die Jahre" gekom­men, da sich das Framework mit rasan­ter Geschwindigkeit entwickelt.

Warum sich ein Update lohnt und wel­che Schritte not­wen­dig sind wird in die­sem Beitrag vorgestellt.

Warum sollte ich das SharePoint Framework aktualisieren?

Für ein Update des Frameworks spre­chen zunächst die tol­len neuen Features, die Microsoft ein­baut und die den Entwicklern das Leben erleich­tern kön­nen. Beispielsweise wur­den im Laufe der Zeit Environment-Klassen hin­zu­ge­fügt, mit denen Webparts her­aus­fin­den kön­nen, ob sie im SharePoint Online oder on-premises im Einsatz sind. Auch die neuen SharePoint Framework Extensions erfor­dern ein Update, sowie das tenant-weite Deployment der Solution.

Für ein Update des Frameworks spricht aber auch die Frequenz, mit der wei­tere Updates zu erwar­ten sind. Im Laufe der Entwicklung wurde bis­her die Struktur ver­schie­de­ner Dateien erwei­tert oder ver­än­dert. Build-Prozesse, die davon abhän­gen müs­sen u.U. ange­passt wer­den. Updates von Modul-Abhängigkeiten wie "web­pack" kön­nen klei­nere Änderungen der Modulauflösung mit sich brin­gen. Die dar­aus ent­ste­hen­den Probleme löst man lie­ber in klei­nen Schritten - Update für Update.

Wie erkenne ich alte SharePoint Framework Solutions?

Alte Solutions las­sen sich schnell durch einen Blick in die "package.json" identifizieren.

Die Kern-Pakete des Frameworks sehen hier ziem­lich alt aus, alle besit­zen die initiale Version 1.0.0:

Stand heute sollte eine aktu­elle "package.json" aber eher so aussehen:

Mit Visual Studio Code lässt sich sehr leicht nach­se­hen, ob eine aktu­el­lere Version zur Verfügung steht. Fährt man mit der Maus über die Versionsnummer, wird die aktu­ellste Version angezeigt:

Praktisch! Jetzt kann das Update kommen.

Wie aktua­li­siere ich alte SharePoint Framework Solutions?

Um das Framework zu aktua­li­sie­ren, muss bei allen dazu­ge­hö­ri­gen Paketen die aktu­elle Versionsnummer ein­ge­tra­gen wer­den. Hier noch ein­mal das Bild von oben:

Wer genau hin­schaut, sieht, dass ein Paket sogar noch die Version 1.0.0 besitzt. Hier gibt es kei­nen aktu­el­le­ren Stand. Das müs­sen wir wohl so hinnehmen.

Nachdem die Versionsnummern aktua­li­siert wur­den, wird der Node Package Manager "npm" ver­wen­det, um diese Versionen auch her­un­ter­zu­la­den. Folgender Befehl wird dazu in der Konsole ausgeführt:

npm install

Npm schaut in die "package.json" und lädt die gewünsch­ten Dateien herunter.

Im Anschluss ist even­tu­ell noch fol­gen­der Befehl not­wen­dig, um die Konfigurationsdateien wie "config.json" auf den aktu­el­len Stand zu bringen:

gulp --upgrade

Wurde die­ser Befehl noch nicht aus­ge­führt, erscheint beim nächs­ten Build in der Konsole ein Hinweis.

Wieviel Zeit sollte für das Update ein­ge­plant werden?

In der Überschrift deu­tet sich schon die Antwort an: mehr als gedacht. Die Schritte oben sind schnell durch­ge­führt. Allerdings kann es sein, dass nach dem Update der Build nicht mehr funk­tio­niert: Gulp-Tasks müs­sen aktua­li­siert wer­den, weil sie von Schema-Änderungen betrof­fen sind. Fehler bei der Webpack-Modulauflösung müs­sen beho­ben wer­den. Generierte Dateinamen ändern sich.

Wir hat­ten auch schon den Fall, dass kurz nach einem Update der SPFx-Pakete durch Microsoft kein Build mehr mög­lich war, da Framework-intern Abhängigkeiten nicht kor­rekt kon­fi­gu­riert waren. Ein bis zwei Wochen und ein Update spä­ter war alles wie­der in Ordnung.

Sofern der zuletzt genannte Fall nicht ein­tritt, sollte man sich in klei­nen bis mitt­le­ren Projekten etwa 2-4 Stunden für das Update reservieren.

Zusammenfassung und Ausblick

Wir haben anhand eini­ger Beispiele gese­hen, warum es sich lohnt, auf neuere Versionen des SharePoint Frameworks zu aktua­li­sie­ren. Das Update an sich ist ein­fach, für die Nacharbeiten sollte man ein wenig Zeit einplanen.

Das SharePoint Framework und die ers­ten Extensions ste­hen erst am Anfang, auf der Roadmap ste­hen noch viele Punkte. Wir bli­cken gespannt in die Zukunft und wer­den unsere Solutions aktu­ell halten.