serverless / utils Goto Github PK

View Code? Open in Web Editor NEW

29.0 22.0 21.0 1.11 MB

General serverless utilities

License: MIT License

JavaScript 100.00%

serverless utils

utils's Introduction

@serverless/utils

Serverless Inc. CLIs internal utilities

Installation

npm install @serverless/utils

Utilities

utils's People

Contributors

Stargazers

Watchers

utils's Issues

Type definitions are missing

There are no type definitions for TypeScript. It causes errors.

Allow customizing location of global Serverless config files

Feature Proposal

Allow customizing location of serverless' global config files: ~/.serverlessrc and ~/.serverless.

Description

What is the use case that should be solved. The more detail you describe this in the easier it is to understand for us.

Some people don't like having their home directories full of files that they neither use nor want. It's nice to be able to put them in other places, like ~/.config, ~/.local/share, etc. For examples of software that behaves nicely, see Git, GnuPG, htop, Emacs >= 27, Python, Go, ccache, nodejs, jupyter, julia, ruby, mix, asdf, etc.

Optional: If there is additional config how would it look

Either automatically search common places with something like appdirs, or allow environment variables that specify the locations of the serverlessrc and serverless dirs.
Most tools have priority order: environment -> config dir -> home dir

Similar or dependent issues:

serverless/serverless#7651

Add general logging utility

Add general logging utility, as specified in serverless/serverless#8444, to be used across projects.

Invalid format of user config crashes the process

If config is not parseable we should ignore it and treat it as if there's no user config (it means that config was manipulated) and we don't keep there any data of which loss would be problematic.

If there's such case we should rename original config to .serverlessrc.bak, create a new one in place and communicate to user with log message what happened

serverless is making calls to sp-notifications-and-metrics-v1.serverless-platform.com

Hi,

In one of our project where we use serverless framework, we are not expecting to use analytics feature of the serverless. Still the framework is making calls to endpoint sp-notifications-and-metrics-v1.serverless-platform.com

How can I configure the serverless to prevent calls to this domain?

Unify configuration file handling

Proposal of implementation/extension of existing config.js module so it covers all use cases currently supported by platform-sdk. It is a part of initiative: serverless/dashboard-plugin#464

Get rid of merging config with rc utility. Reasoning: At the moment, in utils, when resolving config, we're using rc to read both local and global config files and merge them with local config overwriting global. This creates a situation where reading config after saving it can produce inconsistent results due to the fact that we're always saving to global - if saved property also exist in local config, it will be shadowed by that value when reading configuration. (Please correct me if I'm wrong here)
Introduce a method that will resolve the configuration file, resembling https://github.com/serverless/platform-sdk/blob/master/src/utils/configFile.js#L21 and always use it to resolve the config path when reading/writing. This will ensure that read-after-write will be always consistent and we won't run into situation as highlighted in 1.
Add getLoggedInUser util that will retrieve logged in user data - similar to https://github.com/serverless/platform-sdk/blob/master/src/utils/configFile.js#L80
Use it both in components and enterprise-plugin.

I'd love to get your opinion on this one @medikoo, thanks in advance 🙇

Security Vulnerability with `semver` (via `make-dir` Transitive Dependency)

make-dir 3.1.0 depends on semver ^6.0.0 which has a vulnerability:

GHSA-c2qf-rxjj-qqgw

The solution is to upgrade make-dir to 4.0.0 which updates semver to ^7.5.3, which doesn't have the vulnerability.

cloudformation-schema doc update (?)

Currently in the cloudformationSchema doc, it states the import should be as:

const cloudFormationSchema = require('@serverless/utils/cloudformationSchema');

But it seems to export directly from the file, so it requires a user to do:

const cloudFormationSchema = require("@serverless/utils/cloudformation-schema")

I'm guessing this is unintentional so I'm reporting it as a bug, though it may just need a doc update.

Security vulnerability from `file-type` inner dependency

This package depends on archive-type and decompress which seem abandoned and they depend on really old versions of file-type triggering our CI audit checks:

┌───────────────┬──────────────────────────────────────────────────────────────┐
│ moderate      │ file-type vulnerable to Infinite Loop via malformed MKV file │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package       │ file-type                                                    │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in    │ >=16.5.4                                                     │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ @the-mill/infra-serverless                                   │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path          │ @the-mill/infra-serverless > serverless > @serverless/utils  │
│               │ > archive-type > file-type                                   │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info     │ https://www.npmjs.com/advisories/1081704                     │
└───────────────┴──────────────────────────────────────────────────────────────┘
┌───────────────┬──────────────────────────────────────────────────────────────┐
│ moderate      │ file-type vulnerable to Infinite Loop via malformed MKV file │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package       │ file-type                                                    │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in    │ >=16.5.4                                                     │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ @the-mill/infra-serverless                                   │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path          │ @the-mill/infra-serverless > serverless > @serverless/utils  │
│               │ > decompress > decompress-tar > file-type                    │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info     │ https://www.npmjs.com/advisories/1081704                     │
└───────────────┴──────────────────────────────────────────────────────────────┘
┌───────────────┬──────────────────────────────────────────────────────────────┐
│ moderate      │ file-type vulnerable to Infinite Loop via malformed MKV file │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package       │ file-type                                                    │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in    │ >=16.5.4                                                     │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ @the-mill/infra-serverless                                   │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path          │ @the-mill/infra-serverless > serverless > @serverless/utils  │
│               │ > decompress > decompress-tarbz2 > file-type                 │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info     │ https://www.npmjs.com/advisories/1081704                     │
└───────────────┴──────────────────────────────────────────────────────────────┘
┌───────────────┬──────────────────────────────────────────────────────────────┐
│ moderate      │ file-type vulnerable to Infinite Loop via malformed MKV file │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package       │ file-type                                                    │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in    │ >=16.5.4                                                     │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ @the-mill/infra-serverless                                   │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path          │ @the-mill/infra-serverless > serverless > @serverless/utils  │
│               │ > decompress > decompress-targz > file-type                  │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info     │ https://www.npmjs.com/advisories/1081704                     │
└───────────────┴──────────────────────────────────────────────────────────────┘
┌───────────────┬──────────────────────────────────────────────────────────────┐
│ moderate      │ file-type vulnerable to Infinite Loop via malformed MKV file │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package       │ file-type                                                    │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in    │ >=16.5.4                                                     │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ @the-mill/infra-serverless                                   │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path          │ @the-mill/infra-serverless > serverless > @serverless/utils  │
│               │ > decompress > decompress-unzip > file-type                  │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info     │ https://www.npmjs.com/advisories/1081704                     │
└───────────────┴──────────────────────────────────────────────────────────────┘

Add account-related methods

The purpose of this issue is to introduce account-related methods such as logout, getAccessKeyForOrg and refreshToken that will replace corresponding methods from platform-sdk and will be used by components and enterprise-plugin projects.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.