Check for existence of key with Data Stores API on New Analysis Completed (Instant) from SonarCloud API

Pipedream makes it easy to connect APIs for Data Stores, SonarCloud and 2,200+ other apps remarkably fast.

Trigger workflow on

New Analysis Completed (Instant) from the SonarCloud API

Next, do this

Check for existence of key with the Data Stores 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 SonarCloud trigger and Data Stores action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Analysis Completed (Instant) trigger
1. Connect your SonarCloud account
2. Configure Name
3. Select a Organization
4. Optional- Select a Project
Configure the Check for existence of key action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Optional- Select a Create a new record if the key is not found?
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 Analysis Completed (Instant) on SonarCloud

Description:Emit new event when a new analisys is completed.

Version:0.0.1

Key:sonarcloud-new-analysis-completed-instant

View on GitHub

SonarCloud Overview#

The SonarCloud API facilitates automated code quality checks and security vulnerability assessments. By integrating with Pipedream, developers can harness this power within serverless workflows, triggering actions based on code analysis results, monitoring project metrics, and automating project management tasks. The API allows for enhanced productivity by connecting code quality data with other services and tools, streamlining the development process.

Trigger Code#

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

export default {
  key: "sonarcloud-new-analysis-completed-instant",
  name: "New Analysis Completed (Instant)",
  description: "Emit new event when a new analisys is completed.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    sonarcloud,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    name: {
      type: "string",
      label: "Name",
      description: "Name displayed in the administration console of webhooks.",
    },
    organization: {
      propDefinition: [
        sonarcloud,
        "organization",
      ],
    },
    project: {
      propDefinition: [
        sonarcloud,
        "project",
        ({ organization }) => ({
          organization,
        }),
      ],
      optional: true,
    },
  },
  hooks: {
    async activate() {
      const { webhook } = await this.sonarcloud.createWebhook({
        params: {
          name: this.name,
          organization: this.organization,
          project: this.project,
          url: this.http.endpoint,
        },
      });
      this.db.set("hookId", webhook.key);
    },
    async deactivate() {
      await this.sonarcloud.deleteWebhook({
        params: {
          webhook: this.db.get("hookId"),
        },
      });
    },
  },
  async run(event) {
    this.http.respond({
      status: 200,
    });

    const { body } = event;

    this.$emit(body, {
      id: body.revision,
      summary: `New analisys completed with revision key: ${body.revision}`,
      ts: Date.parse(body.changedAt),
    });
  },
};

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
SonarCloud	`sonarcloud`	`app`	This component uses the SonarCloud app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Name	`name`	`string`	Name displayed in the administration console of webhooks.
Organization	`organization`	`string`	Select a value from the drop down menu.
Project	`project`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About SonarCloud#

SonarCloud is the leading online service for Code Quality & Security. Free analysis for open-source projects covering 24 languages.

Action#

Check for existence of key on Data Stores

Description:Check if a key exists in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.

Version:0.1.2

Key:data_stores-has-key-or-create

View on GitHub

Data Stores Overview#

Data Stores are a key-value store that allow you to persist state and share data across workflows. You can perform CRUD operations, enabling dynamic data management within your serverless architecture. Use it to save results from API calls, user inputs, or interim data; then read, update, or enrich this data in subsequent steps or workflows. Data Stores simplify stateful logic and cross-workflow communication, making them ideal for tracking process statuses, aggregating metrics, or serving as a simple configuration store.

Action Code#

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

export default {
  key: "data_stores-has-key-or-create",
  name: "Check for existence of key",
  description: "Check if a key exists in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.",
  version: "0.1.2",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    key: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Enter the key you'd like to check.",
    },
    addRecordIfNotFound: {
      propDefinition: [
        app,
        "addRecordIfNotFound",
      ],
    },
  },
  async additionalProps() {
    const props = {};
    if (this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      props.value = app.propDefinitions.value;
    }
    return props;
  },
  async run({ $ }) {
    if (await this.dataStore.has(this.key)) {
      $.export("$summary", `Key \`${this.key}\` exists.`);

      return {
        existingKeyFound: true,
        newKeyCreated: false,
      };
    }

    if (!this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      $.export("$summary", `Key \`${this.key}\` does not exist.`);

      return {
        existingKeyFound: false,
        newKeyCreated: false,
      };
    }

    const parsedValue = this.app.parseValue(this.value);
    await this.dataStore.set(this.key, parsedValue);
    $.export("$summary", `Key \`${this.key}\` was not found. Successfully added a new record.`);

    return {
      existingKeyFound: false,
      newKeyCreated: true,
      value: parsedValue,
    };
  },
};

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
Data Stores	`app`	`app`	This component uses the Data Stores app.
Data Store	`dataStore`	`data_store`	Select an existing Data Store or create a new one.
Key	`key`	`string`	Select a value from the drop down menu.
Create a new record if the key is not found?	`addRecordIfNotFound`	`string`	Select a value from the drop down menu:`YesNo`