Merge remote-tracking branch 'upstream/master' into failing-test-502

Author: dplewis

.github/workflows/ci.yml

@@ -52,6 +52,7 @@ jobs:
       - run: npm ci
       - run: npm start
       - run: npm run lint
+      - run: npm run test-stream
       - run: npm run test:coverage
       - run: npm run document-check
       - run: npm run document

.github/workflows/release-automated.yml

@@ -2,6 +2,9 @@ name: release-automated
 on:
   push:
     branches: [ master, release, alpha, beta ]
+env:
+  NODE_VERSION: 18
+  PHP_VERSION: 8.1
 jobs:
   release:
     runs-on: ubuntu-latest
@@ -13,7 +16,7 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: ${{ env.NODE_VERSION }}
       - run: npm ci
       - run: npx semantic-release
         env:
@@ -22,32 +25,30 @@ jobs:
       - name: Determine tag on current commit
         id: tag
         run: echo "::set-output name=current_tag::$(git describe --tags --abbrev=0 --exact-match || echo '')"
-  publish-docs:
+  docs-publish:
     needs: release
     if: needs.release.outputs.current_tag != ''
     runs-on: ubuntu-latest
+    timeout-minutes: 15
     steps:
       - uses: actions/checkout@v3
         with:
           ref: ${{ needs.release.outputs.current_tag }}
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 16
-      - name: Cache Node.js modules
-        uses: actions/cache@v3
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-              ${{ runner.os }}-node-
+          php-version: ${{ env.PHP_VERSION }}
       - name: Generate Docs
         run: |
-          npm ci
+          composer install
           npm run document-check
-          npm run documentation
+          npm run document
         env:
-          SOURCE_TAG: ${{ github.event.inputs.tag }}
+          SOURCE_TAG: ${{ needs.release.outputs.current_tag }}
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3.7.3
         with:

.github/workflows/release-manual-docs.yml

@@ -6,12 +6,12 @@ on:
         default: ''
         description: 'Version tag:' 
 env:
-  NODE_VERSION: 16.17.1
+  NODE_VERSION: 18
   PHP_VERSION: 8.1
 jobs:
   docs-publish:
     if: github.event.inputs.tag != ''
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
       - uses: actions/checkout@v3

CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.1.0](https://github.com/parse-community/parse-php-sdk/compare/2.0.0...2.1.0) (2023-04-29)
+
+
+### Features
+
+* Add `ParseUser::logInAs` method ([#486](https://github.com/parse-community/parse-php-sdk/issues/486)) ([5b4e102](https://github.com/parse-community/parse-php-sdk/commit/5b4e102e4513e82cca1ddcce9c2158f6187239c8))
+
 # [2.0.0](https://github.com/parse-community/parse-php-sdk/compare/1.6.0...2.0.0) (2023-04-27)
 
 ### Features

CONTRIBUTING.md

@@ -7,8 +7,6 @@ When committing, keep all lines to less than 80 characters, and try to
 follow the existing style. Before creating a pull request, squash your commits
 into a single commit. Please provide ample explanation in the commit message.
 
-In addition there's a pretty cool [class inheritance diagram](http://parseplatform.org/parse-php-sdk/graph_class.html) you can check out as well.
-
 Installation
 ------------
 
@@ -28,15 +26,13 @@ To setup the Test Parse Server:
 * Run `npm install` from the project root to download the server and it's dependencies.
 * When you're ready to run tests use `npm start` from the project root to boot up the test server.
 
-The embedded test server utilizes this [parse server test] project.
-It's setup with the appropriate configuration to run the php sdk test suite.
-Additionally it handles setting up mongodb for the server.
+The test server is setup with the appropriate configuration to run the php sdk test suite. Additionally it handles setting up mongodb for the server. If you have a mongodb instance already running, you can use `npm run server-only`.
 
 If you have specific needs and would like to alter your test server you can fork and modify the aforementioned test project.
 Alternately you can configure a compatible test server as follows:
 
 * [Setup a local Parse Server instance]
-* Add main.js in tests/cloudcode/cloud/ to your Parse Server configuration as a cloud code file
+* Add cloud-code.js in tests to your Parse Server configuration as a cloud code file
 * Ensure your App ID, REST API Key, and Master Key match those contained in tests/Parse/Helper.php
 * Add a mock push configuration, for example:
 ```json
@@ -70,6 +66,10 @@ You may also run tests directly using phpunit as follows:
 
     npm test
 
+For debugging you can use the `print` function found in tests/Parse/Helper.php
+
+    Helper::print()
+
 Make sure your code is linted with phpcs ([PSR-2 Coding Style]):
 
     npm run lint
@@ -90,11 +90,13 @@ If you do not have XDebug tests will still run, just without coverage.
 Please make sure that any new functionality (or issues) you are working on are covered by tests when possible.
 If you have XDebug setup and can view code coverage please ensure that you do your best to completely cover any new code you are adding.
 
+## Code of Conduct
+
+This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to honor this code.
+
 [Get Composer]: https://getcomposer.org/download/
 [Get npm]: https://www.npmjs.com/get-npm
-[Contributor License Agreement]: https://developers.facebook.com/opensource/cla
 [XDebug]: https://xdebug.org/
-[parse server test]: https://github.com/montymxb/parse-server-test
 [Setup a local Parse Server instance]: https://github.com/parse-community/parse-server#user-content-locally
 [PSR-2 Coding Style]: http://www.php-fig.org/psr/psr-2/
 

README.md

@@ -1,33 +1,29 @@
-<p align="center">
-    <img alt="Parse Platform" src="Assets/logo large.png" width="200">
-  </a>
-</p>
-
-<h2 align="center">Parse PHP SDK</h2>
-
-<p align="center">
-    The Parse PHP SDK gives you access to the powerful Parse Server backend from your PHP app or script.
-</p>
-
-<p align="center">
-    <a href="https://twitter.com/intent/follow?screen_name=parseplatform"><img alt="Follow on Twitter" src="https://img.shields.io/twitter/follow/parseplatform?style=social&label=Follow"></a>
-    <a href="https://community.parseplatform.org/"><img alt="Join the conversation" src="https://img.shields.io/discourse/https/community.parseplatform.org/topics.svg"></a>
-    <a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-BSD-lightgrey.svg"></a>
-    <a href="https://packagist.org/packages/parse/php-sdk"><img alt="All time downloads" src="https://poser.pugx.org/parse/php-sdk/downloads" /></a>
-</p>
-
-<p align="center">
-    <a href="https://codecov.io/gh/parse-community/parse-php-sdk"><img alt="Test coverage" src="https://codecov.io/gh/parse-community/parse-php-sdk/branch/master/graph/badge.svg"></a>
-    <a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/parse-server/backers/badge.svg" /></a>
-    <a href="#sponsors"><img alt="Sponsors on Open Collective" src="https://opencollective.com/parse-server/sponsors/badge.svg" /></a>
-    <a href="https://packagist.org/packages/parse/php-sdk"><img alt="Latest stable version" src="https://poser.pugx.org/parse/php-sdk/v/stable" /></a>
-</p>
-<br>
-
-For more information on Parse and its features, see [the website](https://parseplatform.org), [the PHP guide](https://docs.parseplatform.org/php/guide/) or [API Reference](https://parseplatform.org/parse-php-sdk/namespaces/Parse.html).
-
-## Table of Contents
-- [Table of Contents](#table-of-contents)
+![parse-repository-header-sdk-php](https://user-images.githubusercontent.com/5673677/235324256-42e13836-b26a-4de0-a5c7-b979bc5aff2c.png)
+
+---
+
+[![Build Status CI release](https://github.com/parse-community/parse-php-sdk/workflows/ci/badge.svg?branch=master)](https://github.com/parse-community/parse-php-sdk/actions?query=workflow%3Aci+branch%3Amaster)
+[![Snyk Badge](https://snyk.io/test/github/parse-community/parse-php-sdk/badge.svg)](https://snyk.io/test/github/parse-community/parse-php-sdk)
+[![Coverage](http://codecov.io/github/parse-community/parse-php-sdk/coverage.svg?branch=master)](http://codecov.io/github/parse-community/parse-php-sdk?branch=master)
+[![auto-release](https://img.shields.io/badge/%F0%9F%9A%80-auto--release-9e34eb.svg)](https://github.com/parse-community/parse-dashboard/releases)
+
+[![PHP Version](https://img.shields.io/badge/php-8.1,_8.2-green.svg?logo=php&style=flat)](https://php.org/)
+
+[![packagist latest version](https://img.shields.io/packagist/v/parse/php-sdk)](https://packagist.org/packages/parse/php-sdk)
+
+[![Backers on Open Collective](https://opencollective.com/parse-server/backers/badge.svg)][open-collective-link]
+[![Sponsors on Open Collective](https://opencollective.com/parse-server/sponsors/badge.svg)][open-collective-link]
+[![Forum](https://img.shields.io/discourse/https/community.parseplatform.org/topics.svg)](https://community.parseplatform.org/c/client-sdks/javascript-sdk)
+[![Twitter](https://img.shields.io/twitter/follow/ParsePlatform.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=ParsePlatform)
+
+---
+
+A library that gives you access to the powerful Parse Server backend from your PHP app. For more information on Parse and its features, see [the website](https://parseplatform.org), [the PHP guide](https://docs.parseplatform.org/php/guide/), [the Cloud Code guide](https://docs.parseplatform.org/cloudcode/guide/) or [API Reference](https://parseplatform.org/parse-php-sdk/).
+
+---
+
+## Table of Contents <!-- omit in toc -->
+
 - [Installation](#installation)
   - [Install with Composer](#install-with-composer)
   - [Install with Git](#install-with-git)
@@ -780,8 +776,7 @@ $logs = ParseLogs::getInfoLogs(10, $fromDate, $untilDate, 'asc');
 
 ## Contributing / Testing
 
-See [CONTRIBUTING](CONTRIBUTING.md) for information on testing and contributing to
-the Parse PHP SDK. We welcome fixes and enhancements.
+See [CONTRIBUTING](CONTRIBUTING.md) for information on testing and contributing to the Parse PHP SDK.
 
 -----
 

package-lock.json

@@ -2,8 +2,9 @@
   "name": "parse-php-sdk",
   "scripts": {
     "test": "./vendor/bin/phpunit",
-    "test:coverage": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --stderr --coverage-clover=coverage.xml",
-    "test-stream:coverage": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --stderr --bootstrap=./tests/bootstrap-stream.php --coverage-clover=coverage.xml",
+    "test-stream": "./vendor/bin/phpunit --bootstrap=./tests/bootstrap-stream.php",
+    "test:coverage": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-clover=coverage.xml",
+    "test-stream:coverage": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --bootstrap=./tests/bootstrap-stream.php --coverage-clover=coverage.xml",
     "lint": "./vendor/bin/phpcs --standard=./phpcs.xml.dist ./src/Parse ./tests/Parse",
     "lint:fix": "./vendor/bin/phpcbf --standard=./phpcs.xml.dist ./src/Parse ./tests/Parse",
     "prestart": "MONGODB_VERSION=4.0.4 MONGODB_TOPOLOGY=replicaset MONGODB_STORAGE_ENGINE=wiredTiger mongodb-runner start",
@@ -30,5 +31,6 @@
     "parse-server": "github:parse-community/parse-server#alpha",
     "semantic-release": "21.0.1",
     "winston": "3.2.1"
-  }
+  },
+  "version": "2.1.0"
 }

package.json

@@ -79,7 +79,8 @@ async function config() {
         'changelogFile': changelogFile,
       }],
       ["@semantic-release/exec", {
-        "prepareCmd": `sed -i '' -r "s/const VERSION_STRING = '.*'/const VERSION_STRING = '\${nextRelease.version}'/" ./src/Parse/ParseClient.php`
+        // Update Parse SDK version
+        "prepareCmd": `sed -i'' -r "s/const VERSION_STRING = '.*'/const VERSION_STRING = '\${nextRelease.version}'/" ./src/Parse/ParseClient.php`
       }],
       ['@semantic-release/npm', {
         'npmPublish': false,

release.config.cjs

@@ -61,19 +61,16 @@ public function get($url)
     {
         try {
             // get our response
-            $response = file_get_contents($url, false, $this->stream);
+            $response = $this->getFileContents($url, false, $this->stream);
             $this->errorMessage = null;
             $this->errorCode    = null;
         } catch (\Exception $e) {
             // set our error message/code and return false
             $this->errorMessage = $e->getMessage();
             $this->errorCode    = $e->getCode();
+            $this->responseHeaders = null;
             return false;
         }
-
-        // set response headers
-        $this->responseHeaders = $http_response_header;
-
         return $response;
     }
 
@@ -98,12 +95,22 @@ public function getErrorMessage()
     }
 
     /**
-     * Gest the current error code
+     * Get the current error code
      *
      * @return int
      */
     public function getErrorCode()
     {
         return $this->errorCode;
     }
+
+    /**
+     * Wrapper for file_get_contents, used for testing
+     */
+    public function getFileContents($filename, $use_include_path, $context)
+    {
+        $result = file_get_contents($filename, $use_include_path, $context);
+        $this->responseHeaders = $http_response_header;
+        return $result;
+    }
 }

src/Parse/HttpClients/ParseStream.php

@@ -108,7 +108,7 @@ final class ParseClient
      *
      * @var string
      */
-    const VERSION_STRING = '2.0.0';
+    const VERSION_STRING = '2.1.0';
 
     /**
      * Parse\Client::initialize, must be called before using Parse features.
@@ -554,7 +554,7 @@ public static function _request(
         $response = $httpClient->send($url, $method, $data);
 
         // check content type of our response
-        $contentType = $httpClient->getResponseContentType();
+        $contentType = $httpClient->getResponseContentType() || '';
 
         if (strpos($contentType, 'text/html') !== false) {
             throw new ParseException('Bad Request', -1);

src/Parse/ParseClient.php

@@ -157,6 +157,33 @@ public static function logIn($username, $password)
         return $user;
     }
 
+    /**
+     * Uses the master key to log in and return a valid ParseUser, or throws if invalid.
+     *
+     * @param $userId
+     *
+     * @throws ParseException
+     *
+     * @return ParseUser
+     */
+    public static function logInAs($userId)
+    {
+        if (!$userId) {
+            throw new ParseException(
+                'Cannot log in as user with an empty user id',
+                200
+            );
+        }
+        $data = ['userId' => $userId];
+        $result = ParseClient::_request('POST', 'loginAs', '', json_encode($data), true);
+        $user = new static();
+        $user->_mergeAfterFetch($result);
+        $user->handleSaveResult(true);
+        ParseClient::getStorage()->set('user', $user);
+
+        return $user;
+    }
+
     /**
      * Logs in with Facebook details, or throws if invalid.
      *

src/Parse/ParseUser.php

@@ -321,6 +321,10 @@ public function testStreamConnectionTimeout()
      */
     public function testNoCurlExceptions()
     {
+        global $USE_CLIENT_STREAM;
+        if (isset($USE_CLIENT_STREAM)) {
+            $this->markTestSkipped('Skipping curl exception test');
+        }
         Helper::setUpWithoutCURLExceptions();
 
         ParseClient::setServerURL('http://404.example.com', 'parse');
@@ -656,7 +660,11 @@ public function testCheckBadServer()
 
         ParseClient::setServerURL('http://___uh___oh___.com', 'parse');
         $health = ParseClient::getServerHealth();
-        $this->assertTrue(isset($health['error']));
-        $this->assertTrue(isset($health['error_message']));
+
+        global $USE_CLIENT_STREAM;
+        if (!isset($USE_CLIENT_STREAM)) {
+            $this->assertTrue(isset($health['error']));
+            $this->assertTrue(isset($health['error_message']));
+        }
     }
 }