Plugins revision

[peterpp]

I'm in the middle of plugins revision and refactoring right now. The current state is:

• Refactored and improved: 10 plugins
• Transformed to config options: 6 plugins
• 3-rd party plugins as config options: 2 plugins
• Removed: 6 plugins
• Remaining: 10 plugins

If you have any thoughts or suggestions, this is the right time 🕰️

[adrianbj]

Not sure if it makes sense for the frames plugin, but I have implemented a postMessage technique to push the querystr to the parent so that URLs can be shared and history stack is updated.

https://github.com/adrianbj/TracyDebugger/blob/05916d044022430bf7dbccad4a5ebbbd4c2a30d0/panels/Adminer/scripts/tweaks.js#L3-L13

https://github.com/adrianbj/TracyDebugger/blob/05916d044022430bf7dbccad4a5ebbbd4c2a30d0/ProcessTracyAdminer.module.php#L40-L49

Of course part of the code needs to be added to the file that loads the iframe so maybe not worth trying to implement.

[adrianbj]

Just realized that because you are sending event and checking with the data.event === "loading" that takes care of the issue I was seeing with the object from another event. Much nicer approach :)

[peterpp]

I was looking back through my commit log and shows that I specifically added that debounce (in main.js) so must have had a reason :)

Maybe because you also changed the height of the frame according to its content here:

if(event.source.document.body && event.source.document.body.scrollHeight) {
    adminer_iframe.style.height = (event.source.document.body.scrollHeight + 20) + "px";
}

And that content has to be rendered at first. However, adding random delay is not a good solution for any kind of problem ☺️

but I do wonder about the "string" check - I know I was getting some data sent via postMessage that was an object
Just realized that because you are sending event and checking with the data.event === "loading"...

You have to expect that other services can also send messages if you embed them in similar way. Checking of event.source should be sufficient, but other additional checks will not harm (in case you accidentally load another service to the same frame).

I slightly changed the message – it is an object now and object type is verified before usage. Internal parameter event is now adminneo-loading to be super clear.

I assume you'll be removing the messageBox in that iframe.php example?

Why? I like it 😉 It's just an example used for testing.

Only other thing is that I think I just made my life more difficult as I am also trying to maintain support for your 4.x branch within my module, but that's my problem

You can create very similar plugin for v4. It should not be a big deal. Just change getCspHeader() to something like this:

public function csp()
{
	if (!$this->frameAncestors) {
		return null;
	}

	$csp = csp();
	$csp[0]["frame-ancestors"] = implode(" ", $this->frameAncestors);

	return $csp;
}

the rest is compatible, I think.

[adrianbj]

Maybe because you also changed the height of the frame according to its content here

Good catch - I got rid of that recently, but that does seem like the reason it was needed.

Thanks for the tip about a v4 version of the plugin - hadn't had time to see what was involved today.

[peterpp]

I finished what I wanted to, so if you have no other notes, I will merge it tomorrow.

[adrianbj]

I've integrated the latest version and all looks good here. Thanks - I think this is a great improvement for those who do need it in an iframe.

[adrianbj]

Yes, of course - I have actually already implemented with the new frameAncestors approach (I just forgot): https://github.com/adrianbj/TracyDebugger/blob/05916d044022430bf7dbccad4a5ebbbd4c2a30d0/ProcessTracyAdminerRenderer.module.php#L47

[adrianbj]

Is the latest version of JsonPreviewPlugin working for you? After updating it doesn't add the toggle to the table view or the edit view. If I revert to the version prior to the latest it seems fine.

Am I doing something wrong? I am calling like this: https://github.com/adrianbj/TracyDebugger/blob/05916d044022430bf7dbccad4a5ebbbd4c2a30d0/ProcessTracyAdminerRenderer.module.php#L38

[peterpp]

JsonPreviewPlugin now respects jsonValuesDetection option that is off by default. I will mention it in upgrade guide. Note that for example MariaDB doesn't have native support for JSON columns.

There is also jsonValuesAutoFormat option, so you probably can remove PrettyJsonEditPlugin.

[adrianbj]

Thanks JSON stuff all sorted now.

[peterpp]

It's done. All plugins have been reviewed and refactored, improved or removed. I also renamed all public customizable functions. They now follow a more common naming convention. 3rd party plugins are of course not compatible. If you miss one that you like or you think is generally useful, feel free to suggest it.