mallardduck / dynamic-echo-events

src/DynamicEchoService.php

<?php

namespace MallardDuck\DynamicEcho;

use MallardDuck\DynamicEcho\Collections\{
    ChannelEventCollection,
    ChannelAwareEventCollection
};
use MallardDuck\DynamicEcho\Loader\LoadedEventDTO;
use MallardDuck\DynamicEcho\ScriptGenerator\{
    ScriptGenerator,
    ScriptNodeBuilder
};

class DynamicEchoService
{
    /**
     * @var ChannelManager
     */
    private ChannelManager $channelManager;

    /**
     * @var ScriptGenerator
     */
    private ScriptGenerator $scriptGenerator;

    public function __construct(
        ChannelManager $channelManager,
        ScriptGenerator $scriptGenerator
    ) {
        $this->channelManager = $channelManager;
        $this->scriptGenerator = $scriptGenerator;
    }

    public function context(): string
    {
        $context = $this->compiledJSContext();
        $html = $this->buildHtmlStack($context, ucfirst(__FUNCTION__));

        return implode("\n", $html);
    }

    /**
     * Internally compile the necessary JS context for the current Request/User.
     *
     * This method calls on the ChannelManager to fetch channels and events that need to be registered.
     * Then it pushes the equivalent ScriptNodes into the generator and creates the JS listeners.
     *
     * @return string
     */
    protected function compiledJSContext(): string
    {
        $warning = null;

        // TODO: Figure out what a "GenericContextNode" might look like, so I can push the "active: false" variable in.
        /**
         * @var ChannelEventCollection $channelGroup
         */
        foreach ($this->channelManager->getChannelEventCollection() as $channelName => $channelGroup) {
            $channelContext = $this->resolveChannelContextBindings($channelGroup->getChannelContextBindingCallback());

            $this->scriptGenerator->pushContextNode(ScriptNodeBuilder::getChannelContextNode(
                $channelGroup->getChannelJsVarKey(),
                $channelContext
            ));
        }


        $generatedContext = $this->scriptGenerator->getRootContext();

        return view('dynamicEcho::context', compact('warning', 'generatedContext'))->render();

The expression return view('dynamicEcho::context', compact('warning', 'generatedContext'))->render() could return the type array which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    private function resolveChannelContextBindings($callback): array
    {
        return $callback(request());
    }

    // NOTE: Ideally the static content could be "compiled" more consistently to a cache.
    // CONT: Then the dynamic ones would just be injected to the page for each user's request.
    public function scripts(): string
    {
        $scripts = $this->compiledJSScripts();
        $html = $this->buildHtmlStack($scripts, ucfirst(__FUNCTION__));

        return implode("\n", $html);
    }

    /**
     * Internally compile the necessary JS code to subscribe to channels and events.
     *
     * This method calls on the ChannelManager to fetch channels and events that need to be registered.
     * Then it pushes the equivalent ScriptNodes into the generator and creates the JS listeners.
     *
     * @return string
     */
    protected function compiledJSScripts(): string
    {
        /**
         * @var ChannelEventCollection $channelGroup
         */
        foreach ($this->channelManager->getChannelEventCollection() as $channelName => $channelGroup) {
            // Push the channel subscription in first...
            $this->scriptGenerator->pushScriptNode(ScriptNodeBuilder::getPrivateChannelNode(
                $channelGroup->getChannelJsIdentifier()
            ));

            /**
             * @var LoadedEventDTO $eventDTO
             */
            foreach ($channelGroup as $key => $eventDTO) {
                // Then push each of the channels events into the stack too.
                $this->scriptGenerator->pushScriptNode(ScriptNodeBuilder::getListenNode(
                    $eventDTO->eventName,
                    $eventDTO->jsEventCallback
                ));
            }
        }

        $generatedScript = $this->scriptGenerator->getRootScript();

        return view('dynamicEcho::scripts', compact('generatedScript'))->render();

The expression return view('dynamicEcho::scripts', compact('generatedScript'))->render() could return the type array which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    protected function buildHtmlStack(string $content, string $renderType): array
    {
        /**
         * @var ?bool $debug
         */
        static $debug;
        if (null === $debug) {
            $debug = config('app.debug');
        }

        $html = [];
        if ($debug) {
            $html[] = '<!-- Start DynamicEcho ' . $renderType . ' -->';
        }
        $html[] = $debug ? $content : $this->minify($content);
        if ($debug) {
            $html[] = '<!-- End DynamicEcho ' . $renderType . ' -->';
        }

        return $html;
    }

    protected function minify(string $subject): string
    {
        return preg_replace('~(\v|\t|\s{2,})~m', '', $subject);
    }

    public function getDiscoveredChannels(): ChannelAwareEventCollection
    {
        return $this->channelManager->registeredChannelNames();
    }

    public function getExtendedChannelInfo()
    {
        return $this->channelManager->registeredChannelInfo();
    }
}