text: /**
   * Copyright (C) 2017 MongoDB Inc.
   *
   * This program is free software: you can redistribute it and/or  modify
   * it under the terms of the GNU Affero General Public License, version 3,
   * as published by the Free Software Foundation.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU Affero General Public License for more details.
   *
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   *
   * As a special exception, the copyright holders give permission to link the
   * code of portions of this program with the OpenSSL library under certain
   * conditions as described in each individual source file and distribute
   * linked combinations including the program with the OpenSSL library. You
   * must comply with the GNU Affero General Public License in all respects
   * for all of the code used other than as permitted herein. If you modify
   * file(s) with this exception, you may extend this exception to your
   * version of the file(s), but you are not obligated to do so. If you do not
   * wish to do so, delete this exception statement from your version. If you
   * delete this exception statement from all source files in the program,
   * then also delete it in the license file.
   */
  
  #pragma once
  
  #include "mongo/db/pipeline/document_source.h"
  
  namespace mongo {
  
  /**
   * An internal stage available for testing. Acts as a simple passthrough of intermediate results
   * from the source stage. Does not participate in optimizations such as swapping, coalescing, or
   * pushdown into the query system, so this stage can be useful in tests to ensure that an
   * unoptimized code path is being exercised.
   */
  class DocumentSourceInternalInhibitOptimization final : public DocumentSource {
  public:
      static constexpr StringData kStageName = "$_internalInhibitOptimization"_sd;
  
      static boost::intrusive_ptr<DocumentSource> createFromBson(
          BSONElement, const boost::intrusive_ptr<ExpressionContext>&);
  
      DocumentSourceInternalInhibitOptimization(const boost::intrusive_ptr<ExpressionContext>& expCtx)
          : DocumentSource(expCtx) {}
  
      const char* getSourceName() const final {
          return kStageName.rawData();
      }
  
      StageConstraints constraints() const final {
          StageConstraints constraints;
          constraints.hostRequirement = HostTypeRequirement::kAnyShardOrMongoS;
          return constraints;
      }
  
      GetNextResult getNext() final;
  
  private:
      Value serialize(boost::optional<ExplainOptions::Verbosity> explain = boost::none) const final;
  };
  
  }  // namesace mongo
  