Global extend.php works, but custom one does not

Kiryi

Hi everyone,

I was developing a simple extension some months ago for beta.15. Now I installed a new beta.16 and installed my extension from my repo. Result: It does no work.

I was checking the changes from beta.15 to beta.16 and I can't figure out any relevant changes.

Now the fact that confuses me the most:

Contents of my extend.php file:

use Flarum\Extend;
use Flarum\Discussion\Discussion;
use Flarum\Tags\Tag;
use OxidSupport\PublicTag\Access;

return [
    (new Extend\Frontend('admin'))
        ->js(__DIR__ . '/js/dist/admin.js'),

    (new Extend\ModelVisibility(Discussion::class))
        ->scope(Access\ScopeDiscussionVisibility::class),

    (new Extend\ModelVisibility(Tag::class))
        ->scope(Access\ScopeTagVisibility::class),
];

If I copy these contents into the global extend.php file, everything works perfectly fine. Therefore I thought my extension's extend.php isn't recognized by my Flarum instance. I added a test output to my custom extend.php. Test output was seen in frontend. The file contents are definitely executed.

Then I also realized, that my admin setting

    (new Extend\Frontend('admin'))
        ->js(__DIR__ . '/js/dist/admin.js'),

works also. Therefore it looks like my extend.php is recognized and not damaged or whatever ...Ok?!

Now I'm sitting here for about two hours and have no idea what to check. Any suggestions? Any changes in beta.16 I did not understand? Any tools to verifiy the extenders?

clarkwinkelmann

Kiryi so only the ModelVisibility extender do not work when added to your extension's extend.php ?

How are you testing it?

How are you editing your extension? Do you use a workbench folder? Is the extend.php correctly kept in sync between your working directory and vendor? Composer sometimes uses symlinks but it might also fallback to copy files if symlinking is not available, which could cause the files to no longer be in sync.

Kiryi

so only the ModelVisibility extender do not work when added to your extension's extend.php ?

Correct.

I usually use a local repo beside my flarum installation. Composer did symlink the contents. Files are in sync. However, even if I commit everything to the remote repo, synced to Packagist and simply install by composer require the extension is "not working". Cache was cleared before and - Flarum as well as Composer. The extension is visible in admin area, I can activate it, I can edit my setting, it is stored in the database. But it does not show any effect. Again, If I then copy the extenders to the global extend.php it works fine.

clarkwinkelmann

Kiryi is the namespace correctly registered in Composer and/or all imports are correct?

The extenders will often fail silently if the ::class attributes don't resolve to anything.

If you recently changed your namespace declaration in composer.json you might need to uninstall and install the extension again.

You could check each import by dumping class_exists(Discussion::class), class_exists(Access\ScopeDiscussionVisibility::class), etc.

EDIT: also if your extend.php doesn't have a namespace itself, you could try adding one. It should work both with or without it, but it could interfere with relative imports.

askvortsov

Kiryi Any chance you could share the contents of your ScopeTagVisibility class?

Kiryi

Actually I did not change anything... ;D Maybe I was just lucky it worked in the past??? lol

I did check with class_exists all classes (namespaces) in my extend.php and everything is fine. I also verified the entry in the composer autoloading files. As I described, if I add the two ModelVisibility extenders to the global extend.php, the extension works fine. Therefore I'm pretty sure there is no trouble with the namespace so far.

My extend.php does not have a namespace itself. I tested that, but no other result was given.

askvortsov
You can check out the extension on GitHub and may even install it:
https://github.com/oxid-support/sic-public-tag

It's just a little feature we needed for our internal knowledge center based on a Flarum installation. If you activate the extension even guests will see restricted tags on the /tags overview page, but can only view discussions tagged with a specific tag you need to define in the extension settings.

Extension is working fine in our beta.15 production system. Unfortunately since it's internal stuff, I'm not able to show you. In my local environment (beta.16) the extension does not work for any reason. Nothing in my logs and I personally do not have any further idea. So I appreciate any help.

askvortsov

Kiryi I have tested your extension locally, and confirmed that the code runs. The issue isn't in infrastructure, but in implementation.

By boolean algebra, and takes precedence over or. For this reason, mixing where and orWhere in the same level of scoping can lead to big issues: if any extensions are booted after yours, the orWhere you're defining will attach to the next extension's where, causing all sorts of issues. I recently opened a PR to clarify this for our documentation.

Essentially, top-level visibility scopers should only be used to restrict the query. If you want to expand it to offset the effect of some other visibility scoper, you'll want to scope it for an ability exposed by that scoper. See my help tags extension for an example.

Kiryi

So I was really kind of lucky it did run in our beta.15 for the last months. ö_ö

Thanks everyone for the help. I will have a look into my implementation soon.