Add support for files.getUploadURLExternal and files.completeUploadExternal

[maybe-Baylie]

This pull request introduces support for two new endpoints:

1. files.getUploadURLExternal docs
2. files.completeUploadExternal docs

Additionally, A few errors were corrected in the command classes to allow the tools to run

[maybe-Baylie]

I can add the string literal to class string conversions from Jane as well if desired, will add 448 file changes in generated/normalizer/.

[damienalexandre]

The proper way to add stuffs in this file is described here: https://github.com/jolicode/slack-php-api/blob/main/docs/4-updating-sdk.md#generating-a-new-patch

You need to run a command to update the .patch.

[maybe-Baylie]

I rebased the branch and followed the instructions in the section and confirmed the patch was correctly applied. Should I write unit tests in the WritingTest.php file?

*edit: I think I answered my own question for the test

[damienalexandre]

Also, can you rebase your PR? main has been updated.

[maybe-Baylie]

@damienalexandre Is there a preferred way for sending a post request with the client that isn't to a normal endpoint? To complete the test for FilesCompleteUploadExternal, I need to post the file to the link returned from filesGetUploadURLExternal. I would like to use the client since the auth is already attached to it but I'm not super familiar with how I would go about that. Mocking an endpoint maybe?

[damienalexandre]

Actually, if we must POST to a custom URL, we should create a new customizable Endpoint in the lib, inspired by the existing upload one (https://github.com/jolicode/slack-php-api/blob/main/generated/Endpoint/FilesUpload.php).

class NewFileUpload extends \JoliCode\Slack\Api\Runtime\Client\BaseEndpoint implements \JoliCode\Slack\Api\Runtime\Client\Endpoint
{
    use \JoliCode\Slack\Api\Runtime\Client\EndpointTrait;
   
    private $uri;

    public function __construct(string $uri, array $queryParameters = [], array $headerParameters = [])
    {
        $this->queryParameters = $queryParameters;
        $this->headerParameters = $headerParameters;
    }

    public function getMethod(): string
    {
        return 'POST';
    }

    public function getUri(): string
    {
        return $this->uri;
    }

    public function getBody(\Symfony\Component\Serializer\SerializerInterface $serializer, $streamFactory = null): array
    {
        return $this->getMultipartBody($streamFactory);
    }

    public function getExtraHeaders(): array
    {
        return ['Accept' => ['application/json']];
    }

    public function getAuthenticationScopes(): array
    {
        return ['slackAuth'];
    }

    protected function getQueryOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
    {
        $optionsResolver = parent::getQueryOptionsResolver();

        // todo

        return $optionsResolver;
    }

    protected function getHeadersOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
    {
        $optionsResolver = parent::getHeadersOptionsResolver();
        // todo

        return $optionsResolver;
    }

    protected function transformResponseBody(\Psr\Http\Message\ResponseInterface $response, \Symfony\Component\Serializer\SerializerInterface $serializer, ?string $contentType = null)
    {
        // todo
    }
}

Then it can be used like this in the Client:

    public function newfileUpload(string $uploadUri, array $formParameters = [], string $fetch = self::FETCH_OBJECT)
    {
        return $this->executeEndpoint(new Endpoint\NewFileUpload($uploadUri, $formParameters), $fetch);
    }

Would that be an option? Do you think it's the way to go? I didn't study the new upload behavior yet but if you can to POST to a custom URI, that's the way to go I think.

[maybe-Baylie]

That seems like a fine approach to me. Based on slacks own implementation in the WebAPI, they ended up defining the filesUploadV2 method as a convenience wrapper around the two new endpoints with an internal post call in between. I'll get started on it and see what I can do

[maybe-Baylie]

I was able to validate that the methods worked by using a guzzle client to make the actual post request in a separate project. As it currently stands, this PR has the necessary changes to use the two new methods for completing a file upload.

I have been trying to debug the custom endpoint to make the Post Request and I'm continuing to get this generic error message.

I stepped through it and it appears to be a timeout issue, but I'm a little lost with trying to overcome it. The request URL appears to be properly formatted

Im going to be leaving for vacation at 5pm est today so I'm not sure exactly how you'd like me to proceed. I can commit the code I have been trying to work to this branch or I can share it else where. Im happy to keep trying until 5.

Here is my current implementation of the new class. The types in transformResponseBody() are just direct copies of the types for FilesUpload, but I haven't gotten far enough to know if they need to be customized or not.

class FileUploadToURLExternal extends \JoliCode\Slack\Api\Runtime\Client\BaseEndpoint implements \JoliCode\Slack\Api\Runtime\Client\Endpoint
{
    use \JoliCode\Slack\Api\Runtime\Client\EndpointTrait;

    private $uri;

    public function __construct(string $uri, array $queryParameters = [], array $headerParameters = [])
    {
        $this->uri = $uri;

        $this->queryParameters = $queryParameters;
        $this->headerParameters = $headerParameters;
    }

    public function getMethod(): string
    {
        return 'POST';
    }

    public function getUri(): string
    {
        return $this->uri;
    }

    public function getBody(\Symfony\Component\Serializer\SerializerInterface $serializer, $streamFactory = null): array
    {
        return $this->getMultipartBody($streamFactory);
    }

    public function getExtraHeaders(): array
    {
        return ['Accept' => ['application/json']];
    }

    public function getAuthenticationScopes(): array
    {
        return ['slackAuth'];
    }

    protected function getQueryOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
    {
        $optionsResolver = parent::getQueryOptionsResolver();
        $optionsResolver->setDefined(['filename', 'content', 'file']);
        $optionsResolver->setRequired([]);
        $optionsResolver->setDefaults([]);
        $optionsResolver->addAllowedTypes('filename', ['string']);
        $optionsResolver->addAllowedTypes('file', ['string', 'resource', '\Psr\Http\Message\StreamInterface']);
        $optionsResolver->addAllowedTypes('content', ['string']);

        return $optionsResolver;
    }

    protected function getHeadersOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
    {
        $optionsResolver = parent::getHeadersOptionsResolver();
        // todo

        return $optionsResolver;
    }

    protected function transformResponseBody(\Psr\Http\Message\ResponseInterface $response, \Symfony\Component\Serializer\SerializerInterface $serializer, ?string $contentType = null)
    {
        $status = $response->getStatusCode();
        $body = (string) $response->getBody();
        if (200 === $status) {
            return $serializer->deserialize($body, 'JoliCode\Slack\CustomRoutes\Model\FilesUploadToURLExternalPostResponse200', 'json');
        }

        return $serializer->deserialize($body, 'JoliCode\Slack\CustomRoutes\Model\FilesUploadToURLExternalPostResponseDefault', 'json');
    }
}

And the test method I have been working with

public function testCompleteUploadExternal(): void
    {
        /* Step 1: Get the upload url */
        $client = $this->createClient();

        $filename = 'test-image.png';

        /** @var FilesGetUploadURLExternalGetResponse200 $response */
        $response = $client->filesGetUploadURLExternal([
            'filename' => $filename,
            'length' => filesize(__DIR__ . '/resources/test-image.png'),
        ]);

        $this->assertTrue($response->getOk());

        $this->assertNotEmpty($response->getUploadUrl());
        $this->assertNotEmpty($response->getFileId());

        // Save values for confirming upload
        $fileId = $response->getFileId();
        $uploadUrl = $response->getUploadUrl();

        /* Step 2: Send file to slack with post method */

        /** @var FilesUploadToURLExternalPostResponse200 $response */
        $response = $client->FileUploadToURLExternal($uploadUrl, [
            'filename' => $filename,
            'content' => file_get_contents(__DIR__ . '/resources/test-image.png'), // , 'r'),
        ]);

//        /** @var FilesUploadToURLExternalPostResponse200 $response */
//        $response = $client->FileUploadToURLExternal($uploadUrl, [
//            'filename' => $filename,
//            'content' => fopen(__DIR__ . '/resources/test-image.png', 'r'),
//        ]);

        $this->assertTrue($response->getOk());

        /* Step 3: confirm upload */
        $filesArr = [
            [
                'id' => $fileId,
                'title' => $filename,
            ],
        ];

        $response = $client->filesCompleteUploadExternal([
            'channel_id' => $_SERVER['SLACK_TEST_CHANNEL'],
            'files' => json_encode($filesArr),
        ]);

        $this->assertTrue($response->getOk());

        $expected = [
            'id' => $fileId,
            'title' => $filename,
        ];

        $this->assertSame($expected, $response['files']);
    }

[damienalexandre]

Ok thanks for sharing your progress!
Best thing to do is to push everything you have and maybe one of us will be able to finish it (I may - just not sure when).
And have a great vacation 🤗🎉