opf/openproject

View on GitHub
frontend/src/stimulus/controllers/refresh-on-form-changes.controller.ts

Summary

Maintainability
A
35 mins
Test Coverage
/*
 * -- copyright
 * OpenProject is an open source project management software.
 * Copyright (C) the OpenProject GmbH
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 3.
 *
 * OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
 * Copyright (C) 2006-2013 Jean-Philippe Lang
 * Copyright (C) 2010-2013 the ChiliProject Team
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * See COPYRIGHT and LICENSE files for more details.
 * ++
 */

import { ApplicationController } from 'stimulus-use';
import { renderStreamMessage } from '@hotwired/turbo';

export default class RefreshOnFormChangesController extends ApplicationController {
  static targets = [
    'form',
  ];

  static values = {
    refreshUrl: String,
    turboStreamUrl: String,
  };

  declare readonly formTarget:HTMLFormElement;

  declare refreshUrlValue:string;
  declare turboStreamUrlValue:string;

  triggerReload():void {
    window.location.href = `${this.refreshUrlValue}?${this.getSerializedFormData()}`;
  }

  async triggerTurboStream():Promise<void> {
    await fetch(`${this.turboStreamUrlValue}?${this.getSerializedFormData()}`, {
      headers: {
        Accept: 'text/vnd.turbo-stream.html',
      },
    }).then((r) => r.text())
      .then((html) => renderStreamMessage(html));
  }

  private getSerializedFormData():string {
    // without the cast to undefined, the URLSearchParams constructor will
    // not accept the FormData object.
    const formData = new FormData(this.formTarget) as unknown as undefined;
    return new URLSearchParams(formData).toString();
  }
}