[3.2][RC] Extension .yml check

A place for Extension Authors to post and receive feedback on Extensions still in development. No Extensions within this forum should be used within a live environment!
Suggested Hosts
Forum rules
READ: phpBB.com Board-Wide Rules and Regulations

IMPORTANT: Extensions Development rules

IMPORTANT FOR NEEDED EVENTS!!!
If you need an event for your extension please read this for the steps to follow to request the event(s)
User avatar
david63
Registered User
Posts: 16681
Joined: Thu Dec 19, 2002 8:08 am
Location: Lancashire, UK
Name: David Wood
Contact:

[3.2][RC] Extension .yml check

Post by david63 » Sun Nov 03, 2019 1:33 pm

phpbb3-extension-extservicescheck

Description:
Checks the syntax of the services.yml file in extensions prior to phpBB 3.3.

Note:
This extension will only check that the syntax of the services.yml file is compatible with phpBB 3.3 - it does no other checks and does not make any guarantees that any extension will be compatible with phpBB 3.3 in any other respect.

Features:
  • Lists the status of all extensions.
  • Shows a comparison of the "original" file and the "re-formatted" file.
Languages:
en

Status:
2.1.0-RC5

Installation:
  • Download the latest release and unzip it.
  • Upload the unzipped files to [board root]/ext/david63/extservicescheck and enable it in the ACP
GitHub Repository: https://github.com/david63/extservicescheck/tree/3.2

Extension Download:https://github.com/david63/extservicesc ... ve/3.2.zip

Useage:
ACP > Customise > Extension management > Extension services check
Last edited by david63 on Wed Nov 13, 2019 2:12 pm, edited 6 times in total.
David
Remember: You only know what you know and - you don't know what you don't know!
My CDB Contributions | How to install an extension
I will not be accepting translations for any of my extensions in Github - please post any translations in the appropriate topic.
No support requests via PM or email as they will be ignored

User avatar
david63
Registered User
Posts: 16681
Joined: Thu Dec 19, 2002 8:08 am
Location: Lancashire, UK
Name: David Wood
Contact:

Re: [3.2][RC] Extension Services Check

Post by david63 » Sun Nov 03, 2019 1:37 pm

The reason for this extension is that in phpBB 3.3 there is a change in Symfony that requires the services.yml file to have a particular syntax. There are some, probably quite old, extensions that may not conform to this syntax and the extension will not work - and may possibly break your board.

By running this extension you will be able to check your extensions and take appropriate action prior to upgrading to phpBB 3.3 (when it is released)
David
Remember: You only know what you know and - you don't know what you don't know!
My CDB Contributions | How to install an extension
I will not be accepting translations for any of my extensions in Github - please post any translations in the appropriate topic.
No support requests via PM or email as they will be ignored

User avatar
HiFiKabin
Community Team Member
Community Team Member
Posts: 4053
Joined: Wed May 14, 2014 9:10 am
Location: Swearing at the PC, UK
Name: James
Contact:

Re: [3.2][RC] Extension Services Check

Post by HiFiKabin » Sun Nov 03, 2019 1:51 pm

Very clever, and most helpful. Many thanks David

User avatar
pierredu
Registered User
Posts: 962
Joined: Thu Nov 01, 2012 8:04 am
Location: Paris (France)

Re: [3.2][RC] Extension Services Check

Post by pierredu » Sun Nov 03, 2019 2:38 pm

Do you check the 'pattern' keyword?

User avatar
david63
Registered User
Posts: 16681
Joined: Thu Dec 19, 2002 8:08 am
Location: Lancashire, UK
Name: David Wood
Contact:

Re: [3.2][RC] Extension Services Check

Post by david63 » Sun Nov 03, 2019 3:01 pm

pierredu wrote:
Sun Nov 03, 2019 2:38 pm
Do you check the 'pattern' keyword?
Not sure what you mean by "keyword" but I am checking that the @ and % arguments are not without a leading character.

I am not claiming this to be infallible but more as a guide
Last edited by david63 on Sun Nov 03, 2019 3:08 pm, edited 1 time in total.
David
Remember: You only know what you know and - you don't know what you don't know!
My CDB Contributions | How to install an extension
I will not be accepting translations for any of my extensions in Github - please post any translations in the appropriate topic.
No support requests via PM or email as they will be ignored

User avatar
</Solidjeuh>
Registered User
Posts: 1732
Joined: Tue Mar 29, 2016 3:45 am
Location: Aalst (Belgium)
Name: Andy Dm
Contact:

Re: [3.2][RC] Extension Services Check

Post by </Solidjeuh> » Sun Nov 03, 2019 3:07 pm

david63 wrote:
Sun Nov 03, 2019 3:01 pm
pierredu wrote:
Sun Nov 03, 2019 2:38 pm
Do you check the 'pattern' keyword?
Not sure what you mean by "keyword" but I am checking that if an argument starts with either @ or % then it also has a quote
I guess this:
https://area51.phpbb.com/phpBB/viewtopi ... 30#p332791

User avatar
P_I
Registered User
Posts: 942
Joined: Tue Mar 01, 2011 8:35 pm
Location: Calgary
Contact:

Re: [3.2][RC] Extension Services Check

Post by P_I » Sun Nov 03, 2019 3:07 pm

Thanks David. This will be very helpful going forward.
Normal people… believe that if it ain’t broke, don’t fix it. Engineers believe that if it ain’t broke, it doesn’t have enough features yet. – Scott Adams

nou nou
Registered User
Posts: 385
Joined: Sat Oct 29, 2016 8:08 pm

Re: [3.2][RC] Extension Services Check

Post by nou nou » Sun Nov 03, 2019 3:10 pm

Very helpful indeed! Thank you very much!

User avatar
pierredu
Registered User
Posts: 962
Joined: Thu Nov 01, 2012 8:04 am
Location: Paris (France)

Re: [3.2][RC] Extension Services Check

Post by pierredu » Sun Nov 03, 2019 5:16 pm

</Solidjeuh> wrote:
Sun Nov 03, 2019 3:07 pm
david63 wrote:
Sun Nov 03, 2019 3:01 pm
pierredu wrote:
Sun Nov 03, 2019 2:38 pm
Do you check the 'pattern' keyword?
Not sure what you mean by "keyword" but I am checking that if an argument starts with either @ or % then it also has a quote
I guess this:
https://area51.phpbb.com/phpBB/viewtopi ... 30#p332791
Exactly.

User avatar
david63
Registered User
Posts: 16681
Joined: Thu Dec 19, 2002 8:08 am
Location: Lancashire, UK
Name: David Wood
Contact:

Re: [3.2][RC] Extension Services Check

Post by david63 » Sun Nov 03, 2019 10:20 pm

Updated to RC2

Added check for routing.yml
David
Remember: You only know what you know and - you don't know what you don't know!
My CDB Contributions | How to install an extension
I will not be accepting translations for any of my extensions in Github - please post any translations in the appropriate topic.
No support requests via PM or email as they will be ignored

User avatar
dmzx
Registered User
Posts: 780
Joined: Fri Sep 05, 2014 6:48 am
Location: The Netherlands
Contact:

Re: [3.2][RC] Extension Services Check

Post by dmzx » Mon Nov 04, 2019 9:23 am

david63 wrote:
Sun Nov 03, 2019 10:20 pm
Updated to RC2

Added check for routing.yml
Maybe change the text in ACP that routing.yml is also checked.


-------------
Extension Services File Syntax Check
This extension will check the syntax of the services.yml file in all of the enabled extensions on this board for compatibility with phpBB 3.3.

It does NOT guarantee that the extension is compatible in any other way with phpBB 3.3 nor does it guarantee that there are no other issues with the services.yml file.


------------
Contact me on dmzx-web.net
 Need a Host or buy me a beer Donate and try binance.com

User avatar
kasimi
Extension Customisations
Extension Customisations
Posts: 3937
Joined: Sat Sep 10, 2011 7:12 pm
Location: Germany
Contact:

Re: [3.2][RC] Extension Services Check

Post by kasimi » Mon Nov 04, 2019 10:49 am

You may also want to check services & parameters of setter injections: https://github.com/phpbb/phpbb/blob/rel ... es.yml#L41

User avatar
david63
Registered User
Posts: 16681
Joined: Thu Dec 19, 2002 8:08 am
Location: Lancashire, UK
Name: David Wood
Contact:

Re: [3.2][RC] Extension Services Check

Post by david63 » Mon Nov 04, 2019 11:26 am

kasimi wrote:
Mon Nov 04, 2019 10:49 am
You may also want to check services & parameters of setter injections: https://github.com/phpbb/phpbb/blob/rel ... es.yml#L41
To save me spending the next three days digging around documentation :o what are the correct and incorrect setting? ;)

And while I am about it are there any others that come to mind?
David
Remember: You only know what you know and - you don't know what you don't know!
My CDB Contributions | How to install an extension
I will not be accepting translations for any of my extensions in Github - please post any translations in the appropriate topic.
No support requests via PM or email as they will be ignored

User avatar
kasimi
Extension Customisations
Extension Customisations
Posts: 3937
Joined: Sat Sep 10, 2011 7:12 pm
Location: Germany
Contact:

Re: [3.2][RC] Extension Services Check

Post by kasimi » Mon Nov 04, 2019 7:04 pm

The same rules apply, incorrect: - [set_cache, [@cache.driver]], correct: - [set_cache, ['@cache.driver']].

And maybe you should check all .yml files in the config folder & its subfolders.

User avatar
david63
Registered User
Posts: 16681
Joined: Thu Dec 19, 2002 8:08 am
Location: Lancashire, UK
Name: David Wood
Contact:

Re: [3.2][RC] Extension Services Check

Post by david63 » Tue Nov 05, 2019 8:34 am

kasimi wrote:
Mon Nov 04, 2019 7:04 pm
The same rules apply, incorrect: - [set_cache, [@cache.driver]], correct: - [set_cache, ['@cache.driver']].
Thanks - I will check for that
kasimi wrote:
Mon Nov 04, 2019 7:04 pm
And maybe you should check all .yml files in the config folder
I was hoping nobody would suggest that :o
kasimi wrote:
Mon Nov 04, 2019 7:04 pm
& its subfolders.
Do any extensions have subfolders? I cannot recall ever seeing any
David
Remember: You only know what you know and - you don't know what you don't know!
My CDB Contributions | How to install an extension
I will not be accepting translations for any of my extensions in Github - please post any translations in the appropriate topic.
No support requests via PM or email as they will be ignored

Post Reply

Return to “Extensions in Development”