Run Performance Test with GTmetrix API on New Field in Document from MongoDB API

Pipedream makes it easy to connect APIs for GTmetrix, MongoDB and 2,400+ other apps remarkably fast.

Trigger workflow on

New Field in Document from the MongoDB API

Next, do this

Run Performance Test with the GTmetrix API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a MongoDB trigger and GTmetrix action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Field in Document trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
4. Select a Collection
5. Select a Document
Configure the Run Performance Test action
1. Connect your GTmetrix account
2. Configure URL
3. Optional- Select a Location
4. Optional- Select a Browser
5. Optional- Configure Wait for Report
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Field in Document on MongoDB

Description:Emit new an event when a new field is added to a document

Version:0.0.7

Key:mongodb-new-field-in-document

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "mongodb-new-field-in-document",
  name: "New Field in Document",
  description: "Emit new an event when a new field is added to a document",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        common.props.mongodb,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    document: {
      propDefinition: [
        common.props.mongodb,
        "document",
        (c) => ({
          database: c.database,
          collection: c.collection,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getFields() {
      return this.db.get("fields");
    },
    _setFields(fields) {
      this.db.set("fields", fields);
    },
    isRelevant(key, fields) {
      return !fields.includes(key);
    },
    async processEvent(client, ts) {
      const fields = this._getFields() || [];
      const collection = this.mongodb.getCollection(client, this.database, this.collection);
      const documents = await this.mongodb.listDocuments(collection);
      const doc = documents.find((obj) => {
        return obj._id == this.document;
      });
      const keys = Object.keys(doc);
      for (const key of keys) {
        if (!this.isRelevant(key, fields)) {
          continue;
        }
        fields.push(key);
        this.emitEvent(key, ts);
      }
      this._setFields(fields);
    },
    generateMeta(key, ts) {
      return {
        id: key,
        summary: `New Field ${key}`,
        ts,
      };
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
MongoDB	`mongodb`	`app`	This component uses the MongoDB app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database	`database`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
Document	`document`	`string`	Select a value from the drop down menu.

Trigger Authentication#

MongoDB uses API keys for authentication. When you connect your MongoDB account, Pipedream securely stores the keys so you can easily authenticate to MongoDB APIs in both code and no-code steps.

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

Run Performance Test on GTmetrix

Description:Run a performance test on a specified URL using GTmetrix. [See the documentation](https://gtmetrix.com/api/docs/2.0/#api-test-start)

Version:0.0.1

Key:gtmetrix-run-performance-test

View on GitHub

GTmetrix Overview#

The GTmetrix API provides an interface to test the loading speed of your website, offering insights into performance issues and potential optimizations. By integrating this API with Pipedream, you can automate performance monitoring, receive alerts, and combine data with other services for in-depth analysis. For instance, you could trigger a performance report after a site update, log results to a spreadsheet for tracking, or compare your metrics against industry standards.

Action Code#

import gtmetrix from "../../gtmetrix.app.mjs";

export default {
  key: "gtmetrix-run-performance-test",
  name: "Run Performance Test",
  description: "Run a performance test on a specified URL using GTmetrix. [See the documentation](https://gtmetrix.com/api/docs/2.0/#api-test-start)",
  version: "0.0.1",
  type: "action",
  props: {
    gtmetrix,
    url: {
      type: "string",
      label: "URL",
      description: "The URL of the page to test",
    },
    locationId: {
      propDefinition: [
        gtmetrix,
        "locationId",
      ],
    },
    browserId: {
      propDefinition: [
        gtmetrix,
        "browserId",
      ],
    },
    waitForReport: {
      type: "boolean",
      label: "Wait for Report",
      description: "Set to `true` to poll the API in 3-second intervals until the test is completed. Will return the report.",
      optional: true,
    },
  },
  async run({ $ }) {
    const { data: test } = await this.gtmetrix.startTest({
      data: {
        data: {
          type: "test",
          attributes: {
            url: this.url,
            location: this.locationId,
            browser: this.browserId,
          },
        },
      },
      $,
    });

    if (!this.waitForReport) {
      $.export("$summary", "Successfully started performance test.");
      return test;
    }

    const testId = test.id;
    let type = test.type;
    let report;
    const timer = (ms) => new Promise((res) => setTimeout(res, ms));

    // when completed, type will be "report"
    while (type === "test") {
      const { data } = await this.gtmetrix.getTest({
        testId,
        $,
      }); console.log(data);
      type = data.type;
      report = data;
      if (data.attributes?.error) {
        throw new Error(data.attributes.error);
      }
      await timer(3000);
    }

    if (report.attributes?.report) {
      $.export("$summary", "Successfully completed performance test.");
    }

    return report;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
GTmetrix	`gtmetrix`	`app`	This component uses the GTmetrix app.
URL	`url`	`string`	The URL of the page to test
Location	`locationId`	`string`	Select a value from the drop down menu.
Browser	`browserId`	`string`	Select a value from the drop down menu.
Wait for Report	`waitForReport`	`boolean`	Set to `true` to poll the API in 3-second intervals until the test is completed. Will return the report.

Action Authentication#

GTmetrix uses API keys for authentication. When you connect your GTmetrix account, Pipedream securely stores the keys so you can easily authenticate to GTmetrix APIs in both code and no-code steps.

To retrieve your API Key,

Navigate to your GTmetrix account and sign in
Go to “Account” > “API Usage”

Run Performance Test with GTmetrix API on New Field in Document from MongoDB API

Pipedream makes it easy to connect APIs for GTmetrix, MongoDB and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular