apollo-server-plugin-operation-registry

v3.5.1

Apollo Server operation registry For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

53 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.12.0	\|	08/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.5.1	\|	01/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.4.0	\|	11/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.11.1	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.10.0	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (413)

GitHub Stars: 13.81K
Forks: 2.03K
Contributors: 420

Direct Usage Popularity

The npm package apollo-server-plugin-operation-registry receives a total of 413 downloads a week. As such, we scored apollo-server-plugin-operation-registry popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package apollo-server-plugin-operation-registry, we found that it has been starred 13,814 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 420
Funding: No

A good and healthy external contribution signal for apollo-server-plugin-operation-registry project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Inactive

deprecated

Commit Frequency

Open Issues: 72
Open PR: 17
Last Release: 3 years ago
Last Commit: 16 days ago

Further analysis of the maintenance status of apollo-server-plugin-operation-registry based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for apollo-server-plugin-operation-registry is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=12.0

Age: 6 years
Dependencies: 8 Direct
Versions: 88
Install Size: 424 kB
Dist-tags: 11
# of Files: 41
Maintainers: 1
TS Typings: Yes

apollo-server-plugin-operation-registry has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Operation Registry Plugin

The operation registry plugin is the interface into the Apollo Platform's operation registry and enables operation safelisting, which allows selective execution based on the operation. Safelisting eliminates the risk of unexpected operations that could cause downtime from being run against a graph.

In order to enable safelisting, follow the step by step guide in the Apollo docs. These steps describe how to extract and upload operations defined within client applications to Apollo Studio using the Apollo CLI. Once operations have been registered, this plugin for Apollo Server fetches the manifest of these operations from Apollo Studio and forbids the execution of any operations that are not in that manifest.

Usage

The following example shows basic usage of the plugin with Apollo Server. First, add the plugin to your project's package.json:

npm install apollo-server-plugin-operation-registry

Then, ensure Apollo Server has access to an API key, for example as the APOLLO_KEY environment variable:

APOLLO_KEY= npm start

Next, enable the plugin by adding it to the plugins parameter to the Apollo Server options:

const server = new ApolloServer({
  typeDefs,
  resolvers,
  subscriptions: false,
  plugins: [
    require("apollo-server-plugin-operation-registry")({
      forbidUnregisteredOperations: true
    })
  ]
});

With federation, the setup follows the same `plugins` configuration:

const { ApolloServer } = require("apollo-server");
const { ApolloGateway } = require("@apollo/gateway");

const gateway = new ApolloGateway({
  serviceList: [ /* services */ ],
});

const server = new ApolloServer({
  gateway,
  subscriptions: false,
  plugins: [
    require("apollo-server-plugin-operation-registry")({
      forbidUnregisteredOperations: true
    })
  ]
});

server.listen().then(({ url }) =&gt; {
  console.log(`🚀 Server ready at ${url}`);
});

Variant

Clients can register their operations to a specific variant, so the plugin contains the graphVariant field to specify which variant to pull operation manifests from.

const server = new ApolloServer({
  plugins: [
    require("apollo-server-plugin-operation-registry")({
      graphVariant: "production"
    })
  ]
});

Metrics

The plugin will transmit metrics regarding unregistered operations which can be viewed within Apollo Studio. The following example shows the unregistered operations sent by a particular client:

The clients page showing unregistered operations

apollo-server-plugin-operation-registry dependencies

apollo-graphql apollo-server-caching apollo-server-env apollo-server-errors apollo-server-plugin-base fast-json-stable-stringify loglevel make-fetch-happen

FAQs

What is apollo-server-plugin-operation-registry?

Apollo Server operation registry. Visit Snyk Advisor to see a full health score report for apollo-server-plugin-operation-registry, including popularity, security, maintenance & community analysis.

Is apollo-server-plugin-operation-registry popular?

The npm package apollo-server-plugin-operation-registry receives a total of 413 weekly downloads. As such, apollo-server-plugin-operation-registry popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is apollo-server-plugin-operation-registry well maintained?

We found indications that apollo-server-plugin-operation-registry is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is apollo-server-plugin-operation-registry safe to use?

While scanning the latest version of apollo-server-plugin-operation-registry, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 12 December-2024, at 10:55 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP