Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

DRY reading CSRF tokens with Stimulus-Use useMeta

Alexander Brandon Coles63e433a98f59
diff --git a/frontend/src/stimulus/controllers/dynamic/admin/hierarchy-item.controller.ts b/frontend/src/stimulus/controllers/dynamic/admin/hierarchy-item.controller.ts
index 1d26eefa5e2..e6e6a5a1e92 100644
--- a/frontend/src/stimulus/controllers/dynamic/admin/hierarchy-item.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/admin/hierarchy-item.controller.ts
@@ -30,11 +30,17 @@
import { Controller } from '@hotwired/stimulus';
import * as Turbo from '@hotwired/turbo';
+import { useMeta } from 'stimulus-use';
export default class HierarchyItemController extends Controller {
+ static metaNames = ['csrf-token'];
+ declare readonly csrfToken:string;
+
private currentHover:HTMLElement | null;
- connect() {}
+ connect() {
+ useMeta(this, { suffix: false });
+ }
dragstart(event:DragEvent) {
const element = dataNode(event.target);
@@ -91,31 +97,26 @@ export default class HierarchyItemController extends Controller {
targetSortOrder += 1;
}
- updateSortOrder(originElement, targetSortOrder);
+ this.#updateSortOrder(originElement, targetSortOrder);
}
}
-}
-function updateSortOrder(originElement:HTMLElement, sortOrder:number | string) {
- const { frameId = '', indexUrl = '', moveUrl = '' } = originElement.dataset;
-
- fetch(new URL(moveUrl), {
- body: new URLSearchParams([['new_sort_order', sortOrder.toString()]]),
- method: 'POST',
- credentials: 'include',
- headers: [
- ['Content-Type', 'application/x-www-form-urlencoded;charset=UTF-8'],
- ['X-CSRF-Token', getMetaValue('csrf-token')],
- ],
- redirect: 'manual',
- }).then(() => {
- Turbo.visit(indexUrl, { frame: frameId });
- }).catch(() => {});
-}
-
-function getMetaValue(name:string) {
- const element = document.head.querySelector(`meta[name='${name}']`);
- return element?.getAttribute('content') || '';
+ #updateSortOrder(originElement:HTMLElement, sortOrder:number | string):void {
+ const { frameId = '', indexUrl = '', moveUrl = '' } = originElement.dataset;
+
+ fetch(new URL(moveUrl), {
+ body: new URLSearchParams([['new_sort_order', sortOrder.toString()]]),
+ method: 'POST',
+ credentials: 'include',
+ headers: [
+ ['Content-Type', 'application/x-www-form-urlencoded;charset=UTF-8'],
+ ['X-CSRF-Token', this.csrfToken],
+ ],
+ redirect: 'manual',
+ }).then(() => {
+ Turbo.visit(indexUrl, { frame: frameId });
+ }).catch(() => {});
+ }
}
function dataNode(node:EventTarget | null):HTMLElement {
diff --git a/frontend/src/stimulus/controllers/dynamic/costs/budget-subform.controller.ts b/frontend/src/stimulus/controllers/dynamic/costs/budget-subform.controller.ts
index a2d8a8b295a..ac3d79d8483 100644
--- a/frontend/src/stimulus/controllers/dynamic/costs/budget-subform.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/costs/budget-subform.controller.ts
@@ -29,6 +29,7 @@
*/
import { Controller } from '@hotwired/stimulus';
+import { useMeta } from 'stimulus-use';
export default class BudgetSubformController extends Controller {
static targets = [
@@ -47,10 +48,15 @@ export default class BudgetSubformController extends Controller {
declare itemCountValue:number;
declare updateUrlValue:string;
+ static metaNames = ['csrf-token'];
+
+ declare readonly csrfToken:string|null;
+
private form:HTMLFormElement;
private submitButtons:NodeListOf<HTMLButtonElement>;
connect():void {
+ useMeta(this, { suffix: false });
this.form = this.element.closest('form') as HTMLFormElement;
this.submitButtons = this.form.querySelectorAll("button[type='submit']");
}
@@ -129,10 +135,8 @@ export default class BudgetSubformController extends Controller {
body.append(itemValue.dataset.requestKey as string, (itemValue.value || '0'));
});
- const csrfTokenTag = document.querySelector("meta[name='csrf-token']");
-
- if (csrfTokenTag !== null) {
- body.append('authenticity_token', csrfTokenTag.getAttribute('content') as string);
+ if (this.csrfToken !== null) {
+ body.append('authenticity_token', this.csrfToken);
}
return body;
diff --git a/frontend/src/stimulus/controllers/dynamic/generic-drag-and-drop.controller.ts b/frontend/src/stimulus/controllers/dynamic/generic-drag-and-drop.controller.ts
index 52f151d4059..0ff465109cf 100644
--- a/frontend/src/stimulus/controllers/dynamic/generic-drag-and-drop.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/generic-drag-and-drop.controller.ts
@@ -32,6 +32,7 @@ import * as Turbo from '@hotwired/turbo';
import { Controller } from '@hotwired/stimulus';
import { Drake } from 'dragula';
import { debugLog } from 'core-app/shared/helpers/debug_output';
+import { useMeta } from 'stimulus-use';
interface TargetConfig {
container:Element;
@@ -40,6 +41,9 @@ interface TargetConfig {
}
export default class GenericDragAndDropController extends Controller {
+ static metaNames = ['csrf-token'];
+ declare readonly csrfToken:string;
+
drake:Drake|undefined;
targetConfigs:TargetConfig[];
@@ -48,6 +52,7 @@ export default class GenericDragAndDropController extends Controller {
observer:MutationObserver|null = null;
connect() {
+ useMeta(this, { suffix: false });
this.initDrake();
this.startMutationObserver();
}
@@ -151,7 +156,7 @@ export default class GenericDragAndDropController extends Controller {
method: 'PUT',
body: data,
headers: {
- 'X-CSRF-Token': (document.querySelector('meta[name="csrf-token"]') as HTMLMetaElement).content,
+ 'X-CSRF-Token': this.csrfToken,
Accept: 'text/vnd.turbo-stream.html',
},
credentials: 'same-origin',
diff --git a/frontend/src/stimulus/controllers/dynamic/meeting-agenda-item-form.controller.ts b/frontend/src/stimulus/controllers/dynamic/meeting-agenda-item-form.controller.ts
index 7e24228b37c..8a5905ab146 100644
--- a/frontend/src/stimulus/controllers/dynamic/meeting-agenda-item-form.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/meeting-agenda-item-form.controller.ts
@@ -30,6 +30,7 @@
import * as Turbo from '@hotwired/turbo';
import { Controller } from '@hotwired/stimulus';
+import { useMeta } from 'stimulus-use';
export default class extends Controller {
static values = {
@@ -43,7 +44,11 @@ export default class extends Controller {
static targets = ['notesInput'];
declare readonly notesInputTarget:HTMLInputElement;
+ static metaNames = ['csrf-token'];
+ declare readonly csrfToken:string;
+
connect():void {
+ useMeta(this, { suffix: false });
this.focusInput();
this.addNotes();
}
@@ -63,7 +68,7 @@ export default class extends Controller {
const response = await fetch(this.cancelUrlValue, {
method: 'GET',
headers: {
- 'X-CSRF-Token': (document.querySelector('meta[name="csrf-token"]') as HTMLMetaElement).content,
+ 'X-CSRF-Token': this.csrfToken,
Accept: 'text/vnd.turbo-stream.html',
},
});
diff --git a/frontend/src/stimulus/controllers/dynamic/meetings/add-params.controller.ts b/frontend/src/stimulus/controllers/dynamic/meetings/add-params.controller.ts
index c737a293a62..b0dac604060 100644
--- a/frontend/src/stimulus/controllers/dynamic/meetings/add-params.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/meetings/add-params.controller.ts
@@ -28,7 +28,7 @@
* ++
*/
-import { ApplicationController } from 'stimulus-use';
+import { ApplicationController, useMeta } from 'stimulus-use';
import { TurboRequestsService } from 'core-app/core/turbo/turbo-requests.service';
import { appendCollapsedState } from '../../../helpers/collapsible-helper';
@@ -38,7 +38,12 @@ export default class extends ApplicationController {
declare readonly containerTarget:HTMLElement;
+ static metaNames = ['csrf-token'];
+
+ declare readonly csrfToken:string;
+
async connect() {
+ useMeta(this, { suffix: false });
const context = await window.OpenProject.getPluginContext();
this.turboRequests = context.services.turboRequests;
}
@@ -59,7 +64,7 @@ export default class extends ApplicationController {
{
method: 'PUT',
headers: {
- 'X-CSRF-Token': (document.querySelector('meta[name="csrf-token"]') as HTMLMetaElement).content,
+ 'X-CSRF-Token': this.csrfToken,
Accept: 'text/vnd.turbo-stream.html',
},
},
diff --git a/frontend/src/stimulus/controllers/dynamic/meetings/check-unsaved.controller.ts b/frontend/src/stimulus/controllers/dynamic/meetings/check-unsaved.controller.ts
index 7622564a09c..71fdd66f1ac 100644
--- a/frontend/src/stimulus/controllers/dynamic/meetings/check-unsaved.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/meetings/check-unsaved.controller.ts
@@ -28,7 +28,7 @@
* ++
*/
-import { ApplicationController } from 'stimulus-use';
+import { ApplicationController, useMeta } from 'stimulus-use';
import { TurboRequestsService } from 'core-app/core/turbo/turbo-requests.service';
export default class extends ApplicationController {
@@ -39,7 +39,13 @@ export default class extends ApplicationController {
declare unsavedChangesConfirmationMessageValue:string;
+ static metaNames = ['csrf-token'];
+
+ declare readonly csrfToken:string;
+
async connect():Promise<void> {
+ useMeta(this, { suffix: false });
+
window.addEventListener('beforeunload', this.boundBeforeUnloadHandler);
const context = await window.OpenProject.getPluginContext();
@@ -85,7 +91,7 @@ export default class extends ApplicationController {
void this.turboRequests.request(url, {
method: 'PUT',
headers: {
- 'X-CSRF-Token': (document.querySelector('meta[name="csrf-token"]') as HTMLMetaElement).content,
+ 'X-CSRF-Token': this.csrfToken,
Accept: 'text/vnd.turbo-stream.html',
},
});
diff --git a/frontend/src/stimulus/controllers/dynamic/meetings/section-form.controller.ts b/frontend/src/stimulus/controllers/dynamic/meetings/section-form.controller.ts
index 93ac0692183..208edf14550 100644
--- a/frontend/src/stimulus/controllers/dynamic/meetings/section-form.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/meetings/section-form.controller.ts
@@ -30,6 +30,7 @@
import * as Turbo from '@hotwired/turbo';
import { Controller } from '@hotwired/stimulus';
+import { useMeta } from 'stimulus-use';
export default class extends Controller {
static values = {
@@ -38,7 +39,11 @@ export default class extends Controller {
declare cancelUrlValue:string;
+ static metaNames = ['csrf-token'];
+ declare readonly csrfToken:string;
+
connect():void {
+ useMeta(this, { suffix: false });
this.focusInput();
}
@@ -53,7 +58,7 @@ export default class extends Controller {
const response = await fetch(this.cancelUrlValue, {
method: 'GET',
headers: {
- 'X-CSRF-Token': (document.querySelector('meta[name="csrf-token"]') as HTMLMetaElement).content,
+ 'X-CSRF-Token': this.csrfToken,
Accept: 'text/vnd.turbo-stream.html',
},
});
diff --git a/frontend/src/stimulus/controllers/dynamic/my/time-tracking.controller.ts b/frontend/src/stimulus/controllers/dynamic/my/time-tracking.controller.ts
index ae00628d42c..8afe6574746 100644
--- a/frontend/src/stimulus/controllers/dynamic/my/time-tracking.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/my/time-tracking.controller.ts
@@ -11,6 +11,7 @@ import moment from 'moment';
import allLocales from '@fullcalendar/core/locales-all';
import { renderStreamMessage } from '@hotwired/turbo';
import { opStopwatchStopIconData, toDOMString } from '@openproject/octicons-angular';
+import { useMeta } from 'stimulus-use';
export default class MyTimeTrackingController extends Controller {
private turboRequests:TurboRequestsService;
@@ -33,6 +34,8 @@ export default class MyTimeTrackingController extends Controller {
timeZone: String,
};
+ static metaNames = ['csrf-token'];
+
declare readonly calendarTarget:HTMLElement;
declare readonly hasCalendarTarget:boolean;
declare readonly modeValue:string;
@@ -47,12 +50,14 @@ export default class MyTimeTrackingController extends Controller {
declare readonly workingDaysValue:number[];
declare readonly startOfWeekValue:number;
declare readonly timeZoneValue:string;
+ declare readonly csrfToken:string;
private calendar:Calendar;
private DEFAULT_TIMED_EVENT_DURATION = '01:00';
private boundListener = this.dialogCloseListener.bind(this);
async connect() {
+ useMeta(this, { suffix: false });
const context = await window.OpenProject.getPluginContext();
this.turboRequests = context.services.turboRequests;
this.pathHelper = context.services.pathHelperService;
@@ -360,13 +365,11 @@ export default class MyTimeTrackingController extends Controller {
}
updateTimeEntry(timeEntryId:string, spentOn:string, startTime:string | null, hours:number, revertFunction:() => void) {
- const csrfToken = document.querySelector<HTMLMetaElement>('meta[name="csrf-token"]')?.content || '';
-
fetch(this.pathHelper.timeEntryUpdate(timeEntryId), {
method: 'PATCH',
headers: {
'Content-Type': 'application/json',
- 'X-CSRF-Token': csrfToken,
+ 'X-CSRF-Token': this.csrfToken,
},
body: JSON.stringify({
time_entry: {
diff --git a/frontend/src/stimulus/controllers/dynamic/time-entry.controller.ts b/frontend/src/stimulus/controllers/dynamic/time-entry.controller.ts
index ac0f81666ca..4da7656f0cf 100644
--- a/frontend/src/stimulus/controllers/dynamic/time-entry.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/time-entry.controller.ts
@@ -35,6 +35,7 @@ import {
} from 'core-app/shared/helpers/chronic_duration';
import { TurboRequestsService } from 'core-app/core/turbo/turbo-requests.service';
import { PathHelperService } from 'core-app/core/path-helper/path-helper.service';
+import { useMeta } from 'stimulus-use';
export default class TimeEntryController extends Controller {
static targets = ['startTimeInput', 'endTimeInput', 'hoursInput', 'form'];
@@ -47,10 +48,16 @@ export default class TimeEntryController extends Controller {
declare readonly hoursInputTarget:HTMLInputElement;
declare oldWorkPackageId:string;
+ static metaNames = ['csrf-token'];
+
+ declare readonly csrfToken:string;
+
private turboRequests:TurboRequestsService;
private pathHelper:PathHelperService;
async connect() {
+ useMeta(this, { suffix: false });
+
const context = await window.OpenProject.getPluginContext();
this.turboRequests = context.services.turboRequests;
this.pathHelper = context.services.pathHelperService;
@@ -77,14 +84,13 @@ export default class TimeEntryController extends Controller {
this.oldWorkPackageId = newValue;
const url = this.formTarget.dataset.refreshFormUrl as string;
- const csrfToken = document.querySelector<HTMLMetaElement>('meta[name="csrf-token"]')?.content || '';
const formData = new FormData(this.formTarget);
formData.delete('_method'); // remove the override method as this will submit to the wrong action
void this.turboRequests.request(url, {
method: 'post',
body: formData,
headers: {
- 'X-CSRF-Token': csrfToken,
+ 'X-CSRF-Token': this.csrfToken,
},
});
}
diff --git a/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/index.controller.ts b/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/index.controller.ts
index 5ad1934169a..9b7f4345a69 100644
--- a/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/index.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/index.controller.ts
@@ -34,6 +34,7 @@ import {
} from 'core-app/shared/components/editor/components/ckeditor/ckeditor.types';
import { TurboRequestsService } from 'core-app/core/turbo/turbo-requests.service';
import { ApiV3Service } from 'core-app/core/apiv3/api-v3.service';
+import { useMeta } from 'stimulus-use';
enum AnchorType {
Comment = 'comment',
@@ -86,6 +87,10 @@ export default class IndexController extends Controller {
declare showConflictFlashMessageUrlValue:string;
declare unsavedChangesConfirmationMessageValue:string;
+ static metaNames = ['csrf-token'];
+
+ declare readonly csrfToken:string;
+
private updateInProgress:boolean;
private turboRequests:TurboRequestsService;
@@ -95,6 +100,8 @@ export default class IndexController extends Controller {
private ckEditorAbortController = new AbortController();
async connect() {
+ useMeta(this, { suffix: false });
+
const context = await window.OpenProject.getPluginContext();
this.turboRequests = context.services.turboRequests;
this.apiV3Service = context.services.apiV3Service;
@@ -250,7 +257,7 @@ export default class IndexController extends Controller {
return this.turboRequests.request(url, {
method: 'GET',
headers: {
- 'X-CSRF-Token': (document.querySelector('meta[name="csrf-token"]') as HTMLMetaElement).content,
+ 'X-CSRF-Token': this.csrfToken,
},
}, true); // suppress error toast in polling to avoid spamming the user when having e.g. network issues
}
diff --git a/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/internal-comment.controller.ts b/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/internal-comment.controller.ts
index 88c10b6095c..cf40b7d7cbc 100644
--- a/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/internal-comment.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/internal-comment.controller.ts
@@ -30,6 +30,7 @@
import { Controller } from '@hotwired/stimulus';
import { renderStreamMessage } from '@hotwired/turbo';
+import { useMeta } from 'stimulus-use';
import type IndexController from './index.controller';
export default class InternalCommentController extends Controller {
@@ -53,6 +54,14 @@ export default class InternalCommentController extends Controller {
declare hasInternalCheckboxTarget:boolean;
+ static metaNames = ['csrf-token'];
+
+ declare readonly csrfToken:string;
+
+ connect() {
+ useMeta(this, { suffix: false });
+ }
+
onSubmitEnd(_event:CustomEvent):void {
if (this.hasInternalCheckboxTarget) {
this.toggleInternal();
@@ -107,14 +116,13 @@ export default class InternalCommentController extends Controller {
if (editorData.length === 0) return;
const sanitizePath = `/work_packages/${this.workPackagesActivitiesTabIndexOutlet.workPackageIdValue}/activities/sanitize_internal_mentions`;
- const csrfToken = (document.querySelector('meta[name="csrf-token"]') as HTMLMetaElement).content;
try {
const response = await fetch(sanitizePath, {
method: 'POST',
body: JSON.stringify({ journal: { notes: editorData } }),
headers: {
- 'X-CSRF-Token': csrfToken,
+ 'X-CSRF-Token': this.csrfToken,
'Content-Type': 'application/json',
},
});