Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove JsSse::$closeBeforeUnload property #2245

Merged
merged 5 commits into from
Jan 30, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion js/src/JqueryPlugin/FileUploadPlugin.js
Original file line number Diff line number Diff line change
@@ -145,7 +145,7 @@ export default class AtkFileUploadPlugin extends AbstractPlugin {
const percentComplete = event.loaded / event.total;
this.bar.progress('set percent', Number.parseInt(percentComplete * 100, 10));
}
}, false);
});

return xhr;
};
14 changes: 6 additions & 8 deletions js/src/JqueryPlugin/ServerEventPlugin.js
Original file line number Diff line number Diff line change
@@ -7,6 +7,7 @@ export default class AtkServerEventPlugin extends AbstractPlugin {
const hasLoader = this.settings.showLoader;

this.source = new EventSource(this.settings.url);

if (hasLoader) {
element.addClass('loading');
}
@@ -17,22 +18,20 @@ export default class AtkServerEventPlugin extends AbstractPlugin {

this.source.addEventListener('error', (e) => {
if (e.eventPhase === EventSource.CLOSED) {
this.source.close();

if (hasLoader) {
element.removeClass('loading');
}
this.source.close();
}
});

this.source.addEventListener('atkSseAction', (e) => {
atk.apiService.atkProcessExternalResponse(JSON.parse(e.data));
}, false);
});

if (this.settings.closeBeforeUnload) {
window.addEventListener('beforeunload', (event) => {
this.source.close();
});
}
// prevent "The connection to http://xxx was interrupted while the page was loading." browser console warning
window.addEventListener('beforeunload', () => this.source.close());
}

stop() {
@@ -48,5 +47,4 @@ AtkServerEventPlugin.DEFAULTS = {
url: null,
urlOptions: {},
showLoader: false,
closeBeforeUnload: false,
};
6 changes: 3 additions & 3 deletions js/src/Service/apiService.js
Original file line number Diff line number Diff line change
@@ -49,12 +49,12 @@ class ApiService {
return false;
}

onAbort(message) {
console.warn(message);
onAbort() {
console.warn('API service - request aborted');
}

onError(message) {
console.warn(message);
console.warn('API service - request errored: ' + message);
}

/**
23 changes: 10 additions & 13 deletions public/js/atkjs-ui.js
Original file line number Diff line number Diff line change
@@ -998,7 +998,7 @@ class AtkFileUploadPlugin extends _AbstractPlugin__WEBPACK_IMPORTED_MODULE_5__["
const percentComplete = event.loaded / event.total;
this.bar.progress('set percent', Number.parseInt(percentComplete * 100, 10));
}
}, false);
});
return xhr;
};
this.bar.show();
@@ -1775,20 +1775,18 @@ class AtkServerEventPlugin extends _AbstractPlugin__WEBPACK_IMPORTED_MODULE_2__[
});
this.source.addEventListener('error', e => {
if (e.eventPhase === EventSource.CLOSED) {
this.source.close();
if (hasLoader) {
element.removeClass('loading');
}
this.source.close();
}
});
this.source.addEventListener('atkSseAction', e => {
atk__WEBPACK_IMPORTED_MODULE_1__["default"].apiService.atkProcessExternalResponse(JSON.parse(e.data));
}, false);
if (this.settings.closeBeforeUnload) {
window.addEventListener('beforeunload', event => {
this.source.close();
});
}
});

// prevent "The connection to http://xxx was interrupted while the page was loading." browser console warning
window.addEventListener('beforeunload', () => this.source.close());
}
stop() {
this.source.close();
@@ -1800,8 +1798,7 @@ class AtkServerEventPlugin extends _AbstractPlugin__WEBPACK_IMPORTED_MODULE_2__[
AtkServerEventPlugin.DEFAULTS = {
url: null,
urlOptions: {},
showLoader: false,
closeBeforeUnload: false
showLoader: false
};

/***/ }),
@@ -2077,11 +2074,11 @@ class ApiService {
}
return false;
}
onAbort(message) {
console.warn(message);
onAbort() {
console.warn('API service - request aborted');
}
onError(message) {
console.warn(message);
console.warn('API service - request errored: ' + message);
}

/**
2 changes: 1 addition & 1 deletion public/js/atkjs-ui.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion public/js/atkjs-ui.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion public/js/atkjs-ui.min.js.map

Large diffs are not rendered by default.

6 changes: 0 additions & 6 deletions src/JsSse.php
Original file line number Diff line number Diff line change
@@ -18,9 +18,6 @@ class JsSse extends JsCallback
/** @var bool Show Loader when doing SSE. */
public $showLoader = false;

/** @var bool Add window.beforeunload listener for closing js EventSource. Off by default. */
public $closeBeforeUnload = false;

/** @var \Closure(string): void|null Custom function for outputting (instead of echo). */
public $echoFunction;

@@ -33,9 +30,6 @@ public function jsExecute(): JsBlock
if ($this->showLoader) {
$options['showLoader'] = $this->showLoader;
}
if ($this->closeBeforeUnload) {
$options['closeBeforeUnload'] = $this->closeBeforeUnload;
}

return new JsBlock([(new Jquery($this->getOwner() /* TODO element and loader element should be passed explicitly */))->atkServerEvent($options)]);
}